keymap.c 103 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;

Jim Blandy's avatar
Jim Blandy committed
78 79 80 81 82
/* 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;

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

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

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

94 95 96
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

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 105 106 107 108
/* 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;

109 110 111 112
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));
113 114
static void describe_command P_ ((Lisp_Object, Lisp_Object));
static void describe_translation P_ ((Lisp_Object, Lisp_Object));
115
static void describe_map P_ ((Lisp_Object, Lisp_Object,
116
			      void (*) P_ ((Lisp_Object, Lisp_Object)),
117
			      int, Lisp_Object, Lisp_Object*, int));
118
static void silly_event_symbol_error P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
119

Jim Blandy's avatar
Jim Blandy committed
120 121
/* Keymap object support - constructors and predicates.			*/

122
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
123 124 125 126 127 128 129 130 131
       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)
132
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
133
{
134 135 136 137 138
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
139
  return Fcons (Qkeymap,
140
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
141 142
}

143
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
144 145 146 147 148 149 150 151 152
       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)
153
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
154
{
155 156
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
157 158 159 160 161 162 163 164
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

165
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
166 167 168 169 170 171 172 173 174 175

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

176 177 178 179 180 181 182 183 184
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
185
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
186 187 188 189 190 191 192 193
       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
194 195
     Lisp_Object object;
{
196
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
197 198
}

199
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
200 201 202 203
       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)
204 205 206 207 208 209 210 211 212 213 214 215 216
     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
217
/* Check that OBJECT is a keymap (after dereferencing through any
218 219 220 221
   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.
222
   If AUTOLOAD is nonzero, callers must assume GC is possible.
223

224 225 226
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

227 228 229 230 231 232 233
   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
234 235 236 237
   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.  */
238

Jim Blandy's avatar
Jim Blandy committed
239
Lisp_Object
240
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
241
     Lisp_Object object;
242
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
243
{
244
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
245

246
 autoload_retry:
247 248 249 250
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
251

252 253
  tem = indirect_function (object);
  if (CONSP (tem))
254
    {
255 256
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
257

258 259 260
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload))
261
	{
262
	  Lisp_Object tail;
263

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
		  
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
		  
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
280
	}
281 282
    }

283
 end:
Jim Blandy's avatar
Jim Blandy committed
284 285
  if (error)
    wrong_type_argument (Qkeymapp, object);
286
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
287
}
288 289 290 291 292

/* 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,
293 294
       doc: /* Return the parent keymap of KEYMAP.  */)
     (keymap)
295 296 297 298
     Lisp_Object keymap;
{
  Lisp_Object list;

299
  keymap = get_keymap (keymap, 1, 1);
300 301

  /* Skip past the initial element `keymap'.  */
302 303
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
304 305
    {
      /* See if there is another `keymap'.  */
306
      if (KEYMAPP (list))
307 308 309
	return list;
    }

310
  return get_keymap (list, 0, 1);
311 312
}

313

314 315 316 317 318
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
319
  if (NILP (map)) return 0;
320 321 322 323 324
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

325 326 327
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
328 329 330
       doc: /* Modify KEYMAP to set its parent map to PARENT.
PARENT should be nil or another keymap.  */)
     (keymap, parent)
331 332 333
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
334
  struct gcpro gcpro1;
335
  int i;
Jim Blandy's avatar
Jim Blandy committed
336

337 338 339 340 341 342 343 344 345
  /* 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;

346
  keymap = get_keymap (keymap, 1, 1);
347 348
  GCPRO1 (keymap);
  
349
  if (!NILP (parent))
350
    {
351
      parent = get_keymap (parent, 1, 1);
352 353

      /* Check for cycles.  */
354
      if (keymap_memberp (keymap, parent))
355 356
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
357

358 359 360 361
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
362
      list = XCDR (prev);
363 364
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
365
      if (!CONSP (list) || KEYMAPP (list))
366
	{
367 368
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
369
	  if (EQ (XCDR (prev), parent))
370
	    RETURN_UNGCPRO (parent);
371

372
	  XSETCDR (prev, parent);
373 374 375 376 377 378 379
	  break;
	}
      prev = list;
    }

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

380
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
381 382
    {
      /* Stop the scan when we come to the parent.  */
383
      if (EQ (XCAR (list), Qkeymap))
384 385 386
	break;

      /* If this element holds a prefix map, deal with it.  */
387 388 389 390 391 392 393 394
      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]))
395
	    fix_submap_inheritance (keymap, make_number (i),
396
				    XVECTOR (XCAR (list))->contents[i]);
397

398
      if (CHAR_TABLE_P (XCAR (list)))
399
	{
400
	  Lisp_Object indices[3];
401

402
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
403 404
			  keymap, 0, indices);
	}
405 406
    }

407
  RETURN_UNGCPRO (parent);
408 409 410 411 412 413
}

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

414
static void
415 416 417 418 419 420 421 422
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.  */

423
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
424 425

  /* If it isn't a keymap now, there's no work to do.  */
426
  if (!CONSP (submap))
427 428 429
    return;

  map_parent = Fkeymap_parent (map);
430
  if (!NILP (map_parent))
431
    parent_entry =
432
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
433 434 435
  else
    parent_entry = Qnil;

436
  /* If MAP's parent has something other than a keymap,
437
     our own submap shadows it completely.  */
438
  if (!CONSP (parent_entry))
439
    return;
440

441
  if (! EQ (parent_entry, submap))
442 443 444 445 446 447
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
448

449
	  tem = Fkeymap_parent (submap_parent);
450 451 452 453 454 455 456 457

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
458 459 460 461 462
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
463 464
}

Jim Blandy's avatar
Jim Blandy committed
465
/* Look up IDX in MAP.  IDX may be any sort of event.
466
   Note that this does only one level of lookup; IDX must be a single
467 468 469 470 471 472
   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.  

473 474 475
   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
476 477

Lisp_Object
478
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
479 480
     Lisp_Object map;
     Lisp_Object idx;
481
     int t_ok;
482
     int noinherit;
483
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
484
{
485 486 487 488
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
490 491 492
  /* 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.  */
493
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
494

495 496
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
497
  if (SYMBOLP (idx))
498
    idx = reorder_modifiers (idx);
499 500 501
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
502
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
503

504 505 506
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
507 508
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
509
      Lisp_Object meta_map =
510 511 512 513
	get_keymap (access_keymap (map, meta_prefix_char,
				   t_ok, noinherit, autoload),
		    0, autoload);
      if (CONSP (meta_map))
514
	{
515
	  map = meta_map;
516 517 518 519 520 521 522 523
	  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;
524 525
    }

526 527
  {
    Lisp_Object tail;
528 529 530

    /* t_binding is where we put a default binding that applies,
       to use in case we do not find a binding specifically
531
       for this key sequence.  */
532 533 534

    Lisp_Object t_binding;
    t_binding = Qnil;
535 536 537 538 539

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

541
    for (tail = XCDR (map);
542
	 (CONSP (tail)
543
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
544
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
545
      {
546
	Lisp_Object binding;
547

548
	binding = XCAR (tail);
549
	if (SYMBOLP (binding))
550
	  {
551 552
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
553
	    if (noinherit && EQ (binding, Qkeymap))
554
	      return Qnil;
555 556 557
	  }
	else if (CONSP (binding))
	  {
558 559 560
	    Lisp_Object key = XCAR (binding);
	    
	    if (EQ (key, idx))
561 562 563
	      val = XCDR (binding);
	    else if (t_ok
		     && INTEGERP (idx)
564
		     && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
565
		     && INTEGERP (key)
566
		     && (XINT (key) & CHAR_MODIFIER_MASK) == 0
567 568 569 570 571 572 573 574 575 576
		     && !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.  */
577 578 579 580 581 582 583
		t_binding = XCDR (binding);
		t_ok = 0;
	      }
	    else if (t_ok > 1 && EQ (key, Qt))
	      {
		t_binding = XCDR (binding);
		t_ok = 1;
584
	      }
585 586 587
	  }
	else if (VECTORP (binding))
	  {
588 589
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
590
	  }
591 592
	else if (CHAR_TABLE_P (binding))
	  {
593 594 595
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
596 597 598 599 600 601 602 603 604
	    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;
	      }
605
	  }
606

607 608 609
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
610 611 612 613 614
	    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;
615 616 617 618 619
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
	    return val;
	  }
620
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
621
      }
622

623
    return get_keyelt (t_binding, autoload);
624
  }
Jim Blandy's avatar
Jim Blandy committed
625 626 627 628 629 630 631 632 633
}

/* 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,
634 635 636 637
   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
638 639

Lisp_Object
640
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
641
     register Lisp_Object object;
642
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
643 644 645
{
  while (1)
    {
646 647 648
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
649

650 651 652 653 654 655 656
      /* 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.
657
	 This is a new format menu item.  */
658
      else if (EQ (XCAR (object), Qmenu_item))
659
	{
660
	  if (CONSP (XCDR (object)))
661
	    {
662 663
	      Lisp_Object tem;

664
	      object = XCDR (XCDR (object));
665
	      tem = object;
666 667
	      if (CONSP (object))
		object = XCAR (object);
668 669 670

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
671
		 use.  */
672
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
673
		if (EQ (XCAR (tem), QCfilter) && autoload)
674 675 676 677 678 679 680
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
681 682
	    }
	  else
683 684
	    /* Invalid keymap */
	    return object;
685 686
	}

687
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
688 689
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
690
      else if (STRINGP (XCAR (object)))
691
	{
692
	  object = XCDR (object);
693 694
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
695 696
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
697
	  /* Also remove the sublist that caches key equivalences, if any.  */
698
	  if (CONSP (object) && CONSP (XCAR (object)))
699
	    {
700
	      Lisp_Object carcar;
701
	      carcar = XCAR (XCAR (object));
702
	      if (NILP (carcar) || VECTORP (carcar))
703
		object = XCDR (object);
704
	    }
705
	}
Jim Blandy's avatar
Jim Blandy committed
706

707 708
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
709
	{
710
	  Lisp_Object map;
711 712
	  map = get_keymap (Fcar_safe (object), 0, autoload);
	  return (!CONSP (map) ? object /* Invalid keymap */
713
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
714
	}
Jim Blandy's avatar
Jim Blandy committed
715 716 717
    }
}

718
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
719 720 721 722 723
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
724 725 726 727
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

728
  /* If we are preparing to dump, and DEF is a menu element
729 730
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
731 732
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
733

734
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
735 736
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
737 738 739
  /* 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.  */
740
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
741

742 743
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
744
  if (SYMBOLP (idx))
745
    idx = reorder_modifiers (idx);
746 747 748
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
749
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
750 751

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
752
  {
753
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
754

755 756 757 758 759 760
    /* 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.  */
761
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
762

763
    insertion_point = keymap;
764
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
765
      {
766
	Lisp_Object elt;
767

768
	elt = XCAR (tail);
769
	if (VECTORP (elt))
770
	  {
771
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
772
	      {
773
		ASET (elt, XFASTINT (idx), def);
774 775 776
		return def;
	      }
	    insertion_point = tail;
777
	  }
778 779
	else if (CHAR_TABLE_P (elt))
	  {
780 781 782
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
783
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
784
	      {
785 786 787 788 789
		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);
790 791 792 793
		return def;
	      }
	    insertion_point = tail;
	  }
794 795
	else if (CONSP (elt))
	  {
796
	    if (EQ (idx, XCAR (elt)))
797
	      {
798
		XSETCDR (elt, def);
799 800
		return def;
	      }
801
	  }
802 803 804 805 806 807
	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;
808 809

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
810 811
      }

812 813 814
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
815 816
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
817
  }
818
  
Jim Blandy's avatar
Jim Blandy committed
819 820 821
  return def;
}

822 823
EXFUN (Fcopy_keymap, 1);

824
void
825 826 827
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
828
  if (CONSP (elt) && EQ (XCAR (elt), Qkeymap))
829
    Faset (chartable, idx, Fcopy_keymap (elt));
830
}
831

Jim Blandy's avatar
Jim Blandy committed
832
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
833 834 835 836 837 838 839
       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
840 841
     Lisp_Object keymap;
{
842 843 844
  /* FIXME: This doesn't properly copy menu-items in vectors.  */
  /* FIXME: This also copies the parent keymap.  */

Jim Blandy's avatar
Jim Blandy committed
845 846
  register Lisp_Object copy, tail;

847
  copy = Fcopy_alist (get_keymap (keymap, 1, 0));
Jim Blandy's avatar
Jim Blandy committed
848

849
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
850
    {
851
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
852

853
      elt = XCAR (tail);
854 855
      if (CHAR_TABLE_P (elt))
	{
856
	  Lisp_Object indices[3];
857 858

	  elt = Fcopy_sequence (elt);
859
	  XSETCAR (tail, elt);
860

861 862 863
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
864
	{
865
	  int i;
Jim Blandy's avatar
Jim Blandy committed
866

867
	  elt = Fcopy_sequence (elt);
868
	  XSETCAR (tail, elt);
Jim Blandy's avatar
Jim Blandy committed
869

870
	  for (i = 0; i < ASIZE (elt); i++)
871
	    if (CONSP (AREF (elt, i)) && EQ (XCAR (AREF (elt, i)), Qkeymap))
872
	      ASET (elt, i, Fcopy_keymap (AREF (elt, i)));
Jim Blandy's avatar
Jim Blandy committed
873
	}
874
      else if (CONSP (elt) && CONSP (XCDR (elt)))
875
	{
876
	  Lisp_Object tem;
877
	  tem = XCDR (elt);
878

879
	  /* Is this a new format menu item.  */
880
	  if (EQ (XCAR (tem),Qmenu_item))
881 882
	    {
	      /* Copy cell with menu-item marker.  */
883 884
	      XSETCDR (elt,
		       Fcons (XCAR (tem), XCDR (tem)));
885 886
	      elt = XCDR (elt);
	      tem = XCDR (elt);
887 888 889
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
890 891
		  XSETCDR (elt,
			   Fcons (XCAR (tem), XCDR (tem)));
892 893
		  elt = XCDR (elt);
		  tem = XCDR (elt);
894 895 896 897 898
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
899 900
		  XSETCDR (elt,
			   Fcons (XCAR (tem), XCDR (tem)));
901 902
		  elt = XCDR (elt);
		  tem = XCAR (elt);
903
		  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
904
		    XSETCAR (elt, Fcopy_keymap (tem));
905 906
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
907
		    /* Delete cache for key equivalences.  */
908
		    XSETCDR (elt, XCDR (tem));
909 910 911 912 913 914 915
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
916
	      if (STRINGP (XCAR (tem)))
917
		{
918
		  /* Copy the cell, since copy-alist didn't go this deep.  */
919 920
		  XSETCDR (elt,
			   Fcons (XCAR (tem), XCDR (tem)));
921 922
		  elt = XCDR (elt);
		  tem = XCDR (elt);
923
		  /* Also skip the optional menu help string.  */
924
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
925
		    {
926 927
		      XSETCDR (elt,
			       Fcons (XCAR (tem), XCDR (tem)));
928 929
		      elt = XCDR (elt);
		      tem = XCDR (elt);
930 931 932 933
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
934 935 936
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
937
		    XSETCDR (elt, XCDR (tem));
938
		}
939
	      if (CONSP (elt)
940 941
		  && CONSP (XCDR (elt))
		  && EQ (XCAR (XCDR (elt)), Qkeymap))
942
		XSETCDR (elt, Fcopy_keymap (XCDR (elt)));
943
	    }
944

945
	}
Jim Blandy's avatar
Jim Blandy committed
946
    }
947
  
Jim Blandy's avatar
Jim Blandy committed
948 949 950
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
951 952
/* Simple Keymap mutators and accessors.				*/

953 954
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
955
DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
956
       doc: /* Args KEYMAP, KEY, DEF.  Define key sequence KEY, in KEYMAP, as DEF.
957 958 959 960 961 962
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.

963 964 965 966 967 968 969 970 971 972 973 974 975
DEF is anything that can be a key's definition:
 nil (means key is undefined in this keymap),
 a command (a Lisp function suitable for interactive calling)
 a string (treated as a keyboard macro),
 a keymap (to define a prefix key),
 a symbol.  When the key is looked up, the symbol will stand for its
    function definition, which should at that time be one of the above,
    or another symbol whose function definition is used, etc.
 a cons (STRING . DEFN), meaning that DEFN is the definition
    (DEFN should be a valid definition in its own right),
 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.

If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at
976 977 978 979
the front of KEYMAP.  

KEY may also be a command name which is remapped to DEF.  In this case,
DEF must be a symbol or nil (to remove a previous binding of KEY).  */)
980
     (keymap, key, def)
981
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
982 983 984 985 986 987 988
     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
989
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
990
  int length;
991
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
992

993
  keymap = get_keymap (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
994

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
  if (SYMBOLP (key))
    {
      /* A command may only be remapped to another command.  */

      /* I thought of using is_command_symbol above and below instead
	 of SYMBOLP, since remapping only works for sych symbols.
	 However, to make that a requirement would make it impossible
	 to remap a command before it has been defined, e.g. if a minor
	 mode were to remap a command of another minor mode which has
	 not yet been loaded, it would fail.  So just use the least
	 restrictive sanity check here.  */
      if (!SYMBOLP (def))
	key = wrong_type_argument (Qsymbolp, def);
      else
	key = Fmake_vector (make_number (1), key);
    }
  else if (!VECTORP (key) && !STRINGP (key))
      key = wrong_type_argument (Qarrayp, key);
Jim Blandy's avatar
Jim Blandy committed
1013

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

1018 1019 1020
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

1021 1022
  GCPRO3 (keymap, key, def);

1023
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
1024 1025 1026 1027
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;