| blob | 9992861fc3c2437751866a12ddc4af0062e01001 |
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 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:
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
46 ;;;###autoload
48 "Define a menu bar submenu in maps MAPS, according to MENU.
50 If SYMBOL is non-nil, store the menu keymap in the value of SYMBOL,
51 and define SYMBOL as a function to pop up the menu, with DOC as its doc string.
52 If SYMBOL is nil, just store the menu keymap into MAPS.
54 The first element of MENU must be a string. It is the menu bar item name.
55 It may be followed by the following keyword argument pairs
57 :filter FUNCTION
59 FUNCTION is a function with one argument, the rest of menu items.
60 It returns the remaining items of the displayed menu.
62 :visible INCLUDE
64 INCLUDE is an expression; this menu is only visible if this
65 expression has a non-nil value. `:included' is an alias for `:visible'.
67 :active ENABLE
69 ENABLE is an expression; the menu is enabled for selection
70 whenever this expression's value is non-nil.
72 The rest of the elements in MENU, are menu items.
74 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
76 NAME is a string--the menu item name.
78 CALLBACK is a command to run when the item is chosen,
79 or a list to evaluate when the item is chosen.
81 ENABLE is an expression; the item is enabled for selection
82 whenever this expression's value is non-nil.
84 Alternatively, a menu item may have the form:
86 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
88 Where KEYWORD is one of the symbols defined below.
90 :keys KEYS
92 KEYS is a string; a complex keyboard equivalent to this menu item.
93 This is normally not needed because keyboard equivalents are usually
94 computed automatically.
95 KEYS is expanded with `substitute-command-keys' before it is used.
97 :key-sequence KEYS
99 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
100 menu item.
101 This is a hint that will considerably speed up Emacs' first display of
102 a menu. Use `:key-sequence nil' when you know that this menu item has no
103 keyboard equivalent.
105 :active ENABLE
107 ENABLE is an expression; the item is enabled for selection
108 whenever this expression's value is non-nil.
110 :visible INCLUDE
112 INCLUDE is an expression; this item is only visible if this
113 expression has a non-nil value. `:included' is an alias for `:visible'.
115 :label FORM
117 FORM is an expression that will be dynamically evaluated and whose
118 value will be used for the menu entry's text label (the default is NAME).
120 :suffix FORM
122 FORM is an expression that will be dynamically evaluated and whose
123 value will be concatenated to the menu entry's label.
125 :style STYLE
127 STYLE is a symbol describing the type of menu item. The following are
128 defined:
130 toggle: A checkbox.
131 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
132 radio: A radio button.
133 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
134 button: Surround the name with `[' and `]'. Use this for an item in the
135 menu bar itself.
136 anything else means an ordinary menu item.
138 :selected SELECTED
140 SELECTED is an expression; the checkbox or radio button is selected
141 whenever this expression's value is non-nil.
143 :help HELP
145 HELP is a string, the help to display for the menu item.
147 A menu item can be a string. Then that string appears in the menu as
148 unselectable text. A string consisting solely of hyphens is displayed
149 as a solid horizontal line.
151 A menu item can be a list with the same format as MENU. This is a submenu."
158 "Return a binding suitable to pass to `define-key'.
159 This is expected to be bound to a mouse event."
160 ;; Under Emacs this is almost trivial, whereas under XEmacs this may
161 ;; involve defining a function that calls popup-menu.
172 ;;;###autoload
174 ;; We can't do anything that might differ between Emacs dialects in
175 ;; `easy-menu-define' in order to make byte compiled files
176 ;; compatible. Therefore everything interesting is done in this
177 ;; function.
183 ;; FIXME: XEmacs uses popup-menu which calls the binding
184 ;; while x-popup-menu only returns the selection.
199 "Convert MENU to the right thing to return from a menu filter.
200 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
201 a symbol whose value is such a menu.
202 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
203 return a menu items list (without menu name and keywords).
204 This function returns the right thing in the two cases.
205 If NAME is provided, it is used for the keymap."
208 ;; If it's a cons but not a keymap, then it can't be right
209 ;; unless it's an XEmacs menu.
212 ;; It's just a menu entry.
214 menu)
217 "Dynamically scoped var to register already used keys in a menu.
218 If it holds a list, this is expected to be a list of keys already seen in the
221 ;;;###autoload
223 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
224 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
225 possibly preceded by keyword pairs as described in `easy-menu-define'."
228 prop keyword arg label enable filter visible help)
229 ;; Look for keywords.
245 nil ; Invisible menu entry, return nil.
254 ;; The filter expects the menu in its XEmacs form and the pre-filter
255 ;; form will only be passed to the filter anyway, so we'd better
256 ;; not convert it at all (it will be converted on the fly by
257 ;; easy-menu-filter-return).
263 menu)))
266 ;; Known button types.
273 "Memoize the value returned by `easy-menu-convert-item-1' called on ITEM.
274 This makes key-shortcut-caching work a *lot* better when this
275 conversion is done from within a filter.
276 This also helps when the NAME of the entry is recreated each time:
277 since the menu is built and traversed separately, the lookup
278 would always fail because the key is `equal' but not `eq'."
283 ;; Merging multiple entries with the same name is sometimes what we
284 ;; want, but not when the entries are actually different (e.g. same
285 ;; name but different :suffix as seen in cal-menu.el) and appear in
286 ;; the same menu. So we try to detect and resolve conflicts.
288 ;; We need to use some distinct object, ideally a symbol, ideally
289 ;; related to the `name'. Uninterned symbols do not work (they
290 ;; are apparently turned into strings and re-interned later on).
297 result))
300 "Parse an item description and convert it to a menu keymap element.
301 ITEM defines an item as in `easy-menu-define'."
312 ;; Invisible menu item. Don't insert into keymap.
323 cache cache-specified)
328 keyword arg suffix visible style selected keys)
364 keys)
381 ;; Invisible menu item. Don't insert into keymap.
390 ;; `intern' the name so as to merge multiple entries with the same name.
391 ;; It also makes it easier/possible to lookup/change menu bindings
392 ;; via keymap functions.
402 "Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
403 If KEY is not nil then delete any duplications.
404 If ITEM is nil, then delete the definition of KEY.
406 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil,
407 put binding before the item in MENU named BEFORE; otherwise,
408 if a binding for KEY is already present in MENU, just change it;
409 otherwise put the new binding last in MENU.
410 BEFORE can be either a string (menu item name) or a symbol
411 \(the fake function key for the menu item).
412 KEY does not have to be a symbol, and comparison is done with equal."
415 tail done)
420 ;; If key is nil, stop here, otherwise keep going past the
421 ;; inserted element so we can delete any duplications that come
422 ;; later.
443 "Return t if NAME is the name of menu item ITEM.
444 NAME can be either a string, or a symbol.
445 ITEM should be a keymap binding of the form (KEY . MENU-ITEM)."
450 ;; Match against the text that is displayed to the user.
453 ;; Also check the string version of the symbol name,
454 ;; for backwards compatibility.
458 "Return true if form X never evaluates to nil."
465 "Return a unique symbol with CALLBACK as function value.
466 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
467 \(i.e. does not need to be turned into a function)."
473 ;; `functionp' is probably not needed.
475 callback
477 command))
479 ;;;###autoload
481 "Change menu found at PATH as item NAME to contain ITEMS.
482 PATH is a list of strings for locating the menu that
483 should contain a submenu named NAME.
484 ITEMS is a list of menu items, as in `easy-menu-define'.
485 These items entirely replace the previous items in that submenu.
487 If MAP is specified, it should normally be a keymap; nil stands for the local
488 menu-bar keymap. It can also be a symbol, which has earlier been used as the
489 first argument in a call to `easy-menu-define', or the value of such a symbol.
491 If the menu located by PATH has no submenu named NAME, add one.
492 If the optional argument BEFORE is present, add it just before
493 the submenu named BEFORE, otherwise add it at the end of the menu.
495 To implement dynamic menus, either call this from
496 `menu-bar-update-hook' or use a menu filter."
499 ;; XEmacs needs the following two functions to add and remove menus.
500 ;; In Emacs this is done automatically when switching keymaps, so
501 ;; here easy-menu-remove is a noop.
503 "Remove MENU from the current menu bar.
504 Contrary to XEmacs, this is a nop on Emacs since menus are automatically
505 \(de)activated when the corresponding keymap is (de)activated.
510 "Add the menu to the menubar.
511 On Emacs, menus are already automatically activated when the
512 corresponding keymap is activated. On XEmacs this is needed to
513 actually add the menu to the current menubar.
515 You should call this once the menu and keybindings are set up
516 completely and menu filter functions can be expected to work."
517 )
520 "Add submenu SUBMENU in the menu at MENU-PATH.
521 If BEFORE is non-nil, add before the item named BEFORE.
522 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
523 This is a compatibility function; use `easy-menu-add-item'."
526 submenu before))
529 "To the submenu of MAP with path PATH, add ITEM.
531 If an item with the same name is already present in this submenu,
532 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
533 In the latter case, ITEM is normally added at the end of the submenu.
534 However, if BEFORE is a string and there is an item in the submenu
535 with that name, then ITEM is added before that item.
537 MAP should normally be a keymap; nil stands for the local menu-bar keymap.
538 It can also be a symbol, which has earlier been used as the first
539 argument in a call to `easy-menu-define', or the value of such a symbol.
541 PATH is a list of strings for locating the submenu where ITEM is to be
542 added. If PATH is nil, MAP itself is used. Otherwise, the first
543 element should be the name of a submenu directly under MAP. This
544 submenu is then traversed recursively with the remaining elements of PATH.
546 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
547 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
548 earlier by `easy-menu-define' or `easy-menu-create-menu'."
554 ;; This is a value returned by `easy-menu-item-present-p' or
555 ;; `easy-menu-remove-item'.
561 ;; Item is a keymap, find the prompt string and use as item name.
567 "In submenu of MAP with path PATH, return non-nil if item NAME is present.
568 MAP and PATH are defined as in `easy-menu-add-item'.
569 NAME should be a string, the name of the element to be looked for."
573 "From submenu of MAP with path PATH remove item NAME.
574 MAP and PATH are defined as in `easy-menu-add-item'.
575 NAME should be a string, the name of the element to be removed."
579 ret))
582 "In menu MENU try to look for menu item with name NAME.
583 If a menu item is found, return (NAME . item), otherwise return nil.
584 If item is an old format item, a new format item is returned."
585 ;; The call to `lookup-key' also calls the C function `get_keyelt' which
586 ;; looks inside a menu-item to only return the actual command. This is
587 ;; not what we want here. We should either add an arg to lookup-key to be
588 ;; able to turn off this "feature", or else we could use map-keymap here.
589 ;; In the mean time, I just use `assq' which is an OK approximation since
590 ;; menus are rarely built from vectors or char-tables.
593 ret enable cache label)
596 ;; This is the old menu format. Convert it to new format.
611 )))
614 "Lookup menu item NAME in keymap MAP.
615 Like `lookup-key' except that NAME is not an array but just a single key
616 and that NAME can be a string representing the menu item's name."
619 ;; `lookup-key' failed and we have a menu item name: look at the
620 ;; actual menu entries's names.
625 ;; Found it!! Look for it again with
626 ;; `lookup-key' so as to handle inheritance and
627 ;; to extract the actual command/keymap bound to
628 ;; `name' from the item (via get_keyelt).
630 map)))))
633 "Return a sparse keymap in which to add or remove an item.
634 MAP and PATH are as defined in `easy-menu-add-item'.
636 TO-MODIFY, if non-nil, is the name of the item the caller
637 wants to modify in the map that we return.
638 In some cases we use that to select between the local and global maps."
645 ;; Look for PATH in each map.
651 map name))
653 maps))))
655 ;; Prefer a map that already contains the to-be-modified entry.
660 ;; Use the first valid map.
663 ;; Otherwise, make one up.
664 ;; Hardcoding current-local-map is lame, but it's difficult
665 ;; to know what the caller intended for us to do ;-(
671 newmap))))
673 map)
677 ;; arch-tag: 2a04020d-90d2-476d-a7c6-71e072007a4a
678 ;;; easymenu.el ends here