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
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 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,
119 120 121 122 123 124 125 126 127
       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)
128
     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 141 142 143 144 145 146 147 148
       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)
149
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
150
{
151 152
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
153 154 155 156 157 158 159 160
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

309

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

321 322 323
/* Set the parent keymap of MAP to PARENT.  */

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

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

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

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

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

368
	  XSETCDR (prev, parent);
369 370 371 372 373 374 375
	  break;
	}
      prev = list;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

522 523
  {
    Lisp_Object tail;
524 525 526

    /* t_binding is where we put a default binding that applies,
       to use in case we do not find a binding specifically
527
       for this key sequence.  */
528 529 530

    Lisp_Object t_binding;
    t_binding = Qnil;
531 532 533 534 535

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

537
    for (tail = XCDR (map);
538
	 (CONSP (tail)
539
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
540
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
541
      {
542
	Lisp_Object binding;
543

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

598 599 600 601 602 603 604 605
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
	    return val;
	  }
606
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
607
      }
608

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
		XSETCDR (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
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
802
  }
803
  
Jim Blandy's avatar
Jim Blandy committed
804 805 806
  return def;
}

807 808
EXFUN (Fcopy_keymap, 1);

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

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

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

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

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

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

	  elt = Fcopy_sequence (elt);
844
	  XSETCAR (tail, elt);
845

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

852
	  elt = Fcopy_sequence (elt);
853
	  XSETCAR (tail, elt);
Jim Blandy's avatar
Jim Blandy committed
854

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

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

930
	}
Jim Blandy's avatar
Jim Blandy committed
931
    }
932
  
Jim Blandy's avatar
Jim Blandy committed
933 934 935
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
936 937
/* Simple Keymap mutators and accessors.				*/

938 939
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
940
DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,