| blob | 49eaa551e13d89ccf63ff50e04ddfe3546419e12 |
1 ;;; easymenu.el --- support the easymenu interface for defining a menu.
3 ;; Copyright (C) 1994, 1996, 1998 Free Software Foundation, Inc.
5 ;; Keywords: emulations
6 ;; Author: rms
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."
44 ;;;###autoload
46 "Define a menu bar submenu in maps MAPS, according to MENU.
47 The menu keymap is stored in symbol SYMBOL, both as its value
48 and as its function definition. DOC is used as the doc string for SYMBOL.
50 The first element of MENU must be a string. It is the menu bar item name.
51 It may be followed by the following keyword argument pairs
53 :filter FUNCTION
55 FUNCTION is a function with one argument, the menu. It returns the actual
56 menu displayed.
58 :visible INCLUDE
60 INCLUDE is an expression; this menu is only visible if this
61 expression has a non-nil value. `:include' is an alias for `:visible'.
63 :active ENABLE
65 ENABLE is an expression; the menu is enabled for selection
66 whenever this expression's value is non-nil.
68 The rest of the elements in MENU, are menu items.
70 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
72 NAME is a string--the menu item name.
74 CALLBACK is a command to run when the item is chosen,
75 or a list to evaluate when the item is chosen.
77 ENABLE is an expression; the item is enabled for selection
78 whenever this expression's value is non-nil.
80 Alternatively, a menu item may have the form:
82 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
84 Where KEYWORD is one of the symbols defined below.
86 :keys KEYS
88 KEYS is a string; a complex keyboard equivalent to this menu item.
89 This is normally not needed because keyboard equivalents are usually
90 computed automatically.
91 KEYS is expanded with `substitute-command-keys' before it is used.
93 :key-sequence KEYS
95 KEYS is nil, a string or a vector; nil or a keyboard equivalent to this
96 menu item.
97 This is a hint that will considerably speed up Emacs' first display of
98 a menu. Use `:key-sequence nil' when you know that this menu item has no
99 keyboard equivalent.
101 :active ENABLE
103 ENABLE is an expression; the item is enabled for selection
104 whenever this expression's value is non-nil.
106 :included INCLUDE
108 INCLUDE is an expression; this item is only visible if this
109 expression has a non-nil value.
111 :suffix FORM
113 FORM is an expression that will be dynamically evaluated and whose
114 value will be concatenated to the menu entry's NAME.
116 :style STYLE
118 STYLE is a symbol describing the type of menu item. The following are
119 defined:
121 toggle: A checkbox.
122 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
123 radio: A radio button.
124 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
125 button: Surround the name with `[' and `]'. Use this for an item in the
126 menu bar itself.
127 anything else means an ordinary menu item.
129 :selected SELECTED
131 SELECTED is an expression; the checkbox or radio button is selected
132 whenever this expression's value is non-nil.
134 :help HELP
136 HELP is a string, the help to display for the menu item.
138 A menu item can be a string. Then that string appears in the menu as
139 unselectable text. A string consisting solely of hyphens is displayed
140 as a solid horizontal line.
142 A menu item can be a list with the same format as MENU. This is a submenu."
147 ;;;###autoload
149 ;; We can't do anything that might differ between Emacs dialects in
150 ;; `easy-menu-define' in order to make byte compiled files
151 ;; compatible. Therefore everything interesting is done in this
152 ;; function.
157 ;; FIXME: XEmacs uses popup-menu which calls the binding
158 ;; while x-popup-menu only returns the selection.
178 "Convert MENU to the right thing to return from a menu filter.
179 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
180 a symbol whose value is such a menu.
181 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
182 return a menu items list (without menu name and keywords).
183 This function returns the right thing in the two cases.
184 If NAME is provided, it is used for the keymap."
186 ;; If it's a cons but not a keymap, then it can't be right
187 ;; unless it's an XEmacs menu.
191 ;;;###autoload
193 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
194 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
195 possibly preceded by keyword pairs as described in `easy-menu-define'."
197 prop keyword arg label enable filter visible help)
198 ;; Look for keywords.
214 nil ; Invisible menu entry, return nil.
223 ;; The filter expects the menu in its XEmacs form and the pre-filter
224 ;; form will only be passed to the filter anyway, so we'd better
225 ;; not convert it at all (it will be converted on the fly by
226 ;; easy-menu-filter-return).
232 menu)))
235 ;; Known button types.
246 "Memoize the value returned by `easy-menu-convert-item-1' called on ITEM.
247 This makes key-shortcut-caching work a *lot* better when this
248 conversion is done from within a filter.
249 This also helps when the NAME of the entry is recreated each time:
250 since the menu is built and traversed separately, the lookup
251 would always fail because the key is `equal' but not `eq'."
254 easy-menu-converted-items-table)))
257 "Parse an item description and add the item to a keymap.
258 This is the function that is used for item definition by the other easy-menu
259 functions.
260 MENU is a sparse keymap i.e. a list starting with the symbol `keymap'.
261 ITEM defines an item as in `easy-menu-define'.
262 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil
263 put item before BEFORE in MENU, otherwise if item is already present in
264 MENU, just change it, otherwise put it last in MENU."
275 ;; Invisible menu item. Don't insert into keymap.
286 cache cache-specified)
291 keyword arg suffix visible style selected keys)
327 keys)
345 ;; Invisible menu item. Don't insert into keymap.
354 ;; `intern' the name so as to merge multiple entries with the same name.
355 ;; It also makes it easier/possible to lookup/change menu bindings
356 ;; via keymap functions.
365 "Like easy-menu-define-key, but interns KEY and BEFORE if they are strings."
370 "Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
371 If KEY is not nil then delete any duplications. If ITEM is nil, then
372 don't insert, only delete.
373 Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil
374 put binding before BEFORE in MENU, otherwise if binding is already
375 present in MENU, just change it, otherwise put it last in MENU.
376 KEY and BEFORE don't have to be symbols, comparison is done with equal
377 not with eq."
379 tail done)
384 ;; If key is nil, stop here, otherwise keep going past the
385 ;; inserted element so we can delete any duplications that come
386 ;; later.
406 "Return true if X never evaluates to nil."
413 "Return a unique symbol with CALLBACK as function value.
414 When non-nil, NOEXP indicates that CALLBACK cannot be an expression
415 \(i.e. does not need to be turned into a function)."
422 command))
424 ;;;###autoload
426 "Change menu found at PATH as item NAME to contain ITEMS.
427 PATH is a list of strings for locating the menu that
428 should contain a submenu named NAME.
429 ITEMS is a list of menu items, as in `easy-menu-define'.
430 These items entirely replace the previous items in that submenu.
432 If the menu located by PATH has no submenu named NAME, add one.
433 If the optional argument BEFORE is present, add it just before
434 the submenu named BEFORE, otherwise add it at the end of the menu.
436 Either call this from `menu-bar-update-hook' or use a menu filter,
437 to implement dynamic menus."
440 ;; XEmacs needs the following two functions to add and remove menus.
441 ;; In Emacs this is done automatically when switching keymaps, so
442 ;; here easy-menu-remove is a noop and easy-menu-add only precalculates
443 ;; equivalent keybindings (if easy-menu-precalculate-equivalent-keybindings
444 ;; is on).
448 "Maybe precalculate equivalent key bindings.
449 Do it if `easy-menu-precalculate-equivalent-keybindings' is on,"
456 "To the submenu of MAP with path PATH, add ITEM.
458 If an item with the same name is already present in this submenu,
459 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
460 In the latter case, ITEM is normally added at the end of the submenu.
461 However, if BEFORE is a string and there is an item in the submenu
462 with that name, then ITEM is added before that item.
464 MAP should normally be a keymap; nil stands for the global menu-bar keymap.
465 It can also be a symbol, which has earlier been used as the first
466 argument in a call to `easy-menu-define', or the value of such a symbol.
468 PATH is a list of strings for locating the submenu where ITEM is to be
469 added. If PATH is nil, MAP itself is used. Otherwise, the first
470 element should be the name of a submenu directly under MAP. This
471 submenu is then traversed recursively with the remaining elements of PATH.
473 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
474 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
475 earlier by `easy-menu-define' or `easy-menu-create-menu'."
481 ;; This is a value returned by `easy-menu-item-present-p' or
482 ;; `easy-menu-remove-item'.
486 ;; Item is a keymap, find the prompt string and use as item name.
497 "In submenu of MAP with path PATH, return true iff item NAME is present.
498 MAP and PATH are defined as in `easy-menu-add-item'.
499 NAME should be a string, the name of the element to be looked for."
503 "From submenu of MAP with path PATH remove item NAME.
504 MAP and PATH are defined as in `easy-menu-add-item'.
505 NAME should be a string, the name of the element to be removed."
509 ret))
512 "In menu MENU try to look for menu item with name NAME.
513 If a menu item is found, return (NAME . item), otherwise return nil.
514 If item is an old format item, a new format item is returned."
516 ret enable cache label)
521 ;; This is the old menu format. Convert it to new format.
539 submap)
542 "Return a sparse keymap in which to add or remove an item.
543 MAP and PATH are as defined in `easy-menu-add-item'.
545 TO-MODIFY, if non-nil, is the name of the item the caller
546 wants to modify in the map that we return.
547 In some cases we use that to select between the local and global maps."
576 map)
580 ;;; easymenu.el ends here