1 ;;; menubar.el --- Menubar support for XEmacs
3 ;; Copyright (C) 1991-4, 1997-1998 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
5 ;; Copyright (C) 1995, 1996 Ben Wing.
7 ;; Maintainer: XEmacs Development Team
8 ;; Keywords: internal, extensions, dumped
10 ;; This file is part of XEmacs.
12 ;; XEmacs is free software; you can redistribute it and/or modify it
13 ;; under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; XEmacs is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ;; General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with XEmacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Synched up with: Not in FSF. (Completely divergent from FSF menu-bar.el)
31 ;; This file is dumped with XEmacs (when menubar support is compiled in).
33 ;; Some stuff in FSF menu-bar.el is in x-menubar.el
38 "Input from the menus."
41 (defvar default-menubar nil)
43 ;; this function is considered "part of the lexicon" by many,
44 ;; so we'll leave it here.
45 (defun kill-this-buffer () ; for the menubar
46 "Kill the current buffer."
48 (kill-buffer (current-buffer)))
50 (defun set-menubar-dirty-flag ()
51 "Tell XEmacs that the menubar has to be updated.
52 NOTE: XEmacs now recognizes when you set a different value for
53 `current-menubar'. You *only* need to call this function if you
54 destructively modify a part of the menubar and don't set `current-menubar'.
55 Note that all the functions that modify a menu call this automatically."
56 (setq-default current-menubar (default-value 'current-menubar)))
58 ;; #### shouldn't this perhaps be `copy-tree'?
59 (defun set-menubar (menubar)
60 "Set the default menubar to be MENUBAR.
61 See `current-menubar' for a description of the syntax of a menubar."
62 (check-menu-syntax menubar t)
63 (setq-default current-menubar (copy-sequence menubar)))
65 (defun set-buffer-menubar (menubar)
66 "Set the buffer-local menubar to be MENUBAR.
67 See `current-menubar' for a description of the syntax of a menubar."
68 (check-menu-syntax menubar t)
69 (make-local-variable 'current-menubar)
70 (setq current-menubar (copy-sequence menubar)))
72 (defun check-menu-syntax (menu &optional menubar-p)
73 ;; The C code does syntax checking on the value of `current-menubar',
74 ;; but it's better to do it early, before things have gotten messed up.
77 (or (stringp (car menu))
79 (list "menu name (first element) must be a string" menu)))
80 ;;(or (cdr menu) (signal 'error (list "menu is empty" menu)))
81 (setq menu (cdr menu)))
83 (while (keywordp (setq item (car menu)))
84 (or (memq item '(:config :included :filter :accelerator))
86 (list "menu keyword must be :config, :included, :accelerator or :filter"
88 (if (or (not (cdr menu))
89 (vectorp (nth 1 menu))
90 (keywordp (nth 1 menu)))
91 (signal 'error (list "strange keyword value" item (nth 1 menu))))
92 (setq menu (nthcdr 2 menu)))
94 (setq menuitem (car menu))
97 (and (string-match "^\\(-+\\|=+\\):\\(.*\\)" menuitem)
98 (setq item (match-string 2 menuitem))
99 (or (member item '(;; Motif-compatible
108 "shadowEtchedOutDash"
109 ;; non-Motif (Lucid menubar widget only)
110 "shadowDoubleEtchedIn"
111 "shadowDoubleEtchedOut"
112 "shadowDoubleEtchedInDash"
113 "shadowDoubleEtchedOutDash"
115 (signal 'error (list "bogus separator style in menu item" item)))
119 (signal 'error (list "nil is only permitted in the top level of menubars"))))
121 (check-menu-syntax menuitem))
123 (let ((L (length menuitem))
127 (list "button descriptors must be at least 2 long"
129 (setq plistp (or (>= L 5)
130 (and (> L 2) (keywordp (aref menuitem 2)))))
131 (or (stringp (aref menuitem 0))
134 "first element of a button must be a string (the label)"
138 (null (aref menuitem 3))
139 (stringp (aref menuitem 3))
142 "fourth element of a button must be a string (the label suffix)"
150 (setq item (aref menuitem i))
151 (cond ((not (memq item '(:active :suffix :keys :style
152 :full :included :selected
155 (list (if (keywordp item)
156 "unknown menu item keyword"
160 (setq style (aref menuitem (1+ i)))
161 (or (memq style '(nil toggle radio button text))
162 (signal 'error (list "unknown style" style
164 ((eq item :selected) (setq selp t))
166 (setq i (+ i (if (eq item :full) 1 2))))
167 (if (and selp (not (memq style '(toggle button radio))))
170 ":selected only makes sense with :style toggle, radio, or button"
174 ;; (t (signal 'error (list "unrecognised menu descriptor" menuitem))))
175 (t (message "unrecognised menu descriptor %s" (prin1-to-string menuitem))))
176 (setq menu (cdr menu)))))
179 ;;; menu manipulation functions
181 (defun find-menu-item (menubar item-path-list &optional parent)
182 "Search MENUBAR for item given by ITEM-PATH-LIST starting from PARENT.
183 Returns (ITEM . PARENT), where PARENT is the immediate parent of
185 If the item does not exist, the car of the returned value is nil.
186 If some menu in the ITEM-PATH-LIST does not exist, an error is signalled."
187 (check-argument-type 'listp item-path-list)
189 (setq item-path-list (mapcar 'normalize-menu-item-name item-path-list)))
190 (if (not (consp menubar))
194 (when (stringp (car rest))
195 (setq rest (cdr rest)))
196 (while (keywordp (car rest))
197 (setq rest (cddr rest)))
200 (equal (car item-path-list)
201 (normalize-menu-item-name
202 (cond ((vectorp (car rest))
204 ((stringp (car rest))
208 (setq result (car rest)
210 (setq rest (cdr rest))))
211 (if (cdr item-path-list)
212 (cond ((consp result)
213 (find-menu-item (cdr result) (cdr item-path-list) result))
215 (signal 'error (list (gettext "not a submenu") result)))
217 (signal 'error (list (gettext "no such submenu")
218 (car item-path-list)))))
219 (cons result parent)))))
221 (defun add-menu-item-1 (leaf-p menu-path new-item before)
222 ;; This code looks like it could be cleaned up some more
223 ;; Do we really need 6 calls to find-menu-item?
224 (when before (setq before (normalize-menu-item-name before)))
226 (cond ((vectorp new-item) (aref new-item 0))
227 ((consp new-item) (car new-item))
229 (menubar current-menubar)
230 (menu (condition-case ()
231 (car (find-menu-item menubar menu-path))
237 (signal 'error (list (gettext "not a submenu")
240 (find-menu-item (cdr menu) (list item-name)))
242 (find-menu-item menubar (list item-name)))
245 (error "`current-menubar' is nil: can't add menus to it."))
247 (let ((rest menu-path)
250 ;;; (setq menu (car (find-menu-item (cdr so-far) (list (car rest)))))
252 (if (eq so-far menubar)
253 (car (find-menu-item so-far (list (car rest))))
254 (car (find-menu-item (cdr so-far) (list (car rest))))))
256 (let ((rest2 so-far))
257 (while (and (cdr rest2) (car (cdr rest2)))
258 (setq rest2 (cdr rest2)))
260 (nconc (list (setq menu (list (car rest))))
263 (setq rest (cdr rest)))))
264 (if (and item-found (car item-found))
265 ;; hack the item in place.
267 ;; Isn't it very bad form to use nsubstitute for side effects?
268 (nsubstitute new-item (car item-found) menu)
269 (setq current-menubar (nsubstitute new-item
272 ;; OK, we have to add the whole thing...
273 ;; if BEFORE is specified, try to add it there.
274 (unless menu (setq menu current-menubar))
276 (setq before (car (find-menu-item menu (list before)))))
280 (if (eq before (car (cdr rest)))
282 (setcdr rest (cons new-item (cdr rest)))
283 (setq rest nil added-before t))
284 (setq rest (cdr rest))))
285 (when (not added-before)
286 ;; adding before the first item on the menubar itself is harder
287 (if (and (eq menu menubar) (eq before (car menu)))
288 (setq menu (cons new-item menu)
289 current-menubar menu)
290 ;; otherwise, add the item to the end.
291 (nconc menu (list new-item))))))
292 (set-menubar-dirty-flag)
295 (defun add-menu-button (menu-path menu-leaf &optional before)
296 "Add a menu item to some menu, creating the menu first if necessary.
297 If the named item exists already, it is changed.
298 MENU-PATH identifies the menu under which the new menu item should be inserted.
299 It is a list of strings; for example, (\"File\") names the top-level \"File\"
300 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
301 MENU-LEAF is a menubar leaf node. See the documentation of `current-menubar'.
302 BEFORE, if provided, is the name of a menu item before which this item should
303 be added, if this item is not on the menu already. If the item is already
304 present, it will not be moved."
305 (add-menu-item-1 t menu-path menu-leaf before))
307 ;; I actually liked the old name better, but the interface has changed too
308 ;; drastically to keep it. --Stig
309 (defun add-submenu (menu-path submenu &optional before)
310 "Add a menu to the menubar or one of its submenus.
311 If the named menu exists already, it is changed.
312 MENU-PATH identifies the menu under which the new menu should be inserted.
313 It is a list of strings; for example, (\"File\") names the top-level \"File\"
314 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
315 If MENU-PATH is nil, then the menu will be added to the menubar itself.
316 SUBMENU is the new menu to add.
317 See the documentation of `current-menubar' for the syntax.
318 BEFORE, if provided, is the name of a menu before which this menu should
319 be added, if this menu is not on its parent already. If the menu is already
320 present, it will not be moved."
321 (check-menu-syntax submenu nil)
322 (add-menu-item-1 nil menu-path submenu before))
324 (defun purecopy-menubar (x)
325 ;; this calls purecopy on the strings, and the contents of the vectors,
326 ;; but not on the vectors themselves, or the conses - those must be
329 (let ((i (length x)))
331 (aset x (1- i) (purecopy (aref x (1- i))))
337 (setcar rest (purecopy-menubar (car rest)))
338 (setq rest (cdr rest))))
343 (defun delete-menu-item (path)
344 "Remove the named menu item from the menu hierarchy.
345 PATH is a list of strings which identify the position of the menu item in
346 the menu hierarchy. The documentation of `add-submenu' describes menu-paths."
347 (let* ((pair (condition-case nil (find-menu-item current-menubar path)
350 (parent (or (cdr pair) current-menubar)))
353 ;; the menubar is the only special case, because other menus begin
355 (if (eq parent current-menubar)
356 (setq current-menubar (delq item parent))
358 (set-menubar-dirty-flag)
361 (defun relabel-menu-item (path new-name)
362 "Change the string of the specified menu item.
363 PATH is a list of strings which identify the position of the menu item in
364 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
365 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
366 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\".
367 NEW-NAME is the string that the menu item will be printed as from now on."
368 (or (stringp new-name)
369 (setq new-name (signal 'wrong-type-argument (list 'stringp new-name))))
370 (let* ((menubar current-menubar)
371 (pair (find-menu-item menubar path))
375 (signal 'error (list (if menu (gettext "No such menu item")
376 (gettext "No such menu"))
378 (if (and (consp item)
379 (stringp (car item)))
380 (setcar item new-name)
381 (aset item 0 new-name))
382 (set-menubar-dirty-flag)
385 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
387 ;; these are all bad style. Why in the world would we put evaluable forms
388 ;; into the menubar if we didn't want people to use 'em?
389 ;; x-font-menu.el is the only known offender right now and that ought to be
393 (defun enable-menu-item-1 (path toggle-p on-p)
395 (if (and (vectorp path) (> (length path) 2)) ; limited syntax checking...
397 (let* ((menubar current-menubar)
398 (pair (find-menu-item menubar path)))
399 (setq item (car pair)
402 (signal 'error (list (if menu
407 (error "%S is a menu, not a menu item" path))))
408 (if (or (> (length item) 4)
409 (and (symbolp (aref item 2))
410 (= ?: (aref (symbol-name (aref item 2)) 0))))
413 (keyword (if toggle-p :selected :active))
415 (while (< i (length item))
416 (cond ((eq (aref item i) keyword)
417 (aset item (1+ i) on-p)
422 (signal 'error (list "not a toggle menu item" item)))
424 ;; Need to copy the item to extend it, sigh...
425 (let ((cons (memq item menu))
426 (new-item (vconcat item (list keyword on-p))))
428 (setcar cons (setq item new-item))
430 (error "couldn't find %S on its parent?" item)
431 (error "no %S slot to set: %S" keyword item)))))))
434 (signal 'error (list "not a toggle menu item" item))
436 (set-menubar-dirty-flag)
439 (defun enable-menu-item (path)
440 "Make the named menu item be selectable.
441 PATH is a list of strings which identify the position of the menu item in
442 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
443 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
444 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
445 (enable-menu-item-1 path nil t))
447 (defun disable-menu-item (path)
448 "Make the named menu item be unselectable.
449 PATH is a list of strings which identify the position of the menu item in
450 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
451 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
452 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
453 (enable-menu-item-1 path nil nil))
455 (defun select-toggle-menu-item (path)
456 "Make the named toggle- or radio-style menu item be in the `selected' state.
457 PATH is a list of strings which identify the position of the menu item in
458 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
459 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
460 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
461 (enable-menu-item-1 path t t))
463 (defun deselect-toggle-menu-item (path)
464 "Make the named toggle- or radio-style menu item be in the `unselected' state.
465 PATH is a list of strings which identify the position of the menu item in
466 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
467 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
468 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
469 (enable-menu-item-1 path t nil))
472 (defun get-popup-menu-response (menu-desc &optional event)
473 "Pop up the given menu and wait for a response.
474 This blocks until the response is received, and returns the misc-user
475 event that encapsulates the response. To execute it, you can do
476 (funcall (event-function response) (event-object response))
477 If no response was received, nil is returned.
479 MENU-DESC and EVENT are as in the call to `popup-menu'."
480 ;; partially stolen from w3
481 (let ((echo-keystrokes 0)
483 (popup-menu menu-desc event)
486 (setq new-event (next-command-event new-event))
487 (cond ((misc-user-event-p new-event)
488 (throw 'popup-done new-event))
490 (setq unread-command-events (cons new-event
491 unread-command-events))
492 (throw 'popup-done nil))
493 ((button-release-event-p new-event);; don't beep twice
495 ((event-matches-key-specifier-p (quit-char))
499 (message "please make a choice from the menu.")))))))
501 (defun popup-menu-and-execute-in-window (menu-desc event)
502 "Pop up the given menu and execute its response in EVENT's window.
503 This blocks until the response is received, temporarily selects
504 EVENT's window, and executes the command specified in the response.
505 EVENT can also be a window. See `popup-menu' for the semantics of
508 (get-popup-menu-response menu-desc
509 (and (eventp event) event))))
510 (and (misc-user-event-p response)
511 (save-selected-window
512 (select-window (if (windowp event) event
513 (event-window event)))
514 (funcall (event-function response)
515 (event-object response))))))
517 ;; provide default bindings for menu accelerator map
518 (and (boundp 'menu-accelerator-map)
519 (keymapp menu-accelerator-map)
521 (define-key menu-accelerator-map "\e" 'menu-escape)
522 (define-key menu-accelerator-map [left] 'menu-left)
523 (define-key menu-accelerator-map [right] 'menu-right)
524 (define-key menu-accelerator-map [up] 'menu-up)
525 (define-key menu-accelerator-map [down] 'menu-down)
526 (define-key menu-accelerator-map [return] 'menu-select)
527 (define-key menu-accelerator-map [kp_down] 'menu-down)
528 (define-key menu-accelerator-map [kp_up] 'menu-down)
529 (define-key menu-accelerator-map [kp_left] 'menu-left)
530 (define-key menu-accelerator-map [kp_right] 'menu-right)
531 (define-key menu-accelerator-map [kp_enter] 'menu-select)
532 (define-key menu-accelerator-map "\C-g" 'menu-quit)))
537 ;;; menubar.el ends here