keymap.c 51.2 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 31 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 66 67

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

/* Dense keymaps look like (keymap VECTOR . ALIST), where VECTOR is a
   128-element vector used to look up bindings for ASCII characters,
   and ALIST is an assoc list for looking up symbols.  */
#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
68 69 70
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

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

112
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
113 114 115 116
  "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\
117 118 119 120 121
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
122
{
123 124
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");

   I haven't extended these to allow the initializing code to bind
   function keys and mouse events; since they are called by many files,
   I'd have to fix lots of callers, and nobody right now would be using
   the new functionality, so it seems like a waste of time.  But there's
   no technical reason not to.  -JimB */

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

/* 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
169 170 171 172 173
\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
174 175 176
  (object)
     Lisp_Object object;
{
Jim Blandy's avatar
Jim Blandy committed
177
  return (NILP (get_keymap_1 (object, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
178 179 180 181 182 183 184 185 186 187 188 189
}

/* Check that OBJECT is a keymap (after dereferencing through any
   symbols).  If it is, return it; otherwise, return nil, or signal an
   error if ERROR != 0.  */
Lisp_Object
get_keymap_1 (object, error)
     Lisp_Object object;
     int error;
{
  register Lisp_Object tem;

Jim Blandy's avatar
Jim Blandy committed
190
  tem = indirect_function (object);
Jim Blandy's avatar
Jim Blandy committed
191 192 193 194
  if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap))
    return tem;
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
195 196
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200 201 202 203 204 205 206 207 208 209
}

Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
  return get_keymap_1 (object, 1);
}


/* If KEYMAP is a dense keymap, return the vector from its cadr.
   Otherwise, return nil.  */

210
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
keymap_table (keymap)
     Lisp_Object keymap;
{
  Lisp_Object cadr;

  if (CONSP (XCONS (keymap)->cdr)
      && XTYPE (cadr = XCONS (XCONS (keymap)->cdr)->car) == Lisp_Vector
      && XVECTOR (cadr)->size == DENSE_TABLE_SIZE)
    return cadr;
  else
    return Qnil;
}


/* Look up IDX in MAP.  IDX may be any sort of event.
   Note that this does only one level of lookup; IDX must
   be a single event, not a sequence.  */

Lisp_Object
access_keymap (map, idx)
     Lisp_Object map;
     Lisp_Object idx;
{
  /* 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.  */
Jim Blandy's avatar
Jim Blandy committed
237 238
  if (EVENT_HAS_PARAMETERS (idx))
    idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
239 240 241 242 243 244 245 246 247 248

  if (XTYPE (idx) == Lisp_Int
      && (XINT (idx) < 0 || XINT (idx) >= DENSE_TABLE_SIZE))
    error ("Command key is not an ASCII character");

  {
    Lisp_Object table = keymap_table (map);

    /* A dense keymap indexed by a character?  */
    if (XTYPE (idx) == Lisp_Int
Jim Blandy's avatar
Jim Blandy committed
249
	&& ! NILP (table))
Jim Blandy's avatar
Jim Blandy committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
      return XVECTOR (table)->contents[XFASTINT (idx)];

    /* This lookup will not involve a vector reference.  */
    else
      {
	/* If idx is a symbol, it might have modifiers, which need to
	   be put in the canonical order.  */
	if (XTYPE (idx) == Lisp_Symbol)
	  idx = reorder_modifiers (idx);
	
	return Fcdr (Fassq (idx, map));
      }
  }
}

/* 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,
   remove that.  */

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

      map = get_keymap_1 (Fcar_safe (object), 0);
      tem = Fkeymapp (map);

      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
Jim Blandy's avatar
Jim Blandy committed
286
      if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
	object = access_keymap (map, Fcdr (object));
      
      /* 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)
	object = XCONS (object)->cdr;

      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;
{
  /* 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.  */
Jim Blandy's avatar
Jim Blandy committed
312 313
  if (EVENT_HAS_PARAMETERS (idx))
    idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
314 315 316 317 318 319 320 321 322

  if (XTYPE (idx) == Lisp_Int
      && (XINT (idx) < 0 || XINT (idx) >= DENSE_TABLE_SIZE))
    error ("Command key is a character outside of the ASCII set.");
  
  {
    Lisp_Object table = keymap_table (keymap);

    /* A dense keymap indexed by a character?  */
Jim Blandy's avatar
Jim Blandy committed
323
    if (XTYPE (idx) == Lisp_Int	&& !NILP (table))
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327 328 329 330 331
      XVECTOR (table)->contents[XFASTINT (idx)] = def;

    /* Must be a sparse keymap, or a dense keymap indexed by a symbol.  */
    else
      {
	/* Point to the pointer to the start of the assoc-list part
	   of the keymap.  */
	register Lisp_Object *assoc_head
Jim Blandy's avatar
Jim Blandy committed
332
	  = (NILP (table)
Jim Blandy's avatar
Jim Blandy committed
333 334 335 336 337 338 339 340 341 342 343 344
	     ? & XCONS (keymap)->cdr
	     : & XCONS (XCONS (keymap)->cdr)->cdr);
	register Lisp_Object defining_pair;

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

	/* Point to the pair where idx is bound, if any.  */
	defining_pair = Fassq (idx, *assoc_head);

Jim Blandy's avatar
Jim Blandy committed
345
	if (NILP (defining_pair))
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351 352 353 354 355 356 357 358
	  *assoc_head = Fcons (Fcons (idx, def), *assoc_head);
	else
	  Fsetcdr (defining_pair, def);
      }
  }

  return def;
}

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
359 360 361
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
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));
  tail = XCONS (copy)->cdr;

  /* If this is a dense keymap, copy the vector.  */
  if (CONSP (tail))
    {
      register Lisp_Object table = XCONS (tail)->car;

      if (XTYPE (table) == Lisp_Vector
	  && XVECTOR (table)->size == DENSE_TABLE_SIZE)
	{
	  register int i;

	  table = Fcopy_sequence (table);

	  for (i = 0; i < DENSE_TABLE_SIZE; i++)
Jim Blandy's avatar
Jim Blandy committed
383
	    if (XTYPE (XVECTOR (copy)->contents[i]) != Lisp_Symbol)
Jim Blandy's avatar
Jim Blandy committed
384
	      if (! NILP (Fkeymapp (XVECTOR (table)->contents[i])))
Jim Blandy's avatar
Jim Blandy committed
385 386
		XVECTOR (table)->contents[i]
		  = Fcopy_keymap (XVECTOR (table)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
387 388 389 390 391 392 393 394 395 396 397 398
	  XCONS (tail)->car = table;
      
	  tail = XCONS (tail)->cdr;
	}
    }

  /* Copy the alist portion of the keymap.  */
  while (CONSP (tail))
    {
      register Lisp_Object elt;

      elt = XCONS (tail)->car;
Jim Blandy's avatar
Jim Blandy committed
399 400
      if (CONSP (elt)
	  && XTYPE (XCONS (elt)->cdr) != Lisp_Symbol
Jim Blandy's avatar
Jim Blandy committed
401
	  && ! NILP (Fkeymapp (XCONS (elt)->cdr)))
Jim Blandy's avatar
Jim Blandy committed
402 403 404 405 406 407 408 409
	XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr);

      tail = XCONS (tail)->cdr;
    }

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

Jim Blandy's avatar
Jim Blandy committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425
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
426 427 428 429
 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
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
  (keymap, key, def)
     register Lisp_Object keymap;
     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;

  keymap = get_keymap (keymap);

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

  length = Flength (key);
  if (length == 0)
    return Qnil;

  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)
	return store_in_keymap (keymap, c, def);

      cmd = get_keyelt (access_keymap (keymap, c));

Jim Blandy's avatar
Jim Blandy committed
478
      if (NILP (cmd))
Jim Blandy's avatar
Jim Blandy committed
479
	{
480
	  cmd = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
481 482 483 484
	  store_in_keymap (keymap, c, cmd);
	}

      tem = Fkeymapp (cmd);
Jim Blandy's avatar
Jim Blandy committed
485
      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
	error ("Key sequence %s uses invalid prefix characters",
	       XSTRING (key)->data);

      keymap = get_keymap (cmd);
    }
}

/* 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);

  length = Flength (key);
  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++;
	}

      cmd = get_keyelt (access_keymap (keymap, c));
      if (idx == length)
	return cmd;

      tem = Fkeymapp (cmd);
Jim Blandy's avatar
Jim Blandy committed
550
      if (NILP (tem))
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
	return make_number (idx);

      keymap = get_keymap (cmd);
      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
583 584
/* Global, local, and minor mode keymap stuff.				*/

Jim Blandy's avatar
Jim Blandy committed
585
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
586 587
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
588 589 590
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

Jim Blandy's avatar
Jim Blandy committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
/* 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
612
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
613 614 615 616 617 618

  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
619 620
	&& ! EQ ((val = find_symbol_value (var)), Qunbound)
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
621
      {
Jim Blandy's avatar
Jim Blandy committed
622
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
623 624 625
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
626
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
627
	      {
Jim Blandy's avatar
Jim Blandy committed
628 629
		newmodes = (Lisp_Object *) realloc (cmm_modes, cmm_size *= 2);
		newmaps  = (Lisp_Object *) realloc (cmm_maps,  cmm_size);
Jim Blandy's avatar
Jim Blandy committed
630 631 632
	      }
	    else
	      {
Jim Blandy's avatar
Jim Blandy committed
633 634
		newmodes = (Lisp_Object *) malloc (cmm_size = 30);
		newmaps  = (Lisp_Object *) malloc (cmm_size);
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
639 640
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
641 642 643 644
	      }
	    else
	      break;
	  }
Jim Blandy's avatar
Jim Blandy committed
645 646
	cmm_modes[i] = var;
	cmm_maps [i] = XCONS (assoc)->cdr;
Jim Blandy's avatar
Jim Blandy committed
647 648 649
	i++;
      }

Jim Blandy's avatar
Jim Blandy committed
650 651
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
652 653 654
  return i;
}

Jim Blandy's avatar
Jim Blandy committed
655 656 657 658 659 660 661
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
662 663 664 665 666
  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
667
    if (! NILP (maps[i]))
Jim Blandy's avatar
Jim Blandy committed
668 669
      {
	value = Flookup_key (maps[i], key);
Jim Blandy's avatar
Jim Blandy committed
670
	if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
671 672 673
	  return value;
      }

Jim Blandy's avatar
Jim Blandy committed
674
  if (! NILP (current_buffer->keymap))
Jim Blandy's avatar
Jim Blandy committed
675
    {
Jim Blandy's avatar
Jim Blandy committed
676
      value = Flookup_key (current_buffer->keymap, key);
Jim Blandy's avatar
Jim Blandy committed
677
      if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
678 679
	return value;
    }
Jim Blandy's avatar
Jim Blandy committed
680 681

  value = Flookup_key (current_global_map, key);
Jim Blandy's avatar
Jim Blandy committed
682
  if (! NILP (value) && XTYPE (value) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
683 684 685
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
686 687 688 689 690 691 692 693 694 695 696
}

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
697
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702 703 704
    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
705 706 707
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
708 709 710 711 712 713
  (keys)
     Lisp_Object keys;
{
  return Flookup_key (current_global_map, keys);
}

Jim Blandy's avatar
Jim Blandy committed
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
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
733 734
    if (! NILP (maps[i])
	&& ! NILP (binding = Flookup_key (maps[i], key))
Jim Blandy's avatar
Jim Blandy committed
735 736
	&& XTYPE (binding) != Lisp_Int)
      {
Jim Blandy's avatar
Jim Blandy committed
737
	if (! NILP (get_keymap_1 (binding, 0)))
Jim Blandy's avatar
Jim Blandy committed
738 739 740 741 742 743 744 745
	  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
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
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
776
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
777
    {
778
      map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
      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
807
  if (!NILP (current_buffer->keymap))
Jim Blandy's avatar
Jim Blandy committed
808 809 810 811 812 813 814
    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
815 816 817
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
818 819 820 821
  (name, mapvar)
     Lisp_Object name, mapvar;
{
  Lisp_Object map;
822
  map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
823
  Ffset (name, map);
Jim Blandy's avatar
Jim Blandy committed
824
  if (!NILP (mapvar))
Jim Blandy's avatar
Jim Blandy committed
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
    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
847
  if (!NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
    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
868 869 870 871 872 873 874 875 876 877

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

Jim Blandy's avatar
Jim Blandy committed
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
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);
  tail = maps;

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

Jim Blandy's avatar
Jim Blandy committed
902
  while (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
    {
      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));

      /* Skip the 'keymap element of the list.  */
      thismap = Fcdr (thismap);

      if (CONSP (thismap))
	{
	  register Lisp_Object table = XCONS (thismap)->car;

	  if (XTYPE (table) == Lisp_Vector)
	    {
	      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;

		  cmd = get_keyelt (XVECTOR (table)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
930
		  if (NILP (cmd)) continue;
Jim Blandy's avatar
Jim Blandy committed
931
		  tem = Fkeymapp (cmd);
Jim Blandy's avatar
Jim Blandy committed
932
		  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
933 934 935 936
		    {
		      cmd = get_keymap (cmd);
		      /* Ignore keymaps that are already added to maps.  */
		      tem = Frassq (cmd, maps);
Jim Blandy's avatar
Jim Blandy committed
937
		      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
			{
			  /* 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
			     ascii keystroke.  */
			  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));
			    }
			}
		    }
		}

	      /* Once finished with the lookup elements of the dense
		 keymap, go on to scan its assoc list.  */
	      thismap = XCONS (thismap)->cdr;
	    }
	}

      /* The rest is an alist.  Scan all the alist elements.  */
      while (CONSP (thismap))
	{
	  Lisp_Object elt = XCONS (thismap)->car;

	  /* Ignore elements that are not conses.  */
	  if (CONSP (elt))
	    {
	      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
982
	      if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
983 984 985 986
		{
		  /* Ignore keymaps that have been seen already.  */
		  cmd = get_keymap (cmd);
		  tem = Frassq (cmd, maps);
Jim Blandy's avatar
Jim Blandy committed
987
		  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
		    {
		      /* 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));
		    }
		}
	    }
	  
	  thismap = XCONS (thismap)->cdr;
	}

      tail = Fcdr (tail);
    }

  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];

Jim Blandy's avatar
Jim Blandy committed
1109 1110 1111
  if (EVENT_HAS_PARAMETERS (key))
    key = EVENT_HEAD (key);

Jim Blandy's avatar
Jim Blandy committed
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 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
  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
1168 1169
/* where-is - finding a command in a set of keymaps.			*/

Jim Blandy's avatar
Jim Blandy committed
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
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
1189
  if (NILP (global_keymap))
Jim Blandy's avatar
Jim Blandy committed
1190 1191
    global_keymap = current_global_map;

Jim Blandy's avatar
Jim Blandy committed
1192
  if (!NILP (local_keymap))
Jim Blandy's avatar
Jim Blandy committed
1193 1194 1195 1196 1197 1198 1199
    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
1200
  for (; !NILP (maps); maps = Fcdr (maps))
Jim Blandy's avatar
Jim Blandy committed
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 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
    {
      register this = Fcar (Fcar (maps)); /* Key sequence to reach map */
      register map = Fcdr (Fcar (maps)); /* The map that it reaches */
      register dense_alist;
      register int i = 0;

      /* 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));
	 
      /* Skip the 'keymap element of the list.  */
      map = Fcdr (map);

      /* If the keymap is sparse, map traverses the alist to the end.

	 If the keymap is dense, we set map to the vector and
	 dense_alist to the assoc-list portion of the keymap.  When we
	 are finished dealing with the vector portion, we set map to
	 dense_alist, and handle the rest like a sparse keymap.  */
      if (XTYPE (XCONS (map)->car) == Lisp_Vector)
	{
	  dense_alist = XCONS (map)->cdr;
	  map = XCONS (map)->car;
	}

      while (1)
	{
	  register Lisp_Object key, binding, sequence;
	  
	  QUIT;
	  if (XTYPE (map) == Lisp_Vector)
	    {
	      /* In a vector, look at each element.  */
	      binding = XVECTOR (map)->contents[i];
	      XFASTINT (key) = i;
	      i++;

	      /* If we've just finished scanning a vector, switch map to
		 the assoc-list at the end of the vector.  */
	      if (i >= DENSE_TABLE_SIZE)
		map = dense_alist;
	    }
	  else if (CONSP (map))
	    {
	      /* In an alist, ignore elements that aren't conses.  */
	      if (! CONSP (XCONS (map)->car))
		{
		  /* Ignore other elements.  */
		  map = Fcdr (map);
		  continue;
		}
	      binding = Fcdr (Fcar (map));
	      key = Fcar (Fcar (map));
	      map = Fcdr (map);
	    }
	  else
	    break;

	  /* Search through indirections unless that's not wanted.  */
Jim Blandy's avatar
Jim Blandy committed
1263
	  if (NILP (noindirect))
Jim Blandy's avatar
Jim Blandy committed
1264 1265 1266 1267 1268 1269 1270 1271 1272
	    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
1273
	      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
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
		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
1299
	  if (!NILP (local_keymap))
Jim Blandy's avatar
Jim Blandy committed
1300 1301
	    {
	      binding = Flookup_key (local_keymap, sequence);
Jim Blandy's avatar
Jim Blandy committed
1302
	      if (!NILP (binding) && XTYPE (binding) != Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
1303 1304 1305 1306 1307
		{
		  if (XTYPE (definition) == Lisp_Cons)
		    {
		      Lisp_Object tem;
		      tem = Fequal (binding, definition);
Jim Blandy's avatar
Jim Blandy committed
1308
		      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
			continue;
		    }
		  else
		    if (!EQ (binding, definition))
		      continue;
		}
	    }

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

Jim Blandy's avatar
Jim Blandy committed
1319
	  if (!NILP (firstonly))
Jim Blandy's avatar
Jim Blandy committed
1320 1321 1322 1323 1324 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 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
	    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
1361 1362
/* describe-bindings - summarizing all the bindings in a set of keymaps.  */

Jim Blandy's avatar
Jim Blandy committed
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
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;

  char *heading
    = "key                     binding\n---                     -------\n";

  Fset_buffer (Vstandard_output);

Jim Blandy's avatar
Jim Blandy committed
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
  {
    int i, nmaps;
    Lisp_Object *modes, *maps;

    nmaps = current_minor_maps (&modes, &maps);
    for (i = 0; i < nmaps; i++)
      {
	if (XTYPE (modes[i]) == Lisp_Symbol)
	  {
	    insert_char ('`');
	    insert_string (XSYMBOL (modes[i])->name->data);
	    insert_char ('\'');
	  }
	else
	  insert_string ("Strangely Named");
	insert_string (" Minor Mode Bindings:\n");
	insert_string (heading);
	describe_map_tree (maps[i], 0, Qnil);
	insert_char ('\n');
      }
  }

Jim Blandy's avatar
Jim Blandy committed
1409
  start1 = XBUFFER (descbuf)->keymap;
Jim Blandy's avatar
Jim Blandy committed
1410
  if (!NILP (start1))
Jim Blandy's avatar
Jim Blandy committed
1411 1412 1413
    {
      insert_string ("Local Bindings:\n");
      insert_string (heading);
Jim Blandy's avatar
Jim Blandy committed
1414
      describe_map_tree (start1, 0, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1415 1416 1417 1418 1419 1420
      insert_string ("\n");
    }

  insert_string ("Global Bindings:\n");
  insert_string (heading);

Jim Blandy's avatar
Jim Blandy committed
1421
  describe_map_tree (current_global_map, 0, XBUFFER (descbuf)->keymap);
Jim Blandy's avatar
Jim Blandy committed
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445

  Fset_buffer (descbuf);
  return Qnil;
}

/* Insert a desription of the key bindings in STARTMAP,
    followed by those of all maps reachable through STARTMAP.
   If PARTIAL is nonzero, omit certain "uninteresting" commands
    (such as `undefined').
   If SHADOW is non-nil, it is another map;
    don't mention keys which would be shadowed by it.  */

void
describe_map_tree (startmap, partial, shadow)
     Lisp_Object startmap, shadow;
     int partial;
{
  register Lisp_Object elt, sh;
  Lisp_Object maps;
  struct gcpro gcpro1;

  maps = Faccessible_keymaps (startmap);
  GCPRO1 (maps);

Jim Blandy's avatar
Jim Blandy committed
1446
  for (; !NILP (maps); maps = Fcdr (maps))
Jim Blandy's avatar
Jim Blandy committed
1447 1448 1449 1450 1451
    {
      elt = Fcar (maps);
      sh = Fcar (elt);

      /* If there is no shadow keymap given, don't shadow.  */
Jim Blandy's avatar
Jim Blandy committed
1452
      if (NILP (shadow))
Jim Blandy's avatar
Jim Blandy committed
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
	sh = Qnil;

      /* If the sequence by which we reach this keymap is zero-length,
	 then the shadow map for this keymap is just SHADOW.  */
      else if ((XTYPE (sh) == Lisp_String
		&& XSTRING (sh)->size == 0)
	       || (XTYPE (sh) == Lisp_Vector
		   && XVECTOR (sh)->size == 0))
	sh = shadow;

      /* If the sequence by which we reach this keymap actually has
	 some elements, then the sequence's definition in SHADOW is
	 what we should use.  */
      else
	{
	  sh = Flookup_key (shadow, Fcar (elt));
	  if (XTYPE (sh) == Lisp_Int)
	    sh = Qnil;
	}

      /* If sh is null (meaning that the current map is not shadowed),
	 or a keymap (meaning that bindings from the current map might
	 show through), describe the map.  Otherwise, sh is a command
	 that completely shadows the current map, and we shouldn't
	 bother.  */
Jim Blandy's avatar
Jim Blandy committed
1478
      if (NILP (sh) || !NILP (Fkeymapp (sh)))
Jim Blandy's avatar
Jim Blandy committed
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
	describe_map (Fcdr (elt), Fcar (elt), partial, sh);
    }

  UNGCPRO;
}

static void
describe_command (definition)
     Lisp_Object definition;
{
  register Lisp_Object tem1;

  Findent_to (make_number (16), make_number (1));

  if (XTYPE (definition) == Lisp_Symbol)
    {
      XSET (tem1, Lisp_String, XSYMBOL (definition)->name);
      insert1 (tem1);
      insert_string ("\n");
    }
  else
    {
      tem1 = Fkeymapp (definition);
Jim Blandy's avatar
Jim Blandy committed
1502
      if (!NILP (tem1))
Jim Blandy's avatar
Jim Blandy committed
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
	insert_string ("Prefix Command\n");
      else
	insert_string ("??\n");
    }
}

/* Describe the contents of map MAP, assuming that this map itself is
   reached by the sequence of prefix keys KEYS (a string or vector).
   PARTIAL, SHADOW is as in `describe_map_tree' above.  */

static void
describe_map (map, keys, partial, shadow)
     Lisp_Object map, keys;
     int partial;
     Lisp_Object shadow;
{
  register Lisp_Object keysdesc;

Jim Blandy's avatar
Jim Blandy committed
1521
  if (!NILP (keys) && Flength (keys) > 0)
Jim Blandy's avatar
Jim Blandy committed
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
    keysdesc = concat2 (Fkey_description (keys),
			build_string (" "));
  else
    keysdesc = Qnil;

  /* Skip the 'keymap element of the list.  */
  map = Fcdr (map);

  /* If this is a dense keymap, take care of the table.  */
  if (CONSP (map)
      && XTYPE (XCONS (map)->car) == Lisp_Vector)
    {
      describe_vector (XCONS (map)->car, keysdesc, describe_command,
		       partial, shadow);
      map = XCONS (map)->cdr;
    }

  /* Now map is an alist.  */
  describe_alist (map, keysdesc, describe_command, partial, shadow);
}

/* Insert a description of ALIST into the current buffer. 
   Note that ALIST is just a plain association list, not a keymap.  */

static void
describe_alist (alist, elt_prefix, elt_describer, partial, shadow)
     register Lisp_Object alist;
     Lisp_Object elt_prefix;
     int (*elt_describer) ();
     int partial;
     Lisp_Object shadow;
{
  Lisp_Object this;
  Lisp_Object tem1, tem2 = Qnil;
  Lisp_Object suppress;
  Lisp_Object kludge;
  int first = 1;
  struct gcpro gcpro1, gcpro2, gcpro3;

  if (partial)
    suppress = intern ("suppress-keymap");

  /* This vector gets used to present single keys to Flookup_key.  Since
     that is done once per alist element, we don't want to cons up a
     fresh vector every time.  */
  kludge = Fmake_vector (make_number (1), Qnil);

  GCPRO3 (elt_prefix, tem2, kludge);

  for (; CONSP (alist); alist = Fcdr (alist))
    {
      QUIT;
      tem1 = Fcar_safe (Fcar (alist));
      tem2 = get_keyelt (Fcdr_safe (Fcar (alist)));

      /* Don't show undefined commands or suppressed commands.  */
Jim Blandy's avatar
Jim Blandy committed
1578
      if (NILP (tem2)) continue;
Jim Blandy's avatar
Jim Blandy committed
1579 1580 1581
      if (XTYPE (tem2) == Lisp_Symbol && partial)
	{
	  this = Fget (tem2, suppress);
Jim Blandy's avatar
Jim Blandy committed
1582
	  if (!NILP (this))
Jim Blandy's avatar
Jim Blandy committed
1583 1584 1585 1586 1587 1588
	    continue;
	}

      /* Don't show a command that isn't really visible
	 because a local definition of the same key shadows it.  */

Jim Blandy's avatar
Jim Blandy committed
1589
      if (!NILP (shadow))
Jim Blandy's avatar
Jim Blandy committed
1590 1591