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"
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 58 59 60 61 62 63 64 65 66 67 68 69 70
#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
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

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

99 100
extern Lisp_Object Voverriding_local_map;

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

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

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

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

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

   For example:

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

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

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

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

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

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

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

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

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

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

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

278
 end:
Jim Blandy's avatar
Jim Blandy committed
279 280
  if (error)
    wrong_type_argument (Qkeymapp, object);
281
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
282
}
283 284 285 286 287 288 289 290 291 292 293

/* 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;

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

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

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

308

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

320 321 322 323 324 325 326 327 328
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
  "Modify KEYMAP to set its parent map to PARENT.\n\
PARENT should be nil or another keymap.")
  (keymap, parent)
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
329
  struct gcpro gcpro1;
330
  int i;
Jim Blandy's avatar
Jim Blandy committed
331

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

929
	}