| blob | ca5151fa9846bdea33a3484e44ba3217fdf184d3 |
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, or (at your option)
14 ;; 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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; This is compatible with easymenu.el by Per Abrahamsen
29 ;; but it is much simpler as it doesn't try to support other Emacs versions.
30 ;; The code was mostly derived from lmenu.el.
32 ;;; Code:
35 "Determine when equivalent key bindings are computed for easy-menu menus.
36 It can take some time to calculate the equivalent key bindings that are shown
37 in a menu. If the variable is on, then this calculation gives a (maybe
38 noticeable) delay when a mode is first entered. If the variable is off, then
39 this delay will come when a menu is displayed the first time. If you never use
40 menus, turn this variable off, otherwise it is probably better to keep it on."
48 ;;;###autoload
50 ;;;###autoload
52 "Define a menu bar submenu in maps MAPS, according to MENU.
54 If SYMBOL is non-nil, store the menu keymap in the value of SYMBOL,
55 and define SYMBOL as a function to pop up the menu, with DOC as its doc string.
56 If SYMBOL is nil, just store the menu keymap into MAPS.
58 The first element of MENU must be a string. It is the menu bar item name.
59 It may be followed by the following keyword argument pairs
61 :filter FUNCTION
63 FUNCTION is a function with one argument, the rest of menu items.
64 It returns the remaining items of the displayed menu.
66 :visible INCLUDE
68 INCLUDE is an expression; this menu is only visible if this
69 expression has a non-nil value. `:included' is an alias for `:visible'.
71 :active ENABLE
73 ENABLE is an expression; the menu is enabled for selection
74 whenever this expression's value is non-nil.
76 The rest of the elements in MENU, are menu items.
78 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
80 NAME is a string--the menu item name.
82 CALLBACK is a command to run when the item is chosen,
83 or a list to evaluate when the item is chosen.
85 ENABLE is an expression; the item is enabled for selection
86 whenever this expression's value is non-nil.
88 Alternatively, a menu item may have the form:
90 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
92 Where KEYWORD is one of the symbols defined below.
94 :keys KEYS
96 KEYS is a string; a complex keyboard equivalent to this menu item.
97 This is normally not needed because keyboard equivalents are usually
98 computed automatically.
99 KEYS is expanded with `substitute-command-keys' before it is used.
101 :key-sequence KEYS
103 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
104 menu item.
105 This is a hint that will considerably speed up Emacs' first display of
106 a menu. Use `:key-sequence nil' when you know that this menu item has no
107 keyboard equivalent.
109 :active ENABLE
111 ENABLE is an expression; the item is enabled for selection
112 whenever this expression's value is non-nil.
114 :visible INCLUDE
116 INCLUDE is an expression; this item is only visible if this
117 expression has a non-nil value. `:included' is an alias for `:visible'.
119 :label FORM
121 FORM is an expression that will be dynamically evaluated and whose
122 value will be used for the menu entry's text label (the default is NAME).
124 :suffix FORM
126 FORM is an expression that will be dynamically evaluated and whose
127 value will be concatenated to the menu entry's label.
129 :style STYLE
131 STYLE is a symbol describing the type of menu item. The following are
132 defined:
134 toggle: A checkbox.
135 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
136 radio: A radio button.
137 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
138 button: Surround the name with `[' and `]'. Use this for an item in the
139 menu bar itself.
140 anything else means an ordinary menu item.
142 :selected SELECTED
144 SELECTED is an expression; the checkbox or radio button is selected
145 whenever this expression's value is non-nil.
147 :help HELP
149 HELP is a string, the help to display for the menu item.
151 A menu item can be a string. Then that string appears in the menu as
152 unselectable text. A string consisting solely of hyphens is displayed
153 as a solid horizontal line.
155 A menu item can be a list with the same format as MENU. This is a submenu."
161 "Return a binding suitable to pass to `define-key'.
162 This is expected to be bound to a mouse event."
163 ;; Under Emacs this is almost trivial, whereas under XEmacs this may
164 ;; involve defining a function that calls popup-menu.
175 ;;;###autoload
177 ;; We can't do anything that might differ between Emacs dialects in
178 ;; `easy-menu-define' in order to make byte compiled files
179 ;; compatible. Therefore everything interesting is done in this
180 ;; function.
186 ;; FIXME: XEmacs uses popup-menu which calls the binding
187 ;; while x-popup-menu only returns the selection.
202 "Convert MENU to the right thing to return from a menu filter.
203 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
204 a symbol whose value is such a menu.
205 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
206 return a menu items list (without menu name and keywords).
207 This function returns the right thing in the two cases.
208 If NAME is provided, it is used for the keymap."
211 ;; If it's a cons but not a keymap, then it can't be right
212 ;; unless it's an XEmacs menu.
215 ;; It's just a menu entry.
217 menu)
220 "Dynamically scoped var to register already used keys in a menu.
221 If it holds a list, this is expected to be a list of keys already seen in the
224 ;;;###autoload
226 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
227 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
228 possibly preceded by keyword pairs as described in `easy-menu-define'."
231 prop keyword arg label enable filter visible help)
232 ;; Look for keywords.
248 nil ; Invisible menu entry, return nil.
257 ;; The filter expects the menu in its XEmacs form and the pre-filter
258 ;; form will only be passed to the filter anyway, so we'd better
259 ;; not convert it at all (it will be converted on the fly by
260 ;; easy-menu-filter-return).
266 menu)))
269 ;; Known button types.
276 "Memoize the value returned by `easy-menu-convert-item-1' called on ITEM.
277 This makes key-shortcut-caching work a *lot* better when this
278 conversion is done from within a filter.
279 This also helps when the NAME of the entry is recreated each time:
280 since the menu is built and traversed separately, the lookup
281 would always fail because the key is `equal' but not `eq'."
284 easy-menu-converted-items-table)))
287 "Parse an item description and convert it to a menu keymap element.
288 ITEM defines an item as in `easy-menu-define'."
299 ;; Invisible menu item. Don't insert into keymap.
310 cache cache-specified)
315 keyword arg suffix visible style selected keys)
351 keys)
368 ;; Invisible menu item. Don't insert into keymap.
377 ;; `intern' the name so as to merge multiple entries with the same name.
378 ;; It also makes it easier/possible to lookup/change menu bindings
379 ;; via keymap functions.
382 ;; Merging multiple entries with the same name is sometimes what we
383 ;; want, but not when the entries are actually different (e.g. same
384 ;; name but different :suffix as seen in cal-menu.el) and appear in
385 ;; the same menu. So we try to detect and resolve conflicts.
388 ;; We need to use some distinct object, ideally a symbol, ideally
389 ;; related to the `name'. Uninterned symbols do not work (they
390 ;; are apparently turned into strings and re-interned later on).
403 "Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
404 If KEY is not nil then delete any duplications.
405 If ITEM is nil, then delete the definition of KEY.
407 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil,
408 put binding before the item in MENU named BEFORE; otherwise,
409 if a binding for KEY is already present in MENU, just change it;
410 otherwise put the new binding last in MENU.
411 BEFORE can be either a string (menu item name) or a symbol
412 \(the fake function key for the menu item).
413 KEY does not have to be a symbol, and comparison is done with equal."
416 tail done)
421 ;; If key is nil, stop here, otherwise keep going past the
422 ;; inserted element so we can delete any duplications that come
423 ;; later.
444 "Return t if NAME is the name of menu item ITEM.
445 NAME can be either a string, or a symbol.
446 ITEM should be a keymap binding of the form (KEY . MENU-ITEM)."
451 ;; Match against the text that is displayed to the user.
454 ;; Also check the string version of the symbol name,
455 ;; for backwards compatibility.
459 "Return true if form X never evaluates to nil."
466 "Return a unique symbol with CALLBACK as function value.
467 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
468 \(i.e. does not need to be turned into a function)."
475 command))
477 ;;;###autoload
479 "Change menu found at PATH as item NAME to contain ITEMS.
480 PATH is a list of strings for locating the menu that
481 should contain a submenu named NAME.
482 ITEMS is a list of menu items, as in `easy-menu-define'.
483 These items entirely replace the previous items in that submenu.
485 If MAP is specified, it should normally be a keymap; nil stands for the local
486 menu-bar keymap. It can also be a symbol, which has earlier been used as the
487 first argument in a call to `easy-menu-define', or the value of such a symbol.
489 If the menu located by PATH has no submenu named NAME, add one.
490 If the optional argument BEFORE is present, add it just before
491 the submenu named BEFORE, otherwise add it at the end of the menu.
493 To implement dynamic menus, either call this from
494 `menu-bar-update-hook' or use a menu filter."
497 ;; XEmacs needs the following two functions to add and remove menus.
498 ;; In Emacs this is done automatically when switching keymaps, so
499 ;; here easy-menu-remove is a noop and easy-menu-add only precalculates
500 ;; equivalent keybindings (if easy-menu-precalculate-equivalent-keybindings
501 ;; is on).
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 This also precalculates equivalent key bindings when
516 `easy-menu-precalculate-equivalent-keybindings' is on.
518 You should call this once the menu and keybindings are set up
519 completely and menu filter functions can be expected to work."
525 ))
528 "Add submenu SUBMENU in the menu at MENU-PATH.
529 If BEFORE is non-nil, add before the item named BEFORE.
530 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
531 This is a compatibility function; use `easy-menu-add-item'."
534 submenu before))
537 "To the submenu of MAP with path PATH, add ITEM.
539 If an item with the same name is already present in this submenu,
540 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
541 In the latter case, ITEM is normally added at the end of the submenu.
542 However, if BEFORE is a string and there is an item in the submenu
543 with that name, then ITEM is added before that item.
545 MAP should normally be a keymap; nil stands for the local menu-bar keymap.
546 It can also be a symbol, which has earlier been used as the first
547 argument in a call to `easy-menu-define', or the value of such a symbol.
549 PATH is a list of strings for locating the submenu where ITEM is to be
550 added. If PATH is nil, MAP itself is used. Otherwise, the first
551 element should be the name of a submenu directly under MAP. This
552 submenu is then traversed recursively with the remaining elements of PATH.
554 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
555 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
556 earlier by `easy-menu-define' or `easy-menu-create-menu'."
562 ;; This is a value returned by `easy-menu-item-present-p' or
563 ;; `easy-menu-remove-item'.
569 ;; Item is a keymap, find the prompt string and use as item name.
575 "In submenu of MAP with path PATH, return non-nil if item NAME is present.
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 looked for."
581 "From submenu of MAP with path PATH remove item NAME.
582 MAP and PATH are defined as in `easy-menu-add-item'.
583 NAME should be a string, the name of the element to be removed."
587 ret))
590 "In menu MENU try to look for menu item with name NAME.
591 If a menu item is found, return (NAME . item), otherwise return nil.
592 If item is an old format item, a new format item is returned."
593 ;; The call to `lookup-key' also calls the C function `get_keyelt' which
594 ;; looks inside a menu-item to only return the actual command. This is
595 ;; not what we want here. We should either add an arg to lookup-key to be
596 ;; able to turn off this "feature", or else we could use map-keymap here.
597 ;; In the mean time, I just use `assq' which is an OK approximation since
598 ;; menus are rarely built from vectors or char-tables.
601 ret enable cache label)
604 ;; This is the old menu format. Convert it to new format.
619 )))
622 "Lookup menu item NAME in keymap MAP.
623 Like `lookup-key' except that NAME is not an array but just a single key
624 and that NAME can be a string representing the menu item's name."
627 ;; `lookup-key' failed and we have a menu item name: look at the
628 ;; actual menu entries's names.
633 ;; Found it!! Look for it again with
634 ;; `lookup-key' so as to handle inheritance and
635 ;; to extract the actual command/keymap bound to
636 ;; `name' from the item (via get_keyelt).
638 map)))))
641 "Return a sparse keymap in which to add or remove an item.
642 MAP and PATH are as defined in `easy-menu-add-item'.
644 TO-MODIFY, if non-nil, is the name of the item the caller
645 wants to modify in the map that we return.
646 In some cases we use that to select between the local and global maps."
653 ;; Look for PATH in each map.
659 map name))
661 maps))))
663 ;; Prefer a map that already contains the to-be-modified entry.
668 ;; Use the first valid map.
671 ;; Otherwise, make one up.
672 ;; Hardcoding current-local-map is lame, but it's difficult
673 ;; to know what the caller intended for us to do ;-(
679 newmap))))
681 map)
685 ;; arch-tag: 2a04020d-90d2-476d-a7c6-71e072007a4a
686 ;;; easymenu.el ends here