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

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


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

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

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

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

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

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

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

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

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

99
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
100
Lisp_Object QCadvertised_binding;
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
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
331 332
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
333 334 335 336 337
     (keymap)
     Lisp_Object keymap;
{
  return keymap_parent (keymap, 1);
}
338

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

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

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

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

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

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

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

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

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

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

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

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

424
      if (CHAR_TABLE_P (XCAR (list)))
425
	{
426
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list), keymap);
427
	}
428 429
    }

430
  RETURN_UNGCPRO (parent);
431 432 433 434 435 436
}

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

437
static void
438 439 440 441 442 443 444 445
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.  */

446
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
447 448

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

452
  map_parent = keymap_parent (map, 0);
453
  if (!NILP (map_parent))
454
    parent_entry =
455
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
456 457 458
  else
    parent_entry = Qnil;

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

464
  if (! EQ (parent_entry, submap))
465 466 467 468 469 470
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
471

472
	  tem = keymap_parent (submap_parent, 0);
473 474 475 476 477 478 479 480

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

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

496 497 498
   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
499 500

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

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

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

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

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

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

564
    GCPRO4 (map, tail, idx, t_binding);
565

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

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

585
	    if (EQ (key, idx))
586
	      val = XCDR (binding);
587
	    else if (t_ok && EQ (key, Qt))
588 589
	      {
		t_binding = XCDR (binding);
590
		t_ok = 0;
591
	      }
592 593 594
	  }
	else if (VECTORP (binding))
	  {
595 596
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
597
	  }
598 599
	else if (CHAR_TABLE_P (binding))
	  {
600 601 602
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
603 604 605 606 607 608 609 610 611
	    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;
	      }
612
	  }
613

614 615 616
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
617 618 619 620 621
	    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;
622 623 624
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
625
	    RETURN_UNGCPRO (val);
626
	  }
627
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
628
      }
629
    UNGCPRO;
630
    return get_keyelt (t_binding, autoload);
631
  }
Jim Blandy's avatar
Jim Blandy committed
632 633
}

634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
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);
655 656 657 658
      /* If the key is a range, make a copy since map_char_table modifies
	 it in place.  */
      if (CONSP (key))
	key = Fcons (XCAR (key), XCDR (key));
659 660 661 662 663
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

664 665 666 667 668 669 670
/* Call FUN for every binding in MAP and stop at (and return) the parent.
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).  */
Lisp_Object
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
671 672
{
  struct gcpro gcpro1, gcpro2, gcpro3;
673 674
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
675 676

  GCPRO3 (map, args, tail);
677
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
678 679
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
680

681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
      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))
	{
Kenichi Handa's avatar
Kenichi Handa committed
697
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
698 699
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
700
					args)));
701 702 703
	}
    }
  UNGCPRO;
704
  return tail;
705 706 707 708 709 710 711 712 713 714
}

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

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
/* Same as map_keymap_internal, but doesn't traverses parent keymaps as well.
   A non-zero AUTOLOAD indicates that autoloaded keymaps should be loaded.  */
void
map_keymap (map, fun, args, data, autoload)
     map_keymap_function_t fun;
     Lisp_Object map, args;
     void *data;
     int autoload;
{
  struct gcpro gcpro1;
  GCPRO1 (args);
  map = get_keymap (map, 1, autoload);
  while (CONSP (map))
    {
      map = map_keymap_internal (map, fun, args, data);
      map = get_keymap (map, 0, autoload);
    }
  UNGCPRO;
}

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
Lisp_Object Qkeymap_canonicalize;

/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
map_keymap_canonical (map, fun, args, data)
     map_keymap_function_t fun;
     Lisp_Object map, args;
     void *data;
{
  struct gcpro gcpro1;
  GCPRO1 (args);
  /* map_keymap_canonical may be used from redisplay (e.g. when building menus)
     so be careful to ignore errors and to inhibit redisplay.  */
  map = safe_call1 (Qkeymap_canonicalize, map);
  /* No need to use `map_keymap' here because canonical map has no parent.  */
  map_keymap_internal (map, fun, args, data);
  UNGCPRO;
}

755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
DEFUN ("map-keymap-internal", Fmap_keymap_internal, Smap_keymap_internal, 2, 2, 0,
       doc: /* Call FUNCTION once for each event binding in KEYMAP.
FUNCTION is called with two arguments: the event that is bound, and
the definition it is bound to.  The event may be a character range.
If KEYMAP has a parent, this function returns it without processing it.  */)
     (function, keymap)
     Lisp_Object function, keymap;
{
  struct gcpro gcpro1;
  GCPRO1 (function);
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  UNGCPRO;
  return keymap;
}

771
DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
772
       doc: /* Call FUNCTION once for each event binding in KEYMAP.
Richard M. Stallman's avatar
Richard M. Stallman committed
773
FUNCTION is called with two arguments: the event that is bound, and
774
the definition it is bound to.  The event may be a character range.
Richard M. Stallman's avatar
Richard M. Stallman committed
775

776 777
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
778 779 780 781
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
782
{
783
  if (! NILP (sort_first))
784
    return call2 (intern ("map-keymap-sorted"), function, keymap);
785

786 787 788 789
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
790 791 792 793 794 795 796
/* 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,
797 798 799
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
800 801 802
   that are referred to with indirection.

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

Lisp_Object
805
get_keyelt (object, autoload)
806
     Lisp_Object object;
807
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
808 809 810
{
  while (1)
    {
811 812 813
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
814

815 816 817 818 819 820 821
      /* 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.
822
	 This is a new format menu item.  */
823
      else if (EQ (XCAR (object), Qmenu_item))
824
	{
825
	  if (CONSP (XCDR (object)))
826
	    {
827 828
	      Lisp_Object tem;

829
	      object = XCDR (XCDR (object));
830
	      tem = object;
831 832
	      if (CONSP (object))
		object = XCAR (object);
833 834 835

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
836
		 use.  */
837
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
838
		if (EQ (XCAR (tem), QCfilter) && autoload)
839 840 841 842 843 844 845
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
846 847
	    }
	  else
848
	    /* Invalid keymap.  */
849
	    return object;
850 851
	}

852
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
853 854
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
855
      else if (STRINGP (XCAR (object)))
856
	{
857
	  object = XCDR (object);
858 859
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
860 861
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
862
	  /* Also remove the sublist that caches key equivalences, if any.  */
863
	  if (CONSP (object) && CONSP (XCAR (object)))
864
	    {
865
	      Lisp_Object carcar;
866
	      carcar = XCAR (XCAR (object));
867
	      if (NILP (carcar) || VECTORP (carcar))
868
		object = XCDR (object);
869
	    }
870
	}
Jim Blandy's avatar
Jim Blandy committed
871

872 873
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
874
	{
875
	  struct gcpro gcpro1;
876
	  Lisp_Object map;
877
	  GCPRO1 (object);
878
	  map = get_keymap (Fcar_safe (object), 0, autoload);
879
	  UNGCPRO;
880
	  return (!CONSP (map) ? object /* Invalid keymap */
881
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
882
	}
Jim Blandy's avatar
Jim Blandy committed
883 884 885
    }
}

886
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
887 888 889
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
890
     Lisp_Object def;
Jim Blandy's avatar
Jim Blandy committed
891
{
892 893 894 895
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

896
  /* If we are preparing to dump, and DEF is a menu element
897 898
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
899 900
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
901

902
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
903 904
    error ("attempt to define a key in a non-keymap");

905 906 907 908 909 910 911 912 913
  /* If idx is a cons, and the car part is a character, idx must be of
     the form (FROM-CHAR . TO-CHAR).  */
  if (CONSP (idx) && CHARACTERP (XCAR (idx)))
    CHECK_CHARACTER_CDR (idx);
  else
    /* If idx is a list (some sort of mouse click, perhaps?),
       the index we want to use is the car of the list, which
       ought to be a symbol.  */
    idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
914

915 916
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
917
  if (SYMBOLP (idx))
918
    idx = reorder_modifiers (idx);
919 920 921
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
922
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
923 924

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
925
  {
926
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
927

928 929 930 931 932 933
    /* 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.  */
934
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
935

936
    insertion_point = keymap;
937
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
938
      {
939
	Lisp_Object elt;
940

941
	elt = XCAR (tail);
942
	if (VECTORP (elt))
943
	  {
944
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
945
	      {
946
		CHECK_IMPURE (elt);