keymap.c 118 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


24
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
25
#include <stdio.h>
26 27 28
#if HAVE_ALLOCA_H
# include <alloca.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
29 30 31
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
32
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
33
#include "keyboard.h"
34
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
35
#include "termhooks.h"
36
#include "blockinput.h"
37
#include "puresize.h"
Dave Love's avatar
Dave Love committed
38
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
39
#include "keymap.h"
40
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
41

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

73 74 75
/* keymap used for minibuffers when doing completion in filenames */
Lisp_Object Vminibuffer_local_filename_completion_map;

76
/* keymap used for minibuffers when doing completion in filenames
77 78 79
   with require-match*/
Lisp_Object Vminibuffer_local_must_match_filename_map;

Jim Blandy's avatar
Jim Blandy committed
80 81 82 83
/* 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
84 85 86
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

87 88 89 90
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

91 92 93
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

94 95 96 97 98 99
/* 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;

100
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
Jim Blandy's avatar
Jim Blandy committed
101

102 103 104
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

105 106
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
107

Jim Blandy's avatar
Jim Blandy committed
108 109 110
/* 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
111 112
extern Lisp_Object meta_prefix_char;

113 114
extern Lisp_Object Voverriding_local_map;

115 116 117 118 119
/* 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;

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

137
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
138
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
139 140 141 142 143
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.
144 145 146 147

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

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

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

   For example:

181
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
182 183 184 185 186 187 188 189 190 191

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

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

215
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
216 217 218 219
       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)
220 221
     Lisp_Object map;
{
222
  map = get_keymap (map, 0, 0);
223 224
  while (CONSP (map))
    {
225
      Lisp_Object tem = XCAR (map);
226 227
      if (STRINGP (tem))
	return tem;
228
      map = XCDR (map);
229 230 231 232
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
233
/* Check that OBJECT is a keymap (after dereferencing through any
234 235 236 237
   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.
238
   If AUTOLOAD is nonzero, callers must assume GC is possible.
239

240 241 242
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

243 244 245 246 247 248 249
   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
250 251 252 253
   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.  */
254

Jim Blandy's avatar
Jim Blandy committed
255
Lisp_Object
256
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
257
     Lisp_Object object;
258
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
259
{
260
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
261

262
 autoload_retry:
263 264 265 266
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
267

268 269
  tem = indirect_function (object);
  if (CONSP (tem))
270
    {
271 272
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
273

274 275
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
276 277
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload)
	  && SYMBOLP (object))
278
	{
279
	  Lisp_Object tail;
280

281 282 283 284 285 286
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
287

288 289 290
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
291

292 293 294 295 296
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
297
	}
298 299
    }

300
 end:
Jim Blandy's avatar
Jim Blandy committed
301 302
  if (error)
    wrong_type_argument (Qkeymapp, object);
303
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
304
}
305

306 307
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
308

309 310
Lisp_Object
keymap_parent (keymap, autoload)
311
     Lisp_Object keymap;
312
     int autoload;
313 314 315
{
  Lisp_Object list;

316
  keymap = get_keymap (keymap, 1, autoload);
317 318

  /* Skip past the initial element `keymap'.  */
319 320
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
321 322
    {
      /* See if there is another `keymap'.  */
323
      if (KEYMAPP (list))
324 325 326
	return list;
    }

327
  return get_keymap (list, 0, autoload);
328 329
}

330 331 332 333 334 335 336
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);
}
337

338 339 340 341 342
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
343
  if (NILP (map)) return 0;
344
  while (KEYMAPP (maps) && !EQ (map, maps))
345
    maps = keymap_parent (maps, 0);
346 347 348
  return (EQ (map, maps));
}

349 350 351
/* Set the parent keymap of MAP to PARENT.  */

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

361 362 363 364 365 366 367 368 369
  /* 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;

370
  GCPRO2 (keymap, parent);
371
  keymap = get_keymap (keymap, 1, 1);
372

373
  if (!NILP (parent))
374
    {
375
      parent = get_keymap (parent, 1, 1);
376 377

      /* Check for cycles.  */
378
      if (keymap_memberp (keymap, parent))
379 380
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
381

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

396
	  CHECK_IMPURE (prev);
397
	  XSETCDR (prev, parent);
398 399 400 401 402 403 404
	  break;
	}
      prev = list;
    }

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

405
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
406 407
    {
      /* Stop the scan when we come to the parent.  */
408
      if (EQ (XCAR (list), Qkeymap))
409 410 411
	break;

      /* If this element holds a prefix map, deal with it.  */
412 413 414 415 416 417 418 419
      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]))
420
	    fix_submap_inheritance (keymap, make_number (i),
421
				    XVECTOR (XCAR (list))->contents[i]);
422

423
      if (CHAR_TABLE_P (XCAR (list)))
424
	{
425
	  int indices[3];
426

427 428
	  map_char_table (fix_submap_inheritance, Qnil,
			  XCAR (list), XCAR (list),
429 430
			  keymap, 0, indices);
	}
431 432
    }

433
  RETURN_UNGCPRO (parent);
434 435 436 437 438 439
}

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

440
static void
441 442 443 444 445 446 447 448
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.  */

449
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
450 451

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

455
  map_parent = keymap_parent (map, 0);
456
  if (!NILP (map_parent))
457
    parent_entry =
458
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
459 460 461
  else
    parent_entry = Qnil;

462
  /* If MAP's parent has something other than a keymap,
463
     our own submap shadows it completely.  */
464
  if (!CONSP (parent_entry))
465
    return;
466

467
  if (! EQ (parent_entry, submap))
468 469 470 471 472 473
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
474

475
	  tem = keymap_parent (submap_parent, 0);
476 477 478 479 480 481 482 483

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

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

499 500 501
   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
502 503

Lisp_Object
504
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
505 506
     Lisp_Object map;
     Lisp_Object idx;
507
     int t_ok;
508
     int noinherit;
509
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
510
{
511 512 513 514
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
516 517 518
  /* 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.  */
519
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
520

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

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

559 560 561
  /* 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.  */
562 563
  {
    Lisp_Object tail;
564 565
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
566

567
    GCPRO4 (map, tail, idx, t_binding);
568 569 570 571 572

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

574
    for (tail = XCDR (map);
575
	 (CONSP (tail)
576
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
577
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
578
      {
579
	Lisp_Object binding;
580

581
	binding = XCAR (tail);
582
	if (SYMBOLP (binding))
583
	  {
584 585
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
586
	    if (noinherit && EQ (binding, Qkeymap))
587
	      RETURN_UNGCPRO (Qnil);
588 589 590
	  }
	else if (CONSP (binding))
	  {
591
	    Lisp_Object key = XCAR (binding);
592

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

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

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
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
687 688
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
   AUTOLOAD if non-zero means that we can autoload keymaps if necessary.  */
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;

699
  tail = Qnil;
700 701 702 703 704 705 706
  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);
707

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
      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))
	{
724
	  int indices[3];
725
	  map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
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);
}

743
DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
744
       doc: /* Call FUNCTION once for each event binding in KEYMAP.
Richard M. Stallman's avatar
Richard M. Stallman committed
745
FUNCTION is called with two arguments: the event that is bound, and
746 747 748 749
the definition it is bound to.  If the event is an integer, it may be
a generic character (see Info node `(elisp)Splitting Characters'), and
that means that all actual character events belonging to that generic
character are bound to the definition.
Richard M. Stallman's avatar
Richard M. Stallman committed
750

751 752
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
753 754 755 756
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
757 758 759 760
{
  if (INTEGERP (function))
    /* We have to stop integers early since map_keymap gives them special
       significance.  */
Kim F. Storm's avatar
Kim F. Storm committed
761
    xsignal1 (Qinvalid_function, function);
762 763
  if (! NILP (sort_first))
    return call3 (intern ("map-keymap-internal"), function, keymap, Qt);
764

765 766 767 768
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
769 770 771 772 773 774 775
/* 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,
776 777 778
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
779 780 781
   that are referred to with indirection.

   This can GC because menu_item_eval_property calls Feval.  */
Jim Blandy's avatar
Jim Blandy committed
782 783

Lisp_Object
784
get_keyelt (object, autoload)
785
     Lisp_Object object;
786
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
787 788 789
{
  while (1)
    {
790 791 792
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
793

794 795 796 797 798 799 800
      /* 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.
801
	 This is a new format menu item.  */
802
      else if (EQ (XCAR (object), Qmenu_item))
803
	{
804
	  if (CONSP (XCDR (object)))
805
	    {
806 807
	      Lisp_Object tem;

808
	      object = XCDR (XCDR (object));
809
	      tem = object;
810 811
	      if (CONSP (object))
		object = XCAR (object);
812 813 814

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
815
		 use.  */
816
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
817
		if (EQ (XCAR (tem), QCfilter) && autoload)
818 819 820 821 822 823 824
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
825 826
	    }
	  else
827
	    /* Invalid keymap.  */
828
	    return object;
829 830
	}

831
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
832 833
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
834
      else if (STRINGP (XCAR (object)))
835
	{
836
	  object = XCDR (object);
837 838
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
839 840
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
841
	  /* Also remove the sublist that caches key equivalences, if any.  */
842
	  if (CONSP (object) && CONSP (XCAR (object)))
843
	    {
844
	      Lisp_Object carcar;
845
	      carcar = XCAR (XCAR (object));
846
	      if (NILP (carcar) || VECTORP (carcar))
847
		object = XCDR (object);
848
	    }
849
	}
Jim Blandy's avatar
Jim Blandy committed
850

851 852
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
853
	{
854
	  struct gcpro gcpro1;
855
	  Lisp_Object map;
856
	  GCPRO1 (object);
857
	  map = get_keymap (Fcar_safe (object), 0, autoload);
858
	  UNGCPRO;
859
	  return (!CONSP (map) ? object /* Invalid keymap */
860
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
861
	}
Jim Blandy's avatar
Jim Blandy committed
862 863 864
    }
}

865
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
866 867 868
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
869
     Lisp_Object def;
Jim Blandy's avatar
Jim Blandy committed
870
{
871 872 873 874
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

875
  /* If we are preparing to dump, and DEF is a menu element
876 877
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
878 879
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
880

881
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
882 883
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
884 885 886
  /* 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.  */
887
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
888

889 890
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
891