keymap.c 93.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985, 86,87,88,93,94,95,98 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
#include <stdio.h>
Andreas Schwab's avatar
Andreas Schwab committed
24 25 26
#ifdef STDC_HEADERS
#include <stdlib.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
27 28 29 30
#undef NULL
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
31
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
32
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
33
#include "termhooks.h"
34
#include "blockinput.h"
35
#include "puresize.h"
Jim Blandy's avatar
Jim Blandy committed
36 37 38

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

39
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
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 71 72 73
#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
74 75 76
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

77 78 79 80
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

Jim Blandy's avatar
Jim Blandy committed
81 82 83 84 85
/* 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;

86 87 88
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

89 90 91 92 93 94
/* 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;

95
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item;
Jim Blandy's avatar
Jim Blandy committed
96

Jim Blandy's avatar
Jim Blandy committed
97 98 99
/* 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
100 101
extern Lisp_Object meta_prefix_char;

102 103
extern Lisp_Object Voverriding_local_map;

104
static Lisp_Object define_as_prefix ();
Jim Blandy's avatar
Jim Blandy committed
105
static Lisp_Object describe_buffer_bindings ();
106
static void describe_command (), describe_translation ();
Jim Blandy's avatar
Jim Blandy committed
107 108
static void describe_map ();

Jim Blandy's avatar
Jim Blandy committed
109 110
/* Keymap object support - constructors and predicates.			*/

111
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
112 113
  "Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).\n\
CHARTABLE is a char-table that holds the bindings for the ASCII\n\
Jim Blandy's avatar
Jim Blandy committed
114 115
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\
116 117 118 119 120
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
121
{
122 123 124 125 126
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
127
  return Fcons (Qkeymap,
128
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
129 130
}

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

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

   For example:

152
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
153 154 155 156 157 158 159 160 161 162

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

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

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

/* Check that OBJECT is a keymap (after dereferencing through any
204 205 206 207
   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.
208
   If AUTOLOAD is nonzero, callers must assume GC is possible.
209 210 211 212 213 214 215 216 217 218

   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
219
Lisp_Object
220
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
221
     Lisp_Object object;
222
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
223
{
224
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
225

226
 autoload_retry:
227 228 229 230 231 232 233 234 235 236
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
  else
    {
      tem = indirect_function (object);
      if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap))
	return tem;
    }
237

238 239
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
240
  if (autoload
241
      && SYMBOLP (object)
242 243 244
      && CONSP (tem)
      && EQ (XCONS (tem)->car, Qautoload))
    {
245
      Lisp_Object tail;
246

247 248 249 250
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
251

252 253
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
254 255 256 257
	  UNGCPRO;

	  goto autoload_retry;
	}
258 259
    }

260
 end:
Jim Blandy's avatar
Jim Blandy committed
261 262
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
263 264
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
265 266
}

267 268 269

/* 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
270 271 272 273
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
274
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
275
}
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310

/* 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
311

312 313 314
  keymap = get_keymap_1 (keymap, 1, 1);
  if (!NILP (parent))
    parent = get_keymap_1 (parent, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
315

316 317 318 319 320 321 322 323 324
  /* 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))
	{
325 326 327 328 329
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
	  if (EQ (XCONS (prev)->cdr, parent))
	    return parent;

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
	  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]);
355 356 357

      if (CHAR_TABLE_P (XCONS (list)->car))
	{
358
	  Lisp_Object indices[3];
359 360 361 362

	  map_char_table (fix_submap_inheritance, Qnil, XCONS (list)->car,
			  keymap, 0, indices);
	}
363 364 365 366 367 368 369 370 371
    }

  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.  */

372
void
373 374 375 376 377 378 379 380
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.  */

381
  if (CONSP (submap))
382
    {
383
      /* May be an old format menu item */
384
      if (STRINGP (XCONS (submap)->car))
385
	{
386 387 388 389
	  submap = XCONS (submap)->cdr;
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
	  if (CONSP (submap) && STRINGP (XCONS (submap)->car))
390
	    submap = XCONS (submap)->cdr;
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
	  /* 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;
	    }
	}

      /* Or a new format menu item */
      else if (EQ (XCONS (submap)->car, Qmenu_item)
	       && CONSP (XCONS (submap)->cdr))
	{
	  submap = XCONS (XCONS (submap)->cdr)->cdr;
	  if (CONSP (submap))
	    submap = XCONS (submap)->car;
409 410 411 412 413 414 415 416 417 418 419 420 421 422
	}
    }

  /* 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;

423 424 425 426 427
  /* 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;

428
  if (! EQ (parent_entry, submap))
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
	  tem = Fkeymap_parent (submap_parent);
	  if (EQ (tem, parent_entry))
	    return;
          if (CONSP (tem)
	      && EQ (XCONS (tem)->car, Qkeymap))
	    submap_parent = tem;
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
446 447
}

Jim Blandy's avatar
Jim Blandy committed
448
/* Look up IDX in MAP.  IDX may be any sort of event.
449
   Note that this does only one level of lookup; IDX must be a single
450 451 452 453 454 455
   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.  

456 457 458
   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
459 460

Lisp_Object
461
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
462 463
     Lisp_Object map;
     Lisp_Object idx;
464
     int t_ok;
465
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
466
{
467 468 469
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
470 471 472
  /* 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.  */
473
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
474

475 476
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
477
  if (SYMBOLP (idx))
478
    idx = reorder_modifiers (idx);
479 480 481
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
482
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
483

484 485
  {
    Lisp_Object tail;
486
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
487

488
    t_binding = Qnil;
489
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
490
      {
491
	Lisp_Object binding;
492

493
	binding = XCONS (tail)->car;
494
	if (SYMBOLP (binding))
495
	  {
496 497 498 499
	    /* 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;
500 501 502
	  }
	else if (CONSP (binding))
	  {
503
	    if (EQ (XCONS (binding)->car, idx))
504 505 506 507
	      {
		val = XCONS (binding)->cdr;
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
508 509
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
510 511
		return val;
	      }
512 513
	    if (t_ok && EQ (XCONS (binding)->car, Qt))
	      t_binding = XCONS (binding)->cdr;
514 515 516
	  }
	else if (VECTORP (binding))
	  {
517
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
518
	      {
519
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
520 521
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
522 523
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
524 525
		return val;
	      }
526
	  }
527 528
	else if (CHAR_TABLE_P (binding))
	  {
529 530 531 532 533 534 535
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
	    if (NATNUMP (idx)
		&& ! (XFASTINT (idx)
		      & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER
			 | CHAR_SHIFT | CHAR_CTL | CHAR_META)))
536 537 538 539 540 541 542 543 544
	      {
		val = Faref (binding, idx);
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
		return val;
	      }
	  }
545 546

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
547
      }
548

549 550
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
551 552 553 554 555 556 557 558 559
}

/* 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,
560 561 562 563
   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
564 565

Lisp_Object
566
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
567
     register Lisp_Object object;
568
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
569 570 571
{
  while (1)
    {
572 573 574
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
575

576 577 578 579 580 581 582 583 584 585
      /* If the keymap contents looks like (keymap ...) or (lambda ...)
	 then use itself. */
      else if (EQ (XCAR (object), Qkeymap) || EQ (XCAR (object), Qlambda))
	return object;

      /* If the keymap contents looks like (menu-item name . DEFN)
	 or (menu-item name DEFN ...) then use DEFN.
	 This is a new format menu item.
      */
      else if (EQ (XCAR (object), Qmenu_item))
586
	{
587
	  if (CONSP (XCDR (object)))
588
	    {
589 590 591
	      object = XCDR (XCDR (object));
	      if (CONSP (object))
		object = XCAR (object);
592 593
	    }
	  else
594 595
	    /* Invalid keymap */
	    return object;
596 597
	}

598
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
599 600
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
601
      else if (STRINGP (XCAR (object)))
602
	{
603
	  object = XCDR (object);
604 605
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
606 607
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
608
	  /* Also remove the sublist that caches key equivalences, if any.  */
609
	  if (CONSP (object) && CONSP (XCAR (object)))
610
	    {
611
	      Lisp_Object carcar;
612
	      carcar = XCAR (XCAR (object));
613
	      if (NILP (carcar) || VECTORP (carcar))
614
		object = XCDR (object);
615
	    }
616
	}
Jim Blandy's avatar
Jim Blandy committed
617

618 619
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
620
	{
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
	  register Lisp_Object map;
	  map = get_keymap_1 (Fcar_safe (object), 0, autoload);
	  if (NILP (map))
	    /* Invalid keymap */
	    return object;
	  else
	    {
	      Lisp_Object key;
	      key = Fcdr (object);
	      if (INTEGERP (key) && (XINT (key) & meta_modifier))
		{
		  object = access_keymap (map, meta_prefix_char, 0, 0);
		  map = get_keymap_1 (object, 0, autoload);
		  object = access_keymap (map, make_number (XINT (key)
							    & ~meta_modifier),
					  0, 0);
		}
	      else
		object = access_keymap (map, key, 0, 0);
	    }
641
	}
Jim Blandy's avatar
Jim Blandy committed
642 643 644 645 646 647 648 649 650
    }
}

Lisp_Object
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
651
  /* If we are preparing to dump, and DEF is a menu element
652 653 654
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
      && (EQ (XCONS (def)->car, Qmenu_item) || STRINGP (XCONS (def)->car)))
655 656
    def = Fcons (XCONS (def)->car, XCONS (def)->cdr);

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

Jim Blandy's avatar
Jim Blandy committed
660 661 662
  /* 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.  */
663
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
664

665 666
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
667
  if (SYMBOLP (idx))
668
    idx = reorder_modifiers (idx);
669 670 671
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
672
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
673 674

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
675
  {
676
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
677

678 679 680 681 682 683
    /* 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.  */
684
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
685

686
    insertion_point = keymap;
687
    for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
688
      {
689
	Lisp_Object elt;
690

691
	elt = XCONS (tail)->car;
692
	if (VECTORP (elt))
693
	  {
694
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
695 696 697 698 699
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
700
	  }
701 702
	else if (CHAR_TABLE_P (elt))
	  {
703 704 705 706 707 708 709
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
	    if (NATNUMP (idx)
		&& ! (XFASTINT (idx)
		      & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER
			 | CHAR_SHIFT | CHAR_CTL | CHAR_META)))
710 711 712 713 714 715
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
716 717
	else if (CONSP (elt))
	  {
718 719 720 721 722
	    if (EQ (idx, XCONS (elt)->car))
	      {
		XCONS (elt)->cdr = def;
		return def;
	      }
723 724 725
	  }
	else if (SYMBOLP (elt))
	  {
726 727 728 729 730 731 732
	    /* 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;
	  }
733 734

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
735 736
      }

737 738 739
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
740 741
    XCONS (insertion_point)->cdr
      = Fcons (Fcons (idx, def), XCONS (insertion_point)->cdr);
742 743
  }
	  
Jim Blandy's avatar
Jim Blandy committed
744 745 746
  return def;
}

747
void
748 749 750
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
751 752
  if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt)))
    Faset (chartable, idx, Fcopy_keymap (elt));
753
}
754

Jim Blandy's avatar
Jim Blandy committed
755 756 757 758
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
759 760 761
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
762 763 764 765 766 767 768
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

769
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
770
    {
771
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
772

773
      elt = XCONS (tail)->car;
774 775
      if (CHAR_TABLE_P (elt))
	{
776
	  Lisp_Object indices[3];
777 778

	  elt = Fcopy_sequence (elt);
779 780
	  XCONS (tail)->car = elt;

781 782 783
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
784
	{
785
	  int i;
Jim Blandy's avatar
Jim Blandy committed
786

787 788
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
789

790
	  for (i = 0; i < XVECTOR (elt)->size; i++)
791
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
792
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
793 794
	      XVECTOR (elt)->contents[i]
		= Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
795
	}
796
      else if (CONSP (elt) && CONSP (XCONS (elt)->cdr))
797
	{
798 799
	  Lisp_Object tem;
	  tem = XCONS (elt)->cdr;
800

801 802 803 804 805 806
	  /* Is this a new format menu item.  */
	  if (EQ (XCONS (tem)->car,Qmenu_item))
	    {
	      /* Copy cell with menu-item marker.  */
	      XCONS (elt)->cdr
		= Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
807
	      elt = XCONS (elt)->cdr;
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
	      tem = XCONS (elt)->cdr;
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
		  XCONS (elt)->cdr
		    = Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
		  elt = XCONS (elt)->cdr;
		  tem = XCONS (elt)->cdr;
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
		  XCONS (elt)->cdr
		    = Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
		  elt = XCONS (elt)->cdr;
		  tem = XCONS (elt)->car;
		  if (!(SYMBOLP (tem) || NILP (Fkeymapp (tem))))
		    XCONS (elt)->car = Fcopy_keymap (tem);
		  tem = XCONS (elt)->cdr;
		  if (CONSP (tem) && CONSP (XCONS (tem)->car))
		    /* Delete cache for key equivalences.  */
		    XCONS (elt)->cdr = XCONS (tem)->cdr;
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
	      if (STRINGP (XCONS (tem)->car))
839
		{
840 841 842
		  /* Copy the cell, since copy-alist didn't go this deep.  */
		  XCONS (elt)->cdr
		    = Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
843
		  elt = XCONS (elt)->cdr;
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
		  tem = XCONS (elt)->cdr;
		  /* Also skip the optional menu help string.  */
		  if (CONSP (tem) && STRINGP (XCONS (tem)->car))
		    {
		      XCONS (elt)->cdr
			= Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
		      elt = XCONS (elt)->cdr;
		      tem = XCONS (elt)->cdr;
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
		      && CONSP (XCONS (tem)->car)
		      && (NILP (XCONS (XCONS (tem)->car)->car)
			  || VECTORP (XCONS (XCONS (tem)->car)->car)))
		    XCONS (elt)->cdr = XCONS (tem)->cdr;
860
		}
861 862 863 864
	      if (CONSP (elt)
		  && ! SYMBOLP (XCONS (elt)->cdr)
		  && ! NILP (Fkeymapp (XCONS (elt)->cdr)))
		XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr);
865
	    }
866

867
	}
Jim Blandy's avatar
Jim Blandy committed
868
    }
869
	      
Jim Blandy's avatar
Jim Blandy committed
870 871 872
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
873 874
/* Simple Keymap mutators and accessors.				*/

875 876
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
877 878 879 880
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
881 882
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
883 884 885 886 887 888 889 890 891 892
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
893 894 895 896
 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
897
  (keymap, key, def)
898
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
899 900 901 902 903 904 905 906
     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
907
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
908
  int length;
909
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
910

911
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
912

913
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
914 915
    key = wrong_type_argument (Qarrayp, key);

916
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
917 918 919
  if (length == 0)
    return Qnil;

920 921 922
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

923 924
  GCPRO3 (keymap, key, def);

925
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
926 927 928 929
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
930 931 932 933 934
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

935
      if (CONSP (c) && lucid_event_type_list_p (c))
936
	c = Fevent_convert_list (c);
937

938
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
939
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
940 941 942 943 944 945 946
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
947
	  if (INTEGERP (c))
948
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
949 950 951 952 953

	  metized = 0;
	  idx++;
	}

954
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
955
	error ("Key sequence contains invalid events");
956

Jim Blandy's avatar
Jim Blandy committed
957
      if (idx == length)
958
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
959

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

962
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
963
      if (NILP (cmd))
964
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
965

966 967
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
968 969 970 971
	/* 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
972 973 974 975
    }
}

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

978
DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
979 980
  "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\
981
\n\
Jim Blandy's avatar
Jim Blandy committed
982 983 984 985
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\
986 987 988 989
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
990
usable as a general function for probing keymaps.  However, if the\n\
991 992 993
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
994 995
     register Lisp_Object keymap;
     Lisp_Object key;
996
     Lisp_Object accept_default;
Jim Blandy's avatar
Jim Blandy committed
997 998 999 1000 1001 1002 1003
{
  register int idx;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  register Lisp_Object c;
  int metized = 0;
  int length;
1004
  int t_ok = ! NILP (accept_default);
Richard M. Stallman's avatar
Richard M. Stallman committed
1005
  int meta_bit;
1006
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
1007

1008
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
1009

1010
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
1011 1012
    key = wrong_type_argument (Qarrayp, key);

1013
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
1014 1015 1016
  if (length == 0)
    return keymap;

1017
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
1018 1019 1020 1021
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

1022 1023
  GCPRO1 (key);

Jim Blandy's avatar
Jim Blandy committed
1024 1025 1026 1027 1028
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

1029
      if (CONSP (c) && lucid_event_type_list_p (c))
1030
	c = Fevent_convert_list (c);
1031

1032
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
1033
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036 1037 1038 1039 1040
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
1041
	  if (INTEGERP (c))
Richard M. Stallman's avatar
Richard M. Stallman committed
1042
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046 1047

	  metized = 0;
	  idx++;
	}

1048
      cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1);
Jim Blandy's avatar
Jim Blandy committed
1049
      if (idx == length)
1050
	RETURN_UNGCPRO (cmd);
Jim Blandy's avatar
Jim Blandy committed
1051

1052
      keymap = get_keymap_1 (cmd, 0, 1);
1053
      if (NILP (keymap))
1054
	RETURN_UNGCPRO (make_number (idx));
Jim Blandy's avatar
Jim Blandy committed
1055 1056 1057 1058 1059

      QUIT;
    }
}

1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
/* 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);
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
#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.  */
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
  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);
    }
1103
#endif
1104 1105 1106 1107 1108 1109 1110

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

  return cmd;
}

1111 1112
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
1113 1114 1115 1116 1117 1118 1119 1120
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

1121 1122
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);
Jim Blandy's avatar
Jim Blandy committed
1123 1124 1125
}

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

Jim Blandy's avatar
Jim Blandy committed
1128
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
1129 1130
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
1131 1132 1133
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

1134 1135 1136 1137 1138 1139 1140
/* Error handler used in current_minor_maps.  */
static Lisp_Object
current_minor_maps_error ()
{
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/* 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;
1162
  int list_number = 0;
Jim Blandy's avatar
Jim Blandy committed
1163
  Lisp_Object alist, assoc, var, val;
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
  Lisp_Object lists[2];

  lists[0] = Vminor_mode_overriding_map_alist;
  lists[1] = Vminor_mode_map_alist;

  for (list_number = 0; list_number < 2; list_number++)
    for (alist = lists[list_number];
	 CONSP (alist);
	 alist = XCONS (alist)->cdr)
      if ((assoc = XCONS (alist)->car, CONSP (assoc))
	  && (var = XCONS (assoc)->car, SYMBOLP (var))
	  && (val = find_symbol_value (var), ! EQ (val, Qunbound))
	  && ! NILP (val))
	{
	  Lisp_Object temp;
Jim Blandy's avatar
Jim Blandy committed
1179

Richard M. Stallman's avatar
Richard M. Stallman committed
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
	  /* If a variable has an entry in Vminor_mode_overriding_map_alist,
	     and also an entry in Vminor_mode_map_alist,
	     ignore the latter.  */
	  if (list_number == 1)
	    {
	      val = assq_no_quit (var, lists[0]);
	      if (!NILP (val))
		break;
	    }

1190 1191 1192
	  if (i >= cmm_size)
	    {
	      Lisp_Object *newmodes, *newmaps;
Jim Blandy's avatar
Jim Blandy committed
1193

1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
	      if (cmm_maps)
		{
		  BLOCK_INPUT;
		  cmm_size *= 2;
		  newmodes
		    = (Lisp_Object *) realloc (cmm_modes,
					       cmm_size * sizeof (Lisp_Object));
		  newmaps
		    = (Lisp_Object *) realloc (cmm_maps,
					       cmm_size * sizeof (Lisp_Object));
		  UNBLOCK_INPUT;
		}
	      else
		{
		  BLOCK_INPUT;
		  cmm_size = 30;
		  newmodes
		    = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
		  newmaps
		    = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
		  UNBLOCK_INPUT;
		}
Jim Blandy's avatar
Jim Blandy committed
1216

1217 1218 1219 1220 1221 1222 1223 1224
	      if (newmaps && newmodes)
		{
		  cmm_modes = newmodes;
		  cmm_maps = newmaps;
		}
	      else
		break;
	    }
1225

1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
	  /* 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
1237

Jim Blandy's avatar
Jim Blandy committed
1238 1239
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar