keymap.c 93.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2
   Copyright (C) 1985, 86,87,88,93,94,95,98,99 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
#include <stdio.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
29
#include "termhooks.h"
30
#include "blockinput.h"
31
#include "puresize.h"
Dave Love's avatar
Dave Love committed
32
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
33 34

#define min(a, b) ((a) < (b) ? (a) : (b))
35
#define KEYMAPP(m) (!NILP (Fkeymapp (m)))
Jim Blandy's avatar
Jim Blandy committed
36

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

75 76 77 78
/* 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
79 80 81 82 83
/* 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;

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

87 88 89 90 91 92
/* 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;

93
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item;
Jim Blandy's avatar
Jim Blandy committed
94

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

100 101
extern Lisp_Object Voverriding_local_map;

102 103 104 105 106 107 108 109 110 111
static Lisp_Object store_in_keymap P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
static void fix_submap_inheritance P_ ((Lisp_Object, Lisp_Object, Lisp_Object));

static Lisp_Object define_as_prefix P_ ((Lisp_Object, Lisp_Object));
static Lisp_Object describe_buffer_bindings P_ ((Lisp_Object));
static void describe_command P_ ((Lisp_Object));
static void describe_translation P_ ((Lisp_Object));
static void describe_map P_ ((Lisp_Object, Lisp_Object,
			      void (*) P_ ((Lisp_Object)),
			      int, Lisp_Object, Lisp_Object*, int));
Jim Blandy's avatar
Jim Blandy committed
112

Jim Blandy's avatar
Jim Blandy committed
113 114
/* Keymap object support - constructors and predicates.			*/

115
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
116 117
  "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
118 119
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\
120 121 122 123 124
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
125
{
126 127 128 129 130
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
131
  return Fcons (Qkeymap,
132
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
133 134
}

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

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

   For example:

156
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
157 158 159 160 161 162 163 164 165 166

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

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

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

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

   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
222 223 224 225
   Fdefine_key should cause keymaps to be autoloaded.

   This function can GC when AUTOLOAD is non-zero, because it calls
   do_autoload which can GC.  */
226

Jim Blandy's avatar
Jim Blandy committed
227
Lisp_Object
228
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
229
     Lisp_Object object;
230
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
231
{
232
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
233

234
 autoload_retry:
235 236 237 238 239 240 241
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
  else
    {
      tem = indirect_function (object);
242
      if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
243 244
	return tem;
    }
245

246 247
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
248
  if (autoload
249
      && SYMBOLP (object)
250
      && CONSP (tem)
251
      && EQ (XCAR (tem), Qautoload))
252
    {
253
      Lisp_Object tail;
254

255 256 257 258
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
259

260 261
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
262 263 264 265
	  UNGCPRO;

	  goto autoload_retry;
	}
266 267
    }

268
 end:
Jim Blandy's avatar
Jim Blandy committed
269 270
  if (error)
    wrong_type_argument (Qkeymapp, object);
271
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
272 273
}

274 275 276

/* 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
277 278 279 280
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
281
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
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'.  */
297 298
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
299 300
    {
      /* See if there is another `keymap'.  */
301
      if (KEYMAPP (list))
302 303 304
	return list;
    }

305
  return get_keymap_1(list, 0, 1);
306 307
}

308

309 310 311 312 313
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
314
  if (NILP (map)) return 0;
315 316 317 318 319
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

320 321 322 323 324 325 326 327 328
/* 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;
329
  struct gcpro gcpro1;
330
  int i;
Jim Blandy's avatar
Jim Blandy committed
331

332
  keymap = get_keymap_1 (keymap, 1, 1);
333 334
  GCPRO1 (keymap);
  
335
  if (!NILP (parent))
336 337 338 339
    {
      parent = get_keymap_1 (parent, 1, 1);

      /* Check for cycles.  */
340
      if (keymap_memberp (keymap, parent))
341 342
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
343

344 345 346 347
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
348
      list = XCDR (prev);
349 350
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
351
      if (! CONSP (list) || KEYMAPP (list))
352
	{
353 354
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
355
	  if (EQ (XCDR (prev), parent))
356
	    RETURN_UNGCPRO (parent);
357

358
	  XCDR (prev) = parent;
359 360 361 362 363 364 365
	  break;
	}
      prev = list;
    }

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

366
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
367 368
    {
      /* Stop the scan when we come to the parent.  */
369
      if (EQ (XCAR (list), Qkeymap))
370 371 372
	break;

      /* If this element holds a prefix map, deal with it.  */
373 374 375 376 377 378 379 380
      if (CONSP (XCAR (list))
	  && CONSP (XCDR (XCAR (list))))
	fix_submap_inheritance (keymap, XCAR (XCAR (list)),
				XCDR (XCAR (list)));

      if (VECTORP (XCAR (list)))
	for (i = 0; i < XVECTOR (XCAR (list))->size; i++)
	  if (CONSP (XVECTOR (XCAR (list))->contents[i]))
381
	    fix_submap_inheritance (keymap, make_number (i),
382
				    XVECTOR (XCAR (list))->contents[i]);
383

384
      if (CHAR_TABLE_P (XCAR (list)))
385
	{
386
	  Lisp_Object indices[3];
387

388
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
389 390
			  keymap, 0, indices);
	}
391 392
    }

393
  RETURN_UNGCPRO (parent);
394 395 396 397 398 399
}

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

400
static void
401 402 403 404 405 406 407 408
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.  */

409
  submap = get_keymap_1 (get_keyelt (submap, 0), 0, 0);
410 411

  /* If it isn't a keymap now, there's no work to do.  */
412
  if (NILP (submap))
413 414 415 416
    return;

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

421 422
  /* If MAP's parent has something other than a keymap,
     our own submap shadows it completely, so use nil as SUBMAP's parent.  */
423
  if (! KEYMAPP (parent_entry))
424 425
    parent_entry = Qnil;

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

454 455 456
   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
457 458

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

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

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

483 484 485
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
      Lisp_Object meta_map;

      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
      meta_map = access_keymap (map, meta_prefix_char, t_ok, noinherit,
				autoload);
      if (KEYMAPP (meta_map))
	{
	  map = get_keymap_1 (meta_map, 0, autoload);
	  idx = make_number (XUINT (idx) & ~meta_modifier);
	}
      else if (t_ok)
	/* Set IDX to t, so that we only find a default binding.  */
	idx = Qt;
      else
	/* We know there is no binding.  */
	return Qnil;
503 504
    }

505 506
  {
    Lisp_Object tail;
507
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
508

509
    t_binding = Qnil;
510
    for (tail = XCDR (map);
511 512 513
	 (CONSP (tail)
	  || (tail = get_keymap_1 (tail, 0, autoload),
	      CONSP (tail)));
514
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
515
      {
516
	Lisp_Object binding;
517

518
	binding = XCAR (tail);
519
	if (SYMBOLP (binding))
520
	  {
521 522
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
523
	    if (noinherit && EQ (binding, Qkeymap))
524
	      noprefix = 1;
525 526 527
	  }
	else if (CONSP (binding))
	  {
528
	    if (EQ (XCAR (binding), idx))
529
	      {
530
		val = XCDR (binding);
531
		if (noprefix && KEYMAPP (val))
532
		  return Qnil;
533 534
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
535
		return get_keyelt (val, autoload);
536
	      }
537 538
	    if (t_ok && EQ (XCAR (binding), Qt))
	      t_binding = XCDR (binding);
539 540 541
	  }
	else if (VECTORP (binding))
	  {
542
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
543
	      {
544
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
545
		if (noprefix && KEYMAPP (val))
546
		  return Qnil;
547 548
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
549
		return get_keyelt (val, autoload);
550
	      }
551
	  }
552 553
	else if (CHAR_TABLE_P (binding))
	  {
554 555 556 557 558 559 560
	    /* 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)))
561 562
	      {
		val = Faref (binding, idx);
563
		if (noprefix && KEYMAPP (val))
564 565 566
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
567
		return get_keyelt (val, autoload);
568 569
	      }
	  }
570 571

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
572
      }
573

574
    return get_keyelt (t_binding, autoload);
575
  }
Jim Blandy's avatar
Jim Blandy committed
576 577 578 579 580 581 582 583 584
}

/* 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,
585 586 587 588
   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
589 590

Lisp_Object
591
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
592
     register Lisp_Object object;
593
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
594 595 596
{
  while (1)
    {
597 598 599
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
600

601 602 603 604 605 606 607
      /* 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.
608
	 This is a new format menu item.  */
609
      else if (EQ (XCAR (object), Qmenu_item))
610
	{
611
	  if (CONSP (XCDR (object)))
612
	    {
613 614
	      Lisp_Object tem;

615
	      object = XCDR (XCDR (object));
616
	      tem = object;
617 618
	      if (CONSP (object))
		object = XCAR (object);
619 620 621

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
622 623 624
		 use.  Temporarily inhibit GC while evaluating FILTER,
	         because not functions calling get_keyelt are prepared
		 for a GC.  */
625 626 627
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
		if (EQ (XCAR (tem), QCfilter))
		  {
628
		    int count = inhibit_garbage_collection ();
629 630 631 632
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
633
		    unbind_to (count, Qnil);
634 635
		    break;
		  }
636 637
	    }
	  else
638 639
	    /* Invalid keymap */
	    return object;
640 641
	}

642
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
643 644
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
645
      else if (STRINGP (XCAR (object)))
646
	{
647
	  object = XCDR (object);
648 649
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
650 651
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
652
	  /* Also remove the sublist that caches key equivalences, if any.  */
653
	  if (CONSP (object) && CONSP (XCAR (object)))
654
	    {
655
	      Lisp_Object carcar;
656
	      carcar = XCAR (XCAR (object));
657
	      if (NILP (carcar) || VECTORP (carcar))
658
		object = XCDR (object);
659
	    }
660
	}
Jim Blandy's avatar
Jim Blandy committed
661

662 663
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
664
	{
665
	  Lisp_Object map;
666
	  map = get_keymap_1 (Fcar_safe (object), 0, autoload);
667 668
	  return (NILP (map) ? object /* Invalid keymap */
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
669
	}
Jim Blandy's avatar
Jim Blandy committed
670 671 672
    }
}

673
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
674 675 676 677 678
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
679
  /* If we are preparing to dump, and DEF is a menu element
680 681
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
682 683
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
684

685
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
686 687
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
688 689 690
  /* 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.  */
691
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
692

693 694
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
695
  if (SYMBOLP (idx))
696
    idx = reorder_modifiers (idx);
697 698 699
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
700
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
701 702

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
703
  {
704
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
705

706 707 708 709 710 711
    /* 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.  */
712
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
713

714
    insertion_point = keymap;
715
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
716
      {
717
	Lisp_Object elt;
718

719
	elt = XCAR (tail);
720
	if (VECTORP (elt))
721
	  {
722
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
723 724 725 726 727
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
728
	  }
729 730
	else if (CHAR_TABLE_P (elt))
	  {
731 732 733 734 735 736 737
	    /* 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)))
738 739 740 741 742 743
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
744 745
	else if (CONSP (elt))
	  {
746
	    if (EQ (idx, XCAR (elt)))
747
	      {
748
		XCDR (elt) = def;
749 750
		return def;
	      }
751 752 753
	  }
	else if (SYMBOLP (elt))
	  {
754 755 756 757 758 759 760
	    /* 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;
	  }
761 762

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
763 764
      }

765 766 767
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
768 769
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
770
  }
771
  
Jim Blandy's avatar
Jim Blandy committed
772 773 774
  return def;
}

775
void
776 777 778
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
779 780
  if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt)))
    Faset (chartable, idx, Fcopy_keymap (elt));
781
}
782

Jim Blandy's avatar
Jim Blandy committed
783 784 785 786
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
787 788 789
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
790 791 792 793 794 795 796
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

797
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
798
    {
799
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
800

801
      elt = XCAR (tail);
802 803
      if (CHAR_TABLE_P (elt))
	{
804
	  Lisp_Object indices[3];
805 806

	  elt = Fcopy_sequence (elt);
807
	  XCAR (tail) = elt;
808

809 810 811
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
812
	{
813
	  int i;
Jim Blandy's avatar
Jim Blandy committed
814

815
	  elt = Fcopy_sequence (elt);
816
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
817

818
	  for (i = 0; i < XVECTOR (elt)->size; i++)
819
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
820
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
821 822
	      XVECTOR (elt)->contents[i]
		= Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
823
	}
824
      else if (CONSP (elt) && CONSP (XCDR (elt)))
825
	{
826
	  Lisp_Object tem;
827
	  tem = XCDR (elt);
828

829
	  /* Is this a new format menu item.  */
830
	  if (EQ (XCAR (tem),Qmenu_item))
831 832
	    {
	      /* Copy cell with menu-item marker.  */
833 834 835 836
	      XCDR (elt)
		= Fcons (XCAR (tem), XCDR (tem));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
837 838 839
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
840 841 842 843
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
844 845 846 847 848
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
849 850 851 852
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCAR (elt);
853
		  if (!(SYMBOLP (tem) || NILP (Fkeymapp (tem))))
854 855 856
		    XCAR (elt) = Fcopy_keymap (tem);
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
857
		    /* Delete cache for key equivalences.  */
858
		    XCDR (elt) = XCDR (tem);
859 860 861 862 863 864 865
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
866
	      if (STRINGP (XCAR (tem)))
867
		{
868
		  /* Copy the cell, since copy-alist didn't go this deep.  */
869 870 871 872
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
873
		  /* Also skip the optional menu help string.  */
874
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
875
		    {
876 877 878 879
		      XCDR (elt)
			= Fcons (XCAR (tem), XCDR (tem));
		      elt = XCDR (elt);
		      tem = XCDR (elt);
880 881 882 883
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
884 885 886 887
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
		    XCDR (elt) = XCDR (tem);
888
		}
889
	      if (CONSP (elt)
890 891 892
		  && ! SYMBOLP (XCDR (elt))
		  && ! NILP (Fkeymapp (XCDR (elt))))
		XCDR (elt) = Fcopy_keymap (XCDR (elt));
893
	    }
894

895
	}
Jim Blandy's avatar
Jim Blandy committed
896
    }
897
	      
Jim Blandy's avatar
Jim Blandy committed
898 899 900
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
901 902
/* Simple Keymap mutators and accessors.				*/

903 904
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
905 906 907 908
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
909 910
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
911 912 913 914 915 916 917 918 919 920
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
921 922 923 924
 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
925
  (keymap, key, def)
926
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
927 928 929 930 931 932 933
     Lisp_Object key;
     Lisp_Object def;
{
  register int idx;
  register Lisp_Object c;
  register Lisp_Object cmd;
  int metized = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
934
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
935
  int length;
936
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
937

938
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
939

940
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
941 942
    key = wrong_type_argument (Qarrayp, key);

943
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
944 945 946
  if (length == 0)
    return Qnil;