Fix buffer overflow in make-docfile
[emacs.git] / doc / lispref / keymaps.texi
blob73f5572e69dd40a8d5f5445532528a4719741c49
1 @c -*- mode: texinfo; coding: utf-8 -*-
2 @c This is part of the GNU Emacs Lisp Reference Manual.
3 @c Copyright (C) 1990-1994, 1998-2017 Free Software Foundation, Inc.
4 @c See the file elisp.texi for copying conditions.
5 @node Keymaps
6 @chapter Keymaps
7 @cindex keymap
9   The command bindings of input events are recorded in data structures
10 called @dfn{keymaps}.  Each entry in a keymap associates (or
11 @dfn{binds}) an individual event type, either to another keymap or to
12 a command.  When an event type is bound to a keymap, that keymap is
13 used to look up the next input event; this continues until a command
14 is found.  The whole process is called @dfn{key lookup}.
16 @menu
17 * Key Sequences::               Key sequences as Lisp objects.
18 * Keymap Basics::               Basic concepts of keymaps.
19 * Format of Keymaps::           What a keymap looks like as a Lisp object.
20 * Creating Keymaps::            Functions to create and copy keymaps.
21 * Inheritance and Keymaps::     How one keymap can inherit the bindings
22                                    of another keymap.
23 * Prefix Keys::                 Defining a key with a keymap as its definition.
24 * Active Keymaps::              How Emacs searches the active keymaps
25                                    for a key binding.
26 * Searching Keymaps::           A pseudo-Lisp summary of searching active maps.
27 * Controlling Active Maps::     Each buffer has a local keymap
28                                    to override the standard (global) bindings.
29                                    A minor mode can also override them.
30 * Key Lookup::                  Finding a key's binding in one keymap.
31 * Functions for Key Lookup::    How to request key lookup.
32 * Changing Key Bindings::       Redefining a key in a keymap.
33 * Remapping Commands::          A keymap can translate one command to another.
34 * Translation Keymaps::         Keymaps for translating sequences of events.
35 * Key Binding Commands::        Interactive interfaces for redefining keys.
36 * Scanning Keymaps::            Looking through all keymaps, for printing help.
37 * Menu Keymaps::                Defining a menu as a keymap.
38 @end menu
40 @node Key Sequences
41 @section Key Sequences
42 @cindex key
43 @cindex keystroke
44 @cindex key sequence
46   A @dfn{key sequence}, or @dfn{key} for short, is a sequence of one
47 or more input events that form a unit.  Input events include
48 characters, function keys, mouse actions, or system events external to
49 Emacs, such as @code{iconify-frame} (@pxref{Input Events}).
50 The Emacs Lisp representation for a key sequence is a string or
51 vector.  Unless otherwise stated, any Emacs Lisp function that accepts
52 a key sequence as an argument can handle both representations.
54   In the string representation, alphanumeric characters ordinarily
55 stand for themselves; for example, @code{"a"} represents @kbd{a}
56 and @code{"2"} represents @kbd{2}.  Control character events are
57 prefixed by the substring @code{"\C-"}, and meta characters by
58 @code{"\M-"}; for example, @code{"\C-x"} represents the key @kbd{C-x}.
59 In addition, the @key{TAB}, @key{RET}, @key{ESC}, and @key{DEL} events
60 are represented by @code{"\t"}, @code{"\r"}, @code{"\e"}, and
61 @code{"\d"} respectively.  The string representation of a complete key
62 sequence is the concatenation of the string representations of the
63 constituent events; thus, @code{"\C-xl"} represents the key sequence
64 @kbd{C-x l}.
66   Key sequences containing function keys, mouse button events, system
67 events, or non-@acronym{ASCII} characters such as @kbd{C-=} or
68 @kbd{H-a} cannot be represented as strings; they have to be
69 represented as vectors.
71   In the vector representation, each element of the vector represents
72 an input event, in its Lisp form.  @xref{Input Events}.  For example,
73 the vector @code{[?\C-x ?l]} represents the key sequence @kbd{C-x l}.
75   For examples of key sequences written in string and vector
76 representations, @ref{Init Rebinding,,, emacs, The GNU Emacs Manual}.
78 @defun kbd keyseq-text
79 This function converts the text @var{keyseq-text} (a string constant)
80 into a key sequence (a string or vector constant).  The contents of
81 @var{keyseq-text} should use the same syntax as in the buffer invoked
82 by the @kbd{C-x C-k @key{RET}} (@code{kmacro-edit-macro}) command; in
83 particular, you must surround function key names with
84 @samp{<@dots{}>}.  @xref{Edit Keyboard Macro,,, emacs, The GNU Emacs
85 Manual}.
87 @example
88 (kbd "C-x") @result{} "\C-x"
89 (kbd "C-x C-f") @result{} "\C-x\C-f"
90 (kbd "C-x 4 C-f") @result{} "\C-x4\C-f"
91 (kbd "X") @result{} "X"
92 (kbd "RET") @result{} "\^M"
93 (kbd "C-c SPC") @result{} "\C-c@ "
94 (kbd "<f1> SPC") @result{} [f1 32]
95 (kbd "C-M-<down>") @result{} [C-M-down]
96 @end example
97 @end defun
99 @node Keymap Basics
100 @section Keymap Basics
101 @cindex key binding
102 @cindex binding of a key
103 @cindex complete key
104 @cindex undefined key
106   A keymap is a Lisp data structure that specifies @dfn{key bindings}
107 for various key sequences.
109   A single keymap directly specifies definitions for individual
110 events.  When a key sequence consists of a single event, its binding
111 in a keymap is the keymap's definition for that event.  The binding of
112 a longer key sequence is found by an iterative process: first find the
113 definition of the first event (which must itself be a keymap); then
114 find the second event's definition in that keymap, and so on until all
115 the events in the key sequence have been processed.
117   If the binding of a key sequence is a keymap, we call the key sequence
118 a @dfn{prefix key}.  Otherwise, we call it a @dfn{complete key} (because
119 no more events can be added to it).  If the binding is @code{nil},
120 we call the key @dfn{undefined}.  Examples of prefix keys are @kbd{C-c},
121 @kbd{C-x}, and @kbd{C-x 4}.  Examples of defined complete keys are
122 @kbd{X}, @key{RET}, and @kbd{C-x 4 C-f}.  Examples of undefined complete
123 keys are @kbd{C-x C-g}, and @kbd{C-c 3}.  @xref{Prefix Keys}, for more
124 details.
126   The rule for finding the binding of a key sequence assumes that the
127 intermediate bindings (found for the events before the last) are all
128 keymaps; if this is not so, the sequence of events does not form a
129 unit---it is not really one key sequence.  In other words, removing one
130 or more events from the end of any valid key sequence must always yield
131 a prefix key.  For example, @kbd{C-f C-n} is not a key sequence;
132 @kbd{C-f} is not a prefix key, so a longer sequence starting with
133 @kbd{C-f} cannot be a key sequence.
135   The set of possible multi-event key sequences depends on the bindings
136 for prefix keys; therefore, it can be different for different keymaps,
137 and can change when bindings are changed.  However, a one-event sequence
138 is always a key sequence, because it does not depend on any prefix keys
139 for its well-formedness.
141   At any time, several primary keymaps are @dfn{active}---that is, in
142 use for finding key bindings.  These are the @dfn{global map}, which is
143 shared by all buffers; the @dfn{local keymap}, which is usually
144 associated with a specific major mode; and zero or more @dfn{minor mode
145 keymaps}, which belong to currently enabled minor modes.  (Not all minor
146 modes have keymaps.)  The local keymap bindings shadow (i.e., take
147 precedence over) the corresponding global bindings.  The minor mode
148 keymaps shadow both local and global keymaps.  @xref{Active Keymaps},
149 for details.
151 @node Format of Keymaps
152 @section Format of Keymaps
153 @cindex format of keymaps
154 @cindex keymap format
155 @cindex full keymap
156 @cindex sparse keymap
158   Each keymap is a list whose @sc{car} is the symbol @code{keymap}.  The
159 remaining elements of the list define the key bindings of the keymap.
160 A symbol whose function definition is a keymap is also a keymap.  Use
161 the function @code{keymapp} (see below) to test whether an object is a
162 keymap.
164   Several kinds of elements may appear in a keymap, after the symbol
165 @code{keymap} that begins it:
167 @table @code
168 @item (@var{type} .@: @var{binding})
169 This specifies one binding, for events of type @var{type}.  Each
170 ordinary binding applies to events of a particular @dfn{event type},
171 which is always a character or a symbol.  @xref{Classifying Events}.
172 In this kind of binding, @var{binding} is a command.
174 @item (@var{type} @var{item-name} .@: @var{binding})
175 This specifies a binding which is also a simple menu item that
176 displays as @var{item-name} in the menu.  @xref{Simple Menu Items}.
178 @item (@var{type} @var{item-name} @var{help-string} .@: @var{binding})
179 This is a simple menu item with help string @var{help-string}.
181 @item (@var{type} menu-item .@: @var{details})
182 This specifies a binding which is also an extended menu item.  This
183 allows use of other features.  @xref{Extended Menu Items}.
185 @item (t .@: @var{binding})
186 @cindex default key binding
187 This specifies a @dfn{default key binding}; any event not bound by other
188 elements of the keymap is given @var{binding} as its binding.  Default
189 bindings allow a keymap to bind all possible event types without having
190 to enumerate all of them.  A keymap that has a default binding
191 completely masks any lower-precedence keymap, except for events
192 explicitly bound to @code{nil} (see below).
194 @item @var{char-table}
195 If an element of a keymap is a char-table, it counts as holding
196 bindings for all character events with no modifier bits
197 (@pxref{modifier bits}): the element whose index is @var{c} is the
198 binding for the character @var{c}.  This is a compact way to record
199 lots of bindings.  A keymap with such a char-table is called a
200 @dfn{full keymap}.  Other keymaps are called @dfn{sparse keymaps}.
202 @item @var{vector}
203 This kind of element is similar to a char-table: the element whose
204 index is @var{c} is the binding for the character @var{c}.  Since the
205 range of characters that can be bound this way is limited by the
206 vector size, and vector creation allocates space for all character
207 codes from 0 up, this format should not be used except for creating
208 menu keymaps (@pxref{Menu Keymaps}), where the bindings themselves
209 don't matter.
211 @item @var{string}
212 @cindex keymap prompt string
213 @cindex overall prompt string
214 @cindex prompt string of keymap
215 Aside from elements that specify bindings for keys, a keymap can also
216 have a string as an element.  This is called the @dfn{overall prompt
217 string} and makes it possible to use the keymap as a menu.
218 @xref{Defining Menus}.
220 @item (keymap @dots{})
221 If an element of a keymap is itself a keymap, it counts as if this inner keymap
222 were inlined in the outer keymap.  This is used for multiple-inheritance, such
223 as in @code{make-composed-keymap}.
224 @end table
226 When the binding is @code{nil}, it doesn't constitute a definition
227 but it does take precedence over a default binding or a binding in the
228 parent keymap.  On the other hand, a binding of @code{nil} does
229 @emph{not} override lower-precedence keymaps; thus, if the local map
230 gives a binding of @code{nil}, Emacs uses the binding from the
231 global map.
233 @cindex meta characters lookup
234   Keymaps do not directly record bindings for the meta characters.
235 Instead, meta characters are regarded for purposes of key lookup as
236 sequences of two characters, the first of which is @key{ESC} (or
237 whatever is currently the value of @code{meta-prefix-char}).  Thus, the
238 key @kbd{M-a} is internally represented as @kbd{@key{ESC} a}, and its
239 global binding is found at the slot for @kbd{a} in @code{esc-map}
240 (@pxref{Prefix Keys}).
242   This conversion applies only to characters, not to function keys or
243 other input events; thus, @kbd{M-@key{end}} has nothing to do with
244 @kbd{@key{ESC} @key{end}}.
246   Here as an example is the local keymap for Lisp mode, a sparse
247 keymap.  It defines bindings for @key{DEL}, @kbd{C-c C-z},
248 @kbd{C-M-q}, and @kbd{C-M-x} (the actual value also contains a menu
249 binding, which is omitted here for the sake of brevity).
251 @example
252 @group
253 lisp-mode-map
254 @result{}
255 @end group
256 @group
257 (keymap
258  (3 keymap
259     ;; @kbd{C-c C-z}
260     (26 . run-lisp))
261 @end group
262 @group
263  (27 keymap
264      ;; @r{@kbd{C-M-x}, treated as @kbd{@key{ESC} C-x}}
265      (24 . lisp-send-defun))
266 @end group
267 @group
268  ;; @r{This part is inherited from @code{lisp-mode-shared-map}.}
269  keymap
270  ;; @key{DEL}
271  (127 . backward-delete-char-untabify)
272 @end group
273 @group
274  (27 keymap
275      ;; @r{@kbd{C-M-q}, treated as @kbd{@key{ESC} C-q}}
276      (17 . indent-sexp)))
277 @end group
278 @end example
280 @defun keymapp object
281 This function returns @code{t} if @var{object} is a keymap, @code{nil}
282 otherwise.  More precisely, this function tests for a list whose
283 @sc{car} is @code{keymap}, or for a symbol whose function definition
284 satisfies @code{keymapp}.
286 @example
287 @group
288 (keymapp '(keymap))
289     @result{} t
290 @end group
291 @group
292 (fset 'foo '(keymap))
293 (keymapp 'foo)
294     @result{} t
295 @end group
296 @group
297 (keymapp (current-global-map))
298     @result{} t
299 @end group
300 @end example
301 @end defun
303 @node Creating Keymaps
304 @section Creating Keymaps
305 @cindex creating keymaps
307   Here we describe the functions for creating keymaps.
309 @defun make-sparse-keymap &optional prompt
310 This function creates and returns a new sparse keymap with no entries.
311 (A sparse keymap is the kind of keymap you usually want.)  The new
312 keymap does not contain a char-table, unlike @code{make-keymap}, and
313 does not bind any events.
315 @example
316 @group
317 (make-sparse-keymap)
318     @result{} (keymap)
319 @end group
320 @end example
322 If you specify @var{prompt}, that becomes the overall prompt string
323 for the keymap.  You should specify this only for menu keymaps
324 (@pxref{Defining Menus}).  A keymap with an overall prompt string will
325 always present a mouse menu or a keyboard menu if it is active for
326 looking up the next input event.  Don't specify an overall prompt string
327 for the main map of a major or minor mode, because that would cause
328 the command loop to present a keyboard menu every time.
329 @end defun
331 @defun make-keymap &optional prompt
332 This function creates and returns a new full keymap.  That keymap
333 contains a char-table (@pxref{Char-Tables}) with slots for all
334 characters without modifiers.  The new keymap initially binds all
335 these characters to @code{nil}, and does not bind any other kind of
336 event.  The argument @var{prompt} specifies a
337 prompt string, as in @code{make-sparse-keymap}.
339 @c This example seems kind of pointless, but I guess it serves
340 @c to contrast the result with make-sparse-keymap above.
341 @example
342 @group
343 (make-keymap)
344     @result{} (keymap #^[nil nil keymap nil nil nil @dots{}])
345 @end group
346 @end example
348 A full keymap is more efficient than a sparse keymap when it holds
349 lots of bindings; for just a few, the sparse keymap is better.
350 @end defun
352 @defun copy-keymap keymap
353 This function returns a copy of @var{keymap}.  This is almost never
354 needed.  If you want a keymap that's like another yet with a few
355 changes, you should use map inheritance rather than copying.
356 I.e., something like:
358 @example
359 @group
360 (let ((map (make-sparse-keymap)))
361   (set-keymap-parent map <theirmap>)
362   (define-key map ...)
363   ...)
364 @end group
365 @end example
367 When performing @code{copy-keymap}, any keymaps that
368 appear directly as bindings in @var{keymap} are also copied recursively,
369 and so on to any number of levels.  However, recursive copying does not
370 take place when the definition of a character is a symbol whose function
371 definition is a keymap; the same symbol appears in the new copy.
372 @c Emacs 19 feature
374 @example
375 @group
376 (setq map (copy-keymap (current-local-map)))
377 @result{} (keymap
378 @end group
379 @group
380      ;; @r{(This implements meta characters.)}
381      (27 keymap
382          (83 . center-paragraph)
383          (115 . center-line))
384      (9 . tab-to-tab-stop))
385 @end group
387 @group
388 (eq map (current-local-map))
389     @result{} nil
390 @end group
391 @group
392 (equal map (current-local-map))
393     @result{} t
394 @end group
395 @end example
396 @end defun
398 @node Inheritance and Keymaps
399 @section Inheritance and Keymaps
400 @cindex keymap inheritance
401 @cindex inheritance, keymap
403   A keymap can inherit the bindings of another keymap, which we call the
404 @dfn{parent keymap}.  Such a keymap looks like this:
406 @example
407 (keymap @var{elements}@dots{} . @var{parent-keymap})
408 @end example
410 @noindent
411 The effect is that this keymap inherits all the bindings of
412 @var{parent-keymap}, whatever they may be at the time a key is looked up,
413 but can add to them or override them with @var{elements}.
415 If you change the bindings in @var{parent-keymap} using
416 @code{define-key} or other key-binding functions, these changed
417 bindings are visible in the inheriting keymap, unless shadowed by the
418 bindings made by @var{elements}.  The converse is not true: if you use
419 @code{define-key} to change bindings in the inheriting keymap, these
420 changes are recorded in @var{elements}, but have no effect on
421 @var{parent-keymap}.
423 The proper way to construct a keymap with a parent is to use
424 @code{set-keymap-parent}; if you have code that directly constructs a
425 keymap with a parent, please convert the program to use
426 @code{set-keymap-parent} instead.
428 @defun keymap-parent keymap
429 This returns the parent keymap of @var{keymap}.  If @var{keymap}
430 has no parent, @code{keymap-parent} returns @code{nil}.
431 @end defun
433 @defun set-keymap-parent keymap parent
434 This sets the parent keymap of @var{keymap} to @var{parent}, and returns
435 @var{parent}.  If @var{parent} is @code{nil}, this function gives
436 @var{keymap} no parent at all.
438 If @var{keymap} has submaps (bindings for prefix keys), they too receive
439 new parent keymaps that reflect what @var{parent} specifies for those
440 prefix keys.
441 @end defun
443    Here is an example showing how to make a keymap that inherits
444 from @code{text-mode-map}:
446 @example
447 (let ((map (make-sparse-keymap)))
448   (set-keymap-parent map text-mode-map)
449   map)
450 @end example
452   A non-sparse keymap can have a parent too, but this is not very
453 useful.  A non-sparse keymap always specifies something as the binding
454 for every numeric character code without modifier bits, even if it is
455 @code{nil}, so these character's bindings are never inherited from
456 the parent keymap.
458 @cindex keymap inheritance from multiple maps
459   Sometimes you want to make a keymap that inherits from more than one
460 map.  You can use the function @code{make-composed-keymap} for this.
462 @defun make-composed-keymap maps &optional parent
463 This function returns a new keymap composed of the existing keymap(s)
464 @var{maps}, and optionally inheriting from a parent keymap
465 @var{parent}.  @var{maps} can be a single keymap or a list of more
466 than one.  When looking up a key in the resulting new map, Emacs
467 searches in each of the @var{maps} in turn, and then in @var{parent},
468 stopping at the first match.  A @code{nil} binding in any one of
469 @var{maps} overrides any binding in @var{parent}, but it does not
470 override any non-@code{nil} binding in any other of the @var{maps}.
471 @end defun
473 @noindent For example, here is how Emacs sets the parent of
474 @code{help-mode-map}, such that it inherits from both
475 @code{button-buffer-map} and @code{special-mode-map}:
477 @example
478 (defvar help-mode-map
479   (let ((map (make-sparse-keymap)))
480     (set-keymap-parent map
481       (make-composed-keymap button-buffer-map special-mode-map))
482     ... map) ... )
483 @end example
486 @node Prefix Keys
487 @section Prefix Keys
488 @cindex prefix key
490   A @dfn{prefix key} is a key sequence whose binding is a keymap.  The
491 keymap defines what to do with key sequences that extend the prefix key.
492 For example, @kbd{C-x} is a prefix key, and it uses a keymap that is
493 also stored in the variable @code{ctl-x-map}.  This keymap defines
494 bindings for key sequences starting with @kbd{C-x}.
496   Some of the standard Emacs prefix keys use keymaps that are
497 also found in Lisp variables:
499 @itemize @bullet
500 @item
501 @vindex esc-map
502 @findex ESC-prefix
503 @code{esc-map} is the global keymap for the @key{ESC} prefix key.  Thus,
504 the global definitions of all meta characters are actually found here.
505 This map is also the function definition of @code{ESC-prefix}.
507 @item
508 @cindex @kbd{C-h}
509 @code{help-map} is the global keymap for the @kbd{C-h} prefix key.
511 @item
512 @cindex @kbd{C-c}
513 @vindex mode-specific-map
514 @code{mode-specific-map} is the global keymap for the prefix key
515 @kbd{C-c}.  This map is actually global, not mode-specific, but its name
516 provides useful information about @kbd{C-c} in the output of @kbd{C-h b}
517 (@code{display-bindings}), since the main use of this prefix key is for
518 mode-specific bindings.
520 @item
521 @cindex @kbd{C-x}
522 @vindex ctl-x-map
523 @findex Control-X-prefix
524 @code{ctl-x-map} is the global keymap used for the @kbd{C-x} prefix key.
525 This map is found via the function cell of the symbol
526 @code{Control-X-prefix}.
528 @item
529 @cindex @kbd{C-x @key{RET}}
530 @vindex mule-keymap
531 @code{mule-keymap} is the global keymap used for the @kbd{C-x @key{RET}}
532 prefix key.
534 @item
535 @cindex @kbd{C-x 4}
536 @vindex ctl-x-4-map
537 @code{ctl-x-4-map} is the global keymap used for the @kbd{C-x 4} prefix
538 key.
540 @item
541 @cindex @kbd{C-x 5}
542 @vindex ctl-x-5-map
543 @code{ctl-x-5-map} is the global keymap used for the @kbd{C-x 5} prefix
544 key.
546 @item
547 @cindex @kbd{C-x 6}
548 @vindex 2C-mode-map
549 @code{2C-mode-map} is the global keymap used for the @kbd{C-x 6} prefix
550 key.
552 @item
553 @cindex @kbd{C-x v}
554 @vindex vc-prefix-map
555 @code{vc-prefix-map} is the global keymap used for the @kbd{C-x v} prefix
556 key.
558 @item
559 @cindex @kbd{M-g}
560 @vindex goto-map
561 @code{goto-map} is the global keymap used for the @kbd{M-g} prefix
562 key.
564 @item
565 @cindex @kbd{M-s}
566 @vindex search-map
567 @code{search-map} is the global keymap used for the @kbd{M-s} prefix
568 key.
570 @item
571 @cindex @kbd{M-o}
572 @vindex facemenu-keymap
573 @code{facemenu-keymap} is the global keymap used for the @kbd{M-o}
574 prefix key.
576 @item
577 The other Emacs prefix keys are @kbd{C-x @@}, @kbd{C-x a i}, @kbd{C-x
578 @key{ESC}} and @kbd{@key{ESC} @key{ESC}}.  They use keymaps that have
579 no special names.
580 @end itemize
582   The keymap binding of a prefix key is used for looking up the event
583 that follows the prefix key.  (It may instead be a symbol whose function
584 definition is a keymap.  The effect is the same, but the symbol serves
585 as a name for the prefix key.)  Thus, the binding of @kbd{C-x} is the
586 symbol @code{Control-X-prefix}, whose function cell holds the keymap
587 for @kbd{C-x} commands.  (The same keymap is also the value of
588 @code{ctl-x-map}.)
590   Prefix key definitions can appear in any active keymap.  The
591 definitions of @kbd{C-c}, @kbd{C-x}, @kbd{C-h} and @key{ESC} as prefix
592 keys appear in the global map, so these prefix keys are always
593 available.  Major and minor modes can redefine a key as a prefix by
594 putting a prefix key definition for it in the local map or the minor
595 mode's map.  @xref{Active Keymaps}.
597   If a key is defined as a prefix in more than one active map, then its
598 various definitions are in effect merged: the commands defined in the
599 minor mode keymaps come first, followed by those in the local map's
600 prefix definition, and then by those from the global map.
602   In the following example, we make @kbd{C-p} a prefix key in the local
603 keymap, in such a way that @kbd{C-p} is identical to @kbd{C-x}.  Then
604 the binding for @kbd{C-p C-f} is the function @code{find-file}, just
605 like @kbd{C-x C-f}.  The key sequence @kbd{C-p 6} is not found in any
606 active keymap.
608 @example
609 @group
610 (use-local-map (make-sparse-keymap))
611     @result{} nil
612 @end group
613 @group
614 (local-set-key "\C-p" ctl-x-map)
615     @result{} nil
616 @end group
617 @group
618 (key-binding "\C-p\C-f")
619     @result{} find-file
620 @end group
622 @group
623 (key-binding "\C-p6")
624     @result{} nil
625 @end group
626 @end example
628 @defun define-prefix-command symbol &optional mapvar prompt
629 @cindex prefix command
630 @anchor{Definition of define-prefix-command}
631 This function prepares @var{symbol} for use as a prefix key's binding:
632 it creates a sparse keymap and stores it as @var{symbol}'s function
633 definition.  Subsequently binding a key sequence to @var{symbol} will
634 make that key sequence into a prefix key.  The return value is @code{symbol}.
636 This function also sets @var{symbol} as a variable, with the keymap as
637 its value.  But if @var{mapvar} is non-@code{nil}, it sets @var{mapvar}
638 as a variable instead.
640 If @var{prompt} is non-@code{nil}, that becomes the overall prompt
641 string for the keymap.  The prompt string should be given for menu keymaps
642 (@pxref{Defining Menus}).
643 @end defun
645 @node Active Keymaps
646 @section Active Keymaps
647 @cindex active keymap
649   Emacs contains many keymaps, but at any time only a few keymaps are
650 @dfn{active}.  When Emacs receives user input, it translates the input
651 event (@pxref{Translation Keymaps}), and looks for a key binding in
652 the active keymaps.
654   Usually, the active keymaps are: (i) the keymap specified by the
655 @code{keymap} property, (ii) the keymaps of enabled minor modes, (iii)
656 the current buffer's local keymap, and (iv) the global keymap, in that
657 order.  Emacs searches for each input key sequence in all these
658 keymaps.
660   Of these usual keymaps, the highest-precedence one is specified
661 by the @code{keymap} text or overlay property at point, if any.  (For
662 a mouse input event, Emacs uses the event position instead of point;
663 @iftex
664 see the next section for details.)
665 @end iftex
666 @ifnottex
667 @pxref{Searching Keymaps}.)
668 @end ifnottex
670   Next in precedence are keymaps specified by enabled minor modes.
671 These keymaps, if any, are specified by the variables
672 @code{emulation-mode-map-alists},
673 @code{minor-mode-overriding-map-alist}, and
674 @code{minor-mode-map-alist}.  @xref{Controlling Active Maps}.
676 @cindex local keymap
677   Next in precedence is the buffer's @dfn{local keymap}, containing
678 key bindings specific to the buffer.  The minibuffer also has a local
679 keymap (@pxref{Intro to Minibuffers}).  If there is a @code{local-map}
680 text or overlay property at point, that specifies the local keymap to
681 use, in place of the buffer's default local keymap.
683 @cindex major mode keymap
684   The local keymap is normally set by the buffer's major mode, and
685 every buffer with the same major mode shares the same local keymap.
686 Hence, if you call @code{local-set-key} (@pxref{Key Binding Commands})
687 to change the local keymap in one buffer, that also affects the local
688 keymaps in other buffers with the same major mode.
690 @cindex global keymap
691   Finally, the @dfn{global keymap} contains key bindings that are
692 defined regardless of the current buffer, such as @kbd{C-f}.  It is
693 always active, and is bound to the variable @code{global-map}.
695   Apart from the above usual keymaps, Emacs provides special ways
696 for programs to make other keymaps active.  Firstly, the variable
697 @code{overriding-local-map} specifies a keymap that replaces the usual
698 active keymaps, except for the global keymap.  Secondly, the
699 terminal-local variable @code{overriding-terminal-local-map} specifies
700 a keymap that takes precedence over @emph{all} other keymaps
701 (including @code{overriding-local-map}); this is normally used for
702 modal/transient keybindings (the function @code{set-transient-map}
703 provides a convenient interface for this).  @xref{Controlling Active
704 Maps}, for details.
706   Making keymaps active is not the only way to use them.  Keymaps are
707 also used in other ways, such as for translating events within
708 @code{read-key-sequence}.  @xref{Translation Keymaps}.
710   @xref{Standard Keymaps}, for a list of some standard keymaps.
712 @defun current-active-maps &optional olp position
713 This returns the list of active keymaps that would be used by the
714 command loop in the current circumstances to look up a key sequence.
715 Normally it ignores @code{overriding-local-map} and
716 @code{overriding-terminal-local-map}, but if @var{olp} is non-@code{nil}
717 then it pays attention to them.  @var{position} can optionally be either
718 an event position as returned by @code{event-start} or a buffer
719 position, and may change the keymaps as described for
720 @code{key-binding}.
721 @end defun
723 @defun key-binding key &optional accept-defaults no-remap position
724 This function returns the binding for @var{key} according to the
725 current active keymaps.  The result is @code{nil} if @var{key} is
726 undefined in the keymaps.
728 The argument @var{accept-defaults} controls checking for default
729 bindings, as in @code{lookup-key} (@pxref{Functions for Key Lookup}).
731 When commands are remapped (@pxref{Remapping Commands}),
732 @code{key-binding} normally processes command remappings so as to
733 return the remapped command that will actually be executed.  However,
734 if @var{no-remap} is non-@code{nil}, @code{key-binding} ignores
735 remappings and returns the binding directly specified for @var{key}.
737 If @var{key} starts with a mouse event (perhaps following a prefix
738 event), the maps to be consulted are determined based on the event's
739 position.  Otherwise, they are determined based on the value of point.
740 However, you can override either of them by specifying @var{position}.
741 If @var{position} is non-@code{nil}, it should be either a buffer
742 position or an event position like the value of @code{event-start}.
743 Then the maps consulted are determined based on @var{position}.
745 Emacs signals an error if @var{key} is not a string or a vector.
747 @example
748 @group
749 (key-binding "\C-x\C-f")
750     @result{} find-file
751 @end group
752 @end example
753 @end defun
755 @node Searching Keymaps
756 @section Searching the Active Keymaps
757 @cindex searching active keymaps for keys
759 Here is a pseudo-Lisp summary of how Emacs searches the active
760 keymaps:
762 @lisp
763 (or (if overriding-terminal-local-map
764         (@var{find-in} overriding-terminal-local-map))
765     (if overriding-local-map
766         (@var{find-in} overriding-local-map)
767       (or (@var{find-in} (get-char-property (point) 'keymap))
768           (@var{find-in-any} emulation-mode-map-alists)
769           (@var{find-in-any} minor-mode-overriding-map-alist)
770           (@var{find-in-any} minor-mode-map-alist)
771           (if (get-text-property (point) 'local-map)
772               (@var{find-in} (get-char-property (point) 'local-map))
773             (@var{find-in} (current-local-map)))))
774     (@var{find-in} (current-global-map)))
775 @end lisp
777 @noindent
778 Here, @var{find-in} and @var{find-in-any} are pseudo functions that
779 search in one keymap and in an alist of keymaps, respectively.  Note
780 that the @code{set-transient-map} function works by setting
781 @code{overriding-terminal-local-map} (@pxref{Controlling Active
782 Maps}).
784   In the above pseudo-code, if a key sequence starts with a mouse
785 event (@pxref{Mouse Events}), that event's position is used instead of
786 point, and the event's buffer is used instead of the current buffer.
787 In particular, this affects how the @code{keymap} and @code{local-map}
788 properties are looked up.  If a mouse event occurs on a string
789 embedded with a @code{display}, @code{before-string}, or
790 @code{after-string} property (@pxref{Special Properties}), and the
791 string has a non-@code{nil} @code{keymap} or @code{local-map}
792 property, that overrides the corresponding property in the underlying
793 buffer text (i.e., the property specified by the underlying text is
794 ignored).
796   When a key binding is found in one of the active keymaps, and that
797 binding is a command, the search is over---the command is executed.
798 However, if the binding is a symbol with a value or a string, Emacs
799 replaces the input key sequences with the variable's value or the
800 string, and restarts the search of the active keymaps.  @xref{Key
801 Lookup}.
803   The command which is finally found might also be remapped.
804 @xref{Remapping Commands}.
806 @node Controlling Active Maps
807 @section Controlling the Active Keymaps
808 @cindex active keymap, controlling
810 @defvar global-map
811 This variable contains the default global keymap that maps Emacs
812 keyboard input to commands.  The global keymap is normally this
813 keymap.  The default global keymap is a full keymap that binds
814 @code{self-insert-command} to all of the printing characters.
816 It is normal practice to change the bindings in the global keymap, but you
817 should not assign this variable any value other than the keymap it starts
818 out with.
819 @end defvar
821 @defun current-global-map
822 This function returns the current global keymap.  This is the same as
823 the value of @code{global-map} unless you change one or the other.
824 The return value is a reference, not a copy; if you use
825 @code{define-key} or other functions on it you will alter global
826 bindings.
828 @example
829 @group
830 (current-global-map)
831 @result{} (keymap [set-mark-command beginning-of-line @dots{}
832             delete-backward-char])
833 @end group
834 @end example
835 @end defun
837 @defun current-local-map
838 This function returns the current buffer's local keymap, or @code{nil}
839 if it has none.  In the following example, the keymap for the
840 @file{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap
841 in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse
842 keymap.
844 @example
845 @group
846 (current-local-map)
847 @result{} (keymap
848     (10 . eval-print-last-sexp)
849     (9 . lisp-indent-line)
850     (127 . backward-delete-char-untabify)
851 @end group
852 @group
853     (27 keymap
854         (24 . eval-defun)
855         (17 . indent-sexp)))
856 @end group
857 @end example
858 @end defun
860 @code{current-local-map} returns a reference to the local keymap, not
861 a copy of it; if you use @code{define-key} or other functions on it
862 you will alter local bindings.
864 @defun current-minor-mode-maps
865 This function returns a list of the keymaps of currently enabled minor modes.
866 @end defun
868 @defun use-global-map keymap
869 This function makes @var{keymap} the new current global keymap.  It
870 returns @code{nil}.
872 It is very unusual to change the global keymap.
873 @end defun
875 @defun use-local-map keymap
876 This function makes @var{keymap} the new local keymap of the current
877 buffer.  If @var{keymap} is @code{nil}, then the buffer has no local
878 keymap.  @code{use-local-map} returns @code{nil}.  Most major mode
879 commands use this function.
880 @end defun
882 @defvar minor-mode-map-alist
883 @anchor{Definition of minor-mode-map-alist}
884 This variable is an alist describing keymaps that may or may not be
885 active according to the values of certain variables.  Its elements look
886 like this:
888 @example
889 (@var{variable} . @var{keymap})
890 @end example
892 The keymap @var{keymap} is active whenever @var{variable} has a
893 non-@code{nil} value.  Typically @var{variable} is the variable that
894 enables or disables a minor mode.  @xref{Keymaps and Minor Modes}.
896 Note that elements of @code{minor-mode-map-alist} do not have the same
897 structure as elements of @code{minor-mode-alist}.  The map must be the
898 @sc{cdr} of the element; a list with the map as the second element will
899 not do.  The @sc{cdr} can be either a keymap (a list) or a symbol whose
900 function definition is a keymap.
902 When more than one minor mode keymap is active, the earlier one in
903 @code{minor-mode-map-alist} takes priority.  But you should design
904 minor modes so that they don't interfere with each other.  If you do
905 this properly, the order will not matter.
907 See @ref{Keymaps and Minor Modes}, for more information about minor
908 modes.  See also @code{minor-mode-key-binding} (@pxref{Functions for Key
909 Lookup}).
910 @end defvar
912 @defvar minor-mode-overriding-map-alist
913 This variable allows major modes to override the key bindings for
914 particular minor modes.  The elements of this alist look like the
915 elements of @code{minor-mode-map-alist}: @code{(@var{variable}
916 . @var{keymap})}.
918 If a variable appears as an element of
919 @code{minor-mode-overriding-map-alist}, the map specified by that
920 element totally replaces any map specified for the same variable in
921 @code{minor-mode-map-alist}.
923 @code{minor-mode-overriding-map-alist} is automatically buffer-local in
924 all buffers.
925 @end defvar
927 @defvar overriding-local-map
928 If non-@code{nil}, this variable holds a keymap to use instead of the
929 buffer's local keymap, any text property or overlay keymaps, and any
930 minor mode keymaps.  This keymap, if specified, overrides all other
931 maps that would have been active, except for the current global map.
932 @end defvar
934 @defvar overriding-terminal-local-map
935 If non-@code{nil}, this variable holds a keymap to use instead of
936 @code{overriding-local-map}, the buffer's local keymap, text property
937 or overlay keymaps, and all the minor mode keymaps.
939 This variable is always local to the current terminal and cannot be
940 buffer-local.  @xref{Multiple Terminals}.  It is used to implement
941 incremental search mode.
942 @end defvar
944 @defvar overriding-local-map-menu-flag
945 If this variable is non-@code{nil}, the value of
946 @code{overriding-local-map} or @code{overriding-terminal-local-map} can
947 affect the display of the menu bar.  The default value is @code{nil}, so
948 those map variables have no effect on the menu bar.
950 Note that these two map variables do affect the execution of key
951 sequences entered using the menu bar, even if they do not affect the
952 menu bar display.  So if a menu bar key sequence comes in, you should
953 clear the variables before looking up and executing that key sequence.
954 Modes that use the variables would typically do this anyway; normally
955 they respond to events that they do not handle by ``unreading'' them and
956 exiting.
957 @end defvar
959 @defvar special-event-map
960 This variable holds a keymap for special events.  If an event type has a
961 binding in this keymap, then it is special, and the binding for the
962 event is run directly by @code{read-event}.  @xref{Special Events}.
963 @end defvar
965 @defvar emulation-mode-map-alists
966 This variable holds a list of keymap alists to use for emulation
967 modes.  It is intended for modes or packages using multiple minor-mode
968 keymaps.  Each element is a keymap alist which has the same format and
969 meaning as @code{minor-mode-map-alist}, or a symbol with a variable
970 binding which is such an alist.  The active keymaps in each alist
971 are used before @code{minor-mode-map-alist} and
972 @code{minor-mode-overriding-map-alist}.
973 @end defvar
975 @cindex transient keymap
976 @defun set-transient-map keymap &optional keep-pred on-exit
977 This function adds @var{keymap} as a @dfn{transient} keymap, which
978 takes precedence over other keymaps for one (or more) subsequent keys.
980 Normally, @var{keymap} is used just once, to look up the very next key.
981 If the optional argument @var{keep-pred} is @code{t}, the map stays
982 active as long as the user types keys defined in @var{keymap}; when the
983 user types a key that is not in @var{keymap}, the transient keymap is
984 deactivated and normal key lookup continues for that key.
986 The @var{keep-pred} argument can also be a function.  In that case, the
987 function is called with no arguments, prior to running each command,
988 while @var{keymap} is active; it should return non-@code{nil} if
989 @var{keymap} should stay active.
991 The optional argument @var{on-exit}, if non-nil, specifies a function
992 that is called, with no arguments, after @var{keymap} is deactivated.
994 This function works by adding and removing @var{keymap} from the
995 variable @code{overriding-terminal-local-map}, which takes precedence
996 over all other active keymaps (@pxref{Searching Keymaps}).
997 @end defun
999 @node Key Lookup
1000 @section Key Lookup
1001 @cindex key lookup
1002 @cindex keymap entry
1004   @dfn{Key lookup} is the process of finding the binding of a key
1005 sequence from a given keymap.  The execution or use of the binding is
1006 not part of key lookup.
1008   Key lookup uses just the event type of each event in the key sequence;
1009 the rest of the event is ignored.  In fact, a key sequence used for key
1010 lookup may designate a mouse event with just its types (a symbol)
1011 instead of the entire event (a list).  @xref{Input Events}.  Such
1012 a key sequence is insufficient for @code{command-execute} to run,
1013 but it is sufficient for looking up or rebinding a key.
1015   When the key sequence consists of multiple events, key lookup
1016 processes the events sequentially: the binding of the first event is
1017 found, and must be a keymap; then the second event's binding is found in
1018 that keymap, and so on until all the events in the key sequence are used
1019 up.  (The binding thus found for the last event may or may not be a
1020 keymap.)  Thus, the process of key lookup is defined in terms of a
1021 simpler process for looking up a single event in a keymap.  How that is
1022 done depends on the type of object associated with the event in that
1023 keymap.
1025   Let's use the term @dfn{keymap entry} to describe the value found by
1026 looking up an event type in a keymap.  (This doesn't include the item
1027 string and other extra elements in a keymap element for a menu item, because
1028 @code{lookup-key} and other key lookup functions don't include them in
1029 the returned value.)  While any Lisp object may be stored in a keymap
1030 as a keymap entry, not all make sense for key lookup.  Here is a table
1031 of the meaningful types of keymap entries:
1033 @table @asis
1034 @item @code{nil}
1035 @cindex @code{nil} in keymap
1036 @code{nil} means that the events used so far in the lookup form an
1037 undefined key.  When a keymap fails to mention an event type at all, and
1038 has no default binding, that is equivalent to a binding of @code{nil}
1039 for that event type.
1041 @item @var{command}
1042 @cindex command in keymap
1043 The events used so far in the lookup form a complete key,
1044 and @var{command} is its binding.  @xref{What Is a Function}.
1046 @item @var{array}
1047 @cindex string in keymap
1048 The array (either a string or a vector) is a keyboard macro.  The events
1049 used so far in the lookup form a complete key, and the array is its
1050 binding.  See @ref{Keyboard Macros}, for more information.
1052 @item @var{keymap}
1053 @cindex keymap in keymap
1054 The events used so far in the lookup form a prefix key.  The next
1055 event of the key sequence is looked up in @var{keymap}.
1057 @item @var{list}
1058 @cindex list in keymap
1059 The meaning of a list depends on what it contains:
1061 @itemize @bullet
1062 @item
1063 If the @sc{car} of @var{list} is the symbol @code{keymap}, then the list
1064 is a keymap, and is treated as a keymap (see above).
1066 @item
1067 @cindex @code{lambda} in keymap
1068 If the @sc{car} of @var{list} is @code{lambda}, then the list is a
1069 lambda expression.  This is presumed to be a function, and is treated
1070 as such (see above).  In order to execute properly as a key binding,
1071 this function must be a command---it must have an @code{interactive}
1072 specification.  @xref{Defining Commands}.
1073 @end itemize
1075 @item @var{symbol}
1076 @cindex symbol in keymap
1077 The function definition of @var{symbol} is used in place of
1078 @var{symbol}.  If that too is a symbol, then this process is repeated,
1079 any number of times.  Ultimately this should lead to an object that is
1080 a keymap, a command, or a keyboard macro.
1082 Note that keymaps and keyboard macros (strings and vectors) are not
1083 valid functions, so a symbol with a keymap, string, or vector as its
1084 function definition is invalid as a function.  It is, however, valid as
1085 a key binding.  If the definition is a keyboard macro, then the symbol
1086 is also valid as an argument to @code{command-execute}
1087 (@pxref{Interactive Call}).
1089 @cindex @code{undefined} in keymap
1090 The symbol @code{undefined} is worth special mention: it means to treat
1091 the key as undefined.  Strictly speaking, the key is defined, and its
1092 binding is the command @code{undefined}; but that command does the same
1093 thing that is done automatically for an undefined key: it rings the bell
1094 (by calling @code{ding}) but does not signal an error.
1096 @cindex preventing prefix key
1097 @code{undefined} is used in local keymaps to override a global key
1098 binding and make the key undefined locally.  A local binding of
1099 @code{nil} would fail to do this because it would not override the
1100 global binding.
1102 @item @var{anything else}
1103 If any other type of object is found, the events used so far in the
1104 lookup form a complete key, and the object is its binding, but the
1105 binding is not executable as a command.
1106 @end table
1108   In short, a keymap entry may be a keymap, a command, a keyboard
1109 macro, a symbol that leads to one of them, or @code{nil}.
1111 @node Functions for Key Lookup
1112 @section Functions for Key Lookup
1114   Here are the functions and variables pertaining to key lookup.
1116 @defun lookup-key keymap key &optional accept-defaults
1117 This function returns the definition of @var{key} in @var{keymap}.  All
1118 the other functions described in this chapter that look up keys use
1119 @code{lookup-key}.  Here are examples:
1121 @example
1122 @group
1123 (lookup-key (current-global-map) "\C-x\C-f")
1124     @result{} find-file
1125 @end group
1126 @group
1127 (lookup-key (current-global-map) (kbd "C-x C-f"))
1128     @result{} find-file
1129 @end group
1130 @group
1131 (lookup-key (current-global-map) "\C-x\C-f12345")
1132     @result{} 2
1133 @end group
1134 @end example
1136 If the string or vector @var{key} is not a valid key sequence according
1137 to the prefix keys specified in @var{keymap}, it must be too long
1138 and have extra events at the end that do not fit into a single key
1139 sequence.  Then the value is a number, the number of events at the front
1140 of @var{key} that compose a complete key.
1142 @c Emacs 19 feature
1143 If @var{accept-defaults} is non-@code{nil}, then @code{lookup-key}
1144 considers default bindings as well as bindings for the specific events
1145 in @var{key}.  Otherwise, @code{lookup-key} reports only bindings for
1146 the specific sequence @var{key}, ignoring default bindings except when
1147 you explicitly ask about them.  (To do this, supply @code{t} as an
1148 element of @var{key}; see @ref{Format of Keymaps}.)
1150 If @var{key} contains a meta character (not a function key), that
1151 character is implicitly replaced by a two-character sequence: the value
1152 of @code{meta-prefix-char}, followed by the corresponding non-meta
1153 character.  Thus, the first example below is handled by conversion into
1154 the second example.
1156 @example
1157 @group
1158 (lookup-key (current-global-map) "\M-f")
1159     @result{} forward-word
1160 @end group
1161 @group
1162 (lookup-key (current-global-map) "\ef")
1163     @result{} forward-word
1164 @end group
1165 @end example
1167 Unlike @code{read-key-sequence}, this function does not modify the
1168 specified events in ways that discard information (@pxref{Key Sequence
1169 Input}).  In particular, it does not convert letters to lower case and
1170 it does not change drag events to clicks.
1171 @end defun
1173 @deffn Command undefined
1174 Used in keymaps to undefine keys.  It calls @code{ding}, but does
1175 not cause an error.
1176 @end deffn
1178 @defun local-key-binding key &optional accept-defaults
1179 This function returns the binding for @var{key} in the current
1180 local keymap, or @code{nil} if it is undefined there.
1182 @c Emacs 19 feature
1183 The argument @var{accept-defaults} controls checking for default bindings,
1184 as in @code{lookup-key} (above).
1185 @end defun
1187 @defun global-key-binding key &optional accept-defaults
1188 This function returns the binding for command @var{key} in the
1189 current global keymap, or @code{nil} if it is undefined there.
1191 @c Emacs 19 feature
1192 The argument @var{accept-defaults} controls checking for default bindings,
1193 as in @code{lookup-key} (above).
1194 @end defun
1196 @c Emacs 19 feature
1197 @defun minor-mode-key-binding key &optional accept-defaults
1198 This function returns a list of all the active minor mode bindings of
1199 @var{key}.  More precisely, it returns an alist of pairs
1200 @code{(@var{modename} . @var{binding})}, where @var{modename} is the
1201 variable that enables the minor mode, and @var{binding} is @var{key}'s
1202 binding in that mode.  If @var{key} has no minor-mode bindings, the
1203 value is @code{nil}.
1205 If the first binding found is not a prefix definition (a keymap or a
1206 symbol defined as a keymap), all subsequent bindings from other minor
1207 modes are omitted, since they would be completely shadowed.  Similarly,
1208 the list omits non-prefix bindings that follow prefix bindings.
1210 The argument @var{accept-defaults} controls checking for default
1211 bindings, as in @code{lookup-key} (above).
1212 @end defun
1214 @defopt meta-prefix-char
1215 @cindex @key{ESC}
1216 This variable is the meta-prefix character code.  It is used for
1217 translating a meta character to a two-character sequence so it can be
1218 looked up in a keymap.  For useful results, the value should be a
1219 prefix event (@pxref{Prefix Keys}).  The default value is 27, which is
1220 the @acronym{ASCII} code for @key{ESC}.
1222 As long as the value of @code{meta-prefix-char} remains 27, key lookup
1223 translates @kbd{M-b} into @kbd{@key{ESC} b}, which is normally defined
1224 as the @code{backward-word} command.  However, if you were to set
1225 @code{meta-prefix-char} to 24, the code for @kbd{C-x}, then Emacs will
1226 translate @kbd{M-b} into @kbd{C-x b}, whose standard binding is the
1227 @code{switch-to-buffer} command.  (Don't actually do this!)  Here is an
1228 illustration of what would happen:
1230 @smallexample
1231 @group
1232 meta-prefix-char                    ; @r{The default value.}
1233      @result{} 27
1234 @end group
1235 @group
1236 (key-binding "\M-b")
1237      @result{} backward-word
1238 @end group
1239 @group
1240 ?\C-x                               ; @r{The print representation}
1241      @result{} 24                          ;   @r{of a character.}
1242 @end group
1243 @group
1244 (setq meta-prefix-char 24)
1245      @result{} 24
1246 @end group
1247 @group
1248 (key-binding "\M-b")
1249      @result{} switch-to-buffer            ; @r{Now, typing @kbd{M-b} is}
1250                                     ;   @r{like typing @kbd{C-x b}.}
1252 (setq meta-prefix-char 27)          ; @r{Avoid confusion!}
1253      @result{} 27                          ; @r{Restore the default value!}
1254 @end group
1255 @end smallexample
1257 This translation of one event into two happens only for characters, not
1258 for other kinds of input events.  Thus, @kbd{M-@key{F1}}, a function
1259 key, is not converted into @kbd{@key{ESC} @key{F1}}.
1260 @end defopt
1262 @node Changing Key Bindings
1263 @section Changing Key Bindings
1264 @cindex changing key bindings
1265 @cindex rebinding
1267   The way to rebind a key is to change its entry in a keymap.  If you
1268 change a binding in the global keymap, the change is effective in all
1269 buffers (though it has no direct effect in buffers that shadow the
1270 global binding with a local one).  If you change the current buffer's
1271 local map, that usually affects all buffers using the same major mode.
1272 The @code{global-set-key} and @code{local-set-key} functions are
1273 convenient interfaces for these operations (@pxref{Key Binding
1274 Commands}).  You can also use @code{define-key}, a more general
1275 function; then you must explicitly specify the map to change.
1277   When choosing the key sequences for Lisp programs to rebind, please
1278 follow the Emacs conventions for use of various keys (@pxref{Key
1279 Binding Conventions}).
1281 @cindex meta character key constants
1282 @cindex control character key constants
1283   In writing the key sequence to rebind, it is good to use the special
1284 escape sequences for control and meta characters (@pxref{String Type}).
1285 The syntax @samp{\C-} means that the following character is a control
1286 character and @samp{\M-} means that the following character is a meta
1287 character.  Thus, the string @code{"\M-x"} is read as containing a
1288 single @kbd{M-x}, @code{"\C-f"} is read as containing a single
1289 @kbd{C-f}, and @code{"\M-\C-x"} and @code{"\C-\M-x"} are both read as
1290 containing a single @kbd{C-M-x}.  You can also use this escape syntax in
1291 vectors, as well as others that aren't allowed in strings; one example
1292 is @samp{[?\C-\H-x home]}.  @xref{Character Type}.
1294   The key definition and lookup functions accept an alternate syntax for
1295 event types in a key sequence that is a vector: you can use a list
1296 containing modifier names plus one base event (a character or function
1297 key name).  For example, @code{(control ?a)} is equivalent to
1298 @code{?\C-a} and @code{(hyper control left)} is equivalent to
1299 @code{C-H-left}.  One advantage of such lists is that the precise
1300 numeric codes for the modifier bits don't appear in compiled files.
1302   The functions below signal an error if @var{keymap} is not a keymap,
1303 or if @var{key} is not a string or vector representing a key sequence.
1304 You can use event types (symbols) as shorthand for events that are
1305 lists.  The @code{kbd} function (@pxref{Key Sequences}) is a
1306 convenient way to specify the key sequence.
1308 @defun define-key keymap key binding
1309 This function sets the binding for @var{key} in @var{keymap}.  (If
1310 @var{key} is more than one event long, the change is actually made
1311 in another keymap reached from @var{keymap}.)  The argument
1312 @var{binding} can be any Lisp object, but only certain types are
1313 meaningful.  (For a list of meaningful types, see @ref{Key Lookup}.)
1314 The value returned by @code{define-key} is @var{binding}.
1316 If @var{key} is @code{[t]}, this sets the default binding in
1317 @var{keymap}.  When an event has no binding of its own, the Emacs
1318 command loop uses the keymap's default binding, if there is one.
1320 @cindex invalid prefix key error
1321 @cindex key sequence error
1322 Every prefix of @var{key} must be a prefix key (i.e., bound to a keymap)
1323 or undefined; otherwise an error is signaled.  If some prefix of
1324 @var{key} is undefined, then @code{define-key} defines it as a prefix
1325 key so that the rest of @var{key} can be defined as specified.
1327 If there was previously no binding for @var{key} in @var{keymap}, the
1328 new binding is added at the beginning of @var{keymap}.  The order of
1329 bindings in a keymap makes no difference for keyboard input, but it
1330 does matter for menu keymaps (@pxref{Menu Keymaps}).
1331 @end defun
1333   This example creates a sparse keymap and makes a number of
1334 bindings in it:
1336 @smallexample
1337 @group
1338 (setq map (make-sparse-keymap))
1339     @result{} (keymap)
1340 @end group
1341 @group
1342 (define-key map "\C-f" 'forward-char)
1343     @result{} forward-char
1344 @end group
1345 @group
1347     @result{} (keymap (6 . forward-char))
1348 @end group
1350 @group
1351 ;; @r{Build sparse submap for @kbd{C-x} and bind @kbd{f} in that.}
1352 (define-key map (kbd "C-x f") 'forward-word)
1353     @result{} forward-word
1354 @end group
1355 @group
1357 @result{} (keymap
1358     (24 keymap                ; @kbd{C-x}
1359         (102 . forward-word)) ;      @kbd{f}
1360     (6 . forward-char))       ; @kbd{C-f}
1361 @end group
1363 @group
1364 ;; @r{Bind @kbd{C-p} to the @code{ctl-x-map}.}
1365 (define-key map (kbd "C-p") ctl-x-map)
1366 ;; @code{ctl-x-map}
1367 @result{} [nil @dots{} find-file @dots{} backward-kill-sentence]
1368 @end group
1370 @group
1371 ;; @r{Bind @kbd{C-f} to @code{foo} in the @code{ctl-x-map}.}
1372 (define-key map (kbd "C-p C-f") 'foo)
1373 @result{} 'foo
1374 @end group
1375 @group
1377 @result{} (keymap     ; @r{Note @code{foo} in @code{ctl-x-map}.}
1378     (16 keymap [nil @dots{} foo @dots{} backward-kill-sentence])
1379     (24 keymap
1380         (102 . forward-word))
1381     (6 . forward-char))
1382 @end group
1383 @end smallexample
1385 @noindent
1386 Note that storing a new binding for @kbd{C-p C-f} actually works by
1387 changing an entry in @code{ctl-x-map}, and this has the effect of
1388 changing the bindings of both @kbd{C-p C-f} and @kbd{C-x C-f} in the
1389 default global map.
1391   The function @code{substitute-key-definition} scans a keymap for
1392 keys that have a certain binding and rebinds them with a different
1393 binding.  Another feature which is cleaner and can often produce the
1394 same results is to remap one command into another (@pxref{Remapping
1395 Commands}).
1397 @defun substitute-key-definition olddef newdef keymap &optional oldmap
1398 @cindex replace bindings
1399 This function replaces @var{olddef} with @var{newdef} for any keys in
1400 @var{keymap} that were bound to @var{olddef}.  In other words,
1401 @var{olddef} is replaced with @var{newdef} wherever it appears.  The
1402 function returns @code{nil}.
1404 For example, this redefines @kbd{C-x C-f}, if you do it in an Emacs with
1405 standard bindings:
1407 @smallexample
1408 @group
1409 (substitute-key-definition
1410  'find-file 'find-file-read-only (current-global-map))
1411 @end group
1412 @end smallexample
1414 @c Emacs 19 feature
1415 If @var{oldmap} is non-@code{nil}, that changes the behavior of
1416 @code{substitute-key-definition}: the bindings in @var{oldmap} determine
1417 which keys to rebind.  The rebindings still happen in @var{keymap}, not
1418 in @var{oldmap}.  Thus, you can change one map under the control of the
1419 bindings in another.  For example,
1421 @smallexample
1422 (substitute-key-definition
1423   'delete-backward-char 'my-funny-delete
1424   my-map global-map)
1425 @end smallexample
1427 @noindent
1428 puts the special deletion command in @code{my-map} for whichever keys
1429 are globally bound to the standard deletion command.
1431 Here is an example showing a keymap before and after substitution:
1433 @smallexample
1434 @group
1435 (setq map '(keymap
1436             (?1 . olddef-1)
1437             (?2 . olddef-2)
1438             (?3 . olddef-1)))
1439 @result{} (keymap (49 . olddef-1) (50 . olddef-2) (51 . olddef-1))
1440 @end group
1442 @group
1443 (substitute-key-definition 'olddef-1 'newdef map)
1444 @result{} nil
1445 @end group
1446 @group
1448 @result{} (keymap (49 . newdef) (50 . olddef-2) (51 . newdef))
1449 @end group
1450 @end smallexample
1451 @end defun
1453 @defun suppress-keymap keymap &optional nodigits
1454 @cindex @code{self-insert-command} override
1455 This function changes the contents of the full keymap @var{keymap} by
1456 remapping @code{self-insert-command} to the command @code{undefined}
1457 (@pxref{Remapping Commands}).  This has the effect of undefining all
1458 printing characters, thus making ordinary insertion of text impossible.
1459 @code{suppress-keymap} returns @code{nil}.
1461 If @var{nodigits} is @code{nil}, then @code{suppress-keymap} defines
1462 digits to run @code{digit-argument}, and @kbd{-} to run
1463 @code{negative-argument}.  Otherwise it makes them undefined like the
1464 rest of the printing characters.
1466 @cindex yank suppression
1467 @cindex @code{quoted-insert} suppression
1468 The @code{suppress-keymap} function does not make it impossible to
1469 modify a buffer, as it does not suppress commands such as @code{yank}
1470 and @code{quoted-insert}.  To prevent any modification of a buffer, make
1471 it read-only (@pxref{Read Only Buffers}).
1473 Since this function modifies @var{keymap}, you would normally use it
1474 on a newly created keymap.  Operating on an existing keymap
1475 that is used for some other purpose is likely to cause trouble; for
1476 example, suppressing @code{global-map} would make it impossible to use
1477 most of Emacs.
1479 This function can be used to initialize the local keymap of a major
1480 mode for which insertion of text is not desirable.  But usually such a
1481 mode should be derived from @code{special-mode} (@pxref{Basic Major
1482 Modes}); then its keymap will automatically inherit from
1483 @code{special-mode-map}, which is already suppressed.  Here is how
1484 @code{special-mode-map} is defined:
1486 @smallexample
1487 @group
1488 (defvar special-mode-map
1489   (let ((map (make-sparse-keymap)))
1490     (suppress-keymap map)
1491     (define-key map "q" 'quit-window)
1492     @dots{}
1493     map))
1494 @end group
1495 @end smallexample
1496 @end defun
1498 @node Remapping Commands
1499 @section Remapping Commands
1500 @cindex remapping commands
1502   A special kind of key binding can be used to @dfn{remap} one command
1503 to another, without having to refer to the key sequence(s) bound to
1504 the original command.  To use this feature, make a key binding for a
1505 key sequence that starts with the dummy event @code{remap}, followed
1506 by the command name you want to remap; for the binding, specify the
1507 new definition (usually a command name, but possibly any other valid
1508 definition for a key binding).
1510   For example, suppose My mode provides a special command
1511 @code{my-kill-line}, which should be invoked instead of
1512 @code{kill-line}.  To establish this, its mode keymap should contain
1513 the following remapping:
1515 @smallexample
1516 (define-key my-mode-map [remap kill-line] 'my-kill-line)
1517 @end smallexample
1519 @noindent
1520 Then, whenever @code{my-mode-map} is active, if the user types
1521 @kbd{C-k} (the default global key sequence for @code{kill-line}) Emacs
1522 will instead run @code{my-kill-line}.
1524   Note that remapping only takes place through active keymaps; for
1525 example, putting a remapping in a prefix keymap like @code{ctl-x-map}
1526 typically has no effect, as such keymaps are not themselves active.
1527 In addition, remapping only works through a single level; in the
1528 following example,
1530 @smallexample
1531 (define-key my-mode-map [remap kill-line] 'my-kill-line)
1532 (define-key my-mode-map [remap my-kill-line] 'my-other-kill-line)
1533 @end smallexample
1535 @noindent
1536 @code{kill-line} is @emph{not} remapped to @code{my-other-kill-line}.
1537 Instead, if an ordinary key binding specifies @code{kill-line}, it is
1538 remapped to @code{my-kill-line}; if an ordinary binding specifies
1539 @code{my-kill-line}, it is remapped to @code{my-other-kill-line}.
1541 To undo the remapping of a command, remap it to @code{nil}; e.g.,
1543 @smallexample
1544 (define-key my-mode-map [remap kill-line] nil)
1545 @end smallexample
1547 @defun command-remapping command &optional position keymaps
1548 This function returns the remapping for @var{command} (a symbol),
1549 given the current active keymaps.  If @var{command} is not remapped
1550 (which is the usual situation), or not a symbol, the function returns
1551 @code{nil}.  @code{position} can optionally specify a buffer position
1552 or an event position to determine the keymaps to use, as in
1553 @code{key-binding}.
1555 If the optional argument @code{keymaps} is non-@code{nil}, it
1556 specifies a list of keymaps to search in.  This argument is ignored if
1557 @code{position} is non-@code{nil}.
1558 @end defun
1560 @node Translation Keymaps
1561 @section Keymaps for Translating Sequences of Events
1562 @cindex translation keymap
1563 @cindex keymaps for translating events
1565   When the @code{read-key-sequence} function reads a key sequence
1566 (@pxref{Key Sequence Input}), it uses @dfn{translation keymaps} to
1567 translate certain event sequences into others.  The translation
1568 keymaps are @code{input-decode-map}, @code{local-function-key-map},
1569 and @code{key-translation-map} (in order of priority).
1571   Translation keymaps have the same structure as other keymaps, but
1572 are used differently: they specify translations to make while reading
1573 key sequences, rather than bindings for complete key sequences.  As
1574 each key sequence is read, it is checked against each translation
1575 keymap.  If one of the translation keymaps binds @var{k} to a
1576 vector @var{v}, then whenever @var{k} appears as a sub-sequence
1577 @emph{anywhere} in a key sequence, that sub-sequence is replaced with
1578 the events in @var{v}.
1580   For example, VT100 terminals send @kbd{@key{ESC} O P} when the
1581 keypad key @key{PF1} is pressed.  On such terminals, Emacs must
1582 translate that sequence of events into a single event @code{pf1}.
1583 This is done by binding @kbd{@key{ESC} O P} to @code{[pf1]} in
1584 @code{input-decode-map}.  Thus, when you type @kbd{C-c @key{PF1}} on
1585 the terminal, the terminal emits the character sequence @kbd{C-c
1586 @key{ESC} O P}, and @code{read-key-sequence} translates this back into
1587 @kbd{C-c @key{PF1}} and returns it as the vector @code{[?\C-c pf1]}.
1589   Translation keymaps take effect only after Emacs has decoded the
1590 keyboard input (via the input coding system specified by
1591 @code{keyboard-coding-system}).  @xref{Terminal I/O Encoding}.
1593 @defvar input-decode-map
1594 This variable holds a keymap that describes the character sequences sent
1595 by function keys on an ordinary character terminal.
1597 The value of @code{input-decode-map} is usually set up automatically
1598 according to the terminal's Terminfo or Termcap entry, but sometimes
1599 those need help from terminal-specific Lisp files.  Emacs comes with
1600 terminal-specific files for many common terminals; their main purpose is
1601 to make entries in @code{input-decode-map} beyond those that can be
1602 deduced from Termcap and Terminfo.  @xref{Terminal-Specific}.
1603 @end defvar
1605 @defvar local-function-key-map
1606 This variable holds a keymap similar to @code{input-decode-map} except
1607 that it describes key sequences which should be translated to
1608 alternative interpretations that are usually preferred.  It applies
1609 after @code{input-decode-map} and before @code{key-translation-map}.
1611 Entries in @code{local-function-key-map} are ignored if they conflict
1612 with bindings made in the minor mode, local, or global keymaps.  I.e.,
1613 the remapping only applies if the original key sequence would
1614 otherwise not have any binding.
1616 @code{local-function-key-map} inherits from @code{function-key-map},
1617 but the latter should not be used directly.
1618 @end defvar
1620 @defvar key-translation-map
1621 This variable is another keymap used just like @code{input-decode-map}
1622 to translate input events into other events.  It differs from
1623 @code{input-decode-map} in that it goes to work after
1624 @code{local-function-key-map} is finished rather than before; it
1625 receives the results of translation by @code{local-function-key-map}.
1627 Just like @code{input-decode-map}, but unlike
1628 @code{local-function-key-map}, this keymap is applied regardless of
1629 whether the input key-sequence has a normal binding.  Note however
1630 that actual key bindings can have an effect on
1631 @code{key-translation-map}, even though they are overridden by it.
1632 Indeed, actual key bindings override @code{local-function-key-map} and
1633 thus may alter the key sequence that @code{key-translation-map}
1634 receives.  Clearly, it is better to avoid this type of situation.
1636 The intent of @code{key-translation-map} is for users to map one
1637 character set to another, including ordinary characters normally bound
1638 to @code{self-insert-command}.
1639 @end defvar
1641 @cindex key translation function
1642 You can use @code{input-decode-map}, @code{local-function-key-map},
1643 and @code{key-translation-map} for more than simple aliases, by using
1644 a function, instead of a key sequence, as the translation of a
1645 key.  Then this function is called to compute the translation of that
1646 key.
1648 The key translation function receives one argument, which is the prompt
1649 that was specified in @code{read-key-sequence}---or @code{nil} if the
1650 key sequence is being read by the editor command loop.  In most cases
1651 you can ignore the prompt value.
1653 If the function reads input itself, it can have the effect of altering
1654 the event that follows.  For example, here's how to define @kbd{C-c h}
1655 to turn the character that follows into a Hyper character:
1657 @example
1658 @group
1659 (defun hyperify (prompt)
1660   (let ((e (read-event)))
1661     (vector (if (numberp e)
1662                 (logior (lsh 1 24) e)
1663               (if (memq 'hyper (event-modifiers e))
1664                   e
1665                 (add-event-modifier "H-" e))))))
1667 (defun add-event-modifier (string e)
1668   (let ((symbol (if (symbolp e) e (car e))))
1669     (setq symbol (intern (concat string
1670                                  (symbol-name symbol))))
1671     (if (symbolp e)
1672         symbol
1673       (cons symbol (cdr e)))))
1675 (define-key local-function-key-map "\C-ch" 'hyperify)
1676 @end group
1677 @end example
1679 @subsection Interaction with normal keymaps
1681 The end of a key sequence is detected when that key sequence either is bound
1682 to a command, or when Emacs determines that no additional event can lead
1683 to a sequence that is bound to a command.
1685 This means that, while @code{input-decode-map} and @code{key-translation-map}
1686 apply regardless of whether the original key sequence would have a binding, the
1687 presence of such a binding can still prevent translation from taking place.
1688 For example, let us return to our VT100 example above and add a binding for
1689 @kbd{C-c @key{ESC}} to the global map; now when the user hits @kbd{C-c
1690 @key{PF1}} Emacs will fail to decode @kbd{C-c @key{ESC} O P} into @kbd{C-c
1691 @key{PF1}} because it will stop reading keys right after @kbd{C-x @key{ESC}},
1692 leaving @kbd{O P} for later.  This is in case the user really hit @kbd{C-c
1693 @key{ESC}}, in which case Emacs should not sit there waiting for the next key
1694 to decide whether the user really pressed @kbd{@key{ESC}} or @kbd{@key{PF1}}.
1696 For that reason, it is better to avoid binding commands to key sequences where
1697 the end of the key sequence is a prefix of a key translation.  The main such
1698 problematic suffixes/prefixes are @kbd{@key{ESC}}, @kbd{M-O} (which is really
1699 @kbd{@key{ESC} O}) and @kbd{M-[} (which is really @kbd{@key{ESC} [}).
1701 @node Key Binding Commands
1702 @section Commands for Binding Keys
1704   This section describes some convenient interactive interfaces for
1705 changing key bindings.  They work by calling @code{define-key}.
1707   People often use @code{global-set-key} in their init files
1708 (@pxref{Init File}) for simple customization.  For example,
1710 @smallexample
1711 (global-set-key (kbd "C-x C-\\") 'next-line)
1712 @end smallexample
1714 @noindent
1717 @smallexample
1718 (global-set-key [?\C-x ?\C-\\] 'next-line)
1719 @end smallexample
1721 @noindent
1724 @smallexample
1725 (global-set-key [(control ?x) (control ?\\)] 'next-line)
1726 @end smallexample
1728 @noindent
1729 redefines @kbd{C-x C-\} to move down a line.
1731 @smallexample
1732 (global-set-key [M-mouse-1] 'mouse-set-point)
1733 @end smallexample
1735 @noindent
1736 redefines the first (leftmost) mouse button, entered with the Meta key, to
1737 set point where you click.
1739 @cindex non-@acronym{ASCII} text in keybindings
1740   Be careful when using non-@acronym{ASCII} text characters in Lisp
1741 specifications of keys to bind.  If these are read as multibyte text, as
1742 they usually will be in a Lisp file (@pxref{Loading Non-ASCII}), you
1743 must type the keys as multibyte too.  For instance, if you use this:
1745 @smallexample
1746 (global-set-key "ö" 'my-function) ; bind o-umlaut
1747 @end smallexample
1749 @noindent
1752 @smallexample
1753 (global-set-key ?ö 'my-function) ; bind o-umlaut
1754 @end smallexample
1756 @noindent
1757 and your language environment is multibyte Latin-1, these commands
1758 actually bind the multibyte character with code 246, not the byte
1759 code 246 (@kbd{M-v}) sent by a Latin-1 terminal.  In order to use this
1760 binding, you need to teach Emacs how to decode the keyboard by using an
1761 appropriate input method (@pxref{Input Methods, , Input Methods, emacs, The GNU
1762 Emacs Manual}).
1764 @deffn Command global-set-key key binding
1765 This function sets the binding of @var{key} in the current global map
1766 to @var{binding}.
1768 @smallexample
1769 @group
1770 (global-set-key @var{key} @var{binding})
1771 @equiv{}
1772 (define-key (current-global-map) @var{key} @var{binding})
1773 @end group
1774 @end smallexample
1775 @end deffn
1777 @deffn Command global-unset-key key
1778 @cindex unbinding keys
1779 This function removes the binding of @var{key} from the current
1780 global map.
1782 One use of this function is in preparation for defining a longer key
1783 that uses @var{key} as a prefix---which would not be allowed if
1784 @var{key} has a non-prefix binding.  For example:
1786 @smallexample
1787 @group
1788 (global-unset-key "\C-l")
1789     @result{} nil
1790 @end group
1791 @group
1792 (global-set-key "\C-l\C-l" 'redraw-display)
1793     @result{} nil
1794 @end group
1795 @end smallexample
1797 This function is equivalent to using @code{define-key} as follows:
1799 @smallexample
1800 @group
1801 (global-unset-key @var{key})
1802 @equiv{}
1803 (define-key (current-global-map) @var{key} nil)
1804 @end group
1805 @end smallexample
1806 @end deffn
1808 @deffn Command local-set-key key binding
1809 This function sets the binding of @var{key} in the current local
1810 keymap to @var{binding}.
1812 @smallexample
1813 @group
1814 (local-set-key @var{key} @var{binding})
1815 @equiv{}
1816 (define-key (current-local-map) @var{key} @var{binding})
1817 @end group
1818 @end smallexample
1819 @end deffn
1821 @deffn Command local-unset-key key
1822 This function removes the binding of @var{key} from the current
1823 local map.
1825 @smallexample
1826 @group
1827 (local-unset-key @var{key})
1828 @equiv{}
1829 (define-key (current-local-map) @var{key} nil)
1830 @end group
1831 @end smallexample
1832 @end deffn
1834 @node Scanning Keymaps
1835 @section Scanning Keymaps
1836 @cindex scanning keymaps
1837 @cindex keymaps, scanning
1839   This section describes functions used to scan all the current keymaps
1840 for the sake of printing help information.
1842 @defun accessible-keymaps keymap &optional prefix
1843 This function returns a list of all the keymaps that can be reached (via
1844 zero or more prefix keys) from @var{keymap}.  The value is an
1845 association list with elements of the form @code{(@var{key} .@:
1846 @var{map})}, where @var{key} is a prefix key whose definition in
1847 @var{keymap} is @var{map}.
1849 The elements of the alist are ordered so that the @var{key} increases
1850 in length.  The first element is always @code{([] .@: @var{keymap})},
1851 because the specified keymap is accessible from itself with a prefix of
1852 no events.
1854 If @var{prefix} is given, it should be a prefix key sequence; then
1855 @code{accessible-keymaps} includes only the submaps whose prefixes start
1856 with @var{prefix}.  These elements look just as they do in the value of
1857 @code{(accessible-keymaps)}; the only difference is that some elements
1858 are omitted.
1860 In the example below, the returned alist indicates that the key
1861 @key{ESC}, which is displayed as @samp{^[}, is a prefix key whose
1862 definition is the sparse keymap @code{(keymap (83 .@: center-paragraph)
1863 (115 .@: foo))}.
1865 @smallexample
1866 @group
1867 (accessible-keymaps (current-local-map))
1868 @result{}(([] keymap
1869       (27 keymap   ; @r{Note this keymap for @key{ESC} is repeated below.}
1870           (83 . center-paragraph)
1871           (115 . center-line))
1872       (9 . tab-to-tab-stop))
1873 @end group
1875 @group
1876    ("^[" keymap
1877     (83 . center-paragraph)
1878     (115 . foo)))
1879 @end group
1880 @end smallexample
1882 In the following example, @kbd{C-h} is a prefix key that uses a sparse
1883 keymap starting with @code{(keymap (118 . describe-variable)@dots{})}.
1884 Another prefix, @kbd{C-x 4}, uses a keymap which is also the value of
1885 the variable @code{ctl-x-4-map}.  The event @code{mode-line} is one of
1886 several dummy events used as prefixes for mouse actions in special parts
1887 of a window.
1889 @smallexample
1890 @group
1891 (accessible-keymaps (current-global-map))
1892 @result{} (([] keymap [set-mark-command beginning-of-line @dots{}
1893                    delete-backward-char])
1894 @end group
1895 @group
1896     ("^H" keymap (118 . describe-variable) @dots{}
1897      (8 . help-for-help))
1898 @end group
1899 @group
1900     ("^X" keymap [x-flush-mouse-queue @dots{}
1901      backward-kill-sentence])
1902 @end group
1903 @group
1904     ("^[" keymap [mark-sexp backward-sexp @dots{}
1905      backward-kill-word])
1906 @end group
1907     ("^X4" keymap (15 . display-buffer) @dots{})
1908 @group
1909     ([mode-line] keymap
1910      (S-mouse-2 . mouse-split-window-horizontally) @dots{}))
1911 @end group
1912 @end smallexample
1914 @noindent
1915 These are not all the keymaps you would see in actuality.
1916 @end defun
1918 @defun map-keymap function keymap
1919 The function @code{map-keymap} calls @var{function} once
1920 for each binding in @var{keymap}.  It passes two arguments,
1921 the event type and the value of the binding.  If @var{keymap}
1922 has a parent, the parent's bindings are included as well.
1923 This works recursively: if the parent has itself a parent, then the
1924 grandparent's bindings are also included and so on.
1926 This function is the cleanest way to examine all the bindings
1927 in a keymap.
1928 @end defun
1930 @defun where-is-internal command &optional keymap firstonly noindirect no-remap
1931 This function is a subroutine used by the @code{where-is} command
1932 (@pxref{Help, , Help, emacs,The GNU Emacs Manual}).  It returns a list
1933 of all key sequences (of any length) that are bound to @var{command} in a
1934 set of keymaps.
1936 The argument @var{command} can be any object; it is compared with all
1937 keymap entries using @code{eq}.
1939 If @var{keymap} is @code{nil}, then the maps used are the current active
1940 keymaps, disregarding @code{overriding-local-map} (that is, pretending
1941 its value is @code{nil}).  If @var{keymap} is a keymap, then the
1942 maps searched are @var{keymap} and the global keymap.  If @var{keymap}
1943 is a list of keymaps, only those keymaps are searched.
1945 Usually it's best to use @code{overriding-local-map} as the expression
1946 for @var{keymap}.  Then @code{where-is-internal} searches precisely
1947 the keymaps that are active.  To search only the global map, pass the
1948 value @code{(keymap)} (an empty keymap) as @var{keymap}.
1950 If @var{firstonly} is @code{non-ascii}, then the value is a single
1951 vector representing the first key sequence found, rather than a list of
1952 all possible key sequences.  If @var{firstonly} is @code{t}, then the
1953 value is the first key sequence, except that key sequences consisting
1954 entirely of @acronym{ASCII} characters (or meta variants of @acronym{ASCII}
1955 characters) are preferred to all other key sequences and that the
1956 return value can never be a menu binding.
1958 If @var{noindirect} is non-@code{nil}, @code{where-is-internal} doesn't look
1959 inside menu-items to find their commands.  This makes it possible to search for
1960 a menu-item itself.
1962 The fifth argument, @var{no-remap}, determines how this function
1963 treats command remappings (@pxref{Remapping Commands}).  There are two
1964 cases of interest:
1966 @table @asis
1967 @item If a command @var{other-command} is remapped to @var{command}:
1968 If @var{no-remap} is @code{nil}, find the bindings for
1969 @var{other-command} and treat them as though they are also bindings
1970 for @var{command}.  If @var{no-remap} is non-@code{nil}, include the
1971 vector @code{[remap @var{other-command}]} in the list of possible key
1972 sequences, instead of finding those bindings.
1974 @item If @var{command} is remapped to @var{other-command}:
1975 If @var{no-remap} is @code{nil}, return the bindings for
1976 @var{other-command} rather than @var{command}.  If @var{no-remap} is
1977 non-@code{nil}, return the bindings for @var{command}, ignoring the
1978 fact that it is remapped.
1979 @end table
1980 @end defun
1982 @deffn Command describe-bindings &optional prefix buffer-or-name
1983 This function creates a listing of all current key bindings, and
1984 displays it in a buffer named @file{*Help*}.  The text is grouped by
1985 modes---minor modes first, then the major mode, then global bindings.
1987 If @var{prefix} is non-@code{nil}, it should be a prefix key; then the
1988 listing includes only keys that start with @var{prefix}.
1990 When several characters with consecutive @acronym{ASCII} codes have the
1991 same definition, they are shown together, as
1992 @samp{@var{firstchar}..@var{lastchar}}.  In this instance, you need to
1993 know the @acronym{ASCII} codes to understand which characters this means.
1994 For example, in the default global map, the characters @samp{@key{SPC}
1995 ..@: ~} are described by a single line.  @key{SPC} is @acronym{ASCII} 32,
1996 @kbd{~} is @acronym{ASCII} 126, and the characters between them include all
1997 the normal printing characters, (e.g., letters, digits, punctuation,
1998 etc.@:); all these characters are bound to @code{self-insert-command}.
2000 If @var{buffer-or-name} is non-@code{nil}, it should be a buffer or a
2001 buffer name.  Then @code{describe-bindings} lists that buffer's bindings,
2002 instead of the current buffer's.
2003 @end deffn
2005 @node Menu Keymaps
2006 @section Menu Keymaps
2007 @cindex menu keymaps
2009 A keymap can operate as a menu as well as defining bindings for
2010 keyboard keys and mouse buttons.  Menus are usually actuated with the
2011 mouse, but they can function with the keyboard also.  If a menu keymap
2012 is active for the next input event, that activates the keyboard menu
2013 feature.
2015 @menu
2016 * Defining Menus::     How to make a keymap that defines a menu.
2017 * Mouse Menus::        How users actuate the menu with the mouse.
2018 * Keyboard Menus::     How users actuate the menu with the keyboard.
2019 * Menu Example::       Making a simple menu.
2020 * Menu Bar::           How to customize the menu bar.
2021 * Tool Bar::           A tool bar is a row of images.
2022 * Modifying Menus::    How to add new items to a menu.
2023 * Easy Menu::      A convenience macro for making menus.
2024 @end menu
2026 @node Defining Menus
2027 @subsection Defining Menus
2028 @cindex defining menus
2029 @cindex menu prompt string
2030 @cindex prompt string (of menu)
2031 @cindex menu item
2033 A keymap acts as a menu if it has an @dfn{overall prompt string},
2034 which is a string that appears as an element of the keymap.
2035 (@xref{Format of Keymaps}.)  The string should describe the purpose of
2036 the menu's commands.  Emacs displays the overall prompt string as the
2037 menu title in some cases, depending on the toolkit (if any) used for
2038 displaying menus.@footnote{It is required for menus which do not use a
2039 toolkit, e.g., on a text terminal.}  Keyboard menus also display the
2040 overall prompt string.
2042 The easiest way to construct a keymap with a prompt string is to
2043 specify the string as an argument when you call @code{make-keymap},
2044 @code{make-sparse-keymap} (@pxref{Creating Keymaps}), or
2045 @code{define-prefix-command} (@pxref{Definition of
2046 define-prefix-command}).  If you do not want the keymap to operate as
2047 a menu, don't specify a prompt string for it.
2049 @defun keymap-prompt keymap
2050 This function returns the overall prompt string of @var{keymap},
2051 or @code{nil} if it has none.
2052 @end defun
2054 The menu's items are the bindings in the keymap.  Each binding
2055 associates an event type to a definition, but the event types have no
2056 significance for the menu appearance.  (Usually we use pseudo-events,
2057 symbols that the keyboard cannot generate, as the event types for menu
2058 item bindings.)  The menu is generated entirely from the bindings that
2059 correspond in the keymap to these events.
2061 The order of items in the menu is the same as the order of bindings in
2062 the keymap.  Since @code{define-key} puts new bindings at the front, you
2063 should define the menu items starting at the bottom of the menu and
2064 moving to the top, if you care about the order.  When you add an item to
2065 an existing menu, you can specify its position in the menu using
2066 @code{define-key-after} (@pxref{Modifying Menus}).
2068 @menu
2069 * Simple Menu Items::       A simple kind of menu key binding.
2070 * Extended Menu Items::     More complex menu item definitions.
2071 * Menu Separators::         Drawing a horizontal line through a menu.
2072 * Alias Menu Items::        Using command aliases in menu items.
2073 @end menu
2075 @node Simple Menu Items
2076 @subsubsection Simple Menu Items
2078   The simpler (and original) way to define a menu item is to bind some
2079 event type (it doesn't matter what event type) to a binding like this:
2081 @example
2082 (@var{item-string} . @var{real-binding})
2083 @end example
2085 @noindent
2086 The @sc{car}, @var{item-string}, is the string to be displayed in the
2087 menu.  It should be short---preferably one to three words.  It should
2088 describe the action of the command it corresponds to.  Note that not
2089 all graphical toolkits can display non-@acronym{ASCII} text in menus
2090 (it will work for keyboard menus and will work to a large extent with
2091 the GTK+ toolkit).
2093   You can also supply a second string, called the help string, as follows:
2095 @example
2096 (@var{item-string} @var{help} . @var{real-binding})
2097 @end example
2099 @noindent
2100 @var{help} specifies a help-echo string to display while the mouse
2101 is on that item in the same way as @code{help-echo} text properties
2102 (@pxref{Help display}).
2104   As far as @code{define-key} is concerned, @var{item-string} and
2105 @var{help-string} are part of the event's binding.  However,
2106 @code{lookup-key} returns just @var{real-binding}, and only
2107 @var{real-binding} is used for executing the key.
2109   If @var{real-binding} is @code{nil}, then @var{item-string} appears in
2110 the menu but cannot be selected.
2112   If @var{real-binding} is a symbol and has a non-@code{nil}
2113 @code{menu-enable} property, that property is an expression that
2114 controls whether the menu item is enabled.  Every time the keymap is
2115 used to display a menu, Emacs evaluates the expression, and it enables
2116 the menu item only if the expression's value is non-@code{nil}.  When a
2117 menu item is disabled, it is displayed in a fuzzy fashion, and
2118 cannot be selected.
2120   The menu bar does not recalculate which items are enabled every time you
2121 look at a menu.  This is because the X toolkit requires the whole tree
2122 of menus in advance.  To force recalculation of the menu bar, call
2123 @code{force-mode-line-update} (@pxref{Mode Line Format}).
2125 @node Extended Menu Items
2126 @subsubsection Extended Menu Items
2127 @kindex menu-item
2128 @cindex extended menu item
2130   An extended-format menu item is a more flexible and also cleaner
2131 alternative to the simple format.  You define an event type with a
2132 binding that's a list starting with the symbol @code{menu-item}.
2133 For a non-selectable string, the binding looks like this:
2135 @example
2136 (menu-item @var{item-name})
2137 @end example
2139 @noindent
2140 A string starting with two or more dashes specifies a separator line;
2141 see @ref{Menu Separators}.
2143   To define a real menu item which can be selected, the extended format
2144 binding looks like this:
2146 @example
2147 (menu-item @var{item-name} @var{real-binding}
2148     . @var{item-property-list})
2149 @end example
2151 @noindent
2152 Here, @var{item-name} is an expression which evaluates to the menu item
2153 string.  Thus, the string need not be a constant.  The third element,
2154 @var{real-binding}, is the command to execute.  The tail of the list,
2155 @var{item-property-list}, has the form of a property list which contains
2156 other information.
2158   Here is a table of the properties that are supported:
2160 @table @code
2161 @item :enable @var{form}
2162 The result of evaluating @var{form} determines whether the item is
2163 enabled (non-@code{nil} means yes).  If the item is not enabled,
2164 you can't really click on it.
2166 @item :visible @var{form}
2167 The result of evaluating @var{form} determines whether the item should
2168 actually appear in the menu (non-@code{nil} means yes).  If the item
2169 does not appear, then the menu is displayed as if this item were
2170 not defined at all.
2172 @item :help @var{help}
2173 The value of this property, @var{help}, specifies a help-echo string
2174 to display while the mouse is on that item.  This is displayed in the
2175 same way as @code{help-echo} text properties (@pxref{Help display}).
2176 Note that this must be a constant string, unlike the @code{help-echo}
2177 property for text and overlays.
2179 @item :button (@var{type} . @var{selected})
2180 This property provides a way to define radio buttons and toggle buttons.
2181 The @sc{car}, @var{type}, says which: it should be @code{:toggle} or
2182 @code{:radio}.  The @sc{cdr}, @var{selected}, should be a form; the
2183 result of evaluating it says whether this button is currently selected.
2185 A @dfn{toggle} is a menu item which is labeled as either on or off
2186 according to the value of @var{selected}.  The command itself should
2187 toggle @var{selected}, setting it to @code{t} if it is @code{nil},
2188 and to @code{nil} if it is @code{t}.  Here is how the menu item
2189 to toggle the @code{debug-on-error} flag is defined:
2191 @example
2192 (menu-item "Debug on Error" toggle-debug-on-error
2193            :button (:toggle
2194                     . (and (boundp 'debug-on-error)
2195                            debug-on-error)))
2196 @end example
2198 @noindent
2199 This works because @code{toggle-debug-on-error} is defined as a command
2200 which toggles the variable @code{debug-on-error}.
2202 @dfn{Radio buttons} are a group of menu items, in which at any time one
2203 and only one is selected.  There should be a variable whose value
2204 says which one is selected at any time.  The @var{selected} form for
2205 each radio button in the group should check whether the variable has the
2206 right value for selecting that button.  Clicking on the button should
2207 set the variable so that the button you clicked on becomes selected.
2209 @item :key-sequence @var{key-sequence}
2210 This property specifies which key sequence is likely to be bound to the
2211 same command invoked by this menu item.  If you specify the right key
2212 sequence, that makes preparing the menu for display run much faster.
2214 If you specify the wrong key sequence, it has no effect; before Emacs
2215 displays @var{key-sequence} in the menu, it verifies that
2216 @var{key-sequence} is really equivalent to this menu item.
2218 @item :key-sequence nil
2219 This property indicates that there is normally no key binding which is
2220 equivalent to this menu item.  Using this property saves time in
2221 preparing the menu for display, because Emacs does not need to search
2222 the keymaps for a keyboard equivalent for this menu item.
2224 However, if the user has rebound this item's definition to a key
2225 sequence, Emacs ignores the @code{:keys} property and finds the keyboard
2226 equivalent anyway.
2228 @item :keys @var{string}
2229 This property specifies that @var{string} is the string to display
2230 as the keyboard equivalent for this menu item.  You can use
2231 the @samp{\\[...]} documentation construct in @var{string}.
2233 @item :filter @var{filter-fn}
2234 This property provides a way to compute the menu item dynamically.
2235 The property value @var{filter-fn} should be a function of one argument;
2236 when it is called, its argument will be @var{real-binding}.  The
2237 function should return the binding to use instead.
2239 Emacs can call this function at any time that it does redisplay or
2240 operates on menu data structures, so you should write it so it can
2241 safely be called at any time.
2242 @end table
2244 @node Menu Separators
2245 @subsubsection Menu Separators
2246 @cindex menu separators
2248   A menu separator is a kind of menu item that doesn't display any
2249 text---instead, it divides the menu into subparts with a horizontal line.
2250 A separator looks like this in the menu keymap:
2252 @example
2253 (menu-item @var{separator-type})
2254 @end example
2256 @noindent
2257 where @var{separator-type} is a string starting with two or more dashes.
2259   In the simplest case, @var{separator-type} consists of only dashes.
2260 That specifies the default kind of separator.  (For compatibility,
2261 @code{""} and @code{-} also count as separators.)
2263   Certain other values of @var{separator-type} specify a different
2264 style of separator.  Here is a table of them:
2266 @table @code
2267 @item "--no-line"
2268 @itemx "--space"
2269 An extra vertical space, with no actual line.
2271 @item "--single-line"
2272 A single line in the menu's foreground color.
2274 @item "--double-line"
2275 A double line in the menu's foreground color.
2277 @item "--single-dashed-line"
2278 A single dashed line in the menu's foreground color.
2280 @item "--double-dashed-line"
2281 A double dashed line in the menu's foreground color.
2283 @item "--shadow-etched-in"
2284 A single line with a 3D sunken appearance.  This is the default,
2285 used separators consisting of dashes only.
2287 @item "--shadow-etched-out"
2288 A single line with a 3D raised appearance.
2290 @item "--shadow-etched-in-dash"
2291 A single dashed line with a 3D sunken appearance.
2293 @item "--shadow-etched-out-dash"
2294 A single dashed line with a 3D raised appearance.
2296 @item "--shadow-double-etched-in"
2297 Two lines with a 3D sunken appearance.
2299 @item "--shadow-double-etched-out"
2300 Two lines with a 3D raised appearance.
2302 @item "--shadow-double-etched-in-dash"
2303 Two dashed lines with a 3D sunken appearance.
2305 @item "--shadow-double-etched-out-dash"
2306 Two dashed lines with a 3D raised appearance.
2307 @end table
2309   You can also give these names in another style, adding a colon after
2310 the double-dash and replacing each single dash with capitalization of
2311 the following word.  Thus, @code{"--:singleLine"}, is equivalent to
2312 @code{"--single-line"}.
2314   You can use a longer form to specify keywords such as @code{:enable}
2315 and @code{:visible} for a menu separator:
2317 @code{(menu-item @var{separator-type} nil . @var{item-property-list})}
2319 For example:
2321 @example
2322 (menu-item "--" nil :visible (boundp 'foo))
2323 @end example
2325   Some systems and display toolkits don't really handle all of these
2326 separator types.  If you use a type that isn't supported, the menu
2327 displays a similar kind of separator that is supported.
2329 @node Alias Menu Items
2330 @subsubsection Alias Menu Items
2332   Sometimes it is useful to make menu items that use the same
2333 command but with different enable conditions.  The best way to do this
2334 in Emacs now is with extended menu items; before that feature existed,
2335 it could be done by defining alias commands and using them in menu
2336 items.  Here's an example that makes two aliases for
2337 @code{read-only-mode} and gives them different enable conditions:
2339 @example
2340 (defalias 'make-read-only 'read-only-mode)
2341 (put 'make-read-only 'menu-enable '(not buffer-read-only))
2342 (defalias 'make-writable 'read-only-mode)
2343 (put 'make-writable 'menu-enable 'buffer-read-only)
2344 @end example
2346 When using aliases in menus, often it is useful to display the
2347 equivalent key bindings for the real command name, not the aliases
2348 (which typically don't have any key bindings except for the menu
2349 itself).  To request this, give the alias symbol a non-@code{nil}
2350 @code{menu-alias} property.  Thus,
2352 @example
2353 (put 'make-read-only 'menu-alias t)
2354 (put 'make-writable 'menu-alias t)
2355 @end example
2357 @noindent
2358 causes menu items for @code{make-read-only} and @code{make-writable} to
2359 show the keyboard bindings for @code{read-only-mode}.
2361 @node Mouse Menus
2362 @subsection Menus and the Mouse
2364   The usual way to make a menu keymap produce a menu is to make it the
2365 definition of a prefix key.  (A Lisp program can explicitly pop up a
2366 menu and receive the user's choice---see @ref{Pop-Up Menus}.)
2368   If the prefix key ends with a mouse event, Emacs handles the menu keymap
2369 by popping up a visible menu, so that the user can select a choice with
2370 the mouse.  When the user clicks on a menu item, the event generated is
2371 whatever character or symbol has the binding that brought about that
2372 menu item.  (A menu item may generate a series of events if the menu has
2373 multiple levels or comes from the menu bar.)
2375   It's often best to use a button-down event to trigger the menu.  Then
2376 the user can select a menu item by releasing the button.
2378 @cindex submenu
2379   If the menu keymap contains a binding to a nested keymap, the nested
2380 keymap specifies a @dfn{submenu}.  There will be a menu item, labeled
2381 by the nested keymap's item string, and clicking on this item
2382 automatically pops up the specified submenu.  As a special exception,
2383 if the menu keymap contains a single nested keymap and no other menu
2384 items, the menu shows the contents of the nested keymap directly, not
2385 as a submenu.
2387   However, if Emacs is compiled without X toolkit support, or on text
2388 terminals, submenus are not supported.  Each nested keymap is shown as
2389 a menu item, but clicking on it does not automatically pop up the
2390 submenu.  If you wish to imitate the effect of submenus, you can do
2391 that by giving a nested keymap an item string which starts with
2392 @samp{@@}.  This causes Emacs to display the nested keymap using a
2393 separate @dfn{menu pane}; the rest of the item string after the
2394 @samp{@@} is the pane label.  If Emacs is compiled without X toolkit
2395 support, or if a menu is displayed on a text terminal, menu panes are
2396 not used; in that case, a @samp{@@} at the beginning of an item string
2397 is omitted when the menu label is displayed, and has no other effect.
2399 @node Keyboard Menus
2400 @subsection Menus and the Keyboard
2402   When a prefix key ending with a keyboard event (a character or
2403 function key) has a definition that is a menu keymap, the keymap
2404 operates as a keyboard menu; the user specifies the next event by
2405 choosing a menu item with the keyboard.
2407   Emacs displays the keyboard menu with the map's overall prompt
2408 string, followed by the alternatives (the item strings of the map's
2409 bindings), in the echo area.  If the bindings don't all fit at once,
2410 the user can type @key{SPC} to see the next line of alternatives.
2411 Successive uses of @key{SPC} eventually get to the end of the menu and
2412 then cycle around to the beginning.  (The variable
2413 @code{menu-prompt-more-char} specifies which character is used for
2414 this; @key{SPC} is the default.)
2416   When the user has found the desired alternative from the menu, he or
2417 she should type the corresponding character---the one whose binding is
2418 that alternative.
2420 @defvar menu-prompt-more-char
2421 This variable specifies the character to use to ask to see
2422 the next line of a menu.  Its initial value is 32, the code
2423 for @key{SPC}.
2424 @end defvar
2426 @node Menu Example
2427 @subsection Menu Example
2428 @cindex menu definition example
2430   Here is a complete example of defining a menu keymap.  It is the
2431 definition of the @samp{Replace} submenu in the @samp{Edit} menu in
2432 the menu bar, and it uses the extended menu item format
2433 (@pxref{Extended Menu Items}).  First we create the keymap, and give
2434 it a name:
2436 @smallexample
2437 (defvar menu-bar-replace-menu (make-sparse-keymap "Replace"))
2438 @end smallexample
2440 @noindent
2441 Next we define the menu items:
2443 @smallexample
2444 (define-key menu-bar-replace-menu [tags-repl-continue]
2445   '(menu-item "Continue Replace" tags-loop-continue
2446               :help "Continue last tags replace operation"))
2447 (define-key menu-bar-replace-menu [tags-repl]
2448   '(menu-item "Replace in tagged files" tags-query-replace
2449               :help "Interactively replace a regexp in all tagged files"))
2450 (define-key menu-bar-replace-menu [separator-replace-tags]
2451   '(menu-item "--"))
2452 ;; @r{@dots{}}
2453 @end smallexample
2455 @noindent
2456 Note the symbols which the bindings are made for; these appear
2457 inside square brackets, in the key sequence being defined.  In some
2458 cases, this symbol is the same as the command name; sometimes it is
2459 different.  These symbols are treated as function keys, but they are
2460 not real function keys on the keyboard.  They do not affect the
2461 functioning of the menu itself, but they are echoed in the echo area
2462 when the user selects from the menu, and they appear in the output of
2463 @code{where-is} and @code{apropos}.
2465   The menu in this example is intended for use with the mouse.  If a
2466 menu is intended for use with the keyboard, that is, if it is bound to
2467 a key sequence ending with a keyboard event, then the menu items
2468 should be bound to characters or real function keys, that can be
2469 typed with the keyboard.
2471   The binding whose definition is @code{("--")} is a separator line.
2472 Like a real menu item, the separator has a key symbol, in this case
2473 @code{separator-replace-tags}.  If one menu has two separators, they
2474 must have two different key symbols.
2476   Here is how we make this menu appear as an item in the parent menu:
2478 @example
2479 (define-key menu-bar-edit-menu [replace]
2480   (list 'menu-item "Replace" menu-bar-replace-menu))
2481 @end example
2483 @noindent
2484 Note that this incorporates the submenu keymap, which is the value of
2485 the variable @code{menu-bar-replace-menu}, rather than the symbol
2486 @code{menu-bar-replace-menu} itself.  Using that symbol in the parent
2487 menu item would be meaningless because @code{menu-bar-replace-menu} is
2488 not a command.
2490   If you wanted to attach the same replace menu to a mouse click, you
2491 can do it this way:
2493 @example
2494 (define-key global-map [C-S-down-mouse-1]
2495    menu-bar-replace-menu)
2496 @end example
2498 @node Menu Bar
2499 @subsection The Menu Bar
2500 @cindex menu bar
2502   Emacs usually shows a @dfn{menu bar} at the top of each frame.
2503 @xref{Menu Bars,,,emacs, The GNU Emacs Manual}.  Menu bar items are
2504 subcommands of the fake function key @code{menu-bar}, as defined
2505 in the active keymaps.
2507   To add an item to the menu bar, invent a fake function key of your
2508 own (let's call it @var{key}), and make a binding for the key sequence
2509 @code{[menu-bar @var{key}]}.  Most often, the binding is a menu keymap,
2510 so that pressing a button on the menu bar item leads to another menu.
2512   When more than one active keymap defines the same function key
2513 for the menu bar, the item appears just once.  If the user clicks on
2514 that menu bar item, it brings up a single, combined menu containing
2515 all the subcommands of that item---the global subcommands, the local
2516 subcommands, and the minor mode subcommands.
2518   The variable @code{overriding-local-map} is normally ignored when
2519 determining the menu bar contents.  That is, the menu bar is computed
2520 from the keymaps that would be active if @code{overriding-local-map}
2521 were @code{nil}.  @xref{Active Keymaps}.
2523   Here's an example of setting up a menu bar item:
2525 @example
2526 @group
2527 ;; @r{Make a menu keymap (with a prompt string)}
2528 ;; @r{and make it the menu bar item's definition.}
2529 (define-key global-map [menu-bar words]
2530   (cons "Words" (make-sparse-keymap "Words")))
2531 @end group
2533 @group
2534 ;; @r{Define specific subcommands in this menu.}
2535 (define-key global-map
2536   [menu-bar words forward]
2537   '("Forward word" . forward-word))
2538 @end group
2539 @group
2540 (define-key global-map
2541   [menu-bar words backward]
2542   '("Backward word" . backward-word))
2543 @end group
2544 @end example
2546   A local keymap can cancel a menu bar item made by the global keymap by
2547 rebinding the same fake function key with @code{undefined} as the
2548 binding.  For example, this is how Dired suppresses the @samp{Edit} menu
2549 bar item:
2551 @example
2552 (define-key dired-mode-map [menu-bar edit] 'undefined)
2553 @end example
2555 @noindent
2556 Here, @code{edit} is the fake function key used by the global map for
2557 the @samp{Edit} menu bar item.  The main reason to suppress a global
2558 menu bar item is to regain space for mode-specific items.
2560 @defvar menu-bar-final-items
2561 Normally the menu bar shows global items followed by items defined by the
2562 local maps.
2564 This variable holds a list of fake function keys for items to display at
2565 the end of the menu bar rather than in normal sequence.  The default
2566 value is @code{(help-menu)}; thus, the @samp{Help} menu item normally appears
2567 at the end of the menu bar, following local menu items.
2568 @end defvar
2570 @defvar menu-bar-update-hook
2571 This normal hook is run by redisplay to update the menu bar contents,
2572 before redisplaying the menu bar.  You can use it to update menus
2573 whose contents should vary.  Since this hook is run frequently, we
2574 advise you to ensure that the functions it calls do not take much time
2575 in the usual case.
2576 @end defvar
2578 Next to every menu bar item, Emacs displays a key binding that runs
2579 the same command (if such a key binding exists).  This serves as a
2580 convenient hint for users who do not know the key binding.  If a
2581 command has multiple bindings, Emacs normally displays the first one
2582 it finds.  You can specify one particular key binding by assigning an
2583 @code{:advertised-binding} symbol property to the command.  @xref{Keys
2584 in Documentation}.
2586 @node Tool Bar
2587 @subsection Tool bars
2588 @cindex tool bar
2590   A @dfn{tool bar} is a row of clickable icons at the top of a frame,
2591 just below the menu bar.  @xref{Tool Bars,,,emacs, The GNU Emacs
2592 Manual}.  Emacs normally shows a tool bar on graphical displays.
2594   On each frame, the frame parameter @code{tool-bar-lines} controls
2595 how many lines' worth of height to reserve for the tool bar.  A zero
2596 value suppresses the tool bar.  If the value is nonzero, and
2597 @code{auto-resize-tool-bars} is non-@code{nil}, the tool bar expands
2598 and contracts automatically as needed to hold the specified contents.
2599 If the value is @code{grow-only}, the tool bar expands automatically,
2600 but does not contract automatically.
2602   The tool bar contents are controlled by a menu keymap attached to a
2603 fake function key called @code{tool-bar} (much like the way the menu
2604 bar is controlled).  So you define a tool bar item using
2605 @code{define-key}, like this:
2607 @example
2608 (define-key global-map [tool-bar @var{key}] @var{item})
2609 @end example
2611 @noindent
2612 where @var{key} is a fake function key to distinguish this item from
2613 other items, and @var{item} is a menu item key binding (@pxref{Extended
2614 Menu Items}), which says how to display this item and how it behaves.
2616   The usual menu keymap item properties, @code{:visible},
2617 @code{:enable}, @code{:button}, and @code{:filter}, are useful in
2618 tool bar bindings and have their normal meanings.  The @var{real-binding}
2619 in the item must be a command, not a keymap; in other words, it does not
2620 work to define a tool bar icon as a prefix key.
2622   The @code{:help} property specifies a help-echo string to display
2623 while the mouse is on that item.  This is displayed in the same way as
2624 @code{help-echo} text properties (@pxref{Help display}).
2626   In addition, you should use the @code{:image} property;
2627 this is how you specify the image to display in the tool bar:
2629 @table @code
2630 @item :image @var{image}
2631 @var{image} is either a single image specification (@pxref{Images}) or
2632 a vector of four image specifications.  If you use a vector of four,
2633 one of them is used, depending on circumstances:
2635 @table @asis
2636 @item item 0
2637 Used when the item is enabled and selected.
2638 @item item 1
2639 Used when the item is enabled and deselected.
2640 @item item 2
2641 Used when the item is disabled and selected.
2642 @item item 3
2643 Used when the item is disabled and deselected.
2644 @end table
2645 @end table
2647 The GTK+ and NS versions of Emacs ignores items 1 to 3, because disabled and/or
2648 deselected images are autocomputed from item 0.
2650 If @var{image} is a single image specification, Emacs draws the tool bar
2651 button in disabled state by applying an edge-detection algorithm to the
2652 image.
2654 The @code{:rtl} property specifies an alternative image to use for
2655 right-to-left languages.  Only the GTK+ version of Emacs supports this
2656 at present.
2658 Like the menu bar, the tool bar can display separators (@pxref{Menu
2659 Separators}).  Tool bar separators are vertical rather than
2660 horizontal, though, and only a single style is supported.  They are
2661 represented in the tool bar keymap by @code{(menu-item "--")} entries;
2662 properties like @code{:visible} are not supported for tool bar
2663 separators.  Separators are rendered natively in GTK+ and Nextstep
2664 tool bars; in the other cases, they are rendered using an image of a
2665 vertical line.
2667 The default tool bar is defined so that items specific to editing do not
2668 appear for major modes whose command symbol has a @code{mode-class}
2669 property of @code{special} (@pxref{Major Mode Conventions}).  Major
2670 modes may add items to the global bar by binding @code{[tool-bar
2671 @var{foo}]} in their local map.  It makes sense for some major modes to
2672 replace the default tool bar items completely, since not many can be
2673 accommodated conveniently, and the default bindings make this easy by
2674 using an indirection through @code{tool-bar-map}.
2676 @defvar tool-bar-map
2677 By default, the global map binds @code{[tool-bar]} as follows:
2679 @example
2680 (global-set-key [tool-bar]
2681                 `(menu-item ,(purecopy "tool bar") ignore
2682                             :filter tool-bar-make-keymap))
2683 @end example
2685 @noindent
2686 The function @code{tool-bar-make-keymap}, in turn, derives the actual
2687 tool bar map dynamically from the value of the variable
2688 @code{tool-bar-map}.  Hence, you should normally adjust the default
2689 (global) tool bar by changing that map.  Some major modes, such as
2690 Info mode, completely replace the global tool bar by making
2691 @code{tool-bar-map} buffer-local and setting it to a different keymap.
2692 @end defvar
2694 There are two convenience functions for defining tool bar items, as
2695 follows.
2697 @defun tool-bar-add-item icon def key &rest props
2698 This function adds an item to the tool bar by modifying
2699 @code{tool-bar-map}.  The image to use is defined by @var{icon}, which
2700 is the base name of an XPM, XBM or PBM image file to be located by
2701 @code{find-image}.  Given a value @samp{"exit"}, say, @file{exit.xpm},
2702 @file{exit.pbm} and @file{exit.xbm} would be searched for in that order
2703 on a color display.  On a monochrome display, the search order is
2704 @samp{.pbm}, @samp{.xbm} and @samp{.xpm}.  The binding to use is the
2705 command @var{def}, and @var{key} is the fake function key symbol in the
2706 prefix keymap.  The remaining arguments @var{props} are additional
2707 property list elements to add to the menu item specification.
2709 To define items in some local map, bind @code{tool-bar-map} with
2710 @code{let} around calls of this function:
2711 @example
2712 (defvar foo-tool-bar-map
2713   (let ((tool-bar-map (make-sparse-keymap)))
2714     (tool-bar-add-item @dots{})
2715     @dots{}
2716     tool-bar-map))
2717 @end example
2718 @end defun
2720 @defun tool-bar-add-item-from-menu command icon &optional map &rest props
2721 This function is a convenience for defining tool bar items which are
2722 consistent with existing menu bar bindings.  The binding of
2723 @var{command} is looked up in the menu bar in @var{map} (default
2724 @code{global-map}) and modified to add an image specification for
2725 @var{icon}, which is found in the same way as by
2726 @code{tool-bar-add-item}.  The resulting binding is then placed in
2727 @code{tool-bar-map}, so use this function only for global tool bar
2728 items.
2730 @var{map} must contain an appropriate keymap bound to
2731 @code{[menu-bar]}.  The remaining arguments @var{props} are additional
2732 property list elements to add to the menu item specification.
2733 @end defun
2735 @defun tool-bar-local-item-from-menu command icon in-map &optional from-map &rest props
2736 This function is used for making non-global tool bar items.  Use it
2737 like @code{tool-bar-add-item-from-menu} except that @var{in-map}
2738 specifies the local map to make the definition in.  The argument
2739 @var{from-map} is like the @var{map} argument of
2740 @code{tool-bar-add-item-from-menu}.
2741 @end defun
2743 @defvar auto-resize-tool-bars
2744 If this variable is non-@code{nil}, the tool bar automatically resizes to
2745 show all defined tool bar items---but not larger than a quarter of the
2746 frame's height.
2748 If the value is @code{grow-only}, the tool bar expands automatically,
2749 but does not contract automatically.  To contract the tool bar, the
2750 user has to redraw the frame by entering @kbd{C-l}.
2752 If Emacs is built with GTK or Nextstep, the tool bar can only show one
2753 line, so this variable has no effect.
2754 @end defvar
2756 @defvar auto-raise-tool-bar-buttons
2757 If this variable is non-@code{nil}, tool bar items display
2758 in raised form when the mouse moves over them.
2759 @end defvar
2761 @defvar tool-bar-button-margin
2762 This variable specifies an extra margin to add around tool bar items.
2763 The value is an integer, a number of pixels.  The default is 4.
2764 @end defvar
2766 @defvar tool-bar-button-relief
2767 This variable specifies the shadow width for tool bar items.
2768 The value is an integer, a number of pixels.  The default is 1.
2769 @end defvar
2771 @defvar tool-bar-border
2772 This variable specifies the height of the border drawn below the tool
2773 bar area.  An integer specifies height as a number of pixels.
2774 If the value is one of @code{internal-border-width} (the default) or
2775 @code{border-width}, the tool bar border height corresponds to the
2776 corresponding frame parameter.
2777 @end defvar
2779   You can define a special meaning for clicking on a tool bar item with
2780 the shift, control, meta, etc., modifiers.  You do this by setting up
2781 additional items that relate to the original item through the fake
2782 function keys.  Specifically, the additional items should use the
2783 modified versions of the same fake function key used to name the
2784 original item.
2786   Thus, if the original item was defined this way,
2788 @example
2789 (define-key global-map [tool-bar shell]
2790   '(menu-item "Shell" shell
2791               :image (image :type xpm :file "shell.xpm")))
2792 @end example
2794 @noindent
2795 then here is how you can define clicking on the same tool bar image with
2796 the shift modifier:
2798 @example
2799 (define-key global-map [tool-bar S-shell] 'some-command)
2800 @end example
2802 @xref{Function Keys}, for more information about how to add modifiers to
2803 function keys.
2805 @node Modifying Menus
2806 @subsection Modifying Menus
2807 @cindex menu modification
2809   When you insert a new item in an existing menu, you probably want to
2810 put it in a particular place among the menu's existing items.  If you
2811 use @code{define-key} to add the item, it normally goes at the front of
2812 the menu.  To put it elsewhere in the menu, use @code{define-key-after}:
2814 @defun define-key-after map key binding &optional after
2815 Define a binding in @var{map} for @var{key}, with value @var{binding},
2816 just like @code{define-key}, but position the binding in @var{map} after
2817 the binding for the event @var{after}.  The argument @var{key} should be
2818 of length one---a vector or string with just one element.  But
2819 @var{after} should be a single event type---a symbol or a character, not
2820 a sequence.  The new binding goes after the binding for @var{after}.  If
2821 @var{after} is @code{t} or is omitted, then the new binding goes last, at
2822 the end of the keymap.  However, new bindings are added before any
2823 inherited keymap.
2825 Here is an example:
2827 @example
2828 (define-key-after my-menu [drink]
2829   '("Drink" . drink-command) 'eat)
2830 @end example
2832 @noindent
2833 makes a binding for the fake function key @key{DRINK} and puts it
2834 right after the binding for @key{EAT}.
2836 Here is how to insert an item called @samp{Work} in the @samp{Signals}
2837 menu of Shell mode, after the item @code{break}:
2839 @example
2840 (define-key-after
2841   (lookup-key shell-mode-map [menu-bar signals])
2842   [work] '("Work" . work-command) 'break)
2843 @end example
2844 @end defun
2846 @node Easy Menu
2847 @subsection Easy Menu
2849   The following macro provides a convenient way to define pop-up menus
2850 and/or menu bar menus.
2852 @defmac easy-menu-define symbol maps doc menu
2853 This macro defines a pop-up menu and/or menu bar submenu, whose
2854 contents are given by @var{menu}.
2856 If @var{symbol} is non-@code{nil}, it should be a symbol; then this
2857 macro defines @var{symbol} as a function for popping up the menu
2858 (@pxref{Pop-Up Menus}), with @var{doc} as its documentation string.
2859 @var{symbol} should not be quoted.
2861 Regardless of the value of @var{symbol}, if @var{maps} is a keymap,
2862 the menu is added to that keymap, as a top-level menu for the menu bar
2863 (@pxref{Menu Bar}).  It can also be a list of keymaps, in which case
2864 the menu is added separately to each of those keymaps.
2866 The first element of @var{menu} must be a string, which serves as the
2867 menu label.  It may be followed by any number of the following
2868 keyword-argument pairs:
2870 @table @code
2871 @item :filter @var{function}
2872 @var{function} must be a function which, if called with one
2873 argument---the list of the other menu items---returns the actual items
2874 to be displayed in the menu.
2876 @item :visible @var{include}
2877 @var{include} is an expression; if it evaluates to @code{nil}, the
2878 menu is made invisible.  @code{:included} is an alias for
2879 @code{:visible}.
2881 @item :active @var{enable}
2882 @var{enable} is an expression; if it evaluates to @code{nil}, the menu
2883 is not selectable.  @code{:enable} is an alias for @code{:active}.
2884 @end table
2886 The remaining elements in @var{menu} are menu items.
2888 A menu item can be a vector of three elements, @code{[@var{name}
2889 @var{callback} @var{enable}]}.  @var{name} is the menu item name (a
2890 string).  @var{callback} is a command to run, or an expression to
2891 evaluate, when the item is chosen.  @var{enable} is an expression; if
2892 it evaluates to @code{nil}, the item is disabled for selection.
2894 Alternatively, a menu item may have the form:
2896 @smallexample
2897    [ @var{name} @var{callback} [ @var{keyword} @var{arg} ]... ]
2898 @end smallexample
2900 @noindent
2901 where @var{name} and @var{callback} have the same meanings as above,
2902 and each optional @var{keyword} and @var{arg} pair should be one of
2903 the following:
2905 @table @code
2906 @item :keys @var{keys}
2907 @var{keys} is a keyboard equivalent to the menu item (a string).  This
2908 is normally not needed, as keyboard equivalents are computed
2909 automatically.  @var{keys} is expanded with
2910 @code{substitute-command-keys} before it is displayed (@pxref{Keys in
2911 Documentation}).
2913 @item :key-sequence @var{keys}
2914 @var{keys} is a hint for speeding up Emacs's first display of the
2915 menu.  It should be @code{nil} if you know that the menu item has no keyboard
2916 equivalent; otherwise it should be a string or vector specifying a
2917 keyboard equivalent for the menu item.
2919 @item :active @var{enable}
2920 @var{enable} is an expression; if it evaluates to @code{nil}, the item
2921 is make unselectable..  @code{:enable} is an alias for @code{:active}.
2923 @item :visible @var{include}
2924 @var{include} is an expression; if it evaluates to @code{nil}, the
2925 item is made invisible.  @code{:included} is an alias for
2926 @code{:visible}.
2928 @item :label @var{form}
2929 @var{form} is an expression that is evaluated to obtain a value which
2930 serves as the menu item's label (the default is @var{name}).
2932 @item :suffix @var{form}
2933 @var{form} is an expression that is dynamically evaluated and whose
2934 value is concatenated with the menu entry's label.
2936 @item :style @var{style}
2937 @var{style} is a symbol describing the type of menu item; it should be
2938 @code{toggle} (a checkbox), or @code{radio} (a radio button), or
2939 anything else (meaning an ordinary menu item).
2941 @item :selected @var{selected}
2942 @var{selected} is an expression; the checkbox or radio button is
2943 selected whenever the expression's value is non-@code{nil}.
2945 @item :help @var{help}
2946 @var{help} is a string describing the menu item.
2947 @end table
2949 Alternatively, a menu item can be a string.  Then that string appears
2950 in the menu as unselectable text.  A string consisting of dashes is
2951 displayed as a separator (@pxref{Menu Separators}).
2953 Alternatively, a menu item can be a list with the same format as
2954 @var{menu}.  This is a submenu.
2955 @end defmac
2957 Here is an example of using @code{easy-menu-define} to define a menu
2958 similar to the one defined in the example in @ref{Menu Bar}:
2960 @example
2961 (easy-menu-define words-menu global-map
2962   "Menu for word navigation commands."
2963   '("Words"
2964      ["Forward word" forward-word]
2965      ["Backward word" backward-word]))
2966 @end example