keymap.c 108 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, 01, 2004
Gerd Moellmann's avatar
Gerd Moellmann committed
3
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27
#include <stdio.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
28
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
30
#include "termhooks.h"
31
#include "blockinput.h"
32
#include "puresize.h"
Dave Love's avatar
Dave Love committed
33
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
34
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
35

36
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
#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 */
58
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
59 60 61 62 63 64 65 66 67 68 69 70
				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
				   in the minibuf */

/* keymap used for minibuffers when doing completion */
/* was MinibufLocalCompletionMap */
Lisp_Object Vminibuffer_local_completion_map;

/* keymap used for minibuffers when doing completion and require a match */
/* was MinibufLocalMustMatchMap */
Lisp_Object Vminibuffer_local_must_match_map;

Jim Blandy's avatar
Jim Blandy committed
71 72 73
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

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

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

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

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

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

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

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

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

108 109
extern Lisp_Object Voverriding_local_map;

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

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

131
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
132 133 134 135 136 137 138 139 140
       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)
141
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
142
{
143 144 145 146 147
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
148
  return Fcons (Qkeymap,
149
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
150 151
}

152
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
153 154 155 156 157 158 159 160 161
       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)
162
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
163
{
164 165
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
166 167 168 169 170 171 172 173
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

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

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

185 186 187 188 189 190 191 192 193
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
194
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
195 196 197 198 199 200 201 202
       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
203 204
     Lisp_Object object;
{
205
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
206 207
}

208
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
209 210 211 212
       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)
213 214 215 216 217 218 219 220 221 222 223 224 225
     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
226
/* Check that OBJECT is a keymap (after dereferencing through any
227 228 229 230
   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.
231
   If AUTOLOAD is nonzero, callers must assume GC is possible.
232

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

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

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

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

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

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

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

280 281 282
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
283

284 285 286 287 288
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
289
	}
290 291
    }

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

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

308
  keymap = get_keymap (keymap, 1, autoload);
309 310

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

319
  return get_keymap (list, 0, autoload);
320 321
}

322 323 324 325 326 327 328
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);
}
329

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

341 342 343
/* Set the parent keymap of MAP to PARENT.  */

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

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

362
  GCPRO2 (keymap, parent);
363
  keymap = get_keymap (keymap, 1, 1);
364

365
  if (!NILP (parent))
366
    {
367
      parent = get_keymap (parent, 1, 1);
368 369

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

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

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

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

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

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

414
      if (CHAR_TABLE_P (XCAR (list)))
415
	{
416
	  Lisp_Object indices[3];
417

418 419
	  map_char_table (fix_submap_inheritance, Qnil,
			  XCAR (list), XCAR (list),
420 421
			  keymap, 0, indices);
	}
422 423
    }

424
  RETURN_UNGCPRO (parent);
425 426 427 428 429 430
}

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

431
static void
432 433 434 435 436 437 438 439
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.  */

440
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
441 442

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

446
  map_parent = keymap_parent (map, 0);
447
  if (!NILP (map_parent))
448
    parent_entry =
449
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
450 451 452
  else
    parent_entry = Qnil;

453
  /* If MAP's parent has something other than a keymap,
454
     our own submap shadows it completely.  */
455
  if (!CONSP (parent_entry))
456
    return;
457

458
  if (! EQ (parent_entry, submap))
459 460 461 462 463 464
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
465

466
	  tem = keymap_parent (submap_parent, 0);
467 468 469 470 471 472 473 474

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

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

490 491 492
   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
493 494

Lisp_Object
495
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
496 497
     Lisp_Object map;
     Lisp_Object idx;
498
     int t_ok;
499
     int noinherit;
500
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
501
{
502 503 504 505
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
507 508 509
  /* 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.  */
510
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
511

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

521 522 523
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
524 525
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
526 527 528 529 530 531 532
      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;
533
      if (CONSP (meta_map))
534
	{
535
	  map = meta_map;
536 537 538 539 540 541 542 543
	  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;
544 545
    }

546 547 548
  /* 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.  */
549 550
  {
    Lisp_Object tail;
551 552
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
553

554
    GCPRO4 (map, tail, idx, t_binding);
555 556 557 558 559

    /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
       If it is 1, only generic-char bindings are accepted.
       Otherwise, neither are.  */
    t_ok = t_ok ? 2 : 0;
Jim Blandy's avatar
Jim Blandy committed
560

561
    for (tail = XCDR (map);
562
	 (CONSP (tail)
563
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
564
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
565
      {
566
	Lisp_Object binding;
567

568
	binding = XCAR (tail);
569
	if (SYMBOLP (binding))
570
	  {
571 572
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
573
	    if (noinherit && EQ (binding, Qkeymap))
574
	      RETURN_UNGCPRO (Qnil);
575 576 577
	  }
	else if (CONSP (binding))
	  {
578
	    Lisp_Object key = XCAR (binding);
579

580
	    if (EQ (key, idx))
581 582 583
	      val = XCDR (binding);
	    else if (t_ok
		     && INTEGERP (idx)
584
		     && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
585
		     && INTEGERP (key)
586
		     && (XINT (key) & CHAR_MODIFIER_MASK) == 0
587 588 589 590 591 592 593 594 595 596
		     && !SINGLE_BYTE_CHAR_P (XINT (idx))
		     && !SINGLE_BYTE_CHAR_P (XINT (key))
		     && CHAR_VALID_P (XINT (key), 1)
		     && !CHAR_VALID_P (XINT (key), 0)
		     && (CHAR_CHARSET (XINT (key))
			 == CHAR_CHARSET (XINT (idx))))
	      {
		/* KEY is the generic character of the charset of IDX.
		   Use KEY's binding if there isn't a binding for IDX
		   itself.  */
597 598 599 600 601 602 603
		t_binding = XCDR (binding);
		t_ok = 0;
	      }
	    else if (t_ok > 1 && EQ (key, Qt))
	      {
		t_binding = XCDR (binding);
		t_ok = 1;
604
	      }
605 606 607
	  }
	else if (VECTORP (binding))
	  {
608 609
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
610
	  }
611 612
	else if (CHAR_TABLE_P (binding))
	  {
613 614 615
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
616 617 618 619 620 621 622 623 624
	    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;
	      }
625
	  }
626

627 628 629
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
630 631 632 633 634
	    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;
635 636 637
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
638
	    RETURN_UNGCPRO (val);
639
	  }
640
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
641
      }
642
    UNGCPRO;
643
    return get_keyelt (t_binding, autoload);
644
  }
Jim Blandy's avatar
Jim Blandy committed
645 646
}

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
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
674 675
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
   AUTOLOAD if non-zero means that we can autoload keymaps if necessary.  */
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
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);
693

694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
      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;
	  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))
	{
	  Lisp_Object indices[3];
711
	  map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
					args)),
			  0, indices);
	}
    }
  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
743 744 745 746 747 748 749
/* 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,
750 751 752 753
   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
754 755

Lisp_Object
756
get_keyelt (object, autoload)
757
     Lisp_Object object;
758
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
759 760 761
{
  while (1)
    {
762 763 764
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
765

766 767 768 769 770 771 772
      /* 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.
773
	 This is a new format menu item.  */
774
      else if (EQ (XCAR (object), Qmenu_item))
775
	{
776
	  if (CONSP (XCDR (object)))
777
	    {
778 779
	      Lisp_Object tem;

780
	      object = XCDR (XCDR (object));
781
	      tem = object;
782 783
	      if (CONSP (object))
		object = XCAR (object);
784 785 786

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
787
		 use.  */
788
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
789
		if (EQ (XCAR (tem), QCfilter) && autoload)
790 791 792 793 794 795 796
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
797 798
	    }
	  else
799
	    /* Invalid keymap.  */
800
	    return object;
801 802
	}

803
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
804 805
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
806
      else if (STRINGP (XCAR (object)))
807
	{
808
	  object = XCDR (object);
809 810
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
811 812
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
813
	  /* Also remove the sublist that caches key equivalences, if any.  */
814
	  if (CONSP (object) && CONSP (XCAR (object)))
815
	    {
816
	      Lisp_Object carcar;
817
	      carcar = XCAR (XCAR (object));
818
	      if (NILP (carcar) || VECTORP (carcar))
819
		object = XCDR (object);
820
	    }
821
	}
Jim Blandy's avatar
Jim Blandy committed
822

823 824
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
825
	{
826
	  struct gcpro gcpro1;
827
	  Lisp_Object map;
828
	  GCPRO1 (object);
829
	  map = get_keymap (Fcar_safe (object), 0, autoload);
830
	  UNGCPRO;
831
	  return (!CONSP (map) ? object /* Invalid keymap */
832
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
833
	}
Jim Blandy's avatar
Jim Blandy committed
834 835 836
    }
}

837
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
838 839 840 841 842
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
843 844 845 846
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

847
  /* If we are preparing to dump, and DEF is a menu element
848 849
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
850 851
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
852

853
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
854 855
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
856 857 858
  /* 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.  */
859
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
860

861 862
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
863
  if (SYMBOLP (idx))
864
    idx = reorder_modifiers (idx);
865 866 867
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
868
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
869 870

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
871
  {
872
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
873

874 875 876 877 878 879
    /* 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.  */
880
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
881

882
    insertion_point = keymap;
883
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
884
      {
885
	Lisp_Object elt;
886

887
	elt = XCAR (tail);
888
	if (VECTORP (elt))
889
	  {
890
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
891
	      {
892
		ASET (elt, XFASTINT (idx), def);
893 894 895
		return def;
	      }
	    insertion_point = tail;
896
	  }
897 898
	else if (CHAR_TABLE_P (elt))
	  {
899 900 901
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
902
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
903
	      {
904 905 906 907 908
		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);
909 910 911 912
		return def;
	      }
	    insertion_point = tail;
	  }
913 914
	else if (CONSP (elt))
	  {
915
	    if (EQ (idx, XCAR (elt)))
916
	      {
917
		XSETCDR (elt, def);
918 919
		return def;
	      }
920
	  }
921 922 923 924 925 926
	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;
927 928

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
929 930
      }

931 932 933
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
934 935
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
936
  }
937

Jim Blandy's avatar
Jim Blandy committed
938 939 940
  return def;
}

941 942
EXFUN (Fcopy_keymap, 1);

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 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
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;
}

1017
static void
1018 1019 1020
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
1021
  Faset (chartable, idx, copy_keymap_item (elt));
1022
}
1023

Jim Blandy's avatar
Jim Blandy committed
1024
DEFUN <