1 ;;; menubar.el --- Menubar support for SXEmacs
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 SXEmacs.
12 ;; SXEmacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; SXEmacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Synched up with: Not in FSF. (Completely divergent from FSF menu-bar.el)
29 ;; This file is dumped with SXEmacs (when menubar support is compiled in).
31 ;; Some stuff in FSF menu-bar.el is in menubar-items.el
36 "Input from the menus."
39 (defvar default-menubar nil)
41 ;; this function is considered "part of the lexicon" by many,
42 ;; so we'll leave it here.
43 (defun kill-this-buffer () ; for the menubar
44 "Kill the current buffer."
46 (kill-buffer (current-buffer)))
48 (defun set-menubar-dirty-flag ()
49 "Tell XEmacs that the menubar has to be updated.
50 NOTE: XEmacs now recognizes when you set a different value for
51 `current-menubar'. You *only* need to call this function if you
52 destructively modify a part of the menubar and don't set `current-menubar'.
53 Note that all the functions that modify a menu call this automatically."
54 (setq-default current-menubar (default-value 'current-menubar)))
56 ;; #### shouldn't this perhaps be `copy-tree'?
57 (defun set-menubar (menubar)
58 "Set the default menubar to be MENUBAR.
59 See `current-menubar' for a description of the syntax of a menubar."
60 (check-menu-syntax menubar t)
61 (setq-default current-menubar (copy-sequence menubar)))
63 (defun set-buffer-menubar (menubar)
64 "Set the buffer-local menubar to be MENUBAR.
65 See `current-menubar' for a description of the syntax of a menubar."
66 (check-menu-syntax menubar t)
67 (make-local-variable 'current-menubar)
68 (setq current-menubar (copy-sequence menubar)))
70 (defun check-menu-syntax (menu &optional menubar-p)
71 ;; The C code does syntax checking on the value of `current-menubar',
72 ;; but it's better to do it early, before things have gotten messed up.
75 (or (stringp (car menu))
77 (list "menu name (first element) must be a string" menu)))
78 ;;(or (cdr menu) (signal 'error (list "menu is empty" menu)))
79 (setq menu (cdr menu)))
81 (while (keywordp (setq item (car menu)))
82 (or (memq item '(:config :included :filter :accelerator))
84 (list "menu keyword must be :config, :included, :accelerator or :filter"
86 (if (or (not (cdr menu))
87 (vectorp (nth 1 menu))
88 (keywordp (nth 1 menu)))
89 (signal 'error (list "strange keyword value" item (nth 1 menu))))
90 (setq menu (nthcdr 2 menu)))
92 (setq menuitem (car menu))
95 (and (string-match #r"^\(-+\|=+\):\(.*\)" menuitem)
96 (setq item (match-string 2 menuitem))
97 (or (member item '(;; Motif-compatible
106 "shadowEtchedOutDash"
107 ;; non-Motif (Lucid menubar widget only)
108 "shadowDoubleEtchedIn"
109 "shadowDoubleEtchedOut"
110 "shadowDoubleEtchedInDash"
111 "shadowDoubleEtchedOutDash"
113 (signal 'error (list "bogus separator style in menu item" item)))
117 (signal 'error (list "nil is only permitted in the top level of menubars"))))
119 (check-menu-syntax menuitem))
121 (let ((L (length menuitem))
125 (list "button descriptors must be at least 2 long"
127 (setq plistp (or (>= L 5)
128 (and (> L 2) (keywordp (aref menuitem 2)))))
135 (setq item (aref menuitem i))
136 (cond ((not (memq item '(:active :suffix :keys :style
137 :full :included :selected
140 (list (if (keywordp item)
141 "unknown menu item keyword"
145 (setq style (aref menuitem (1+ i)))
146 (or (memq style '(nil toggle radio button text))
147 (signal 'error (list "unknown style" style
149 ((eq item :selected) (setq selp t))
151 (setq i (+ i (if (eq item :full) 1 2))))
152 (if (and selp (not (memq style '(toggle button radio))))
155 ":selected only makes sense with :style toggle, radio, or button"
159 ;; (t (signal 'error (list "unrecognized menu descriptor" menuitem))))
160 (t (message "unrecognized menu descriptor %s" (prin1-to-string menuitem))))
161 (setq menu (cdr menu)))))
164 ;;; menu manipulation functions
166 (defun find-menu-item (menubar item-path-list &optional parent)
167 "Search MENUBAR for item given by ITEM-PATH-LIST starting from PARENT.
168 Returns (ITEM . PARENT), where PARENT is the immediate parent of
170 If the item does not exist, the car of the returned value is nil.
171 If some menu in the ITEM-PATH-LIST does not exist, an error is signalled."
172 (check-argument-type 'listp item-path-list)
174 (setq item-path-list (mapcar 'normalize-menu-item-name item-path-list)))
175 (if (not (consp menubar))
179 (when (stringp (car rest))
180 (setq rest (cdr rest)))
181 (while (keywordp (car rest))
182 (setq rest (cddr rest)))
185 (equal (car item-path-list)
186 (normalize-menu-item-name
187 (cond ((vectorp (car rest))
189 ((stringp (car rest))
193 (setq result (car rest)
195 (setq rest (cdr rest))))
196 (if (cdr item-path-list)
197 (cond ((consp result)
198 (find-menu-item (cdr result) (cdr item-path-list) result))
200 (signal 'error (list (gettext "not a submenu") result)))
202 (signal 'error (list (gettext "no such submenu")
203 (car item-path-list)))))
204 (cons result parent)))))
206 (defun add-menu-item-1 (leaf-p menu-path new-item before in-menu)
207 ;; This code looks like it could be cleaned up some more
208 ;; Do we really need 6 calls to find-menu-item?
209 (when before (setq before (normalize-menu-item-name before)))
211 (cond ((vectorp new-item) (aref new-item 0))
212 ((consp new-item) (car new-item))
214 (menubar (or in-menu current-menubar))
215 (menu (condition-case ()
216 (car (find-menu-item menubar menu-path))
222 (signal 'error (list (gettext "not a submenu")
225 (find-menu-item (cdr menu) (list item-name)))
227 (find-menu-item menubar (list item-name)))
230 (error "`current-menubar' is nil: can't add menus to it."))
232 (let ((rest menu-path)
235 ;;; (setq menu (car (find-menu-item (cdr so-far) (list (car rest)))))
237 (if (eq so-far menubar)
238 (car (find-menu-item so-far (list (car rest))))
239 (car (find-menu-item (cdr so-far) (list (car rest))))))
241 (let ((rest2 so-far))
242 (while (and (cdr rest2) (car (cdr rest2)))
243 (setq rest2 (cdr rest2)))
245 (nconc (list (setq menu (list (car rest))))
248 (setq rest (cdr rest)))))
249 (if (and item-found (car item-found))
250 ;; hack the item in place.
252 ;; Isn't it very bad form to use nsubstitute for side effects?
253 (nsubstitute new-item (car item-found) menu)
254 (setq current-menubar (nsubstitute new-item
257 ;; OK, we have to add the whole thing...
258 ;; if BEFORE is specified, try to add it there.
259 (unless menu (setq menu current-menubar))
261 (setq before (car (find-menu-item menu (list before)))))
265 (if (eq before (car (cdr rest)))
267 (setcdr rest (cons new-item (cdr rest)))
268 (setq rest nil added-before t))
269 (setq rest (cdr rest))))
270 (when (not added-before)
271 ;; adding before the first item on the menubar itself is harder
272 (if (and (eq menu menubar) (eq before (car menu)))
273 (setq menu (cons new-item menu)
274 current-menubar menu)
275 ;; otherwise, add the item to the end.
276 (nconc menu (list new-item))))))
277 (set-menubar-dirty-flag)
280 (defun add-menu-button (menu-path menu-leaf &optional before in-menu)
281 "Add a menu item to some menu, creating the menu first if necessary.
282 If the named item exists already, it is changed.
283 MENU-PATH identifies the menu under which the new menu item should be inserted.
284 It is a list of strings; for example, (\"File\") names the top-level \"File\"
285 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
286 MENU-LEAF is a menubar leaf node. See the documentation of `current-menubar'.
287 BEFORE, if provided, is the name of a menu item before which this item should
288 be added, if this item is not on the menu already. If the item is already
289 present, it will not be moved.
290 IN-MENU, if provided, means use that instead of `current-menubar' as the
292 ;; Note easymenu.el uses the fact that menu-leaf can be a submenu.
293 (add-menu-item-1 t menu-path menu-leaf before in-menu))
295 ;; I actually liked the old name better, but the interface has changed too
296 ;; drastically to keep it. --Stig
297 (defun add-submenu (menu-path submenu &optional before in-menu)
298 "Add a menu to the menubar or one of its submenus.
299 If the named menu exists already, it is changed.
300 MENU-PATH identifies the menu under which the new menu should be inserted.
301 It is a list of strings; for example, (\"File\") names the top-level \"File\"
302 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
303 If MENU-PATH is nil, then the menu will be added to the menubar itself.
304 SUBMENU is the new menu to add.
305 See the documentation of `current-menubar' for the syntax.
306 BEFORE, if provided, is the name of a menu before which this menu should
307 be added, if this menu is not on its parent already. If the menu is already
308 present, it will not be moved.
309 IN-MENU, if provided, means use that instead of `current-menubar' as the
311 (check-menu-syntax submenu nil)
312 (add-menu-item-1 nil menu-path submenu before in-menu))
313 ;; purespace is no more, so this function is unnecessary
314 ;(defun purecopy-menubar (x)
315 ; ;; this calls purecopy on the strings, and the contents of the vectors,
316 ; ;; but not on the vectors themselves, or the conses - those must be
319 ; (let ((i (length x)))
321 ; (aset x (1- i) (purecopy (aref x (1- i))))
327 ; (setcar rest (purecopy-menubar (car rest)))
328 ; (setq rest (cdr rest))))
333 (defun delete-menu-item (path &optional from-menu)
334 "Remove the named menu item from the menu hierarchy.
335 PATH is a list of strings which identify the position of the menu item
336 in the menu hierarchy. The documentation of `add-submenu' describes
338 FROM-MENU, if provided, means use that instead of `current-menubar'
339 as the menu to change."
340 (let* ((pair (condition-case nil (find-menu-item (or from-menu
341 current-menubar) path)
344 (parent (or (cdr pair) current-menubar)))
347 ;; the menubar is the only special case, because other menus begin
349 (if (eq parent current-menubar)
350 (setq current-menubar (delq item parent))
352 (set-menubar-dirty-flag)
355 (defun relabel-menu-item (path new-name)
356 "Change the string of the specified menu item.
357 PATH is a list of strings which identify the position of the menu item in
358 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
359 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
360 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\".
361 NEW-NAME is the string that the menu item will be printed as from now on."
362 (check-type new-name string)
363 (let* ((menubar current-menubar)
364 (pair (find-menu-item menubar path))
368 (signal 'error (list (if menu (gettext "No such menu item")
369 (gettext "No such menu"))
371 (if (and (consp item)
372 (stringp (car item)))
373 (setcar item new-name)
374 (aset item 0 new-name))
375 (set-menubar-dirty-flag)
378 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
380 ;; these are all bad style. Why in the world would we put evaluable forms
381 ;; into the menubar if we didn't want people to use 'em?
382 ;; x-font-menu.el is the only known offender right now and that ought to be
386 (defun enable-menu-item-1 (path toggle-p on-p)
388 (if (and (vectorp path) (> (length path) 2)) ; limited syntax checking...
390 (let* ((menubar current-menubar)
391 (pair (find-menu-item menubar path)))
392 (setq item (car pair)
395 (signal 'error (list (if menu
400 (error "%S is a menu, not a menu item" path))))
401 (if (or (> (length item) 4)
402 (and (symbolp (aref item 2))
403 (= ?: (aref (symbol-name (aref item 2)) 0))))
406 (keyword (if toggle-p :selected :active))
408 (while (< i (length item))
409 (cond ((eq (aref item i) keyword)
410 (aset item (1+ i) on-p)
415 (signal 'error (list "not a toggle menu item" item)))
417 ;; Need to copy the item to extend it, sigh...
418 (let ((cons (memq item menu))
419 (new-item (vconcat item (list keyword on-p))))