| blob | 7f9f8a336348a8afb21f2ec3105c5eb4f4f9628c |
1 ;;; easymenu.el --- support the easymenu interface for defining a menu
3 ;; Copyright (C) 1994, 1996, 1998-2012 Free Software Foundation, Inc.
5 ;; Keywords: emulations
6 ;; Author: Richard Stallman <rms@gnu.org>
7 ;; Package: emacs
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
45 ;;;###autoload
47 "Define a menu bar submenu in maps MAPS, according to MENU.
49 If SYMBOL is non-nil, store the menu keymap in the value of SYMBOL,
50 and define SYMBOL as a function to pop up the menu, with DOC as its doc string.
51 If SYMBOL is nil, just store the menu keymap into MAPS.
53 The first element of MENU must be a string. It is the menu bar item name.
54 It may be followed by the following keyword argument pairs
56 :filter FUNCTION
58 FUNCTION is a function with one argument, the rest of menu items.
59 It returns the remaining items of the displayed menu.
61 :visible INCLUDE
63 INCLUDE is an expression; this menu is only visible if this
64 expression has a non-nil value. `:included' is an alias for `:visible'.
66 :active ENABLE
68 ENABLE is an expression; the menu is enabled for selection whenever
69 this expression's value is non-nil. `:enable' is an alias for `:active'.
71 The rest of the elements in MENU, are menu items.
73 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
75 NAME is a string--the menu item name.
77 CALLBACK is a command to run when the item is chosen,
78 or a list to evaluate when the item is chosen.
80 ENABLE is an expression; the item is enabled for selection
81 whenever this expression's value is non-nil.
83 Alternatively, a menu item may have the form:
85 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
87 Where KEYWORD is one of the symbols defined below.
89 :keys KEYS
91 KEYS is a string; a complex keyboard equivalent to this menu item.
92 This is normally not needed because keyboard equivalents are usually
93 computed automatically.
94 KEYS is expanded with `substitute-command-keys' before it is used.
96 :key-sequence KEYS
98 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
99 menu item.
100 This is a hint that will considerably speed up Emacs's first display of
101 a menu. Use `:key-sequence nil' when you know that this menu item has no
102 keyboard equivalent.
104 :active ENABLE
106 ENABLE is an expression; the item is enabled for selection whenever
107 this expression's value is non-nil. `:enable' is an alias for `:active'.
109 :visible INCLUDE
111 INCLUDE is an expression; this item is only visible if this
112 expression has a non-nil value. `:included' is an alias for `:visible'.
114 :label FORM
116 FORM is an expression that will be dynamically evaluated and whose
117 value will be used for the menu entry's text label (the default is NAME).
119 :suffix FORM
121 FORM is an expression that will be dynamically evaluated and whose
122 value will be concatenated to the menu entry's label.
124 :style STYLE
126 STYLE is a symbol describing the type of menu item. The following are
127 defined:
129 toggle: A checkbox.
130 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
131 radio: A radio button.
132 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
133 button: Surround the name with `[' and `]'. Use this for an item in the
134 menu bar itself.
135 anything else means an ordinary menu item.
137 :selected SELECTED
139 SELECTED is an expression; the checkbox or radio button is selected
140 whenever this expression's value is non-nil.
142 :help HELP
144 HELP is a string, the help to display for the menu item.
146 A menu item can be a string. Then that string appears in the menu as
147 unselectable text. A string consisting solely of hyphens is displayed
148 as a solid horizontal line.
150 A menu item can be a list with the same format as MENU. This is a submenu."
157 "Return a binding suitable to pass to `define-key'.
158 This is expected to be bound to a mouse event."
159 ;; Under Emacs this is almost trivial, whereas under XEmacs this may
160 ;; involve defining a function that calls popup-menu.
174 ;;;###autoload
176 ;; We can't do anything that might differ between Emacs dialects in
177 ;; `easy-menu-define' in order to make byte compiled files
178 ;; compatible. Therefore everything interesting is done in this
179 ;; function.
185 ;; FIXME: XEmacs uses popup-menu which calls the binding
186 ;; while x-popup-menu only returns the selection.
201 "Convert MENU to the right thing to return from a menu filter.
202 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
203 a symbol whose value is such a menu.
204 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
205 return a menu items list (without menu name and keywords).
206 This function returns the right thing in the two cases.
207 If NAME is provided, it is used for the keymap."
210 ;; If it's a cons but not a keymap, then it can't be right
211 ;; unless it's an XEmacs menu.
214 ;; It's just a menu entry.
216 menu)
219 "Dynamically scoped var to register already used keys in a menu.
220 If it holds a list, this is expected to be a list of keys already seen in the
223 ;;;###autoload
225 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
226 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
227 possibly preceded by keyword pairs as described in `easy-menu-define'."
230 prop keyword arg label enable filter visible help)
231 ;; Look for keywords.
238 (`:filter
246 nil ; Invisible menu entry, return nil.
255 ;; The filter expects the menu in its XEmacs form and the
256 ;; pre-filter form will only be passed to the filter
257 ;; anyway, so we'd better not convert it at all (it will
258 ;; be converted on the fly by easy-menu-filter-return).
259 menu-items
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'."
284 ;; Merging multiple entries with the same name is sometimes what we
285 ;; want, but not when the entries are actually different (e.g. same
286 ;; name but different :suffix as seen in cal-menu.el) and appear in
287 ;; the same menu. So we try to detect and resolve conflicts.
289 ;; We need to use some distinct object, ideally a symbol, ideally
290 ;; related to the `name'. Uninterned symbols do not work (they
291 ;; are apparently turned into strings and re-interned later on).
298 result))
301 "Parse an item description and convert it to a menu keymap element.
302 ITEM defines an item as in `easy-menu-define'."
313 ;; Invisible menu item. Don't insert into keymap.
324 cache cache-specified)
329 keyword arg suffix visible style selected keys)
363 keys)
380 ;; Invisible menu item. Don't insert into keymap.
389 ;; `intern' the name so as to merge multiple entries with the same name.
390 ;; It also makes it easier/possible to lookup/change menu bindings
391 ;; via keymap functions.
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.
502 "Remove MENU from the current menu bar.
503 Contrary to XEmacs, this is a nop on Emacs since menus are automatically
504 \(de)activated when the corresponding keymap is (de)activated.
509 "Add the menu to the menubar.
510 On Emacs, menus are already automatically activated when the
511 corresponding keymap is activated. On XEmacs this is needed to
512 actually add the menu to the current menubar.
514 You should call this once the menu and keybindings are set up
515 completely and menu filter functions can be expected to work."
516 )
519 "Add submenu SUBMENU in the menu at MENU-PATH.
520 If BEFORE is non-nil, add before the item named BEFORE.
521 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
522 This is a compatibility function; use `easy-menu-add-item'."
525 submenu before))
528 "To the submenu of MAP with path PATH, add ITEM.
530 If an item with the same name is already present in this submenu,
531 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
532 In the latter case, ITEM is normally added at the end of the submenu.
533 However, if BEFORE is a string and there is an item in the submenu
534 with that name, then ITEM is added before that item.
536 MAP should normally be a keymap; nil stands for the local menu-bar keymap.
537 It can also be a symbol, which has earlier been used as the first
538 argument in a call to `easy-menu-define', or the value of such a symbol.
540 PATH is a list of strings for locating the submenu where ITEM is to be
541 added. If PATH is nil, MAP itself is used. Otherwise, the first
542 element should be the name of a submenu directly under MAP. This
543 submenu is then traversed recursively with the remaining elements of PATH.
545 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
546 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
547 earlier by `easy-menu-define' or `easy-menu-create-menu'."
553 ;; This is a value returned by `easy-menu-item-present-p' or
554 ;; `easy-menu-remove-item'.
560 ;; Item is a keymap, find the prompt string and use as item name.
566 "In submenu of MAP with path PATH, return non-nil if item NAME is present.
567 MAP and PATH are defined as in `easy-menu-add-item'.
568 NAME should be a string, the name of the element to be looked for."
572 "From submenu of MAP with path PATH remove item NAME.
573 MAP and PATH are defined as in `easy-menu-add-item'.
574 NAME should be a string, the name of the element to be removed."
578 ret))
581 "In menu MENU try to look for menu item with name NAME.
582 If a menu item is found, return (NAME . item), otherwise return nil.
583 If item is an old format item, a new format item is returned."
584 ;; The call to `lookup-key' also calls the C function `get_keyelt' which
585 ;; looks inside a menu-item to only return the actual command. This is
586 ;; not what we want here. We should either add an arg to lookup-key to be
587 ;; able to turn off this "feature", or else we could use map-keymap here.
588 ;; In the mean time, I just use `assq' which is an OK approximation since
589 ;; menus are rarely built from vectors or char-tables.
592 ret enable cache label)
595 ;; This is the old menu format. Convert it to new format.
610 )))
613 "Lookup menu item NAME in keymap MAP.
614 Like `lookup-key' except that NAME is not an array but just a single key
615 and that NAME can be a string representing the menu item's name."
618 ;; `lookup-key' failed and we have a menu item name: look at the
619 ;; actual menu entries's names.
624 ;; Found it!! Look for it again with
625 ;; `lookup-key' so as to handle inheritance and
626 ;; to extract the actual command/keymap bound to
627 ;; `name' from the item (via get_keyelt).
629 map)))))
632 "Return a sparse keymap in which to add or remove an item.
633 MAP and PATH are as defined in `easy-menu-add-item'.
635 TO-MODIFY, if non-nil, is the name of the item the caller
636 wants to modify in the map that we return.
637 In some cases we use that to select between the local and global maps."
644 ;; Look for PATH in each map.
650 map name))
652 maps))))
654 ;; Prefer a map that already contains the to-be-modified entry.
659 ;; Use the first valid map.
662 ;; Otherwise, make one up.
663 ;; Hardcoding current-local-map is lame, but it's difficult
664 ;; to know what the caller intended for us to do ;-(
670 newmap))))
672 map)
676 ;;; easymenu.el ends here