keymap.c 94.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Gerd Moellmann's avatar
Gerd Moellmann committed
2 3
   Copyright (C) 1985, 86,87,88,93,94,95,98,99, 2000
   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

#define min(a, b) ((a) < (b) ? (a) : (b))
36
#define KEYMAPP(m) (!NILP (Fkeymapp (m)))
Jim Blandy's avatar
Jim Blandy committed
37

38
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
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 71 72
#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
73 74 75
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

76 77 78 79
/* 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
80 81 82 83 84
/* 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;

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

88 89 90 91 92 93
/* 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;

94
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item;
Jim Blandy's avatar
Jim Blandy committed
95

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

101 102
extern Lisp_Object Voverriding_local_map;

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

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

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

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

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

   For example:

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

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

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

/* Check that OBJECT is a keymap (after dereferencing through any
198 199 200 201
   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.
202
   If AUTOLOAD is nonzero, callers must assume GC is possible.
203 204 205 206 207 208 209 210

   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
211 212 213 214
   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.  */
215

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

223
 autoload_retry:
224 225 226 227 228 229 230
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
  else
    {
      tem = indirect_function (object);
231
      if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
232 233
	return tem;
    }
234

235 236
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
237
  if (autoload
238
      && SYMBOLP (object)
239
      && CONSP (tem)
240
      && EQ (XCAR (tem), Qautoload))
241
    {
242
      Lisp_Object tail;
243

244 245 246 247
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
248

249 250
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
251 252 253 254
	  UNGCPRO;

	  goto autoload_retry;
	}
255 256
    }

257
 end:
Jim Blandy's avatar
Jim Blandy committed
258 259
  if (error)
    wrong_type_argument (Qkeymapp, object);
260
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
261 262
}

263 264 265

/* Follow any symbol chaining, and return the keymap denoted by OBJECT.
   If OBJECT doesn't denote a keymap at all, signal an error.  */
Jim Blandy's avatar
Jim Blandy committed
266 267 268 269
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
270
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
271
}
272 273 274 275 276 277 278 279 280 281 282 283 284 285

/* 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;

  keymap = get_keymap_1 (keymap, 1, 1);

  /* Skip past the initial element `keymap'.  */
286 287
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
288 289
    {
      /* See if there is another `keymap'.  */
290
      if (KEYMAPP (list))
291 292 293
	return list;
    }

294
  return get_keymap_1(list, 0, 1);
295 296
}

297

298 299 300 301 302
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
303
  if (NILP (map)) return 0;
304 305 306 307 308
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

309 310 311 312 313 314 315 316 317
/* 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;
318
  struct gcpro gcpro1;
319
  int i;
Jim Blandy's avatar
Jim Blandy committed
320

321 322 323 324 325 326 327 328 329
  /* 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;

330
  keymap = get_keymap_1 (keymap, 1, 1);
331 332
  GCPRO1 (keymap);
  
333
  if (!NILP (parent))
334 335 336 337
    {
      parent = get_keymap_1 (parent, 1, 1);

      /* Check for cycles.  */
338
      if (keymap_memberp (keymap, parent))
339 340
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
341

342 343 344 345
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
346
      list = XCDR (prev);
347 348
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
349
      if (! CONSP (list) || KEYMAPP (list))
350
	{
351 352
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
353
	  if (EQ (XCDR (prev), parent))
354
	    RETURN_UNGCPRO (parent);
355

356
	  XCDR (prev) = parent;
357 358 359 360 361 362 363
	  break;
	}
      prev = list;
    }

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

364
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
365 366
    {
      /* Stop the scan when we come to the parent.  */
367
      if (EQ (XCAR (list), Qkeymap))
368 369 370
	break;

      /* If this element holds a prefix map, deal with it.  */
371 372 373 374 375 376 377 378
      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]))
379
	    fix_submap_inheritance (keymap, make_number (i),
380
				    XVECTOR (XCAR (list))->contents[i]);
381

382
      if (CHAR_TABLE_P (XCAR (list)))
383
	{
384
	  Lisp_Object indices[3];
385

386
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
387 388
			  keymap, 0, indices);
	}
389 390
    }

391
  RETURN_UNGCPRO (parent);
392 393 394 395 396 397
}

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

398
static void
399 400 401 402 403 404 405 406
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.  */

407
  submap = get_keymap_1 (get_keyelt (submap, 0), 0, 0);
408 409

  /* If it isn't a keymap now, there's no work to do.  */
410
  if (NILP (submap))
411 412 413 414
    return;

  map_parent = Fkeymap_parent (map);
  if (! NILP (map_parent))
415 416
    parent_entry =
      get_keymap_1 (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
417 418 419
  else
    parent_entry = Qnil;

420
  /* If MAP's parent has something other than a keymap,
421
     our own submap shadows it completely.  */
422
  if (NILP (parent_entry))
423
    return;
424

425
  if (! EQ (parent_entry, submap))
426 427 428 429 430 431
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
432

433
	  tem = Fkeymap_parent (submap_parent);
434 435 436 437 438 439 440 441

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

457 458 459
   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
460 461

Lisp_Object
462
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
463 464
     Lisp_Object map;
     Lisp_Object idx;
465
     int t_ok;
466
     int noinherit;
467
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
468
{
469 470 471
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
472 473 474
  /* 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.  */
475
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
476

477 478
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
479
  if (SYMBOLP (idx))
480
    idx = reorder_modifiers (idx);
481 482 483
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
484
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
485

486 487 488
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
489 490
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
491
      Lisp_Object meta_map =
Gerd Moellmann's avatar
Gerd Moellmann committed
492 493
	get_keymap_1 (access_keymap (map, meta_prefix_char,
				     t_ok, noinherit, autoload),
494 495
		      0, autoload);
      if (!NILP (meta_map))
496
	{
497
	  map = meta_map;
498 499 500 501 502 503 504 505
	  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;
506 507
    }

508 509
  {
    Lisp_Object tail;
510
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
511

512
    t_binding = Qnil;
513
    for (tail = XCDR (map);
514 515 516
	 (CONSP (tail)
	  || (tail = get_keymap_1 (tail, 0, autoload),
	      CONSP (tail)));
517
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
518
      {
519
	Lisp_Object binding;
520

521
	binding = XCAR (tail);
522
	if (SYMBOLP (binding))
523
	  {
524 525
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
526
	    if (noinherit && EQ (binding, Qkeymap))
527
	      noprefix = 1;
528 529 530
	  }
	else if (CONSP (binding))
	  {
531
	    if (EQ (XCAR (binding), idx))
532
	      {
533
		val = XCDR (binding);
534
		if (noprefix && KEYMAPP (val))
535
		  return Qnil;
536 537
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
538
		return get_keyelt (val, autoload);
539
	      }
540 541
	    if (t_ok && EQ (XCAR (binding), Qt))
	      t_binding = XCDR (binding);
542 543 544
	  }
	else if (VECTORP (binding))
	  {
545
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
546
	      {
547
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
548
		if (noprefix && KEYMAPP (val))
549
		  return Qnil;
550 551
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
552
		return get_keyelt (val, autoload);
553
	      }
554
	  }
555 556
	else if (CHAR_TABLE_P (binding))
	  {
557 558 559 560 561 562 563
	    /* 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)))
564 565
	      {
		val = Faref (binding, idx);
566
		if (noprefix && KEYMAPP (val))
567 568 569
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
570
		return get_keyelt (val, autoload);
571 572
	      }
	  }
573 574

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
575
      }
576

577
    return get_keyelt (t_binding, autoload);
578
  }
Jim Blandy's avatar
Jim Blandy committed
579 580 581 582 583 584 585 586 587
}

/* 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,
588 589 590 591
   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
592 593

Lisp_Object
594
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
595
     register Lisp_Object object;
596
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
597 598 599
{
  while (1)
    {
600 601 602
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
603

604 605 606 607 608 609 610
      /* 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.
611
	 This is a new format menu item.  */
612
      else if (EQ (XCAR (object), Qmenu_item))
613
	{
614
	  if (CONSP (XCDR (object)))
615
	    {
616 617
	      Lisp_Object tem;

618
	      object = XCDR (XCDR (object));
619
	      tem = object;
620 621
	      if (CONSP (object))
		object = XCAR (object);
622 623 624

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
625 626 627
		 use.  Temporarily inhibit GC while evaluating FILTER,
	         because not functions calling get_keyelt are prepared
		 for a GC.  */
628 629 630
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
		if (EQ (XCAR (tem), QCfilter))
		  {
631
		    int count = inhibit_garbage_collection ();
632 633 634 635
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
636
		    unbind_to (count, Qnil);
637 638
		    break;
		  }
639 640
	    }
	  else
641 642
	    /* Invalid keymap */
	    return object;
643 644
	}

645
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
646 647
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
648
      else if (STRINGP (XCAR (object)))
649
	{
650
	  object = XCDR (object);
651 652
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
653 654
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
655
	  /* Also remove the sublist that caches key equivalences, if any.  */
656
	  if (CONSP (object) && CONSP (XCAR (object)))
657
	    {
658
	      Lisp_Object carcar;
659
	      carcar = XCAR (XCAR (object));
660
	      if (NILP (carcar) || VECTORP (carcar))
661
		object = XCDR (object);
662
	    }
663
	}
Jim Blandy's avatar
Jim Blandy committed
664

665 666
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
667
	{
668
	  Lisp_Object map;
669
	  map = get_keymap_1 (Fcar_safe (object), 0, autoload);
670 671
	  return (NILP (map) ? object /* Invalid keymap */
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
672
	}
Jim Blandy's avatar
Jim Blandy committed
673 674 675
    }
}

676
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
677 678 679 680 681
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
682 683 684 685
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

686
  /* If we are preparing to dump, and DEF is a menu element
687 688
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
689 690
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
691

692
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
693 694
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
695 696 697
  /* 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.  */
698
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
699

700 701
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
702
  if (SYMBOLP (idx))
703
    idx = reorder_modifiers (idx);
704 705 706
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
707
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
708 709

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
710
  {
711
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
712

713 714 715 716 717 718
    /* 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.  */
719
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
720

721
    insertion_point = keymap;
722
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
723
      {
724
	Lisp_Object elt;
725

726
	elt = XCAR (tail);
727
	if (VECTORP (elt))
728
	  {
729
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
730
	      {
731
		ASET (elt, XFASTINT (idx), def);
732 733 734
		return def;
	      }
	    insertion_point = tail;
735
	  }
736 737
	else if (CHAR_TABLE_P (elt))
	  {
738 739 740 741 742 743 744
	    /* 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)))
745 746 747 748 749 750
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
751 752
	else if (CONSP (elt))
	  {
753
	    if (EQ (idx, XCAR (elt)))
754
	      {
755
		XCDR (elt) = def;
756 757
		return def;
	      }
758
	  }
759 760 761 762 763 764
	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;
765 766

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
767 768
      }

769 770 771
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
772 773
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
774
  }
775
  
Jim Blandy's avatar
Jim Blandy committed
776 777 778
  return def;
}

779
void
780 781 782
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
783 784
  if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt)))
    Faset (chartable, idx, Fcopy_keymap (elt));
785
}
786

Jim Blandy's avatar
Jim Blandy committed
787 788 789 790
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
791 792 793
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
794 795 796 797 798 799 800
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

801
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
802
    {
803
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
804

805
      elt = XCAR (tail);
806 807
      if (CHAR_TABLE_P (elt))
	{
808
	  Lisp_Object indices[3];
809 810

	  elt = Fcopy_sequence (elt);
811
	  XCAR (tail) = elt;
812

813 814 815
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
816
	{
817
	  int i;
Jim Blandy's avatar
Jim Blandy committed
818

819
	  elt = Fcopy_sequence (elt);
820
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
821

822 823 824 825
	  for (i = 0; i < ASIZE (elt); i++)
	    if (!SYMBOLP (AREF (elt, i))
		&& ! NILP (Fkeymapp (AREF (elt, i))))
	      ASET (elt, i, Fcopy_keymap (AREF (elt, i)));
Jim Blandy's avatar
Jim Blandy committed
826
	}
827
      else if (CONSP (elt) && CONSP (XCDR (elt)))
828
	{
829
	  Lisp_Object tem;
830
	  tem = XCDR (elt);
831

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

898
	}
Jim Blandy's avatar
Jim Blandy committed
899
    }
900
	      
Jim Blandy's avatar
Jim Blandy committed
901 902 903
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
904 905
/* Simple Keymap mutators and accessors.				*/

906 907
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
908 909 910 911
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
912 913
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
914 915 916 917 918 919 920 921 922 923
DEF is anything that can be a key's definition:\n\
 nil (means key is undefined in this keymap),\n\
 a command (a Lisp function suitable for interactive calling)\n\
 a string (treated as a keyboard macro),\n\
 a keymap (to define a prefix key),\n\
 a symbol.  When the key is looked up, the symbol will stand for its\n\
    function definition, which should at that time be one of the above,\n\
    or another symbol whose function definition is used, etc.\n\
 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
    (DEFN should be a valid definition in its own right),\n\
Jim Blandy's avatar
Jim Blandy committed
924 925 926 927
 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
\n\
If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
the front of KEYMAP.")
Jim Blandy's avatar
Jim Blandy committed
928
  (keymap, key, def)
929
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
930 931 932 933 934 935 936
     Lisp_Object key;
     Lisp_Object def;
{
  register int idx;
  register Lisp_Object c;
  register Lisp_Object cmd;
  int metized = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
937
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
938
  int length;
939
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
940