| blob | bf2e190e4892283161a6539c7b64a8844c391fc8 |
1 ;;; easymenu.el --- support the easymenu interface for defining a menu
3 ;; Copyright (C) 1994, 1996, 1998, 1999, 2000 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.
52 The menu keymap is stored in symbol SYMBOL, both as its value
53 and as its function definition. DOC is used as the doc string for SYMBOL.
55 The first element of MENU must be a string. It is the menu bar item name.
56 It may be followed by the following keyword argument pairs
58 :filter FUNCTION
60 FUNCTION is a function with one argument, the menu. It returns the actual
61 menu displayed.
63 :visible INCLUDE
65 INCLUDE is an expression; this menu is only visible if this
66 expression has a non-nil value. `:include' is an alias for `:visible'.
68 :active ENABLE
70 ENABLE is an expression; the menu is enabled for selection
71 whenever this expression's value is non-nil.
73 The rest of the elements in MENU, are menu items.
75 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
77 NAME is a string--the menu item name.
79 CALLBACK is a command to run when the item is chosen,
80 or a list to evaluate when the item is chosen.
82 ENABLE is an expression; the item is enabled for selection
83 whenever this expression's value is non-nil.
85 Alternatively, a menu item may have the form:
87 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
89 Where KEYWORD is one of the symbols defined below.
91 :keys KEYS
93 KEYS is a string; a complex keyboard equivalent to this menu item.
94 This is normally not needed because keyboard equivalents are usually
95 computed automatically.
96 KEYS is expanded with `substitute-command-keys' before it is used.
98 :key-sequence KEYS
100 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
101 menu item.
102 This is a hint that will considerably speed up Emacs' first display of
103 a menu. Use `:key-sequence nil' when you know that this menu item has no
104 keyboard equivalent.
106 :active ENABLE
108 ENABLE is an expression; the item is enabled for selection
109 whenever this expression's value is non-nil.
111 :included INCLUDE
113 INCLUDE is an expression; this item is only visible if this
114 expression has a non-nil value.
116 :suffix FORM
118 FORM is an expression that will be dynamically evaluated and whose
119 value will be concatenated to the menu entry's NAME.
121 :style STYLE
123 STYLE is a symbol describing the type of menu item. The following are
124 defined:
126 toggle: A checkbox.
127 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
128 radio: A radio button.
129 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
130 button: Surround the name with `[' and `]'. Use this for an item in the
131 menu bar itself.
132 anything else means an ordinary menu item.
134 :selected SELECTED
136 SELECTED is an expression; the checkbox or radio button is selected
137 whenever this expression's value is non-nil.
139 :help HELP
141 HELP is a string, the help to display for the menu item.
143 A menu item can be a string. Then that string appears in the menu as
144 unselectable text. A string consisting solely of hyphens is displayed
145 as a solid horizontal line.
147 A menu item can be a list with the same format as MENU. This is a submenu."
152 ;;;###autoload
154 ;; We can't do anything that might differ between Emacs dialects in
155 ;; `easy-menu-define' in order to make byte compiled files
156 ;; compatible. Therefore everything interesting is done in this
157 ;; function.
162 ;; FIXME: XEmacs uses popup-menu which calls the binding
163 ;; while x-popup-menu only returns the selection.
183 "Convert MENU to the right thing to return from a menu filter.
184 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
185 a symbol whose value is such a menu.
186 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
187 return a menu items list (without menu name and keywords).
188 This function returns the right thing in the two cases.
189 If NAME is provided, it is used for the keymap."
191 ;; If it's a cons but not a keymap, then it can't be right
192 ;; unless it's an XEmacs menu.
196 ;;;###autoload
198 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
199 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
200 possibly preceded by keyword pairs as described in `easy-menu-define'."
202 prop keyword arg label enable filter visible help)
203 ;; Look for keywords.
219 nil ; Invisible menu entry, return nil.
228 ;; The filter expects the menu in its XEmacs form and the pre-filter
229 ;; form will only be passed to the filter anyway, so we'd better
230 ;; not convert it at all (it will be converted on the fly by
231 ;; easy-menu-filter-return).
237 menu)))
240 ;; Known button types.
251 "Memoize the value returned by `easy-menu-convert-item-1' called on ITEM.
252 This makes key-shortcut-caching work a *lot* better when this
253 conversion is done from within a filter.
254 This also helps when the NAME of the entry is recreated each time:
255 since the menu is built and traversed separately, the lookup
256 would always fail because the key is `equal' but not `eq'."
259 easy-menu-converted-items-table)))
262 "Parse an item description and add the item to a keymap.
263 This is the function that is used for item definition by the other easy-menu
264 functions.
265 MENU is a sparse keymap i.e. a list starting with the symbol `keymap'.
266 ITEM defines an item as in `easy-menu-define'.
267 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil
268 put item before BEFORE in MENU, otherwise if item is already present in
269 MENU, just change it, otherwise put it last in MENU."
280 ;; Invisible menu item. Don't insert into keymap.
291 cache cache-specified)
296 keyword arg suffix visible style selected keys)
332 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."
382 tail done)
387 ;; If key is nil, stop here, otherwise keep going past the
388 ;; inserted element so we can delete any duplications that come
389 ;; later.
410 "Return t if NAME is the name of menu item ITEM.
411 NAME can be either a string, or a symbol."
416 ;; Match against the text that is displayed to the user.
418 ;; Also check the string version of the symbol name,
419 ;; for backwards compatibility.
423 "Return true if form X never evaluates to nil."
430 "Return a unique symbol with CALLBACK as function value.
431 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
432 \(i.e. does not need to be turned into a function)."
439 command))
441 ;;;###autoload
443 "Change menu found at PATH as item NAME to contain ITEMS.
444 PATH is a list of strings for locating the menu that
445 should contain a submenu named NAME.
446 ITEMS is a list of menu items, as in `easy-menu-define'.
447 These items entirely replace the previous items in that submenu.
449 If the menu located by PATH has no submenu named NAME, add one.
450 If the optional argument BEFORE is present, add it just before
451 the submenu named BEFORE, otherwise add it at the end of the menu.
453 Either call this from `menu-bar-update-hook' or use a menu filter,
454 to implement dynamic menus."
457 ;; XEmacs needs the following two functions to add and remove menus.
458 ;; In Emacs this is done automatically when switching keymaps, so
459 ;; here easy-menu-remove is a noop and easy-menu-add only precalculates
460 ;; equivalent keybindings (if easy-menu-precalculate-equivalent-keybindings
461 ;; is on).
465 "Maybe precalculate equivalent key bindings.
466 Do it only if `easy-menu-precalculate-equivalent-keybindings' is on."
473 "Add submenu SUBMENU in the menu at MENU-PATH.
474 If BEFORE is non-nil, add before the item named BEFORE.
475 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
476 This is a compatibility function; use `easy-menu-add-item'."
479 submenu before))
482 "To the submenu of MAP with path PATH, add ITEM.
484 If an item with the same name is already present in this submenu,
485 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
486 In the latter case, ITEM is normally added at the end of the submenu.
487 However, if BEFORE is a string and there is an item in the submenu
488 with that name, then ITEM is added before that item.
490 MAP should normally be a keymap; nil stands for the global menu-bar keymap.
491 It can also be a symbol, which has earlier been used as the first
492 argument in a call to `easy-menu-define', or the value of such a symbol.
494 PATH is a list of strings for locating the submenu where ITEM is to be
495 added. If PATH is nil, MAP itself is used. Otherwise, the first
496 element should be the name of a submenu directly under MAP. This
497 submenu is then traversed recursively with the remaining elements of PATH.
499 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
500 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
501 earlier by `easy-menu-define' or `easy-menu-create-menu'."
507 ;; This is a value returned by `easy-menu-item-present-p' or
508 ;; `easy-menu-remove-item'.
513 ;; Item is a keymap, find the prompt string and use as item name.
524 "In submenu of MAP with path PATH, return true iff item NAME is present.
525 MAP and PATH are defined as in `easy-menu-add-item'.
526 NAME should be a string, the name of the element to be looked for."
530 "From submenu of MAP with path PATH remove item NAME.
531 MAP and PATH are defined as in `easy-menu-add-item'.
532 NAME should be a string, the name of the element to be removed."
536 ret))
539 "In menu MENU try to look for menu item with name NAME.
540 If a menu item is found, return (NAME . item), otherwise return nil.
541 If item is an old format item, a new format item is returned."
543 ret enable cache label)
546 ;; This is the old menu format. Convert it to new format.
561 )))
566 submap)
568 ;; This should really be in keymap.c
578 "Return a sparse keymap in which to add or remove an item.
579 MAP and PATH are as defined in `easy-menu-add-item'.
581 TO-MODIFY, if non-nil, is the name of the item the caller
582 wants to modify in the map that we return.
583 In some cases we use that to select between the local and global maps."
592 map)
598 ;; Prefer a map that already contains the to-be-modified entry.
604 ;; Use the first valid map.
608 ;; Otherwise, make one up.
609 ;; Hardcoding current-local-map is lame, but it's difficult
610 ;; to know what the caller intended for us to do ;-(
615 newmap))))
617 map)
621 ;;; easymenu.el ends here