| blob | b0f3b9b9d3e86c6f6a5f04ad06c5f37cd55d25d9 |
1 ;;; easymenu.el --- support the easymenu interface for defining a menu
3 ;; Copyright (C) 1994,96,98,1999,2000,2004 Free Software Foundation, Inc.
5 ;; Keywords: emulations
6 ;; Author: Richard Stallman <rms@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; This is compatible with easymenu.el by Per Abrahamsen
28 ;; but it is much simpler as it doesn't try to support other Emacs versions.
29 ;; The code was mostly derived from lmenu.el.
31 ;;; Code:
34 "Determine when equivalent key bindings are computed for easy-menu menus.
35 It can take some time to calculate the equivalent key bindings that are shown
36 in a menu. If the variable is on, then this calculation gives a (maybe
37 noticeable) delay when a mode is first entered. If the variable is off, then
38 this delay will come when a menu is displayed the first time. If you never use
39 menus, turn this variable off, otherwise it is probably better to keep it on."
47 ;;;###autoload
49 ;;;###autoload
51 "Define a menu bar submenu in maps MAPS, according to MENU.
53 If SYMBOL is non-nil, store the menu keymap in the value of SYMBOL,
54 and define SYMBOL as a function to pop up the menu, with DOC as its doc string.
55 If SYMBOL is nil, just store the menu keymap into MAPS.
57 The first element of MENU must be a string. It is the menu bar item name.
58 It may be followed by the following keyword argument pairs
60 :filter FUNCTION
62 FUNCTION is a function with one argument, the rest of menu items.
63 It returns the remaining items of the displayed menu.
65 :visible INCLUDE
67 INCLUDE is an expression; this menu is only visible if this
68 expression has a non-nil value. `:include' is an alias for `:visible'.
70 :active ENABLE
72 ENABLE is an expression; the menu is enabled for selection
73 whenever this expression's value is non-nil.
75 The rest of the elements in MENU, are menu items.
77 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
79 NAME is a string--the menu item name.
81 CALLBACK is a command to run when the item is chosen,
82 or a list to evaluate when the item is chosen.
84 ENABLE is an expression; the item is enabled for selection
85 whenever this expression's value is non-nil.
87 Alternatively, a menu item may have the form:
89 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
91 Where KEYWORD is one of the symbols defined below.
93 :keys KEYS
95 KEYS is a string; a complex keyboard equivalent to this menu item.
96 This is normally not needed because keyboard equivalents are usually
97 computed automatically.
98 KEYS is expanded with `substitute-command-keys' before it is used.
100 :key-sequence KEYS
102 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
103 menu item.
104 This is a hint that will considerably speed up Emacs' first display of
105 a menu. Use `:key-sequence nil' when you know that this menu item has no
106 keyboard equivalent.
108 :active ENABLE
110 ENABLE is an expression; the item is enabled for selection
111 whenever this expression's value is non-nil.
113 :included INCLUDE
115 INCLUDE is an expression; this item is only visible if this
116 expression has a non-nil value.
118 :suffix FORM
120 FORM is an expression that will be dynamically evaluated and whose
121 value will be concatenated to the menu entry's NAME.
123 :style STYLE
125 STYLE is a symbol describing the type of menu item. The following are
126 defined:
128 toggle: A checkbox.
129 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
130 radio: A radio button.
131 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
132 button: Surround the name with `[' and `]'. Use this for an item in the
133 menu bar itself.
134 anything else means an ordinary menu item.
136 :selected SELECTED
138 SELECTED is an expression; the checkbox or radio button is selected
139 whenever this expression's value is non-nil.
141 :help HELP
143 HELP is a string, the help to display for the menu item.
145 A menu item can be a string. Then that string appears in the menu as
146 unselectable text. A string consisting solely of hyphens is displayed
147 as a solid horizontal line.
149 A menu item can be a list with the same format as MENU. This is a submenu."
154 ;;;###autoload
156 ;; We can't do anything that might differ between Emacs dialects in
157 ;; `easy-menu-define' in order to make byte compiled files
158 ;; compatible. Therefore everything interesting is done in this
159 ;; function.
165 ;; FIXME: XEmacs uses popup-menu which calls the binding
166 ;; while x-popup-menu only returns the selection.
186 "Convert MENU to the right thing to return from a menu filter.
187 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
188 a symbol whose value is such a menu.
189 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
190 return a menu items list (without menu name and keywords).
191 This function returns the right thing in the two cases.
192 If NAME is provided, it is used for the keymap."
195 ;; If it's a cons but not a keymap, then it can't be right
196 ;; unless it's an XEmacs menu.
199 ;; It's just a menu entry.
201 menu)
203 ;;;###autoload
205 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
206 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
207 possibly preceded by keyword pairs as described in `easy-menu-define'."
209 prop keyword arg label enable filter visible help)
210 ;; Look for keywords.
226 nil ; Invisible menu entry, return nil.
235 ;; The filter expects the menu in its XEmacs form and the pre-filter
236 ;; form will only be passed to the filter anyway, so we'd better
237 ;; not convert it at all (it will be converted on the fly by
238 ;; easy-menu-filter-return).
244 menu)))
247 ;; Known button types.
258 "Memoize the value returned by `easy-menu-convert-item-1' called on ITEM.
259 This makes key-shortcut-caching work a *lot* better when this
260 conversion is done from within a filter.
261 This also helps when the NAME of the entry is recreated each time:
262 since the menu is built and traversed separately, the lookup
263 would always fail because the key is `equal' but not `eq'."
266 easy-menu-converted-items-table)))
269 "Parse an item description and convert it to a menu keymap element.
270 ITEM defines an item as in `easy-menu-define'."
281 ;; Invisible menu item. Don't insert into keymap.
292 cache cache-specified)
297 keyword arg suffix visible style selected keys)
333 keys)
350 ;; Invisible menu item. Don't insert into keymap.
359 ;; `intern' the name so as to merge multiple entries with the same name.
360 ;; It also makes it easier/possible to lookup/change menu bindings
361 ;; via keymap functions.
370 "Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
371 If KEY is not nil then delete any duplications.
372 If ITEM is nil, then delete the definition of KEY.
374 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil,
375 put binding before the item in MENU named BEFORE; otherwise,
376 if a binding for KEY is already present in MENU, just change it;
377 otherwise put the new binding last in MENU.
378 BEFORE can be either a string (menu item name) or a symbol
379 \(the fake function key for the menu item).
380 KEY does not have to be a symbol, and comparison is done with equal."
383 tail done)
388 ;; If key is nil, stop here, otherwise keep going past the
389 ;; inserted element so we can delete any duplications that come
390 ;; later.
411 "Return t if NAME is the name of menu item ITEM.
412 NAME can be either a string, or a symbol.
413 ITEM should be a keymap binding of the form (KEY . MENU-ITEM)."
418 ;; Match against the text that is displayed to the user.
421 ;; Also check the string version of the symbol name,
422 ;; for backwards compatibility.
426 "Return true if form X never evaluates to nil."
433 "Return a unique symbol with CALLBACK as function value.
434 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
435 \(i.e. does not need to be turned into a function)."
442 command))
444 ;;;###autoload
446 "Change menu found at PATH as item NAME to contain ITEMS.
447 PATH is a list of strings for locating the menu that
448 should contain a submenu named NAME.
449 ITEMS is a list of menu items, as in `easy-menu-define'.
450 These items entirely replace the previous items in that submenu.
452 If the menu located by PATH has no submenu named NAME, add one.
453 If the optional argument BEFORE is present, add it just before
454 the submenu named BEFORE, otherwise add it at the end of the menu.
456 Either call this from `menu-bar-update-hook' or use a menu filter,
457 to implement dynamic menus."
460 ;; XEmacs needs the following two functions to add and remove menus.
461 ;; In Emacs this is done automatically when switching keymaps, so
462 ;; here easy-menu-remove is a noop and easy-menu-add only precalculates
463 ;; equivalent keybindings (if easy-menu-precalculate-equivalent-keybindings
464 ;; is on).
466 "Remove MENU from the current menu bar.
467 Contrary to XEmacs, this is a nop on Emacs since menus are automatically
468 \(de)activated when the corresponding keymap is (de)activated.
473 "Add the menu to the menubar.
474 This is a nop on Emacs since menus are automatically activated when the
475 corresponding keymap is activated. On XEmacs this is needed to actually
476 add the menu to the current menubar.
477 Maybe precalculate equivalent key bindings.
478 Do it only if `easy-menu-precalculate-equivalent-keybindings' is on."
484 ))
487 "Add submenu SUBMENU in the menu at MENU-PATH.
488 If BEFORE is non-nil, add before the item named BEFORE.
489 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
490 This is a compatibility function; use `easy-menu-add-item'."
493 submenu before))
496 "To the submenu of MAP with path PATH, add ITEM.
498 If an item with the same name is already present in this submenu,
499 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
500 In the latter case, ITEM is normally added at the end of the submenu.
501 However, if BEFORE is a string and there is an item in the submenu
502 with that name, then ITEM is added before that item.
504 MAP should normally be a keymap; nil stands for the local menu-bar keymap.
505 It can also be a symbol, which has earlier been used as the first
506 argument in a call to `easy-menu-define', or the value of such a symbol.
508 PATH is a list of strings for locating the submenu where ITEM is to be
509 added. If PATH is nil, MAP itself is used. Otherwise, the first
510 element should be the name of a submenu directly under MAP. This
511 submenu is then traversed recursively with the remaining elements of PATH.
513 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
514 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
515 earlier by `easy-menu-define' or `easy-menu-create-menu'."
521 ;; This is a value returned by `easy-menu-item-present-p' or
522 ;; `easy-menu-remove-item'.
528 ;; Item is a keymap, find the prompt string and use as item name.
533 "In submenu of MAP with path PATH, return true iff item NAME is present.
534 MAP and PATH are defined as in `easy-menu-add-item'.
535 NAME should be a string, the name of the element to be looked for."
539 "From submenu of MAP with path PATH remove item NAME.
540 MAP and PATH are defined as in `easy-menu-add-item'.
541 NAME should be a string, the name of the element to be removed."
545 ret))
548 "In menu MENU try to look for menu item with name NAME.
549 If a menu item is found, return (NAME . item), otherwise return nil.
550 If item is an old format item, a new format item is returned."
552 ret enable cache label)
555 ;; This is the old menu format. Convert it to new format.
570 )))
573 "Lookup menu item NAME in keymap MAP.
574 Like `lookup-key' except that NAME is not an array but just a single key
575 and that NAME can be a string representing the menu item's name."
578 ;; `lookup-key' failed and we have a menu item name: look at the
579 ;; actual menu entries's names.
584 ;; Found it!! Look for it again with
585 ;; `lookup-key' so as to handle inheritance and
586 ;; to extract the actual command/keymap bound to
587 ;; `name' from the item (via get_keyelt).
589 map)))))
592 "Return a sparse keymap in which to add or remove an item.
593 MAP and PATH are as defined in `easy-menu-add-item'.
595 TO-MODIFY, if non-nil, is the name of the item the caller
596 wants to modify in the map that we return.
597 In some cases we use that to select between the local and global maps."
603 ;; Look for PATH in each map.
609 map name))
611 maps))))
613 ;; Prefer a map that already contains the to-be-modified entry.
618 ;; Use the first valid map.
621 ;; Otherwise, make one up.
622 ;; Hardcoding current-local-map is lame, but it's difficult
623 ;; to know what the caller intended for us to do ;-(
629 newmap))))
631 map)
635 ;; arch-tag: 2a04020d-90d2-476d-a7c6-71e072007a4a
636 ;;; easymenu.el ends here