keymap.c 96.5 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
}

/* Check that OBJECT is a keymap (after dereferencing through any
194 195 196 197
   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.
198
   If AUTOLOAD is nonzero, callers must assume GC is possible.
199

200 201 202
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

203 204 205 206 207 208 209
   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
210 211 212 213
   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.  */
214

Jim Blandy's avatar
Jim Blandy committed
215
Lisp_Object
216
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
217
     Lisp_Object object;
218
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
219
{
220
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
221

222
 autoload_retry:
223 224 225 226
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
227

228 229
  tem = indirect_function (object);
  if (CONSP (tem))
230
    {
231 232
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
233

234 235 236
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload))
237
	{
238
	  Lisp_Object tail;
239

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
	  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;
	    }
256
	}
257 258
    }

259
 end:
Jim Blandy's avatar
Jim Blandy committed
260 261
  if (error)
    wrong_type_argument (Qkeymapp, object);
262
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
263
}
264 265 266 267 268 269 270 271 272 273 274

/* 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;

275
  keymap = get_keymap (keymap, 1, 1);
276 277

  /* Skip past the initial element `keymap'.  */
278 279
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
280 281
    {
      /* See if there is another `keymap'.  */
282
      if (KEYMAPP (list))
283 284 285
	return list;
    }

286
  return get_keymap (list, 0, 1);
287 288
}

289

290 291 292 293 294
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
295
  if (NILP (map)) return 0;
296 297 298 299 300
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

301 302 303 304 305 306 307 308 309
/* 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;
310
  struct gcpro gcpro1;
311
  int i;
Jim Blandy's avatar
Jim Blandy committed
312

313 314 315 316 317 318 319 320 321
  /* 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;

322
  keymap = get_keymap (keymap, 1, 1);
323 324
  GCPRO1 (keymap);
  
325
  if (!NILP (parent))
326
    {
327
      parent = get_keymap (parent, 1, 1);
328 329

      /* Check for cycles.  */
330
      if (keymap_memberp (keymap, parent))
331 332
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
333

334 335 336 337
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
338
      list = XCDR (prev);
339 340
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
341
      if (! CONSP (list) || KEYMAPP (list))
342
	{
343 344
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
345
	  if (EQ (XCDR (prev), parent))
346
	    RETURN_UNGCPRO (parent);
347

348
	  XCDR (prev) = parent;
349 350 351 352 353 354 355
	  break;
	}
      prev = list;
    }

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

356
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
357 358
    {
      /* Stop the scan when we come to the parent.  */
359
      if (EQ (XCAR (list), Qkeymap))
360 361 362
	break;

      /* If this element holds a prefix map, deal with it.  */
363 364 365 366 367 368 369 370
      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]))
371
	    fix_submap_inheritance (keymap, make_number (i),
372
				    XVECTOR (XCAR (list))->contents[i]);
373

374
      if (CHAR_TABLE_P (XCAR (list)))
375
	{
376
	  Lisp_Object indices[3];
377

378
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
379 380
			  keymap, 0, indices);
	}
381 382
    }

383
  RETURN_UNGCPRO (parent);
384 385 386 387 388 389
}

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

390
static void
391 392 393 394 395 396 397 398
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.  */

399
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
400 401

  /* If it isn't a keymap now, there's no work to do.  */
402
  if (!CONSP (submap))
403 404 405
    return;

  map_parent = Fkeymap_parent (map);
406
  if (!NILP (map_parent))
407
    parent_entry =
408
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
409 410 411
  else
    parent_entry = Qnil;

412
  /* If MAP's parent has something other than a keymap,
413
     our own submap shadows it completely.  */
414
  if (!CONSP (parent_entry))
415
    return;
416

417
  if (! EQ (parent_entry, submap))
418 419 420 421 422 423
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
424

425
	  tem = Fkeymap_parent (submap_parent);
426 427 428 429 430 431 432 433

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
434 435 436 437 438
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
439 440
}

Jim Blandy's avatar
Jim Blandy committed
441
/* Look up IDX in MAP.  IDX may be any sort of event.
442
   Note that this does only one level of lookup; IDX must be a single
443 444 445 446 447 448
   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.  

449 450 451
   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
452 453

Lisp_Object
454
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
455 456
     Lisp_Object map;
     Lisp_Object idx;
457
     int t_ok;
458
     int noinherit;
459
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
460
{
461 462 463
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
464 465 466
  /* 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.  */
467
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
468

469 470
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
471
  if (SYMBOLP (idx))
472
    idx = reorder_modifiers (idx);
473 474 475
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
476
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
477

478 479 480
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
481 482
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
483
      Lisp_Object meta_map =
484 485 486 487
	get_keymap (access_keymap (map, meta_prefix_char,
				   t_ok, noinherit, autoload),
		    0, autoload);
      if (CONSP (meta_map))
488
	{
489
	  map = meta_map;
490 491 492 493 494 495 496 497
	  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;
498 499
    }

500 501
  {
    Lisp_Object tail;
502
    Lisp_Object t_binding;
503
    Lisp_Object generic_binding;
Jim Blandy's avatar
Jim Blandy committed
504

505
    t_binding = Qnil;
506 507
    generic_binding = Qnil;
    
508
    for (tail = XCDR (map);
509
	 (CONSP (tail)
510
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
511
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
512
      {
513
	Lisp_Object binding;
514

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
586
      }
587

588 589 590
    if (!NILP (generic_binding))
      return get_keyelt (generic_binding, autoload);

591
    return get_keyelt (t_binding, autoload);
592
  }
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600 601
}

/* 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,
602 603 604 605
   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
606 607

Lisp_Object
608
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
609
     register Lisp_Object object;
610
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
611 612 613
{
  while (1)
    {
614 615 616
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
617

618 619 620 621 622 623 624
      /* 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.
625
	 This is a new format menu item.  */
626
      else if (EQ (XCAR (object), Qmenu_item))
627
	{
628
	  if (CONSP (XCDR (object)))
629
	    {
630 631
	      Lisp_Object tem;

632
	      object = XCDR (XCDR (object));
633
	      tem = object;
634 635
	      if (CONSP (object))
		object = XCAR (object);
636 637 638

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
639
		 use.  */
640
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
641
		if (EQ (XCAR (tem), QCfilter) && autoload)
642 643 644 645 646 647 648
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
649 650
	    }
	  else
651 652
	    /* Invalid keymap */
	    return object;
653 654
	}

655
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
656 657
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
658
      else if (STRINGP (XCAR (object)))
659
	{
660
	  object = XCDR (object);
661 662
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
663 664
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
665
	  /* Also remove the sublist that caches key equivalences, if any.  */
666
	  if (CONSP (object) && CONSP (XCAR (object)))
667
	    {
668
	      Lisp_Object carcar;
669
	      carcar = XCAR (XCAR (object));
670
	      if (NILP (carcar) || VECTORP (carcar))
671
		object = XCDR (object);
672
	    }
673
	}
Jim Blandy's avatar
Jim Blandy committed
674

675 676
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
677
	{
678
	  Lisp_Object map;
679 680
	  map = get_keymap (Fcar_safe (object), 0, autoload);
	  return (!CONSP (map) ? object /* Invalid keymap */
681
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
682
	}
Jim Blandy's avatar
Jim Blandy committed
683 684 685
    }
}

686
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
687 688 689 690 691
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
692 693 694 695
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

696
  /* If we are preparing to dump, and DEF is a menu element
697 698
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
699 700
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
701

702
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
703 704
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
705 706 707
  /* 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.  */
708
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
709

710 711
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
712
  if (SYMBOLP (idx))
713
    idx = reorder_modifiers (idx);
714 715 716
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
717
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
718 719

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
720
  {
721
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
722

723 724 725 726 727 728
    /* 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.  */
729
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
730

731
    insertion_point = keymap;
732
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
733
      {
734
	Lisp_Object elt;
735

736
	elt = XCAR (tail);
737
	if (VECTORP (elt))
738
	  {
739
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
740
	      {
741
		ASET (elt, XFASTINT (idx), def);
742 743 744
		return def;
	      }
	    insertion_point = tail;
745
	  }
746 747
	else if (CHAR_TABLE_P (elt))
	  {
748 749 750 751 752 753 754
	    /* 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)))
755 756 757 758 759 760
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
761 762
	else if (CONSP (elt))
	  {
763
	    if (EQ (idx, XCAR (elt)))
764
	      {
765
		XCDR (elt) = def;
766 767
		return def;
	      }
768
	  }
769 770 771 772 773 774
	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;
775 776

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
777 778
      }

779 780 781
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
782 783
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
784
  }
785
  
Jim Blandy's avatar
Jim Blandy committed
786 787 788
  return def;
}

789
void
790 791 792
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
793
  if (CONSP (elt) && EQ (XCAR (elt), Qkeymap))
794
    Faset (chartable, idx, Fcopy_keymap (elt));
795
}
796

Jim Blandy's avatar
Jim Blandy committed
797 798 799 800
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
801 802 803
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
804 805 806 807 808
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

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

811
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
812
    {
813
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
814

815
      elt = XCAR (tail);
816 817
      if (CHAR_TABLE_P (elt))
	{
818
	  Lisp_Object indices[3];
819 820

	  elt = Fcopy_sequence (elt);
821
	  XCAR (tail) = elt;
822

823 824 825
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
826
	{
827
	  int i;
Jim Blandy's avatar
Jim Blandy committed
828

829
	  elt = Fcopy_sequence (elt);
830
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
831

832
	  for (i = 0; i < ASIZE (elt); i++)
833
	    if (CONSP (AREF (elt, i)) && EQ (XCAR (AREF (elt, i)), Qkeymap))
834
	      ASET (elt, i, Fcopy_keymap (AREF (elt, i)));
Jim Blandy's avatar
Jim Blandy committed
835
	}
836
      else if (CONSP (elt) && CONSP (XCDR (elt)))
837
	{
838
	  Lisp_Object tem;
839
	  tem = XCDR (elt);
840

841
	  /* Is this a new format menu item.  */
842
	  if (EQ (XCAR (tem),Qmenu_item))
843 844
	    {
	      /* Copy cell with menu-item marker.  */
845 846 847 848
	      XCDR (elt)
		= Fcons (XCAR (tem), XCDR (tem));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
849 850 851
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
852 853 854 855
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
856 857 858 859 860
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
861 862 863 864
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCAR (elt);
865
		  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
866 867 868
		    XCAR (elt) = Fcopy_keymap (tem);
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
869
		    /* Delete cache for key equivalences.  */
870
		    XCDR (elt) = XCDR (tem);
871 872 873 874 875 876 877
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
878
	      if (STRINGP (XCAR (tem)))
879
		{
880
		  /* Copy the cell, since copy-alist didn't go this deep.  */
881 882 883 884
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
885
		  /* Also skip the optional menu help string.  */
886
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
887
		    {
888 889 890 891
		      XCDR (elt)
			= Fcons (XCAR (tem), XCDR (tem));
		      elt = XCDR (elt);
		      tem = XCDR (elt);
892 893 894 895
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
896 897 898 899
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
		    XCDR (elt) = XCDR (tem);
900
		}
901
	      if (CONSP (elt)
902 903
		  && CONSP (XCDR (elt))
		  && EQ (XCAR (XCDR (elt)), Qkeymap))
904
		XCDR (elt) = Fcopy_keymap (XCDR (elt));
905
	    }
906

907
	}
Jim Blandy's avatar
Jim Blandy committed
908
    }
909
	      
Jim Blandy's avatar
Jim Blandy committed
910 911 912
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
913 914
/* Simple Keymap mutators and accessors.				*/

915 916
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
917 918 919 920
DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
  "Args KEYMAP, KEY, DEF.  Define key sequence KEY, in KEYMAP, as DEF.\n\
KEYMAP is a keymap.  KEY is a string or a vector of symbols and characters\n\
meaning a sequence of keystrokes and events.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
921 922
Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
can be included if you use a vector.\n\
Jim Blandy's avatar
Jim Blandy committed