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

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
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
#include <stdio.h>
26 27 28
#if HAVE_ALLOCA_H
# include <alloca.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
29 30 31
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
32
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
33
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
34
#include "termhooks.h"
35
#include "blockinput.h"
36
#include "puresize.h"
Dave Love's avatar
Dave Love committed
37
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
38
#include "keymap.h"
39
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
40

41
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
#define DENSE_TABLE_SIZE (0200)

/* Actually allocate storage for these variables */

Lisp_Object current_global_map;	/* Current global keymap */

Lisp_Object global_map;		/* default global key bindings */

Lisp_Object meta_map;		/* The keymap used for globally bound
				   ESC-prefixed default commands */

Lisp_Object control_x_map;	/* The keymap used for globally bound
				   C-x-prefixed default commands */

/* was MinibufLocalMap */
Lisp_Object Vminibuffer_local_map;
				/* The keymap used by the minibuf for local
				   bindings when spaces are allowed in the
				   minibuf */

/* was MinibufLocalNSMap */
63
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
64 65 66 67 68 69 70 71
				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
				   in the minibuf */

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

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

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

Jim Blandy's avatar
Jim Blandy committed
79 80 81 82
/* keymap used for minibuffers when doing completion and require a match */
/* was MinibufLocalMustMatchMap */
Lisp_Object Vminibuffer_local_must_match_map;

Jim Blandy's avatar
Jim Blandy committed
83 84 85
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

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

Jim Blandy's avatar
Jim Blandy committed
93 94 95 96 97
/* 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;

98 99 100
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

101 102 103 104 105 106
/* 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;

107
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
Jim Blandy's avatar
Jim Blandy committed
108

109 110 111
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

112 113
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
114

Jim Blandy's avatar
Jim Blandy committed
115 116 117
/* 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
118 119
extern Lisp_Object meta_prefix_char;

120 121
extern Lisp_Object Voverriding_local_map;

122 123 124 125 126
/* 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;

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

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

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

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

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

   For example:

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

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

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

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

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

247 248 249
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

250 251 252 253 254 255 256
   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
257 258 259 260
   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.  */
261

Jim Blandy's avatar
Jim Blandy committed
262
Lisp_Object
263
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
264
     Lisp_Object object;
265
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
266
{
267
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
268

269
 autoload_retry:
270 271 272 273
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
274

275 276
  tem = indirect_function (object);
  if (CONSP (tem))
277
    {
278 279
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
280

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

288 289 290 291 292 293
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
294

295 296 297
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
298

299 300 301 302 303
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
304
	}
305 306
    }

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

316 317
Lisp_Object
keymap_parent (keymap, autoload)
318
     Lisp_Object keymap;
319
     int autoload;
320 321 322
{
  Lisp_Object list;

323
  keymap = get_keymap (keymap, 1, autoload);
324 325

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

334
  return get_keymap (list, 0, autoload);
335 336
}

337 338 339 340 341 342 343
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);
}
344

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

356 357 358
/* Set the parent keymap of MAP to PARENT.  */

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

368 369 370 371 372 373 374 375 376
  /* 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;

377
  GCPRO2 (keymap, parent);
378
  keymap = get_keymap (keymap, 1, 1);
379

380
  if (!NILP (parent))
381
    {
382
      parent = get_keymap (parent, 1, 1);
383 384

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

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

403
	  CHECK_IMPURE (prev);
404
	  XSETCDR (prev, parent);
405 406 407 408 409 410 411
	  break;
	}
      prev = list;
    }

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

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

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

430
      if (CHAR_TABLE_P (XCAR (list)))
431
	{
432
	  Lisp_Object indices[3];
433

434 435
	  map_char_table (fix_submap_inheritance, Qnil,
			  XCAR (list), XCAR (list),
436 437
			  keymap, 0, indices);
	}
438 439
    }

440
  RETURN_UNGCPRO (parent);
441 442 443 444 445 446
}

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

447
static void
448 449 450 451 452 453 454 455
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.  */

456
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
457 458

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

462
  map_parent = keymap_parent (map, 0);
463
  if (!NILP (map_parent))
464
    parent_entry =
465
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
466 467 468
  else
    parent_entry = Qnil;

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

474
  if (! EQ (parent_entry, submap))
475 476 477 478 479 480
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
481

482
	  tem = keymap_parent (submap_parent, 0);
483 484 485 486 487 488 489 490

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

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

506 507 508
   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
509 510

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

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

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

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

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

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

574
    GCPRO4 (map, tail, idx, t_binding);
575 576 577 578 579

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

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

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

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

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

706
  tail = Qnil;
707 708 709 710 711 712 713
  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);
714

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

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

758 759
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
760 761 762 763
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
764 765 766 767
{
  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
768
    xsignal1 (Qinvalid_function, function);
769 770
  if (! NILP (sort_first))
    return call3 (intern ("map-keymap-internal"), function, keymap, Qt);
771

772 773 774 775
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
776 777 778 779 780 781 782
/* 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,
783 784 785
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
786 787 788
   that are referred to with indirection.

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

Lisp_Object
791
get_keyelt (object, autoload)
792
     Lisp_Object object;
793
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
794 795 796
{
  while (1)
    {
797 798 799
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
800

801 802 803 804 805 806 807
      /* 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.
808
	 This is a new format menu item.  */
809
      else if (EQ (XCAR (object), Qmenu_item))
810
	{
811
	  if (CONSP (XCDR (object)))
812
	    {
813 814
	      Lisp_Object tem;

815
	      object = XCDR (XCDR (object));
816
	      tem = object;
817 818
	      if (CONSP (object))
		object = XCAR (object);
819 820 821

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

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

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

872
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
873 874 875
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
876
     Lisp_Object def;
Jim Blandy's avatar
Jim Blandy committed
877
{
878 879 880 881
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

882
  /* If we are preparing to dump, and DEF is a menu element
883 884
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
885 886
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
887

888
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
889 890
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
891 892 893
  /* 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.  */
894
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
895

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