| blob | ac0853a0544043d897c2faa114ba9a49b60371b8 |
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, 2009, 2010, 2011 Free Software Foundation, Inc.
6 ;; Keywords: emulations
7 ;; Author: Richard Stallman <rms@gnu.org>
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
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:
36 "Determine when equivalent key bindings are computed for easy-menu menus.
37 It can take some time to calculate the equivalent key bindings that are shown
38 in a menu. If the variable is on, then this calculation gives a (maybe
39 noticeable) delay when a mode is first entered. If the variable is off, then
40 this delay will come when a menu is displayed the first time. If you never use
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 whenever
72 this expression's value is non-nil. `:enable' is an alias for `:active'.
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 whenever
110 this expression's value is non-nil. `:enable' is an alias for `:active'.
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."
160 "Return a binding suitable to pass to `define-key'.
161 This is expected to be bound to a mouse event."
162 ;; Under Emacs this is almost trivial, whereas under XEmacs this may
163 ;; involve defining a function that calls popup-menu.
177 ;;;###autoload
179 ;; We can't do anything that might differ between Emacs dialects in
180 ;; `easy-menu-define' in order to make byte compiled files
181 ;; compatible. Therefore everything interesting is done in this
182 ;; function.
188 ;; FIXME: XEmacs uses popup-menu which calls the binding
189 ;; while x-popup-menu only returns the selection.
204 "Convert MENU to the right thing to return from a menu filter.
205 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
206 a symbol whose value is such a menu.
207 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
208 return a menu items list (without menu name and keywords).
209 This function returns the right thing in the two cases.
210 If NAME is provided, it is used for the keymap."
213 ;; If it's a cons but not a keymap, then it can't be right
214 ;; unless it's an XEmacs menu.
217 ;; It's just a menu entry.
219 menu)
222 "Dynamically scoped var to register already used keys in a menu.
223 If it holds a list, this is expected to be a list of keys already seen in the
226 ;;;###autoload
228 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
229 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
230 possibly preceded by keyword pairs as described in `easy-menu-define'."
233 prop keyword arg label enable filter visible help)
234 ;; Look for keywords.
241 (:filter
249 nil ; Invisible menu entry, return nil.
258 ;; The filter expects the menu in its XEmacs form and the
259 ;; pre-filter form will only be passed to the filter
260 ;; anyway, so we'd better not convert it at all (it will
261 ;; be converted on the fly by easy-menu-filter-return).
262 menu-items
267 menu)))
270 ;; Known button types.
277 "Memoize the value returned by `easy-menu-convert-item-1' called on ITEM.
278 This makes key-shortcut-caching work a *lot* better when this
279 conversion is done from within a filter.
280 This also helps when the NAME of the entry is recreated each time:
281 since the menu is built and traversed separately, the lookup
282 would always fail because the key is `equal' but not `eq'."
287 ;; Merging multiple entries with the same name is sometimes what we
288 ;; want, but not when the entries are actually different (e.g. same
289 ;; name but different :suffix as seen in cal-menu.el) and appear in
290 ;; the same menu. So we try to detect and resolve conflicts.
292 ;; We need to use some distinct object, ideally a symbol, ideally
293 ;; related to the `name'. Uninterned symbols do not work (they
294 ;; are apparently turned into strings and re-interned later on).
301 result))
304 "Parse an item description and convert it to a menu keymap element.
305 ITEM defines an item as in `easy-menu-define'."
316 ;; Invisible menu item. Don't insert into keymap.
327 cache cache-specified)
332 keyword arg suffix visible style selected keys)
366 keys)
383 ;; Invisible menu item. Don't insert into keymap.
392 ;; `intern' the name so as to merge multiple entries with the same name.
393 ;; It also makes it easier/possible to lookup/change menu bindings
394 ;; via keymap functions.
404 "Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
405 If KEY is not nil then delete any duplications.
406 If ITEM is nil, then delete the definition of KEY.
408 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil,
409 put binding before the item in MENU named BEFORE; otherwise,
410 if a binding for KEY is already present in MENU, just change it;
411 otherwise put the new binding last in MENU.
412 BEFORE can be either a string (menu item name) or a symbol
413 \(the fake function key for the menu item).
414 KEY does not have to be a symbol, and comparison is done with equal."
417 tail done)
422 ;; If key is nil, stop here, otherwise keep going past the
423 ;; inserted element so we can delete any duplications that come
424 ;; later.
445 "Return t if NAME is the name of menu item ITEM.
446 NAME can be either a string, or a symbol.
447 ITEM should be a keymap binding of the form (KEY . MENU-ITEM)."
452 ;; Match against the text that is displayed to the user.
455 ;; Also check the string version of the symbol name,
456 ;; for backwards compatibility.
460 "Return true if form X never evaluates to nil."
467 "Return a unique symbol with CALLBACK as function value.
468 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
469 \(i.e. does not need to be turned into a function)."
475 ;; `functionp' is probably not needed.
477 callback
479 command))
481 ;;;###autoload
483 "Change menu found at PATH as item NAME to contain ITEMS.
484 PATH is a list of strings for locating the menu that
485 should contain a submenu named NAME.
486 ITEMS is a list of menu items, as in `easy-menu-define'.
487 These items entirely replace the previous items in that submenu.
489 If MAP is specified, it should normally be a keymap; nil stands for the local
490 menu-bar keymap. It can also be a symbol, which has earlier been used as the
491 first argument in a call to `easy-menu-define', or the value of such a symbol.
493 If the menu located by PATH has no submenu named NAME, add one.
494 If the optional argument BEFORE is present, add it just before
495 the submenu named BEFORE, otherwise add it at the end of the menu.
497 To implement dynamic menus, either call this from
498 `menu-bar-update-hook' or use a menu filter."
501 ;; XEmacs needs the following two functions to add and remove menus.
502 ;; In Emacs this is done automatically when switching keymaps, so
503 ;; here easy-menu-remove is a noop.
505 "Remove MENU from the current menu bar.
506 Contrary to XEmacs, this is a nop on Emacs since menus are automatically
507 \(de)activated when the corresponding keymap is (de)activated.
512 "Add the menu to the menubar.
513 On Emacs, menus are already automatically activated when the
514 corresponding keymap is activated. On XEmacs this is needed to
515 actually add the menu to the current menubar.
517 You should call this once the menu and keybindings are set up
518 completely and menu filter functions can be expected to work."
519 )
522 "Add submenu SUBMENU in the menu at MENU-PATH.
523 If BEFORE is non-nil, add before the item named BEFORE.
524 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
525 This is a compatibility function; use `easy-menu-add-item'."
528 submenu before))
531 "To the submenu of MAP with path PATH, add ITEM.
533 If an item with the same name is already present in this submenu,
534 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
535 In the latter case, ITEM is normally added at the end of the submenu.
536 However, if BEFORE is a string and there is an item in the submenu
537 with that name, then ITEM is added before that item.
539 MAP should normally be a keymap; nil stands for the local menu-bar keymap.
540 It can also be a symbol, which has earlier been used as the first
541 argument in a call to `easy-menu-define', or the value of such a symbol.
543 PATH is a list of strings for locating the submenu where ITEM is to be
544 added. If PATH is nil, MAP itself is used. Otherwise, the first
545 element should be the name of a submenu directly under MAP. This
546 submenu is then traversed recursively with the remaining elements of PATH.
548 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
549 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
550 earlier by `easy-menu-define' or `easy-menu-create-menu'."
556 ;; This is a value returned by `easy-menu-item-present-p' or
557 ;; `easy-menu-remove-item'.
563 ;; Item is a keymap, find the prompt string and use as item name.
569 "In submenu of MAP with path PATH, return non-nil if item NAME is present.
570 MAP and PATH are defined as in `easy-menu-add-item'.
571 NAME should be a string, the name of the element to be looked for."
575 "From submenu of MAP with path PATH remove item NAME.
576 MAP and PATH are defined as in `easy-menu-add-item'.
577 NAME should be a string, the name of the element to be removed."
581 ret))
584 "In menu MENU try to look for menu item with name NAME.
585 If a menu item is found, return (NAME . item), otherwise return nil.
586 If item is an old format item, a new format item is returned."
587 ;; The call to `lookup-key' also calls the C function `get_keyelt' which
588 ;; looks inside a menu-item to only return the actual command. This is
589 ;; not what we want here. We should either add an arg to lookup-key to be
590 ;; able to turn off this "feature", or else we could use map-keymap here.
591 ;; In the mean time, I just use `assq' which is an OK approximation since
592 ;; menus are rarely built from vectors or char-tables.
595 ret enable cache label)
598 ;; This is the old menu format. Convert it to new format.
613 )))
616 "Lookup menu item NAME in keymap MAP.
617 Like `lookup-key' except that NAME is not an array but just a single key
618 and that NAME can be a string representing the menu item's name."
621 ;; `lookup-key' failed and we have a menu item name: look at the
622 ;; actual menu entries's names.
627 ;; Found it!! Look for it again with
628 ;; `lookup-key' so as to handle inheritance and
629 ;; to extract the actual command/keymap bound to
630 ;; `name' from the item (via get_keyelt).
632 map)))))
635 "Return a sparse keymap in which to add or remove an item.
636 MAP and PATH are as defined in `easy-menu-add-item'.
638 TO-MODIFY, if non-nil, is the name of the item the caller
639 wants to modify in the map that we return.
640 In some cases we use that to select between the local and global maps."
647 ;; Look for PATH in each map.
653 map name))
655 maps))))
657 ;; Prefer a map that already contains the to-be-modified entry.
662 ;; Use the first valid map.
665 ;; Otherwise, make one up.
666 ;; Hardcoding current-local-map is lame, but it's difficult
667 ;; to know what the caller intended for us to do ;-(
673 newmap))))
675 map)
679 ;;; easymenu.el ends here