annotate lisp/easymenu.el @ 4843:715b15990d0a

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