| blob | bab2ce75dff3881e95f0a45a84fe1b7bf4541eb1 |
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 NAME
113 NAME is a string; the name of an argument to CALLBACK.
115 :style STYLE
117 STYLE is a symbol describing the type of menu item. The following are
118 defined:
120 toggle: A checkbox.
121 Prepend the name with `(*) ' or `( ) ' depending on if selected or not.
122 radio: A radio button.
123 Prepend the name with `[X] ' or `[ ] ' depending on if selected or not.
124 button: Surround the name with `[' and `]'. Use this for an item in the
125 menu bar itself.
126 anything else means an ordinary menu item.
128 :selected SELECTED
130 SELECTED is an expression; the checkbox or radio button is selected
131 whenever this expression's value is non-nil.
133 A menu item can be a string. Then that string appears in the menu as
134 unselectable text. A string consisting solely of hyphens is displayed
135 as a solid horizontal line.
137 A menu item can be a list with the same format as MENU. This is a submenu."
142 ;;;###autoload
144 ;; We can't do anything that might differ between Emacs dialects in
145 ;; `easy-menu-define' in order to make byte compiled files
146 ;; compatible. Therefore everything interesting is done in this
147 ;; function.
157 "Convert MENU to the right thing to return from a menu filter.
158 MENU is a menu as computed by `easy-menu-define' or `easy-menu-create-menu' or
159 a symbol whose value is such a menu.
160 In Emacs a menu filter must return a menu (a keymap), in XEmacs a filter must
161 return a menu items list (without menu name and keywords).
162 This function returns the right thing in the two cases."
165 ;;;###autoload
167 "Create a menu called MENU-NAME with items described in MENU-ITEMS.
168 MENU-NAME is a string, the name of the menu. MENU-ITEMS is a list of items
169 possibly preceded by keyword pairs as described in `easy-menu-define'."
171 prop keyword arg label enable filter visible)
172 ;; Look for keywords.
197 menu)))
200 ;; Known button types.
205 ;; Parse an item description and add the item to a keymap. This is
206 ;; the function that is used for item definition by the other easy-menu
207 ;; functions.
208 ;; MENU is a sparse keymap i.e. a list starting with the symbol `keymap'.
209 ;; ITEM defines an item as in `easy-menu-define'.
210 ;; Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil
211 ;; put item before BEFORE in MENU, otherwise if item is already present in
212 ;; MENU, just change it, otherwise put it last in MENU.
223 ;; Invisible menu item. Don't insert into keymap.
234 cache cache-specified)
239 keyword arg suffix visible style selected keys)
274 keys)
292 ;; Invisible menu item. Don't insert into keymap.
307 before)))
310 ;; This is the same as easy-menu-define-key, but it interns KEY and
311 ;; BEFORE if they are strings.
316 ;; Add binding in MENU for KEY => ITEM. Similar to `define-key-after'.
317 ;; If KEY is not nil then delete any duplications. If ITEM is nil, then
318 ;; don't insert, only delete.
319 ;; Optional argument BEFORE is nil or a key in MENU. If BEFORE is not nil
320 ;; put binding before BEFORE in MENU, otherwise if binding is already
321 ;; present in MENU, just change it, otherwise put it last in MENU.
322 ;; KEY and BEFORE don't have to be symbols, comparison is done with equal
323 ;; not with eq.
325 tail done)
330 ;; If key is nil, stop here, otherwise keep going past the
331 ;; inserted element so we can delete any duplications that come
332 ;; later.
352 ;; Return true if X never evaluates to nil.
359 ;; Return a unique symbol with CALLBACK as function value.
366 command))
368 ;;;###autoload
370 "Change menu found at PATH as item NAME to contain ITEMS.
371 PATH is a list of strings for locating the menu that
372 should contain a submenu named NAME.
373 ITEMS is a list of menu items, as in `easy-menu-define'.
374 These items entirely replace the previous items in that submenu.
376 If the menu located by PATH has no submenu named NAME, add one.
377 If the optional argument BEFORE is present, add it just before
378 the submenu named BEFORE, otherwise add it at the end of the menu.
380 Either call this from `menu-bar-update-hook' or use a menu filter,
381 to implement dynamic menus."
384 ;; XEmacs needs the following two functions to add and remove menus.
385 ;; In Emacs this is done automatically when switching keymaps, so
386 ;; here easy-menu-remove is a noop and easy-menu-add only precalculates
387 ;; equivalent keybindings (if easy-menu-precalculate-equivalent-keybindings
388 ;; is on).
392 "Maybe precalculate equivalent key bindings.
393 Do it if `easy-menu-precalculate-equivalent-keybindings' is on,"
400 "To the submenu of MAP with path PATH, add ITEM.
402 If an item with the same name is already present in this submenu,
403 then ITEM replaces it. Otherwise, ITEM is added to this submenu.
404 In the latter case, ITEM is normally added at the end of the submenu.
405 However, if BEFORE is a string and there is an item in the submenu
406 with that name, then ITEM is added before that item.
408 MAP should normally be a keymap; nil stands for the global menu-bar keymap.
409 It can also be a symbol, which has earlier been used as the first
410 argument in a call to `easy-menu-define', or the value of such a symbol.
412 PATH is a list of strings for locating the submenu where ITEM is to be
413 added. If PATH is nil, MAP itself is used. Otherwise, the first
414 element should be the name of a submenu directly under MAP. This
415 submenu is then traversed recursively with the remaining elements of PATH.
417 ITEM is either defined as in `easy-menu-define' or a non-nil value returned
418 by `easy-menu-item-present-p' or `easy-menu-remove-item' or a menu defined
419 earlier by `easy-menu-define' or `easy-menu-create-menu'."
425 ;; This is a value returned by `easy-menu-item-present-p' or
426 ;; `easy-menu-remove-item'.
430 ;; Item is a keymap, find the prompt string and use as item name.
441 "In submenu of MAP with path PATH, return true iff item NAME is present.
442 MAP and PATH are defined as in `easy-menu-add-item'.
443 NAME should be a string, the name of the element to be looked for."
447 "From submenu of MAP with path PATH remove item NAME.
448 MAP and PATH are defined as in `easy-menu-add-item'.
449 NAME should be a string, the name of the element to be removed."
453 ret))
456 ;; In menu MENU try to look for menu item with name NAME.
457 ;; If a menu item is found, return (NAME . item), otherwise return nil.
458 ;; If item is an old format item, a new format item is returned.
460 ret enable cache label)
465 ;; This is the old menu format. Convert it to new format.
483 submap)
486 ;; Return a sparse keymap in which to add or remove an item.
487 ;; MAP and PATH are as defined in `easy-menu-add-item'.
489 ;; TO-MODIFY, if non-nil, is the name of the item the caller
490 ;; wants to modify in the map that we return.
491 ;; In some cases we use that to select between the local and global maps.
520 map)
524 ;;; easymenu.el ends here