keymap.c 94.5 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Gerd Moellmann's avatar
Gerd Moellmann committed
2 3
   Copyright (C) 1985, 86,87,88,93,94,95,98,99, 2000
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27
#include <stdio.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
28
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
30
#include "termhooks.h"
31
#include "blockinput.h"
32
#include "puresize.h"
Dave Love's avatar
Dave Love committed
33
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
34 35 36

#define min(a, b) ((a) < (b) ? (a) : (b))

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

/* 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
72 73 74
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

75 76 77 78
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

Jim Blandy's avatar
Jim Blandy committed
79 80 81 82 83
/* 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;

84 85 86
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

87 88 89 90 91 92
/* 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;

93
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item;
Jim Blandy's avatar
Jim Blandy committed
94

Jim Blandy's avatar
Jim Blandy committed
95 96 97
/* 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
98 99
extern Lisp_Object meta_prefix_char;

100 101
extern Lisp_Object Voverriding_local_map;

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

107 108 109 110 111 112 113 114 115 116
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));
static Lisp_Object describe_buffer_bindings P_ ((Lisp_Object));
static void describe_command P_ ((Lisp_Object));
static void describe_translation P_ ((Lisp_Object));
static void describe_map P_ ((Lisp_Object, Lisp_Object,
			      void (*) P_ ((Lisp_Object)),
			      int, Lisp_Object, Lisp_Object*, int));
Jim Blandy's avatar
Jim Blandy committed
117

Jim Blandy's avatar
Jim Blandy committed
118 119
/* Keymap object support - constructors and predicates.			*/

120
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
121 122
  "Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).\n\
CHARTABLE is a char-table that holds the bindings for the ASCII\n\
Jim Blandy's avatar
Jim Blandy committed
123 124
characters.  ALIST is an assoc-list which holds bindings for function keys,\n\
mouse events, and any other things that appear in the input stream.\n\
125 126 127 128 129
All entries in it are initially nil, meaning \"command undefined\".\n\n\
The optional arg STRING supplies a menu name for the keymap\n\
in case you use it as a menu with `x-popup-menu'.")
  (string)
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
130
{
131 132 133 134 135
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
136
  return Fcons (Qkeymap,
137
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
138 139
}

140
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
141
  "Construct and return a new sparse keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
142 143 144
Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
which binds the function key or mouse event SYMBOL to DEFINITION.\n\
145 146 147 148 149
Initially the alist is nil.\n\n\
The optional arg STRING supplies a menu name for the keymap\n\
in case you use it as a menu with `x-popup-menu'.")
  (string)
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
150
{
151 152
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
153 154 155 156 157 158 159 160
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

161
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
162 163 164 165 166 167 168 169 170 171

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

172 173 174 175 176 177 178 179 180
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
181
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
182
  "Return t if OBJECT is a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
183
\n\
184
A keymap is a list (keymap . ALIST),\n\
Karl Heuer's avatar
Karl Heuer committed
185
or a symbol whose function definition is itself a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
186
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
187 188
a vector of densely packed bindings for small character codes\n\
is also allowed as an element.")
Jim Blandy's avatar
Jim Blandy committed
189 190 191
  (object)
     Lisp_Object object;
{
192
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
193 194 195
}

/* Check that OBJECT is a keymap (after dereferencing through any
196 197 198 199
   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.
200
   If AUTOLOAD is nonzero, callers must assume GC is possible.
201

202 203 204
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

205 206 207 208 209 210 211
   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
212 213 214 215
   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.  */
216

Jim Blandy's avatar
Jim Blandy committed
217
Lisp_Object
218
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
219
     Lisp_Object object;
220
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
221
{
222
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
223

224
 autoload_retry:
225 226 227 228
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
229

230 231
  tem = indirect_function (object);
  if (CONSP (tem))
232
    {
233 234
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
235

236 237 238
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload))
239
	{
240
	  Lisp_Object tail;
241

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
		  
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
		  
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
258
	}
259 260
    }

261
 end:
Jim Blandy's avatar
Jim Blandy committed
262 263
  if (error)
    wrong_type_argument (Qkeymapp, object);
264
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
265
}
266 267 268 269 270 271 272 273 274 275 276

/* Return the parent map of the keymap MAP, or nil if it has none.
   We assume that MAP is a valid keymap.  */

DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
  "Return the parent keymap of KEYMAP.")
  (keymap)
     Lisp_Object keymap;
{
  Lisp_Object list;

277
  keymap = get_keymap (keymap, 1, 1);
278 279

  /* Skip past the initial element `keymap'.  */
280 281
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
282 283
    {
      /* See if there is another `keymap'.  */
284
      if (KEYMAPP (list))
285 286 287
	return list;
    }

288
  return get_keymap (list, 0, 1);
289 290
}

291

292 293 294 295 296
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
297
  if (NILP (map)) return 0;
298 299 300 301 302
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

303 304 305 306 307 308 309 310 311
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
  "Modify KEYMAP to set its parent map to PARENT.\n\
PARENT should be nil or another keymap.")
  (keymap, parent)
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
312
  struct gcpro gcpro1;
313
  int i;
Jim Blandy's avatar
Jim Blandy committed
314

315 316 317 318 319 320 321 322 323
  /* 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;

324
  keymap = get_keymap (keymap, 1, 1);
325 326
  GCPRO1 (keymap);
  
327
  if (!NILP (parent))
328
    {
329
      parent = get_keymap (parent, 1, 1);
330 331

      /* Check for cycles.  */
332
      if (keymap_memberp (keymap, parent))
333 334
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
335

336 337 338 339
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
340
      list = XCDR (prev);
341 342
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
343
      if (! CONSP (list) || KEYMAPP (list))
344
	{
345 346
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
347
	  if (EQ (XCDR (prev), parent))
348
	    RETURN_UNGCPRO (parent);
349

350
	  XCDR (prev) = parent;
351 352 353 354 355 356 357
	  break;
	}
      prev = list;
    }

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

358
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
359 360
    {
      /* Stop the scan when we come to the parent.  */
361
      if (EQ (XCAR (list), Qkeymap))
362 363 364
	break;

      /* If this element holds a prefix map, deal with it.  */
365 366 367 368 369 370 371 372
      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]))
373
	    fix_submap_inheritance (keymap, make_number (i),
374
				    XVECTOR (XCAR (list))->contents[i]);
375

376
      if (CHAR_TABLE_P (XCAR (list)))
377
	{
378
	  Lisp_Object indices[3];
379

380
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
381 382
			  keymap, 0, indices);
	}
383 384
    }

385
  RETURN_UNGCPRO (parent);
386 387 388 389 390 391
}

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

392
static void
393 394 395 396 397 398 399 400
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.  */

401
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
402 403

  /* If it isn't a keymap now, there's no work to do.  */
404
  if (!CONSP (submap))
405 406 407
    return;

  map_parent = Fkeymap_parent (map);
408
  if (!NILP (map_parent))
409
    parent_entry =
410
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
411 412 413
  else
    parent_entry = Qnil;

414
  /* If MAP's parent has something other than a keymap,
415
     our own submap shadows it completely.  */
416
  if (!CONSP (parent_entry))
417
    return;
418

419
  if (! EQ (parent_entry, submap))
420 421 422 423 424 425
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
426

427
	  tem = Fkeymap_parent (submap_parent);
428 429 430 431 432 433 434 435

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
436 437 438 439 440
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
441 442
}

Jim Blandy's avatar
Jim Blandy committed
443
/* Look up IDX in MAP.  IDX may be any sort of event.
444
   Note that this does only one level of lookup; IDX must be a single
445 446 447 448 449 450
   event, not a sequence. 

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

451 452 453
   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
454 455

Lisp_Object
456
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
457 458
     Lisp_Object map;
     Lisp_Object idx;
459
     int t_ok;
460
     int noinherit;
461
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
462
{
463 464 465
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
466 467 468
  /* 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.  */
469
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
470

471 472
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
473
  if (SYMBOLP (idx))
474
    idx = reorder_modifiers (idx);
475 476 477
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
478
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
479

480 481 482
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
483 484
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
485
      Lisp_Object meta_map =
486 487 488 489
	get_keymap (access_keymap (map, meta_prefix_char,
				   t_ok, noinherit, autoload),
		    0, autoload);
      if (CONSP (meta_map))
490
	{
491
	  map = meta_map;
492 493 494 495 496 497 498 499
	  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;
500 501
    }

502 503
  {
    Lisp_Object tail;
504
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
505

506
    t_binding = Qnil;
507
    for (tail = XCDR (map);
508
	 (CONSP (tail)
509
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
510
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
511
      {
512
	Lisp_Object binding;
513

514
	binding = XCAR (tail);
515
	if (SYMBOLP (binding))
516
	  {
517 518
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
519
	    if (noinherit && EQ (binding, Qkeymap))
520
	      noprefix = 1;
521 522 523
	  }
	else if (CONSP (binding))
	  {
524
	    if (EQ (XCAR (binding), idx))
525
	      {
526
		val = XCDR (binding);
527
		if (noprefix && KEYMAPP (val))
528
		  return Qnil;
529 530
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
531
		return get_keyelt (val, autoload);
532
	      }
533 534
	    if (t_ok && EQ (XCAR (binding), Qt))
	      t_binding = XCDR (binding);
535 536 537
	  }
	else if (VECTORP (binding))
	  {
538
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
539
	      {
540
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
541
		if (noprefix && KEYMAPP (val))
542
		  return Qnil;
543 544
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
545
		return get_keyelt (val, autoload);
546
	      }
547
	  }
548 549
	else if (CHAR_TABLE_P (binding))
	  {
550 551 552 553 554 555 556
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
	    if (NATNUMP (idx)
		&& ! (XFASTINT (idx)
		      & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER
			 | CHAR_SHIFT | CHAR_CTL | CHAR_META)))
557 558
	      {
		val = Faref (binding, idx);
559
		if (noprefix && KEYMAPP (val))
560 561 562
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
563
		return get_keyelt (val, autoload);
564 565
	      }
	  }
566 567

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
568
      }
569

570
    return get_keyelt (t_binding, autoload);
571
  }
Jim Blandy's avatar
Jim Blandy committed
572 573 574 575 576 577 578 579 580
}

/* 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,
581 582 583 584
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
   that are referred to with indirection.  */
Jim Blandy's avatar
Jim Blandy committed
585 586

Lisp_Object
587
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
588
     register Lisp_Object object;
589
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
590 591 592
{
  while (1)
    {
593 594 595
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
596

597 598 599 600 601 602 603
      /* 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.
604
	 This is a new format menu item.  */
605
      else if (EQ (XCAR (object), Qmenu_item))
606
	{
607
	  if (CONSP (XCDR (object)))
608
	    {
609 610
	      Lisp_Object tem;

611
	      object = XCDR (XCDR (object));
612
	      tem = object;
613 614
	      if (CONSP (object))
		object = XCAR (object);
615 616 617

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
618 619 620
		 use.  Temporarily inhibit GC while evaluating FILTER,
	         because not functions calling get_keyelt are prepared
		 for a GC.  */
621 622 623
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
		if (EQ (XCAR (tem), QCfilter))
		  {
624
		    int count = inhibit_garbage_collection ();
625 626 627 628
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
629
		    unbind_to (count, Qnil);
630 631
		    break;
		  }
632 633
	    }
	  else
634 635
	    /* Invalid keymap */
	    return object;
636 637
	}

638
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
639 640
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
641
      else if (STRINGP (XCAR (object)))
642
	{
643
	  object = XCDR (object);
644 645
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
646 647
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
648
	  /* Also remove the sublist that caches key equivalences, if any.  */
649
	  if (CONSP (object) && CONSP (XCAR (object)))
650
	    {
651
	      Lisp_Object carcar;
652
	      carcar = XCAR (XCAR (object));
653
	      if (NILP (carcar) || VECTORP (carcar))
654
		object = XCDR (object);
655
	    }
656
	}
Jim Blandy's avatar
Jim Blandy committed
657

658 659
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
660
	{
661
	  Lisp_Object map;
662 663
	  map = get_keymap (Fcar_safe (object), 0, autoload);
	  return (!CONSP (map) ? object /* Invalid keymap */
664
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
665
	}
Jim Blandy's avatar
Jim Blandy committed
666 667 668
    }
}

669
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
670 671 672 673 674
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
675 676 677 678
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

679
  /* If we are preparing to dump, and DEF is a menu element
680 681
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
682 683
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
684

685
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
686 687
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
688 689 690
  /* 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.  */
691
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
692

693 694
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
695
  if (SYMBOLP (idx))
696
    idx = reorder_modifiers (idx);
697 698 699
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
700
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
701 702

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
703
  {
704
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
705

706 707 708 709 710 711
    /* 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.  */
712
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
713

714
    insertion_point = keymap;
715
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
716
      {
717
	Lisp_Object elt;
718

719
	elt = XCAR (tail);
720
	if (VECTORP (elt))
721
	  {
722
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
723
	      {
724
		ASET (elt, XFASTINT (idx), def);
725 726 727
		return def;
	      }
	    insertion_point = tail;
728
	  }
729 730
	else if (CHAR_TABLE_P (elt))
	  {
731 732 733 734 735 736 737
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
	    if (NATNUMP (idx)
		&& ! (XFASTINT (idx)
		      & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER
			 | CHAR_SHIFT | CHAR_CTL | CHAR_META)))
738 739 740 741 742 743
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
744 745
	else if (CONSP (elt))
	  {
746
	    if (EQ (idx, XCAR (elt)))
747
	      {
748
		XCDR (elt) = def;
749 750
		return def;
	      }
751
	  }
752 753 754 755 756 757
	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;
758 759

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
760 761
      }

762 763 764
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
765 766
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
767
  }
768
  
Jim Blandy's avatar
Jim Blandy committed
769 770 771
  return def;
}

772
void
773 774 775
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
776
  if (CONSP (elt) && EQ (XCAR (elt), Qkeymap))
777
    Faset (chartable, idx, Fcopy_keymap (elt));
778
}
779

Jim Blandy's avatar
Jim Blandy committed
780 781 782 783
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
  "Return a copy of the keymap KEYMAP.\n\
The copy starts out with the same definitions of KEYMAP,\n\
but changing either the copy or KEYMAP does not affect the other.\n\
Jim Blandy's avatar
Jim Blandy committed
784 785 786
Any key definitions that are subkeymaps are recursively copied.\n\
However, a key definition which is a symbol whose definition is a keymap\n\
is not copied.")
Jim Blandy's avatar
Jim Blandy committed
787 788 789 790 791
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

792
  copy = Fcopy_alist (get_keymap (keymap, 1, 0));
Jim Blandy's avatar
Jim Blandy committed
793

794
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
795
    {
796
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
797

798
      elt = XCAR (tail);
799 800
      if (CHAR_TABLE_P (elt))
	{
801
	  Lisp_Object indices[3];
802 803

	  elt = Fcopy_sequence (elt);
804
	  XCAR (tail) = elt;
805

806 807 808
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
809
	{
810
	  int i;
Jim Blandy's avatar
Jim Blandy committed
811

812
	  elt = Fcopy_sequence (elt);
813
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
814

815
	  for (i = 0; i < ASIZE (elt); i++)
816
	    if (CONSP (AREF (elt, i)) && EQ (XCAR (AREF (elt, i)), Qkeymap))
817
	      ASET (elt, i, Fcopy_keymap (AREF (elt, i)));
Jim Blandy's avatar
Jim Blandy committed
818
	}
819
      else if (CONSP (elt) && CONSP (XCDR (elt)))
820
	{
821
	  Lisp_Object tem;
822
	  tem = XCDR (elt);
823

824
	  /* Is this a new format menu item.  */
825
	  if (EQ (XCAR (tem),Qmenu_item))
826 827
	    {
	      /* Copy cell with menu-item marker.  */
828 829 830 831
	      XCDR (elt)
		= Fcons (XCAR (tem), XCDR (tem));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
832 833 834
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
835 836 837 838
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
839 840 841 842 843
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
844 845 846 847
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCAR (elt);
848
		  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
849 850 851
		    XCAR (elt) = Fcopy_keymap (tem);
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
852
		    /* Delete cache for key equivalences.  */
853
		    XCDR (elt) = XCDR (tem);
854 855 856 857 858 859 860
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
861
	      if (STRINGP (XCAR (tem)))
862
		{
863
		  /* Copy the cell, since copy-alist didn't go this deep.  */
864 865 866 867
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
868
		  /* Also skip the optional menu help string.  */
869
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
870
		    {
871 872 873 874
		      XCDR (elt)
			= Fcons (XCAR (tem), XCDR (tem));
		      elt = XCDR (elt);
		      tem = XCDR (elt);
875 876 877 878
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
879 880 881 882
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
		    XCDR (elt) = XCDR (tem);
883
		}
884
	      if (CONSP (elt)
885 886
		  && CONSP (XCDR (elt))
		  && EQ (XCAR (XCDR (elt)), Qkeymap))
887
		XCDR (elt) = Fcopy_keymap (XCDR (elt));
888
	    }
889

890
	}
Jim Blandy's avatar
Jim Blandy committed
891
    }
892
	      
Jim Blandy's avatar
Jim Blandy committed
893 894 895
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
896 897
/* Simple Keymap mutators and accessors.				*/

898 899
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
900 901 902 903
DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
  "Args KEYMAP, KEY, DEF.  Define key sequence KEY, in KEYMAP, as DEF.\n\
KEYMAP is a keymap.  KEY is a string or a vector of symbols and characters\n\
meaning a sequence of keystrokes and events.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
904 905
Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
can be included if you use a vector.\n\
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909 910 911 912 913 914 915
DEF is anything that can be a key's definition:\n\
 nil (means key is undefined in this keymap),\n\
 a command (a Lisp function suitable for interactive calling)\n\
 a string (treated as a keyboard macro),\n\
 a keymap (to define a prefix key),\n\
 a symbol.  When the key is looked up, the symbol will stand for its\n\
    function definition, which should at that time be one of the above,\n\
    or another symbol whose function definition is used, etc.\n\
 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
    (DEFN should be a valid definition in its own right),\n\
Jim Blandy's avatar
Jim Blandy committed
916 917 918 919
 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
\n\
If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
the front of KEYMAP.")
Jim Blandy's avatar
Jim Blandy committed
920
  (keymap, key, def)
921
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926 927 928
     Lisp_Object key;
     Lisp_Object def;
{
  register int idx;
  register Lisp_Object c;
  register Lisp_Object cmd;
  int metized = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
929
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
930
  int length;
931
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
932

933
  keymap = get_keymap (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
934

935
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
936 937
    key = wrong_type_argument (Qarrayp, key);

938
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
939 940 941
  if (length == 0)
    return Qnil;

942 943 944
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

945 946
  GCPRO3 (keymap, key, def);

947
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
948 949 950 951
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
952 953 954 955 956
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

957
      if (CONSP (c) && lucid_event_type_list_p (c))
958
	c = Fevent_convert_list (c);
959

960
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
961
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
962 963 964 965 966 967 968
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
969
	  if (INTEGERP (c))
970
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
971 972 973 974 975

	  metized = 0;
	  idx++;
	}

976
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
977
	error ("Key sequence contains invalid events");
978

Jim Blandy's avatar
Jim Blandy committed
979
      if (idx == length)
980
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
981

982
      cmd = access_keymap (keymap, c, 0, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
983

984
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
985
      if (NILP (cmd))
986
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
987

988 989
      keymap = get_keymap (cmd, 0, 1);
      if (!CONSP (keymap))
990 991 992 993
	/* We must use Fkey_description rather than just passing key to
	   error; key might be a vector, not a string.  */
	error ("Key sequence %s uses invalid prefix characters",
	       XSTRING (Fkey_description (key))->data);
Jim Blandy's avatar
Jim Blandy committed
994 995 996 997
    }
}

/* Value is number if KEY is too long; NIL if valid but has no definition. */
998
/* GC is possible in this function if it autoloads a keymap.  */
Jim Blandy's avatar
Jim Blandy committed
999