keymap.c 96.7 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"
Jim Blandy's avatar
Jim Blandy committed
34

35
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
#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
70 71 72
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

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

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

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

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

98 99
extern Lisp_Object Voverriding_local_map;

100 101 102 103 104
/* 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;

105 106 107 108 109 110 111 112 113 114
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
115

Jim Blandy's avatar
Jim Blandy committed
116 117
/* Keymap object support - constructors and predicates.			*/

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

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

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

   For example:

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

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

170 171 172 173 174 175 176 177 178
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
179
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
180
  "Return t if OBJECT is a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
181
\n\
182
A keymap is a list (keymap . ALIST),\n\
Karl Heuer's avatar
Karl Heuer committed
183
or a symbol whose function definition is itself a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
184
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
185 186
a vector of densely packed bindings for small character codes\n\
is also allowed as an element.")
Jim Blandy's avatar
Jim Blandy committed
187 188 189
  (object)
     Lisp_Object object;
{
190
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
191 192
}

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
  "Return the prompt-string of a keymap MAP.\n\
If non-nil, the prompt is shown in the echo-area\n\
when reading a key-sequence to be looked-up in this keymap.")
  (map)
     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
211
/* Check that OBJECT is a keymap (after dereferencing through any
212 213 214 215
   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.
216
   If AUTOLOAD is nonzero, callers must assume GC is possible.
217

218 219 220
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

221 222 223 224 225 226 227
   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
228 229 230 231
   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.  */
232

Jim Blandy's avatar
Jim Blandy committed
233
Lisp_Object
234
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
235
     Lisp_Object object;
236
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
237
{
238
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
239

240
 autoload_retry:
241 242 243 244
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
245

246 247
  tem = indirect_function (object);
  if (CONSP (tem))
248
    {
249 250
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
251

252 253 254
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload))
255
	{
256
	  Lisp_Object tail;
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
	  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;
	    }
274
	}
275 276
    }

277
 end:
Jim Blandy's avatar
Jim Blandy committed
278 279
  if (error)
    wrong_type_argument (Qkeymapp, object);
280
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
281
}
282 283 284 285 286 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,
  "Return the parent keymap of KEYMAP.")
  (keymap)
     Lisp_Object keymap;
{
  Lisp_Object list;

293
  keymap = get_keymap (keymap, 1, 1);
294 295

  /* Skip past the initial element `keymap'.  */
296 297
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
298 299
    {
      /* See if there is another `keymap'.  */
300
      if (KEYMAPP (list))
301 302 303
	return list;
    }

304
  return get_keymap (list, 0, 1);
305 306
}

307

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

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

331 332 333 334 335 336 337 338 339
  /* 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;

340
  keymap = get_keymap (keymap, 1, 1);
341 342
  GCPRO1 (keymap);
  
343
  if (!NILP (parent))
344
    {
345
      parent = get_keymap (parent, 1, 1);
346 347

      /* Check for cycles.  */
348
      if (keymap_memberp (keymap, parent))
349 350
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
351

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

366
	  XCDR (prev) = parent;
367 368 369 370 371 372 373
	  break;
	}
      prev = list;
    }

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

374
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
375 376
    {
      /* Stop the scan when we come to the parent.  */
377
      if (EQ (XCAR (list), Qkeymap))
378 379 380
	break;

      /* If this element holds a prefix map, deal with it.  */
381 382 383 384 385 386 387 388
      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]))
389
	    fix_submap_inheritance (keymap, make_number (i),
390
				    XVECTOR (XCAR (list))->contents[i]);
391

392
      if (CHAR_TABLE_P (XCAR (list)))
393
	{
394
	  Lisp_Object indices[3];
395

396
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
397 398
			  keymap, 0, indices);
	}
399 400
    }

401
  RETURN_UNGCPRO (parent);
402 403 404 405 406 407
}

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

408
static void
409 410 411 412 413 414 415 416
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.  */

417
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
418 419

  /* If it isn't a keymap now, there's no work to do.  */
420
  if (!CONSP (submap))
421 422 423
    return;

  map_parent = Fkeymap_parent (map);
424
  if (!NILP (map_parent))
425
    parent_entry =
426
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
427 428 429
  else
    parent_entry = Qnil;

430
  /* If MAP's parent has something other than a keymap,
431
     our own submap shadows it completely.  */
432
  if (!CONSP (parent_entry))
433
    return;
434

435
  if (! EQ (parent_entry, submap))
436 437 438 439 440 441
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
442

443
	  tem = Fkeymap_parent (submap_parent);
444 445 446 447 448 449 450 451

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

467 468 469
   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
470 471

Lisp_Object
472
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
473 474
     Lisp_Object map;
     Lisp_Object idx;
475
     int t_ok;
476
     int noinherit;
477
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
478
{
479 480 481
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
482 483 484
  /* 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.  */
485
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
486

487 488
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
489
  if (SYMBOLP (idx))
490
    idx = reorder_modifiers (idx);
491 492 493
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
494
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
495

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

518 519
  {
    Lisp_Object tail;
520
    Lisp_Object t_binding;
521
    Lisp_Object generic_binding;
Jim Blandy's avatar
Jim Blandy committed
522

523
    t_binding = Qnil;
524 525
    generic_binding = Qnil;
    
526
    for (tail = XCDR (map);
527
	 (CONSP (tail)
528
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
529
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
530
      {
531
	Lisp_Object binding;
532

533
	binding = XCAR (tail);
534
	if (SYMBOLP (binding))
535
	  {
536 537
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
538
	    if (noinherit && EQ (binding, Qkeymap))
539
	      noprefix = 1;
540 541 542
	  }
	else if (CONSP (binding))
	  {
543 544 545 546
	    Lisp_Object key = XCAR (binding);
	    int c1, c2, charset;
	    
	    if (EQ (key, idx))
547
	      {
548
		val = XCDR (binding);
549
		if (noprefix && KEYMAPP (val))
550
		  return Qnil;
551 552
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
553
		return get_keyelt (val, autoload);
554
	      }
555
	    else if (INTEGERP (idx)
556
		     && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
557
		     && INTEGERP (key)
558
		     && (XINT (key) & CHAR_MODIFIER_MASK) == 0
559 560 561 562 563 564 565 566 567 568
		     && !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.  */
569
		generic_binding = XCDR (binding);
570 571
	      }
	    else if (t_ok && EQ (XCAR (binding), Qt))
572
	      t_binding = XCDR (binding);
573 574 575
	  }
	else if (VECTORP (binding))
	  {
576
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
577
	      {
578
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
579
		if (noprefix && KEYMAPP (val))
580
		  return Qnil;
581 582
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
583
		return get_keyelt (val, autoload);
584
	      }
585
	  }
586 587
	else if (CHAR_TABLE_P (binding))
	  {
588 589 590 591
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
	    if (NATNUMP (idx)
592
		&& (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
593 594
	      {
		val = Faref (binding, idx);
595
		if (noprefix && KEYMAPP (val))
596 597 598
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
599
		return get_keyelt (val, autoload);
600 601
	      }
	  }
602 603

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
604
      }
605

606 607 608
    if (!NILP (generic_binding))
      return get_keyelt (generic_binding, autoload);

609
    return get_keyelt (t_binding, autoload);
610
  }
Jim Blandy's avatar
Jim Blandy committed
611 612 613 614 615 616 617 618 619
}

/* 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,
620 621 622 623
   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
624 625

Lisp_Object
626
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
627
     register Lisp_Object object;
628
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
629 630 631
{
  while (1)
    {
632 633 634
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
635

636 637 638 639 640 641 642
      /* 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.
643
	 This is a new format menu item.  */
644
      else if (EQ (XCAR (object), Qmenu_item))
645
	{
646
	  if (CONSP (XCDR (object)))
647
	    {
648 649
	      Lisp_Object tem;

650
	      object = XCDR (XCDR (object));
651
	      tem = object;
652 653
	      if (CONSP (object))
		object = XCAR (object);
654 655 656

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
657
		 use.  */
658
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
659
		if (EQ (XCAR (tem), QCfilter) && autoload)
660 661 662 663 664 665 666
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
667 668
	    }
	  else
669 670
	    /* Invalid keymap */
	    return object;
671 672
	}

673
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
674 675
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
676
      else if (STRINGP (XCAR (object)))
677
	{
678
	  object = XCDR (object);
679 680
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
681 682
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
683
	  /* Also remove the sublist that caches key equivalences, if any.  */
684
	  if (CONSP (object) && CONSP (XCAR (object)))
685
	    {
686
	      Lisp_Object carcar;
687
	      carcar = XCAR (XCAR (object));
688
	      if (NILP (carcar) || VECTORP (carcar))
689
		object = XCDR (object);
690
	    }
691
	}
Jim Blandy's avatar
Jim Blandy committed
692

693 694
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
695
	{
696
	  Lisp_Object map;
697 698
	  map = get_keymap (Fcar_safe (object), 0, autoload);
	  return (!CONSP (map) ? object /* Invalid keymap */
699
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
700
	}
Jim Blandy's avatar
Jim Blandy committed
701 702 703
    }
}

704
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
705 706 707 708 709
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
710 711 712 713
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

714
  /* If we are preparing to dump, and DEF is a menu element
715 716
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
717 718
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
719

720
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
721 722
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
723 724 725
  /* 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.  */
726
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
727

728 729
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
730
  if (SYMBOLP (idx))
731
    idx = reorder_modifiers (idx);
732 733 734
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
735
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
736 737

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
738
  {
739
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
740

741 742 743 744 745 746
    /* 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.  */
747
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
748

749
    insertion_point = keymap;
750
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
751
      {
752
	Lisp_Object elt;
753

754
	elt = XCAR (tail);
755
	if (VECTORP (elt))
756
	  {
757
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
758
	      {
759
		ASET (elt, XFASTINT (idx), def);
760 761 762
		return def;
	      }
	    insertion_point = tail;
763
	  }
764 765
	else if (CHAR_TABLE_P (elt))
	  {
766 767 768 769 770 771 772
	    /* 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)))
773 774 775 776 777 778
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
779 780
	else if (CONSP (elt))
	  {
781
	    if (EQ (idx, XCAR (elt)))
782
	      {
783
		XCDR (elt) = def;
784 785
		return def;
	      }
786
	  }
787 788 789 790 791 792
	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;
793 794

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
795 796
      }

797 798 799
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
800 801
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
802
  }
803
  
Jim Blandy's avatar
Jim Blandy committed
804 805 806
  return def;
}

807
void
808 809 810
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
811
  if (CONSP (elt) && EQ (XCAR (elt), Qkeymap))
812
    Faset (chartable, idx, Fcopy_keymap (elt));
813
}
814

Jim Blandy's avatar
Jim Blandy committed
815 816 817 818
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
819 820 821
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
822 823 824
  (keymap)
     Lisp_Object keymap;
{
825 826 827
  /* FIXME: This doesn't properly copy menu-items in vectors.  */
  /* FIXME: This also copies the parent keymap.  */

Jim Blandy's avatar
Jim Blandy committed
828 829
  register Lisp_Object copy, tail;

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

832
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
833
    {
834
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
835

836
      elt = XCAR (tail);
837 838
      if (CHAR_TABLE_P (elt))
	{
839
	  Lisp_Object indices[3];
840 841

	  elt = Fcopy_sequence (elt);
842
	  XCAR (tail) = elt;
843

844 845 846
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
847
	{
848
	  int i;
Jim Blandy's avatar
Jim Blandy committed
849

850
	  elt = Fcopy_sequence (elt);
851
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
852

853
	  for (i = 0; i < ASIZE (elt); i++)
854
	    if (CONSP (AREF (elt, i)) && EQ (XCAR (AREF (elt, i)), Qkeymap))
855
	      ASET (elt, i, Fcopy_keymap (AREF (elt, i)));
Jim Blandy's avatar
Jim Blandy committed
856
	}
857
      else if (CONSP (elt) && CONSP (XCDR (elt)))
858
	{
859
	  Lisp_Object tem;
860
	  tem = XCDR (elt);
861

862
	  /* Is this a new format menu item.  */
863
	  if (EQ (XCAR (tem),Qmenu_item))
864 865
	    {
	      /* Copy cell with menu-item marker.  */
866 867 868 869
	      XCDR (elt)
		= Fcons (XCAR (tem), XCDR (tem));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
870 871 872
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
873 874 875 876
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
877 878 879 880 881
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
882 883 884 885
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCAR (elt);
886
		  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
887 888 889
		    XCAR (elt) = Fcopy_keymap (tem);
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
890
		    /* Delete cache for key equivalences.  */
891
		    XCDR (elt) = XCDR (tem);
892 893 894 895 896 897 898
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
899
	      if (STRINGP (XCAR (tem)))
900
		{
901
		  /* Copy the cell, since copy-alist didn't go this deep.  */
902 903 904 905
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
906
		  /* Also skip the optional menu help string.  */
907
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
908
		    {
909 910 911 912
		      XCDR (elt)
			= Fcons (XCAR (tem), XCDR (tem));
		      elt = XCDR (elt);
		      tem = XCDR (elt);
913 914 915 916
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
917 918 919 920
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
		    XCDR (elt) = XCDR (tem);
921
		}
922
	      if (CONSP (elt)
923 924
		  && CONSP (XCDR (elt))
		  && EQ (XCAR (XCDR (elt)), Qkeymap))
925
		XCDR (elt) = Fcopy_keymap (XCDR (elt));
926
	    }
927

928
	}
Jim Blandy's avatar
Jim Blandy committed
929
    }