keymap.c 115 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008 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
10
the Free Software Foundation; either version 3, 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"
Kenichi Handa's avatar
Kenichi Handa committed
32
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
33
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
34
#include "keyboard.h"
35
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
36
#include "termhooks.h"
37
#include "blockinput.h"
38
#include "puresize.h"
Dave Love's avatar
Dave Love committed
39
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
40
#include "keymap.h"
41
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
42

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

74 75 76
/* keymap used for minibuffers when doing completion in filenames */
Lisp_Object Vminibuffer_local_filename_completion_map;

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

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

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

92 93 94
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

95 96 97 98 99 100
/* 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;

101
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
Jim Blandy's avatar
Jim Blandy committed
102

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

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

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

114 115
extern Lisp_Object Voverriding_local_map;

116 117 118 119 120
/* 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;

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

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

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

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

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

   For example:

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

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

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

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

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

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

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

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

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

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

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

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

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

293 294 295 296 297
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
298
	}
299 300
    }

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

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

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

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

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

331 332 333 334 335 336 337
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);
}
338

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

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

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

362 363 364 365 366 367 368 369 370
  /* Force a keymap flush for the next call to where-is.
     Since this can be called from within where-is, we don't set where_is_cache
     directly but only where_is_cache_keymaps, since where_is_cache shouldn't
     be changed during where-is, while where_is_cache_keymaps is only used at
     the very beginning of where-is and can thus be changed here without any
     adverse effect.
     This is a very minor correctness (rather than safety) issue.  */
  where_is_cache_keymaps = Qt;

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

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

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

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

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

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

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

      /* If this element holds a prefix map, deal with it.  */
413 414 415 416 417 418 419 420
      if (CONSP (XCAR (list))
	  && CONSP (XCDR (XCAR (list))))
	fix_submap_inheritance (keymap, XCAR (XCAR (list)),
				XCDR (XCAR (list)));

      if (VECTORP (XCAR (list)))
	for (i = 0; i < XVECTOR (XCAR (list))->size; i++)
	  if (CONSP (XVECTOR (XCAR (list))->contents[i]))
421
	    fix_submap_inheritance (keymap, make_number (i),
422
				    XVECTOR (XCAR (list))->contents[i]);
423

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

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

/* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
   if EVENT is also a prefix in MAP's parent,
   make sure that SUBMAP inherits that definition as its own parent.  */

437
static void
438 439 440 441 442 443 444 445
fix_submap_inheritance (map, event, submap)
     Lisp_Object map, event, submap;
{
  Lisp_Object map_parent, parent_entry;

  /* SUBMAP is a cons that we found as a key binding.
     Discard the other things found in a menu key binding.  */

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

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

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

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

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

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

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

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

496 497 498
   If T_OK is zero, bindings for Qt are not treated specially.

   If NOINHERIT, don't accept a subkeymap found in an inherited keymap.  */
Jim Blandy's avatar
Jim Blandy committed
499 500

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

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

Jim Blandy's avatar
Jim Blandy committed
513 514 515
  /* If idx is a list (some sort of mouse click, perhaps?),
     the index we want to use is the car of the list, which
     ought to be a symbol.  */
516
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
517

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

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

556 557 558
  /* t_binding is where we put a default binding that applies,
     to use in case we do not find a binding specifically
     for this key sequence.  */
559 560
  {
    Lisp_Object tail;
561 562
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
563

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

566
    /* If `t_ok' is 2, both `t' is accepted.  */
567
    t_ok = t_ok ? 2 : 0;
Jim Blandy's avatar
Jim Blandy committed
568

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

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

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

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

637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
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);
    }
}

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

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

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
      if (CONSP (binding))
	map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data);
      else if (VECTORP (binding))
	{
	  /* Loop over the char values represented in the vector.  */
	  int len = ASIZE (binding);
	  int c;
	  for (c = 0; c < len; c++)
	    {
	      Lisp_Object character;
	      XSETFASTINT (character, c);
	      map_keymap_item (fun, args, character, AREF (binding, c), data);
	    }
	}
      else if (CHAR_TABLE_P (binding))
	{
Kenichi Handa's avatar
Kenichi Handa committed
696
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
697 698
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
699
					args)));
700 701 702
	}
    }
  UNGCPRO;
703
  return tail;
704 705 706 707 708 709 710 711 712 713
}

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

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

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

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
the definition it is bound to.  The event may be a character range.
Richard M. Stallman's avatar
Richard M. Stallman committed
754

755 756
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
757 758 759 760
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
761
{
762
  if (! NILP (sort_first))
763
    return call2 (intern ("map-keymap-sorted"), function, keymap);
764

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

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

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

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

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

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

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

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

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

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

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

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

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

884 885 886 887 888 889 890 891 892
  /* If idx is a cons, and the car part is a character, idx must be of
     the form (FROM-CHAR . TO-CHAR).  */
  if (CONSP (idx) && CHARACTERP (XCAR (idx)))
    CHECK_CHARACTER_CDR (idx);
  else
    /* If idx is a list (some sort of mouse click, perhaps?),
       the index we want to use is the car of the list, which
       ought to be a symbol.  */
    idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
893

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
904
  {
905
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
906

907 908 909 910 911 912
    /* 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.  */
913
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
914

915
    insertion_point = keymap;
916
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
917
      {
918
	Lisp_Object elt;
919

920
	elt = XCAR (tail);
921
	if (VECTORP (elt))
922
	  {
923
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
924
	      {
925
		CHECK_IMPURE (elt);
926
		ASET (elt, XFASTINT (idx), def);
927 928
		return def;
	      }
929 930 931 932 933 934 935 936 937 938 939 940 941
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		int from = XFASTINT (XCAR (idx));
		int to = XFASTINT (XCDR (idx));

		if (to >= ASIZE (elt))
		  to = ASIZE (elt) - 1;
		for (; from <= to; from++)
		  ASET (elt, from, def);
		if (to == XFASTINT (XCDR (idx)))
		  /* We have defined all keys in IDX.  */
		  return def;
	      }
942
	    insertion_point = tail;
943
	  }
944 945
	else if (CHAR_TABLE_P (elt))
	  {
946 947 948
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
949
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
950
	      {
951 952 953 954 955
		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);
956 957
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
958 959 960 961 962
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
963 964
	    insertion_point = tail;
	  }
965 966
	else if (CONSP (elt))
	  {
967
	    if (EQ (idx, XCAR (elt)))
968
	      {
969
		CHECK_IMPURE (elt);
970
		XSETCDR (elt, def);
971 972
		return def;
	      }
973 974 975 976 977 978 979 980 981 982 983 984 985
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		int from = XFASTINT (XCAR (idx));
		int to = XFASTINT (XCDR (idx));

		if (from <= XFASTINT (XCAR (elt))
		    && to >= XFASTINT (XCAR (elt)))
		  {
		    XSETCDR (elt, def);
		    if (from == to)
		      return def;
		  }
	      }
986
	  }
987 988 989 990 991 992
	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;
993 994

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
995 996
      }

997 998 999
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
    {
      Lisp_Object elt;

      if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	{
	  /* IDX specifies a range of characters, and not all of them
	     were handled yet, which means this keymap doesn't have a
	     char-table.  So, we insert a char-table now.  */
	  elt = Fmake_char_table (Qkeymap, Qnil);
	  Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
	}
      else
	elt = Fcons (idx, def);
1013
      CHECK_IMPURE (insertion_point);
1014 1015
      XSETCDR (insertion_point, Fcons (elt, XCDR (insertion_point)));
    }
1016
  }
1017

Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020
  return def;
}

1021 1022
EXFUN (Fcopy_keymap, 1);

1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
Lisp_Object
copy_keymap_item (elt)
     Lisp_Object elt;
{
  Lisp_Object res, tem;

  if (!CONSP (elt))
    return elt;

  res = tem = elt;

  /* Is this a new format menu item.  */
  if (EQ (XCAR (tem), Qmenu_item))
    {
      /* Copy cell with menu-item marker.  */
      res = elt = Fcons (XCAR (tem), XCDR (tem));
      tem = XCDR (elt);
      if (CONSP (tem))
	{
	  /* Copy cell with menu-item name.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	  elt = XCDR (elt);
	  tem = XCDR (elt);
	}
      if (CONSP (tem))
	{
	  /* Copy cell with binding and if the binding is a keymap,
	     copy that.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));