| blob | e039b80aee5b2db94f9a16768f8a9c83c8c4885d |
1 ;;; easymenu.el --- support the easymenu interface for defining a menu
3 ;; Copyright (C) 1994,96,98,1999,2000,2004 Free Software Foundation, Inc.
5 ;; Keywords: emulations
6 ;; Author: Richard Stallman <rms@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
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
39 menus, turn this variable off, otherwise it is probably better to keep it on."
48 found)
49 ;; For each letter that starts a word, flip its case.
50 ;; This way, the usual convention for menu strings (capitalized)
51 ;; corresponds to the usual convention for menu item event types
52 ;; (all lower case). It's a 1-1 mapping so causes no conflicts.
63 s))
65 ;;;###autoload
67 ;;;###autoload
69 "Define a menu bar submenu in maps MAPS, according to MENU.
71 If SYMBOL is non-nil, store the menu keymap in the value of SYMBOL,
72 and define SYMBOL as a function to pop up the menu, with DOC as its doc string.
73 If SYMBOL is nil, just store the menu keymap into MAPS.
75 The first element of MENU must be a string. It is the menu bar item name.
76 It may be followed by the following keyword argument pairs
78 :filter FUNCTION
80 FUNCTION is a function with one argument, the rest of menu items.
81 It returns the remaining items of the displayed menu.
83 :visible INCLUDE
85 INCLUDE is an expression; this menu is only visible if this
86 expression has a non-nil value. `:include' is an alias for `:visible'.
88 :active ENABLE
90 ENABLE is an expression; the menu is enabled for selection
91 whenever this expression's value is non-nil.
93 The rest of the elements in MENU, are menu items.
95 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
97 NAME is a string--the menu item name.
99 CALLBACK is a command to run when the item is chosen,
100 or a list to evaluate when the item is chosen.
102 ENABLE is an expression; the item is enabled for selection
103 whenever this expression's value is non-nil.
105 Alternatively, a menu item may have the form:
107 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
109 Where KEYWORD is one of the symbols defined below.
111 :keys KEYS
113 KEYS is a string; a complex keyboard equivalent to this menu item.
114 This is normally not needed because keyboard equivalents are usually
115 computed automatically.
116 KEYS is expanded with `substitute-command-keys' before it is used.
118 :key-sequence KEYS
120 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
121 menu item.
122 This is a hint that will considerably speed up Emacs' first display of
123 a menu. Use `:key-sequence nil' when you know that this menu item has no
124 keyboard equivalent.
126 :active ENABLE
128 ENABLE is an expression; the item is enabled for selection
129 whenever this expression's value is non-nil.
131 :included INCLUDE
133 INCLUDE is an expression; this item is only visible if this
134 expression has a non-nil value.
136 :suffix FORM
138 FORM is an expression that will be dynamically evaluated and whose
139 value will be concatenated to the menu entry's NAME.
141 :style STYLE
143 STYLE is a symbol describing the type of menu item. The following are
144 defined:
146 toggle: A checkbox.
147 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
148 radio: A radio button.
149 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
150 button: Surround the name with `[' and `]'. Use this for an item in the
151 menu bar itself.
152 anything else means an ordinary menu item.
154 :selected SELECTED
156 SELECTED is an expression; the checkbox or radio button is selected
157 whenever this expression's value is non-nil.
159 :help HELP
161 HELP is a string, the help to display for the menu item.
163 A menu item can be a string. Then that string appears in the menu as
164 unselectable text. A string consisting solely of hyphens is displayed
165 as a solid horizontal line.
167 A menu item can be a list with the same format as MENU. This is a submenu."
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.
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)
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'."
227 prop keyword arg label enable filter visible help)
228 ;; Look for keywords.
244 nil ; Invisible menu entry, return nil.
253 ;; The filter expects the menu in its XEmacs form and the pre-filter
254 ;; form will only be passed to the filter anyway, so we'd better
255 ;; not convert it at all (it will be converted on the fly by
256 ;; easy-menu-filter-return).
262 menu)))
265 ;; 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.
388 "Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
389 If KEY is not nil then delete any duplications.
390 If ITEM is nil, then delete the definition of KEY.
392 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil,
393 put binding before the item in MENU named BEFORE; otherwise,
394 if a binding for KEY is already present in MENU, just change it;
395 otherwise put the new binding last in MENU.
396 BEFORE can be either a string (menu item name) or a symbol
397 \(the fake function key for the menu item).
398 KEY does not have to be a symbol, and comparison is done with equal."
400 tail done)
405 ;; If key is nil, stop here, otherwise keep going past the
406 ;; inserted element so we can delete any duplications that come
407 ;; later.
428 "Return t if NAME is the name of menu item ITEM.
429 NAME can be either a string, or a symbol."
434 ;; Match against the text that is displayed to the user.
437 ;; Also check the string version of the symbol name,
438 ;; for backwards compatibility.
443 "Return true if form X never evaluates to nil."
450 "Return a unique symbol with CALLBACK as function value.
451 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
452 \(i.e. does not need to be turned into a function)."
459 command))
461 ;;;###autoload
463 "Change menu found at PATH as item NAME to contain ITEMS.
464 PATH is a list of strings for locating the menu that
465 should contain a submenu named NAME.
466 ITEMS is a list of menu items, as in `easy-menu-define'.
467 These items entirely replace the previous items in that submenu.
469 If the menu located by PATH has no submenu named NAME, add one.
470 If the optional argument BEFORE is present, add it just before
471 the submenu named BEFORE, otherwise add it at the end of the menu.
473 Either call this from `menu-bar-update-hook' or use a menu filter,
474 to implement dynamic menus."
477 ;; XEmacs needs the following two functions to add and remove menus.
478 ;; In Emacs this is done automatically when switching keymaps, so
479 ;; here easy-menu-remove is a noop and easy-menu-add only precalculates
480 ;; equivalent keybindings (if easy-menu-precalculate-equivalent-keybindings
481 ;; is on).
483 "Remove MENU from the current menu bar.
484 Contrary to XEmacs, this is a nop on Emacs since menus are automatically
485 \(de)activated when the corresponding keymap is (de)activated.
490 "Add the menu to the menubar.
491 This is a nop on Emacs since menus are automatically activated when the
492 corresponding keymap is activated. On XEmacs this is needed to actually
493 add the menu to the current menubar.
494 Maybe precalculate equivalent key bindings.
495 Do it only if `easy-menu-precalculate-equivalent-keybindings' is on."
501 ))
504 "Add submenu SUBMENU in the menu at MENU-PATH.
505 If BEFORE is non-nil, add before the item named BEFORE.
506 If IN-MENU is non-nil, follow MENU-PATH in IN-MENU.
507 This is a compatibility function; use `easy-menu-add-item'."
510 submenu before))
513 "To the submenu of MAP with path PATH, add ITEM.
515 If an item with the same name is already present in this submenu,
516 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
517 In the latter case, ITEM is normally added at the end of the submenu.
518 However, if BEFORE is a string and there is an item in the submenu
519 with that name, then ITEM is added before that item.
521 MAP should normally be a keymap; nil stands for the local menu-bar keymap.
522 It can also be a symbol, which has earlier been used as the first
523 argument in a call to `easy-menu-define', or the value of such a symbol.
525 PATH is a list of strings for locating the submenu where ITEM is to be
526 added. If PATH is nil, MAP itself is used. Otherwise, the first
527 element should be the name of a submenu directly under MAP. This
528 submenu is then traversed recursively with the remaining elements of PATH.
530 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
531 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
532 earlier by `easy-menu-define' or `easy-menu-create-menu'."
538 ;; This is a value returned by `easy-menu-item-present-p' or
539 ;; `easy-menu-remove-item'.
544 ;; Item is a keymap, find the prompt string and use as item name.
555 "In submenu of MAP with path PATH, return true iff item NAME is present.
556 MAP and PATH are defined as in `easy-menu-add-item'.
557 NAME should be a string, the name of the element to be looked for."
561 "From submenu of MAP with path PATH remove item NAME.
562 MAP and PATH are defined as in `easy-menu-add-item'.
563 NAME should be a string, the name of the element to be removed."
567 ret))
570 "In menu MENU try to look for menu item with name NAME.
571 If a menu item is found, return (NAME . item), otherwise return nil.
572 If item is an old format item, a new format item is returned."
574 ret enable cache label)
577 ;; This is the old menu format. Convert it to new format.
592 )))
597 submap)
600 "Return a sparse keymap in which to add or remove an item.
601 MAP and PATH are as defined in `easy-menu-add-item'.
603 TO-MODIFY, if non-nil, is the name of the item the caller
604 wants to modify in the map that we return.
605 In some cases we use that to select between the local and global maps."
614 map)
620 ;; Prefer a map that already contains the to-be-modified entry.
626 ;; Use the first valid map.
630 ;; Otherwise, make one up.
631 ;; Hardcoding current-local-map is lame, but it's difficult
632 ;; to know what the caller intended for us to do ;-(
637 newmap))))
639 map)
643 ;;; arch-tag: 2a04020d-90d2-476d-a7c6-71e072007a4a
644 ;;; easymenu.el ends here