keymap.c 102 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"
Kenichi Handa's avatar
Kenichi Handa committed
28
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
29
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
31
#include "termhooks.h"
32
#include "blockinput.h"
33
#include "puresize.h"
Dave Love's avatar
Dave Love committed
34
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
35
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
36

37
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
#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 */
59
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
60 61 62 63 64 65 66 67 68 69 70 71
				/* 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
72 73 74
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

75 76 77 78
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

79 80 81
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86
/* 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;

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

90 91 92 93 94 95
/* 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;

96
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
Jim Blandy's avatar
Jim Blandy committed
97

98 99 100
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

101 102
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
103

Jim Blandy's avatar
Jim Blandy committed
104 105 106
/* 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
107 108
extern Lisp_Object meta_prefix_char;

109 110
extern Lisp_Object Voverriding_local_map;

111 112 113 114 115
/* 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;

116 117 118 119
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));
120 121
static void describe_command P_ ((Lisp_Object, Lisp_Object));
static void describe_translation P_ ((Lisp_Object, Lisp_Object));
122
static void describe_map P_ ((Lisp_Object, Lisp_Object,
123
			      void (*) P_ ((Lisp_Object, Lisp_Object)),
124
			      int, Lisp_Object, Lisp_Object*, int));
125
static void silly_event_symbol_error P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
126

Jim Blandy's avatar
Jim Blandy committed
127 128
/* Keymap object support - constructors and predicates.			*/

129
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
130 131 132 133 134 135 136 137 138
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
CHARTABLE is a char-table that holds the bindings for the ASCII
characters.  ALIST is an assoc-list which holds bindings for function keys,
mouse events, and any other things that appear in the input stream.
All entries in it are initially nil, meaning "command undefined".

The optional arg STRING supplies a menu name for the keymap
in case you use it as a menu with `x-popup-menu'.  */)
     (string)
139
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
140
{
141 142 143 144 145
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
146
  return Fcons (Qkeymap,
147
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
148 149
}

150
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
151 152 153 154 155 156 157 158 159
       doc: /* Construct and return a new sparse keymap.
Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
which binds the function key or mouse event SYMBOL to DEFINITION.
Initially the alist is nil.

The optional arg STRING supplies a menu name for the keymap
in case you use it as a menu with `x-popup-menu'.  */)
     (string)
160
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
161
{
162 163
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
164 165 166 167 168 169 170 171
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

172
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
173 174 175 176 177 178 179 180 181 182

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

183 184 185 186 187 188 189 190 191
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
192
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
193 194 195 196 197 198 199 200
       doc: /* Return t if OBJECT is a keymap.

A keymap is a list (keymap . ALIST),
or a symbol whose function definition is itself a keymap.
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
a vector of densely packed bindings for small character codes
is also allowed as an element.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
201 202
     Lisp_Object object;
{
203
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
204 205
}

206
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
207 208 209 210
       doc: /* Return the prompt-string of a keymap MAP.
If non-nil, the prompt is shown in the echo-area
when reading a key-sequence to be looked-up in this keymap.  */)
     (map)
211 212 213 214 215 216 217 218 219 220 221 222 223
     Lisp_Object map;
{
  while (CONSP (map))
    {
      register Lisp_Object tem;
      tem = Fcar (map);
      if (STRINGP (tem))
	return tem;
      map = Fcdr (map);
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
224
/* Check that OBJECT is a keymap (after dereferencing through any
225 226 227 228
   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.
229
   If AUTOLOAD is nonzero, callers must assume GC is possible.
230

231 232 233
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

234 235 236 237 238 239 240
   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
241 242 243 244
   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.  */
245

Jim Blandy's avatar
Jim Blandy committed
246
Lisp_Object
247
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
248
     Lisp_Object object;
249
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
250
{
251
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
252

253
 autoload_retry:
254 255 256 257
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
258

259 260
  tem = indirect_function (object);
  if (CONSP (tem))
261
    {
262 263
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
264

265 266 267
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload))
268
	{
269
	  Lisp_Object tail;
270

271 272 273 274 275 276
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
277

278 279 280
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
281

282 283 284 285 286
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
287
	}
288 289
    }

290
 end:
Jim Blandy's avatar
Jim Blandy committed
291 292
  if (error)
    wrong_type_argument (Qkeymapp, object);
293
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
294
}
295

296 297
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
298

299 300
Lisp_Object
keymap_parent (keymap, autoload)
301
     Lisp_Object keymap;
302
     int autoload;
303 304 305
{
  Lisp_Object list;

306
  keymap = get_keymap (keymap, 1, autoload);
307 308

  /* Skip past the initial element `keymap'.  */
309 310
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
311 312
    {
      /* See if there is another `keymap'.  */
313
      if (KEYMAPP (list))
314 315 316
	return list;
    }

317
  return get_keymap (list, 0, autoload);
318 319
}

320 321 322 323 324 325 326
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
       doc: /* Return the parent keymap of KEYMAP.  */)
     (keymap)
     Lisp_Object keymap;
{
  return keymap_parent (keymap, 1);
}
327

328 329 330 331 332
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
333
  if (NILP (map)) return 0;
334
  while (KEYMAPP (maps) && !EQ (map, maps))
335
    maps = keymap_parent (maps, 0);
336 337 338
  return (EQ (map, maps));
}

339 340 341
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
342 343 344
       doc: /* Modify KEYMAP to set its parent map to PARENT.
PARENT should be nil or another keymap.  */)
     (keymap, parent)
345 346 347
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
348
  struct gcpro gcpro1, gcpro2;
349
  int i;
Jim Blandy's avatar
Jim Blandy committed
350

351 352 353 354 355 356 357 358 359
  /* 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;

360
  GCPRO2 (keymap, parent);
361
  keymap = get_keymap (keymap, 1, 1);
362

363
  if (!NILP (parent))
364
    {
365
      parent = get_keymap (parent, 1, 1);
366 367

      /* Check for cycles.  */
368
      if (keymap_memberp (keymap, parent))
369 370
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
371

372 373 374 375
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
376
      list = XCDR (prev);
377 378
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
379
      if (!CONSP (list) || KEYMAPP (list))
380
	{
381 382
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
383
	  if (EQ (XCDR (prev), parent))
384
	    RETURN_UNGCPRO (parent);
385

386
	  XSETCDR (prev, parent);
387 388 389 390 391 392 393
	  break;
	}
      prev = list;
    }

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

394
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
395 396
    {
      /* Stop the scan when we come to the parent.  */
397
      if (EQ (XCAR (list), Qkeymap))
398 399 400
	break;

      /* If this element holds a prefix map, deal with it.  */
401 402 403 404 405 406 407 408
      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]))
409
	    fix_submap_inheritance (keymap, make_number (i),
410
				    XVECTOR (XCAR (list))->contents[i]);
411

412
      if (CHAR_TABLE_P (XCAR (list)))
413
	{
414
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list), keymap);
415
	}
416 417
    }

418
  RETURN_UNGCPRO (parent);
419 420 421 422 423 424
}

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

425
static void
426 427 428 429 430 431 432 433
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.  */

434
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
435 436

  /* If it isn't a keymap now, there's no work to do.  */
437
  if (!CONSP (submap))
438 439
    return;

440
  map_parent = keymap_parent (map, 0);
441
  if (!NILP (map_parent))
442
    parent_entry =
443
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
444 445 446
  else
    parent_entry = Qnil;

447
  /* If MAP's parent has something other than a keymap,
448
     our own submap shadows it completely.  */
449
  if (!CONSP (parent_entry))
450
    return;
451

452
  if (! EQ (parent_entry, submap))
453 454 455 456 457 458
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
459

460
	  tem = keymap_parent (submap_parent, 0);
461 462 463 464 465 466 467 468

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
469 470 471 472 473
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
474 475
}

Jim Blandy's avatar
Jim Blandy committed
476
/* Look up IDX in MAP.  IDX may be any sort of event.
477
   Note that this does only one level of lookup; IDX must be a single
478
   event, not a sequence.
479 480 481

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

484 485 486
   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
487 488

Lisp_Object
489
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
490 491
     Lisp_Object map;
     Lisp_Object idx;
492
     int t_ok;
493
     int noinherit;
494
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
495
{
496 497 498 499
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
501 502 503
  /* 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.  */
504
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
505

506 507
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
508
  if (SYMBOLP (idx))
509
    idx = reorder_modifiers (idx);
510 511 512
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
513
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
514

515 516 517
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
518 519
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
520 521 522 523 524 525 526
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
527
      if (CONSP (meta_map))
528
	{
529
	  map = meta_map;
530 531 532 533 534 535 536 537
	  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;
538 539
    }

540 541 542
  /* t_binding is where we put a default binding that applies,
     to use in case we do not find a binding specifically
     for this key sequence.  */
543 544
  {
    Lisp_Object tail;
545 546
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
547

548
    GCPRO4 (map, tail, idx, t_binding);
549

550
    /* If `t_ok' is 2, both `t' is accepted.  */
551
    t_ok = t_ok ? 2 : 0;
Jim Blandy's avatar
Jim Blandy committed
552

553
    for (tail = XCDR (map);
554
	 (CONSP (tail)
555
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
556
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
557
      {
558
	Lisp_Object binding;
559

560
	binding = XCAR (tail);
561
	if (SYMBOLP (binding))
562
	  {
563 564
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
565
	    if (noinherit && EQ (binding, Qkeymap))
566
	      RETURN_UNGCPRO (Qnil);
567 568 569
	  }
	else if (CONSP (binding))
	  {
570
	    Lisp_Object key = XCAR (binding);
571

572
	    if (EQ (key, idx))
573 574 575 576 577
	      val = XCDR (binding);
	    else if (t_ok > 1 && EQ (key, Qt))
	      {
		t_binding = XCDR (binding);
		t_ok = 1;
578
	      }
579 580 581
	  }
	else if (VECTORP (binding))
	  {
582 583
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
584
	  }
585 586
	else if (CHAR_TABLE_P (binding))
	  {
587 588 589
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
590 591 592 593 594 595 596 597 598
	    if (NATNUMP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
	      {
		val = Faref (binding, idx);
		/* `nil' has a special meaning for char-tables, so
		   we use something else to record an explicitly
		   unbound entry.  */
		if (NILP (val))
		  val = Qunbound;
	      }
599
	  }
600

601 602 603
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
604 605 606 607 608
	    if (EQ (val, Qt))
	      /* A Qt binding is just like an explicit nil binding
		 (i.e. it shadows any parent binding but not bindings in
		 keymaps of lower precedence).  */
	      val = Qnil;
609 610 611
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
612
	    RETURN_UNGCPRO (val);
613
	  }
614
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
615
      }
616
    UNGCPRO;
617
    return get_keyelt (t_binding, autoload);
618
  }
Jim Blandy's avatar
Jim Blandy committed
619 620
}

621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
static void
map_keymap_item (fun, args, key, val, data)
     map_keymap_function_t fun;
     Lisp_Object args, key, val;
     void *data;
{
  /* We should maybe try to detect bindings shadowed by previous
     ones and things like that.  */
  if (EQ (val, Qt))
    val = Qnil;
  (*fun) (key, val, args, data);
}

static void
map_keymap_char_table_item (args, key, val)
     Lisp_Object args, key, val;
{
  if (!NILP (val))
    {
      map_keymap_function_t fun = XSAVE_VALUE (XCAR (args))->pointer;
      args = XCDR (args);
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

/* Call FUN for every binding in MAP.
Stefan Monnier's avatar
Stefan Monnier committed
648 649
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
   AUTOLOAD if non-zero means that we can autoload keymaps if necessary.  */
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
void
map_keymap (map, fun, args, data, autoload)
     map_keymap_function_t fun;
     Lisp_Object map, args;
     void *data;
     int autoload;
{
  struct gcpro gcpro1, gcpro2, gcpro3;
  Lisp_Object tail;

  GCPRO3 (map, args, tail);
  map = get_keymap (map, 1, autoload);
  for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
       CONSP (tail) || (tail = get_keymap (tail, 0, autoload), CONSP (tail));
       tail = XCDR (tail))
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
667

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
      if (CONSP (binding))
	map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data);
      else if (VECTORP (binding))
	{
	  /* Loop over the char values represented in the vector.  */
	  int len = ASIZE (binding);
	  int c;
	  abort();
	  for (c = 0; c < len; c++)
	    {
	      Lisp_Object character;
	      XSETFASTINT (character, c);
	      map_keymap_item (fun, args, character, AREF (binding, c), data);
	    }
	}
      else if (CHAR_TABLE_P (binding))
	{
Kenichi Handa's avatar
Kenichi Handa committed
685
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
686 687
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
688
					args)));
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
	}
    }
  UNGCPRO;
}

static void
map_keymap_call (key, val, fun, dummy)
     Lisp_Object key, val, fun;
     void *dummy;
{
  call2 (fun, key, val);
}

DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 2, 0,
       doc: /* Call FUNCTION for every binding in KEYMAP.
FUNCTION is called with two arguments: the event and its binding.  */)
     (function, keymap)
     Lisp_Object function, keymap;
{
  if (INTEGERP (function))
    /* We have to stop integers early since map_keymap gives them special
       significance.  */
    Fsignal (Qinvalid_function, Fcons (function, Qnil));
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
716 717 718 719 720 721 722
/* 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,
723 724 725 726
   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
727 728

Lisp_Object
729
get_keyelt (object, autoload)
730
     Lisp_Object object;
731
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
732 733 734
{
  while (1)
    {
735 736 737
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
738

739 740 741 742 743 744 745
      /* 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.
746
	 This is a new format menu item.  */
747
      else if (EQ (XCAR (object), Qmenu_item))
748
	{
749
	  if (CONSP (XCDR (object)))
750
	    {
751 752
	      Lisp_Object tem;

753
	      object = XCDR (XCDR (object));
754
	      tem = object;
755 756
	      if (CONSP (object))
		object = XCAR (object);
757 758 759

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
760
		 use.  */
761
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
762
		if (EQ (XCAR (tem), QCfilter) && autoload)
763 764 765 766 767 768 769
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
770 771
	    }
	  else
772
	    /* Invalid keymap.  */
773
	    return object;
774 775
	}

776
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
777 778
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
779
      else if (STRINGP (XCAR (object)))
780
	{
781
	  object = XCDR (object);
782 783
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
784 785
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
786
	  /* Also remove the sublist that caches key equivalences, if any.  */
787
	  if (CONSP (object) && CONSP (XCAR (object)))
788
	    {
789
	      Lisp_Object carcar;
790
	      carcar = XCAR (XCAR (object));
791
	      if (NILP (carcar) || VECTORP (carcar))
792
		object = XCDR (object);
793
	    }
794
	}
Jim Blandy's avatar
Jim Blandy committed
795

796 797
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
798
	{
799
	  struct gcpro gcpro1;
800
	  Lisp_Object map;
801
	  GCPRO1 (object);
802
	  map = get_keymap (Fcar_safe (object), 0, autoload);
803
	  UNGCPRO;
804
	  return (!CONSP (map) ? object /* Invalid keymap */
805
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
806
	}
Jim Blandy's avatar
Jim Blandy committed
807 808 809
    }
}

810
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
811 812 813 814 815
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
816 817 818 819
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

820
  /* If we are preparing to dump, and DEF is a menu element
821 822
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
823 824
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
825

826
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
827 828
    error ("attempt to define a key in a non-keymap");

829 830 831 832 833 834 835 836 837
  /* If idx is a cons, and the car part is a character, idx must be of
     the form (FROM-CHAR . TO-CHAR).  */
  if (CONSP (idx) && CHARACTERP (XCAR (idx)))
    CHECK_CHARACTER_CDR (idx);
  else
    /* 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.  */
    idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
838

839 840
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
841
  if (SYMBOLP (idx))
842
    idx = reorder_modifiers (idx);
843 844 845
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
846
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
847 848

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
849
  {
850
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
851

852 853 854 855 856 857
    /* 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.  */
858
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
859

860
    insertion_point = keymap;
861
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
862
      {
863
	Lisp_Object elt;
864

865
	elt = XCAR (tail);
866
	if (VECTORP (elt))
867
	  {
868
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
869
	      {
870
		ASET (elt, XFASTINT (idx), def);
871 872 873
		return def;
	      }
	    insertion_point = tail;
874
	  }
875 876
	else if (CHAR_TABLE_P (elt))
	  {
877 878 879
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
880
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
881
	      {
882 883 884 885 886
		Faset (elt, idx,
		       /* `nil' has a special meaning for char-tables, so
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
887 888
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
889 890 891 892 893
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
894 895
	    insertion_point = tail;
	  }
896 897
	else if (CONSP (elt))
	  {
898
	    if (EQ (idx, XCAR (elt)))
899
	      {
900
		XSETCDR (elt, def);
901 902
		return def;
	      }
903
	  }
904 905 906 907 908 909
	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;
910 911

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
912 913
      }

914 915 916
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
917 918
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
919
  }
920

Jim Blandy's avatar
Jim Blandy committed
921 922 923
  return def;
}

924 925
EXFUN (Fcopy_keymap, 1);

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
Lisp_Object
copy_keymap_item (elt)
     Lisp_Object elt;
{
  Lisp_Object res, tem;

  if (!CONSP (elt))
    return elt;

  res = tem = elt;

  /* Is this a new format menu item.  */
  if (EQ (XCAR (tem), Qmenu_item))
    {
      /* Copy cell with menu-item marker.  */
      res = elt = Fcons (XCAR (tem), XCDR (tem));
      tem = XCDR (elt);
      if (CONSP (tem))
	{
	  /* Copy cell with menu-item name.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	  elt = XCDR (elt);
	  tem = XCDR (elt);
	}
      if (CONSP (tem))
	{
	  /* Copy cell with binding and if the binding is a keymap,
	     copy that.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	  elt = XCDR (elt);
	  tem = XCAR (elt);
	  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
	    XSETCAR (elt, Fcopy_keymap (tem));
	  tem = XCDR (elt);
	  if (CONSP (tem) && CONSP (XCAR (tem)))
	    /* Delete cache for key equivalences.  */
	    XSETCDR (elt, XCDR (tem));
	}
    }
  else
    {
      /* It may be an old fomat menu item.
	 Skip the optional menu string.  */
      if (STRINGP (XCAR (tem)))
	{
	  /* Copy the cell, since copy-alist didn't go this deep.  */
	  res = elt = Fcons (XCAR (tem), XCDR (tem));
	  tem = XCDR (elt);
	  /* Also skip the optional menu help string.  */
	  if (CONSP (tem) && STRINGP (XCAR (tem)))
	    {
	      XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
	    }
	  /* There may also be a list that caches key equivalences.
	     Just delete it for the new keymap.  */
	  if (CONSP (tem)
	      && CONSP (XCAR (tem))
	      && (NILP (XCAR (XCAR (tem)))
		  || VECTORP (XCAR (XCAR (tem)))))
	    {
	      XSETCDR (elt, XCDR (tem));
	      tem = XCDR (tem);
	    }
	  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
	    XSETCDR (elt, Fcopy_keymap (tem));
	}
      else if (EQ (XCAR (tem), Qkeymap))
	res = Fcopy_keymap (elt);
    }
  return res;
}

1000
static void
1001 1002 1003
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
Kenichi Handa's avatar
Kenichi Handa committed
1004
  Fset_char_table_range (chartable, idx, copy_keymap_item (elt));
1005
}
1006

Jim Blandy's avatar
Jim Blandy committed
1007
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
1008 1009 1010 1011 1012 1013 1014
       doc: /* Return a copy of the keymap KEYMAP.
The copy starts out with the same definitions of KEYMAP,
but changing either the copy or KEYMAP does not affect the other.
Any key definitions that are subkeymaps are recursively copied.
However, a key definition which is a symbol whose definition is a keymap
is not copied.  */)
     (keymap)
Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;
1018 1019 1020
  keymap = get_keymap (keymap, 1, 0);
  copy = tail = Fcons (Qkeymap, Qnil);
  keymap = XCDR (keymap);		/* Skip the `keymap' symbol.  */
Jim Blandy's avatar
Jim Blandy committed
1021

1022
  while (CONSP (keymap) && !EQ (XCAR (keymap), Qkeymap