| blob | 957de4dfe2aed3dc17d1336fa0b8554933e11e6f |
1 ;;; easymenu.el --- support the easymenu interface for defining a menu
3 ;; Copyright (C) 1994, 1996, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Keywords: emulations
7 ;; Author: Richard Stallman <rms@gnu.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This is compatible with easymenu.el by Per Abrahamsen
27 ;; but it is much simpler as it doesn't try to support other Emacs versions.
28 ;; The code was mostly derived from lmenu.el.
30 ;;; Code:
33 "Determine when equivalent key bindings are computed for easy-menu menus.
34 It can take some time to calculate the equivalent key bindings that are shown
35 in a menu. If the variable is on, then this calculation gives a (maybe
36 noticeable) delay when a mode is first entered. If the variable is off, then
37 this delay will come when a menu is displayed the first time. If you never use
38 menus, turn this variable off, otherwise it is probably better to keep it on."
46 ;;;###autoload
48 ;;;###autoload
50 "Define a menu bar submenu in maps MAPS, according to MENU.
52 If SYMBOL is non-nil, store the menu keymap in the value of SYMBOL,
53 and define SYMBOL as a function to pop up the menu, with DOC as its doc string.
54 If SYMBOL is nil, just store the menu keymap into MAPS.
56 The first element of MENU must be a string. It is the menu bar item name.
57 It may be followed by the following keyword argument pairs
59 :filter FUNCTION
61 FUNCTION is a function with one argument, the rest of menu items.
62 It returns the remaining items of the displayed menu.
64 :visible INCLUDE
66 INCLUDE is an expression; this menu is only visible if this
67 expression has a non-nil value. `:included' is an alias for `:visible'.
69 :active ENABLE
71 ENABLE is an expression; the menu is enabled for selection
72 whenever this expression's value is non-nil.
74 The rest of the elements in MENU, are menu items.
76 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
78 NAME is a string--the menu item name.
80 CALLBACK is a command to run when the item is chosen,
81 or a list to evaluate when the item is chosen.
83 ENABLE is an expression; the item is enabled for selection
84 whenever this expression's value is non-nil.
86 Alternatively, a menu item may have the form:
88 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
90 Where KEYWORD is one of the symbols defined below.
92 :keys KEYS
94 KEYS is a string; a complex keyboard equivalent to this menu item.
95 This is normally not needed because keyboard equivalents are usually
96 computed automatically.
97 KEYS is expanded with `substitute-command-keys' before it is used.
99 :key-sequence KEYS
101 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
102 menu item.
103 This is a hint that will considerably speed up Emacs' first display of
104 a menu. Use `:key-sequence nil' when you know that this menu item has no
105 keyboard equivalent.
107 :active ENABLE
109 ENABLE is an expression; the item is enabled for selection
110 whenever this expression's value is non-nil.
112 :visible INCLUDE
114 INCLUDE is an expression; this item is only visible if this
115 expression has a non-nil value. `:included' is an alias for `:visible'.
117 :label FORM
119 FORM is an expression that will be dynamically evaluated and whose
120 value will be used for the menu entry's text label (the default is NAME).
122 :suffix FORM
124 FORM is an expression that will be dynamically evaluated and whose
125 value will be concatenated to the menu entry's label.
127 :style STYLE
129 STYLE is a symbol describing the type of menu item. The following are
130 defined:
132 toggle: A checkbox.
133 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
134 radio: A radio button.
135 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
136 button: Surround the name with `[' and `]'. Use this for an item in the
137 menu bar itself.
138 anything else means an ordinary menu item.
140 :selected SELECTED
142 SELECTED is an expression; the checkbox or radio button is selected
143 whenever this expression's value is non-nil.
145 :help HELP
147 HELP is a string, the help to display for the menu item.
149 A menu item can be a string. Then that string appears in the menu as
150 unselectable text. A string consisting solely of hyphens is displayed
151 as a solid horizontal line.
153 A menu item can be a list with the same format as MENU. This is a submenu."
159 "Return a binding suitable to pass to `define-key'.
160 This is expected to be bound to a mouse event."
161 ;; Under Emacs this is almost trivial, whereas under XEmacs this may
162 ;; involve defining a function that calls popup-menu.
173 ;;;###autoload
175 ;; We can't do anything that might differ between Emacs dialects in
176 ;; `easy-menu-define' in order to make byte compiled files
177 ;; compatible. Therefore everything interesting is done in this
178 ;; function.
184 ;; FIXME: XEmacs uses popup-menu which calls the binding
185 ;; while x-popup-menu only returns the selection.
200 "Convert MENU to the right thing to return from a menu filter.
201 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
202 a symbol whose value is such a menu.
203 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
204 return a menu items list (without menu name and keywords).
205 This function returns the right thing in the two cases.
206 If NAME is provided, it is used for the keymap."
209 ;; If it's a cons but not a keymap, then it can't be right
210 ;; unless it's an XEmacs menu.
213 ;; It's just a menu entry.
215 menu)
218 "Dynamically scoped var to register already used keys in a menu.
219 If it holds a list, this is expected to be a list of keys already seen in the
222 ;;;###autoload
224 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
225 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
226 possibly preceded by keyword pairs as described in `easy-menu-define'."
229 prop keyword arg label enable filter visible help)
230 ;; Look for keywords.
246 nil ; Invisible menu entry, return nil.
255 ;; The filter expects the menu in its XEmacs form and the pre-filter
256 ;; form will only be passed to the filter anyway, so we'd better
257 ;; not convert it at all (it will be converted on the fly by
258 ;; easy-menu-filter-return).
264 menu)))
267 ;; Known button types.
274 "Memoize the value returned by `easy-menu-convert-item-1' called on ITEM.
275 This makes key-shortcut-caching work a *lot* better when this
276 conversion is done from within a filter.
277 This also helps when the NAME of the entry is recreated each time:
278 since the menu is built and traversed separately, the lookup
279 would always fail because the key is `equal' but not `eq'."
282 easy-menu-converted-items-table)))
285 "Parse an item description and convert it to a menu keymap element.
286 ITEM defines an item as in `easy-menu-define'."
297 ;; Invisible menu item. Don't insert into keymap.
308 cache cache-specified)
313 keyword arg suffix visible style selected keys)
349 keys)
366 ;; Invisible menu item. Don't insert into keymap.
375 ;; `intern' the name so as to merge multiple entries with the same name.
376 ;; It also makes it easier/possible to lookup/change menu bindings
377 ;; via keymap functions.
380 ;; Merging multiple entries with the same name is sometimes what we
381 ;; want, but not when the entries are actually different (e.g. same
382 ;; name but different :suffix as seen in cal-menu.el) and appear in
383 ;; the same menu. So we try to detect and resolve conflicts.
386 ;; We need to use some distinct object, ideally a symbol, ideally
387 ;; related to the `name'. Uninterned symbols do not work (they
388 ;; are apparently turned into strings and re-interned later on).
401 "Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
402 If KEY is not nil then delete any duplications.
403 If ITEM is nil, then delete the definition of KEY.
405 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil,
406 put binding before the item in MENU named BEFORE; otherwise,
407 if a binding for KEY is already present in MENU, just change it;
408 otherwise put the new binding last in MENU.
409 BEFORE can be either a string (menu item name) or a symbol
410 \(the fake function key for the menu item).
411 KEY does not have to be a symbol, and comparison is done with equal."
414 tail done)
419 ;; If key is nil, stop here, otherwise keep going past the
420 ;; inserted element so we can delete any duplications that come
421 ;; later.
442 "Return t if NAME is the name of menu item ITEM.
443 NAME can be either a string, or a symbol.
444 ITEM should be a keymap binding of the form (KEY . MENU-ITEM)."
449 ;; Match against the text that is displayed to the user.
452 ;; Also check the string version of the symbol name,
453 ;; for backwards compatibility.
457 "Return true if form X never evaluates to nil."
464 "Return a unique symbol with CALLBACK as function value.
465 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
466 \(i.e. does not need to be turned into a function)."
472 ;; `functionp' is probably not needed.
474 callback
476 command))
478 ;;;###autoload
480 "Change menu found at PATH as item NAME to contain ITEMS.
481 PATH is a list of strings for locating the menu that
482 should contain a submenu named NAME.
483 ITEMS is a list of menu items, as in `easy-menu-define'.
484 These items entirely replace the previous items in that submenu.
486 If MAP is specified, it should normally be a keymap; nil stands for the local
487 menu-bar keymap. It can also be a symbol, which has earlier been used as the
488 first argument in a call to `easy-menu-define', or the value of such a symbol.
490 If the menu located by PATH has no submenu named NAME, add one.
491 If the optional argument BEFORE is present, add it just before
492 the submenu named BEFORE, otherwise add it at the end of the menu.
494 To implement dynamic menus, either call this from
495 `menu-bar-update-hook' or use a menu filter."
498 ;; XEmacs needs the following two functions to add and remove menus.
499 ;; In Emacs this is done automatically when switching keymaps, so
500 ;; here easy-menu-remove is a noop and easy-menu-add only precalculates
501 ;; equivalent keybindings (if easy-menu-precalculate-equivalent-keybindings
502 ;; is on).
504 "Remove MENU from the current menu bar.
505 Contrary to XEmacs, this is a nop on Emacs since menus are automatically
506 \(de)activated when the corresponding keymap is (de)activated.
511 "Add the menu to the menubar.
512 On Emacs, menus are already automatically activated when the
513 corresponding keymap is activated. On XEmacs this is needed to
514 actually add the menu to the current menubar.
516 This also precalculates equivalent key bindings when
517 `easy-menu-precalculate-equivalent-keybindings' is on.
519 You should call this once the menu and keybindings are set up
520 completely and menu filter functions can be expected to work."
526 ))
529 "Add submenu SUBMENU in the menu at MENU-PATH.
530 If BEFORE is non-nil, add before the item named BEFORE.
531 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
532 This is a compatibility function; use `easy-menu-add-item'."
535 submenu before))
538 "To the submenu of MAP with path PATH, add ITEM.
540 If an item with the same name is already present in this submenu,
541 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
542 In the latter case, ITEM is normally added at the end of the submenu.
543 However, if BEFORE is a string and there is an item in the submenu
544 with that name, then ITEM is added before that item.
546 MAP should normally be a keymap; nil stands for the local menu-bar keymap.
547 It can also be a symbol, which has earlier been used as the first
548 argument in a call to `easy-menu-define', or the value of such a symbol.
550 PATH is a list of strings for locating the submenu where ITEM is to be
551 added. If PATH is nil, MAP itself is used. Otherwise, the first
552 element should be the name of a submenu directly under MAP. This
553 submenu is then traversed recursively with the remaining elements of PATH.
555 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
556 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
557 earlier by `easy-menu-define' or `easy-menu-create-menu'."
563 ;; This is a value returned by `easy-menu-item-present-p' or
564 ;; `easy-menu-remove-item'.
570 ;; Item is a keymap, find the prompt string and use as item name.
576 "In submenu of MAP with path PATH, return non-nil if item NAME is present.
577 MAP and PATH are defined as in `easy-menu-add-item'.
578 NAME should be a string, the name of the element to be looked for."
582 "From submenu of MAP with path PATH remove item NAME.
583 MAP and PATH are defined as in `easy-menu-add-item'.
584 NAME should be a string, the name of the element to be removed."
588 ret))
591 "In menu MENU try to look for menu item with name NAME.
592 If a menu item is found, return (NAME . item), otherwise return nil.
593 If item is an old format item, a new format item is returned."
594 ;; The call to `lookup-key' also calls the C function `get_keyelt' which
595 ;; looks inside a menu-item to only return the actual command. This is
596 ;; not what we want here. We should either add an arg to lookup-key to be
597 ;; able to turn off this "feature", or else we could use map-keymap here.
598 ;; In the mean time, I just use `assq' which is an OK approximation since
599 ;; menus are rarely built from vectors or char-tables.
602 ret enable cache label)
605 ;; This is the old menu format. Convert it to new format.
620 )))
623 "Lookup menu item NAME in keymap MAP.
624 Like `lookup-key' except that NAME is not an array but just a single key
625 and that NAME can be a string representing the menu item's name."
628 ;; `lookup-key' failed and we have a menu item name: look at the
629 ;; actual menu entries's names.
634 ;; Found it!! Look for it again with
635 ;; `lookup-key' so as to handle inheritance and
636 ;; to extract the actual command/keymap bound to
637 ;; `name' from the item (via get_keyelt).
639 map)))))
642 "Return a sparse keymap in which to add or remove an item.
643 MAP and PATH are as defined in `easy-menu-add-item'.
645 TO-MODIFY, if non-nil, is the name of the item the caller
646 wants to modify in the map that we return.
647 In some cases we use that to select between the local and global maps."
654 ;; Look for PATH in each map.
660 map name))
662 maps))))
664 ;; Prefer a map that already contains the to-be-modified entry.
669 ;; Use the first valid map.
672 ;; Otherwise, make one up.
673 ;; Hardcoding current-local-map is lame, but it's difficult
674 ;; to know what the caller intended for us to do ;-(
680 newmap))))
682 map)
686 ;; arch-tag: 2a04020d-90d2-476d-a7c6-71e072007a4a
687 ;;; easymenu.el ends here