Mercurial > hg > xemacs-beta
annotate lisp/easymenu.el @ 5554:a42e686a01bf
Automated merge with file:///Sources/xemacs-21.5-checked-out
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Wed, 24 Aug 2011 11:07:26 +0100 |
| parents | ac37a5f7e5be |
| children | cc6f0266bc36 |
| rev | line source |
|---|---|
| 428 | 1 ;;; easymenu.el - Easy menu support for Emacs 19 and XEmacs. |
| 2 | |
| 3230 | 3 ;; Copyright (C) 1992, 1993, 1994, 1995, 2005 Free Software Foundation, Inc. |
| 428 | 4 |
| 5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> | |
| 6 ;; Maintainer: XEmacs Development Team | |
| 7 ;; Keywords: internal, extensions, dumped | |
| 8 | |
| 9 ;; This file is part of XEmacs. | |
| 10 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
11 ;; XEmacs is free software: you can redistribute it and/or modify it |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
12 ;; under the terms of the GNU General Public License as published by the |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
13 ;; Free Software Foundation, either version 3 of the License, or (at your |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
14 ;; option) any later version. |
| 428 | 15 |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
16 ;; XEmacs is distributed in the hope that it will be useful, but WITHOUT |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
17 ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
18 ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
19 ;; for more details. |
| 428 | 20 |
| 21 ;; You should have received a copy of the GNU General Public License | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
3230
diff
changeset
|
22 ;; along with XEmacs. If not, see <http://www.gnu.org/licenses/>. |
| 428 | 23 |
| 24 ;;; Synched up with: Not synched with FSF but coordinated with the FSF | |
| 442 | 25 ;;; easymenu maintainer for compatibility with FSF 20.4. |
| 428 | 26 ;;; Please: Coordinate changes with Inge Frick <inge@nada.kth.se> |
| 27 | |
| 28 ;; Commentary: | |
| 29 | |
| 30 ;; This file is dumped with XEmacs. | |
| 31 | |
| 32 ;; Easymenu allows you to define menus for both Emacs 19 and XEmacs. | |
| 33 | |
| 442 | 34 ;; This file |
| 428 | 35 ;; The advantages of using easymenu are: |
| 36 | |
| 37 ;; - Easier to use than either the Emacs 19 and XEmacs menu syntax. | |
| 38 | |
| 442 | 39 ;; - Common interface for Emacs 18, Emacs 19, and XEmacs. |
| 428 | 40 ;; (The code does nothing when run under Emacs 18). |
| 41 | |
| 42 ;; The public functions are: | |
| 43 | |
| 44 ;; - Function: easy-menu-define SYMBOL MAPS DOC MENU | |
| 45 ;; SYMBOL is both the name of the variable that holds the menu and | |
| 442 | 46 ;; the name of a function that will present the menu. |
| 428 | 47 ;; MAPS is a list of keymaps where the menu should appear in the menubar. |
| 48 ;; DOC is the documentation string for the variable. | |
| 442 | 49 ;; MENU is an XEmacs style menu description. |
| 428 | 50 |
| 51 ;; See the documentation for easy-menu-define for details. | |
| 52 | |
| 53 ;; - Function: easy-menu-change PATH NAME ITEMS | |
| 54 ;; Change an existing menu. | |
| 55 ;; The menu must already exist and be visible on the menu bar. | |
| 442 | 56 ;; PATH is a list of strings used for locating the menu on the menu bar. |
| 57 ;; NAME is the name of the menu. | |
| 428 | 58 ;; ITEMS is a list of menu items, as defined in `easy-menu-define'. |
| 59 | |
| 60 ;; - Function: easy-menu-add MENU [ MAP ] | |
| 61 ;; Add MENU to the current menubar in MAP. | |
| 62 | |
| 63 ;; - Function: easy-menu-remove MENU | |
| 64 ;; Remove MENU from the current menubar. | |
| 65 | |
| 66 ;; - Function: easy-menu-add-item | |
| 67 ;; Add item or submenu to existing menu | |
| 68 | |
| 69 ;; - Function: easy-menu-item-present-p | |
| 70 ;; Locate item | |
| 71 | |
| 72 ;; - Function: easy-menu-remove-item | |
| 73 ;; Delete item from menu. | |
| 74 | |
| 75 ;; Emacs 19 never uses `easy-menu-add' or `easy-menu-remove', menus | |
| 76 ;; automatically appear and disappear when the keymaps specified by | |
| 77 ;; the MAPS argument to `easy-menu-define' are activated. | |
| 78 | |
| 79 ;; XEmacs will bind the map to button3 in each MAPS, but you must | |
| 80 ;; explicitly call `easy-menu-add' and `easy-menu-remove' to add and | |
| 81 ;; remove menus from the menu bar. | |
| 82 | |
| 83 ;;; Code: | |
| 84 | |
| 85 ;; ;;;###autoload | |
| 86 (defmacro easy-menu-define (symbol maps doc menu) | |
| 87 "Define a menu bar submenu in maps MAPS, according to MENU. | |
| 88 The arguments SYMBOL and DOC are ignored; they are present for | |
| 89 compatibility only. SYMBOL is not evaluated. In other Emacs versions | |
| 90 these arguments may be used as a variable to hold the menu data, and a | |
| 91 doc string for that variable. | |
| 92 | |
| 93 The first element of MENU must be a string. It is the menu bar item name. | |
| 94 The rest of the elements are menu items. | |
| 95 | |
| 96 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE] | |
| 97 | |
| 98 NAME is a string--the menu item name. | |
| 99 | |
| 100 CALLBACK is a command to run when the item is chosen, | |
| 101 or a list to evaluate when the item is chosen. | |
| 102 | |
| 103 ENABLE is an expression; the item is enabled for selection | |
| 104 whenever this expression's value is non-nil. | |
| 105 | |
| 442 | 106 Alternatively, a menu item may have the form: |
| 428 | 107 |
| 108 [ NAME CALLBACK [ KEYWORD ARG ] ... ] | |
| 109 | |
| 110 Where KEYWORD is one of the symbol defined below. | |
| 111 | |
| 112 :keys KEYS | |
| 113 | |
| 114 KEYS is a string; a complex keyboard equivalent to this menu item. | |
| 115 | |
| 116 :active ENABLE | |
| 117 | |
| 118 ENABLE is an expression; the item is enabled for selection | |
| 119 whenever this expression's value is non-nil. | |
| 120 | |
| 121 :suffix NAME | |
| 122 | |
| 123 NAME is a string; the name of an argument to CALLBACK. | |
| 124 | |
| 125 :style STYLE | |
| 442 | 126 |
| 428 | 127 STYLE is a symbol describing the type of menu item. The following are |
| 442 | 128 defined: |
| 428 | 129 |
| 442 | 130 toggle: A checkbox. |
| 428 | 131 Currently just prepend the name with the string \"Toggle \". |
| 442 | 132 radio: A radio button. |
| 428 | 133 nil: An ordinary menu item. |
| 134 | |
| 135 :selected SELECTED | |
| 136 | |
| 137 SELECTED is an expression; the checkbox or radio button is selected | |
| 138 whenever this expression's value is non-nil. | |
| 139 Currently just disable radio buttons, no effect on checkboxes. | |
| 140 | |
| 141 A menu item can be a string. Then that string appears in the menu as | |
| 142 unselectable text. A string consisting solely of hyphens is displayed | |
| 143 as a solid horizontal line. | |
| 144 | |
| 145 A menu item can be a list. It is treated as a submenu. | |
| 146 The first element should be the submenu name. That's used as the | |
| 147 menu item in the top-level menu. The cdr of the submenu list | |
| 148 is a list of menu items, as above." | |
| 149 `(progn | |
| 150 (defvar ,symbol nil ,doc) | |
| 151 (easy-menu-do-define (quote ,symbol) ,maps ,doc ,menu))) | |
| 152 | |
| 153 (defun easy-menu-do-define (symbol maps doc menu) | |
| 442 | 154 (when (featurep 'menubar) |
| 155 (set symbol menu) | |
| 156 (fset symbol `(lambda (e) | |
| 157 ,doc | |
| 158 (interactive "@e") | |
| 159 (run-hooks 'activate-menubar-hook) | |
| 502 | 160 (setq zmacs-region-stays t) |
| 442 | 161 (popup-menu ,symbol))))) |
| 428 | 162 |
| 163 (defun easy-menu-change (&rest args) | |
| 164 (when (featurep 'menubar) | |
| 165 (apply 'add-menu args))) | |
| 166 | |
| 3230 | 167 (defvar easy-menu-all-popups nil |
| 168 "This variable holds all the popup menus easy-menu knows about. | |
| 169 This includes any menu created with `easy-menu-add' and any | |
| 170 non-default value for `mode-popup-menu' that existed when | |
| 171 `easy-menu-add' was first called.") | |
| 428 | 172 (make-variable-buffer-local 'easy-menu-all-popups) |
| 173 | |
| 174 (defun easy-menu-add (menu &optional map) | |
| 175 "Add MENU to the current menu bar." | |
| 3230 | 176 ;; If you uncomment the following, do an xemacs -vanilla, type M-x |
| 177 ;; folding-mode RET, you'll see that this code, which theoretically has | |
| 178 ;; *scratch* as its buffer context, can't see *scratch*'s value for | |
| 179 ;; mode-popup-menu--the default overrides it. | |
| 180 ;; | |
| 181 ;; This is not specific to *scratch*--try it on ~/.xemacs/init.el--but it | |
| 182 ;; does appear to be specific to the first time mode-popup-menu is | |
| 183 ;; accessed as a buffer-local variable in non-interactive code (that is, | |
| 184 ;; M-: mode-popup-menu RET gives the correct value). | |
| 185 ;; | |
| 186 ;; My fixing this right now isn't going to happen. Aidan Kehoe, 2006-01-03 | |
| 187 ; (message (concat "inside easy-menu-add, menu is %s, " | |
| 188 ; "mode-popup-menu is %s, current buffer is %s, " | |
| 189 ; "default-value mode-popup-menu is %s, " | |
| 190 ; "easy-menu-all-popups is %s") | |
| 191 ; menu mode-popup-menu (current-buffer) | |
| 192 ; (default-value 'mode-popup-menu) easy-menu-all-popups) | |
| 442 | 193 (when (featurep 'menubar) |
| 3230 | 194 ;; Save the existing mode-popup-menu, if it's been changed. |
|
5366
f00192e1cd49
Examining the result of #'length: `eql', not `=', it's better style & cheaper
Aidan Kehoe <kehoea@parhasard.net>
parents:
5287
diff
changeset
|
195 (when (and (eql (length easy-menu-all-popups) 0) |
| 3230 | 196 (not (equal (default-value 'mode-popup-menu) mode-popup-menu))) |
| 197 (push mode-popup-menu easy-menu-all-popups)) | |
| 198 ;; Add the menu to our list of all the popups for the buffer. | |
| 199 (pushnew menu easy-menu-all-popups :test 'equal) | |
| 200 ;; If there are multiple popup menus available, make the popup menu | |
| 201 ;; normally shown with button-3 a menu of them. If there is just one, | |
| 202 ;; make that button show it, and no super-menu. | |
|
5366
f00192e1cd49
Examining the result of #'length: `eql', not `=', it's better style & cheaper
Aidan Kehoe <kehoea@parhasard.net>
parents:
5287
diff
changeset
|
203 (setq mode-popup-menu (if (eql 1 (length easy-menu-all-popups)) |
| 3230 | 204 (car easy-menu-all-popups) |
| 205 (cons (easy-menu-title) | |
| 206 (reverse easy-menu-all-popups)))) | |
| 442 | 207 (cond ((null current-menubar) |
| 208 ;; Don't add it to a non-existing menubar. | |
| 209 nil) | |
| 210 ((assoc (car menu) current-menubar) | |
| 211 ;; Already present. | |
| 212 nil) | |
| 213 ((equal current-menubar '(nil)) | |
| 214 ;; Set at left if only contains right marker. | |
| 215 (set-buffer-menubar (list menu nil))) | |
| 216 (t | |
| 217 ;; Add at right. | |
| 218 (set-buffer-menubar (copy-sequence current-menubar)) | |
| 219 (add-menu nil (car menu) (cdr menu)))))) | |
| 428 | 220 |
| 221 (defun easy-menu-remove (menu) | |
| 222 "Remove MENU from the current menu bar." | |
| 442 | 223 (when (featurep 'menubar) |
| 3230 | 224 (setq |
| 225 ;; Remove this menu from the list of popups we know about. | |
| 226 easy-menu-all-popups (delq menu easy-menu-all-popups) | |
| 227 ;; If there are multiple popup menus available, make the popup menu | |
| 228 ;; normally shown with button-3 a menu of them. If there is just one, | |
| 229 ;; make that button show it, and no super-menu. | |
|
5366
f00192e1cd49
Examining the result of #'length: `eql', not `=', it's better style & cheaper
Aidan Kehoe <kehoea@parhasard.net>
parents:
5287
diff
changeset
|
230 mode-popup-menu (if (eql 1 (length easy-menu-all-popups)) |
| 3230 | 231 (car easy-menu-all-popups) |
| 232 (cons (easy-menu-title) | |
| 233 (reverse easy-menu-all-popups)))) | |
| 234 ;; If we've just set mode-popup-menu to an empty menu, change that menu | |
| 235 ;; to its default value (without intervention from easy-menu). | |
|
5366
f00192e1cd49
Examining the result of #'length: `eql', not `=', it's better style & cheaper
Aidan Kehoe <kehoea@parhasard.net>
parents:
5287
diff
changeset
|
236 (if (eql (length easy-menu-all-popups) 0) |
| 3230 | 237 (setq mode-popup-menu (default-value 'mode-popup-menu))) |
| 442 | 238 (and current-menubar |
| 239 (assoc (car menu) current-menubar) | |
| 240 (delete-menu-item (list (car menu)))))) | |
| 428 | 241 |
| 242 (defsubst easy-menu-normalize (menu) | |
| 243 (if (symbolp menu) | |
| 244 (symbol-value menu) | |
| 245 menu)) | |
| 246 | |
| 247 (defun easy-menu-add-item (menu path item &optional before) | |
| 442 | 248 "At the end of the submenu of MENU with path PATH, add ITEM. |
| 428 | 249 If ITEM is already present in this submenu, then this item will be changed. |
| 250 otherwise ITEM will be added at the end of the submenu, unless the optional | |
| 251 argument BEFORE is present, in which case ITEM will instead be added | |
| 252 before the item named BEFORE. | |
| 253 MENU is either a symbol, which have earlier been used as the first | |
| 254 argument in a call to `easy-menu-define', or the value of such a symbol | |
| 442 | 255 i.e. a menu, or nil, which stands for the current menubar. |
| 428 | 256 PATH is a list of strings for locating the submenu where ITEM is to be |
| 257 added. If PATH is nil, MENU itself is used. Otherwise, the first | |
| 258 element should be the name of a submenu directly under MENU. This | |
| 259 submenu is then traversed recursively with the remaining elements of PATH. | |
| 260 ITEM is either defined as in `easy-menu-define', a menu defined earlier | |
| 261 by `easy-menu-define' or `easy-menu-create-menu' or an item returned | |
| 262 from `easy-menu-item-present-p' or `easy-menu-remove-item'." | |
| 442 | 263 (when (featurep 'menubar) |
| 264 (add-menu-button path item before (easy-menu-normalize menu)))) | |
| 428 | 265 |
| 266 (defun easy-menu-item-present-p (menu path name) | |
| 267 "In submenu of MENU with path PATH, return true iff item NAME is present. | |
| 268 MENU and PATH are defined as in `easy-menu-add-item'. | |
| 269 NAME should be a string, the name of the element to be looked for. | |
| 270 | |
| 442 | 271 The return value can be used as an argument to `easy-menu-add-item'." |
| 272 (if (featurep 'menubar) | |
| 273 (car (find-menu-item (or (easy-menu-normalize menu) current-menubar) | |
| 274 (append path (list name)))) | |
| 275 nil)) | |
| 428 | 276 |
| 277 (defun easy-menu-remove-item (menu path name) | |
| 442 | 278 "From submenu of MENU with path PATH, remove item NAME. |
| 428 | 279 MENU and PATH are defined as in `easy-menu-add-item'. |
| 280 NAME should be a string, the name of the element to be removed. | |
| 281 | |
| 442 | 282 The return value can be used as an argument to `easy-menu-add-item'." |
| 283 (when (featurep 'menubar) | |
| 284 (delete-menu-item (append path (list name)) | |
| 285 (easy-menu-normalize menu)))) | |
| 286 | |
| 3230 | 287 ;; Think up a good title for the menu. Take the major-mode of the buffer, |
| 288 ;; strip the -mode part, convert hyphens to spaces, and capitalize it. | |
| 289 ;; | |
| 290 ;; In a more ideal world, we could use `mode-name' here, which see, but that | |
| 291 ;; turns out to be temporarily trashed by various minor modes, and this | |
| 292 ;; value is much more trustworthy. | |
| 428 | 293 |
| 294 (defun easy-menu-title () | |
| 295 (capitalize (replace-in-string (replace-in-string | |
| 296 (symbol-name major-mode) "-mode$" "") | |
| 297 "-" " "))) | |
| 298 | |
| 299 (provide 'easymenu) | |
| 300 | |
| 301 ;;; easymenu.el ends here |