keymap.c 68.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2
   Copyright (C) 1985, 86, 87, 88, 93, 94 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
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.  */


21
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
22 23 24 25 26
#include <stdio.h>
#undef NULL
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
28
#include "termhooks.h"
29
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32

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

33
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
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 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;

76
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii;
Jim Blandy's avatar
Jim Blandy committed
77

Jim Blandy's avatar
Jim Blandy committed
78 79 80
/* A char with the CHAR_META bit set in a vector or the 0200 bit set
   in a string key sequence is equivalent to prefixing with this
   character.  */
Jim Blandy's avatar
Jim Blandy committed
81 82
extern Lisp_Object meta_prefix_char;

83 84
extern Lisp_Object Voverriding_local_map;

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

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

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

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

   For example:

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

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

146 147 148 149 150 151 152 153 154
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
155 156 157 158 159 160 161 162 163 164 165
/* 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;
166
  XSETVECTOR (v, tomap);
167
  XSETFASTINT (c, tochar);
Jim Blandy's avatar
Jim Blandy committed
168 169 170 171 172 173
  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
174
\n\
175
A keymap is a list (keymap . ALIST),\n\
Karl Heuer's avatar
Karl Heuer committed
176
or a symbol whose function definition is itself a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
177
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
178 179
a vector of densely packed bindings for small character codes\n\
is also allowed as an element.")
Jim Blandy's avatar
Jim Blandy committed
180 181 182
  (object)
     Lisp_Object object;
{
183
  return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
184 185 186
}

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

   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
202
Lisp_Object
203
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
204
     Lisp_Object object;
205
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
206
{
207
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
208

209
 autoload_retry:
Jim Blandy's avatar
Jim Blandy committed
210
  tem = indirect_function (object);
Jim Blandy's avatar
Jim Blandy committed
211 212
  if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap))
    return tem;
213

214 215
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
216
  if (autoload
217
      && SYMBOLP (object)
218 219 220
      && CONSP (tem)
      && EQ (XCONS (tem)->car, Qautoload))
    {
221
      Lisp_Object tail;
222

223 224 225 226
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
227

228 229
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
230 231 232 233
	  UNGCPRO;

	  goto autoload_retry;
	}
234 235
    }

Jim Blandy's avatar
Jim Blandy committed
236 237
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
238 239
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
240 241
}

242 243 244

/* 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
245 246 247 248
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
249
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
250 251 252 253
}


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

261 262 263
   If T_OK is zero, bindings for Qt are not treated specially.

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

Lisp_Object
266
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
267 268
     Lisp_Object map;
     Lisp_Object idx;
269
     int t_ok;
270
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
271
{
272 273 274
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
275 276 277
  /* 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.  */
278
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
279

280 281
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
282
  if (SYMBOLP (idx))
283
    idx = reorder_modifiers (idx);
284 285 286
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
287
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
288

289 290
  {
    Lisp_Object tail;
291
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
292

293
    t_binding = Qnil;
294
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
295
      {
296
	Lisp_Object binding;
297

298
	binding = XCONS (tail)->car;
299
	if (SYMBOLP (binding))
300
	  {
301 302 303 304
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
	    if (noinherit && EQ (binding, Qkeymap) && ! EQ (tail, map))
	      noprefix = 1;
305 306 307
	  }
	else if (CONSP (binding))
	  {
308
	    if (EQ (XCONS (binding)->car, idx))
309 310 311 312 313 314
	      {
		val = XCONS (binding)->cdr;
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
		return val;
	      }
315 316
	    if (t_ok && EQ (XCONS (binding)->car, Qt))
	      t_binding = XCONS (binding)->cdr;
317 318 319
	  }
	else if (VECTORP (binding))
	  {
320
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
321
	      {
322
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
323 324 325 326
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
		return val;
	      }
327
	  }
328 329

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
330
      }
331

332 333
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
334 335 336 337 338 339 340 341 342
}

/* 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,
343 344 345 346
   remove that.  Also remove a menu help string as second element.

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

Lisp_Object
349
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
350
     register Lisp_Object object;
351
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355 356
{
  while (1)
    {
      register Lisp_Object map, tem;

357
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
358
      map = get_keymap_1 (Fcar_safe (object), 0, autoload);
Jim Blandy's avatar
Jim Blandy committed
359
      tem = Fkeymapp (map);
Jim Blandy's avatar
Jim Blandy committed
360
      if (!NILP (tem))
361
	object = access_keymap (map, Fcdr (object), 0, 0);
Jim Blandy's avatar
Jim Blandy committed
362 363 364 365 366
      
      /* If the keymap contents looks like (STRING . DEFN),
	 use DEFN.
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
367 368
      else if (CONSP (object)
	       && STRINGP (XCONS (object)->car))
369 370 371 372
	{
	  object = XCONS (object)->cdr;
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
373
	  if (CONSP (object) && STRINGP (XCONS (object)->car))
374
	    object = XCONS (object)->cdr;
375 376 377
	  /* Also remove the sublist that caches key equivalences, if any.  */
	  if (CONSP (object)
	      && CONSP (XCONS (object)->car))
378
	    {
379 380 381
	      Lisp_Object carcar;
	      carcar = XCONS (XCONS (object)->car)->car;
	      if (NILP (carcar) || VECTORP (carcar))
382 383
		object = XCONS (object)->cdr;
	    }
384
	}
Jim Blandy's avatar
Jim Blandy committed
385 386 387 388 389 390 391 392 393 394 395 396 397

      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;
{
398
  if (!CONSP (keymap) || ! EQ (XCONS (keymap)->car, Qkeymap))
399 400
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
401 402 403
  /* 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.  */
404
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
405

406 407
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
408
  if (SYMBOLP (idx))
409
    idx = reorder_modifiers (idx);
410 411 412
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
413
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
414 415

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
416
  {
417
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
418

419 420 421 422 423 424
    /* 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.  */
425
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
426

427
    insertion_point = keymap;
428
    for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
429
      {
430
	Lisp_Object elt;
431

432
	elt = XCONS (tail)->car;
433
	if (VECTORP (elt))
434
	  {
435
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
436 437 438 439 440
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
441 442 443
	  }
	else if (CONSP (elt))
	  {
444 445 446 447 448
	    if (EQ (idx, XCONS (elt)->car))
	      {
		XCONS (elt)->cdr = def;
		return def;
	      }
449 450 451
	  }
	else if (SYMBOLP (elt))
	  {
452 453 454 455 456 457 458
	    /* 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;
	  }
459 460

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
461 462
      }

463 464 465 466 467 468 469
  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
470 471 472
  return def;
}

473

Jim Blandy's avatar
Jim Blandy committed
474 475 476 477
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
478 479 480
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
481 482 483 484 485 486 487
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

488
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
489
    {
490
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
491

492
      elt = XCONS (tail)->car;
493
      if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
494
	{
495
	  int i;
Jim Blandy's avatar
Jim Blandy committed
496

497 498
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
499

500
	  for (i = 0; i < XVECTOR (elt)->size; i++)
501
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
502
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
503 504
	      XVECTOR (elt)->contents[i] =
		Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
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
      else if (CONSP (elt))
	{
	  /* Skip the optional menu string.  */
	  if (CONSP (XCONS (elt)->cdr)
	      && STRINGP (XCONS (XCONS (elt)->cdr)->car))
	    {
	      Lisp_Object tem;

	      /* Copy the cell, since copy-alist didn't go this deep.  */
	      XCONS (elt)->cdr = Fcons (XCONS (XCONS (elt)->cdr)->car,
					XCONS (XCONS (elt)->cdr)->cdr);
	      elt = XCONS (elt)->cdr;

	      /* Also skip the optional menu help string.  */
	      if (CONSP (XCONS (elt)->cdr)
		  && STRINGP (XCONS (XCONS (elt)->cdr)->car))
		{
		  XCONS (elt)->cdr = Fcons (XCONS (XCONS (elt)->cdr)->car,
					    XCONS (XCONS (elt)->cdr)->cdr);
		  elt = XCONS (elt)->cdr;
		}
	      /* There may also be a list that caches key equivalences.
		 Just delete it for the new keymap.  */
	      if (CONSP (XCONS (elt)->cdr)
		  && CONSP (XCONS (XCONS (elt)->cdr)->car)
		  && (NILP (tem = XCONS (XCONS (XCONS (elt)->cdr)->car)->car)
		      || VECTORP (tem)))
		XCONS (elt)->cdr = XCONS (XCONS (elt)->cdr)->cdr;
	    }
	  if (CONSP (elt)
	      && ! SYMBOLP (XCONS (elt)->cdr)
	      && ! NILP (Fkeymapp (XCONS (elt)->cdr)))
	    XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr);
	}
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543 544
    }

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

547 548
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
549 550 551 552
DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
  "Args KEYMAP, KEY, DEF.  Define key sequence KEY, in KEYMAP, as DEF.\n\
KEYMAP is a keymap.  KEY is a string or a vector of symbols and characters\n\
meaning a sequence of keystrokes and events.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
553 554
Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
can be included if you use a vector.\n\
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558 559 560 561 562 563 564
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
565 566 567 568
 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
569
  (keymap, key, def)
570
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
571 572 573 574 575 576 577 578
     Lisp_Object key;
     Lisp_Object def;
{
  register int idx;
  register Lisp_Object c;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  int metized = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
579
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
580
  int length;
581
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
582

583
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
584

585
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
586 587
    key = wrong_type_argument (Qarrayp, key);

588
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
589 590 591
  if (length == 0)
    return Qnil;

592 593
  GCPRO3 (keymap, key, def);

594
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
595 596 597 598
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
599 600 601 602 603
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

604
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
605
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
606 607 608 609 610 611 612
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
613
	  if (INTEGERP (c))
614
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
615 616 617 618 619

	  metized = 0;
	  idx++;
	}

620
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
621
	error ("Key sequence contains invalid events");
622

Jim Blandy's avatar
Jim Blandy committed
623
      if (idx == length)
624
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
625

626
      cmd = get_keyelt (access_keymap (keymap, c, 0, 1), 1);
Jim Blandy's avatar
Jim Blandy committed
627

628
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
629
      if (NILP (cmd))
630
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
631

632 633
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
634 635 636 637
	/* We must use Fkey_description rather than just passing key to
	   error; key might be a vector, not a string.  */
	error ("Key sequence %s uses invalid prefix characters",
	       XSTRING (Fkey_description (key))->data);
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641
    }
}

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

644
DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
645 646
  "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\
647
\n\
Jim Blandy's avatar
Jim Blandy committed
648 649 650 651
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\
652 653 654 655 656 657 658 659
it takes to reach a non-prefix command.\n\
\n\
Normally, `lookup-key' ignores bindings for t, which act as default\n\
bindings, used when nothing else in the keymap applies; this makes it\n\
useable as a general function for probing keymaps.  However, if the\n\
third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
recognize the default bindings, just as `read-key-sequence' does.")
  (keymap, key, accept_default)
Jim Blandy's avatar
Jim Blandy committed
660 661
     register Lisp_Object keymap;
     Lisp_Object key;
662
     Lisp_Object accept_default;
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667 668 669
{
  register int idx;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  register Lisp_Object c;
  int metized = 0;
  int length;
670
  int t_ok = ! NILP (accept_default);
Richard M. Stallman's avatar
Richard M. Stallman committed
671
  int meta_bit;
672
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
673

674
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
675

676
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
677 678
    key = wrong_type_argument (Qarrayp, key);

679
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
680 681 682
  if (length == 0)
    return keymap;

683
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
684 685 686 687
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

688 689
  GCPRO1 (key);

Jim Blandy's avatar
Jim Blandy committed
690 691 692 693 694
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

695
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
696
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701 702 703
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
704
	  if (INTEGERP (c))
Richard M. Stallman's avatar
Richard M. Stallman committed
705
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709 710

	  metized = 0;
	  idx++;
	}

711
      cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1);
Jim Blandy's avatar
Jim Blandy committed
712
      if (idx == length)
713
	RETURN_UNGCPRO (cmd);
Jim Blandy's avatar
Jim Blandy committed
714

715
      keymap = get_keymap_1 (cmd, 0, 1);
716
      if (NILP (keymap))
717
	RETURN_UNGCPRO (make_number (idx));
Jim Blandy's avatar
Jim Blandy committed
718 719 720 721 722

      QUIT;
    }
}

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
/* Make KEYMAP define event C as a keymap (i.e., as a prefix).
   Assume that currently it does not define C at all.
   Return the keymap.  */

static Lisp_Object
define_as_prefix (keymap, c)
     Lisp_Object keymap, c;
{
  Lisp_Object inherit, cmd;

  cmd = Fmake_sparse_keymap (Qnil);
  /* If this key is defined as a prefix in an inherited keymap,
     make it a prefix in this map, and make its definition
     inherit the other prefix definition.  */
  inherit = access_keymap (keymap, c, 0, 0);
  if (NILP (inherit))
    {
      /* If there's an inherited keymap
	 and it doesn't define this key,
	 make it define this key.  */
      Lisp_Object tail;

      for (tail = Fcdr (keymap); CONSP (tail); tail = XCONS (tail)->cdr)
	if (EQ (XCONS (tail)->car, Qkeymap))
	  break;

      if (!NILP (tail))
	inherit = define_as_prefix (tail, c);
    }

  cmd = nconc2 (cmd, inherit);
  store_in_keymap (keymap, c, cmd);

  return cmd;
}

759 760
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
761 762 763 764 765 766 767 768
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

769 770
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);
Jim Blandy's avatar
Jim Blandy committed
771 772 773
}

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

Jim Blandy's avatar
Jim Blandy committed
776
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
777 778
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
779 780 781
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

Jim Blandy's avatar
Jim Blandy committed
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
/* 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
803
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
804 805 806 807

  for (alist = Vminor_mode_map_alist;
       CONSP (alist);
       alist = XCONS (alist)->cdr)
808 809 810
    if ((assoc = XCONS (alist)->car, CONSP (assoc))
	&& (var = XCONS (assoc)->car, SYMBOLP (var))
	&& (val = find_symbol_value (var), ! EQ (val, Qunbound))
Jim Blandy's avatar
Jim Blandy committed
811
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
812
      {
Jim Blandy's avatar
Jim Blandy committed
813
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
814 815 816
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
817
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
818
	      {
819
		BLOCK_INPUT;
820
		cmm_size *= 2;
Richard M. Stallman's avatar
Richard M. Stallman committed
821 822 823 824 825 826
		newmodes
		  = (Lisp_Object *) realloc (cmm_modes,
					     cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) realloc (cmm_maps,
					     cmm_size * sizeof (Lisp_Object));
827
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
828 829 830
	      }
	    else
	      {
831
		BLOCK_INPUT;
832
		cmm_size = 30;
Richard M. Stallman's avatar
Richard M. Stallman committed
833 834 835 836
		newmodes
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
837
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
838 839 840 841
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
842 843
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
844 845 846 847
	      }
	    else
	      break;
	  }
Jim Blandy's avatar
Jim Blandy committed
848
	cmm_modes[i] = var;
849
	cmm_maps [i] = Findirect_function (XCONS (assoc)->cdr);
Jim Blandy's avatar
Jim Blandy committed
850 851 852
	i++;
      }

Jim Blandy's avatar
Jim Blandy committed
853 854
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
855 856 857
  return i;
}

858 859
/* GC is possible in this function if it autoloads a keymap.  */

860
DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
861
  "Return the binding for command KEY in current keymaps.\n\
862 863 864 865 866
KEY is a string or vector, a sequence of keystrokes.\n\
The binding is probably a symbol with a function definition.\n\
\n\
Normally, `key-binding' ignores bindings for t, which act as default\n\
bindings, used when nothing else in the keymap applies; this makes it\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
867 868
usable as a general function for probing keymaps.  However, if the\n\
optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
869 870
recognize the default bindings, just as `read-key-sequence' does.")
  (key, accept_default)
871
     Lisp_Object key, accept_default;
Jim Blandy's avatar
Jim Blandy committed
872
{
Jim Blandy's avatar
Jim Blandy committed
873 874
  Lisp_Object *maps, value;
  int nmaps, i;
875 876 877
  struct gcpro gcpro1;

  GCPRO1 (key);
Jim Blandy's avatar
Jim Blandy committed
878

879
  if (!NILP (Voverriding_local_map))
Jim Blandy's avatar
Jim Blandy committed
880
    {
881
      value = Flookup_key (Voverriding_local_map, key, accept_default);
882
      if (! NILP (value) && !INTEGERP (value))
883
	RETURN_UNGCPRO (value);
Jim Blandy's avatar
Jim Blandy committed
884
    }
885 886 887
  else
    { 
      nmaps = current_minor_maps (0, &maps);
888 889 890
      /* Note that all these maps are GCPRO'd
	 in the places where we found them.  */

891 892 893 894
      for (i = 0; i < nmaps; i++)
	if (! NILP (maps[i]))
	  {
	    value = Flookup_key (maps[i], key, accept_default);
895
	    if (! NILP (value) && !INTEGERP (value))
896
	      RETURN_UNGCPRO (value);
897 898 899 900 901
	  }

      if (! NILP (current_buffer->keymap))
	{
	  value = Flookup_key (current_buffer->keymap, key, accept_default);
902
	  if (! NILP (value) && !INTEGERP (value))
903
	    RETURN_UNGCPRO (value);
904 905
	}
    }
Jim Blandy's avatar
Jim Blandy committed
906

907
  value = Flookup_key (current_global_map, key, accept_default);
908
  UNGCPRO;
909
  if (! NILP (value) && !INTEGERP (value))
Jim Blandy's avatar
Jim Blandy committed
910 911 912
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
913 914
}

915 916
/* GC is possible in this function if it autoloads a keymap.  */

917
DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
918 919
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
920 921 922 923 924 925
The binding is probably a symbol with a function definition.\n\
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (keys, accept_default)
     Lisp_Object keys, accept_default;
Jim Blandy's avatar
Jim Blandy committed
926 927 928
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
929
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
930
    return Qnil;
931
  return Flookup_key (map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
932 933
}

934 935
/* GC is possible in this function if it autoloads a keymap.  */

936
DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
937 938
  "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
939 940
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\
941
\(which see).\n\
942 943 944 945 946
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (keys, accept_default)
     Lisp_Object keys, accept_default;
Jim Blandy's avatar
Jim Blandy committed
947
{
948
  return Flookup_key (current_global_map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
949 950
}

951 952
/* GC is possible in this function if it autoloads a keymap.  */

953
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
954 955 956 957 958 959 960
  "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\
961 962 963 964 965 966
that come after prefix bindings.\n\
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (key, accept_default)
     Lisp_Object key, accept_default;
Jim Blandy's avatar
Jim Blandy committed
967 968 969 970 971
{
  Lisp_Object *modes, *maps;
  int nmaps;
  Lisp_Object binding;
  int i, j;
972
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
973 974

  nmaps = current_minor_maps (&modes, &maps);
975 976 977 978 979
  /* Note that all these maps are GCPRO'd
     in the places where we found them.  */

  binding = Qnil;
  GCPRO2 (key, binding);
Jim Blandy's avatar
Jim Blandy committed
980 981

  for (i = j = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
982
    if (! NILP (maps[i])
983
	&& ! NILP (binding = Flookup_key (maps[i], key, accept_default))
984
	&& !INTEGERP (binding))
Jim Blandy's avatar
Jim Blandy committed
985
      {
986
	if (! NILP (get_keymap (binding)))
Jim Blandy's avatar
Jim Blandy committed
987 988
	  maps[j++] = Fcons (modes[i], binding);
	else if (j == 0)
989
	  RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil));
Jim Blandy's avatar
Jim Blandy committed
990 991
      }

992
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
993 994 995
  return Flist (j, maps);
}

Jim Blandy's avatar
Jim Blandy committed
996 997 998 999
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\
Richard M. Stallman's avatar
Richard M. Stallman committed
1000
KEY is a key sequence (a string or vector of characters or event types).\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1001 1002
Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
can be included if you use a vector.\n\
Jim Blandy's avatar
Jim Blandy committed
1003 1004 1005 1006 1007
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;
{
1008
  if (!VECTORP (keys) && !STRINGP (keys))
Jim Blandy's avatar
Jim Blandy committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
    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\
Richard M. Stallman's avatar
Richard M. Stallman committed
1019
KEY is a key sequence (a string or vector of characters or event types).\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1020 1021
Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
can be included if you use a vector.\n\
Jim Blandy's avatar
Jim Blandy committed
1022
The binding goes in the current buffer's local map,\n\
1023
which in most cases is shared with all other buffers in the same major mode.")
Jim Blandy's avatar
Jim Blandy committed
1024 1025 1026 1027 1028
  (keys, function)
     Lisp_Object keys, function;
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
1029
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
1030
    {
1031
      map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
1032 1033 1034
      current_buffer->keymap = map;
    }

1035
  if (!VECTORP (keys) && !STRINGP (keys))
Jim Blandy's avatar
Jim Blandy committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
    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
1059
  if (!NILP (current_buffer->keymap))
Jim Blandy's avatar
Jim Blandy committed
1060 1061 1062 1063 1064
    Flocal_set_key (keys, Qnil);
  return Qnil;
}

DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 2, 0,
1065
  "Define COMMAND as a prefix command.  COMMAND should be a symbol.\n\
Jim Blandy's avatar
Jim Blandy committed
1066
A new sparse keymap is stored as COMMAND's function definition and its value.\n\
Jim Blandy's avatar
Jim Blandy committed
1067 1068 1069
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
1070 1071 1072 1073
  (name, mapvar)
     Lisp_Object name, mapvar;
{
  Lisp_Object map;
1074
  map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed
1075
  Ffset (name, map);
Jim Blandy's avatar
Jim Blandy committed
1076
  if (!NILP (mapvar))
Jim Blandy's avatar
Jim Blandy committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
    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;
1090 1091
  record_asynch_buffer_change ();

Jim Blandy's avatar
Jim Blandy committed
1092 1093 1094 1095 1096 1097 1098 1099 1100
  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
1101
  if (!NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
1102 1103 1104
    keymap = get_keymap (keymap);

  current_buffer->keymap = keymap;
1105
  record_asynch_buffer_change ();
Jim Blandy's avatar
Jim Blandy committed
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122

  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
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132

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

1136 1137
/* This function cannot GC.  */

Jim Blandy's avatar
Jim Blandy committed
1138
DEFUN ("accessible-keymaps", Faccessible_keymaps, Saccessible_keymaps,
1139
  1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1140 1141 1142
  "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\
1143 1144 1145
so that the KEYS increase in length.  The first element is (\"\" . KEYMAP).\n\
An optional argument PREFIX, if non-nil, should be a key sequence;\n\
then the value includes only maps for prefixes that start with PREFIX.")
1146 1147
  (startmap, prefix)
     Lisp_Object startmap, prefix;
Jim Blandy's avatar
Jim Blandy committed
1148
{
1149 1150 1151
  Lisp_Object maps, good_maps, tail;
  int prefixlen = 0;

1152 1153
  /* no need for gcpro because we don't autoload any keymaps.  */

1154 1155
  if (!NILP (prefix))
    prefixlen = XINT (Flength (prefix));
Jim Blandy's avatar
Jim Blandy committed
1156