keymap.c 56.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Jim Blandy's avatar
Jim Blandy committed
2
   Copyright (C) 1985, 1986, 1987, 1988, 1992 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


#include "config.h"
#include <stdio.h>
#undef NULL
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
28
#include "termhooks.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31

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

32
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
33 34 35 36 37 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
#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
67 68 69
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

Jim Blandy's avatar
Jim Blandy committed
70 71 72 73 74
/* 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;

Jim Blandy's avatar
Jim Blandy committed
75 76 77 78 79 80 81 82 83 84 85
Lisp_Object Qkeymapp, Qkeymap;

/* A char over 0200 in a key sequence
   is equivalent to prefixing with this character.  */

extern Lisp_Object meta_prefix_char;

void describe_map_tree ();
static Lisp_Object describe_buffer_bindings ();
static void describe_command ();
static void describe_map ();
86
static void describe_map_2 ();
Jim Blandy's avatar
Jim Blandy committed
87

Jim Blandy's avatar
Jim Blandy committed
88 89
/* Keymap object support - constructors and predicates.			*/

90
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
91 92 93 94
  "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\
VECTOR is a 128-element vector which holds the bindings for the ASCII\n\
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\
95 96 97 98 99
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
100
{
101 102 103 104 105
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
106 107
  return Fcons (Qkeymap,
		Fcons (Fmake_vector (make_number (DENSE_TABLE_SIZE), Qnil),
108
		       tail));
Jim Blandy's avatar
Jim Blandy committed
109 110
}

111
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
112 113 114 115
  "Construct and return a new sparse-keymap list.\n\
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\
116 117 118 119 120
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
121
{
122 123
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
124 125 126 127 128 129 130 131
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

132
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
133 134 135 136 137 138 139 140 141 142

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

143 144 145 146 147 148 149 150 151
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
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
/* Define character fromchar in map frommap as an alias for character
   tochar in map tomap.  Subsequent redefinitions of the latter WILL
   affect the former. */

#if 0
void
synkey (frommap, fromchar, tomap, tochar)
     struct Lisp_Vector *frommap, *tomap;
     int fromchar, tochar;
{
  Lisp_Object v, c;
  XSET (v, Lisp_Vector, tomap);
  XFASTINT (c) = tochar;
  frommap->contents[fromchar] = Fcons (v, c);
}
#endif /* 0 */

DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
  "Return t if ARG is a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
171
\n\
Jim Blandy's avatar
Jim Blandy committed
172
A keymap is a list (keymap . ALIST), a list (keymap VECTOR . ALIST),\n\
Jim Blandy's avatar
Jim Blandy committed
173 174 175
or a symbol whose function definition is a keymap is itself a keymap.\n\
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
VECTOR is a 128-element vector of bindings for ASCII characters.")
Jim Blandy's avatar
Jim Blandy committed
176 177 178
  (object)
     Lisp_Object object;
{
179
  return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
180 181 182
}

/* Check that OBJECT is a keymap (after dereferencing through any
183 184 185 186 187 188 189 190 191 192 193 194 195 196
   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.

   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
   Fdefine_key should cause keymaps to be autoloaded.  */

Jim Blandy's avatar
Jim Blandy committed
197
Lisp_Object
198
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
199
     Lisp_Object object;
200
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
201
{
202
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
203

204
 autoload_retry:
Jim Blandy's avatar
Jim Blandy committed
205
  tem = indirect_function (object);
Jim Blandy's avatar
Jim Blandy committed
206 207
  if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap))
    return tem;
208

209 210
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
211 212 213 214 215
  if (autoload
      && XTYPE (object) == Lisp_Symbol
      && CONSP (tem)
      && EQ (XCONS (tem)->car, Qautoload))
    {
216
      Lisp_Object tail;
217

218 219 220 221
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
222

223 224 225 226 227 228
	  GCPRO2 (tem, object)
	    do_autoload (tem, object);
	  UNGCPRO;

	  goto autoload_retry;
	}
229 230
    }

Jim Blandy's avatar
Jim Blandy committed
231 232
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
233 234
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
235 236
}

237 238 239

/* Follow any symbol chaining, and return the keymap denoted by OBJECT.
   If OBJECT doesn't denote a keymap at all, signal an error.  */
Jim Blandy's avatar
Jim Blandy committed
240 241 242 243
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
244
  return get_keymap_1 (object, 0, 0);
Jim Blandy's avatar
Jim Blandy committed
245 246 247 248
}


/* Look up IDX in MAP.  IDX may be any sort of event.
249
   Note that this does only one level of lookup; IDX must be a single
250 251 252 253 254 255 256
   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.  

   If T_OK is zero, bindings for Qt are not treated specially.  */
Jim Blandy's avatar
Jim Blandy committed
257 258

Lisp_Object
259
access_keymap (map, idx, t_ok)
Jim Blandy's avatar
Jim Blandy committed
260 261
     Lisp_Object map;
     Lisp_Object idx;
262
     int t_ok;
Jim Blandy's avatar
Jim Blandy committed
263 264 265 266
{
  /* 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.  */
267
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
268

269 270
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
271
  if (XTYPE (idx) == Lisp_Symbol)
272
    idx = reorder_modifiers (idx);
Jim Blandy's avatar
Jim Blandy committed
273

274 275
  {
    Lisp_Object tail;
276
    Lisp_Object t_binding = Qnil;
Jim Blandy's avatar
Jim Blandy committed
277

278
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
279
      {
280 281 282 283 284 285 286
	Lisp_Object binding = XCONS (tail)->car;

	switch (XTYPE (binding))
	  {
	  case Lisp_Cons:
	    if (EQ (XCONS (binding)->car, idx))
	      return XCONS (binding)->cdr;
287 288
	    if (t_ok && EQ (XCONS (binding)->car, Qt))
	      t_binding = XCONS (binding)->cdr;
289 290 291 292
	    break;

	  case Lisp_Vector:
	    if (XVECTOR (binding)->size == DENSE_TABLE_SIZE
293 294 295
		&& XTYPE (idx) == Lisp_Int
		&& XINT (idx) >= 0
		&& XINT (idx) < DENSE_TABLE_SIZE)
296 297 298
	      return XVECTOR (binding)->contents[XINT (idx)];
	    break;
	  }
299 300

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
301
      }
302

303 304
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
305 306 307 308 309 310 311 312 313
}

/* 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,
314
   remove that.  Also remove a menu help string as second element.  */
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318 319 320 321 322 323

Lisp_Object
get_keyelt (object)
     register Lisp_Object object;
{
  while (1)
    {
      register Lisp_Object map, tem;

324
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
325
      map = get_keymap_1 (Fcar_safe (object), 0, 0);
Jim Blandy's avatar
Jim Blandy committed
326
      tem = Fkeymapp (map);
Jim Blandy's avatar
Jim Blandy committed
327
      if (!NILP (tem))
328
	object = access_keymap (map, Fcdr (object), 0);
Jim Blandy's avatar
Jim Blandy committed
329 330 331 332 333 334 335
      
      /* If the keymap contents looks like (STRING . DEFN),
	 use DEFN.
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
      else if (XTYPE (object) == Lisp_Cons
	       && XTYPE (XCONS (object)->car) == Lisp_String)
336 337 338 339 340 341 342 343
	{
	  object = XCONS (object)->cdr;
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
	  if (XTYPE (object) == Lisp_Cons
	      && XTYPE (XCONS (object)->car) == Lisp_String)
	    object = XCONS (object)->cdr;
	}
Jim Blandy's avatar
Jim Blandy committed
344 345 346 347 348 349 350 351 352 353 354 355 356

      else
	/* Anything else is really the value.  */
	return object;
    }
}

Lisp_Object
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
357 358 359 360
  if (XTYPE (keymap) != Lisp_Cons
      || ! EQ (XCONS (keymap)->car, Qkeymap))
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
361 362 363
  /* 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.  */
364
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
365

366 367
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
368
  if (XTYPE (idx) == Lisp_Symbol)
369 370 371 372
    idx = reorder_modifiers (idx);


  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
373
  {
374
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
375

376 377 378 379 380 381 382
    /* 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.  */
    Lisp_Object insertion_point = keymap;
Jim Blandy's avatar
Jim Blandy committed
383

384
    for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
385
      {
386 387 388 389 390
	Lisp_Object elt = XCONS (tail)->car;

	switch (XTYPE (elt))
	  {
	  case Lisp_Vector:
391 392
	    if (XVECTOR (elt)->size != DENSE_TABLE_SIZE)
	      break;
393 394
	    if (XTYPE (idx) == Lisp_Int
		&& XINT (idx) >= 0 && XINT (idx) < DENSE_TABLE_SIZE)
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
	    break;

	  case Lisp_Cons:
	    if (EQ (idx, XCONS (elt)->car))
	      {
		XCONS (elt)->cdr = def;
		return def;
	      }
	    break;

	  case Lisp_Symbol:
	    /* 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.  */
	    if (EQ (elt, Qkeymap))
	      goto keymap_end;
	    break;
	  }
419 420

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
421 422
      }

423 424 425 426 427 428 429
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
    XCONS (insertion_point)->cdr =
      Fcons (Fcons (idx, def), XCONS (insertion_point)->cdr);
  }
	  
Jim Blandy's avatar
Jim Blandy committed
430 431 432
  return def;
}

433

Jim Blandy's avatar
Jim Blandy committed
434 435 436 437
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
438 439 440
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
441 442 443 444 445 446 447
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

448
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
449
    {
450
      Lisp_Object elt = XCONS (tail)->car;
Jim Blandy's avatar
Jim Blandy committed
451

452 453
      if (XTYPE (elt) == Lisp_Vector
	  && XVECTOR (elt)->size == DENSE_TABLE_SIZE)
Jim Blandy's avatar
Jim Blandy committed
454
	{
455
	  int i;
Jim Blandy's avatar
Jim Blandy committed
456

457 458
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
459 460

	  for (i = 0; i < DENSE_TABLE_SIZE; i++)
461 462 463 464
	    if (XTYPE (XVECTOR (elt)->contents[i]) != Lisp_Symbol
		&& Fkeymapp (XVECTOR (elt)->contents[i]))
	      XVECTOR (elt)->contents[i] =
		Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
465
	}
466 467 468
      else if (CONSP (elt)
	       && XTYPE (XCONS (elt)->cdr) != Lisp_Symbol
	       && ! NILP (Fkeymapp (XCONS (elt)->cdr)))
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472 473 474
	XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr);
    }

  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
475 476
/* Simple Keymap mutators and accessors.				*/

Jim Blandy's avatar
Jim Blandy committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490
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\
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
491 492 493 494
 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
495
  (keymap, key, def)
496
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
497 498 499 500 501 502 503 504
     Lisp_Object key;
     Lisp_Object def;
{
  register int idx;
  register Lisp_Object c;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  int metized = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
505
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
506
  int length;
507
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513 514

  keymap = get_keymap (keymap);

  if (XTYPE (key) != Lisp_Vector
      && XTYPE (key) != Lisp_String)
    key = wrong_type_argument (Qarrayp, key);

515
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
516 517 518
  if (length == 0)
    return Qnil;

519 520
  GCPRO3 (keymap, key, def);

Richard M. Stallman's avatar
Richard M. Stallman committed
521 522 523 524 525
  if (XTYPE (key) == Lisp_Vector)
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530 531
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

      if (XTYPE (c) == Lisp_Int
Richard M. Stallman's avatar
Richard M. Stallman committed
532
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
533 534 535 536 537 538 539 540
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
	  if (XTYPE (c) == Lisp_Int)
541
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
542 543 544 545 546 547

	  metized = 0;
	  idx++;
	}

      if (idx == length)
548
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
549

550
      cmd = get_keyelt (access_keymap (keymap, c, 0));
Jim Blandy's avatar
Jim Blandy committed
551

Jim Blandy's avatar
Jim Blandy committed
552
      if (NILP (cmd))
Jim Blandy's avatar
Jim Blandy committed
553
	{
554
	  cmd = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
555 556 557
	  store_in_keymap (keymap, c, cmd);
	}

558 559
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564 565 566 567
	{
	  /* We must use Fkey_description rather than just passing key to
	     error; key might be a vector, not a string.  */
	  Lisp_Object description = Fkey_description (key);

	  error ("Key sequence %s uses invalid prefix characters",
		 XSTRING (description)->data);
	}
Jim Blandy's avatar
Jim Blandy committed
568 569 570 571 572
    }
}

/* Value is number if KEY is too long; NIL if valid but has no definition. */

573
DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
574 575
  "In keymap KEYMAP, look up key sequence KEY.  Return the definition.\n\
nil means undefined.  See doc of `define-key' for kinds of definitions.\n\
576
\n\
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580
A number as value means KEY is \"too long\";\n\
that is, characters or symbols in it except for the last one\n\
fail to be a valid sequence of prefix characters in KEYMAP.\n\
The number is how many characters at the front of KEY\n\
581 582 583 584 585 586 587 588
it takes to reach a non-prefix command.\n\
\n\
Normally, `lookup-key' ignores bindings for t, which act as default\n\
bindings, used when nothing else in the keymap applies; this makes it\n\
useable as a general function for probing keymaps.  However, if the\n\
third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
recognize the default bindings, just as `read-key-sequence' does.")
  (keymap, key, accept_default)
Jim Blandy's avatar
Jim Blandy committed
589 590
     register Lisp_Object keymap;
     Lisp_Object key;
591
     Lisp_Object accept_default;
Jim Blandy's avatar
Jim Blandy committed
592 593 594 595 596 597 598
{
  register int idx;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  register Lisp_Object c;
  int metized = 0;
  int length;
599
  int t_ok = ! NILP (accept_default);
Richard M. Stallman's avatar
Richard M. Stallman committed
600
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
601 602 603 604 605 606 607

  keymap = get_keymap (keymap);

  if (XTYPE (key) != Lisp_Vector
      && XTYPE (key) != Lisp_String)
    key = wrong_type_argument (Qarrayp, key);

608
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
609 610 611
  if (length == 0)
    return keymap;

Richard M. Stallman's avatar
Richard M. Stallman committed
612 613 614 615 616
  if (XTYPE (key) == Lisp_Vector)
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
617 618 619 620 621 622
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

      if (XTYPE (c) == Lisp_Int
Richard M. Stallman's avatar
Richard M. Stallman committed
623
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
624 625 626 627 628 629 630 631
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
	  if (XTYPE (c) == Lisp_Int)
Richard M. Stallman's avatar
Richard M. Stallman committed
632
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
633 634 635 636 637

	  metized = 0;
	  idx++;
	}

638
      cmd = get_keyelt (access_keymap (keymap, c, t_ok));
Jim Blandy's avatar
Jim Blandy committed
639 640 641
      if (idx == length)
	return cmd;

642 643
      keymap = get_keymap_1 (cmd, 0, 0);
      if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
644 645 646 647 648 649
	return make_number (idx);

      QUIT;
    }
}

650 651
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
652 653 654 655 656 657 658 659
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

660 661
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);
Jim Blandy's avatar
Jim Blandy committed
662 663 664
}


Jim Blandy's avatar
Jim Blandy committed
665 666
/* Global, local, and minor mode keymap stuff.				*/

Jim Blandy's avatar
Jim Blandy committed
667
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
668 669
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
670 671 672
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

Jim Blandy's avatar
Jim Blandy committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
/* Store a pointer to an array of the keymaps of the currently active
   minor modes in *buf, and return the number of maps it contains.

   This function always returns a pointer to the same buffer, and may
   free or reallocate it, so if you want to keep it for a long time or
   hand it out to lisp code, copy it.  This procedure will be called
   for every key sequence read, so the nice lispy approach (return a
   new assoclist, list, what have you) for each invocation would
   result in a lot of consing over time.

   If we used xrealloc/xmalloc and ran out of memory, they would throw
   back to the command loop, which would try to read a key sequence,
   which would call this function again, resulting in an infinite
   loop.  Instead, we'll use realloc/malloc and silently truncate the
   list, let the key sequence be read, and hope some other piece of
   code signals the error.  */
int
current_minor_maps (modeptr, mapptr)
     Lisp_Object **modeptr, **mapptr;
{
  int i = 0;
Jim Blandy's avatar
Jim Blandy committed
694
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698 699 700

  for (alist = Vminor_mode_map_alist;
       CONSP (alist);
       alist = XCONS (alist)->cdr)
    if (CONSP (assoc = XCONS (alist)->car)
	&& XTYPE (var = XCONS (assoc)->car) == Lisp_Symbol
Jim Blandy's avatar
Jim Blandy committed
701 702
	&& ! EQ ((val = find_symbol_value (var)), Qunbound)
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
703
      {
Jim Blandy's avatar
Jim Blandy committed
704
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
705 706 707
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
708
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
709
	      {
Jim Blandy's avatar
Jim Blandy committed
710 711
		newmodes = (Lisp_Object *) realloc (cmm_modes, cmm_size *= 2);
		newmaps  = (Lisp_Object *) realloc (cmm_maps,  cmm_size);
Jim Blandy's avatar
Jim Blandy committed
712 713 714
	      }
	    else
	      {
Jim Blandy's avatar
Jim Blandy committed
715 716
		newmodes = (Lisp_Object *) malloc (cmm_size = 30);
		newmaps  = (Lisp_Object *) malloc (cmm_size);
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
721 722
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
723 724 725 726
	      }
	    else
	      break;
	  }
Jim Blandy's avatar
Jim Blandy committed
727 728
	cmm_modes[i] = var;
	cmm_maps [i] = XCONS (assoc)->cdr;
Jim Blandy's avatar
Jim Blandy committed
729 730 731
	i++;
      }

Jim Blandy's avatar
Jim Blandy committed
732 733
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
734 735 736
  return i;
}

737
DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
738
  "Return the binding for command KEY in current keymaps.\n\
739 740 741 742 743 744 745 746 747
KEY is a string or vector, a sequence of keystrokes.\n\
The binding is probably a symbol with a function definition.\n\
\n\
Normally, `key-binding' ignores bindings for t, which act as default\n\
bindings, used when nothing else in the keymap applies; this makes it\n\
useable as a general function for probing keymaps.  However, if the\n\
third optional argument ACCEPT-DEFAULT is non-nil, `key-binding' will\n\
recognize the default bindings, just as `read-key-sequence' does.")
  (key, accept_default)
Jim Blandy's avatar
Jim Blandy committed
748 749
     Lisp_Object key;
{
Jim Blandy's avatar
Jim Blandy committed
750 751 752 753 754
  Lisp_Object *maps, value;
  int nmaps, i;

  nmaps = current_minor_maps (0, &maps);
  for (i = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
755
    if (! NILP (maps[i]))
Jim Blandy's avatar
Jim Blandy committed
756
      {
757
	value = Flookup_key (maps[i], key, accept_default);
Jim Blandy's avatar
Jim Blandy committed
758
	if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
759 760 761
	  return value;
      }

Jim Blandy's avatar
Jim Blandy committed
762
  if (! NILP (current_buffer->keymap))
Jim Blandy's avatar
Jim Blandy committed
763
    {
764
      value = Flookup_key (current_buffer->keymap, key, accept_default);
Jim Blandy's avatar
Jim Blandy committed
765
      if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
766 767
	return value;
    }
Jim Blandy's avatar
Jim Blandy committed
768

769
  value = Flookup_key (current_global_map, key, accept_default);
Jim Blandy's avatar
Jim Blandy committed
770
  if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
771 772 773
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
774 775
}

776
DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
777 778
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
779 780 781 782 783 784
The binding is probably a symbol with a function definition.\n\
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (keys, accept_default)
     Lisp_Object keys, accept_default;
Jim Blandy's avatar
Jim Blandy committed
785 786 787
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
788
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
789
    return Qnil;
790
  return Flookup_key (map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
791 792
}

793
DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
794 795
  "Return the binding for command KEYS in current global keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
Jim Blandy's avatar
Jim Blandy committed
796 797
The binding is probably a symbol with a function definition.\n\
This function's return values are the same as those of lookup-key\n\
798 799 800 801 802 803
(which see).\n\
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (keys, accept_default)
     Lisp_Object keys, accept_default;
Jim Blandy's avatar
Jim Blandy committed
804
{
805
  return Flookup_key (current_global_map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
806 807
}

808
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
809 810 811 812 813 814 815
  "Find the visible minor mode bindings of KEY.\n\
Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
the symbol which names the minor mode binding KEY, and BINDING is\n\
KEY's definition in that mode.  In particular, if KEY has no\n\
minor-mode bindings, return nil.  If the first binding is a\n\
non-prefix, all subsequent bindings will be omitted, since they would\n\
be ignored.  Similarly, the list doesn't include non-prefix bindings\n\
816 817 818 819 820 821
that come after prefix bindings.\n\
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (key, accept_default)
     Lisp_Object key, accept_default;
Jim Blandy's avatar
Jim Blandy committed
822 823 824 825 826 827 828 829 830
{
  Lisp_Object *modes, *maps;
  int nmaps;
  Lisp_Object binding;
  int i, j;

  nmaps = current_minor_maps (&modes, &maps);

  for (i = j = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
831
    if (! NILP (maps[i])
832
	&& ! NILP (binding = Flookup_key (maps[i], key, accept_default))
Jim Blandy's avatar
Jim Blandy committed
833 834
	&& XTYPE (binding) != Lisp_Int)
      {
835
	if (! NILP (get_keymap (binding)))
Jim Blandy's avatar
Jim Blandy committed
836 837 838 839 840 841 842 843
	  maps[j++] = Fcons (modes[i], binding);
	else if (j == 0)
	  return Fcons (Fcons (modes[i], binding), Qnil);
      }

  return Flist (j, maps);
}

Jim Blandy's avatar
Jim Blandy committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
DEFUN ("global-set-key", Fglobal_set_key, Sglobal_set_key, 2, 2,
  "kSet key globally: \nCSet key %s to command: ",
  "Give KEY a global binding as COMMAND.\n\
COMMAND is a symbol naming an interactively-callable function.\n\
KEY is a string representing a sequence of keystrokes.\n\
Note that if KEY has a local binding in the current buffer\n\
that local binding will continue to shadow any global binding.")
  (keys, function)
     Lisp_Object keys, function;
{
  if (XTYPE (keys) != Lisp_Vector
      && XTYPE (keys) != Lisp_String)
    keys = wrong_type_argument (Qarrayp, keys);

  Fdefine_key (current_global_map, keys, function);
  return Qnil;
}

DEFUN ("local-set-key", Flocal_set_key, Slocal_set_key, 2, 2,
  "kSet key locally: \nCSet key %s locally to command: ",
  "Give KEY a local binding as COMMAND.\n\
COMMAND is a symbol naming an interactively-callable function.\n\
KEY is a string representing a sequence of keystrokes.\n\
The binding goes in the current buffer's local map,\n\
which is shared with other buffers in the same major mode.")
  (keys, function)
     Lisp_Object keys, function;
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
874
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
875
    {
876
      map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
      current_buffer->keymap = map;
    }

  if (XTYPE (keys) != Lisp_Vector
      && XTYPE (keys) != Lisp_String)
    keys = wrong_type_argument (Qarrayp, keys);

  Fdefine_key (map, keys, function);
  return Qnil;
}

DEFUN ("global-unset-key", Fglobal_unset_key, Sglobal_unset_key,
  1, 1, "kUnset key globally: ",
  "Remove global binding of KEY.\n\
KEY is a string representing a sequence of keystrokes.")
  (keys)
     Lisp_Object keys;
{
  return Fglobal_set_key (keys, Qnil);
}

DEFUN ("local-unset-key", Flocal_unset_key, Slocal_unset_key, 1, 1,
  "kUnset key locally: ",
  "Remove local binding of KEY.\n\
KEY is a string representing a sequence of keystrokes.")
  (keys)
     Lisp_Object keys;
{
Jim Blandy's avatar
Jim Blandy committed
905
  if (!NILP (current_buffer->keymap))
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909 910 911 912
    Flocal_set_key (keys, Qnil);
  return Qnil;
}

DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 2, 0,
  "Define COMMAND as a prefix command.\n\
A new sparse keymap is stored as COMMAND's function definition and its value.\n\
Jim Blandy's avatar
Jim Blandy committed
913 914 915
If a second optional argument MAPVAR is given, the map is stored as\n\
its value instead of as COMMAND's value; but COMMAND is still defined\n\
as a function.")
Jim Blandy's avatar
Jim Blandy committed
916 917 918 919
  (name, mapvar)
     Lisp_Object name, mapvar;
{
  Lisp_Object map;
920
  map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
921
  Ffset (name, map);
Jim Blandy's avatar
Jim Blandy committed
922
  if (!NILP (mapvar))
Jim Blandy's avatar
Jim Blandy committed
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
    Fset (mapvar, map);
  else
    Fset (name, map);
  return name;
}

DEFUN ("use-global-map", Fuse_global_map, Suse_global_map, 1, 1, 0,
  "Select KEYMAP as the global keymap.")
  (keymap)
     Lisp_Object keymap;
{
  keymap = get_keymap (keymap);
  current_global_map = keymap;
  return Qnil;
}

DEFUN ("use-local-map", Fuse_local_map, Suse_local_map, 1, 1, 0,
  "Select KEYMAP as the local keymap.\n\
If KEYMAP is nil, that means no local keymap.")
  (keymap)
     Lisp_Object keymap;
{
Jim Blandy's avatar
Jim Blandy committed
945
  if (!NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
    keymap = get_keymap (keymap);

  current_buffer->keymap = keymap;

  return Qnil;
}

DEFUN ("current-local-map", Fcurrent_local_map, Scurrent_local_map, 0, 0, 0,
  "Return current buffer's local keymap, or nil if it has none.")
  ()
{
  return current_buffer->keymap;
}

DEFUN ("current-global-map", Fcurrent_global_map, Scurrent_global_map, 0, 0, 0,
  "Return the current global keymap.")
  ()
{
  return current_global_map;
}
Jim Blandy's avatar
Jim Blandy committed
966 967 968 969 970 971 972 973 974 975

DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps, Scurrent_minor_mode_maps, 0, 0, 0,
  "Return a list of keymaps for the minor modes of the current buffer.")
  ()
{
  Lisp_Object *maps;
  int nmaps = current_minor_maps (0, &maps);

  return Flist (nmaps, maps);
}
Jim Blandy's avatar
Jim Blandy committed
976

Jim Blandy's avatar
Jim Blandy committed
977 978
/* Help functions for describing and documenting keymaps.		*/

Jim Blandy's avatar
Jim Blandy committed
979 980 981 982 983 984 985 986 987 988 989
DEFUN ("accessible-keymaps", Faccessible_keymaps, Saccessible_keymaps,
  1, 1, 0,
  "Find all keymaps accessible via prefix characters from KEYMAP.\n\
Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
KEYS starting from KEYMAP gets you to MAP.  These elements are ordered\n\
so that the KEYS increase in length.  The first element is (\"\" . KEYMAP).")
  (startmap)
     Lisp_Object startmap;
{
  Lisp_Object maps, tail;

990 991 992
  maps = Fcons (Fcons (Fmake_vector (make_number (0), Qnil),
		       get_keymap (startmap)),
		Qnil);
Jim Blandy's avatar
Jim Blandy committed
993 994 995 996 997 998 999 1000

  /* For each map in the list maps,
     look at any other maps it points to,
     and stick them at the end if they are not already in the list.

     This is a breadth-first traversal, where tail is the queue of
     nodes, and maps accumulates a list of all nodes visited.  */

1001
  for (tail = maps; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1002 1003 1004 1005 1006 1007 1008 1009 1010
    {
      register Lisp_Object thisseq = Fcar (Fcar (tail));
      register Lisp_Object thismap = Fcdr (Fcar (tail));
      Lisp_Object last = make_number (XINT (Flength (thisseq)) - 1);

      /* Does the current sequence end in the meta-prefix-char?  */
      int is_metized = (XINT (last) >= 0
			&& EQ (Faref (thisseq, last), meta_prefix_char));

1011
      for (; CONSP (thismap); thismap = XCONS (thismap)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1012
	{
1013
	  Lisp_Object elt = XCONS (thismap)->car;
Jim Blandy's avatar
Jim Blandy committed
1014

1015 1016 1017
	  QUIT;

	  if (XTYPE (elt) == Lisp_Vector)
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020 1021 1022 1023 1024 1025 1026
	    {
	      register int i;

	      /* Vector keymap.  Scan all the elements.  */
	      for (i = 0; i < DENSE_TABLE_SIZE; i++)
		{
		  register Lisp_Object tem;
		  register Lisp_Object cmd;

1027
		  cmd = get_keyelt (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
1028
		  if (NILP (cmd)) continue;
Jim Blandy's avatar
Jim Blandy committed
1029
		  tem = Fkeymapp (cmd);
Jim Blandy's avatar
Jim Blandy committed
1030
		  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1031 1032 1033 1034
		    {
		      cmd = get_keymap (cmd);
		      /* Ignore keymaps that are already added to maps.  */
		      tem = Frassq (cmd, maps);
Jim Blandy's avatar
Jim Blandy committed
1035
		      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1036 1037 1038 1039
			{
			  /* If the last key in thisseq is meta-prefix-char,
			     turn it into a meta-ized keystroke.  We know
			     that the event we're about to append is an
1040 1041
			     ascii keystroke since we're processing a
			     keymap table.  */
Jim Blandy's avatar
Jim Blandy committed
1042 1043
			  if (is_metized)
			    {
1044
			      int meta_bit = meta_modifier;
Jim Blandy's avatar
Jim Blandy committed
1045
			      tem = Fcopy_sequence (thisseq);
1046 1047
			      
			      Faset (tem, last, make_number (i | meta_bit));
Jim Blandy's avatar
Jim Blandy committed
1048 1049 1050 1051
			      
			      /* This new sequence is the same length as
				 thisseq, so stick it in the list right
				 after this one.  */
1052 1053
			      XCONS (tail)->cdr
				= Fcons (Fcons (tem, cmd), XCONS (tail)->cdr);
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056 1057 1058 1059 1060 1061 1062
			    }
			  else
			    {
			      tem = append_key (thisseq, make_number (i));
			      nconc2 (tail, Fcons (Fcons (tem, cmd), Qnil));
			    }
			}
		    }
		}
1063 1064
	    }	    
	  else if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
1065 1066 1067 1068 1069 1070
	    {
	      register Lisp_Object cmd = get_keyelt (XCONS (elt)->cdr);
	      register Lisp_Object tem;

	      /* Ignore definitions that aren't keymaps themselves.  */
	      tem = Fkeymapp (cmd);
Jim Blandy's avatar
Jim Blandy committed
1071
	      if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1072 1073 1074 1075
		{
		  /* Ignore keymaps that have been seen already.  */
		  cmd = get_keymap (cmd);
		  tem = Frassq (cmd, maps);
Jim Blandy's avatar
Jim Blandy committed
1076
		  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
		    {
		      /* let elt be the event defined by this map entry.  */
		      elt = XCONS (elt)->car;

		      /* If the last key in thisseq is meta-prefix-char, and
			 this entry is a binding for an ascii keystroke,
			 turn it into a meta-ized keystroke.  */
		      if (is_metized && XTYPE (elt) == Lisp_Int)
			{
			  tem = Fcopy_sequence (thisseq);
1087 1088
			  Faset (tem, last,
				 make_number (XINT (elt) | meta_modifier));
Jim Blandy's avatar
Jim Blandy committed
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117

			  /* This new sequence is the same length as
			     thisseq, so stick it in the list right
			     after this one.  */
			  XCONS (tail)->cdr =
			    Fcons (Fcons (tem, cmd), XCONS (tail)->cdr);
			}
		      else
			nconc2 (tail,
				Fcons (Fcons (append_key (thisseq, elt), cmd),
				       Qnil));
		    }
		}
	    }
	}
    }

  return maps;
}

Lisp_Object Qsingle_key_description, Qkey_description;

DEFUN ("key-description", Fkey_description, Skey_description, 1, 1, 0,
  "Return a pretty description of key-sequence KEYS.\n\
Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
spaces are put between sequence elements, etc.")
  (keys)
     Lisp_Object keys;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
  if (XTYPE (keys) == Lisp_String)
    {
      Lisp_Object vector;
      int i;
      vector = Fmake_vector (Flength (keys), Qnil);
      for (i = 0; i < XSTRING (keys)->size; i++)
	{
	  if (XSTRING (keys)->data[i] & 0x80)
	    XFASTINT (XVECTOR (vector)->contents[i])
	      = meta_modifier | (XSTRING (keys)->data[i] & ~0x80);
	  else
	    XFASTINT (XVECTOR (vector)->contents[i])
	      = XSTRING (keys)->data[i];
	}
      keys = vector;
    }
Jim Blandy's avatar
Jim Blandy committed
1134 1135 1136 1137 1138 1139 1140 1141
  return Fmapconcat (Qsingle_key_description, keys, build_string (" "));
}

char *
push_key_description (c, p)
     register unsigned int c;
     register char *p;
{
1142 1143 1144
  /* Clear all the meaningless bits above the meta bit.  */
  c &= meta_modifier | ~ - meta_modifier;

Richard M. Stallman's avatar
Richard M. Stallman committed
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
  if (c & alt_modifier)
    {
      *p++ = 'A';
      *p++ = '-';
      c -= alt_modifier;
    }
  if (c & ctrl_modifier)
    {
      *p++ = 'C';
      *p++ = '-';
      c -= ctrl_modifier;
    }
  if (c & hyper_modifier)
    {
      *p++ = 'H';
      *p++ = '-';
      c -= hyper_modifier;
    }
  if (c & meta_modifier)
Jim Blandy's avatar
Jim Blandy committed
1164 1165 1166
    {
      *p++ = 'M';
      *p++ = '-';
Richard M. Stallman's avatar
Richard M. Stallman committed
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
      c -= meta_modifier;
    }
  if (c & shift_modifier)
    {
      *p++ = 'S';
      *p++ = '-';
      c -= shift_modifier;
    }
  if (c & super_modifier)
    {
      *p++ = 's';
      *p++ = '-';
      c -= super_modifier;
Jim Blandy's avatar
Jim Blandy committed
1180 1181 1182 1183 1184 1185 1186 1187 1188
    }
  if (c < 040)
    {
      if (c == 033)
	{
	  *p++ = 'E';
	  *p++ = 'S';
	  *p++ = 'C';
	}
Richard M. Stallman's avatar
Richard M. Stallman committed
1189
      else if (c == '\t')
Jim Blandy's avatar
Jim Blandy committed
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
	{
	  *p++ = 'T';
	  *p++ = 'A';
	  *p++ = 'B';
	}
      else if (c == Ctl('J'))
	{
	  *p++ = 'L';
	  *p++ = 'F';
	  *p++ = 'D';
	}
      else if (c == Ctl('M'))
	{
	  *p++ = 'R';
	  *p++ = 'E';
	  *p++ = 'T';
	}
      else
	{
	  *p++ = 'C';
	  *p++ = '-';
	  if (c > 0 && c <= Ctl ('Z'))
	    *p++ = c + 0140;
	  else
	    *p++ = c + 0100;
	}
    }
  else if (c == 0177)
    {
      *p++ = 'D';
      *p++ = 'E';
      *p++ = 'L';
    }
  else if (c == ' ')
    {
      *p++ = 'S';
      *p++ = 'P';
      *p++ = 'C';
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
1229
  else if (c < 256)
Jim Blandy's avatar
Jim Blandy committed
1230
    *p++ = c;
Richard M. Stallman's avatar
Richard M. Stallman committed
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
  else
    {
      *p++ = '\\';
      *p++ = (7 & (c >> 15)) + '0';
      *p++ = (7 & (c >> 12)) + '0';
      *p++ = (7 & (c >> 9)) + '0';
      *p++ = (7 & (c >> 6)) + '0';
      *p++ = (7 & (c >> 3)) + '0';
      *p++ = (7 & (c >> 0)) + '0';
    }
Jim Blandy's avatar
Jim Blandy committed
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250

  return p;  
}

DEFUN ("single-key-description", Fsingle_key_description, Ssingle_key_description, 1, 1, 0,
  "Return a pretty description of command character KEY.\n\
Control characters turn into C-whatever, etc.")
  (key)
     Lisp_Object key;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
1251
  char tem[20];
Jim Blandy's avatar
Jim Blandy committed
1252

1253
  key = EVENT_HEAD (key);
Jim Blandy's avatar
Jim Blandy committed
1254

Jim Blandy's avatar
Jim Blandy committed
1255 1256 1257
  switch (XTYPE (key))
    {
    case Lisp_Int:		/* Normal character */
Richard M. Stallman's avatar
Richard M. Stallman committed
1258
      *push_key_description (XUINT (key), tem) = 0;
Jim Blandy's avatar
Jim Blandy committed
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
      return build_string (tem);

    case Lisp_Symbol:		/* Function key or event-symbol */
      return Fsymbol_name (key);

    default:
      error ("KEY must be an integer, cons, or symbol.");
    }
}

char *
push_text_char_description (c, p)
     register unsigned int c;
     register char *p;
{
  if (c >= 0200)
    {
      *p++ = 'M';
      *p++ = '-';
      c -= 0200;
    }
  if (c < 040)
    {
      *p++ = '^';
      *p++ = c + 64;		/* 'A' - 1 */
    }
  else if (c == 0177)
    {
      *p++ = '^';