keymap.c 118 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4
                 2005, 2006 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"
36
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
37

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94
/* 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;

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

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

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

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

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

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

117 118
extern Lisp_Object Voverriding_local_map;

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

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

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

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

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

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

   For example:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

334 335 336 337 338 339 340
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);
}
341

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

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

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

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

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

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

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

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

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

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

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

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

427
      if (CHAR_TABLE_P (XCAR (list)))
428
	{
429
	  Lisp_Object indices[3];
430

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

644 645 646
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
647 648 649 650 651
	    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;
652 653 654
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
655
	    RETURN_UNGCPRO (val);
656
	  }
657
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
658
      }
659
    UNGCPRO;
660
    return get_keyelt (t_binding, autoload);
661
  }
Jim Blandy's avatar
Jim Blandy committed
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 690
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
691 692
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
   AUTOLOAD if non-zero means that we can autoload keymaps if necessary.  */
693 694 695 696 697 698 699 700 701 702
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;

703
  tail = Qnil;
704 705 706 707 708 709 710
  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);
711

712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
      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];
729
	  map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
			  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);
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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