keymap.c 119 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, 2010 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
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
25 26 27
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
28
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
29
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "keyboard.h"
31
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
32
#include "termhooks.h"
33
#include "blockinput.h"
34
#include "puresize.h"
Dave Love's avatar
Dave Love committed
35
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
36
#include "keymap.h"
37
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
38

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

70 71 72
/* keymap used for minibuffers when doing completion in filenames */
Lisp_Object Vminibuffer_local_filename_completion_map;

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

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

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

88 89 90
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

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

97
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
98
Lisp_Object QCadvertised_binding;
Jim Blandy's avatar
Jim Blandy committed
99

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

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

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

111 112
extern Lisp_Object Voverriding_local_map;

113 114 115 116 117
/* 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;

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

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

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

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

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

   For example:

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

void
initial_define_key (keymap, key, defname)
     Lisp_Object keymap;
     int key;
     char *defname;
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
191
  store_in_keymap (keymap, make_number (key), intern_c_string (defname));
Jim Blandy's avatar
Jim Blandy committed
192 193
}

194 195 196 197 198 199
void
initial_define_lispy_key (keymap, keyname, defname)
     Lisp_Object keymap;
     char *keyname;
     char *defname;
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
200
  store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname));
201 202
}

Jim Blandy's avatar
Jim Blandy committed
203
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
204 205 206 207 208 209 210 211
       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
212 213
     Lisp_Object object;
{
214
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
215 216
}

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

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

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

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

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

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

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

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

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

290 291 292
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
293

294 295 296
		  goto autoload_retry;
		}
	      else
297
	      	return object;
298
	    }
299
	}
300 301
    }

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

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

318
  keymap = get_keymap (keymap, 1, autoload);
319 320

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

329
  return get_keymap (list, 0, autoload);
330 331
}

332
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
333 334
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
335 336 337 338 339
     (keymap)
     Lisp_Object keymap;
{
  return keymap_parent (keymap, 1);
}
340

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

352 353 354
/* Set the parent keymap of MAP to PARENT.  */

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

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

373
  GCPRO2 (keymap, parent);
374
  keymap = get_keymap (keymap, 1, 1);
375

376
  if (!NILP (parent))
377
    {
378
      parent = get_keymap (parent, 1, 1);
379 380

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

566
    GCPRO4 (map, tail, idx, t_binding);
567

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

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

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

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

636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
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);
657 658 659 660
      /* 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));
661 662 663 664 665
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

666 667 668 669 670 671 672
/* 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)
673 674
{
  struct gcpro gcpro1, gcpro2, gcpro3;
675 676
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
677 678

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

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

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

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
/* 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;
}

737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
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;
}

757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
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;
}

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

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

788 789 790 791
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

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

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

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

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

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

831
	      object = XCDR (XCDR (object));
832
	      tem = object;
833 834
	      if (CONSP (object))
		object = XCAR (object);
835 836 837

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

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

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

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

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

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

907 908 909 910 911 912 913 914 915
  /* 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
916

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

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

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

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

943