Mercurial > hg > xemacs-beta

comparison lisp/menubar.el @ 209:41ff10fd062f r20-4b3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-4b3
author cvs
date Mon, 13 Aug 2007 10:04:58 +0200
parents
children 12579d965149
comparison
equal deleted inserted replaced
208:f427b8ec4379 209:41ff10fd062f
1 ;;; menubar.el --- Menubar support for XEmacs
2
3 ;; Copyright (C) 1991-4, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
5 ;; Copyright (C) 1995, 1996 Ben Wing.
6
7 ;; Maintainer: XEmacs Development Team
8 ;; Keywords: internal, extensions, dumped
9
10 ;; This file is part of XEmacs.
11
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)
15 ;; any later version.
16
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.
21
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.
26
27 ;;; Synched up with: Not in FSF. (Completely divergent from FSF menu-bar.el)
28
29 ;;; Commentary:
30
31 ;; This file is dumped with XEmacs (when menubar support is compiled in).
32
33 ;; Some stuff in FSF menu-bar.el is in x-menubar.el
34
35 ;;; Code:
36
37 (defvar default-menubar nil)
38
39 ;; this function is considered "part of the lexicon" by many,
40 ;; so we'll leave it here.
41 (defun kill-this-buffer () ; for the menubar
42 "Kill the current buffer."
43 (interactive)
44 (kill-buffer (current-buffer)))
45
46 (defun set-menubar-dirty-flag ()
47 "Tell XEmacs that the menubar has to be updated.
48 NOTE: XEmacs now recognizes when you set a different value for
49 `current-menubar'. You *only* need to call this function if you
50 destructively modify a part of the menubar and don't set `current-menubar'.
51 Note that all the functions that modify a menu call this automatically."
52 (setq-default current-menubar (default-value 'current-menubar)))
53
54 ;; #### shouldn't this perhaps be `copy-tree'?
55 (defun set-menubar (menubar)
56 "Set the default menubar to be MENUBAR.
57 See `current-menubar' for a description of the syntax of a menubar."
58 (check-menu-syntax menubar t)
59 (setq-default current-menubar (copy-sequence menubar)))
60
61 (defun set-buffer-menubar (menubar)
62 "Set the buffer-local menubar to be MENUBAR.
63 See `current-menubar' for a description of the syntax of a menubar."
64 (check-menu-syntax menubar t)
65 (make-local-variable 'current-menubar)
66 (setq current-menubar (copy-sequence menubar)))
67
68 (defun check-menu-syntax (menu &optional menubar-p)
69 ;; The C code does syntax checking on the value of `current-menubar',
70 ;; but it's better to do it early, before things have gotten messed up.
71 (if menubar-p
72 nil
73 (or (stringp (car menu))
74 (signal 'error
75 (list "menu name (first element) must be a string" menu)))
76 ;;(or (cdr menu) (signal 'error (list "menu is empty" menu)))
77 (setq menu (cdr menu)))
78 (let (menuitem item)
79 (while (keywordp (setq item (car menu)))
80 (or (memq item '(:config :included :filter :accelerator))
81 (signal 'error
82 (list "menu keyword must be :config, :included, :accelerator or :filter"
83 item)))
84 (if (or (not (cdr menu))
85 (vectorp (nth 1 menu))
86 (keywordp (nth 1 menu)))
87 (signal 'error (list "strange keyword value" item (nth 1 menu))))
88 (setq menu (nthcdr 2 menu)))
89 (while menu
90 (setq menuitem (car menu))
91 (cond
92 ((stringp menuitem)
93 (and (string-match "^\\(-+\\|=+\\):\\(.*\\)" menuitem)
94 (setq item (match-string 2 menuitem))
95 (or (member item '(;; Motif-compatible
96 "singleLine"
97 "doubleLine"
98 "singleDashedLine"
99 "doubleDashedLine"
100 "noLine"
101 "shadowEtchedIn"
102 "shadowEtchedOut"
103 "shadowEtchedInDash"
104 "shadowEtchedOutDash"
105 ;; non-Motif (Lucid menubar widget only)
106 "shadowDoubleEtchedIn"
107 "shadowDoubleEtchedOut"
108 "shadowDoubleEtchedInDash"
109 "shadowDoubleEtchedOutDash"
110 ))
111 (signal 'error (list "bogus separator style in menu item" item)))
112 ))
113 ((null menuitem)
114 (or menubar-p
115 (signal 'error (list "nil is only permitted in the top level of menubars"))))
116 ((consp menuitem)
117 (check-menu-syntax menuitem))
118 ((vectorp menuitem)
119 (let ((L (length menuitem))
120 plistp)
121 (and (< L 3)
122 (signal 'error
123 (list "button descriptors must be at least 3 long"
124 menuitem)))
125 (setq plistp (or (>= L 5) (keywordp (aref menuitem 2))))
126 (or (stringp (aref menuitem 0))
127 (signal 'error
128 (list
129 "first element of a button must be a string (the label)"
130 menuitem)))
131 (or plistp
132 (< L 4)
133 (null (aref menuitem 3))
134 (stringp (aref menuitem 3))
135 (signal 'error
136 (list
137 "fourth element of a button must be a string (the label suffix)"
138 menuitem)))
139 (if plistp
140 (let ((i 2)
141 selp
142 style
143 item)
144 (while (< i L)
145 (setq item (aref menuitem i))
146 (cond ((not (memq item '(:active :suffix :keys :style
147 :full :included :selected
148 :accelerator)))
149 (signal 'error
150 (list (if (keywordp item)
151 "unknown menu item keyword"
152 "not a keyword")
153 item menuitem)))
154 ((eq item :style)
155 (setq style (aref menuitem (1+ i)))
156 (or (memq style '(nil toggle radio button text))
157 (signal 'error (list "unknown style" style
158 menuitem))))
159 ((eq item :selected) (setq selp t))
160 )
161 (setq i (+ i (if (eq item :full) 1 2))))
162 (if (and selp (not (memq style '(toggle button radio))))
163 (signal 'error
164 (list
165 ":selected only makes sense with :style toggle, radio, or button"
166 menuitem)))
167 )))
168 )
169 (t (signal 'error (list "unrecognised menu descriptor" menuitem))))
170 (setq menu (cdr menu)))))
171
172
173 ;;; menu manipulation functions
174
175 (defun find-menu-item (menubar item-path-list &optional parent)
176 "Search MENUBAR for item given by ITEM-PATH-LIST starting from PARENT.
177 Returns (ITEM . PARENT), where PARENT is the immediate parent of
178 the item found.
179 If the item does not exist, the car of the returned value is nil.
180 If some menu in the ITEM-PATH-LIST does not exist, an error is signalled."
181 (or (listp item-path-list)
182 (signal 'wrong-type-argument (list 'listp item-path-list)))
183 (or parent (setq item-path-list (mapcar 'normalize-menu-item-name item-path-list)))
184 (if (not (consp menubar))
185 nil
186 (let ((rest menubar)
187 result)
188 (if (stringp (car rest))
189 (setq rest (cdr rest)))
190 (while (keywordp (car rest))
191 (setq rest (cddr rest)))
192 (while rest
193 (if (and (car rest)
194 (equal (car item-path-list)
195 (normalize-menu-item-name (if (vectorp (car rest))
196 (aref (car rest) 0)
197 (if (stringp (car rest))
198 (car rest)
199 (car (car rest)))))))
200 (setq result (car rest) rest nil)
201 (setq rest (cdr rest))))
202 (if (cdr item-path-list)
203 (if (consp result)
204 (find-menu-item (cdr result) (cdr item-path-list) result)
205 (if result
206 (signal 'error (list (gettext "not a submenu") result))
207 (signal 'error (list (gettext "no such submenu") (car item-path-list)))))
208 (cons result parent)))))
209
210 (defun add-menu-item-1 (leaf-p menu-path new-item before)
211 ;; This code looks like it could be cleaned up some more
212 ;; Do we really need 6 calls to find-menu-item?
213 (when before (setq before (normalize-menu-item-name before)))
214 (let* ((item-name
215 (cond ((vectorp new-item) (aref new-item 0))
216 ((consp new-item) (car new-item))
217 (t nil)))
218 (menubar current-menubar)
219 (menu (condition-case ()
220 (car (find-menu-item menubar menu-path))
221 (error nil)))
222 (item-found (cond
223 ((null item-name)
224 nil)
225 ((not (listp menu))
226 (signal 'error (list (gettext "not a submenu")
227 menu-path)))
228 (menu
229 (find-menu-item (cdr menu) (list item-name)))
230 (t
231 (find-menu-item menubar (list item-name)))
232 )))
233 (unless menubar
234 (error "`current-menubar' is nil: can't add menus to it."))
235 (unless menu
236 (let ((rest menu-path)
237 (so-far menubar))
238 (while rest
239 ;;; (setq menu (car (find-menu-item (cdr so-far) (list (car rest)))))
240 (setq menu
241 (if (eq so-far menubar)
242 (car (find-menu-item so-far (list (car rest))))
243 (car (find-menu-item (cdr so-far) (list (car rest))))))
244 (unless menu
245 (let ((rest2 so-far))
246 (while (and (cdr rest2) (car (cdr rest2)))
247 (setq rest2 (cdr rest2)))
248 (setcdr rest2
249 (nconc (list (setq menu (list (car rest))))
250 (cdr rest2)))))
251 (setq so-far menu)
252 (setq rest (cdr rest)))))
253 (if (and item-found (car item-found))
254 ;; hack the item in place.
255 (if menu
256 ;; Isn't it very bad form to use nsubstitute for side effects?
257 (nsubstitute new-item (car item-found) menu)
258 (setq current-menubar (nsubstitute new-item
259 (car item-found)
260 current-menubar)))
261 ;; OK, we have to add the whole thing...
262 ;; if BEFORE is specified, try to add it there.
263 (unless menu (setq menu current-menubar))
264 (when before
265 (setq before (car (find-menu-item menu (list before)))))
266 (let ((rest menu)
267 (added-before nil))
268 (while rest
269 (if (eq before (car (cdr rest)))
270 (progn
271 (setcdr rest (cons new-item (cdr rest)))
272 (setq rest nil added-before t))
273 (setq rest (cdr rest))))
274 (when (not added-before)
275 ;; adding before the first item on the menubar itself is harder
276 (if (and (eq menu menubar) (eq before (car menu)))
277 (setq menu (cons new-item menu)
278 current-menubar menu)
279 ;; otherwise, add the item to the end.
280 (nconc menu (list new-item))))))
281 (set-menubar-dirty-flag)
282 new-item))
283
284 (defun add-menu-button (menu-path menu-leaf &optional before)
285 "Add a menu item to some menu, creating the menu first if necessary.
286 If the named item exists already, it is changed.
287 MENU-PATH identifies the menu under which the new menu item should be inserted.
288 It is a list of strings; for example, (\"File\") names the top-level \"File\"
289 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
290 MENU-LEAF is a menubar leaf node. See the documentation of `current-menubar'.
291 BEFORE, if provided, is the name of a menu item before which this item should
292 be added, if this item is not on the menu already. If the item is already
293 present, it will not be moved."
294 (add-menu-item-1 t menu-path menu-leaf before))
295
296 ;; I actually liked the old name better, but the interface has changed too
297 ;; drastically to keep it. --Stig
298 (defun add-submenu (menu-path submenu &optional before)
299 "Add a menu to the menubar or one of its submenus.
300 If the named menu exists already, it is changed.
301 MENU-PATH identifies the menu under which the new menu should be inserted.
302 It is a list of strings; for example, (\"File\") names the top-level \"File\"
303 menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\".
304 If MENU-PATH is nil, then the menu will be added to the menubar itself.
305 SUBMENU is the new menu to add.
306 See the documentation of `current-menubar' for the syntax.
307 BEFORE, if provided, is the name of a menu before which this menu should
308 be added, if this menu is not on its parent already. If the menu is already
309 present, it will not be moved."
310 (check-menu-syntax submenu nil)
311 (add-menu-item-1 nil menu-path submenu before))
312
313 (defun purecopy-menubar (x)
314 ;; this calls purecopy on the strings, and the contents of the vectors,
315 ;; but not on the vectors themselves, or the conses - those must be
316 ;; writable.
317 (cond ((vectorp x)
318 (let ((i (length x)))
319 (while (> i 0)
320 (aset x (1- i) (purecopy (aref x (1- i))))
321 (setq i (1- i))))
322 x)
323 ((consp x)
324 (let ((rest x))
325 (while rest
326 (setcar rest (purecopy-menubar (car rest)))
327 (setq rest (cdr rest))))
328 x)
329 (t
330 (purecopy x))))
331
332 (defun delete-menu-item (path)
333 "Remove the named menu item from the menu hierarchy.
334 PATH is a list of strings which identify the position of the menu item in
335 the menu hierarchy. The documentation of `add-submenu' describes menu-paths."
336 (let* ((pair (condition-case nil (find-menu-item current-menubar path)
337 (error nil)))
338 (item (car pair))
339 (parent (or (cdr pair) current-menubar)))
340 (if (not item)
341 nil
342 ;; the menubar is the only special case, because other menus begin
343 ;; with their name.
344 (if (eq parent current-menubar)
345 (setq current-menubar (delq item parent))
346 (delq item parent))
347 (set-menubar-dirty-flag)
348 item)))
349
350 (defun relabel-menu-item (path new-name)
351 "Change the string of the specified menu item.
352 PATH is a list of strings which identify the position of the menu item in
353 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
354 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
355 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\".
356 NEW-NAME is the string that the menu item will be printed as from now on."
357 (or (stringp new-name)
358 (setq new-name (signal 'wrong-type-argument (list 'stringp new-name))))
359 (let* ((menubar current-menubar)
360 (pair (find-menu-item menubar path))
361 (item (car pair))
362 (menu (cdr pair)))
363 (or item
364 (signal 'error (list (if menu (gettext "No such menu item")
365 (gettext "No such menu"))
366 path)))
367 (if (and (consp item)
368 (stringp (car item)))
369 (setcar item new-name)
370 (aset item 0 new-name))
371 (set-menubar-dirty-flag)
372 item))
373
374 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
375 ;;
376 ;; these are all bad style. Why in the world would we put evaluable forms
377 ;; into the menubar if we didn't want people to use 'em?
378 ;; x-font-menu.el is the only known offender right now and that ought to be
379 ;; rehashed a bit.
380 ;;
381
382 (defun enable-menu-item-1 (path toggle-p on-p)
383 (let (menu item)
384 (if (and (vectorp path) (> (length path) 2)) ; limited syntax checking...
385 (setq item path)
386 (let* ((menubar current-menubar)
387 (pair (find-menu-item menubar path)))
388 (setq item (car pair)
389 menu (cdr pair))
390 (or item
391 (signal 'error (list (if menu
392 "No such menu item"
393 "No such menu")
394 path)))
395 (if (consp item)
396 (error "%S is a menu, not a menu item" path))))
397 (if (or (> (length item) 4)
398 (and (symbolp (aref item 2))
399 (= ?: (aref (symbol-name (aref item 2)) 0))))
400 ;; plist-like syntax
401 (let ((i 2)
402 (keyword (if toggle-p :selected :active))
403 (ok nil))
404 (while (< i (length item))
405 (cond ((eq (aref item i) keyword)
406 (aset item (1+ i) on-p)
407 (setq ok t)))
408 (setq i (+ i 2)))
409 (cond (ok nil)
410 (toggle-p
411 (signal 'error (list "not a toggle menu item" item)))
412 (t
413 ;; Need to copy the item to extend it, sigh...
414 (let ((cons (memq item menu))
415 (new-item (vconcat item (list keyword on-p))))
416 (if cons
417 (setcar cons (setq item new-item))
418 (if menu
419 (error "couldn't find %S on its parent?" item)
420 (error "no %S slot to set: %S" keyword item)))))))
421 ;; positional syntax
422 (if toggle-p
423 (signal 'error (list "not a toggle menu item" item))
424 (aset item 2 on-p)))
425 (set-menubar-dirty-flag)
426 item))
427
428 (defun enable-menu-item (path)
429 "Make the named menu item be selectable.
430 PATH is a list of strings which identify the position of the menu item in
431 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
432 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
433 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
434 (enable-menu-item-1 path nil t))
435
436 (defun disable-menu-item (path)
437 "Make the named menu item be unselectable.
438 PATH is a list of strings which identify the position of the menu item in
439 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
440 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
441 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
442 (enable-menu-item-1 path nil nil))
443
444 (defun select-toggle-menu-item (path)
445 "Make the named toggle- or radio-style menu item be in the `selected' state.
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 (enable-menu-item-1 path t t))
451
452 (defun deselect-toggle-menu-item (path)
453 "Make the named toggle- or radio-style menu item be in the `unselected' state.
454 PATH is a list of strings which identify the position of the menu item in
455 the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\"
456 under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the
457 menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"."
458 (enable-menu-item-1 path t nil))
459
460
461 (defun get-popup-menu-response (menu-desc &optional event)
462 "Pop up the given menu and wait for a response.
463 This blocks until the response is received, and returns the misc-user
464 event that encapsulates the response. To execute it, you can do
465 (funcall (event-function response) (event-object response))
466 If no response was received, nil is returned.
467
468 MENU-DESC and EVENT are as in the call to `popup-menu'."
469 ;; partially stolen from w3
470 (let ((echo-keystrokes 0)
471 new-event)
472 (popup-menu menu-desc event)
473 (catch 'popup-done
474 (while t
475 (setq new-event (next-command-event new-event))
476 (cond ((misc-user-event-p new-event)
477 (throw 'popup-done new-event))
478 ((not (popup-up-p))
479 (setq unread-command-events (cons new-event
480 unread-command-events))
481 (throw 'popup-done nil))
482 ((button-release-event-p new-event);; don't beep twice
483 nil)
484 ((event-matches-key-specifier-p (quit-char))
485 (signal 'quit nil))
486 (t
487 (beep)
488 (message "please make a choice from the menu.")))))))
489
490 (defun popup-menu-and-execute-in-window (menu-desc event)
491 "Pop up the given menu and execute its response in EVENT's window.
492 This blocks until the response is received, temporarily selects
493 EVENT's window, and executes the command specified in the response.
494 EVENT can also be a window. See `popup-menu' for the semantics of
495 MENU-DESC."
496 (let ((response
497 (get-popup-menu-response menu-desc
498 (and (eventp event) event))))
499 (and (misc-user-event-p response)
500 (save-selected-window
501 (select-window (if (windowp event) event
502 (event-window event)))
503 (funcall (event-function response)
504 (event-object response))))))
505
506 ;; provide default bindings for menu accelerator map
507 (and (boundp 'menu-accelerator-map)
508 (keymapp menu-accelerator-map)
509 (progn
510 (define-key menu-accelerator-map "\e" 'menu-escape)
511 (define-key menu-accelerator-map [left] 'menu-left)
512 (define-key menu-accelerator-map [right] 'menu-right)
513 (define-key menu-accelerator-map [up] 'menu-up)
514 (define-key menu-accelerator-map [down] 'menu-down)
515 (define-key menu-accelerator-map [return] 'menu-select)
516 (define-key menu-accelerator-map [kp_down] 'menu-down)
517 (define-key menu-accelerator-map [kp_up] 'menu-down)
518 (define-key menu-accelerator-map [kp_left] 'menu-left)
519 (define-key menu-accelerator-map [kp_right] 'menu-right)
520 (define-key menu-accelerator-map [kp_enter] 'menu-select)
521 (define-key menu-accelerator-map "\C-g" 'menu-quit)))
522
523
524 (provide 'menubar)
525
526 ;;; menubar.el ends here