keymap.c 109 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
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
133 134 135 136 137
CHARTABLE is a char-table that holds the bindings for all characters
without modifiers.  All entries in it are initially nil, meaning
"command undefined".  ALIST is an assoc-list which holds bindings for
function keys, mouse events, and any other things that appear in the
input stream.  Initially, ALIST is nil.
138 139 140 141

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

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

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

   For example:

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

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

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

209
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
210 211 212 213
       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)
214 215
     Lisp_Object map;
{
216
  map = get_keymap (map, 0, 0);
217 218
  while (CONSP (map))
    {
219
      Lisp_Object tem = XCAR (map);
220 221
      if (STRINGP (tem))
	return tem;
222
      map = XCDR (map);
223 224 225 226
    }
  return Qnil;
}

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

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

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

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

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

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

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

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

282 283 284
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
285

286 287 288 289 290
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
291
	}
292 293
    }

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

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

310
  keymap = get_keymap (keymap, 1, autoload);
311 312

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

321
  return get_keymap (list, 0, autoload);
322 323
}

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

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

343 344 345
/* Set the parent keymap of MAP to PARENT.  */

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

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

364
  GCPRO2 (keymap, parent);
365
  keymap = get_keymap (keymap, 1, 1);
366

367
  if (!NILP (parent))
368
    {
369
      parent = get_keymap (parent, 1, 1);
370 371

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

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

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

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

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

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

416
      if (CHAR_TABLE_P (XCAR (list)))
417
	{
418
	  Lisp_Object indices[3];
419

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

426
  RETURN_UNGCPRO (parent);
427 428 429 430 431 432
}

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

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

442
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
443 444

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

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

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

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

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

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

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

492 493 494
   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
495 496

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

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

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

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

523 524 525
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
526 527
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
528 529 530
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
531 532 533 534
      /* A strange value in which Meta is set would cause
	 infinite recursion.  Protect against that.  */
      if (meta_prefix_char & CHAR_META)
	meta_prefix_char = make_number (27);
535 536 537 538
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
539
      if (CONSP (meta_map))
540
	{
541
	  map = meta_map;
542 543 544 545 546 547 548 549
	  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;
550 551
    }

552 553 554
  /* 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.  */
555 556
  {
    Lisp_Object tail;
557 558
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
559

560
    GCPRO4 (map, tail, idx, t_binding);
561 562 563 564 565

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

567
    for (tail = XCDR (map);
568
	 (CONSP (tail)
569
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
570
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
571
      {
572
	Lisp_Object binding;
573

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

586
	    if (EQ (key, idx))
587 588 589
	      val = XCDR (binding);
	    else if (t_ok
		     && INTEGERP (idx)
590
		     && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
591
		     && INTEGERP (key)
592
		     && (XINT (key) & CHAR_MODIFIER_MASK) == 0
593 594 595 596 597 598 599 600 601 602
		     && !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.  */
603 604 605 606 607 608 609
		t_binding = XCDR (binding);
		t_ok = 0;
	      }
	    else if (t_ok > 1 && EQ (key, Qt))
	      {
		t_binding = XCDR (binding);
		t_ok = 1;
610
	      }
611 612 613
	  }
	else if (VECTORP (binding))
	  {
614 615
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
616
	  }
617 618
	else if (CHAR_TABLE_P (binding))
	  {
619 620 621
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
622 623 624 625 626 627 628 629 630
	    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;
	      }
631
	  }
632

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

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

700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
      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];
717
	  map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
			  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);
}

735
DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0,
736
       doc: /* Call FUNCTION for every binding in KEYMAP.
737 738 739
FUNCTION is called with two arguments: the event and its binding.
If KEYMAP has a parent, the parent's bindings are included as well.
This works recursively: if the parent has itself a parent, then the
740 741 742 743
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
744 745 746 747 748
{
  if (INTEGERP (function))
    /* We have to stop integers early since map_keymap gives them special
       significance.  */
    Fsignal (Qinvalid_function, Fcons (function, Qnil));
749 750 751
  if (! NILP (sort_first))
    return call3 (intern ("map-keymap-internal"), function, keymap, Qt);
      
752 753 754 755
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
756 757 758 759 760 761 762
/* 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,
763 764 765 766
   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
767 768

Lisp_Object
769
get_keyelt (object, autoload)
770
     Lisp_Object object;
771
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
772 773 774
{
  while (1)
    {
775 776 777
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
778

779 780 781 782 783 784 785
      /* 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.
786
	 This is a new format menu item.  */
787
      else if (EQ (XCAR (object), Qmenu_item))
788
	{
789
	  if (CONSP (XCDR (object)))
790
	    {
791 792
	      Lisp_Object tem;

793
	      object = XCDR (XCDR (object));
794
	      tem = object;
795 796
	      if (CONSP (object))
		object = XCAR (object);
797 798 799

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
800
		 use.  */
801
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
802
		if (EQ (XCAR (tem), QCfilter) && autoload)
803 804 805 806 807 808 809
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
810 811
	    }
	  else
812
	    /* Invalid keymap.  */
813
	    return object;
814 815
	}

816
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
817 818
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
819
      else if (STRINGP (XCAR (object)))
820
	{
821
	  object = XCDR (object);
822 823
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
824 825
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
826
	  /* Also remove the sublist that caches key equivalences, if any.  */
827
	  if (CONSP (object) && CONSP (XCAR (object)))
828
	    {
829
	      Lisp_Object carcar;
830
	      carcar = XCAR (XCAR (object));
831
	      if (NILP (carcar) || VECTORP (carcar))
832
		object = XCDR (object);
833
	    }
834
	}
Jim Blandy's avatar
Jim Blandy committed
835

836 837
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
838
	{
839
	  struct gcpro gcpro1;
840
	  Lisp_Object map;
841
	  GCPRO1 (object);
842
	  map = get_keymap (Fcar_safe (object), 0, autoload);
843
	  UNGCPRO;
844
	  return (!CONSP (map) ? object /* Invalid keymap */
845
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
846
	}
Jim Blandy's avatar
Jim Blandy committed
847 848 849
    }
}

850
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
851 852 853 854 855
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
856 857 858 859
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

860
  /* If we are preparing to dump, and DEF is a menu element
861 862
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
863 864
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
865

866
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
867 868
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
869 870 871
  /* 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.  */
872
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
873

874 875
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
876
  if (SYMBOLP (idx))
877
    idx = reorder_modifiers (idx);
878 879 880
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
881
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
882 883

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
884
  {
885
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
886

887 888 889 890 891 892
    /* 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.  */
893
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
894

895
    insertion_point = keymap;
896
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
897
      {
898
	Lisp_Object elt;
899

900
	elt = XCAR (tail);
901
	if (VECTORP (elt))
902
	  {
Stefan Monnier's avatar