keymap.c 94.9 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27
#include <stdio.h>
#undef NULL
#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 108 109 110 111 112
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
113

Jim Blandy's avatar
Jim Blandy committed
114 115
/* Keymap object support - constructors and predicates.			*/

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

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

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

   For example:

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

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

168 169 170 171 172 173 174 175 176
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
177 178 179 180 181 182 183 184 185 186 187
/* Define character fromchar in map frommap as an alias for character
   tochar in map tomap.  Subsequent redefinitions of the latter WILL
   affect the former. */

#if 0
void
synkey (frommap, fromchar, tomap, tochar)
     struct Lisp_Vector *frommap, *tomap;
     int fromchar, tochar;
{
  Lisp_Object v, c;
188
  XSETVECTOR (v, tomap);
189
  XSETFASTINT (c, tochar);
Jim Blandy's avatar
Jim Blandy committed
190 191 192 193 194
  frommap->contents[fromchar] = Fcons (v, c);
}
#endif /* 0 */

DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
195
  "Return t if OBJECT is a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
196
\n\
197
A keymap is a list (keymap . ALIST),\n\
Karl Heuer's avatar
Karl Heuer committed
198
or a symbol whose function definition is itself a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
199
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
200 201
a vector of densely packed bindings for small character codes\n\
is also allowed as an element.")
Jim Blandy's avatar
Jim Blandy committed
202 203 204
  (object)
     Lisp_Object object;
{
205
  /* FIXME: Maybe this should return t for autoloaded keymaps?   -sm  */
206
  return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
207 208 209
}

/* Check that OBJECT is a keymap (after dereferencing through any
210 211 212 213
   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.
214
   If AUTOLOAD is nonzero, callers must assume GC is possible.
215 216 217 218 219 220 221 222

   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
223 224 225 226
   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.  */
227

Jim Blandy's avatar
Jim Blandy committed
228
Lisp_Object
229
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
230
     Lisp_Object object;
231
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
232
{
233
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
234

235
 autoload_retry:
236 237 238 239 240 241 242
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
  else
    {
      tem = indirect_function (object);
243
      if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
244 245
	return tem;
    }
246

247 248
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
249
  if (autoload
250
      && SYMBOLP (object)
251
      && CONSP (tem)
252
      && EQ (XCAR (tem), Qautoload))
253
    {
254
      Lisp_Object tail;
255

256 257 258 259
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
260

261 262
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
263 264 265 266
	  UNGCPRO;

	  goto autoload_retry;
	}
267 268
    }

269
 end:
Jim Blandy's avatar
Jim Blandy committed
270 271
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
272 273
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
274 275
}

276 277 278

/* 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
279 280 281 282
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
283
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
284
}
285 286 287 288 289 290 291 292 293 294 295 296 297 298

/* 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'.  */
299 300
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
301 302
    {
      /* See if there is another `keymap'.  */
303
      if (KEYMAPP (list))
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
	return list;
    }

  return Qnil;
}

/* 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;
319
  struct gcpro gcpro1;
320
  int i;
Jim Blandy's avatar
Jim Blandy committed
321

322
  keymap = get_keymap_1 (keymap, 1, 1);
323 324
  GCPRO1 (keymap);
  
325 326
  if (!NILP (parent))
    parent = get_keymap_1 (parent, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
327

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

342
	  XCDR (prev) = parent;
343 344 345 346 347 348 349
	  break;
	}
      prev = list;
    }

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

350
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
351 352
    {
      /* Stop the scan when we come to the parent.  */
353
      if (EQ (XCAR (list), Qkeymap))
354 355 356
	break;

      /* If this element holds a prefix map, deal with it.  */
357 358 359 360 361 362 363 364
      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]))
365
	    fix_submap_inheritance (keymap, make_number (i),
366
				    XVECTOR (XCAR (list))->contents[i]);
367

368
      if (CHAR_TABLE_P (XCAR (list)))
369
	{
370
	  Lisp_Object indices[3];
371

372
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
373 374
			  keymap, 0, indices);
	}
375 376
    }

377
  RETURN_UNGCPRO (parent);
378 379 380 381 382 383
}

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

384
static void
385 386 387 388 389 390 391 392
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.  */

393
  if (CONSP (submap))
394
    {
395
      /* May be an old format menu item */
396
      if (STRINGP (XCAR (submap)))
397
	{
398
	  submap = XCDR (submap);
399 400
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
401 402
	  if (CONSP (submap) && STRINGP (XCAR (submap)))
	    submap = XCDR (submap);
403 404
	  /* Also remove the sublist that caches key equivalences, if any.  */
	  if (CONSP (submap)
405
	      && CONSP (XCAR (submap)))
406 407
	    {
	      Lisp_Object carcar;
408
	      carcar = XCAR (XCAR (submap));
409
	      if (NILP (carcar) || VECTORP (carcar))
410
		submap = XCDR (submap);
411 412 413 414
	    }
	}

      /* Or a new format menu item */
415 416
      else if (EQ (XCAR (submap), Qmenu_item)
	       && CONSP (XCDR (submap)))
417
	{
418
	  submap = XCDR (XCDR (submap));
419
	  if (CONSP (submap))
420
	    submap = XCAR (submap);
421 422 423 424 425
	}
    }

  /* If it isn't a keymap now, there's no work to do.  */
  if (! CONSP (submap)
426
      || ! EQ (XCAR (submap), Qkeymap))
427 428 429 430 431 432 433 434
    return;

  map_parent = Fkeymap_parent (map);
  if (! NILP (map_parent))
    parent_entry = access_keymap (map_parent, event, 0, 0);
  else
    parent_entry = Qnil;

435 436
  /* If MAP's parent has something other than a keymap,
     our own submap shadows it completely, so use nil as SUBMAP's parent.  */
437
  if (! (CONSP (parent_entry) && EQ (XCAR (parent_entry), Qkeymap)))
438 439
    parent_entry = Qnil;

440
  if (! EQ (parent_entry, submap))
441 442 443 444 445 446 447 448 449 450
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
	  tem = Fkeymap_parent (submap_parent);
	  if (EQ (tem, parent_entry))
	    return;
          if (CONSP (tem)
451
	      && EQ (XCAR (tem), Qkeymap))
452 453 454 455 456 457
	    submap_parent = tem;
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
458 459
}

Jim Blandy's avatar
Jim Blandy committed
460
/* Look up IDX in MAP.  IDX may be any sort of event.
461
   Note that this does only one level of lookup; IDX must be a single
462 463 464 465 466 467
   event, not a sequence. 

   If T_OK is non-zero, bindings for Qt are treated as default
   bindings; any key left unmentioned by other tables and bindings is
   given the binding of Qt.  

468 469 470
   If T_OK is zero, bindings for Qt are not treated specially.

   If NOINHERIT, don't accept a subkeymap found in an inherited keymap.  */
Jim Blandy's avatar
Jim Blandy committed
471 472

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

Jim Blandy's avatar
Jim Blandy committed
482 483 484
  /* If idx is a list (some sort of mouse click, perhaps?),
     the index we want to use is the car of the list, which
     ought to be a symbol.  */
485
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
486

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

496 497
  {
    Lisp_Object tail;
498
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
499

500
    t_binding = Qnil;
501
    for (tail = map; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
502
      {
503
	Lisp_Object binding;
504

505
	binding = XCAR (tail);
506
	if (SYMBOLP (binding))
507
	  {
508 509 510 511
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
	    if (noinherit && EQ (binding, Qkeymap) && ! EQ (tail, map))
	      noprefix = 1;
512 513 514
	  }
	else if (CONSP (binding))
	  {
515
	    if (EQ (XCAR (binding), idx))
516
	      {
517 518
		val = XCDR (binding);
		if (noprefix && CONSP (val) && EQ (XCAR (val), Qkeymap))
519
		  return Qnil;
520 521
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
522 523
		return val;
	      }
524 525
	    if (t_ok && EQ (XCAR (binding), Qt))
	      t_binding = XCDR (binding);
526 527 528
	  }
	else if (VECTORP (binding))
	  {
529
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
530
	      {
531
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
532
		if (noprefix && CONSP (val) && EQ (XCAR (val), Qkeymap))
533
		  return Qnil;
534 535
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
536 537
		return val;
	      }
538
	  }
539 540
	else if (CHAR_TABLE_P (binding))
	  {
541 542 543 544 545 546 547
	    /* 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)))
548 549
	      {
		val = Faref (binding, idx);
550
		if (noprefix && CONSP (val) && EQ (XCAR (val), Qkeymap))
551 552 553 554 555 556
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
		return val;
	      }
	  }
557 558

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
559
      }
560

561 562
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
563 564 565 566 567 568 569 570 571
}

/* 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,
572 573 574 575
   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
576 577

Lisp_Object
578
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
579
     register Lisp_Object object;
580
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
581 582 583
{
  while (1)
    {
584 585 586
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
587

588 589 590 591 592 593 594
      /* 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.
595
	 This is a new format menu item.  */
596
      else if (EQ (XCAR (object), Qmenu_item))
597
	{
598
	  if (CONSP (XCDR (object)))
599
	    {
600 601
	      Lisp_Object tem;

602
	      object = XCDR (XCDR (object));
603
	      tem = object;
604 605
	      if (CONSP (object))
		object = XCAR (object);
606 607 608

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
609 610 611
		 use.  Temporarily inhibit GC while evaluating FILTER,
	         because not functions calling get_keyelt are prepared
		 for a GC.  */
612 613 614
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
		if (EQ (XCAR (tem), QCfilter))
		  {
615
		    int count = inhibit_garbage_collection ();
616 617 618 619
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
620
		    unbind_to (count, Qnil);
621 622
		    break;
		  }
623 624
	    }
	  else
625 626
	    /* Invalid keymap */
	    return object;
627 628
	}

629
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
630 631
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
632
      else if (STRINGP (XCAR (object)))
633
	{
634
	  object = XCDR (object);
635 636
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
637 638
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
639
	  /* Also remove the sublist that caches key equivalences, if any.  */
640
	  if (CONSP (object) && CONSP (XCAR (object)))
641
	    {
642
	      Lisp_Object carcar;
643
	      carcar = XCAR (XCAR (object));
644
	      if (NILP (carcar) || VECTORP (carcar))
645
		object = XCDR (object);
646
	    }
647
	}
Jim Blandy's avatar
Jim Blandy committed
648

649 650
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
651
	{
652 653
	  Lisp_Object map;
	  
654 655 656 657 658 659 660 661
	  map = get_keymap_1 (Fcar_safe (object), 0, autoload);
	  if (NILP (map))
	    /* Invalid keymap */
	    return object;
	  else
	    {
	      Lisp_Object key;
	      key = Fcdr (object);
662
	      if (INTEGERP (key) && (XUINT (key) & meta_modifier))
663 664 665 666 667 668 669 670 671 672
		{
		  object = access_keymap (map, meta_prefix_char, 0, 0);
		  map = get_keymap_1 (object, 0, autoload);
		  object = access_keymap (map, make_number (XINT (key)
							    & ~meta_modifier),
					  0, 0);
		}
	      else
		object = access_keymap (map, key, 0, 0);
	    }
673
	}
Jim Blandy's avatar
Jim Blandy committed
674 675 676
    }
}

677
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
678 679 680 681 682
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
683
  /* If we are preparing to dump, and DEF is a menu element
684 685
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
686 687
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
688

689
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
690 691
    error ("attempt to define a key in a non-keymap");

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

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
707
  {
708
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
709

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

718
    insertion_point = keymap;
719
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
720
      {
721
	Lisp_Object elt;
722

723
	elt = XCAR (tail);
724
	if (VECTORP (elt))
725
	  {
726
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
727 728 729 730 731
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
732
	  }
733 734
	else if (CHAR_TABLE_P (elt))
	  {
735 736 737 738 739 740 741
	    /* 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)))
742 743 744 745 746 747
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
748 749
	else if (CONSP (elt))
	  {
750
	    if (EQ (idx, XCAR (elt)))
751
	      {
752
		XCDR (elt) = def;
753 754
		return def;
	      }
755 756 757
	  }
	else if (SYMBOLP (elt))
	  {
758 759 760 761 762 763 764
	    /* 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.  */
	    if (EQ (elt, Qkeymap))
	      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
	  for (i = 0; i < XVECTOR (elt)->size; i++)
823
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
824
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
825 826
	      XVECTOR (elt)->contents[i]
		= Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
827
	}
828
      else if (CONSP (elt) && CONSP (XCDR (elt)))
829
	{
830
	  Lisp_Object tem;
831
	  tem = XCDR (elt);
832

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

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

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

Jim Blandy's avatar
Jim Blandy committed
909 910 911 912
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
913 914
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
915 916 917 918 919 920 921 922 923 924
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
925 926 927 928
 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
929
  (keymap, key, def)
930
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934 935 936 937
     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
938
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
939
  int length;
940
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
941

942
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
943

944
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
945 946
    key = wrong_type_argument (Qarrayp, key);

947
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
948 949 950
  if (length == 0)
    return Qnil;

951 952 953
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

954 955
  GCPRO3 (keymap, key, def);

956
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
957 958 959 960
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
961 962