keymap.c 104 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, 2000, 2001
Gerd Moellmann's avatar
Gerd Moellmann committed
3
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27
#include <stdio.h>
#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"
Dave Love's avatar
Dave Love committed
33
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
34
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
35

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
#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 */
58
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
59 60 61 62 63 64 65 66 67 68 69 70
				/* 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;

74 75 76 77
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

78 79 80
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

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, Qremap;
Jim Blandy's avatar
Jim Blandy committed
96

97 98 99
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

100 101 102
/* Pre-allocated 2-element vector for Fremap_command to use.  */
static Lisp_Object remap_command_vector;

Jim Blandy's avatar
Jim Blandy committed
103 104 105
/* 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
106 107
extern Lisp_Object meta_prefix_char;

108 109
extern Lisp_Object Voverriding_local_map;

110 111 112 113 114
/* Hash table used to cache a reverse-map to speed up calls to where-is.  */
static Lisp_Object where_is_cache;
/* Which keymaps are reverse-stored in the cache.  */
static Lisp_Object where_is_cache_keymaps;

115 116 117 118
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));
119 120
static void describe_command P_ ((Lisp_Object, Lisp_Object));
static void describe_translation P_ ((Lisp_Object, Lisp_Object));
121
static void describe_map P_ ((Lisp_Object, Lisp_Object,
122
			      void (*) P_ ((Lisp_Object, Lisp_Object)),
123
			      int, Lisp_Object, Lisp_Object*, int));
124
static void silly_event_symbol_error P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
125

Jim Blandy's avatar
Jim Blandy committed
126 127
/* Keymap object support - constructors and predicates.			*/

128
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
129 130 131 132 133 134 135 136 137
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
CHARTABLE is a char-table that holds the bindings for the ASCII
characters.  ALIST is an assoc-list which holds bindings for function keys,
mouse events, and any other things that appear in the input stream.
All entries in it are initially nil, meaning "command undefined".

The optional arg STRING supplies a menu name for the keymap
in case you use it as a menu with `x-popup-menu'.  */)
     (string)
138
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
139
{
140 141 142 143 144
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
145
  return Fcons (Qkeymap,
146
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
147 148
}

149
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
150 151 152 153 154 155 156 157 158
       doc: /* Construct and return a new sparse keymap.
Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
which binds the function key or mouse event SYMBOL to DEFINITION.
Initially the alist is nil.

The optional arg STRING supplies a menu name for the keymap
in case you use it as a menu with `x-popup-menu'.  */)
     (string)
159
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
160
{
161 162
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169 170
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

171
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
172 173 174 175 176 177 178 179 180 181

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

182 183 184 185 186 187 188 189 190
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
191
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
192 193 194 195 196 197 198 199
       doc: /* Return t if OBJECT is a keymap.

A keymap is a list (keymap . ALIST),
or a symbol whose function definition is itself a keymap.
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
a vector of densely packed bindings for small character codes
is also allowed as an element.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
200 201
     Lisp_Object object;
{
202
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
203 204
}

205
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
206 207 208 209
       doc: /* Return the prompt-string of a keymap MAP.
If non-nil, the prompt is shown in the echo-area
when reading a key-sequence to be looked-up in this keymap.  */)
     (map)
210 211 212 213 214 215 216 217 218 219 220 221 222
     Lisp_Object map;
{
  while (CONSP (map))
    {
      register Lisp_Object tem;
      tem = Fcar (map);
      if (STRINGP (tem))
	return tem;
      map = Fcdr (map);
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
223
/* Check that OBJECT is a keymap (after dereferencing through any
224 225 226 227
   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.
228
   If AUTOLOAD is nonzero, callers must assume GC is possible.
229

230 231 232
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

233 234 235 236 237 238 239
   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
240 241 242 243
   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.  */
244

Jim Blandy's avatar
Jim Blandy committed
245
Lisp_Object
246
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
247
     Lisp_Object object;
248
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
249
{
250
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
251

252
 autoload_retry:
253 254 255 256
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
257

258 259
  tem = indirect_function (object);
  if (CONSP (tem))
260
    {
261 262
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
263

264 265 266
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload))
267
	{
268
	  Lisp_Object tail;
269

270 271 272 273 274 275
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
276

277 278 279
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
280

281 282 283 284 285
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
286
	}
287 288
    }

289
 end:
Jim Blandy's avatar
Jim Blandy committed
290 291
  if (error)
    wrong_type_argument (Qkeymapp, object);
292
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
293
}
294

295 296
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
297

298 299
Lisp_Object
keymap_parent (keymap, autoload)
300
     Lisp_Object keymap;
301
     int autoload;
302 303 304
{
  Lisp_Object list;

305
  keymap = get_keymap (keymap, 1, autoload);
306 307

  /* Skip past the initial element `keymap'.  */
308 309
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
310 311
    {
      /* See if there is another `keymap'.  */
312
      if (KEYMAPP (list))
313 314 315
	return list;
    }

316
  return get_keymap (list, 0, autoload);
317 318
}

319 320 321 322 323 324 325
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
       doc: /* Return the parent keymap of KEYMAP.  */)
     (keymap)
     Lisp_Object keymap;
{
  return keymap_parent (keymap, 1);
}
326

327 328 329 330 331
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
332
  if (NILP (map)) return 0;
333
  while (KEYMAPP (maps) && !EQ (map, maps))
334
    maps = keymap_parent (maps, 0);
335 336 337
  return (EQ (map, maps));
}

338 339 340
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
341 342 343
       doc: /* Modify KEYMAP to set its parent map to PARENT.
PARENT should be nil or another keymap.  */)
     (keymap, parent)
344 345 346
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
347
  struct gcpro gcpro1, gcpro2;
348
  int i;
Jim Blandy's avatar
Jim Blandy committed
349

350 351 352 353 354 355 356 357 358
  /* Force a keymap flush for the next call to where-is.
     Since this can be called from within where-is, we don't set where_is_cache
     directly but only where_is_cache_keymaps, since where_is_cache shouldn't
     be changed during where-is, while where_is_cache_keymaps is only used at
     the very beginning of where-is and can thus be changed here without any
     adverse effect.
     This is a very minor correctness (rather than safety) issue.  */
  where_is_cache_keymaps = Qt;

359
  GCPRO2 (keymap, parent);
360
  keymap = get_keymap (keymap, 1, 1);
361

362
  if (!NILP (parent))
363
    {
364
      parent = get_keymap (parent, 1, 1);
365 366

      /* Check for cycles.  */
367
      if (keymap_memberp (keymap, parent))
368 369
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
370

371 372 373 374
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
375
      list = XCDR (prev);
376 377
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
378
      if (!CONSP (list) || KEYMAPP (list))
379
	{
380 381
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
382
	  if (EQ (XCDR (prev), parent))
383
	    RETURN_UNGCPRO (parent);
384

385
	  XSETCDR (prev, parent);
386 387 388 389 390 391 392
	  break;
	}
      prev = list;
    }

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

393
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
394 395
    {
      /* Stop the scan when we come to the parent.  */
396
      if (EQ (XCAR (list), Qkeymap))
397 398 399
	break;

      /* If this element holds a prefix map, deal with it.  */
400 401 402 403 404 405 406 407
      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]))
408
	    fix_submap_inheritance (keymap, make_number (i),
409
				    XVECTOR (XCAR (list))->contents[i]);
410

411
      if (CHAR_TABLE_P (XCAR (list)))
412
	{
413
	  Lisp_Object indices[3];
414

415
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
416 417
			  keymap, 0, indices);
	}
418 419
    }

420
  RETURN_UNGCPRO (parent);
421 422 423 424 425 426
}

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

427
static void
428 429 430 431 432 433 434 435
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.  */

436
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
437 438

  /* If it isn't a keymap now, there's no work to do.  */
439
  if (!CONSP (submap))
440 441
    return;

442
  map_parent = keymap_parent (map, 0);
443
  if (!NILP (map_parent))
444
    parent_entry =
445
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
446 447 448
  else
    parent_entry = Qnil;

449
  /* If MAP's parent has something other than a keymap,
450
     our own submap shadows it completely.  */
451
  if (!CONSP (parent_entry))
452
    return;
453

454
  if (! EQ (parent_entry, submap))
455 456 457 458 459 460
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
461

462
	  tem = keymap_parent (submap_parent, 0);
463 464 465 466 467 468 469 470

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
471 472 473 474 475
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
476 477
}

Jim Blandy's avatar
Jim Blandy committed
478
/* Look up IDX in MAP.  IDX may be any sort of event.
479
   Note that this does only one level of lookup; IDX must be a single
480
   event, not a sequence.
481 482 483

   If T_OK is non-zero, bindings for Qt are treated as default
   bindings; any key left unmentioned by other tables and bindings is
484
   given the binding of Qt.
485

486 487 488
   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
489 490

Lisp_Object
491
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
492 493
     Lisp_Object map;
     Lisp_Object idx;
494
     int t_ok;
495
     int noinherit;
496
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
497
{
498 499 500 501
  Lisp_Object val;

  /* Qunbound in VAL means we have found no binding yet.  */
  val = Qunbound;
502

Jim Blandy's avatar
Jim Blandy committed
503 504 505
  /* 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.  */
506
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
507

508 509
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
510
  if (SYMBOLP (idx))
511
    idx = reorder_modifiers (idx);
512 513 514
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
515
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
516

517 518 519
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
520 521
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
522 523 524 525 526 527 528
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
529
      if (CONSP (meta_map))
530
	{
531
	  map = meta_map;
532 533 534 535 536 537 538 539
	  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;
540 541
    }

542 543 544
  /* t_binding is where we put a default binding that applies,
     to use in case we do not find a binding specifically
     for this key sequence.  */
545 546
  {
    Lisp_Object tail;
547 548
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
549

550
    GCPRO4 (map, tail, idx, t_binding);
551 552 553 554 555

    /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
       If it is 1, only generic-char bindings are accepted.
       Otherwise, neither are.  */
    t_ok = t_ok ? 2 : 0;
Jim Blandy's avatar
Jim Blandy committed
556

557
    for (tail = XCDR (map);
558
	 (CONSP (tail)
559
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
560
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
561
      {
562
	Lisp_Object binding;
563

564
	binding = XCAR (tail);
565
	if (SYMBOLP (binding))
566
	  {
567 568
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
569
	    if (noinherit && EQ (binding, Qkeymap))
570
	      RETURN_UNGCPRO (Qnil);
571 572 573
	  }
	else if (CONSP (binding))
	  {
574
	    Lisp_Object key = XCAR (binding);
575

576
	    if (EQ (key, idx))
577 578 579
	      val = XCDR (binding);
	    else if (t_ok
		     && INTEGERP (idx)
580
		     && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
581
		     && INTEGERP (key)
582
		     && (XINT (key) & CHAR_MODIFIER_MASK) == 0
583 584 585 586 587 588 589 590 591 592
		     && !SINGLE_BYTE_CHAR_P (XINT (idx))
		     && !SINGLE_BYTE_CHAR_P (XINT (key))
		     && CHAR_VALID_P (XINT (key), 1)
		     && !CHAR_VALID_P (XINT (key), 0)
		     && (CHAR_CHARSET (XINT (key))
			 == CHAR_CHARSET (XINT (idx))))
	      {
		/* KEY is the generic character of the charset of IDX.
		   Use KEY's binding if there isn't a binding for IDX
		   itself.  */
593 594 595 596 597 598 599
		t_binding = XCDR (binding);
		t_ok = 0;
	      }
	    else if (t_ok > 1 && EQ (key, Qt))
	      {
		t_binding = XCDR (binding);
		t_ok = 1;
600
	      }
601 602 603
	  }
	else if (VECTORP (binding))
	  {
604 605
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
606
	  }
607 608
	else if (CHAR_TABLE_P (binding))
	  {
609 610 611
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
612 613 614 615 616 617 618 619 620
	    if (NATNUMP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
	      {
		val = Faref (binding, idx);
		/* `nil' has a special meaning for char-tables, so
		   we use something else to record an explicitly
		   unbound entry.  */
		if (NILP (val))
		  val = Qunbound;
	      }
621
	  }
622

623 624 625
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
626 627 628 629 630
	    if (EQ (val, Qt))
	      /* A Qt binding is just like an explicit nil binding
		 (i.e. it shadows any parent binding but not bindings in
		 keymaps of lower precedence).  */
	      val = Qnil;
631 632 633
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
634
	    RETURN_UNGCPRO (val);
635
	  }
636
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
637
      }
638
    UNGCPRO;
639
    return get_keyelt (t_binding, autoload);
640
  }
Jim Blandy's avatar
Jim Blandy committed
641 642 643 644 645 646 647 648 649
}

/* 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,
650 651 652 653
   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
654 655

Lisp_Object
656
get_keyelt (object, autoload)
657
     Lisp_Object object;
658
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
659 660 661
{
  while (1)
    {
662 663 664
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
665

666 667 668 669 670 671 672
      /* 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.
673
	 This is a new format menu item.  */
674
      else if (EQ (XCAR (object), Qmenu_item))
675
	{
676
	  if (CONSP (XCDR (object)))
677
	    {
678 679
	      Lisp_Object tem;

680
	      object = XCDR (XCDR (object));
681
	      tem = object;
682 683
	      if (CONSP (object))
		object = XCAR (object);
684 685 686

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
687
		 use.  */
688
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
689
		if (EQ (XCAR (tem), QCfilter) && autoload)
690 691 692 693 694 695 696
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
697 698
	    }
	  else
699
	    /* Invalid keymap.  */
700
	    return object;
701 702
	}

703
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
704 705
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
706
      else if (STRINGP (XCAR (object)))
707
	{
708
	  object = XCDR (object);
709 710
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
711 712
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
713
	  /* Also remove the sublist that caches key equivalences, if any.  */
714
	  if (CONSP (object) && CONSP (XCAR (object)))
715
	    {
716
	      Lisp_Object carcar;
717
	      carcar = XCAR (XCAR (object));
718
	      if (NILP (carcar) || VECTORP (carcar))
719
		object = XCDR (object);
720
	    }
721
	}
Jim Blandy's avatar
Jim Blandy committed
722

723 724
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
725
	{
726
	  struct gcpro gcpro1;
727
	  Lisp_Object map;
728
	  GCPRO1 (object);
729
	  map = get_keymap (Fcar_safe (object), 0, autoload);
730
	  UNGCPRO;
731
	  return (!CONSP (map) ? object /* Invalid keymap */
732
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
733
	}
Jim Blandy's avatar
Jim Blandy committed
734 735 736
    }
}

737
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
738 739 740 741 742
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
743 744 745 746
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

747
  /* If we are preparing to dump, and DEF is a menu element
748 749
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
750 751
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
752

753
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
754 755
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
756 757 758
  /* 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.  */
759
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
760

761 762
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
763
  if (SYMBOLP (idx))
764
    idx = reorder_modifiers (idx);
765 766 767
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
768
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
769 770

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
771
  {
772
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
773

774 775 776 777 778 779
    /* 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.  */
780
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
781

782
    insertion_point = keymap;
783
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
784
      {
785
	Lisp_Object elt;
786

787
	elt = XCAR (tail);
788
	if (VECTORP (elt))
789
	  {
790
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
791
	      {
792
		ASET (elt, XFASTINT (idx), def);
793 794 795
		return def;
	      }
	    insertion_point = tail;
796
	  }
797 798
	else if (CHAR_TABLE_P (elt))
	  {
799 800 801
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
802
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
803
	      {
804 805 806 807 808
		Faset (elt, idx,
		       /* `nil' has a special meaning for char-tables, so
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
809 810 811 812
		return def;
	      }
	    insertion_point = tail;
	  }
813 814
	else if (CONSP (elt))
	  {
815
	    if (EQ (idx, XCAR (elt)))
816
	      {
817
		XSETCDR (elt, def);
818 819
		return def;
	      }
820
	  }
821 822 823 824 825 826
	else if (EQ (elt, Qkeymap))
	  /* 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.  */
	  goto keymap_end;
827 828

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
829 830
      }

831 832 833
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
834 835
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
836
  }
837

Jim Blandy's avatar
Jim Blandy committed
838 839 840
  return def;
}

841 842
EXFUN (Fcopy_keymap, 1);

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
Lisp_Object
copy_keymap_item (elt)
     Lisp_Object elt;
{
  Lisp_Object res, tem;

  if (!CONSP (elt))
    return elt;

  res = tem = elt;

  /* Is this a new format menu item.  */
  if (EQ (XCAR (tem), Qmenu_item))
    {
      /* Copy cell with menu-item marker.  */
      res = elt = Fcons (XCAR (tem), XCDR (tem));
      tem = XCDR (elt);
      if (CONSP (tem))
	{
	  /* Copy cell with menu-item name.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	  elt = XCDR (elt);
	  tem = XCDR (elt);
	}
      if (CONSP (tem))
	{
	  /* Copy cell with binding and if the binding is a keymap,
	     copy that.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	  elt = XCDR (elt);
	  tem = XCAR (elt);
	  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
	    XSETCAR (elt, Fcopy_keymap (tem));
	  tem = XCDR (elt);
	  if (CONSP (tem) && CONSP (XCAR (tem)))
	    /* Delete cache for key equivalences.  */
	    XSETCDR (elt, XCDR (tem));
	}
    }
  else
    {
      /* It may be an old fomat menu item.
	 Skip the optional menu string.  */
      if (STRINGP (XCAR (tem)))
	{
	  /* Copy the cell, since copy-alist didn't go this deep.  */
	  res = elt = Fcons (XCAR (tem), XCDR (tem));
	  tem = XCDR (elt);
	  /* Also skip the optional menu help string.  */
	  if (CONSP (tem) && STRINGP (XCAR (tem)))
	    {
	      XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
	    }
	  /* There may also be a list that caches key equivalences.
	     Just delete it for the new keymap.  */
	  if (CONSP (tem)
	      && CONSP (XCAR (tem))
	      && (NILP (XCAR (XCAR (tem)))
		  || VECTORP (XCAR (XCAR (tem)))))
	    {
	      XSETCDR (elt, XCDR (tem));
	      tem = XCDR (tem);
	    }
	  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
	    XSETCDR (elt, Fcopy_keymap (tem));
	}
      else if (EQ (XCAR (tem), Qkeymap))
	res = Fcopy_keymap (elt);
    }
  return res;
}

917
void
918 919 920
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
921
  Faset (chartable, idx, copy_keymap_item (elt));
922
}
923

Jim Blandy's avatar
Jim Blandy committed
924
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
925 926 927 928 929 930 931
       doc: /* Return a copy of the keymap KEYMAP.
The copy starts out with the same definitions of KEYMAP,
but changing either the copy or KEYMAP does not affect the other.
Any key definitions that are subkeymaps are recursively copied.
However, a key definition which is a symbol whose definition is a keymap
is not copied.  */)
     (keymap)
Jim Blandy's avatar
Jim Blandy committed
932 933 934
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;
935 936 937
  keymap = get_keymap (keymap, 1, 0);
  copy = tail = Fcons (Qkeymap, Qnil);
  keymap = XCDR (keymap);		/* Skip the `keymap' symbol.  */
Jim Blandy's avatar
Jim Blandy committed
938

939
  while (CONSP (keymap) && !EQ (XCAR (keymap), Qkeymap))
Jim Blandy's avatar
Jim Blandy committed
940
    {
941
      Lisp_Object elt = XCAR (keymap);
942 943
      if (CHAR_TABLE_P (elt))
	{
944
	  Lisp_Object indices[3];
945 946 947 948
	  elt = Fcopy_sequence (elt);
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
949
	{
950 951
	  int i;
	  elt = Fcopy_sequence (elt);
952
	  for (i = 0; i < ASIZE (elt); i++)
953
	    ASET (elt, i, copy_keymap_item (AREF (elt, i)));
954
	}
955 956 957 958 959
      else if (CONSP (elt))
	elt = Fcons (XCAR (elt), copy_keymap_item (XCDR (elt)));
      XSETCDR (tail, Fcons (elt, Qnil));
      tail = XCDR (tail);
      keymap = XCDR (keymap);
Jim Blandy's avatar
Jim Blandy committed
960
    }
961
  XSETCDR (tail, keymap);
Jim Blandy's avatar
Jim Blandy committed
962 963 964
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
965 966
/* Simple Keymap mutators and accessors.				*/

967 968
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
969
DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
970
       doc: /* Args KEYMAP, KEY, DEF.  Define key sequence KEY, in KEYMAP, as DEF.
971 972 973 974 975
KEYMAP is a keymap.

KEY is a string or a vector of symbols and characters meaning a
sequence of keystrokes and events.  Non-ASCII characters with codes
above 127 (such as ISO Latin-1) can be included if you use a vector.
Richard M. Stallman's avatar
Richard M. Stallman committed
976 977
Using [t] for KEY creates a default definition, which applies to any
event type that has no other definition in thus keymap.
978