keymap.c 82.8 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
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


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

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

36
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
#define DENSE_TABLE_SIZE (0200)

/* Actually allocate storage for these variables */

Lisp_Object current_global_map;	/* Current global keymap */

Lisp_Object global_map;		/* default global key bindings */

Lisp_Object meta_map;		/* The keymap used for globally bound
				   ESC-prefixed default commands */

Lisp_Object control_x_map;	/* The keymap used for globally bound
				   C-x-prefixed default commands */

/* was MinibufLocalMap */
Lisp_Object Vminibuffer_local_map;
				/* The keymap used by the minibuf for local
				   bindings when spaces are allowed in the
				   minibuf */

/* was MinibufLocalNSMap */
Lisp_Object Vminibuffer_local_ns_map;			
				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
				   in the minibuf */

/* keymap used for minibuffers when doing completion */
/* was MinibufLocalCompletionMap */
Lisp_Object Vminibuffer_local_completion_map;

/* keymap used for minibuffers when doing completion and require a match */
/* was MinibufLocalMustMatchMap */
Lisp_Object Vminibuffer_local_must_match_map;

Jim Blandy's avatar
Jim Blandy committed
71 72 73
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

Jim Blandy's avatar
Jim Blandy committed
74 75 76 77 78
/* 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;

79 80 81
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

82 83 84 85 86 87
/* 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;

88
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii;
Jim Blandy's avatar
Jim Blandy committed
89

Jim Blandy's avatar
Jim Blandy committed
90 91 92
/* 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
93 94
extern Lisp_Object meta_prefix_char;

95 96
extern Lisp_Object Voverriding_local_map;

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

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

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

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

   For example:

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

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

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

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

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

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

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

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

234 235 236 237
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
238

239 240
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
241 242 243 244
	  UNGCPRO;

	  goto autoload_retry;
	}
245 246
    }

Jim Blandy's avatar
Jim Blandy committed
247 248
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
249 250
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
251 252
}

253 254 255

/* 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
256 257 258 259
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
260
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
261
}
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296

/* Return the parent map of the keymap MAP, or nil if it has none.
   We assume that MAP is a valid keymap.  */

DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
  "Return the parent keymap of KEYMAP.")
  (keymap)
     Lisp_Object keymap;
{
  Lisp_Object list;

  keymap = get_keymap_1 (keymap, 1, 1);

  /* Skip past the initial element `keymap'.  */
  list = XCONS (keymap)->cdr;
  for (; CONSP (list); list = XCONS (list)->cdr)
    {
      /* See if there is another `keymap'.  */
      if (EQ (Qkeymap, XCONS (list)->car))
	return list;
    }

  return Qnil;
}

/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
  "Modify KEYMAP to set its parent map to PARENT.\n\
PARENT should be nil or another keymap.")
  (keymap, parent)
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
  int i;
Jim Blandy's avatar
Jim Blandy committed
297

298 299 300
  keymap = get_keymap_1 (keymap, 1, 1);
  if (!NILP (parent))
    parent = get_keymap_1 (parent, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
301

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

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
	  XCONS (prev)->cdr = parent;
	  break;
	}
      prev = list;
    }

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

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

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

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

  return parent;
}

/* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
   if EVENT is also a prefix in MAP's parent,
   make sure that SUBMAP inherits that definition as its own parent.  */

fix_submap_inheritance (map, event, submap)
     Lisp_Object map, event, submap;
{
  Lisp_Object map_parent, parent_entry;

  /* SUBMAP is a cons that we found as a key binding.
     Discard the other things found in a menu key binding.  */

  if (CONSP (submap)
      && STRINGP (XCONS (submap)->car))
    {
      submap = XCONS (submap)->cdr;
      /* Also remove a menu help string, if any,
	 following the menu item name.  */
      if (CONSP (submap) && STRINGP (XCONS (submap)->car))
	submap = XCONS (submap)->cdr;
      /* Also remove the sublist that caches key equivalences, if any.  */
      if (CONSP (submap)
	  && CONSP (XCONS (submap)->car))
	{
	  Lisp_Object carcar;
	  carcar = XCONS (XCONS (submap)->car)->car;
	  if (NILP (carcar) || VECTORP (carcar))
	    submap = XCONS (submap)->cdr;
	}
    }

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

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

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

393 394 395 396
  if (! EQ (parent_entry, submap))
    Fset_keymap_parent (submap, parent_entry);
}

Jim Blandy's avatar
Jim Blandy committed
397
/* Look up IDX in MAP.  IDX may be any sort of event.
398
   Note that this does only one level of lookup; IDX must be a single
399 400 401 402 403 404
   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.  

405 406 407
   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
408 409

Lisp_Object
410
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
411 412
     Lisp_Object map;
     Lisp_Object idx;
413
     int t_ok;
414
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
415
{
416 417 418
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
419 420 421
  /* 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.  */
422
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
423

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

433 434
  {
    Lisp_Object tail;
435
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
436

437
    t_binding = Qnil;
438
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
439
      {
440
	Lisp_Object binding;
441

442
	binding = XCONS (tail)->car;
443
	if (SYMBOLP (binding))
444
	  {
445 446 447 448
	    /* 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;
449 450 451
	  }
	else if (CONSP (binding))
	  {
452
	    if (EQ (XCONS (binding)->car, idx))
453 454 455 456
	      {
		val = XCONS (binding)->cdr;
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
457 458
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
459 460
		return val;
	      }
461 462
	    if (t_ok && EQ (XCONS (binding)->car, Qt))
	      t_binding = XCONS (binding)->cdr;
463 464 465
	  }
	else if (VECTORP (binding))
	  {
466
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
467
	      {
468
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
469 470
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
471 472
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
473 474
		return val;
	      }
475
	  }
476 477

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
478
      }
479

480 481
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
482 483 484 485 486 487 488 489 490
}

/* 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,
491 492 493 494
   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
495 496

Lisp_Object
497
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
498
     register Lisp_Object object;
499
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
500 501 502 503 504
{
  while (1)
    {
      register Lisp_Object map, tem;

505
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
506
      map = get_keymap_1 (Fcar_safe (object), 0, autoload);
Jim Blandy's avatar
Jim Blandy committed
507
      tem = Fkeymapp (map);
Jim Blandy's avatar
Jim Blandy committed
508
      if (!NILP (tem))
509
	object = access_keymap (map, Fcdr (object), 0, 0);
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514
      
      /* If the keymap contents looks like (STRING . DEFN),
	 use DEFN.
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
515 516
      else if (CONSP (object)
	       && STRINGP (XCONS (object)->car))
517 518 519 520
	{
	  object = XCONS (object)->cdr;
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
521
	  if (CONSP (object) && STRINGP (XCONS (object)->car))
522
	    object = XCONS (object)->cdr;
523 524 525
	  /* Also remove the sublist that caches key equivalences, if any.  */
	  if (CONSP (object)
	      && CONSP (XCONS (object)->car))
526
	    {
527 528 529
	      Lisp_Object carcar;
	      carcar = XCONS (XCONS (object)->car)->car;
	      if (NILP (carcar) || VECTORP (carcar))
530 531
		object = XCONS (object)->cdr;
	    }
532
	}
Jim Blandy's avatar
Jim Blandy committed
533 534 535 536 537 538 539 540 541 542 543 544 545

      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;
{
546 547
  /* 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.  */
548
  if (CONSP (def) && PURE_P (def) && STRINGP (XCONS (def)->car))
549 550
    def = Fcons (XCONS (def)->car, XCONS (def)->cdr);

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

Jim Blandy's avatar
Jim Blandy committed
554 555 556
  /* 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.  */
557
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
558

559 560
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
561
  if (SYMBOLP (idx))
562
    idx = reorder_modifiers (idx);
563 564 565
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
566
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
567 568

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
569
  {
570
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
571

572 573 574 575 576 577
    /* 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.  */
578
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
579

580
    insertion_point = keymap;
581
    for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
582
      {
583
	Lisp_Object elt;
584

585
	elt = XCONS (tail)->car;
586
	if (VECTORP (elt))
587
	  {
588
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
589 590 591 592 593
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
594 595 596
	  }
	else if (CONSP (elt))
	  {
597 598 599 600 601
	    if (EQ (idx, XCONS (elt)->car))
	      {
		XCONS (elt)->cdr = def;
		return def;
	      }
602 603 604
	  }
	else if (SYMBOLP (elt))
	  {
605 606 607 608 609 610 611
	    /* 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;
	  }
612 613

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
614 615
      }

616 617 618
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
619 620
    XCONS (insertion_point)->cdr
      = Fcons (Fcons (idx, def), XCONS (insertion_point)->cdr);
621 622
  }
	  
Jim Blandy's avatar
Jim Blandy committed
623 624 625
  return def;
}

626

Jim Blandy's avatar
Jim Blandy committed
627 628 629 630
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
631 632 633
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
634 635 636 637 638 639 640
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

641
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
642
    {
643
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
644

645
      elt = XCONS (tail)->car;
646
      if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
647
	{
648
	  int i;
Jim Blandy's avatar
Jim Blandy committed
649

650 651
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
652

653
	  for (i = 0; i < XVECTOR (elt)->size; i++)
654
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
655
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
656 657
	      XVECTOR (elt)->contents[i] =
		Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
658
	}
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
      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
693 694 695 696 697
    }

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

700 701
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
702 703 704 705
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
706 707
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
708 709 710 711 712 713 714 715 716 717
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
718 719 720 721
 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
722
  (keymap, key, def)
723
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
724 725 726 727 728 729 730 731
     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
732
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
733
  int length;
734
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
735

736
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
737

738
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
739 740
    key = wrong_type_argument (Qarrayp, key);

741
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
742 743 744
  if (length == 0)
    return Qnil;

745 746 747
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

748 749
  GCPRO3 (keymap, key, def);

750
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
751 752 753 754
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
755 756 757 758 759
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

760
      if (CONSP (c) && lucid_event_type_list_p (c))
761
	c = Fevent_convert_list (c);
762

763
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
764
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
765 766 767 768 769 770 771
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
772
	  if (INTEGERP (c))
773
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
774 775 776 777 778

	  metized = 0;
	  idx++;
	}

779
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
780
	error ("Key sequence contains invalid events");
781

Jim Blandy's avatar
Jim Blandy committed
782
      if (idx == length)
783
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
784

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

787
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
788
      if (NILP (cmd))
789
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
790

791 792
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
793 794 795 796
	/* 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
797 798 799 800
    }
}

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

803
DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
804 805
  "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\
806
\n\
Jim Blandy's avatar
Jim Blandy committed
807 808 809 810
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\
811 812 813 814
it takes to reach a non-prefix command.\n\
\n\
Normally, `lookup-key' ignores bindings for t, which act as default\n\
bindings, used when nothing else in the keymap applies; this makes it\n\
Karl Heuer's avatar
Karl Heuer committed
815
usable as a general function for probing keymaps.  However, if the\n\
816 817 818
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
819 820
     register Lisp_Object keymap;
     Lisp_Object key;
821
     Lisp_Object accept_default;
Jim Blandy's avatar
Jim Blandy committed
822 823 824 825 826 827 828
{
  register int idx;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  register Lisp_Object c;
  int metized = 0;
  int length;
829
  int t_ok = ! NILP (accept_default);
Richard M. Stallman's avatar
Richard M. Stallman committed
830
  int meta_bit;
831
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
832

833
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
834

835
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
836 837
    key = wrong_type_argument (Qarrayp, key);

838
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
839 840 841
  if (length == 0)
    return keymap;

842
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
843 844 845 846
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

847 848
  GCPRO1 (key);

Jim Blandy's avatar
Jim Blandy committed
849 850 851 852 853
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

854
      if (CONSP (c) && lucid_event_type_list_p (c))
855
	c = Fevent_convert_list (c);
856

857
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
858
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
859 860 861 862 863 864 865
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
866
	  if (INTEGERP (c))
Richard M. Stallman's avatar
Richard M. Stallman committed
867
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
868 869 870 871 872

	  metized = 0;
	  idx++;
	}

873
      cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1);
Jim Blandy's avatar
Jim Blandy committed
874
      if (idx == length)
875
	RETURN_UNGCPRO (cmd);
Jim Blandy's avatar
Jim Blandy committed
876

877
      keymap = get_keymap_1 (cmd, 0, 1);
878
      if (NILP (keymap))
879
	RETURN_UNGCPRO (make_number (idx));
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883 884

      QUIT;
    }
}

885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
/* 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);
900 901 902 903 904 905 906 907 908 909 910 911 912 913
#if 0
  /* This code is needed to do the right thing in the following case:
     keymap A inherits from B,
     you define KEY as a prefix in A,
     then later you define KEY as a prefix in B.
     We want the old prefix definition in A to inherit from that in B.
     It is hard to do that retroactively, so this code
     creates the prefix in B right away.

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

     So I took out this code.  */
914 915 916 917 918 919 920 921 922 923 924 925 926 927
  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);
    }
928
#endif
929 930 931 932 933 934 935

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

  return cmd;
}

936 937
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
938 939 940 941 942 943 944 945
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

946 947
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);
Jim Blandy's avatar
Jim Blandy committed
948 949 950
}

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

Jim Blandy's avatar
Jim Blandy committed
953
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
954 955
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
956 957 958
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

959 960 961 962 963 964 965
/* Error handler used in current_minor_maps.  */
static Lisp_Object
current_minor_maps_error ()
{
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
/* 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
987
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
988 989 990 991

  for (alist = Vminor_mode_map_alist;
       CONSP (alist);
       alist = XCONS (alist)->cdr)
992 993 994
    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
995
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
996
      {
997 998
	Lisp_Object temp;

Jim Blandy's avatar
Jim Blandy committed
999
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
1003
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
1004
	      {
1005
		BLOCK_INPUT;
1006
		cmm_size *= 2;
Richard M. Stallman's avatar
Richard M. Stallman committed
1007 1008 1009 1010 1011 1012
		newmodes
		  = (Lisp_Object *) realloc (cmm_modes,
					     cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) realloc (cmm_maps,
					     cmm_size * sizeof (Lisp_Object));
1013
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
1014 1015 1016
	      }
	    else
	      {
1017
		BLOCK_INPUT;
1018
		cmm_size = 30;
Richard M. Stallman's avatar
Richard M. Stallman committed
1019 1020 1021 1022
		newmodes
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
1023
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
1024 1025 1026 1027
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
1028 1029
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
1030 1031 1032 1033
	      }
	    else
	      break;
	  }
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044

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

Jim Blandy's avatar
Jim Blandy committed
1047 1048
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
1049 1050 1051
  return i;
}

1052 1053
/* GC is possible in this function if it autoloads a keymap.  */

1054
DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1055
  "Return the binding for command KEY in current keymaps.\n\
1056 1057 1058 1059 1060
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
1061 1062
usable as a general function for probing keymaps.  However, if the\n\
optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1063 1064
recognize the default bindings, just as `read-key-sequence' does.")
  (key, accept_default)
1065
     Lisp_Object key, accept_default;
Jim Blandy's avatar
Jim Blandy committed
1066
{
Jim Blandy's avatar
Jim Blandy committed
1067 1068
  Lisp_Object *maps, value;
  int nmaps, i;
1069 1070 1071
  struct gcpro gcpro1;

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

1073 1074 1075 1076 1077 1078 1079 1080
  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
1081
    {
1082
      value = Flookup_key (Voverriding_local_map, key, accept_default);
1083
      if (! NILP (value) && !INTEGERP (value))
1084
	RETURN_UNGCPRO (value);
Jim Blandy's avatar
Jim Blandy committed
1085
    }
1086 1087
  else
    { 
1088 1089
      Lisp_Object local;

1090
      nmaps = current_minor_maps (0, &maps);
1091 1092 1093
      /* Note that all these maps are GCPRO'd
	 in the places where we found them.  */

1094 1095 1096 1097
      for (i = 0; i < nmaps; i++)
	if (! NILP (maps[i]))
	  {
	    value = Flookup_key (maps[i], key, accept_default);
1098
	    if (! NILP (value) && !INTEGERP (value))
1099
	      RETURN_UNGCPRO (value);
1100 1101
	  }

1102 1103 1104
      local = get_local_map (PT, current_buffer);

      if (! NILP (local))
1105
	{
1106
	  value = Flookup_key (local, key, accept_default);
1107
	  if (! NILP (value) && !INTEGERP (value))
1108
	    RETURN_UNGCPRO (value);
1109 1110
	}
    }
Jim Blandy's avatar
Jim Blandy committed
1111

1112
  value = Flookup_key (current_global_map, key, accept_default);
1113
  UNGCPRO;
1114
  if (! NILP (value) && !INTEGERP (value))
Jim Blandy's avatar
Jim Blandy committed
1115 1116 1117
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
1118 1119
}

1120 1121
/* GC is possible in this function if it autoloads a keymap.  */

1122
DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1123 1124
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
1125 1126 1127 1128 1129 1130
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
1131 1132 1133
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
1134
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
1135
    return Qnil;
1136
  return Flookup_key (map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
1137 1138
}

1139 1140
/* GC is possible in this function if it autoloads a keymap.  */

1141
DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1142 1143
  "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
1144 1145
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\
1146
\(which see).\n\
1147 1148 1149 1150 1151
\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
1152
{
1153
  return Flookup_key (current_global_map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
1154 1155
}

1156 1157
/* GC is possible in this function if it autoloads a keymap.  */

1158
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1159 1160 1161 1162 1163 1164 1165
  "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\
1166 1167 1168 1169 1170 1171
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
1172 1173 1174 1175 1176
{
  Lisp_Object *modes, *maps;
  int nmaps;
  Lisp_Object binding;
  int i, j;
1177
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
1178 1179

  nmaps = current_minor_maps (&modes, &maps);
1180 1181 1182 1183 1184
  /* 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
1185 1186

  for (i = j = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
1187
    if (! NILP (maps[i])
1188
	&& ! NILP (binding = Flookup_key (maps[i], key, accept_default))
1189
	&& !INTEGERP (binding))
Jim Blandy's avatar