keymap.c 53.6 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"
Jim Blandy's avatar
Jim Blandy committed
28 29 30

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

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

Jim Blandy's avatar
Jim Blandy committed
69 70 71 72 73
/* 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
74 75 76 77 78 79 80 81 82 83 84
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 ();
85
static void describe_map_2 ();
Jim Blandy's avatar
Jim Blandy committed
86

Jim Blandy's avatar
Jim Blandy committed
87 88
/* Keymap object support - constructors and predicates.			*/

89
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
90 91 92 93
  "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\
94 95 96 97 98
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
99
{
100 101 102 103 104
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
105 106
  return Fcons (Qkeymap,
		Fcons (Fmake_vector (make_number (DENSE_TABLE_SIZE), Qnil),
107
		       tail));
Jim Blandy's avatar
Jim Blandy committed
108 109
}

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

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

   For example:

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

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

142 143 144 145 146 147 148 149 150
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
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
/* 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
170 171 172 173 174
\n\
A keymap is list (keymap . ALIST), a list (keymap VECTOR . ALIST),\n\
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
175 176 177
  (object)
     Lisp_Object object;
{
178
  return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
179 180 181
}

/* Check that OBJECT is a keymap (after dereferencing through any
182 183 184 185 186 187 188 189 190 191 192 193 194 195
   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
196
Lisp_Object
197
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
198
     Lisp_Object object;
199
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
200
{
201
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
202

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

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
  /* Should we do an autoload?  */
  if (autoload
      && XTYPE (object) == Lisp_Symbol
      && CONSP (tem)
      && EQ (XCONS (tem)->car, Qautoload))
    {
      struct gcpro gcpro1, gcpro2;

      GCPRO2 (tem, object)
      do_autoload (tem, object);
      UNGCPRO;

      goto autoload_retry;
    }

Jim Blandy's avatar
Jim Blandy committed
223 224
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
225 226
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
227 228
}

229 230 231

/* 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
232 233 234 235
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
236
  return get_keymap_1 (object, 0, 0);
Jim Blandy's avatar
Jim Blandy committed
237 238 239 240
}


/* Look up IDX in MAP.  IDX may be any sort of event.
241
   Note that this does only one level of lookup; IDX must be a single
242 243 244 245 246 247 248
   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
249 250

Lisp_Object
251
access_keymap (map, idx, t_ok)
Jim Blandy's avatar
Jim Blandy committed
252 253
     Lisp_Object map;
     Lisp_Object idx;
254
     int t_ok;
Jim Blandy's avatar
Jim Blandy committed
255 256 257 258
{
  /* 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.  */
259
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
260 261 262

  if (XTYPE (idx) == Lisp_Int
      && (XINT (idx) < 0 || XINT (idx) >= DENSE_TABLE_SIZE))
263
    error ("only ASCII characters may be looked up in keymaps");
Jim Blandy's avatar
Jim Blandy committed
264

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

270 271
  {
    Lisp_Object tail;
272
    Lisp_Object t_binding = Qnil;
Jim Blandy's avatar
Jim Blandy committed
273

274
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
275
      {
276 277 278 279 280 281 282
	Lisp_Object binding = XCONS (tail)->car;

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

	  case Lisp_Vector:
	    if (XVECTOR (binding)->size == DENSE_TABLE_SIZE
		&& XTYPE (idx) == Lisp_Int)
	      return XVECTOR (binding)->contents[XINT (idx)];
	    break;
	  }
293 294

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
295
      }
296

297 298
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
299 300 301 302 303 304 305 306 307
}

/* 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,
308
   remove that.  Also remove a menu help string as second element.  */
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314 315 316 317

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

318
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
319
      map = get_keymap_1 (Fcar_safe (object), 0, 0);
Jim Blandy's avatar
Jim Blandy committed
320
      tem = Fkeymapp (map);
Jim Blandy's avatar
Jim Blandy committed
321
      if (!NILP (tem))
322
	object = access_keymap (map, Fcdr (object), 0);
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327 328 329
      
      /* 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)
330 331 332 333 334 335 336 337
	{
	  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
338 339 340 341 342 343 344 345 346 347 348 349 350

      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;
{
351 352 353 354
  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
355 356 357
  /* 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.  */
358
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
359 360 361

  if (XTYPE (idx) == Lisp_Int
      && (XINT (idx) < 0 || XINT (idx) >= DENSE_TABLE_SIZE))
362 363 364 365 366 367 368 369 370
    error ("only ASCII characters may be used as keymap indices");

  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
  else if (XTYPE (idx) == Lisp_Symbol)
    idx = reorder_modifiers (idx);


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

374 375 376 377 378 379 380
    /* 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
381

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

	switch (XTYPE (elt))
	  {
	  case Lisp_Vector:
389 390
	    if (XVECTOR (elt)->size != DENSE_TABLE_SIZE)
	      break;
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
	    if (XTYPE (idx) == Lisp_Int)
	      {
		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;
	  }
416 417

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
418 419
      }

420 421 422 423 424 425 426
  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
427 428 429
  return def;
}

430

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

  copy = Fcopy_alist (get_keymap (keymap));

445
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
446
    {
447
      Lisp_Object elt = XCONS (tail)->car;
Jim Blandy's avatar
Jim Blandy committed
448

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

454 455
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
456 457

	  for (i = 0; i < DENSE_TABLE_SIZE; i++)
458 459 460 461
	    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
462
	}
463 464 465
      else if (CONSP (elt)
	       && XTYPE (XCONS (elt)->cdr) != Lisp_Symbol
	       && ! NILP (Fkeymapp (XCONS (elt)->cdr)))
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469 470 471
	XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr);
    }

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

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

  keymap = get_keymap (keymap);

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

511
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
512 513 514
  if (length == 0)
    return Qnil;

515 516
  GCPRO3 (keymap, key, def);

Jim Blandy's avatar
Jim Blandy committed
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

      if (XTYPE (c) == Lisp_Int
	  && XINT (c) >= 0200
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
	  if (XTYPE (c) == Lisp_Int)
	    XSETINT (c, XINT (c) & 0177);

	  metized = 0;
	  idx++;
	}

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

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

Jim Blandy's avatar
Jim Blandy committed
543
      if (NILP (cmd))
Jim Blandy's avatar
Jim Blandy committed
544
	{
545
	  cmd = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
546 547 548
	  store_in_keymap (keymap, c, cmd);
	}

549 550
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
	error ("Key sequence %s uses invalid prefix characters",
	       XSTRING (key)->data);
    }
}

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

DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 2, 0,
  "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\
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\
it takes to reach a non-prefix command.")
  (keymap, key)
     register Lisp_Object keymap;
     Lisp_Object key;
{
  register int idx;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  register Lisp_Object c;
  int metized = 0;
  int length;

  keymap = get_keymap (keymap);

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

583
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
  if (length == 0)
    return keymap;

  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

      if (XTYPE (c) == Lisp_Int
	  && XINT (c) >= 0200
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
	  if (XTYPE (c) == Lisp_Int)
	    XSETINT (c, XINT (c) & 0177);

	  metized = 0;
	  idx++;
	}

608
      cmd = get_keyelt (access_keymap (keymap, c, 0));
Jim Blandy's avatar
Jim Blandy committed
609 610 611
      if (idx == length)
	return cmd;

612 613
      keymap = get_keymap_1 (cmd, 0, 0);
      if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
	return make_number (idx);

      QUIT;
    }
}

/* Append a key to the end of a key sequence.  If key_sequence is a
   string and key is a character, the result will be another string;
   otherwise, it will be a vector.  */
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

  if (XTYPE (key_sequence) == Lisp_String
      && XTYPE (key) == Lisp_Int)
    {
      args[1] = Fchar_to_string (key);
      return Fconcat (2, args);
    }
  else
    {
      args[1] = Fcons (key, Qnil);
      return Fvconcat (2, args);
    }
}

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

Jim Blandy's avatar
Jim Blandy committed
647
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
648 649
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
650 651 652
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

Jim Blandy's avatar
Jim Blandy committed
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
/* 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
674
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
675 676 677 678 679 680

  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
681 682
	&& ! EQ ((val = find_symbol_value (var)), Qunbound)
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
683
      {
Jim Blandy's avatar
Jim Blandy committed
684
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
685 686 687
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
688
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
689
	      {
Jim Blandy's avatar
Jim Blandy committed
690 691
		newmodes = (Lisp_Object *) realloc (cmm_modes, cmm_size *= 2);
		newmaps  = (Lisp_Object *) realloc (cmm_maps,  cmm_size);
Jim Blandy's avatar
Jim Blandy committed
692 693 694
	      }
	    else
	      {
Jim Blandy's avatar
Jim Blandy committed
695 696
		newmodes = (Lisp_Object *) malloc (cmm_size = 30);
		newmaps  = (Lisp_Object *) malloc (cmm_size);
Jim Blandy's avatar
Jim Blandy committed
697 698 699 700
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
701 702
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
703 704 705 706
	      }
	    else
	      break;
	  }
Jim Blandy's avatar
Jim Blandy committed
707 708
	cmm_modes[i] = var;
	cmm_maps [i] = XCONS (assoc)->cdr;
Jim Blandy's avatar
Jim Blandy committed
709 710 711
	i++;
      }

Jim Blandy's avatar
Jim Blandy committed
712 713
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
714 715 716
  return i;
}

Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722 723
DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 1, 0,
  "Return the binding for command KEY in current keymaps.\n\
KEY is a string, a sequence of keystrokes.\n\
The binding is probably a symbol with a function definition.")
  (key)
     Lisp_Object key;
{
Jim Blandy's avatar
Jim Blandy committed
724 725 726 727 728
  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
729
    if (! NILP (maps[i]))
Jim Blandy's avatar
Jim Blandy committed
730 731
      {
	value = Flookup_key (maps[i], key);
Jim Blandy's avatar
Jim Blandy committed
732
	if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
733 734 735
	  return value;
      }

Jim Blandy's avatar
Jim Blandy committed
736
  if (! NILP (current_buffer->keymap))
Jim Blandy's avatar
Jim Blandy committed
737
    {
Jim Blandy's avatar
Jim Blandy committed
738
      value = Flookup_key (current_buffer->keymap, key);
Jim Blandy's avatar
Jim Blandy committed
739
      if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
740 741
	return value;
    }
Jim Blandy's avatar
Jim Blandy committed
742 743

  value = Flookup_key (current_global_map, key);
Jim Blandy's avatar
Jim Blandy committed
744
  if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
745 746 747
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
748 749 750 751 752 753 754 755 756 757 758
}

DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 1, 0,
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
The binding is probably a symbol with a function definition.")
  (keys)
     Lisp_Object keys;
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
759
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
760 761 762 763 764 765 766
    return Qnil;
  return Flookup_key (map, keys);
}

DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 1, 0,
  "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
767 768 769
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\
(which see).")
Jim Blandy's avatar
Jim Blandy committed
770 771 772 773 774 775
  (keys)
     Lisp_Object keys;
{
  return Flookup_key (current_global_map, keys);
}

Jim Blandy's avatar
Jim Blandy committed
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 1, 0,
  "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\
that come after prefix bindings.")
  (key)
{
  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
795 796
    if (! NILP (maps[i])
	&& ! NILP (binding = Flookup_key (maps[i], key))
Jim Blandy's avatar
Jim Blandy committed
797 798
	&& XTYPE (binding) != Lisp_Int)
      {
799
	if (! NILP (get_keymap (binding)))
Jim Blandy's avatar
Jim Blandy committed
800 801 802 803 804 805 806 807
	  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
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
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
838
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
839
    {
840
      map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
841 842 843 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
      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
869
  if (!NILP (current_buffer->keymap))
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873 874 875 876
    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
877 878 879
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
880 881 882 883
  (name, mapvar)
     Lisp_Object name, mapvar;
{
  Lisp_Object map;
884
  map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
885
  Ffset (name, map);
Jim Blandy's avatar
Jim Blandy committed
886
  if (!NILP (mapvar))
Jim Blandy's avatar
Jim Blandy committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
    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
909
  if (!NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
    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
930 931 932 933 934 935 936 937 938 939

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
940

Jim Blandy's avatar
Jim Blandy committed
941 942
/* Help functions for describing and documenting keymaps.		*/

Jim Blandy's avatar
Jim Blandy committed
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
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;

  maps = Fcons (Fcons (build_string (""), get_keymap (startmap)), Qnil);

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

963
  for (tail = maps; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
964 965 966 967 968 969 970 971 972
    {
      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));

973
      for (; CONSP (thismap); thismap = XCONS (thismap)->cdr)
Jim Blandy's avatar
Jim Blandy committed
974
	{
975
	  Lisp_Object elt = XCONS (thismap)->car;
Jim Blandy's avatar
Jim Blandy committed
976

977 978 979
	  QUIT;

	  if (XTYPE (elt) == Lisp_Vector)
Jim Blandy's avatar
Jim Blandy committed
980 981 982 983 984 985 986 987 988
	    {
	      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;

989
		  cmd = get_keyelt (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
990
		  if (NILP (cmd)) continue;
Jim Blandy's avatar
Jim Blandy committed
991
		  tem = Fkeymapp (cmd);
Jim Blandy's avatar
Jim Blandy committed
992
		  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
993 994 995 996
		    {
		      cmd = get_keymap (cmd);
		      /* Ignore keymaps that are already added to maps.  */
		      tem = Frassq (cmd, maps);
Jim Blandy's avatar
Jim Blandy committed
997
		      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
998 999 1000 1001
			{
			  /* 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
1002 1003
			     ascii keystroke since we're processing a
			     keymap table.  */
Jim Blandy's avatar
Jim Blandy committed
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
			  if (is_metized)
			    {
			      tem = Fcopy_sequence (thisseq);
			      Faset (tem, last, make_number (i | 0200));
			      
			      /* 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
			    {
			      tem = append_key (thisseq, make_number (i));
			      nconc2 (tail, Fcons (Fcons (tem, cmd), Qnil));
			    }
			}
		    }
		}
1023 1024
	    }	    
	  else if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027 1028 1029 1030
	    {
	      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
1031
	      if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1032 1033 1034 1035
		{
		  /* Ignore keymaps that have been seen already.  */
		  cmd = get_keymap (cmd);
		  tem = Frassq (cmd, maps);
Jim Blandy's avatar
Jim Blandy committed
1036
		  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
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 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
		    {
		      /* 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);
			  Faset (tem, last, make_number (XINT (elt) | 0200));

			  /* 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;
{
  return Fmapconcat (Qsingle_key_description, keys, build_string (" "));
}

char *
push_key_description (c, p)
     register unsigned int c;
     register char *p;
{
  if (c >= 0200)
    {
      *p++ = 'M';
      *p++ = '-';
      c -= 0200;
    }
  if (c < 040)
    {
      if (c == 033)
	{
	  *p++ = 'E';
	  *p++ = 'S';
	  *p++ = 'C';
	}
      else if (c == Ctl('I'))
	{
	  *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';
    }
  else
    *p++ = c;

  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;
{
  register unsigned char c;
  char tem[6];

1154
  key = EVENT_HEAD (key);
Jim Blandy's avatar
Jim Blandy committed
1155

Jim Blandy's avatar
Jim Blandy committed
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
  switch (XTYPE (key))
    {
    case Lisp_Int:		/* Normal character */
      c = XINT (key) & 0377;
      *push_key_description (c, tem) = 0;
      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++ = '^';
      *p++ = '?';
    }
  else
    *p++ = c;
  return p;  
}

DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0,
  "Return a pretty description of file-character CHAR.\n\
Control characters turn into \"^char\", etc.")
  (chr)
     Lisp_Object chr;
{
  char tem[6];

  CHECK_NUMBER (chr, 0);

  *push_text_char_description (XINT (chr) & 0377, tem) = 0;

  return build_string (tem);
}

Jim Blandy's avatar
Jim Blandy committed
1212 1213
/* where-is - finding a command in a set of keymaps.			*/

Jim Blandy's avatar
Jim Blandy committed
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0,
  "Return list of keys that invoke DEFINITION in KEYMAP or KEYMAP1.\n\
If KEYMAP is nil, search only KEYMAP1.\n\
If KEYMAP1 is nil, use the current global map.\n\
\n\
If optional 4th arg FIRSTONLY is non-nil,\n\
return a string representing the first key sequence found,\n\
rather than a list of all possible key sequences.\n\
\n\
If optional 5th arg NOINDIRECT is non-nil, don't follow indirections\n\
to other keymaps or slots.  This makes it possible to search for an\n\
indirect definition itself.")
  (definition, local_keymap, global_keymap, firstonly, noindirect)
     Lisp_Object definition, local_keymap, global_keymap;
     Lisp_Object firstonly, noindirect;
{
  register Lisp_Object maps;
  Lisp_Object found;

Jim Blandy's avatar
Jim Blandy committed
1233
  if (NILP (global_keymap))
Jim Blandy's avatar
Jim Blandy committed
1234 1235
    global_keymap = current_global_map;

Jim Blandy's avatar
Jim Blandy committed
1236
  if (!NILP (local_keymap))
Jim Blandy's avatar
Jim Blandy committed
1237 1238 1239 1240 1241 1242 1243
    maps = nconc2 (Faccessible_keymaps (get_keymap (local_keymap)),
		   Faccessible_keymaps (get_keymap (global_keymap)));
  else
    maps = Faccessible_keymaps (get_keymap (global_keymap));

  found = Qnil;

Jim Blandy's avatar
Jim Blandy committed
1244
  for (; !NILP (maps); maps = Fcdr (maps))
Jim Blandy's avatar
Jim Blandy committed
1245
    {
1246 1247 1248 1249 1250 1251 1252 1253
      /* Key sequence to reach map */
      register Lisp_Object this = Fcar (Fcar (maps));

      /* The map that it reaches */
      register Lisp_Object map  = Fcdr (Fcar (maps));

      /* If Fcar (map) is a VECTOR, the current element within that vector.  */
      int i = 0;
Jim Blandy's avatar
Jim Blandy committed
1254 1255 1256 1257 1258 1259 1260 1261

      /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
	 [M-CHAR] sequences, check if last character of the sequence
	 is the meta-prefix char.  */
      Lisp_Object last = make_number (XINT (Flength (this)) - 1);
      int last_is_meta = (XINT (last) >= 0
			  && EQ (Faref (this, last), meta_prefix_char));

1262 1263
      QUIT;

1264
      while (CONSP (map))
Jim Blandy's avatar
Jim Blandy committed
1265
	{
1266 1267 1268 1269 1270 1271 1272 1273
	  /* Because the code we want to run on each binding is rather
	     large, we don't want to have two separate loop bodies for
	     sparse keymap bindings and tables; we want to iterate one
	     loop body over both keymap and vector bindings.

	     For this reason, if Fcar (map) is a vector, we don't
	     advance map to the next element until i indicates that we
	     have finished off the vector.  */
Jim Blandy's avatar
Jim Blandy committed
1274
	  
1275 1276 1277
	  Lisp_Object elt = XCONS (map)->car;
	  Lisp_Object key, binding, sequence;

1278 1279
	  QUIT;

1280 1281 1282
	  /* Set key and binding to the current key and binding, and
	     advance map and i to the next binding.  */
	  if (XTYPE (elt) == Lisp_Vector)
Jim Blandy's avatar
Jim Blandy committed
1283 1284
	    {
	      /* In a vector, look at each element.  */
1285
	      binding = XVECTOR (elt)->contents[i];
Jim Blandy's avatar
Jim Blandy committed
1286 1287 1288
	      XFASTINT (key) = i;
	      i++;

1289 1290 1291
	      /* If we've just finished scanning a vector, advance map
		 to the next element, and reset i in anticipation of the
		 next vector we may find.  */
Jim Blandy's avatar
Jim Blandy committed
1292 1293
	      if (i >= DENSE_TABLE_SIZE)
		{
1294 1295
		  map = XCONS (map)->cdr;
		  i = 0;
Jim Blandy's avatar
Jim Blandy committed
1296
		}
1297 1298 1299
	    }
	  else if (CONSP (elt))
	    {
Jim Blandy's avatar
Jim Blandy committed
1300
	      key = Fcar (Fcar (map));
1301 1302 1303
	      binding = Fcdr (Fcar (map));

	      map = XCONS (map)->cdr;
Jim Blandy's avatar
Jim Blandy committed
1304 1305
	    }
	  else
1306 1307
	    /* We want to ignore keymap elements that are neither
	       vectors nor conses.  */
1308 1309 1310 1311
	    {
	      map = XCONS (map)->cdr;
	      continue;
	    }
Jim Blandy's avatar
Jim Blandy committed
1312 1313

	  /* Search through indirections unless that's not wanted.  */
Jim Blandy's avatar
Jim Blandy committed
1314
	  if (NILP (noindirect))
Jim Blandy's avatar
Jim Blandy committed
1315 1316 1317 1318 1319 1320 1321 1322 1323
	    binding = get_keyelt (binding);

	  /* End this iteration if this element does not match
	     the target.  */

	  if (XTYPE (definition) == Lisp_Cons)
	    {
	      Lisp_Object tem;
	      tem = Fequal (binding, definition);
Jim Blandy's avatar
Jim Blandy committed
1324
	      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
		continue;
	    }
	  else
	    if (!EQ (binding, definition))
	      continue;

	  /* We have found a match.
	     Construct the key sequence where we found it.  */
	  if (XTYPE (key) == Lisp_Int && last_is_meta)
	    {
	      sequence = Fcopy_sequence (this);
	      Faset (sequence, last, make_number (XINT (key) | 0200));
	    }
	  else
	    sequence = append_key (this, key);

	  /* Verify that this key binding is not shadowed by another
	     binding for the same key, before we say it exists.

	     Mechanism: look for local definition of this key and if
	     it is defined and does not match what we found then
	     ignore this key.

	     Either nil or number as value from Flookup_key
	     means undefined.  */
Jim Blandy's avatar
Jim Blandy committed
1350
	  if (!NILP (local_keymap))
Jim Blandy's avatar
Jim Blandy committed
1351 1352
	    {
	      binding = Flookup_key (local_keymap, sequence);
Jim Blandy's avatar
Jim Blandy committed
1353
	      if (!NILP (binding) && XTYPE (binding) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
1354 1355 1356 1357 1358
		{
		  if (XTYPE (definition) == Lisp_Cons)
		    {
		      Lisp_Object tem;
		      tem = Fequal (binding, definition);
Jim Blandy's avatar
Jim Blandy committed
1359
		      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
			continue;
		    }
		  else
		    if (!EQ (binding, definition))
		      continue;
		}
	    }

	  /* It is a true unshadowed match.  Record it.  */

Jim Blandy's avatar
Jim Blandy committed
1370
	  if (!NILP (firstonly))
Jim Blandy's avatar
Jim Blandy committed
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
	    return sequence;
	  found = Fcons (sequence, found);
	}
    }
  return Fnreverse (found);
}

/* Return a string listing the keys and buttons that run DEFINITION.  */

static Lisp_Object
where_is_string (definition)
     Lisp_Object definition;
{
  register Lisp_Object keys, keys1;

  keys = Fwhere_is_internal (definition,
			     current_buffer->keymap, Qnil, Qnil, Qnil);
  keys1 = Fmapconcat (Qkey_description, keys, build_string (", "));

  return keys1;
}

DEFUN ("where-is", Fwhere_is, Swhere_is, 1, 1, "CWhere is command: ",
  "Print message listing key sequences that invoke specified command.\n\
Argument is a command definition, usually a symbol with a function definition.")
  (definition)
     Lisp_Object definition;
{
  register Lisp_Object string;

  CHECK_SYMBOL (definition, 0);
  string = where_is_string (definition);
 
  if (XSTRING (string)->size)
    message ("%s is on %s", XSYMBOL (definition)->name->data,
	     XSTRING (string)->data);
  else
    message ("%s is not on any key", XSYMBOL (definition)->name->data);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
1412 1413
/* describe-bindings - summarizing all the bindings in a set of keymaps.  */

Jim Blandy's avatar
Jim Blandy committed
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
DEFUN ("describe-bindings", Fdescribe_bindings, Sdescribe_bindings, 0, 0, "",
  "Show a list of all defined keys, and their definitions.\n\
The list is put in a buffer, which is displayed.")
  ()
{
  register Lisp_Object thisbuf;
  XSET (thisbuf, Lisp_Buffer, current_buffer);
  internal_with_output_to_temp_buffer ("*Help*",
				       describe_buffer_bindings,
				       thisbuf);
  return Qnil;
}

static Lisp_Object
describe_buffer_bindings (descbuf)
     Lisp_Object descbuf;
{
  register Lisp_Object start1, start2;

1433 1434 1435 1436 1437 1438 1439 1440 1441
  char *key_heading
    = "\
key             binding\n\
---             -------\n";
  char *alternate_heading
    = "\
Alternate Characters (use anywhere the nominal character is listed):\n\
nominal         alternate\n\
-------         ---------\n";
Jim Blandy's avatar
Jim Blandy committed
1442 1443 1444

  Fset_buffer (Vstandard_output);

1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475