1 ;;; lmenu.el --- emulate Lucid's menubar support
3 ;; Keywords: emulations
5 ;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; First, emulate the Lucid menubar support in GNU Emacs 19.
28 ;; Arrange to use current-menubar to set up part of the menu bar.
30 (defvar current-menubar)
32 (setq recompute-lucid-menubar 'recompute-lucid-menubar)
33 (defun recompute-lucid-menubar ()
34 (define-key lucid-menubar-map [menu-bar]
36 (make-lucid-menu-keymap "menu-bar" current-menubar)
37 (error (message "Invalid data in current-menubar moved to lucid-failing-menubar")
39 (setq lucid-failing-menubar current-menubar
40 current-menubar nil))))
41 (setq lucid-menu-bar-dirty-flag nil))
43 (defvar lucid-menubar-map (make-sparse-keymap))
44 (or (assq 'current-menubar minor-mode-map-alist)
45 (setq minor-mode-map-alist
46 (cons (cons 'current-menubar lucid-menubar-map)
47 minor-mode-map-alist)))
49 (defun set-menubar-dirty-flag ()
50 (force-mode-line-update)
51 (setq lucid-menu-bar-dirty-flag t))
53 (defvar add-menu-item-count 0)
55 ;; This is a variable whose value is always nil.
56 (defvar make-lucid-menu-keymap-disable nil)
58 ;; Return a menu keymap corresponding to a Lucid-style menu list
59 ;; MENU-ITEMS, and with name MENU-NAME.
60 (defun make-lucid-menu-keymap (menu-name menu-items)
61 (let ((menu (make-sparse-keymap menu-name)))
62 ;; Process items in reverse order,
63 ;; since the define-key loop reverses them again.
64 (setq menu-items (reverse menu-items))
66 (let ((item (car menu-items))
67 command name callback)
70 (setq name (if (string-match "^-+$" item) "" item)))
72 (setq command (make-lucid-menu-keymap (car item) (cdr item)))
73 (setq name (car item)))
75 (setq command (make-symbol (format "menu-function-%d"
77 add-menu-item-count (1+ add-menu-item-count)
79 callback (aref item 1))
80 (if (symbolp callback)
81 (fset command callback)
82 (fset command (list 'lambda () '(interactive) callback)))
84 (while (< i (length item))
86 ((eq (aref item i) ':active)
87 (put command 'menu-enable
88 (or (aref item (1+ i))
89 'make-lucid-menu-keymap-disable))
91 ((eq (aref item i) ':suffix)
94 ((eq (aref item i) ':keys)
97 ((eq (aref item i) ':style)
100 ((eq (aref item i) ':selected)
103 ((and (symbolp (aref item i))
104 (= ?: (string-to-char (symbol-name (aref item i)))))
105 (error "Unrecognized menu item keyword: %S"
108 ;; old-style format: active-p &optional suffix
109 (put command 'menu-enable
110 (or (aref item i) 'make-lucid-menu-keymap-disable))
111 ;; suffix is unimplemented
112 (setq i (length item)))
114 (error "Unexpected menu item value: %S"
117 ;; Handle inactive strings specially--allow any number
118 ;; of identical ones.
119 (setcdr menu (cons (list nil name) (cdr menu)))
121 (define-key menu (vector (intern name)) (cons name command)))))
122 (setq menu-items (cdr menu-items)))
125 (defun popup-menu (menu-desc)
126 "Pop up the given menu.
127 A menu is a list of menu items, strings, and submenus.
129 The first element of a menu must be a string, which is the name of the
130 menu. This is the string that will be displayed in the parent menu, if
131 any. For toplevel menus, it is ignored. This string is not displayed
134 A menu item is a vector containing:
136 - the name of the menu item (a string);
137 - the `callback' of that item;
138 - a list of keywords with associated values:
139 - :active active-p a form specifying whether this item is selectable;
140 - :suffix suffix a string to be appended to the name as an `argument'
141 to the command, like `Kill Buffer NAME';
142 - :keys command-keys a string, suitable for `substitute-command-keys',
143 to specify the keyboard equivalent of a command
144 when the callback is a form (this is not necessary
145 when the callback is a symbol, as the keyboard
146 equivalent is computed automatically in that case);
147 - :style style a symbol: nil for a normal menu item, `toggle' for
148 a toggle button (a single option that can be turned
149 on or off), or `radio' for a radio button (one of a
150 group of mutually exclusive options);
151 - :selected form for `toggle' or `radio' style, a form that specifies
152 whether the button will be in the selected state.
154 Alternately, the vector may contain exactly 3 or 4 elements, with the third
155 element specifying `active-p' and the fourth specifying `suffix'.
157 If the `callback' of a menu item is a symbol, then it must name a command.
158 It will be invoked with `call-interactively'. If it is a list, then it is
159 evaluated with `eval'.
161 If an element of a menu is a string, then that string will be presented in
162 the menu as unselectable text.
164 If an element of a menu is a string consisting solely of hyphens, then that
165 item will be presented as a solid horizontal line.
167 If an element of a menu is a list, it is treated as a submenu. The name of
168 that submenu (the first element in the list) will be used as the name of the
169 item representing this menu on the parent.
171 The syntax, more precisely:
173 form := <something to pass to `eval'>
174 command := <a symbol or string, to pass to `call-interactively'>
175 callback := command | form
176 active-p := <t or nil, whether this thing is selectable>
177 text := <string, non selectable>
180 command-keys := <string>
181 object-style := 'nil' | 'toggle' | 'radio'
182 keyword := ':active' active-p
184 | ':keys' command-keys
185 | ':style' object-style
187 menu-item := '[' name callback active-p [ suffix ] ']'
188 | '[' name callback [ keyword ]+ ']'
189 menu := '(' name [ menu-item | menu | text ]+ ')'"
190 (let ((menu (make-lucid-menu-keymap (car menu-desc) (cdr menu-desc)))
191 (pos (mouse-pixel-position))
194 (setq answer (x-popup-menu (list (list (nth 1 pos)
198 (setq cmd (lookup-key menu (apply 'vector answer)))
203 (call-interactively cmd))))))
205 (defun popup-dialog-box (data)
206 "Pop up a dialog box.
207 A dialog box description is a list.
209 - The first element of the list is a string to display in the dialog box.
210 - The rest of the elements are descriptions of the dialog box's buttons.
211 Each one is a vector of three elements:
212 - The first element is the text of the button.
213 - The second element is the `callback'.
214 - The third element is t or nil, whether this button is selectable.
216 If the `callback' of a button is a symbol, then it must name a command.
217 It will be invoked with `call-interactively'. If it is a list, then it is
218 evaluated with `eval'.
220 One (and only one) of the buttons may be `nil'. This marker means that all
221 following buttons should be flushright instead of flushleft.
223 The syntax, more precisely:
225 form := <something to pass to `eval'>
226 command := <a symbol or string, to pass to `call-interactively'>
227 callback := command | form
228 active-p := <t, nil, or a form to evaluate to decide whether this
229 button should be selectable>
232 button := '[' name callback active-p ']'
233 dialog := '(' name [ button ]+ [ partition [ button ]+ ] ')'"
234 (let ((name (car data))
239 (if (null (car tail))
240 (setq converted (cons nil converted))
241 (let ((item (aref (car tail) 0))
242 (callback (aref (car tail) 1))
243 (enable (aref (car tail) 2)))
245 (cons (if enable (cons item callback) item)
247 (setq tail (cdr tail)))
248 (setq choice (x-popup-dialog t (cons name (nreverse converted))))
249 (setq meaning (assq choice converted))
251 (if (symbolp (cdr meaning))
252 (call-interactively (cdr meaning))
253 (eval (cdr meaning))))))
255 ;; This is empty because the usual elements of the menu bar
256 ;; are provided by menu-bar.el instead.
257 ;; It would not make sense to duplicate them here.
258 (defconst default-menubar nil)
260 (defun set-menubar (menubar)
261 "Set the default menubar to be menubar."
262 (setq-default current-menubar (copy-sequence menubar))
263 (set-menubar-dirty-flag))
265 (defun set-buffer-menubar (menubar)
266 "Set the buffer-local menubar to be menubar."
267 (make-local-variable 'current-menubar)
268 (setq current-menubar (copy-sequence menubar))
269 (set-menubar-dirty-flag))
272 ;;; menu manipulation functions
274 (defun find-menu-item (menubar item-path-list &optional parent)
275 "Searches MENUBAR for item given by ITEM-PATH-LIST.
276 Returns (ITEM . PARENT), where PARENT is the immediate parent of
278 Signals an error if the item is not found."
279 (or parent (setq item-path-list (mapcar 'downcase item-path-list)))
280 (if (not (consp menubar))
286 (equal (car item-path-list)
287 (downcase (if (vectorp (car rest))
289 (if (stringp (car rest))
291 (car (car rest)))))))
292 (setq result (car rest) rest nil)
293 (setq rest (cdr rest))))
294 (if (cdr item-path-list)
296 (find-menu-item (cdr result) (cdr item-path-list) result)
298 (signal 'error (list "not a submenu" result))
299 (signal 'error (list "no such submenu" (car item-path-list)))))
300 (cons result parent)))))
303 (defun disable-menu-item (path)
304 "Make the named menu item be unselectable.
305 PATH is a list of strings which identify the position of the menu item in
306 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
307 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
308 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
309 (let* ((menubar current-menubar)
310 (pair (find-menu-item menubar path))
314 (signal 'error (list (if menu "No such menu item" "No such menu")
316 (if (consp item) (error "can't disable menus, only menu items"))
318 (set-menubar-dirty-flag)
322 (defun enable-menu-item (path)
323 "Make the named menu item be selectable.
324 PATH is a list of strings which identify the position of the menu item in
325 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
326 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
327 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
328 (let* ((menubar current-menubar)
329 (pair (find-menu-item menubar path))
333 (signal 'error (list (if menu "No such menu item" "No such menu")
335 (if (consp item) (error "%S is a menu, not a menu item" path))
337 (set-menubar-dirty-flag)
341 (defun add-menu-item-1 (item-p menu-path item-name item-data enabled-p before)
342 (if before (setq before (downcase before)))
343 (let* ((menubar current-menubar)
344 (menu (condition-case ()
345 (car (find-menu-item menubar menu-path))
347 (item (if (listp menu)
348 (car (find-menu-item (cdr menu) (list item-name)))
349 (signal 'error (list "not a submenu" menu-path)))))
351 (let ((rest menu-path)
354 ;;; (setq menu (car (find-menu-item (cdr so-far) (list (car rest)))))
356 (if (eq so-far menubar)
357 (car (find-menu-item so-far (list (car rest))))
358 (car (find-menu-item (cdr so-far) (list (car rest))))))
360 (let ((rest2 so-far))
362 (error "Trying to modify a menu that doesn't exist"))
363 (while (and (cdr rest2) (car (cdr rest2)))
364 (setq rest2 (cdr rest2)))
366 (nconc (list (setq menu (list (car rest))))
369 (setq rest (cdr rest)))))
370 (or menu (setq menu menubar))
372 nil ; it's already there
374 (setq item (vector item-name item-data enabled-p))
375 (setq item (cons item-name item-data)))
376 ;; if BEFORE is specified, try to add it there.
378 (setq before (car (find-menu-item menu (list before)))))
382 (if (eq before (car (cdr rest)))
384 (setcdr rest (cons item (cdr rest)))
385 (setq rest nil added-before t))
386 (setq rest (cdr rest))))
387 (if (not added-before)
388 ;; adding before the first item on the menubar itself is harder
389 (if (and (eq menu menubar) (eq before (car menu)))
390 (setq menu (cons item menu)
391 current-menubar menu)
392 ;; otherwise, add the item to the end.
393 (nconc menu (list item))))))
396 (aset item 1 item-data)
397 (aset item 2 (not (null enabled-p))))
398 (setcar item item-name)
399 (setcdr item item-data))
400 (set-menubar-dirty-flag)
403 (defun add-menu-item (menu-path item-name function enabled-p &optional before)
404 "Add a menu item to some menu, creating the menu first if necessary.
405 If the named item exists already, it is changed.
406 MENU-PATH identifies the menu under which the new menu item should be inserted.
407 It is a list of strings; for example, (\"File\") names the top-level \"File\"
408 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
409 ITEM-NAME is the string naming the menu item to be added.
410 FUNCTION is the command to invoke when this menu item is selected.
411 If it is a symbol, then it is invoked with `call-interactively', in the same
412 way that functions bound to keys are invoked. If it is a list, then the
413 list is simply evaluated.
414 ENABLED-P controls whether the item is selectable or not.
415 BEFORE, if provided, is the name of a menu item before which this item should
416 be added, if this item is not on the menu already. If the item is already
417 present, it will not be moved."
418 (or menu-path (error "must specify a menu path"))
419 (or item-name (error "must specify an item name"))
420 (add-menu-item-1 t menu-path item-name function enabled-p before))
423 (defun delete-menu-item (path)
424 "Remove the named menu item from the menu hierarchy.
425 PATH is a list of strings which identify the position of the menu item in
426 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
427 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
428 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
429 (let* ((menubar current-menubar)
430 (pair (find-menu-item menubar path))
432 (menu (or (cdr pair) menubar)))
435 ;; the menubar is the only special case, because other menus begin
437 (if (eq menu current-menubar)
438 (setq current-menubar (delq item menu))
440 (set-menubar-dirty-flag)
444 (defun relabel-menu-item (path new-name)
445 "Change the string of the specified menu item.
446 PATH is a list of strings which identify the position of the menu item in
447 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
448 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
449 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\".
450 NEW-NAME is the string that the menu item will be printed as from now on."
451 (or (stringp new-name)
452 (setq new-name (signal 'wrong-type-argument (list 'stringp new-name))))
453 (let* ((menubar current-menubar)
454 (pair (find-menu-item menubar path))
458 (signal 'error (list (if menu "No such menu item" "No such menu")
460 (if (and (consp item)
461 (stringp (car item)))
462 (setcar item new-name)
463 (aset item 0 new-name))
464 (set-menubar-dirty-flag)
467 (defun add-menu (menu-path menu-name menu-items &optional before)
468 "Add a menu to the menubar or one of its submenus.
469 If the named menu exists already, it is changed.
470 MENU-PATH identifies the menu under which the new menu should be inserted.
471 It is a list of strings; for example, (\"File\") names the top-level \"File\"
472 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
473 If MENU-PATH is nil, then the menu will be added to the menubar itself.
474 MENU-NAME is the string naming the menu to be added.
475 MENU-ITEMS is a list of menu item descriptions.
476 Each menu item should be a vector of three elements:
477 - a string, the name of the menu item;
478 - a symbol naming a command, or a form to evaluate;
479 - and a form whose value determines whether this item is selectable.
480 BEFORE, if provided, is the name of a menu before which this menu should
481 be added, if this menu is not on its parent already. If the menu is already
482 present, it will not be moved."
483 (or menu-name (error "must specify a menu name"))
484 (or menu-items (error "must specify some menu items"))
485 (add-menu-item-1 nil menu-path menu-name menu-items t before))
489 (defvar put-buffer-names-in-file-menu t)
492 ;; Don't unconditionally enable menu bars; leave that up to the user.
493 ;;(let ((frames (frame-list)))
495 ;; (modify-frame-parameters (car frames) '((menu-bar-lines . 1)))
496 ;; (setq frames (cdr frames))))
497 ;;(or (assq 'menu-bar-lines default-frame-alist)
498 ;; (setq default-frame-alist
499 ;; (cons '(menu-bar-lines . 1) default-frame-alist)))
501 (set-menubar default-menubar)
505 ;;; lmenu.el ends here