keymap.c 114 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2 3 4
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
                 2005 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
Jim Blandy's avatar
Jim Blandy committed
10
the Free Software Foundation; either version 2, 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 26 27 28
#include <stdio.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
29
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
31
#include "termhooks.h"
32
#include "blockinput.h"
33
#include "puresize.h"
Dave Love's avatar
Dave Love committed
34
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
35
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
36

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

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

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

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

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

86 87 88
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

Jim Blandy's avatar
Jim Blandy committed
89 90 91 92 93
/* Keymap mapping ASCII function key sequences onto their preferred forms.
   Initialized by the terminal-specific lisp files.  See DEFVAR for more
   documentation.  */
Lisp_Object Vfunction_key_map;

94 95 96
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

97 98 99 100 101 102
/* 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;

103
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
Jim Blandy's avatar
Jim Blandy committed
104

105 106 107
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

108 109
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
110

Jim Blandy's avatar
Jim Blandy committed
111 112 113
/* 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
114 115
extern Lisp_Object meta_prefix_char;

116 117
extern Lisp_Object Voverriding_local_map;

118 119 120 121 122
/* 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;

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

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

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

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

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

   For example:

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

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

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

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

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

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

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

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

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

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

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

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

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

295 296 297 298 299
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
300
	}
301 302
    }

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

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

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

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

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

333 334 335 336 337 338 339
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);
}
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
	  Lisp_Object indices[3];
429

430 431
	  map_char_table (fix_submap_inheritance, Qnil,
			  XCAR (list), XCAR (list),
432 433
			  keymap, 0, indices);
	}
434 435
    }

436
  RETURN_UNGCPRO (parent);
437 438 439 440 441 442
}

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

443
static void
444 445 446 447 448 449 450 451
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.  */

452
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
453 454

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

458
  map_parent = keymap_parent (map, 0);
459
  if (!NILP (map_parent))
460
    parent_entry =
461
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
462 463 464
  else
    parent_entry = Qnil;

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

470
  if (! EQ (parent_entry, submap))
471 472 473 474 475 476
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
477

478
	  tem = keymap_parent (submap_parent, 0);
479 480 481 482 483 484 485 486

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

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

502 503 504
   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
505 506

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

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

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

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

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

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

570
    GCPRO4 (map, tail, idx, t_binding);
571 572 573 574 575

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

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

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

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

643 644 645
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
646 647 648 649 650
	    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;
651 652 653
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
654
	    RETURN_UNGCPRO (val);
655
	  }
656
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
657
      }
658
    UNGCPRO;
659
    return get_keyelt (t_binding, autoload);
660
  }
Jim Blandy's avatar
Jim Blandy committed
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 687 688 689
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
690 691
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
   AUTOLOAD if non-zero means that we can autoload keymaps if necessary.  */
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
void
map_keymap (map, fun, args, data, autoload)
     map_keymap_function_t fun;
     Lisp_Object map, args;
     void *data;
     int autoload;
{
  struct gcpro gcpro1, gcpro2, gcpro3;
  Lisp_Object tail;

  GCPRO3 (map, args, tail);
  map = get_keymap (map, 1, autoload);
  for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
       CONSP (tail) || (tail = get_keymap (tail, 0, autoload), CONSP (tail));
       tail = XCDR (tail))
    {
      Lisp_Object binding = XCAR (tail);
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
      if (CONSP (binding))
	map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data);
      else if (VECTORP (binding))
	{
	  /* Loop over the char values represented in the vector.  */
	  int len = ASIZE (binding);
	  int c;
	  for (c = 0; c < len; c++)
	    {
	      Lisp_Object character;
	      XSETFASTINT (character, c);
	      map_keymap_item (fun, args, character, AREF (binding, c), data);
	    }
	}
      else if (CHAR_TABLE_P (binding))
	{
	  Lisp_Object indices[3];
727
	  map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
			  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);
}

745
DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
746 747 748 749
       doc: /* Call FUNCTION once for each binding in KEYMAP.
FUNCTION is called with two arguments: the event that is bound, and
the definition it is bound to.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

888 889
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
890
  if (SYMBOLP (idx))
891
    idx = reorder_modifiers (idx);
892 893 894
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
895
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
896 897

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
898
  {
899
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
900

901 902 903 904 905 906
    /* 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.  */
907
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
908

909
    insertion_point = keymap;
910
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
911
      {
912
	Lisp_Object elt;
913

914
	elt = XCAR (tail);
915
	if (VECTORP (elt))
916
	  {
917
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
918
	      {
919
		CHECK_IMPURE (elt);
920
		ASET (elt, XFASTINT (idx), def);
921 922 923
		return def;
	      }
	    insertion_point = tail;
924
	  }
925 926
	else if (CHAR_TABLE_P (elt))
	  {
927 928 929
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
930
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
931
	      {
932 933 934 935 936
		Faset (elt, idx,
		       /* `nil' has a special meaning for char-tables, so
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
937 938 939 940
		return def;
	      }
	    insertion_point = tail;
	  }
941 942
	else if (CONSP (elt))
	  {
943
	    if (EQ (idx, XCAR (elt)))
944
	      {
945
		CHECK_IMPURE (elt);
946
		XSETCDR (elt, def);
947 948
		return def;
	      }
949
	  }
950 951 952 953 954 955
	else if (EQ (elt, Qkeymap))
	  /* If we find a 'keymap' symbol in the spine of KEYMAP,
	     then we must have found the start of a second keymap
	     being used as the tail of KEYMAP, and a binding for IDX
	     should be inserted before it.  */
	  goto keymap_end;
956 957

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
958 959
      }

960 961 962
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
963
    CHECK_IMPURE (insertion_point);
964 965
    XSETCDR (ins