Commit | Line | Data |
---|---|---|
d543e20b PA |
1 | ;;; wid-edit.el --- Functions for creating and using widgets. |
2 | ;; | |
99f01612 | 3 | ;; Copyright (C) 1996, 1997, 1999, 2000 Free Software Foundation, Inc. |
d543e20b PA |
4 | ;; |
5 | ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> | |
a89a9d34 | 6 | ;; Maintainer: FSF |
d543e20b | 7 | ;; Keywords: extensions |
d543e20b | 8 | |
ef3f635f RS |
9 | ;; This file is part of GNU Emacs. |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
13 | ;; the Free Software Foundation; either version 2, or (at your option) | |
14 | ;; any later version. | |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
25 | ||
d543e20b PA |
26 | ;;; Commentary: |
27 | ;; | |
28 | ;; See `widget.el'. | |
29 | ||
30 | ;;; Code: | |
31 | ||
32 | (require 'widget) | |
3acab5ef | 33 | (eval-when-compile (require 'cl)) |
d543e20b PA |
34 | |
35 | ;;; Compatibility. | |
4084d128 RS |
36 | |
37 | (defun widget-event-point (event) | |
38 | "Character position of the end of event if that exists, or nil." | |
17030183 | 39 | (posn-point (event-end event))) |
4084d128 RS |
40 | |
41 | (defalias 'widget-read-event 'read-event) | |
d543e20b PA |
42 | |
43 | (eval-and-compile | |
44 | (autoload 'pp-to-string "pp") | |
45 | (autoload 'Info-goto-node "info") | |
4ee1cf9f | 46 | (autoload 'finder-commentary "finder" nil t) |
d543e20b | 47 | |
a3c88c59 PA |
48 | (unless (fboundp 'button-release-event-p) |
49 | ;; XEmacs function missing from Emacs. | |
50 | (defun button-release-event-p (event) | |
51 | "Non-nil if EVENT is a mouse-button-release event object." | |
52 | (and (eventp event) | |
53 | (memq (event-basic-type event) '(mouse-1 mouse-2 mouse-3)) | |
54 | (or (memq 'click (event-modifiers event)) | |
4084d128 | 55 | (memq 'drag (event-modifiers event))))))) |
d543e20b PA |
56 | |
57 | ;;; Customization. | |
58 | ||
59 | (defgroup widgets nil | |
60 | "Customization support for the Widget Library." | |
61 | :link '(custom-manual "(widget)Top") | |
62f44662 | 62 | :link '(emacs-library-link :tag "Lisp File" "widget.el") |
d543e20b PA |
63 | :prefix "widget-" |
64 | :group 'extensions | |
d543e20b PA |
65 | :group 'hypermedia) |
66 | ||
8697863a PA |
67 | (defgroup widget-documentation nil |
68 | "Options controling the display of documentation strings." | |
69 | :group 'widgets) | |
70 | ||
6aaedd12 PA |
71 | (defgroup widget-faces nil |
72 | "Faces used by the widget library." | |
73 | :group 'widgets | |
74 | :group 'faces) | |
75 | ||
0b296dac | 76 | (defvar widget-documentation-face 'widget-documentation-face |
a89a9d34 | 77 | "Face used for documentation strings in widgets. |
0b296dac RS |
78 | This exists as a variable so it can be set locally in certain buffers.") |
79 | ||
8697863a PA |
80 | (defface widget-documentation-face '((((class color) |
81 | (background dark)) | |
82 | (:foreground "lime green")) | |
83 | (((class color) | |
84 | (background light)) | |
85 | (:foreground "dark green")) | |
86 | (t nil)) | |
87 | "Face used for documentation text." | |
88 | :group 'widget-documentation | |
89 | :group 'widget-faces) | |
90 | ||
2f477381 | 91 | (defvar widget-button-face 'widget-button-face |
a89a9d34 | 92 | "Face used for buttons in widgets. |
2f477381 RS |
93 | This exists as a variable so it can be set locally in certain buffers.") |
94 | ||
d543e20b PA |
95 | (defface widget-button-face '((t (:bold t))) |
96 | "Face used for widget buttons." | |
6aaedd12 | 97 | :group 'widget-faces) |
d543e20b PA |
98 | |
99 | (defcustom widget-mouse-face 'highlight | |
100 | "Face used for widget buttons when the mouse is above them." | |
101 | :type 'face | |
6aaedd12 | 102 | :group 'widget-faces) |
d543e20b PA |
103 | |
104 | (defface widget-field-face '((((class grayscale color) | |
105 | (background light)) | |
6d528fc5 | 106 | (:background "gray85")) |
d543e20b PA |
107 | (((class grayscale color) |
108 | (background dark)) | |
25ac13b5 | 109 | (:background "dim gray")) |
d543e20b PA |
110 | (t |
111 | (:italic t))) | |
112 | "Face used for editable fields." | |
6aaedd12 | 113 | :group 'widget-faces) |
d543e20b | 114 | |
c953515e PA |
115 | (defface widget-single-line-field-face '((((class grayscale color) |
116 | (background light)) | |
117 | (:background "gray85")) | |
118 | (((class grayscale color) | |
119 | (background dark)) | |
120 | (:background "dim gray")) | |
121 | (t | |
122 | (:italic t))) | |
123 | "Face used for editable fields spanning only a single line." | |
124 | :group 'widget-faces) | |
125 | ||
33eae9c0 RS |
126 | ;;; This causes display-table to be loaded, and not usefully. |
127 | ;;;(defvar widget-single-line-display-table | |
128 | ;;; (let ((table (make-display-table))) | |
129 | ;;; (aset table 9 "^I") | |
130 | ;;; (aset table 10 "^J") | |
131 | ;;; table) | |
132 | ;;; "Display table used for single-line editable fields.") | |
133 | ||
134 | ;;;(when (fboundp 'set-face-display-table) | |
135 | ;;; (set-face-display-table 'widget-single-line-field-face | |
136 | ;;; widget-single-line-display-table)) | |
c953515e | 137 | |
d543e20b PA |
138 | ;;; Utility functions. |
139 | ;; | |
140 | ;; These are not really widget specific. | |
141 | ||
d543e20b PA |
142 | (defun widget-princ-to-string (object) |
143 | ;; Return string representation of OBJECT, any Lisp object. | |
144 | ;; No quoting characters are used; no delimiters are printed around | |
145 | ;; the contents of strings. | |
146 | (save-excursion | |
147 | (set-buffer (get-buffer-create " *widget-tmp*")) | |
148 | (erase-buffer) | |
149 | (let ((standard-output (current-buffer))) | |
150 | (princ object)) | |
151 | (buffer-string))) | |
152 | ||
153 | (defun widget-clear-undo () | |
154 | "Clear all undo information." | |
155 | (buffer-disable-undo (current-buffer)) | |
156 | (buffer-enable-undo)) | |
157 | ||
a3c88c59 PA |
158 | (defcustom widget-menu-max-size 40 |
159 | "Largest number of items allowed in a popup-menu. | |
160 | Larger menus are read through the minibuffer." | |
161 | :group 'widgets | |
162 | :type 'integer) | |
163 | ||
703c3a11 KH |
164 | (defcustom widget-menu-max-shortcuts 40 |
165 | "Largest number of items for which it works to choose one with a character. | |
166 | For a larger number of items, the minibuffer is used." | |
167 | :group 'widgets | |
168 | :type 'integer) | |
169 | ||
170 | (defcustom widget-menu-minibuffer-flag nil | |
0b296dac RS |
171 | "*Control how to ask for a choice from the keyboard. |
172 | Non-nil means use the minibuffer; | |
173 | nil means read a single character." | |
174 | :group 'widgets | |
175 | :type 'boolean) | |
176 | ||
d543e20b PA |
177 | (defun widget-choose (title items &optional event) |
178 | "Choose an item from a list. | |
179 | ||
180 | First argument TITLE is the name of the list. | |
6d528fc5 PA |
181 | Second argument ITEMS is an list whose members are either |
182 | (NAME . VALUE), to indicate selectable items, or just strings to | |
183 | indicate unselectable items. | |
d543e20b PA |
184 | Optional third argument EVENT is an input event. |
185 | ||
186 | The user is asked to choose between each NAME from the items alist, | |
187 | and the VALUE of the chosen element will be returned. If EVENT is a | |
188 | mouse event, and the number of elements in items is less than | |
189 | `widget-menu-max-size', a popup menu will be used, otherwise the | |
190 | minibuffer." | |
191 | (cond ((and (< (length items) widget-menu-max-size) | |
192 | event (fboundp 'x-popup-menu) window-system) | |
193 | ;; We are in Emacs-19, pressed by the mouse | |
194 | (x-popup-menu event | |
195 | (list title (cons "" items)))) | |
703c3a11 KH |
196 | ((or widget-menu-minibuffer-flag |
197 | (> (length items) widget-menu-max-shortcuts)) | |
0b296dac | 198 | ;; Read the choice of name from the minibuffer. |
e5dfabb4 | 199 | (setq items (widget-remove-if 'stringp items)) |
d543e20b PA |
200 | (let ((val (completing-read (concat title ": ") items nil t))) |
201 | (if (stringp val) | |
202 | (let ((try (try-completion val items))) | |
203 | (when (stringp try) | |
204 | (setq val try)) | |
205 | (cdr (assoc val items))) | |
0b296dac RS |
206 | nil))) |
207 | (t | |
208 | ;; Construct a menu of the choices | |
209 | ;; and then use it for prompting for a single character. | |
210 | (let* ((overriding-terminal-local-map | |
211 | (make-sparse-keymap)) | |
212 | map choice (next-digit ?0) | |
cfc198e5 | 213 | some-choice-enabled |
0b296dac RS |
214 | value) |
215 | ;; Define SPC as a prefix char to get to this menu. | |
216 | (define-key overriding-terminal-local-map " " | |
217 | (setq map (make-sparse-keymap title))) | |
d4b8422f RS |
218 | (save-excursion |
219 | (set-buffer (get-buffer-create " widget-choose")) | |
220 | (erase-buffer) | |
221 | (insert "Available choices:\n\n") | |
222 | (while items | |
223 | (setq choice (car items) items (cdr items)) | |
224 | (if (consp choice) | |
225 | (let* ((name (car choice)) | |
226 | (function (cdr choice))) | |
227 | (insert (format "%c = %s\n" next-digit name)) | |
cfc198e5 RS |
228 | (define-key map (vector next-digit) function) |
229 | (setq some-choice-enabled t))) | |
d4b8422f RS |
230 | ;; Allocate digits to disabled alternatives |
231 | ;; so that the digit of a given alternative never varies. | |
232 | (setq next-digit (1+ next-digit))) | |
233 | (insert "\nC-g = Quit")) | |
cfc198e5 RS |
234 | (or some-choice-enabled |
235 | (error "None of the choices is currently meaningful")) | |
d4b8422f | 236 | (define-key map [?\C-g] 'keyboard-quit) |
0b296dac | 237 | (define-key map [t] 'keyboard-quit) |
4d52438e KH |
238 | (define-key map [?\M-\C-v] 'scroll-other-window) |
239 | (define-key map [?\M--] 'negative-argument) | |
0b296dac | 240 | (setcdr map (nreverse (cdr map))) |
0b296dac RS |
241 | ;; Read a char with the menu, and return the result |
242 | ;; that corresponds to it. | |
d4b8422f | 243 | (save-window-excursion |
4d52438e KH |
244 | (let ((buf (get-buffer " widget-choose"))) |
245 | (display-buffer buf) | |
246 | (let ((cursor-in-echo-area t) | |
247 | keys | |
248 | (char 0) | |
249 | (arg 1)) | |
250 | (while (not (or (and (>= char ?0) (< char next-digit)) | |
251 | (eq value 'keyboard-quit))) | |
252 | ;; Unread a SPC to lead to our new menu. | |
253 | (setq unread-command-events (cons ?\ unread-command-events)) | |
254 | (setq keys (read-key-sequence title)) | |
255 | (setq value (lookup-key overriding-terminal-local-map keys t) | |
256 | char (string-to-char (substring keys 1))) | |
257 | (cond ((eq value 'scroll-other-window) | |
258 | (let ((minibuffer-scroll-window (get-buffer-window buf))) | |
259 | (if (> 0 arg) | |
260 | (scroll-other-window-down (window-height minibuffer-scroll-window)) | |
261 | (scroll-other-window)) | |
262 | (setq arg 1))) | |
263 | ((eq value 'negative-argument) | |
264 | (setq arg -1)) | |
265 | (t | |
266 | (setq arg 1))))))) | |
0b296dac RS |
267 | (when (eq value 'keyboard-quit) |
268 | (error "Canceled")) | |
269 | value)))) | |
d543e20b | 270 | |
e5dfabb4 RS |
271 | (defun widget-remove-if (predictate list) |
272 | (let (result (tail list)) | |
273 | (while tail | |
274 | (or (funcall predictate (car tail)) | |
275 | (setq result (cons (car tail) result))) | |
276 | (setq tail (cdr tail))) | |
277 | (nreverse result))) | |
278 | ||
d543e20b PA |
279 | ;;; Widget text specifications. |
280 | ;; | |
281 | ;; These functions are for specifying text properties. | |
282 | ||
8697863a PA |
283 | (defcustom widget-field-add-space |
284 | (or (< emacs-major-version 20) | |
285 | (and (eq emacs-major-version 20) | |
286 | (< emacs-minor-version 3)) | |
287 | (not (string-match "XEmacs" emacs-version))) | |
288 | "Non-nil means add extra space at the end of editable text fields. | |
289 | ||
290 | This is needed on all versions of Emacs, and on XEmacs before 20.3. | |
291 | If you don't add the space, it will become impossible to edit a zero | |
292 | size field." | |
293 | :type 'boolean | |
294 | :group 'widgets) | |
295 | ||
da5ec617 | 296 | (defcustom widget-field-use-before-change |
4ee1cf9f PA |
297 | (and (or (> emacs-minor-version 34) |
298 | (> emacs-major-version 19)) | |
299 | (not (string-match "XEmacs" emacs-version))) | |
da5ec617 | 300 | "Non-nil means use `before-change-functions' to track editable fields. |
cfc198e5 | 301 | This enables the use of undo, but doesn't work on Emacs 19.34 and earlier. |
da5ec617 PA |
302 | Using before hooks also means that the :notify function can't know the |
303 | new value." | |
304 | :type 'boolean | |
305 | :group 'widgets) | |
306 | ||
d543e20b | 307 | (defun widget-specify-field (widget from to) |
0a3a0b56 | 308 | "Specify editable button for WIDGET between FROM and TO." |
0ce5b5d5 PA |
309 | ;; Terminating space is not part of the field, but necessary in |
310 | ;; order for local-map to work. Remove next sexp if local-map works | |
311 | ;; at the end of the overlay. | |
312 | (save-excursion | |
313 | (goto-char to) | |
62f44662 PA |
314 | (cond ((null (widget-get widget :size)) |
315 | (forward-char 1)) | |
316 | (widget-field-add-space | |
317 | (insert-and-inherit " "))) | |
0ce5b5d5 | 318 | (setq to (point))) |
d543e20b | 319 | (let ((map (widget-get widget :keymap)) |
0a3a0b56 PA |
320 | (face (or (widget-get widget :value-face) 'widget-field-face)) |
321 | (help-echo (widget-get widget :help-echo)) | |
62f44662 PA |
322 | (overlay (make-overlay from to nil |
323 | nil (or (not widget-field-add-space) | |
99f01612 | 324 | (widget-get widget :size))))) |
0a3a0b56 | 325 | (widget-put widget :field-overlay overlay) |
a89a9d34 | 326 | ;;(overlay-put overlay 'detachable nil) |
0a3a0b56 PA |
327 | (overlay-put overlay 'field widget) |
328 | (overlay-put overlay 'local-map map) | |
a89a9d34 | 329 | ;;(overlay-put overlay 'keymap map) |
0a3a0b56 | 330 | (overlay-put overlay 'face face) |
a89a9d34 | 331 | ;;(overlay-put overlay 'balloon-help help-echo) |
99f01612 DL |
332 | (if (stringp help-echo) |
333 | (overlay-put overlay 'help-echo help-echo))) | |
e9367b9c RS |
334 | (widget-specify-secret widget)) |
335 | ||
336 | (defun widget-specify-secret (field) | |
337 | "Replace text in FIELD with value of `:secret', if non-nil." | |
338 | (let ((secret (widget-get field :secret)) | |
339 | (size (widget-get field :size))) | |
340 | (when secret | |
341 | (let ((begin (widget-field-start field)) | |
342 | (end (widget-field-end field))) | |
343 | (when size | |
344 | (while (and (> end begin) | |
345 | (eq (char-after (1- end)) ?\ )) | |
346 | (setq end (1- end)))) | |
347 | (while (< begin end) | |
348 | (let ((old (char-after begin))) | |
349 | (unless (eq old secret) | |
350 | (subst-char-in-region begin (1+ begin) old secret) | |
351 | (put-text-property begin (1+ begin) 'secret old)) | |
352 | (setq begin (1+ begin)))))))) | |
d543e20b | 353 | |
d543e20b | 354 | (defun widget-specify-button (widget from to) |
0a3a0b56 | 355 | "Specify button for WIDGET between FROM and TO." |
d543e20b | 356 | (let ((face (widget-apply widget :button-face-get)) |
0a3a0b56 PA |
357 | (help-echo (widget-get widget :help-echo)) |
358 | (overlay (make-overlay from to nil t nil))) | |
359 | (widget-put widget :button-overlay overlay) | |
0a3a0b56 PA |
360 | (overlay-put overlay 'button widget) |
361 | (overlay-put overlay 'mouse-face widget-mouse-face) | |
a89a9d34 | 362 | ;;(overlay-put overlay 'balloon-help help-echo) |
99f01612 DL |
363 | (if (stringp help-echo) |
364 | (overlay-put overlay 'help-echo help-echo)) | |
0a3a0b56 | 365 | (overlay-put overlay 'face face))) |
d543e20b | 366 | |
d543e20b PA |
367 | (defun widget-specify-sample (widget from to) |
368 | ;; Specify sample for WIDGET between FROM and TO. | |
0f648ca2 PA |
369 | (let ((face (widget-apply widget :sample-face-get)) |
370 | (overlay (make-overlay from to nil t nil))) | |
371 | (overlay-put overlay 'face face) | |
372 | (widget-put widget :sample-overlay overlay))) | |
373 | ||
d543e20b PA |
374 | (defun widget-specify-doc (widget from to) |
375 | ;; Specify documentation for WIDGET between FROM and TO. | |
4ee1cf9f PA |
376 | (let ((overlay (make-overlay from to nil t nil))) |
377 | (overlay-put overlay 'widget-doc widget) | |
378 | (overlay-put overlay 'face widget-documentation-face) | |
379 | (widget-put widget :doc-overlay overlay))) | |
d543e20b PA |
380 | |
381 | (defmacro widget-specify-insert (&rest form) | |
382 | ;; Execute FORM without inheriting any text properties. | |
6d528fc5 PA |
383 | (` |
384 | (save-restriction | |
d543e20b PA |
385 | (let ((inhibit-read-only t) |
386 | result | |
c6753d66 | 387 | before-change-functions |
d543e20b PA |
388 | after-change-functions) |
389 | (insert "<>") | |
390 | (narrow-to-region (- (point) 2) (point)) | |
d543e20b | 391 | (goto-char (1+ (point-min))) |
6d528fc5 | 392 | (setq result (progn (,@ form))) |
d543e20b PA |
393 | (delete-region (point-min) (1+ (point-min))) |
394 | (delete-region (1- (point-max)) (point-max)) | |
395 | (goto-char (point-max)) | |
6d528fc5 | 396 | result)))) |
d543e20b PA |
397 | |
398 | (defface widget-inactive-face '((((class grayscale color) | |
399 | (background dark)) | |
400 | (:foreground "light gray")) | |
401 | (((class grayscale color) | |
402 | (background light)) | |
83427907 | 403 | (:foreground "dim gray")) |
d543e20b PA |
404 | (t |
405 | (:italic t))) | |
406 | "Face used for inactive widgets." | |
6aaedd12 | 407 | :group 'widget-faces) |
d543e20b PA |
408 | |
409 | (defun widget-specify-inactive (widget from to) | |
410 | "Make WIDGET inactive for user modifications." | |
411 | (unless (widget-get widget :inactive) | |
412 | (let ((overlay (make-overlay from to nil t nil))) | |
413 | (overlay-put overlay 'face 'widget-inactive-face) | |
6aaedd12 PA |
414 | ;; This is disabled, as it makes the mouse cursor change shape. |
415 | ;; (overlay-put overlay 'mouse-face 'widget-inactive-face) | |
6d528fc5 PA |
416 | (overlay-put overlay 'evaporate t) |
417 | (overlay-put overlay 'priority 100) | |
a89a9d34 | 418 | (overlay-put overlay 'modification-hooks '(widget-overlay-inactive)) |
d543e20b PA |
419 | (widget-put widget :inactive overlay)))) |
420 | ||
421 | (defun widget-overlay-inactive (&rest junk) | |
422 | "Ignoring the arguments, signal an error." | |
423 | (unless inhibit-read-only | |
a89a9d34 | 424 | (error "The widget here is not active"))) |
d543e20b PA |
425 | |
426 | ||
427 | (defun widget-specify-active (widget) | |
428 | "Make WIDGET active for user modifications." | |
429 | (let ((inactive (widget-get widget :inactive))) | |
430 | (when inactive | |
431 | (delete-overlay inactive) | |
432 | (widget-put widget :inactive nil)))) | |
433 | ||
434 | ;;; Widget Properties. | |
435 | ||
436 | (defsubst widget-type (widget) | |
437 | "Return the type of WIDGET, a symbol." | |
438 | (car widget)) | |
439 | ||
944c91b6 PA |
440 | (defun widget-get-indirect (widget property) |
441 | "In WIDGET, get the value of PROPERTY. | |
442 | If the value is a symbol, return its binding. | |
443 | Otherwise, just return the value." | |
444 | (let ((value (widget-get widget property))) | |
445 | (if (symbolp value) | |
446 | (symbol-value value) | |
447 | value))) | |
448 | ||
d543e20b PA |
449 | (defun widget-member (widget property) |
450 | "Non-nil iff there is a definition in WIDGET for PROPERTY." | |
451 | (cond ((widget-plist-member (cdr widget) property) | |
452 | t) | |
453 | ((car widget) | |
454 | (widget-member (get (car widget) 'widget-type) property)) | |
455 | (t nil))) | |
456 | ||
d543e20b PA |
457 | (defun widget-value (widget) |
458 | "Extract the current value of WIDGET." | |
459 | (widget-apply widget | |
460 | :value-to-external (widget-apply widget :value-get))) | |
461 | ||
462 | (defun widget-value-set (widget value) | |
463 | "Set the current value of WIDGET to VALUE." | |
464 | (widget-apply widget | |
465 | :value-set (widget-apply widget | |
466 | :value-to-internal value))) | |
467 | ||
783824f5 | 468 | (defun widget-default-get (widget) |
416cd771 | 469 | "Extract the default value of WIDGET." |
783824f5 RS |
470 | (or (widget-get widget :value) |
471 | (widget-apply widget :default-get))) | |
472 | ||
d543e20b | 473 | (defun widget-match-inline (widget vals) |
a89a9d34 | 474 | "In WIDGET, match the start of VALS." |
d543e20b PA |
475 | (cond ((widget-get widget :inline) |
476 | (widget-apply widget :match-inline vals)) | |
b2aeee30 | 477 | ((and (listp vals) |
d543e20b PA |
478 | (widget-apply widget :match (car vals))) |
479 | (cons (list (car vals)) (cdr vals))) | |
480 | (t nil))) | |
481 | ||
482 | (defun widget-apply-action (widget &optional event) | |
483 | "Apply :action in WIDGET in response to EVENT." | |
8697863a PA |
484 | (if (widget-apply widget :active) |
485 | (widget-apply widget :action event) | |
486 | (error "Attempt to perform action on inactive widget"))) | |
6d528fc5 | 487 | |
a3c88c59 PA |
488 | ;;; Helper functions. |
489 | ;; | |
490 | ;; These are widget specific. | |
491 | ||
492 | ;;;###autoload | |
493 | (defun widget-prompt-value (widget prompt &optional value unbound) | |
494 | "Prompt for a value matching WIDGET, using PROMPT. | |
495 | The current value is assumed to be VALUE, unless UNBOUND is non-nil." | |
496 | (unless (listp widget) | |
497 | (setq widget (list widget))) | |
498 | (setq prompt (format "[%s] %s" (widget-type widget) prompt)) | |
499 | (setq widget (widget-convert widget)) | |
500 | (let ((answer (widget-apply widget :prompt-value prompt value unbound))) | |
501 | (unless (widget-apply widget :match answer) | |
502 | (error "Value does not match %S type." (car widget))) | |
503 | answer)) | |
504 | ||
505 | (defun widget-get-sibling (widget) | |
506 | "Get the item WIDGET is assumed to toggle. | |
507 | This is only meaningful for radio buttons or checkboxes in a list." | |
508 | (let* ((parent (widget-get widget :parent)) | |
509 | (children (widget-get parent :children)) | |
510 | child) | |
511 | (catch 'child | |
512 | (while children | |
513 | (setq child (car children) | |
514 | children (cdr children)) | |
515 | (when (eq (widget-get child :button) widget) | |
516 | (throw 'child child))) | |
517 | nil))) | |
518 | ||
6aaedd12 PA |
519 | (defun widget-map-buttons (function &optional buffer maparg) |
520 | "Map FUNCTION over the buttons in BUFFER. | |
521 | FUNCTION is called with the arguments WIDGET and MAPARG. | |
522 | ||
523 | If FUNCTION returns non-nil, the walk is cancelled. | |
524 | ||
525 | The arguments MAPARG, and BUFFER default to nil and (current-buffer), | |
526 | respectively." | |
527 | (let ((cur (point-min)) | |
528 | (widget nil) | |
529 | (parent nil) | |
530 | (overlays (if buffer | |
531 | (save-excursion (set-buffer buffer) (overlay-lists)) | |
532 | (overlay-lists)))) | |
533 | (setq overlays (append (car overlays) (cdr overlays))) | |
534 | (while (setq cur (pop overlays)) | |
535 | (setq widget (overlay-get cur 'button)) | |
536 | (if (and widget (funcall function widget maparg)) | |
537 | (setq overlays nil))))) | |
538 | ||
d543e20b PA |
539 | ;;; Glyphs. |
540 | ||
541 | (defcustom widget-glyph-directory (concat data-directory "custom/") | |
542 | "Where widget glyphs are located. | |
543 | If this variable is nil, widget will try to locate the directory | |
25ac13b5 | 544 | automatically." |
d543e20b PA |
545 | :group 'widgets |
546 | :type 'directory) | |
547 | ||
548 | (defcustom widget-glyph-enable t | |
549 | "If non nil, use glyphs in images when available." | |
550 | :group 'widgets | |
551 | :type 'boolean) | |
552 | ||
25ac13b5 PA |
553 | (defcustom widget-image-conversion |
554 | '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg") | |
555 | (xbm ".xbm")) | |
556 | "Conversion alist from image formats to file name suffixes." | |
557 | :group 'widgets | |
558 | :type '(repeat (cons :format "%v" | |
559 | (symbol :tag "Image Format" unknown) | |
560 | (repeat :tag "Suffixes" | |
561 | (string :format "%v"))))) | |
562 | ||
3acab5ef PA |
563 | (defun widget-glyph-find (image tag) |
564 | "Create a glyph corresponding to IMAGE with string TAG as fallback. | |
565 | IMAGE should either already be a glyph, or be a file name sans | |
566 | extension (xpm, xbm, gif, jpg, or png) located in | |
567 | `widget-glyph-directory'." | |
568 | (cond ((not (and image | |
569 | (string-match "XEmacs" emacs-version) | |
d543e20b PA |
570 | widget-glyph-enable |
571 | (fboundp 'make-glyph) | |
25ac13b5 | 572 | (fboundp 'locate-file) |
d543e20b PA |
573 | image)) |
574 | ;; We don't want or can't use glyphs. | |
3acab5ef | 575 | nil) |
d543e20b PA |
576 | ((and (fboundp 'glyphp) |
577 | (glyphp image)) | |
3acab5ef PA |
578 | ;; Already a glyph. Use it. |
579 | image) | |
25ac13b5 PA |
580 | ((stringp image) |
581 | ;; A string. Look it up in relevant directories. | |
582 | (let* ((dirlist (list (or widget-glyph-directory | |
583 | (concat data-directory | |
584 | "custom/")) | |
585 | data-directory)) | |
586 | (formats widget-image-conversion) | |
587 | file) | |
588 | (while (and formats (not file)) | |
0ce5b5d5 PA |
589 | (when (valid-image-instantiator-format-p (car (car formats))) |
590 | (setq file (locate-file image dirlist | |
591 | (mapconcat 'identity | |
592 | (cdr (car formats)) | |
593 | ":")))) | |
594 | (unless file | |
25ac13b5 | 595 | (setq formats (cdr formats)))) |
0ce5b5d5 PA |
596 | (and file |
597 | ;; We create a glyph with the file as the default image | |
598 | ;; instantiator, and the TAG fallback | |
599 | (make-glyph (list (vector (car (car formats)) ':file file) | |
600 | (vector 'string ':data tag)))))) | |
25ac13b5 PA |
601 | ((valid-instantiator-p image 'image) |
602 | ;; A valid image instantiator (e.g. [gif :file "somefile"] etc.) | |
3acab5ef PA |
603 | (make-glyph (list image |
604 | (vector 'string ':data tag)))) | |
0ce5b5d5 PA |
605 | ((consp image) |
606 | ;; This could be virtually anything. Let `make-glyph' sort it out. | |
607 | (make-glyph image)) | |
d543e20b | 608 | (t |
25ac13b5 | 609 | ;; Oh well. |
3acab5ef PA |
610 | nil))) |
611 | ||
612 | (defun widget-glyph-insert (widget tag image &optional down inactive) | |
613 | "In WIDGET, insert the text TAG or, if supported, IMAGE. | |
614 | IMAGE should either be a glyph, an image instantiator, or an image file | |
615 | name sans extension (xpm, xbm, gif, jpg, or png) located in | |
616 | `widget-glyph-directory'. | |
617 | ||
618 | Optional arguments DOWN and INACTIVE is used instead of IMAGE when the | |
619 | glyph is pressed or inactive, respectively. | |
620 | ||
621 | WARNING: If you call this with a glyph, and you want the user to be | |
622 | able to invoke the glyph, make sure it is unique. If you use the | |
623 | same glyph for multiple widgets, invoking any of the glyphs will | |
0ce5b5d5 PA |
624 | cause the last created widget to be invoked. |
625 | ||
626 | Instead of an instantiator, you can also use a list of instantiators, | |
627 | or whatever `make-glyph' will accept. However, in that case you must | |
628 | provide the fallback TAG as a part of the instantiator yourself." | |
3acab5ef PA |
629 | (let ((glyph (widget-glyph-find image tag))) |
630 | (if glyph | |
631 | (widget-glyph-insert-glyph widget | |
632 | glyph | |
633 | (widget-glyph-find down tag) | |
634 | (widget-glyph-find inactive tag)) | |
635 | (insert tag)))) | |
25ac13b5 PA |
636 | |
637 | (defun widget-glyph-insert-glyph (widget glyph &optional down inactive) | |
3acab5ef PA |
638 | "In WIDGET, insert GLYPH. |
639 | If optional arguments DOWN and INACTIVE are given, they should be | |
640 | glyphs used when the widget is pushed and inactive, respectively." | |
da5ec617 PA |
641 | (when widget |
642 | (set-glyph-property glyph 'widget widget) | |
643 | (when down | |
644 | (set-glyph-property down 'widget widget)) | |
645 | (when inactive | |
646 | (set-glyph-property inactive 'widget widget))) | |
d543e20b | 647 | (insert "*") |
3acab5ef | 648 | (let ((ext (make-extent (point) (1- (point)))) |
da5ec617 | 649 | (help-echo (and widget (widget-get widget :help-echo)))) |
3acab5ef | 650 | (set-extent-property ext 'invisible t) |
8697863a PA |
651 | (set-extent-property ext 'start-open t) |
652 | (set-extent-property ext 'end-open t) | |
3acab5ef PA |
653 | (set-extent-end-glyph ext glyph) |
654 | (when help-echo | |
655 | (set-extent-property ext 'balloon-help help-echo) | |
656 | (set-extent-property ext 'help-echo help-echo))) | |
da5ec617 PA |
657 | (when widget |
658 | (widget-put widget :glyph-up glyph) | |
659 | (when down (widget-put widget :glyph-down down)) | |
660 | (when inactive (widget-put widget :glyph-inactive inactive)))) | |
d543e20b | 661 | |
25ac13b5 PA |
662 | ;;; Buttons. |
663 | ||
664 | (defgroup widget-button nil | |
665 | "The look of various kinds of buttons." | |
666 | :group 'widgets) | |
667 | ||
668 | (defcustom widget-button-prefix "" | |
669 | "String used as prefix for buttons." | |
670 | :type 'string | |
3acab5ef | 671 | :group 'widget-button) |
25ac13b5 PA |
672 | |
673 | (defcustom widget-button-suffix "" | |
674 | "String used as suffix for buttons." | |
675 | :type 'string | |
3acab5ef | 676 | :group 'widget-button) |
25ac13b5 | 677 | |
d543e20b PA |
678 | ;;; Creating Widgets. |
679 | ||
680 | ;;;###autoload | |
681 | (defun widget-create (type &rest args) | |
682 | "Create widget of TYPE. | |
683 | The optional ARGS are additional keyword arguments." | |
684 | (let ((widget (apply 'widget-convert type args))) | |
685 | (widget-apply widget :create) | |
686 | widget)) | |
687 | ||
688 | (defun widget-create-child-and-convert (parent type &rest args) | |
689 | "As part of the widget PARENT, create a child widget TYPE. | |
690 | The child is converted, using the keyword arguments ARGS." | |
691 | (let ((widget (apply 'widget-convert type args))) | |
692 | (widget-put widget :parent parent) | |
693 | (unless (widget-get widget :indent) | |
694 | (widget-put widget :indent (+ (or (widget-get parent :indent) 0) | |
695 | (or (widget-get widget :extra-offset) 0) | |
696 | (widget-get parent :offset)))) | |
697 | (widget-apply widget :create) | |
698 | widget)) | |
699 | ||
700 | (defun widget-create-child (parent type) | |
701 | "Create widget of TYPE." | |
ef3f635f | 702 | (let ((widget (copy-sequence type))) |
d543e20b PA |
703 | (widget-put widget :parent parent) |
704 | (unless (widget-get widget :indent) | |
705 | (widget-put widget :indent (+ (or (widget-get parent :indent) 0) | |
706 | (or (widget-get widget :extra-offset) 0) | |
707 | (widget-get parent :offset)))) | |
708 | (widget-apply widget :create) | |
709 | widget)) | |
710 | ||
711 | (defun widget-create-child-value (parent type value) | |
712 | "Create widget of TYPE with value VALUE." | |
ef3f635f | 713 | (let ((widget (copy-sequence type))) |
d543e20b PA |
714 | (widget-put widget :value (widget-apply widget :value-to-internal value)) |
715 | (widget-put widget :parent parent) | |
716 | (unless (widget-get widget :indent) | |
717 | (widget-put widget :indent (+ (or (widget-get parent :indent) 0) | |
718 | (or (widget-get widget :extra-offset) 0) | |
719 | (widget-get parent :offset)))) | |
720 | (widget-apply widget :create) | |
721 | widget)) | |
722 | ||
723 | ;;;###autoload | |
724 | (defun widget-delete (widget) | |
725 | "Delete WIDGET." | |
726 | (widget-apply widget :delete)) | |
727 | ||
728 | (defun widget-convert (type &rest args) | |
729 | "Convert TYPE to a widget without inserting it in the buffer. | |
730 | The optional ARGS are additional keyword arguments." | |
731 | ;; Don't touch the type. | |
732 | (let* ((widget (if (symbolp type) | |
733 | (list type) | |
ef3f635f | 734 | (copy-sequence type))) |
d543e20b PA |
735 | (current widget) |
736 | (keys args)) | |
737 | ;; First set the :args keyword. | |
738 | (while (cdr current) ;Look in the type. | |
739 | (let ((next (car (cdr current)))) | |
740 | (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:)) | |
741 | (setq current (cdr (cdr current))) | |
742 | (setcdr current (list :args (cdr current))) | |
743 | (setq current nil)))) | |
744 | (while args ;Look in the args. | |
745 | (let ((next (nth 0 args))) | |
746 | (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:)) | |
747 | (setq args (nthcdr 2 args)) | |
748 | (widget-put widget :args args) | |
749 | (setq args nil)))) | |
750 | ;; Then Convert the widget. | |
751 | (setq type widget) | |
752 | (while type | |
753 | (let ((convert-widget (plist-get (cdr type) :convert-widget))) | |
754 | (if convert-widget | |
755 | (setq widget (funcall convert-widget widget)))) | |
756 | (setq type (get (car type) 'widget-type))) | |
757 | ;; Finally set the keyword args. | |
758 | (while keys | |
759 | (let ((next (nth 0 keys))) | |
760 | (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:)) | |
761 | (progn | |
762 | (widget-put widget next (nth 1 keys)) | |
763 | (setq keys (nthcdr 2 keys))) | |
764 | (setq keys nil)))) | |
765 | ;; Convert the :value to internal format. | |
766 | (if (widget-member widget :value) | |
767 | (let ((value (widget-get widget :value))) | |
768 | (widget-put widget | |
769 | :value (widget-apply widget :value-to-internal value)))) | |
770 | ;; Return the newly create widget. | |
771 | widget)) | |
772 | ||
773 | (defun widget-insert (&rest args) | |
774 | "Call `insert' with ARGS and make the text read only." | |
775 | (let ((inhibit-read-only t) | |
c6753d66 | 776 | before-change-functions |
d543e20b PA |
777 | after-change-functions |
778 | (from (point))) | |
4ee1cf9f | 779 | (apply 'insert args))) |
d543e20b | 780 | |
8697863a PA |
781 | (defun widget-convert-text (type from to |
782 | &optional button-from button-to | |
783 | &rest args) | |
6aaedd12 | 784 | "Return a widget of type TYPE with endpoint FROM TO. |
8697863a | 785 | Optional ARGS are extra keyword arguments for TYPE. |
6aaedd12 PA |
786 | and TO will be used as the widgets end points. If optional arguments |
787 | BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets | |
8697863a PA |
788 | button end points. |
789 | Optional ARGS are extra keyword arguments for TYPE." | |
790 | (let ((widget (apply 'widget-convert type :delete 'widget-leave-text args)) | |
6aaedd12 PA |
791 | (from (copy-marker from)) |
792 | (to (copy-marker to))) | |
6aaedd12 PA |
793 | (set-marker-insertion-type from t) |
794 | (set-marker-insertion-type to nil) | |
795 | (widget-put widget :from from) | |
796 | (widget-put widget :to to) | |
797 | (when button-from | |
798 | (widget-specify-button widget button-from button-to)) | |
799 | widget)) | |
800 | ||
8697863a | 801 | (defun widget-convert-button (type from to &rest args) |
6aaedd12 | 802 | "Return a widget of type TYPE with endpoint FROM TO. |
8697863a | 803 | Optional ARGS are extra keyword arguments for TYPE. |
6aaedd12 PA |
804 | No text will be inserted to the buffer, instead the text between FROM |
805 | and TO will be used as the widgets end points, as well as the widgets | |
806 | button end points." | |
8697863a PA |
807 | (apply 'widget-convert-text type from to from to args)) |
808 | ||
809 | (defun widget-leave-text (widget) | |
810 | "Remove markers and overlays from WIDGET and its children." | |
811 | (let ((from (widget-get widget :from)) | |
812 | (to (widget-get widget :to)) | |
813 | (button (widget-get widget :button-overlay)) | |
0f648ca2 | 814 | (sample (widget-get widget :sample-overlay)) |
4ee1cf9f | 815 | (doc (widget-get widget :doc-overlay)) |
8697863a PA |
816 | (field (widget-get widget :field-overlay)) |
817 | (children (widget-get widget :children))) | |
818 | (set-marker from nil) | |
819 | (set-marker to nil) | |
208920be PA |
820 | (when button |
821 | (delete-overlay button)) | |
0f648ca2 PA |
822 | (when sample |
823 | (delete-overlay sample)) | |
4ee1cf9f PA |
824 | (when doc |
825 | (delete-overlay doc)) | |
208920be PA |
826 | (when field |
827 | (delete-overlay field)) | |
8697863a | 828 | (mapcar 'widget-leave-text children))) |
6aaedd12 | 829 | |
d543e20b PA |
830 | ;;; Keymap and Commands. |
831 | ||
832 | (defvar widget-keymap nil | |
833 | "Keymap containing useful binding for buffers containing widgets. | |
834 | Recommended as a parent keymap for modes using widgets.") | |
835 | ||
836 | (unless widget-keymap | |
837 | (setq widget-keymap (make-sparse-keymap)) | |
d543e20b | 838 | (define-key widget-keymap "\t" 'widget-forward) |
d543e20b PA |
839 | (define-key widget-keymap [(shift tab)] 'widget-backward) |
840 | (define-key widget-keymap [backtab] 'widget-backward) | |
a3c88c59 | 841 | (if (string-match "XEmacs" emacs-version) |
d543e20b | 842 | (progn |
a3c88c59 PA |
843 | ;;Glyph support. |
844 | (define-key widget-keymap [button1] 'widget-button1-click) | |
845 | (define-key widget-keymap [button2] 'widget-button-click)) | |
d543e20b PA |
846 | (define-key widget-keymap [down-mouse-2] 'widget-button-click)) |
847 | (define-key widget-keymap "\C-m" 'widget-button-press)) | |
848 | ||
849 | (defvar widget-global-map global-map | |
850 | "Keymap used for events the widget does not handle themselves.") | |
851 | (make-variable-buffer-local 'widget-global-map) | |
852 | ||
853 | (defvar widget-field-keymap nil | |
854 | "Keymap used inside an editable field.") | |
855 | ||
856 | (unless widget-field-keymap | |
857 | (setq widget-field-keymap (copy-keymap widget-keymap)) | |
a89a9d34 | 858 | (define-key widget-field-keymap [menu-bar] 'nil) |
0ce5b5d5 PA |
859 | (define-key widget-field-keymap "\C-k" 'widget-kill-line) |
860 | (define-key widget-field-keymap "\M-\t" 'widget-complete) | |
d543e20b PA |
861 | (define-key widget-field-keymap "\C-m" 'widget-field-activate) |
862 | (define-key widget-field-keymap "\C-a" 'widget-beginning-of-line) | |
863 | (define-key widget-field-keymap "\C-e" 'widget-end-of-line) | |
864 | (set-keymap-parent widget-field-keymap global-map)) | |
865 | ||
866 | (defvar widget-text-keymap nil | |
867 | "Keymap used inside a text field.") | |
868 | ||
869 | (unless widget-text-keymap | |
870 | (setq widget-text-keymap (copy-keymap widget-keymap)) | |
a89a9d34 | 871 | (define-key widget-text-keymap [menu-bar] 'nil) |
d543e20b PA |
872 | (define-key widget-text-keymap "\C-a" 'widget-beginning-of-line) |
873 | (define-key widget-text-keymap "\C-e" 'widget-end-of-line) | |
874 | (set-keymap-parent widget-text-keymap global-map)) | |
875 | ||
876 | (defun widget-field-activate (pos &optional event) | |
25ac13b5 | 877 | "Invoke the ediable field at point." |
d543e20b | 878 | (interactive "@d") |
0a3a0b56 | 879 | (let ((field (get-char-property pos 'field))) |
d543e20b PA |
880 | (if field |
881 | (widget-apply-action field event) | |
882 | (call-interactively | |
883 | (lookup-key widget-global-map (this-command-keys)))))) | |
884 | ||
a89a9d34 DL |
885 | (defvar widget-button-pressed-face 'widget-button-pressed-face |
886 | "Face used for pressed buttons in widgets. | |
887 | This exists as a variable so it can be set locally in certain buffers.") | |
888 | ||
a3c88c59 PA |
889 | (defface widget-button-pressed-face |
890 | '((((class color)) | |
891 | (:foreground "red")) | |
892 | (t | |
893 | (:bold t :underline t))) | |
894 | "Face used for pressed buttons." | |
6aaedd12 | 895 | :group 'widget-faces) |
a3c88c59 | 896 | |
d543e20b | 897 | (defun widget-button-click (event) |
d6bc306b | 898 | "Invoke the button that the mouse is pointing at, and move there." |
d543e20b | 899 | (interactive "@e") |
d6bc306b | 900 | (mouse-set-point event) |
d543e20b PA |
901 | (cond ((and (fboundp 'event-glyph) |
902 | (event-glyph event)) | |
a3c88c59 PA |
903 | (widget-glyph-click event)) |
904 | ((widget-event-point event) | |
905 | (let* ((pos (widget-event-point event)) | |
0a3a0b56 | 906 | (button (get-char-property pos 'button))) |
d543e20b | 907 | (if button |
0a3a0b56 PA |
908 | (let* ((overlay (widget-get button :button-overlay)) |
909 | (face (overlay-get overlay 'face)) | |
0ce5b5d5 | 910 | (mouse-face (overlay-get overlay 'mouse-face))) |
a3c88c59 PA |
911 | (unwind-protect |
912 | (let ((track-mouse t)) | |
e006fe5a GM |
913 | (save-excursion |
914 | (overlay-put overlay | |
915 | 'face widget-button-pressed-face) | |
916 | (overlay-put overlay | |
917 | 'mouse-face widget-button-pressed-face) | |
918 | (unless (widget-apply button :mouse-down-action event) | |
919 | (while (not (button-release-event-p event)) | |
920 | (setq event (widget-read-event) | |
921 | pos (widget-event-point event)) | |
922 | (if (and pos | |
923 | (eq (get-char-property pos 'button) | |
924 | button)) | |
925 | (progn | |
926 | (overlay-put overlay | |
927 | 'face | |
928 | widget-button-pressed-face) | |
929 | (overlay-put overlay | |
930 | 'mouse-face | |
931 | widget-button-pressed-face)) | |
932 | (overlay-put overlay 'face face) | |
933 | (overlay-put overlay 'mouse-face mouse-face)))) | |
934 | (when (and pos | |
935 | (eq (get-char-property pos 'button) button)) | |
936 | (widget-apply-action button event)))) | |
0a3a0b56 PA |
937 | (overlay-put overlay 'face face) |
938 | (overlay-put overlay 'mouse-face mouse-face))) | |
da5ec617 PA |
939 | (let ((up t) |
940 | command) | |
0ce5b5d5 PA |
941 | ;; Find the global command to run, and check whether it |
942 | ;; is bound to an up event. | |
943 | (cond ((setq command ;down event | |
da5ec617 PA |
944 | (lookup-key widget-global-map [ button2 ])) |
945 | (setq up nil)) | |
0ce5b5d5 | 946 | ((setq command ;down event |
da5ec617 PA |
947 | (lookup-key widget-global-map [ down-mouse-2 ])) |
948 | (setq up nil)) | |
0ce5b5d5 | 949 | ((setq command ;up event |
da5ec617 | 950 | (lookup-key widget-global-map [ button2up ]))) |
0ce5b5d5 | 951 | ((setq command ;up event |
da5ec617 PA |
952 | (lookup-key widget-global-map [ mouse-2])))) |
953 | (when up | |
0ce5b5d5 | 954 | ;; Don't execute up events twice. |
da5ec617 PA |
955 | (while (not (button-release-event-p event)) |
956 | (setq event (widget-read-event)))) | |
957 | (when command | |
0ce5b5d5 | 958 | (call-interactively command)))))) |
d543e20b PA |
959 | (t |
960 | (message "You clicked somewhere weird.")))) | |
961 | ||
962 | (defun widget-button1-click (event) | |
25ac13b5 | 963 | "Invoke glyph below mouse pointer." |
d543e20b PA |
964 | (interactive "@e") |
965 | (if (and (fboundp 'event-glyph) | |
966 | (event-glyph event)) | |
a3c88c59 | 967 | (widget-glyph-click event) |
d543e20b PA |
968 | (call-interactively (lookup-key widget-global-map (this-command-keys))))) |
969 | ||
a3c88c59 PA |
970 | (defun widget-glyph-click (event) |
971 | "Handle click on a glyph." | |
972 | (let* ((glyph (event-glyph event)) | |
973 | (widget (glyph-property glyph 'widget)) | |
974 | (extent (event-glyph-extent event)) | |
975 | (down-glyph (or (and widget (widget-get widget :glyph-down)) glyph)) | |
976 | (up-glyph (or (and widget (widget-get widget :glyph-up)) glyph)) | |
977 | (last event)) | |
978 | ;; Wait for the release. | |
979 | (while (not (button-release-event-p last)) | |
980 | (if (eq extent (event-glyph-extent last)) | |
981 | (set-extent-property extent 'end-glyph down-glyph) | |
982 | (set-extent-property extent 'end-glyph up-glyph)) | |
17030183 | 983 | (setq last (read-event event))) |
a3c88c59 PA |
984 | ;; Release glyph. |
985 | (when down-glyph | |
986 | (set-extent-property extent 'end-glyph up-glyph)) | |
987 | ;; Apply widget action. | |
988 | (when (eq extent (event-glyph-extent last)) | |
989 | (let ((widget (glyph-property (event-glyph event) 'widget))) | |
990 | (cond ((null widget) | |
991 | (message "You clicked on a glyph.")) | |
992 | ((not (widget-apply widget :active)) | |
993 | (message "This glyph is inactive.")) | |
994 | (t | |
995 | (widget-apply-action widget event))))))) | |
996 | ||
d543e20b | 997 | (defun widget-button-press (pos &optional event) |
25ac13b5 | 998 | "Invoke button at POS." |
d543e20b | 999 | (interactive "@d") |
0a3a0b56 | 1000 | (let ((button (get-char-property pos 'button))) |
d543e20b PA |
1001 | (if button |
1002 | (widget-apply-action button event) | |
1003 | (let ((command (lookup-key widget-global-map (this-command-keys)))) | |
1004 | (when (commandp command) | |
1005 | (call-interactively command)))))) | |
1006 | ||
8697863a PA |
1007 | (defun widget-tabable-at (&optional pos) |
1008 | "Return the tabable widget at POS, or nil. | |
1009 | POS defaults to the value of (point)." | |
1010 | (unless pos | |
1011 | (setq pos (point))) | |
1012 | (let ((widget (or (get-char-property (point) 'button) | |
1013 | (get-char-property (point) 'field)))) | |
1014 | (if widget | |
1015 | (let ((order (widget-get widget :tab-order))) | |
1016 | (if order | |
1017 | (if (>= order 0) | |
1018 | widget | |
1019 | nil) | |
1020 | widget)) | |
1021 | nil))) | |
1022 | ||
35194e3f | 1023 | (defvar widget-use-overlay-change t |
4ee1cf9f | 1024 | "If non-nil, use overlay change functions to tab around in the buffer. |
35194e3f | 1025 | This is much faster, but doesn't work reliably on Emacs 19.34.") |
4ee1cf9f | 1026 | |
d543e20b PA |
1027 | (defun widget-move (arg) |
1028 | "Move point to the ARG next field or button. | |
1029 | ARG may be negative to move backward." | |
0a3a0b56 | 1030 | (or (bobp) (> arg 0) (backward-char)) |
0ce5b5d5 | 1031 | (let ((pos (point)) |
0a3a0b56 | 1032 | (number arg) |
8697863a | 1033 | (old (widget-tabable-at)) |
0a3a0b56 PA |
1034 | new) |
1035 | ;; Forward. | |
1036 | (while (> arg 0) | |
4ee1cf9f PA |
1037 | (cond ((eobp) |
1038 | (goto-char (point-min))) | |
1039 | (widget-use-overlay-change | |
1040 | (goto-char (next-overlay-change (point)))) | |
1041 | (t | |
1042 | (forward-char 1))) | |
0a3a0b56 PA |
1043 | (and (eq pos (point)) |
1044 | (eq arg number) | |
1045 | (error "No buttons or fields found")) | |
8697863a | 1046 | (let ((new (widget-tabable-at))) |
0a3a0b56 PA |
1047 | (when new |
1048 | (unless (eq new old) | |
8697863a | 1049 | (setq arg (1- arg)) |
0a3a0b56 PA |
1050 | (setq old new))))) |
1051 | ;; Backward. | |
1052 | (while (< arg 0) | |
4ee1cf9f PA |
1053 | (cond ((bobp) |
1054 | (goto-char (point-max))) | |
1055 | (widget-use-overlay-change | |
1056 | (goto-char (previous-overlay-change (point)))) | |
1057 | (t | |
1058 | (backward-char 1))) | |
0a3a0b56 PA |
1059 | (and (eq pos (point)) |
1060 | (eq arg number) | |
1061 | (error "No buttons or fields found")) | |
8697863a | 1062 | (let ((new (widget-tabable-at))) |
0a3a0b56 PA |
1063 | (when new |
1064 | (unless (eq new old) | |
8697863a PA |
1065 | (setq arg (1+ arg)))))) |
1066 | (let ((new (widget-tabable-at))) | |
1067 | (while (eq (widget-tabable-at) new) | |
1068 | (backward-char))) | |
0ce5b5d5 PA |
1069 | (forward-char)) |
1070 | (widget-echo-help (point)) | |
1071 | (run-hooks 'widget-move-hook)) | |
d543e20b PA |
1072 | |
1073 | (defun widget-forward (arg) | |
1074 | "Move point to the next field or button. | |
1075 | With optional ARG, move across that many fields." | |
1076 | (interactive "p") | |
1077 | (run-hooks 'widget-forward-hook) | |
1078 | (widget-move arg)) | |
1079 | ||
1080 | (defun widget-backward (arg) | |
1081 | "Move point to the previous field or button. | |
1082 | With optional ARG, move across that many fields." | |
1083 | (interactive "p") | |
1084 | (run-hooks 'widget-backward-hook) | |
1085 | (widget-move (- arg))) | |
1086 | ||
1087 | (defun widget-beginning-of-line () | |
1088 | "Go to beginning of field or beginning of line, whichever is first." | |
1089 | (interactive) | |
0ce5b5d5 | 1090 | (let* ((field (widget-field-find (point))) |
23c1c552 RS |
1091 | (start (and field (widget-field-start field))) |
1092 | (bol (save-excursion | |
1093 | (beginning-of-line) | |
1094 | (point)))) | |
1095 | (goto-char (if start | |
1096 | (max start bol) | |
1097 | bol)))) | |
d543e20b PA |
1098 | |
1099 | (defun widget-end-of-line () | |
1100 | "Go to end of field or end of line, whichever is first." | |
1101 | (interactive) | |
0ce5b5d5 | 1102 | (let* ((field (widget-field-find (point))) |
23c1c552 RS |
1103 | (end (and field (widget-field-end field))) |
1104 | (eol (save-excursion | |
1105 | (end-of-line) | |
1106 | (point)))) | |
1107 | (goto-char (if end | |
1108 | (min end eol) | |
1109 | eol)))) | |
d543e20b PA |
1110 | |
1111 | (defun widget-kill-line () | |
1112 | "Kill to end of field or end of line, whichever is first." | |
1113 | (interactive) | |
0ce5b5d5 PA |
1114 | (let* ((field (widget-field-find (point))) |
1115 | (newline (save-excursion (forward-line 1) (point))) | |
1116 | (end (and field (widget-field-end field)))) | |
1117 | (if (and field (> newline end)) | |
1118 | (kill-region (point) end) | |
d543e20b PA |
1119 | (call-interactively 'kill-line)))) |
1120 | ||
0ce5b5d5 PA |
1121 | (defcustom widget-complete-field (lookup-key global-map "\M-\t") |
1122 | "Default function to call for completion inside fields." | |
1123 | :options '(ispell-complete-word complete-tag lisp-complete-symbol) | |
1124 | :type 'function | |
1125 | :group 'widgets) | |
1126 | ||
1127 | (defun widget-complete () | |
1128 | "Complete content of editable field from point. | |
1129 | When not inside a field, move to the previous button or field." | |
1130 | (interactive) | |
1131 | (let ((field (widget-field-find (point)))) | |
1132 | (if field | |
1133 | (widget-apply field :complete) | |
1134 | (error "Not in an editable field")))) | |
1135 | ||
d543e20b PA |
1136 | ;;; Setting up the buffer. |
1137 | ||
1138 | (defvar widget-field-new nil) | |
1139 | ;; List of all newly created editable fields in the buffer. | |
1140 | (make-variable-buffer-local 'widget-field-new) | |
1141 | ||
1142 | (defvar widget-field-list nil) | |
1143 | ;; List of all editable fields in the buffer. | |
1144 | (make-variable-buffer-local 'widget-field-list) | |
1145 | ||
1146 | (defun widget-setup () | |
1147 | "Setup current buffer so editing string widgets works." | |
1148 | (let ((inhibit-read-only t) | |
1149 | (after-change-functions nil) | |
c6753d66 | 1150 | before-change-functions |
d543e20b PA |
1151 | field) |
1152 | (while widget-field-new | |
1153 | (setq field (car widget-field-new) | |
1154 | widget-field-new (cdr widget-field-new) | |
1155 | widget-field-list (cons field widget-field-list)) | |
0a3a0b56 PA |
1156 | (let ((from (car (widget-get field :field-overlay))) |
1157 | (to (cdr (widget-get field :field-overlay)))) | |
6aaedd12 PA |
1158 | (widget-specify-field field |
1159 | (marker-position from) (marker-position to)) | |
0a3a0b56 PA |
1160 | (set-marker from nil) |
1161 | (set-marker to nil)))) | |
d543e20b | 1162 | (widget-clear-undo) |
4ee1cf9f | 1163 | (widget-add-change)) |
d543e20b PA |
1164 | |
1165 | (defvar widget-field-last nil) | |
1166 | ;; Last field containing point. | |
1167 | (make-variable-buffer-local 'widget-field-last) | |
1168 | ||
1169 | (defvar widget-field-was nil) | |
1170 | ;; The widget data before the change. | |
1171 | (make-variable-buffer-local 'widget-field-was) | |
1172 | ||
0a3a0b56 PA |
1173 | (defun widget-field-buffer (widget) |
1174 | "Return the start of WIDGET's editing field." | |
6aaedd12 PA |
1175 | (let ((overlay (widget-get widget :field-overlay))) |
1176 | (and overlay (overlay-buffer overlay)))) | |
0a3a0b56 PA |
1177 | |
1178 | (defun widget-field-start (widget) | |
1179 | "Return the start of WIDGET's editing field." | |
6aaedd12 PA |
1180 | (let ((overlay (widget-get widget :field-overlay))) |
1181 | (and overlay (overlay-start overlay)))) | |
0a3a0b56 PA |
1182 | |
1183 | (defun widget-field-end (widget) | |
1184 | "Return the end of WIDGET's editing field." | |
6aaedd12 PA |
1185 | (let ((overlay (widget-get widget :field-overlay))) |
1186 | ;; Don't subtract one if local-map works at the end of the overlay. | |
62f44662 PA |
1187 | (and overlay (if (or widget-field-add-space |
1188 | (null (widget-get widget :size))) | |
8697863a PA |
1189 | (1- (overlay-end overlay)) |
1190 | (overlay-end overlay))))) | |
0a3a0b56 | 1191 | |
d543e20b | 1192 | (defun widget-field-find (pos) |
0a3a0b56 PA |
1193 | "Return the field at POS. |
1194 | Unlike (get-char-property POS 'field) this, works with empty fields too." | |
d543e20b PA |
1195 | (let ((fields widget-field-list) |
1196 | field found) | |
1197 | (while fields | |
1198 | (setq field (car fields) | |
1199 | fields (cdr fields)) | |
0a3a0b56 PA |
1200 | (let ((start (widget-field-start field)) |
1201 | (end (widget-field-end field))) | |
1202 | (when (and (<= start pos) (<= pos end)) | |
1203 | (when found | |
1204 | (debug "Overlapping fields")) | |
1205 | (setq found field)))) | |
d543e20b PA |
1206 | found)) |
1207 | ||
4ee1cf9f | 1208 | (defun widget-before-change (from to) |
944c91b6 PA |
1209 | ;; This is how, for example, a variable changes its state to `modified'. |
1210 | ;; when it is being edited. | |
540a8bd2 RS |
1211 | (unless inhibit-read-only |
1212 | (let ((from-field (widget-field-find from)) | |
1213 | (to-field (widget-field-find to))) | |
1214 | (cond ((not (eq from-field to-field)) | |
1215 | (add-hook 'post-command-hook 'widget-add-change nil t) | |
808bcfd2 KH |
1216 | (signal 'text-read-only |
1217 | '("Change should be restricted to a single field"))) | |
540a8bd2 RS |
1218 | ((null from-field) |
1219 | (add-hook 'post-command-hook 'widget-add-change nil t) | |
808bcfd2 KH |
1220 | (signal 'text-read-only |
1221 | '("Attempt to change text outside editable field"))) | |
540a8bd2 RS |
1222 | (widget-field-use-before-change |
1223 | (condition-case nil | |
1224 | (widget-apply from-field :notify from-field) | |
1225 | (error (debug "Before Change")))))))) | |
4ee1cf9f PA |
1226 | |
1227 | (defun widget-add-change () | |
1228 | (make-local-hook 'post-command-hook) | |
1229 | (remove-hook 'post-command-hook 'widget-add-change t) | |
1230 | (make-local-hook 'before-change-functions) | |
1231 | (add-hook 'before-change-functions 'widget-before-change nil t) | |
1232 | (make-local-hook 'after-change-functions) | |
1233 | (add-hook 'after-change-functions 'widget-after-change nil t)) | |
c6753d66 | 1234 | |
d543e20b PA |
1235 | (defun widget-after-change (from to old) |
1236 | ;; Adjust field size and text properties. | |
1237 | (condition-case nil | |
1238 | (let ((field (widget-field-find from)) | |
0a3a0b56 PA |
1239 | (other (widget-field-find to))) |
1240 | (when field | |
1241 | (unless (eq field other) | |
1242 | (debug "Change in different fields")) | |
e9367b9c | 1243 | (let ((size (widget-get field :size))) |
0a3a0b56 PA |
1244 | (when size |
1245 | (let ((begin (widget-field-start field)) | |
1246 | (end (widget-field-end field))) | |
1247 | (cond ((< (- end begin) size) | |
1248 | ;; Field too small. | |
1249 | (save-excursion | |
1250 | (goto-char end) | |
1251 | (insert-char ?\ (- (+ begin size) end)))) | |
1252 | ((> (- end begin) size) | |
1253 | ;; Field too large and | |
1254 | (if (or (< (point) (+ begin size)) | |
1255 | (> (point) end)) | |
1256 | ;; Point is outside extra space. | |
1257 | (setq begin (+ begin size)) | |
1258 | ;; Point is within the extra space. | |
1259 | (setq begin (point))) | |
1260 | (save-excursion | |
1261 | (goto-char end) | |
1262 | (while (and (eq (preceding-char) ?\ ) | |
1263 | (> (point) begin)) | |
8697863a | 1264 | (delete-backward-char 1))))))) |
e9367b9c | 1265 | (widget-specify-secret field)) |
944c91b6 | 1266 | (widget-apply field :notify field))) |
0a3a0b56 | 1267 | (error (debug "After Change")))) |
d543e20b PA |
1268 | |
1269 | ;;; Widget Functions | |
1270 | ;; | |
1271 | ;; These functions are used in the definition of multiple widgets. | |
1272 | ||
a3c88c59 PA |
1273 | (defun widget-parent-action (widget &optional event) |
1274 | "Tell :parent of WIDGET to handle the :action. | |
1275 | Optional EVENT is the event that triggered the action." | |
1276 | (widget-apply (widget-get widget :parent) :action event)) | |
1277 | ||
d543e20b PA |
1278 | (defun widget-children-value-delete (widget) |
1279 | "Delete all :children and :buttons in WIDGET." | |
1280 | (mapcar 'widget-delete (widget-get widget :children)) | |
1281 | (widget-put widget :children nil) | |
1282 | (mapcar 'widget-delete (widget-get widget :buttons)) | |
1283 | (widget-put widget :buttons nil)) | |
1284 | ||
a3c88c59 PA |
1285 | (defun widget-children-validate (widget) |
1286 | "All the :children must be valid." | |
1287 | (let ((children (widget-get widget :children)) | |
1288 | child found) | |
1289 | (while (and children (not found)) | |
1290 | (setq child (car children) | |
1291 | children (cdr children) | |
1292 | found (widget-apply child :validate))) | |
1293 | found)) | |
1294 | ||
d543e20b PA |
1295 | (defun widget-types-convert-widget (widget) |
1296 | "Convert :args as widget types in WIDGET." | |
1297 | (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args))) | |
1298 | widget) | |
1299 | ||
a3c88c59 PA |
1300 | (defun widget-value-convert-widget (widget) |
1301 | "Initialize :value from :args in WIDGET." | |
1302 | (let ((args (widget-get widget :args))) | |
1303 | (when args | |
1304 | (widget-put widget :value (car args)) | |
1305 | ;; Don't convert :value here, as this is done in `widget-convert'. | |
1306 | ;; (widget-put widget :value (widget-apply widget | |
1307 | ;; :value-to-internal (car args))) | |
1308 | (widget-put widget :args nil))) | |
1309 | widget) | |
1310 | ||
1311 | (defun widget-value-value-get (widget) | |
1312 | "Return the :value property of WIDGET." | |
1313 | (widget-get widget :value)) | |
1314 | ||
d543e20b PA |
1315 | ;;; The `default' Widget. |
1316 | ||
1317 | (define-widget 'default nil | |
1318 | "Basic widget other widgets are derived from." | |
1319 | :value-to-internal (lambda (widget value) value) | |
1320 | :value-to-external (lambda (widget value) value) | |
25ac13b5 PA |
1321 | :button-prefix 'widget-button-prefix |
1322 | :button-suffix 'widget-button-suffix | |
0ce5b5d5 | 1323 | :complete 'widget-default-complete |
d543e20b PA |
1324 | :create 'widget-default-create |
1325 | :indent nil | |
1326 | :offset 0 | |
1327 | :format-handler 'widget-default-format-handler | |
1328 | :button-face-get 'widget-default-button-face-get | |
1329 | :sample-face-get 'widget-default-sample-face-get | |
1330 | :delete 'widget-default-delete | |
1331 | :value-set 'widget-default-value-set | |
1332 | :value-inline 'widget-default-value-inline | |
783824f5 | 1333 | :default-get 'widget-default-default-get |
d543e20b | 1334 | :menu-tag-get 'widget-default-menu-tag-get |
99f01612 | 1335 | :validate #'ignore |
d543e20b PA |
1336 | :active 'widget-default-active |
1337 | :activate 'widget-specify-active | |
1338 | :deactivate 'widget-default-deactivate | |
99f01612 | 1339 | :mouse-down-action #'ignore |
d543e20b | 1340 | :action 'widget-default-action |
6d528fc5 PA |
1341 | :notify 'widget-default-notify |
1342 | :prompt-value 'widget-default-prompt-value) | |
d543e20b | 1343 | |
0ce5b5d5 PA |
1344 | (defun widget-default-complete (widget) |
1345 | "Call the value of the :complete-function property of WIDGET. | |
1346 | If that does not exists, call the value of `widget-complete-field'." | |
1347 | (let ((fun (widget-get widget :complete-function))) | |
1348 | (call-interactively (or fun widget-complete-field)))) | |
1349 | ||
d543e20b PA |
1350 | (defun widget-default-create (widget) |
1351 | "Create WIDGET at point in the current buffer." | |
1352 | (widget-specify-insert | |
1353 | (let ((from (point)) | |
d543e20b PA |
1354 | button-begin button-end |
1355 | sample-begin sample-end | |
1356 | doc-begin doc-end | |
1357 | value-pos) | |
1358 | (insert (widget-get widget :format)) | |
1359 | (goto-char from) | |
1360 | ;; Parse escapes in format. | |
1361 | (while (re-search-forward "%\\(.\\)" nil t) | |
1362 | (let ((escape (aref (match-string 1) 0))) | |
1363 | (replace-match "" t t) | |
1364 | (cond ((eq escape ?%) | |
1365 | (insert "%")) | |
1366 | ((eq escape ?\[) | |
25ac13b5 | 1367 | (setq button-begin (point)) |
944c91b6 | 1368 | (insert (widget-get-indirect widget :button-prefix))) |
d543e20b | 1369 | ((eq escape ?\]) |
944c91b6 | 1370 | (insert (widget-get-indirect widget :button-suffix)) |
d543e20b PA |
1371 | (setq button-end (point))) |
1372 | ((eq escape ?\{) | |
1373 | (setq sample-begin (point))) | |
1374 | ((eq escape ?\}) | |
1375 | (setq sample-end (point))) | |
1376 | ((eq escape ?n) | |
1377 | (when (widget-get widget :indent) | |
1378 | (insert "\n") | |
1379 | (insert-char ? (widget-get widget :indent)))) | |
1380 | ((eq escape ?t) | |
25ac13b5 PA |
1381 | (let ((glyph (widget-get widget :tag-glyph)) |
1382 | (tag (widget-get widget :tag))) | |
1383 | (cond (glyph | |
1384 | (widget-glyph-insert widget (or tag "image") glyph)) | |
1385 | (tag | |
1386 | (insert tag)) | |
1387 | (t | |
1388 | (let ((standard-output (current-buffer))) | |
1389 | (princ (widget-get widget :value))))))) | |
d543e20b | 1390 | ((eq escape ?d) |
25ac13b5 PA |
1391 | (let ((doc (widget-get widget :doc))) |
1392 | (when doc | |
1393 | (setq doc-begin (point)) | |
1394 | (insert doc) | |
1395 | (while (eq (preceding-char) ?\n) | |
1396 | (delete-backward-char 1)) | |
1397 | (insert "\n") | |
1398 | (setq doc-end (point))))) | |
d543e20b PA |
1399 | ((eq escape ?v) |
1400 | (if (and button-begin (not button-end)) | |
1401 | (widget-apply widget :value-create) | |
1402 | (setq value-pos (point)))) | |
1403 | (t | |
1404 | (widget-apply widget :format-handler escape))))) | |
1405 | ;; Specify button, sample, and doc, and insert value. | |
1406 | (and button-begin button-end | |
1407 | (widget-specify-button widget button-begin button-end)) | |
1408 | (and sample-begin sample-end | |
1409 | (widget-specify-sample widget sample-begin sample-end)) | |
1410 | (and doc-begin doc-end | |
1411 | (widget-specify-doc widget doc-begin doc-end)) | |
1412 | (when value-pos | |
1413 | (goto-char value-pos) | |
1414 | (widget-apply widget :value-create))) | |
1415 | (let ((from (copy-marker (point-min))) | |
1416 | (to (copy-marker (point-max)))) | |
d543e20b PA |
1417 | (set-marker-insertion-type from t) |
1418 | (set-marker-insertion-type to nil) | |
1419 | (widget-put widget :from from) | |
6d528fc5 PA |
1420 | (widget-put widget :to to))) |
1421 | (widget-clear-undo)) | |
d543e20b PA |
1422 | |
1423 | (defun widget-default-format-handler (widget escape) | |
1424 | ;; We recognize the %h escape by default. | |
6aaedd12 | 1425 | (let* ((buttons (widget-get widget :buttons))) |
d543e20b | 1426 | (cond ((eq escape ?h) |
6aaedd12 PA |
1427 | (let* ((doc-property (widget-get widget :documentation-property)) |
1428 | (doc-try (cond ((widget-get widget :doc)) | |
1429 | ((symbolp doc-property) | |
1430 | (documentation-property | |
1431 | (widget-get widget :value) | |
1432 | doc-property)) | |
1433 | (t | |
1434 | (funcall doc-property | |
1435 | (widget-get widget :value))))) | |
1436 | (doc-text (and (stringp doc-try) | |
1437 | (> (length doc-try) 1) | |
8697863a PA |
1438 | doc-try)) |
1439 | (doc-indent (widget-get widget :documentation-indent))) | |
6aaedd12 PA |
1440 | (when doc-text |
1441 | (and (eq (preceding-char) ?\n) | |
1442 | (widget-get widget :indent) | |
1443 | (insert-char ? (widget-get widget :indent))) | |
1444 | ;; The `*' in the beginning is redundant. | |
1445 | (when (eq (aref doc-text 0) ?*) | |
1446 | (setq doc-text (substring doc-text 1))) | |
1447 | ;; Get rid of trailing newlines. | |
1448 | (when (string-match "\n+\\'" doc-text) | |
1449 | (setq doc-text (substring doc-text 0 (match-beginning 0)))) | |
1450 | (push (widget-create-child-and-convert | |
1451 | widget 'documentation-string | |
8697863a PA |
1452 | :indent (cond ((numberp doc-indent ) |
1453 | doc-indent) | |
1454 | ((null doc-indent) | |
1455 | nil) | |
1456 | (t 0)) | |
6aaedd12 PA |
1457 | doc-text) |
1458 | buttons)))) | |
d543e20b PA |
1459 | (t |
1460 | (error "Unknown escape `%c'" escape))) | |
1461 | (widget-put widget :buttons buttons))) | |
1462 | ||
1463 | (defun widget-default-button-face-get (widget) | |
1464 | ;; Use :button-face or widget-button-face | |
0b296dac RS |
1465 | (or (widget-get widget :button-face) |
1466 | (let ((parent (widget-get widget :parent))) | |
1467 | (if parent | |
1468 | (widget-apply parent :button-face-get) | |
2f477381 | 1469 | widget-button-face)))) |
d543e20b PA |
1470 | |
1471 | (defun widget-default-sample-face-get (widget) | |
1472 | ;; Use :sample-face. | |
1473 | (widget-get widget :sample-face)) | |
1474 | ||
1475 | (defun widget-default-delete (widget) | |
1476 | ;; Remove widget from the buffer. | |
1477 | (let ((from (widget-get widget :from)) | |
1478 | (to (widget-get widget :to)) | |
9097aeb7 PA |
1479 | (inactive-overlay (widget-get widget :inactive)) |
1480 | (button-overlay (widget-get widget :button-overlay)) | |
0f648ca2 | 1481 | (sample-overlay (widget-get widget :sample-overlay)) |
4ee1cf9f | 1482 | (doc-overlay (widget-get widget :doc-overlay)) |
c6753d66 | 1483 | before-change-functions |
0a3a0b56 PA |
1484 | after-change-functions |
1485 | (inhibit-read-only t)) | |
d543e20b | 1486 | (widget-apply widget :value-delete) |
9097aeb7 PA |
1487 | (when inactive-overlay |
1488 | (delete-overlay inactive-overlay)) | |
1489 | (when button-overlay | |
1490 | (delete-overlay button-overlay)) | |
0f648ca2 PA |
1491 | (when sample-overlay |
1492 | (delete-overlay sample-overlay)) | |
4ee1cf9f PA |
1493 | (when doc-overlay |
1494 | (delete-overlay doc-overlay)) | |
d543e20b PA |
1495 | (when (< from to) |
1496 | ;; Kludge: this doesn't need to be true for empty formats. | |
1497 | (delete-region from to)) | |
1498 | (set-marker from nil) | |
6d528fc5 PA |
1499 | (set-marker to nil)) |
1500 | (widget-clear-undo)) | |
d543e20b PA |
1501 | |
1502 | (defun widget-default-value-set (widget value) | |
1503 | ;; Recreate widget with new value. | |
d0acc4ea RS |
1504 | (let* ((old-pos (point)) |
1505 | (from (copy-marker (widget-get widget :from))) | |
1506 | (to (copy-marker (widget-get widget :to))) | |
1507 | (offset (if (and (<= from old-pos) (<= old-pos to)) | |
1508 | (if (>= old-pos (1- to)) | |
1509 | (- old-pos to 1) | |
1510 | (- old-pos from))))) | |
1511 | ;;??? Bug: this ought to insert the new value before deleting the old one, | |
1512 | ;; so that markers on either side of the value automatically | |
1513 | ;; stay on the same side. -- rms. | |
1514 | (save-excursion | |
1515 | (goto-char (widget-get widget :from)) | |
1516 | (widget-apply widget :delete) | |
1517 | (widget-put widget :value value) | |
1518 | (widget-apply widget :create)) | |
1519 | (if offset | |
1520 | (if (< offset 0) | |
1521 | (goto-char (+ (widget-get widget :to) offset 1)) | |
1522 | (goto-char (min (+ from offset) (1- (widget-get widget :to)))))))) | |
d543e20b PA |
1523 | |
1524 | (defun widget-default-value-inline (widget) | |
1525 | ;; Wrap value in a list unless it is inline. | |
1526 | (if (widget-get widget :inline) | |
1527 | (widget-value widget) | |
1528 | (list (widget-value widget)))) | |
1529 | ||
783824f5 RS |
1530 | (defun widget-default-default-get (widget) |
1531 | ;; Get `:value'. | |
1532 | (widget-get widget :value)) | |
1533 | ||
d543e20b PA |
1534 | (defun widget-default-menu-tag-get (widget) |
1535 | ;; Use tag or value for menus. | |
1536 | (or (widget-get widget :menu-tag) | |
1537 | (widget-get widget :tag) | |
1538 | (widget-princ-to-string (widget-get widget :value)))) | |
1539 | ||
1540 | (defun widget-default-active (widget) | |
1541 | "Return t iff this widget active (user modifiable)." | |
0640c647 GM |
1542 | (or (widget-get widget :always-active) |
1543 | (and (not (widget-get widget :inactive)) | |
1544 | (let ((parent (widget-get widget :parent))) | |
1545 | (or (null parent) | |
1546 | (widget-apply parent :active)))))) | |
d543e20b PA |
1547 | |
1548 | (defun widget-default-deactivate (widget) | |
1549 | "Make WIDGET inactive for user modifications." | |
1550 | (widget-specify-inactive widget | |
1551 | (widget-get widget :from) | |
1552 | (widget-get widget :to))) | |
1553 | ||
1554 | (defun widget-default-action (widget &optional event) | |
1555 | ;; Notify the parent when a widget change | |
1556 | (let ((parent (widget-get widget :parent))) | |
1557 | (when parent | |
1558 | (widget-apply parent :notify widget event)))) | |
1559 | ||
1560 | (defun widget-default-notify (widget child &optional event) | |
1561 | ;; Pass notification to parent. | |
1562 | (widget-default-action widget event)) | |
1563 | ||
6d528fc5 PA |
1564 | (defun widget-default-prompt-value (widget prompt value unbound) |
1565 | ;; Read an arbitrary value. Stolen from `set-variable'. | |
1566 | ;; (let ((initial (if unbound | |
1567 | ;; nil | |
1568 | ;; ;; It would be nice if we could do a `(cons val 1)' here. | |
1569 | ;; (prin1-to-string (custom-quote value)))))) | |
1570 | (eval-minibuffer prompt )) | |
1571 | ||
d543e20b PA |
1572 | ;;; The `item' Widget. |
1573 | ||
1574 | (define-widget 'item 'default | |
1575 | "Constant items for inclusion in other widgets." | |
a3c88c59 | 1576 | :convert-widget 'widget-value-convert-widget |
d543e20b PA |
1577 | :value-create 'widget-item-value-create |
1578 | :value-delete 'ignore | |
a3c88c59 | 1579 | :value-get 'widget-value-value-get |
d543e20b PA |
1580 | :match 'widget-item-match |
1581 | :match-inline 'widget-item-match-inline | |
1582 | :action 'widget-item-action | |
1583 | :format "%t\n") | |
1584 | ||
d543e20b PA |
1585 | (defun widget-item-value-create (widget) |
1586 | ;; Insert the printed representation of the value. | |
1587 | (let ((standard-output (current-buffer))) | |
1588 | (princ (widget-get widget :value)))) | |
1589 | ||
1590 | (defun widget-item-match (widget value) | |
1591 | ;; Match if the value is the same. | |
1592 | (equal (widget-get widget :value) value)) | |
1593 | ||
1594 | (defun widget-item-match-inline (widget values) | |
1595 | ;; Match if the value is the same. | |
1596 | (let ((value (widget-get widget :value))) | |
1597 | (and (listp value) | |
1598 | (<= (length value) (length values)) | |
e5dfabb4 | 1599 | (let ((head (widget-sublist values 0 (length value)))) |
d543e20b | 1600 | (and (equal head value) |
e5dfabb4 RS |
1601 | (cons head (widget-sublist values (length value)))))))) |
1602 | ||
1603 | (defun widget-sublist (list start &optional end) | |
1604 | "Return the sublist of LIST from START to END. | |
1605 | If END is omitted, it defaults to the length of LIST." | |
0a3a0b56 PA |
1606 | (if (> start 0) (setq list (nthcdr start list))) |
1607 | (if end | |
1608 | (if (<= end start) | |
1609 | nil | |
1610 | (setq list (copy-sequence list)) | |
1611 | (setcdr (nthcdr (- end start 1) list) nil) | |
1612 | list) | |
1613 | (copy-sequence list))) | |
d543e20b PA |
1614 | |
1615 | (defun widget-item-action (widget &optional event) | |
1616 | ;; Just notify itself. | |
1617 | (widget-apply widget :notify widget event)) | |
1618 | ||
d543e20b PA |
1619 | ;;; The `push-button' Widget. |
1620 | ||
1621 | (defcustom widget-push-button-gui t | |
1622 | "If non nil, use GUI push buttons when available." | |
1623 | :group 'widgets | |
1624 | :type 'boolean) | |
1625 | ||
1626 | ;; Cache already created GUI objects. | |
1627 | (defvar widget-push-button-cache nil) | |
1628 | ||
25ac13b5 PA |
1629 | (defcustom widget-push-button-prefix "[" |
1630 | "String used as prefix for buttons." | |
1631 | :type 'string | |
1632 | :group 'widget-button) | |
1633 | ||
1634 | (defcustom widget-push-button-suffix "]" | |
1635 | "String used as suffix for buttons." | |
1636 | :type 'string | |
1637 | :group 'widget-button) | |
1638 | ||
d543e20b PA |
1639 | (define-widget 'push-button 'item |
1640 | "A pushable button." | |
25ac13b5 PA |
1641 | :button-prefix "" |
1642 | :button-suffix "" | |
d543e20b PA |
1643 | :value-create 'widget-push-button-value-create |
1644 | :format "%[%v%]") | |
1645 | ||
1646 | (defun widget-push-button-value-create (widget) | |
1647 | ;; Insert text representing the `on' and `off' states. | |
1648 | (let* ((tag (or (widget-get widget :tag) | |
1649 | (widget-get widget :value))) | |
da5ec617 | 1650 | (tag-glyph (widget-get widget :tag-glyph)) |
25ac13b5 PA |
1651 | (text (concat widget-push-button-prefix |
1652 | tag widget-push-button-suffix)) | |
d543e20b | 1653 | (gui (cdr (assoc tag widget-push-button-cache)))) |
da5ec617 PA |
1654 | (cond (tag-glyph |
1655 | (widget-glyph-insert widget text tag-glyph)) | |
1656 | ((and (fboundp 'make-gui-button) | |
d543e20b PA |
1657 | (fboundp 'make-glyph) |
1658 | widget-push-button-gui | |
1659 | (fboundp 'device-on-window-system-p) | |
1660 | (device-on-window-system-p) | |
1661 | (string-match "XEmacs" emacs-version)) | |
da5ec617 PA |
1662 | (unless gui |
1663 | (setq gui (make-gui-button tag 'widget-gui-action widget)) | |
1664 | (push (cons tag gui) widget-push-button-cache)) | |
1665 | (widget-glyph-insert-glyph widget | |
1666 | (make-glyph | |
1667 | (list (nth 0 (aref gui 1)) | |
1668 | (vector 'string ':data text))) | |
1669 | (make-glyph | |
1670 | (list (nth 1 (aref gui 1)) | |
1671 | (vector 'string ':data text))) | |
1672 | (make-glyph | |
1673 | (list (nth 2 (aref gui 1)) | |
1674 | (vector 'string ':data text))))) | |
1675 | (t | |
1676 | (insert text))))) | |
d543e20b PA |
1677 | |
1678 | (defun widget-gui-action (widget) | |
1679 | "Apply :action for WIDGET." | |
1680 | (widget-apply-action widget (this-command-keys))) | |
1681 | ||
1682 | ;;; The `link' Widget. | |
1683 | ||
25ac13b5 PA |
1684 | (defcustom widget-link-prefix "[" |
1685 | "String used as prefix for links." | |
1686 | :type 'string | |
1687 | :group 'widget-button) | |
1688 | ||
1689 | (defcustom widget-link-suffix "]" | |
1690 | "String used as suffix for links." | |
1691 | :type 'string | |
1692 | :group 'widget-button) | |
1693 | ||
d543e20b PA |
1694 | (define-widget 'link 'item |
1695 | "An embedded link." | |
25ac13b5 PA |
1696 | :button-prefix 'widget-link-prefix |
1697 | :button-suffix 'widget-link-suffix | |
d543e20b | 1698 | :help-echo "Follow the link." |
25ac13b5 | 1699 | :format "%[%t%]") |
d543e20b PA |
1700 | |
1701 | ;;; The `info-link' Widget. | |
1702 | ||
1703 | (define-widget 'info-link 'link | |
1704 | "A link to an info file." | |
1705 | :action 'widget-info-link-action) | |
1706 | ||
1707 | (defun widget-info-link-action (widget &optional event) | |
1708 | "Open the info node specified by WIDGET." | |
a3c88c59 | 1709 | (Info-goto-node (widget-value widget))) |
d543e20b PA |
1710 | |
1711 | ;;; The `url-link' Widget. | |
1712 | ||
1713 | (define-widget 'url-link 'link | |
1714 | "A link to an www page." | |
1715 | :action 'widget-url-link-action) | |
1716 | ||
1717 | (defun widget-url-link-action (widget &optional event) | |
1718 | "Open the url specified by WIDGET." | |
af0f19d7 | 1719 | (browse-url (widget-value widget))) |
d543e20b | 1720 | |
a59b7025 KH |
1721 | ;;; The `function-link' Widget. |
1722 | ||
1723 | (define-widget 'function-link 'link | |
1724 | "A link to an Emacs function." | |
1725 | :action 'widget-function-link-action) | |
1726 | ||
1727 | (defun widget-function-link-action (widget &optional event) | |
1728 | "Show the function specified by WIDGET." | |
1729 | (describe-function (widget-value widget))) | |
1730 | ||
1731 | ;;; The `variable-link' Widget. | |
1732 | ||
1733 | (define-widget 'variable-link 'link | |
1734 | "A link to an Emacs variable." | |
1735 | :action 'widget-variable-link-action) | |
1736 | ||
1737 | (defun widget-variable-link-action (widget &optional event) | |
1738 | "Show the variable specified by WIDGET." | |
1739 | (describe-variable (widget-value widget))) | |
1740 | ||
62f44662 PA |
1741 | ;;; The `file-link' Widget. |
1742 | ||
1743 | (define-widget 'file-link 'link | |
1744 | "A link to a file." | |
1745 | :action 'widget-file-link-action) | |
1746 | ||
1747 | (defun widget-file-link-action (widget &optional event) | |
1748 | "Find the file specified by WIDGET." | |
1749 | (find-file (widget-value widget))) | |
1750 | ||
1751 | ;;; The `emacs-library-link' Widget. | |
1752 | ||
1753 | (define-widget 'emacs-library-link 'link | |
1754 | "A link to an Emacs Lisp library file." | |
1755 | :action 'widget-emacs-library-link-action) | |
1756 | ||
1757 | (defun widget-emacs-library-link-action (widget &optional event) | |
1758 | "Find the Emacs Library file specified by WIDGET." | |
1759 | (find-file (locate-library (widget-value widget)))) | |
1760 | ||
4ee1cf9f PA |
1761 | ;;; The `emacs-commentary-link' Widget. |
1762 | ||
1763 | (define-widget 'emacs-commentary-link 'link | |
1764 | "A link to Commentary in an Emacs Lisp library file." | |
1765 | :action 'widget-emacs-commentary-link-action) | |
1766 | ||
1767 | (defun widget-emacs-commentary-link-action (widget &optional event) | |
1768 | "Find the Commentary section of the Emacs file specified by WIDGET." | |
1769 | (finder-commentary (widget-value widget))) | |
1770 | ||
d543e20b PA |
1771 | ;;; The `editable-field' Widget. |
1772 | ||
1773 | (define-widget 'editable-field 'default | |
1774 | "An editable text field." | |
a3c88c59 | 1775 | :convert-widget 'widget-value-convert-widget |
d543e20b PA |
1776 | :keymap widget-field-keymap |
1777 | :format "%v" | |
1778 | :value "" | |
a3c88c59 PA |
1779 | :prompt-internal 'widget-field-prompt-internal |
1780 | :prompt-history 'widget-field-history | |
1781 | :prompt-value 'widget-field-prompt-value | |
d543e20b PA |
1782 | :action 'widget-field-action |
1783 | :validate 'widget-field-validate | |
1784 | :valid-regexp "" | |
1785 | :error "No match" | |
1786 | :value-create 'widget-field-value-create | |
1787 | :value-delete 'widget-field-value-delete | |
1788 | :value-get 'widget-field-value-get | |
1789 | :match 'widget-field-match) | |
1790 | ||
a3c88c59 PA |
1791 | (defvar widget-field-history nil |
1792 | "History of field minibuffer edits.") | |
1793 | ||
1794 | (defun widget-field-prompt-internal (widget prompt initial history) | |
1795 | ;; Read string for WIDGET promptinhg with PROMPT. | |
1796 | ;; INITIAL is the initial input and HISTORY is a symbol containing | |
1797 | ;; the earlier input. | |
1798 | (read-string prompt initial history)) | |
1799 | ||
1800 | (defun widget-field-prompt-value (widget prompt value unbound) | |
1801 | ;; Prompt for a string. | |
1802 | (let ((initial (if unbound | |
1803 | nil | |
1804 | (cons (widget-apply widget :value-to-internal | |
1805 | value) 0))) | |
1806 | (history (widget-get widget :prompt-history))) | |
1807 | (let ((answer (widget-apply widget | |
1808 | :prompt-internal prompt initial history))) | |
1809 | (widget-apply widget :value-to-external answer)))) | |
d543e20b | 1810 | |
0b296dac | 1811 | (defvar widget-edit-functions nil) |
211c9fe9 | 1812 | |
d543e20b | 1813 | (defun widget-field-action (widget &optional event) |
f1231b8e RS |
1814 | ;; Move to next field. |
1815 | (widget-forward 1) | |
0b296dac | 1816 | (run-hook-with-args 'widget-edit-functions widget)) |
d543e20b PA |
1817 | |
1818 | (defun widget-field-validate (widget) | |
1819 | ;; Valid if the content matches `:valid-regexp'. | |
1820 | (save-excursion | |
1821 | (let ((value (widget-apply widget :value-get)) | |
1822 | (regexp (widget-get widget :valid-regexp))) | |
1823 | (if (string-match regexp value) | |
1824 | nil | |
1825 | widget)))) | |
1826 | ||
1827 | (defun widget-field-value-create (widget) | |
1828 | ;; Create an editable text field. | |
d543e20b PA |
1829 | (let ((size (widget-get widget :size)) |
1830 | (value (widget-get widget :value)) | |
0a3a0b56 | 1831 | (from (point)) |
c953515e PA |
1832 | ;; This is changed to a real overlay in `widget-setup'. We |
1833 | ;; need the end points to behave differently until | |
1834 | ;; `widget-setup' is called. | |
0a3a0b56 PA |
1835 | (overlay (cons (make-marker) (make-marker)))) |
1836 | (widget-put widget :field-overlay overlay) | |
d543e20b PA |
1837 | (insert value) |
1838 | (and size | |
1839 | (< (length value) size) | |
1840 | (insert-char ?\ (- size (length value)))) | |
1841 | (unless (memq widget widget-field-list) | |
1842 | (setq widget-field-new (cons widget widget-field-new))) | |
0a3a0b56 PA |
1843 | (move-marker (cdr overlay) (point)) |
1844 | (set-marker-insertion-type (cdr overlay) nil) | |
1845 | (when (null size) | |
1846 | (insert ?\n)) | |
1847 | (move-marker (car overlay) from) | |
1848 | (set-marker-insertion-type (car overlay) t))) | |
d543e20b PA |
1849 | |
1850 | (defun widget-field-value-delete (widget) | |
1851 | ;; Remove the widget from the list of active editing fields. | |
1852 | (setq widget-field-list (delq widget widget-field-list)) | |
1853 | ;; These are nil if the :format string doesn't contain `%v'. | |
0a3a0b56 PA |
1854 | (let ((overlay (widget-get widget :field-overlay))) |
1855 | (when overlay | |
1856 | (delete-overlay overlay)))) | |
d543e20b PA |
1857 | |
1858 | (defun widget-field-value-get (widget) | |
1859 | ;; Return current text in editing field. | |
0a3a0b56 PA |
1860 | (let ((from (widget-field-start widget)) |
1861 | (to (widget-field-end widget)) | |
1862 | (buffer (widget-field-buffer widget)) | |
d543e20b PA |
1863 | (size (widget-get widget :size)) |
1864 | (secret (widget-get widget :secret)) | |
1865 | (old (current-buffer))) | |
1866 | (if (and from to) | |
1867 | (progn | |
0a3a0b56 | 1868 | (set-buffer buffer) |
d543e20b PA |
1869 | (while (and size |
1870 | (not (zerop size)) | |
1871 | (> to from) | |
1872 | (eq (char-after (1- to)) ?\ )) | |
1873 | (setq to (1- to))) | |
1874 | (let ((result (buffer-substring-no-properties from to))) | |
1875 | (when secret | |
1876 | (let ((index 0)) | |
1877 | (while (< (+ from index) to) | |
1878 | (aset result index | |
0a3a0b56 | 1879 | (get-char-property (+ from index) 'secret)) |
d543e20b PA |
1880 | (setq index (1+ index))))) |
1881 | (set-buffer old) | |
1882 | result)) | |
1883 | (widget-get widget :value)))) | |
1884 | ||
1885 | (defun widget-field-match (widget value) | |
1886 | ;; Match any string. | |
1887 | (stringp value)) | |
1888 | ||
1889 | ;;; The `text' Widget. | |
1890 | ||
1891 | (define-widget 'text 'editable-field | |
1892 | :keymap widget-text-keymap | |
1893 | "A multiline text area.") | |
1894 | ||
1895 | ;;; The `menu-choice' Widget. | |
1896 | ||
1897 | (define-widget 'menu-choice 'default | |
1898 | "A menu of options." | |
1899 | :convert-widget 'widget-types-convert-widget | |
1900 | :format "%[%t%]: %v" | |
1901 | :case-fold t | |
1902 | :tag "choice" | |
1903 | :void '(item :format "invalid (%t)\n") | |
1904 | :value-create 'widget-choice-value-create | |
1905 | :value-delete 'widget-children-value-delete | |
1906 | :value-get 'widget-choice-value-get | |
1907 | :value-inline 'widget-choice-value-inline | |
783824f5 | 1908 | :default-get 'widget-choice-default-get |
a3c88c59 | 1909 | :mouse-down-action 'widget-choice-mouse-down-action |
d543e20b PA |
1910 | :action 'widget-choice-action |
1911 | :error "Make a choice" | |
1912 | :validate 'widget-choice-validate | |
1913 | :match 'widget-choice-match | |
1914 | :match-inline 'widget-choice-match-inline) | |
1915 | ||
1916 | (defun widget-choice-value-create (widget) | |
1917 | ;; Insert the first choice that matches the value. | |
1918 | (let ((value (widget-get widget :value)) | |
1919 | (args (widget-get widget :args)) | |
4084d128 RS |
1920 | (explicit (widget-get widget :explicit-choice)) |
1921 | (explicit-value (widget-get widget :explicit-choice-value)) | |
d543e20b | 1922 | current) |
1468535e | 1923 | (if (and explicit (equal value explicit-value)) |
4084d128 RS |
1924 | (progn |
1925 | ;; If the user specified the choice for this value, | |
1926 | ;; respect that choice as long as the value is the same. | |
1927 | (widget-put widget :children (list (widget-create-child-value | |
1928 | widget explicit value))) | |
1929 | (widget-put widget :choice explicit)) | |
1930 | (while args | |
1931 | (setq current (car args) | |
1932 | args (cdr args)) | |
1933 | (when (widget-apply current :match value) | |
1934 | (widget-put widget :children (list (widget-create-child-value | |
1935 | widget current value))) | |
1936 | (widget-put widget :choice current) | |
1937 | (setq args nil | |
1938 | current nil))) | |
1939 | (when current | |
1940 | (let ((void (widget-get widget :void))) | |
1941 | (widget-put widget :children (list (widget-create-child-and-convert | |
1942 | widget void :value value))) | |
1943 | (widget-put widget :choice void)))))) | |
d543e20b PA |
1944 | |
1945 | (defun widget-choice-value-get (widget) | |
1946 | ;; Get value of the child widget. | |
1947 | (widget-value (car (widget-get widget :children)))) | |
1948 | ||
1949 | (defun widget-choice-value-inline (widget) | |
1950 | ;; Get value of the child widget. | |
1951 | (widget-apply (car (widget-get widget :children)) :value-inline)) | |
1952 | ||
783824f5 RS |
1953 | (defun widget-choice-default-get (widget) |
1954 | ;; Get default for the first choice. | |
1955 | (widget-default-get (car (widget-get widget :args)))) | |
1956 | ||
a3c88c59 PA |
1957 | (defcustom widget-choice-toggle nil |
1958 | "If non-nil, a binary choice will just toggle between the values. | |
1959 | Otherwise, the user will explicitly have to choose between the values | |
25ac13b5 | 1960 | when he invoked the menu." |
a3c88c59 PA |
1961 | :type 'boolean |
1962 | :group 'widgets) | |
1963 | ||
1964 | (defun widget-choice-mouse-down-action (widget &optional event) | |
1965 | ;; Return non-nil if we need a menu. | |
1966 | (let ((args (widget-get widget :args)) | |
1967 | (old (widget-get widget :choice))) | |
1968 | (cond ((not window-system) | |
1969 | ;; No place to pop up a menu. | |
1970 | nil) | |
1971 | ((not (or (fboundp 'x-popup-menu) (fboundp 'popup-menu))) | |
1972 | ;; No way to pop up a menu. | |
1973 | nil) | |
1974 | ((< (length args) 2) | |
1975 | ;; Empty or singleton list, just return the value. | |
1976 | nil) | |
1977 | ((> (length args) widget-menu-max-size) | |
1978 | ;; Too long, prompt. | |
1979 | nil) | |
1980 | ((> (length args) 2) | |
1981 | ;; Reasonable sized list, use menu. | |
1982 | t) | |
1983 | ((and widget-choice-toggle (memq old args)) | |
1984 | ;; We toggle. | |
1985 | nil) | |
1986 | (t | |
1987 | ;; Ask which of the two. | |
1988 | t)))) | |
1989 | ||
d543e20b PA |
1990 | (defun widget-choice-action (widget &optional event) |
1991 | ;; Make a choice. | |
1992 | (let ((args (widget-get widget :args)) | |
1993 | (old (widget-get widget :choice)) | |
1994 | (tag (widget-apply widget :menu-tag-get)) | |
1995 | (completion-ignore-case (widget-get widget :case-fold)) | |
4084d128 | 1996 | this-explicit |
d543e20b PA |
1997 | current choices) |
1998 | ;; Remember old value. | |
1999 | (if (and old (not (widget-apply widget :validate))) | |
2000 | (let* ((external (widget-value widget)) | |
2001 | (internal (widget-apply old :value-to-internal external))) | |
2002 | (widget-put old :value internal))) | |
2003 | ;; Find new choice. | |
2004 | (setq current | |
2005 | (cond ((= (length args) 0) | |
2006 | nil) | |
2007 | ((= (length args) 1) | |
2008 | (nth 0 args)) | |
a3c88c59 PA |
2009 | ((and widget-choice-toggle |
2010 | (= (length args) 2) | |
d543e20b PA |
2011 | (memq old args)) |
2012 | (if (eq old (nth 0 args)) | |
2013 | (nth 1 args) | |
2014 | (nth 0 args))) | |
2015 | (t | |
2016 | (while args | |
2017 | (setq current (car args) | |
2018 | args (cdr args)) | |
2019 | (setq choices | |
2020 | (cons (cons (widget-apply current :menu-tag-get) | |
2021 | current) | |
2022 | choices))) | |
4084d128 | 2023 | (setq this-explicit t) |
d543e20b | 2024 | (widget-choose tag (reverse choices) event)))) |
d0acc4ea | 2025 | (when current |
4084d128 RS |
2026 | ;; If this was an explicit user choice, |
2027 | ;; record the choice, and the record the value it was made for. | |
2028 | ;; widget-choice-value-create will respect this choice, | |
2029 | ;; as long as the value is the same. | |
2030 | (when this-explicit | |
2031 | (widget-put widget :explicit-choice current) | |
2032 | (widget-put widget :explicit-choice-value (widget-get widget :value))) | |
783824f5 RS |
2033 | (let ((value (widget-default-get current))) |
2034 | (widget-value-set widget | |
2035 | (widget-apply current :value-to-external value))) | |
d0acc4ea RS |
2036 | (widget-setup) |
2037 | (widget-apply widget :notify widget event))) | |
d4b8422f | 2038 | (run-hook-with-args 'widget-edit-functions widget)) |
d543e20b PA |
2039 | |
2040 | (defun widget-choice-validate (widget) | |
2041 | ;; Valid if we have made a valid choice. | |
2042 | (let ((void (widget-get widget :void)) | |
2043 | (choice (widget-get widget :choice)) | |
2044 | (child (car (widget-get widget :children)))) | |
2045 | (if (eq void choice) | |
2046 | widget | |
2047 | (widget-apply child :validate)))) | |
2048 | ||
2049 | (defun widget-choice-match (widget value) | |
2050 | ;; Matches if one of the choices matches. | |
2051 | (let ((args (widget-get widget :args)) | |
2052 | current found) | |
2053 | (while (and args (not found)) | |
2054 | (setq current (car args) | |
2055 | args (cdr args) | |
2056 | found (widget-apply current :match value))) | |
2057 | found)) | |
2058 | ||
2059 | (defun widget-choice-match-inline (widget values) | |
2060 | ;; Matches if one of the choices matches. | |
2061 | (let ((args (widget-get widget :args)) | |
2062 | current found) | |
2063 | (while (and args (null found)) | |
2064 | (setq current (car args) | |
2065 | args (cdr args) | |
2066 | found (widget-match-inline current values))) | |
2067 | found)) | |
2068 | ||
2069 | ;;; The `toggle' Widget. | |
2070 | ||
2071 | (define-widget 'toggle 'item | |
2072 | "Toggle between two states." | |
2073 | :format "%[%v%]\n" | |
2074 | :value-create 'widget-toggle-value-create | |
2075 | :action 'widget-toggle-action | |
2076 | :match (lambda (widget value) t) | |
2077 | :on "on" | |
2078 | :off "off") | |
2079 | ||
2080 | (defun widget-toggle-value-create (widget) | |
2081 | ;; Insert text representing the `on' and `off' states. | |
2082 | (if (widget-value widget) | |
2083 | (widget-glyph-insert widget | |
2084 | (widget-get widget :on) | |
2085 | (widget-get widget :on-glyph)) | |
2086 | (widget-glyph-insert widget | |
2087 | (widget-get widget :off) | |
2088 | (widget-get widget :off-glyph)))) | |
2089 | ||
2090 | (defun widget-toggle-action (widget &optional event) | |
2091 | ;; Toggle value. | |
d0acc4ea RS |
2092 | (widget-value-set widget (not (widget-value widget))) |
2093 | (widget-apply widget :notify widget event) | |
d4b8422f | 2094 | (run-hook-with-args 'widget-edit-functions widget)) |
6d528fc5 | 2095 | |
d543e20b PA |
2096 | ;;; The `checkbox' Widget. |
2097 | ||
2098 | (define-widget 'checkbox 'toggle | |
2099 | "A checkbox toggle." | |
25ac13b5 PA |
2100 | :button-suffix "" |
2101 | :button-prefix "" | |
d543e20b PA |
2102 | :format "%[%v%]" |
2103 | :on "[X]" | |
2104 | :on-glyph "check1" | |
2105 | :off "[ ]" | |
2106 | :off-glyph "check0" | |
99f01612 | 2107 | :help-echo "Toggle this item." |
d543e20b PA |
2108 | :action 'widget-checkbox-action) |
2109 | ||
2110 | (defun widget-checkbox-action (widget &optional event) | |
2111 | "Toggle checkbox, notify parent, and set active state of sibling." | |
2112 | (widget-toggle-action widget event) | |
2113 | (let ((sibling (widget-get-sibling widget))) | |
2114 | (when sibling | |
2115 | (if (widget-value widget) | |
2116 | (widget-apply sibling :activate) | |
2117 | (widget-apply sibling :deactivate))))) | |
2118 | ||
2119 | ;;; The `checklist' Widget. | |
2120 | ||
2121 | (define-widget 'checklist 'default | |
2122 | "A multiple choice widget." | |
2123 | :convert-widget 'widget-types-convert-widget | |
2124 | :format "%v" | |
2125 | :offset 4 | |
2126 | :entry-format "%b %v" | |
2127 | :menu-tag "checklist" | |
2128 | :greedy nil | |
2129 | :value-create 'widget-checklist-value-create | |
2130 | :value-delete 'widget-children-value-delete | |
2131 | :value-get 'widget-checklist-value-get | |
2132 | :validate 'widget-checklist-validate | |
2133 | :match 'widget-checklist-match | |
2134 | :match-inline 'widget-checklist-match-inline) | |
2135 | ||
2136 | (defun widget-checklist-value-create (widget) | |
2137 | ;; Insert all values | |
2138 | (let ((alist (widget-checklist-match-find widget (widget-get widget :value))) | |
2139 | (args (widget-get widget :args))) | |
2140 | (while args | |
2141 | (widget-checklist-add-item widget (car args) (assq (car args) alist)) | |
2142 | (setq args (cdr args))) | |
2143 | (widget-put widget :children (nreverse (widget-get widget :children))))) | |
2144 | ||
2145 | (defun widget-checklist-add-item (widget type chosen) | |
2146 | ;; Create checklist item in WIDGET of type TYPE. | |
2147 | ;; If the item is checked, CHOSEN is a cons whose cdr is the value. | |
2148 | (and (eq (preceding-char) ?\n) | |
2149 | (widget-get widget :indent) | |
2150 | (insert-char ? (widget-get widget :indent))) | |
2151 | (widget-specify-insert | |
2152 | (let* ((children (widget-get widget :children)) | |
2153 | (buttons (widget-get widget :buttons)) | |
2154 | (button-args (or (widget-get type :sibling-args) | |
2155 | (widget-get widget :button-args))) | |
2156 | (from (point)) | |
2157 | child button) | |
2158 | (insert (widget-get widget :entry-format)) | |
2159 | (goto-char from) | |
2160 | ;; Parse % escapes in format. | |
2161 | (while (re-search-forward "%\\([bv%]\\)" nil t) | |
2162 | (let ((escape (aref (match-string 1) 0))) | |
2163 | (replace-match "" t t) | |
2164 | (cond ((eq escape ?%) | |
2165 | (insert "%")) | |
2166 | ((eq escape ?b) | |
2167 | (setq button (apply 'widget-create-child-and-convert | |
2168 | widget 'checkbox | |
2169 | :value (not (null chosen)) | |
2170 | button-args))) | |
2171 | ((eq escape ?v) | |
2172 | (setq child | |
2173 | (cond ((not chosen) | |
2174 | (let ((child (widget-create-child widget type))) | |
2175 | (widget-apply child :deactivate) | |
2176 | child)) | |
2177 | ((widget-get type :inline) | |
2178 | (widget-create-child-value | |
2179 | widget type (cdr chosen))) | |
2180 | (t | |
2181 | (widget-create-child-value | |
2182 | widget type (car (cdr chosen))))))) | |
2183 | (t | |
2184 | (error "Unknown escape `%c'" escape))))) | |
2185 | ;; Update properties. | |
2186 | (and button child (widget-put child :button button)) | |
2187 | (and button (widget-put widget :buttons (cons button buttons))) | |
2188 | (and child (widget-put widget :children (cons child children)))))) | |
2189 | ||
2190 | (defun widget-checklist-match (widget values) | |
2191 | ;; All values must match a type in the checklist. | |
2192 | (and (listp values) | |
2193 | (null (cdr (widget-checklist-match-inline widget values))))) | |
2194 | ||
2195 | (defun widget-checklist-match-inline (widget values) | |
2196 | ;; Find the values which match a type in the checklist. | |
2197 | (let ((greedy (widget-get widget :greedy)) | |
ef3f635f | 2198 | (args (copy-sequence (widget-get widget :args))) |
d543e20b PA |
2199 | found rest) |
2200 | (while values | |
2201 | (let ((answer (widget-checklist-match-up args values))) | |
2202 | (cond (answer | |
2203 | (let ((vals (widget-match-inline answer values))) | |
2204 | (setq found (append found (car vals)) | |
2205 | values (cdr vals) | |
2206 | args (delq answer args)))) | |
2207 | (greedy | |
2208 | (setq rest (append rest (list (car values))) | |
2209 | values (cdr values))) | |
2210 | (t | |
2211 | (setq rest (append rest values) | |
2212 | values nil))))) | |
2213 | (cons found rest))) | |
2214 | ||
2215 | (defun widget-checklist-match-find (widget vals) | |
2216 | ;; Find the vals which match a type in the checklist. | |
2217 | ;; Return an alist of (TYPE MATCH). | |
2218 | (let ((greedy (widget-get widget :greedy)) | |
ef3f635f | 2219 | (args (copy-sequence (widget-get widget :args))) |
d543e20b PA |
2220 | found) |
2221 | (while vals | |
2222 | (let ((answer (widget-checklist-match-up args vals))) | |
2223 | (cond (answer | |
2224 | (let ((match (widget-match-inline answer vals))) | |
2225 | (setq found (cons (cons answer (car match)) found) | |
2226 | vals (cdr match) | |
2227 | args (delq answer args)))) | |
2228 | (greedy | |
2229 | (setq vals (cdr vals))) | |
2230 | (t | |
2231 | (setq vals nil))))) | |
2232 | found)) | |
2233 | ||
2234 | (defun widget-checklist-match-up (args vals) | |
2235 | ;; Rerturn the first type from ARGS that matches VALS. | |
2236 | (let (current found) | |
2237 | (while (and args (null found)) | |
2238 | (setq current (car args) | |
2239 | args (cdr args) | |
2240 | found (widget-match-inline current vals))) | |
2241 | (if found | |
2242 | current | |
2243 | nil))) | |
2244 | ||
2245 | (defun widget-checklist-value-get (widget) | |
2246 | ;; The values of all selected items. | |
2247 | (let ((children (widget-get widget :children)) | |
2248 | child result) | |
2249 | (while children | |
2250 | (setq child (car children) | |
2251 | children (cdr children)) | |
2252 | (if (widget-value (widget-get child :button)) | |
2253 | (setq result (append result (widget-apply child :value-inline))))) | |
2254 | result)) | |
2255 | ||
2256 | (defun widget-checklist-validate (widget) | |
2257 | ;; Ticked chilren must be valid. | |
2258 | (let ((children (widget-get widget :children)) | |
2259 | child button found) | |
2260 | (while (and children (not found)) | |
2261 | (setq child (car children) | |
2262 | children (cdr children) | |
2263 | button (widget-get child :button) | |
2264 | found (and (widget-value button) | |
2265 | (widget-apply child :validate)))) | |
2266 | found)) | |
2267 | ||
2268 | ;;; The `option' Widget | |
2269 | ||
2270 | (define-widget 'option 'checklist | |
2271 | "An widget with an optional item." | |
2272 | :inline t) | |
2273 | ||
2274 | ;;; The `choice-item' Widget. | |
2275 | ||
2276 | (define-widget 'choice-item 'item | |
2277 | "Button items that delegate action events to their parents." | |
a3c88c59 | 2278 | :action 'widget-parent-action |
d543e20b PA |
2279 | :format "%[%t%] \n") |
2280 | ||
d543e20b PA |
2281 | ;;; The `radio-button' Widget. |
2282 | ||
2283 | (define-widget 'radio-button 'toggle | |
2284 | "A radio button for use in the `radio' widget." | |
2285 | :notify 'widget-radio-button-notify | |
2286 | :format "%[%v%]" | |
25ac13b5 PA |
2287 | :button-suffix "" |
2288 | :button-prefix "" | |
d543e20b PA |
2289 | :on "(*)" |
2290 | :on-glyph "radio1" | |
2291 | :off "( )" | |
2292 | :off-glyph "radio0") | |
2293 | ||
2294 | (defun widget-radio-button-notify (widget child &optional event) | |
2295 | ;; Tell daddy. | |
2296 | (widget-apply (widget-get widget :parent) :action widget event)) | |
2297 | ||
2298 | ;;; The `radio-button-choice' Widget. | |
2299 | ||
2300 | (define-widget 'radio-button-choice 'default | |
2301 | "Select one of multiple options." | |
2302 | :convert-widget 'widget-types-convert-widget | |
2303 | :offset 4 | |
2304 | :format "%v" | |
2305 | :entry-format "%b %v" | |
2306 | :menu-tag "radio" | |
2307 | :value-create 'widget-radio-value-create | |
2308 | :value-delete 'widget-children-value-delete | |
2309 | :value-get 'widget-radio-value-get | |
2310 | :value-inline 'widget-radio-value-inline | |
2311 | :value-set 'widget-radio-value-set | |
2312 | :error "You must push one of the buttons" | |
2313 | :validate 'widget-radio-validate | |
2314 | :match 'widget-choice-match | |
2315 | :match-inline 'widget-choice-match-inline | |
2316 | :action 'widget-radio-action) | |
2317 | ||
2318 | (defun widget-radio-value-create (widget) | |
2319 | ;; Insert all values | |
2320 | (let ((args (widget-get widget :args)) | |
2321 | arg) | |
2322 | (while args | |
2323 | (setq arg (car args) | |
2324 | args (cdr args)) | |
2325 | (widget-radio-add-item widget arg)))) | |
2326 | ||
2327 | (defun widget-radio-add-item (widget type) | |
2328 | "Add to radio widget WIDGET a new radio button item of type TYPE." | |
2329 | ;; (setq type (widget-convert type)) | |
2330 | (and (eq (preceding-char) ?\n) | |
2331 | (widget-get widget :indent) | |
2332 | (insert-char ? (widget-get widget :indent))) | |
2333 | (widget-specify-insert | |
2334 | (let* ((value (widget-get widget :value)) | |
2335 | (children (widget-get widget :children)) | |
2336 | (buttons (widget-get widget :buttons)) | |
2337 | (button-args (or (widget-get type :sibling-args) | |
2338 | (widget-get widget :button-args))) | |
2339 | (from (point)) | |
2340 | (chosen (and (null (widget-get widget :choice)) | |
2341 | (widget-apply type :match value))) | |
2342 | child button) | |
2343 | (insert (widget-get widget :entry-format)) | |
2344 | (goto-char from) | |
2345 | ;; Parse % escapes in format. | |
2346 | (while (re-search-forward "%\\([bv%]\\)" nil t) | |
2347 | (let ((escape (aref (match-string 1) 0))) | |
2348 | (replace-match "" t t) | |
2349 | (cond ((eq escape ?%) | |
2350 | (insert "%")) | |
2351 | ((eq escape ?b) | |
2352 | (setq button (apply 'widget-create-child-and-convert | |
2353 | widget 'radio-button | |
2354 | :value (not (null chosen)) | |
2355 | button-args))) | |
2356 | ((eq escape ?v) | |
2357 | (setq child (if chosen | |
2358 | (widget-create-child-value | |
2359 | widget type value) | |
2360 | (widget-create-child widget type))) | |
2361 | (unless chosen | |
2362 | (widget-apply child :deactivate))) | |
2363 | (t | |
2364 | (error "Unknown escape `%c'" escape))))) | |
2365 | ;; Update properties. | |
2366 | (when chosen | |
2367 | (widget-put widget :choice type)) | |
2368 | (when button | |
2369 | (widget-put child :button button) | |
2370 | (widget-put widget :buttons (nconc buttons (list button)))) | |
2371 | (when child | |
2372 | (widget-put widget :children (nconc children (list child)))) | |
2373 | child))) | |
2374 | ||
2375 | (defun widget-radio-value-get (widget) | |
2376 | ;; Get value of the child widget. | |
2377 | (let ((chosen (widget-radio-chosen widget))) | |
2378 | (and chosen (widget-value chosen)))) | |
2379 | ||
2380 | (defun widget-radio-chosen (widget) | |
2381 | "Return the widget representing the chosen radio button." | |
2382 | (let ((children (widget-get widget :children)) | |
2383 | current found) | |
2384 | (while children | |
2385 | (setq current (car children) | |
2386 | children (cdr children)) | |
2387 | (let* ((button (widget-get current :button)) | |
2388 | (value (widget-apply button :value-get))) | |
2389 | (when value | |
2390 | (setq found current | |
2391 | children nil)))) | |
2392 | found)) | |
2393 | ||
2394 | (defun widget-radio-value-inline (widget) | |
2395 | ;; Get value of the child widget. | |
2396 | (let ((children (widget-get widget :children)) | |
2397 | current found) | |
2398 | (while children | |
2399 | (setq current (car children) | |
2400 | children (cdr children)) | |
2401 | (let* ((button (widget-get current :button)) | |
2402 | (value (widget-apply button :value-get))) | |
2403 | (when value | |
2404 | (setq found (widget-apply current :value-inline) | |
2405 | children nil)))) | |
2406 | found)) | |
2407 | ||
2408 | (defun widget-radio-value-set (widget value) | |
2409 | ;; We can't just delete and recreate a radio widget, since children | |
2410 | ;; can be added after the original creation and won't be recreated | |
2411 | ;; by `:create'. | |
2412 | (let ((children (widget-get widget :children)) | |
2413 | current found) | |
2414 | (while children | |
2415 | (setq current (car children) | |
2416 | children (cdr children)) | |
2417 | (let* ((button (widget-get current :button)) | |
2418 | (match (and (not found) | |
2419 | (widget-apply current :match value)))) | |
2420 | (widget-value-set button match) | |
2421 | (if match | |
2422 | (progn | |
2423 | (widget-value-set current value) | |
2424 | (widget-apply current :activate)) | |
2425 | (widget-apply current :deactivate)) | |
2426 | (setq found (or found match)))))) | |
2427 | ||
2428 | (defun widget-radio-validate (widget) | |
2429 | ;; Valid if we have made a valid choice. | |
2430 | (let ((children (widget-get widget :children)) | |
2431 | current found button) | |
2432 | (while (and children (not found)) | |
2433 | (setq current (car children) | |
2434 | children (cdr children) | |
2435 | button (widget-get current :button) | |
2436 | found (widget-apply button :value-get))) | |
2437 | (if found | |
2438 | (widget-apply current :validate) | |
2439 | widget))) | |
2440 | ||
2441 | (defun widget-radio-action (widget child event) | |
2442 | ;; Check if a radio button was pressed. | |
2443 | (let ((children (widget-get widget :children)) | |
2444 | (buttons (widget-get widget :buttons)) | |
2445 | current) | |
2446 | (when (memq child buttons) | |
2447 | (while children | |
2448 | (setq current (car children) | |
2449 | children (cdr children)) | |
2450 | (let* ((button (widget-get current :button))) | |
2451 | (cond ((eq child button) | |
2452 | (widget-value-set button t) | |
2453 | (widget-apply current :activate)) | |
2454 | ((widget-value button) | |
2455 | (widget-value-set button nil) | |
2456 | (widget-apply current :deactivate))))))) | |
2457 | ;; Pass notification to parent. | |
2458 | (widget-apply widget :notify child event)) | |
2459 | ||
2460 | ;;; The `insert-button' Widget. | |
2461 | ||
2462 | (define-widget 'insert-button 'push-button | |
2463 | "An insert button for the `editable-list' widget." | |
2464 | :tag "INS" | |
2465 | :help-echo "Insert a new item into the list at this position." | |
2466 | :action 'widget-insert-button-action) | |
2467 | ||
2468 | (defun widget-insert-button-action (widget &optional event) | |
2469 | ;; Ask the parent to insert a new item. | |
2470 | (widget-apply (widget-get widget :parent) | |
2471 | :insert-before (widget-get widget :widget))) | |
2472 | ||
2473 | ;;; The `delete-button' Widget. | |
2474 | ||
2475 | (define-widget 'delete-button 'push-button | |
2476 | "A delete button for the `editable-list' widget." | |
2477 | :tag "DEL" | |
2478 | :help-echo "Delete this item from the list." | |
2479 | :action 'widget-delete-button-action) | |
2480 | ||
2481 | (defun widget-delete-button-action (widget &optional event) | |
2482 | ;; Ask the parent to insert a new item. | |
2483 | (widget-apply (widget-get widget :parent) | |
2484 | :delete-at (widget-get widget :widget))) | |
2485 | ||
2486 | ;;; The `editable-list' Widget. | |
2487 | ||
2488 | (defcustom widget-editable-list-gui nil | |
2489 | "If non nil, use GUI push-buttons in editable list when available." | |
2490 | :type 'boolean | |
2491 | :group 'widgets) | |
2492 | ||
2493 | (define-widget 'editable-list 'default | |
2494 | "A variable list of widgets of the same type." | |
2495 | :convert-widget 'widget-types-convert-widget | |
2496 | :offset 12 | |
2497 | :format "%v%i\n" | |
2498 | :format-handler 'widget-editable-list-format-handler | |
2499 | :entry-format "%i %d %v" | |
2500 | :menu-tag "editable-list" | |
2501 | :value-create 'widget-editable-list-value-create | |
2502 | :value-delete 'widget-children-value-delete | |
2503 | :value-get 'widget-editable-list-value-get | |
a3c88c59 | 2504 | :validate 'widget-children-validate |
d543e20b PA |
2505 | :match 'widget-editable-list-match |
2506 | :match-inline 'widget-editable-list-match-inline | |
2507 | :insert-before 'widget-editable-list-insert-before | |
2508 | :delete-at 'widget-editable-list-delete-at) | |
2509 | ||
2510 | (defun widget-editable-list-format-handler (widget escape) | |
2511 | ;; We recognize the insert button. | |
2512 | (let ((widget-push-button-gui widget-editable-list-gui)) | |
2513 | (cond ((eq escape ?i) | |
2514 | (and (widget-get widget :indent) | |
2515 | (insert-char ? (widget-get widget :indent))) | |
2516 | (apply 'widget-create-child-and-convert | |
2517 | widget 'insert-button | |
2518 | (widget-get widget :append-button-args))) | |
2519 | (t | |
2520 | (widget-default-format-handler widget escape))))) | |
2521 | ||
2522 | (defun widget-editable-list-value-create (widget) | |
2523 | ;; Insert all values | |
2524 | (let* ((value (widget-get widget :value)) | |
2525 | (type (nth 0 (widget-get widget :args))) | |
2526 | (inlinep (widget-get type :inline)) | |
2527 | children) | |
2528 | (widget-put widget :value-pos (copy-marker (point))) | |
2529 | (set-marker-insertion-type (widget-get widget :value-pos) t) | |
2530 | (while value | |
2531 | (let ((answer (widget-match-inline type value))) | |
2532 | (if answer | |
2533 | (setq children (cons (widget-editable-list-entry-create | |
2534 | widget | |
2535 | (if inlinep | |
2536 | (car answer) | |
2537 | (car (car answer))) | |
2538 | t) | |
2539 | children) | |
2540 | value (cdr answer)) | |
2541 | (setq value nil)))) | |
2542 | (widget-put widget :children (nreverse children)))) | |
2543 | ||
2544 | (defun widget-editable-list-value-get (widget) | |
2545 | ;; Get value of the child widget. | |
2546 | (apply 'append (mapcar (lambda (child) (widget-apply child :value-inline)) | |
2547 | (widget-get widget :children)))) | |
2548 | ||
d543e20b PA |
2549 | (defun widget-editable-list-match (widget value) |
2550 | ;; Value must be a list and all the members must match the type. | |
2551 | (and (listp value) | |
2552 | (null (cdr (widget-editable-list-match-inline widget value))))) | |
2553 | ||
2554 | (defun widget-editable-list-match-inline (widget value) | |
2555 | (let ((type (nth 0 (widget-get widget :args))) | |
2556 | (ok t) | |
2557 | found) | |
2558 | (while (and value ok) | |
2559 | (let ((answer (widget-match-inline type value))) | |
2560 | (if answer | |
2561 | (setq found (append found (car answer)) | |
2562 | value (cdr answer)) | |
2563 | (setq ok nil)))) | |
2564 | (cons found value))) | |
2565 | ||
2566 | (defun widget-editable-list-insert-before (widget before) | |
2567 | ;; Insert a new child in the list of children. | |
2568 | (save-excursion | |
2569 | (let ((children (widget-get widget :children)) | |
2570 | (inhibit-read-only t) | |
c6753d66 | 2571 | before-change-functions |
d543e20b PA |
2572 | after-change-functions) |
2573 | (cond (before | |
2574 | (goto-char (widget-get before :entry-from))) | |
2575 | (t | |
2576 | (goto-char (widget-get widget :value-pos)))) | |
2577 | (let ((child (widget-editable-list-entry-create | |
2578 | widget nil nil))) | |
2579 | (when (< (widget-get child :entry-from) (widget-get widget :from)) | |
2580 | (set-marker (widget-get widget :from) | |
2581 | (widget-get child :entry-from))) | |
d543e20b PA |
2582 | (if (eq (car children) before) |
2583 | (widget-put widget :children (cons child children)) | |
2584 | (while (not (eq (car (cdr children)) before)) | |
2585 | (setq children (cdr children))) | |
2586 | (setcdr children (cons child (cdr children))))))) | |
2587 | (widget-setup) | |
0a3a0b56 | 2588 | (widget-apply widget :notify widget)) |
d543e20b PA |
2589 | |
2590 | (defun widget-editable-list-delete-at (widget child) | |
2591 | ;; Delete child from list of children. | |
2592 | (save-excursion | |
ef3f635f | 2593 | (let ((buttons (copy-sequence (widget-get widget :buttons))) |
d543e20b PA |
2594 | button |
2595 | (inhibit-read-only t) | |
c6753d66 | 2596 | before-change-functions |
d543e20b PA |
2597 | after-change-functions) |
2598 | (while buttons | |
2599 | (setq button (car buttons) | |
2600 | buttons (cdr buttons)) | |
2601 | (when (eq (widget-get button :widget) child) | |
2602 | (widget-put widget | |
2603 | :buttons (delq button (widget-get widget :buttons))) | |
2604 | (widget-delete button)))) | |
2605 | (let ((entry-from (widget-get child :entry-from)) | |
2606 | (entry-to (widget-get child :entry-to)) | |
2607 | (inhibit-read-only t) | |
c6753d66 | 2608 | before-change-functions |
d543e20b PA |
2609 | after-change-functions) |
2610 | (widget-delete child) | |
2611 | (delete-region entry-from entry-to) | |
2612 | (set-marker entry-from nil) | |
2613 | (set-marker entry-to nil)) | |
2614 | (widget-put widget :children (delq child (widget-get widget :children)))) | |
2615 | (widget-setup) | |
2616 | (widget-apply widget :notify widget)) | |
2617 | ||
2618 | (defun widget-editable-list-entry-create (widget value conv) | |
2619 | ;; Create a new entry to the list. | |
2620 | (let ((type (nth 0 (widget-get widget :args))) | |
2621 | (widget-push-button-gui widget-editable-list-gui) | |
2622 | child delete insert) | |
2623 | (widget-specify-insert | |
2624 | (save-excursion | |
2625 | (and (widget-get widget :indent) | |
2626 | (insert-char ? (widget-get widget :indent))) | |
2627 | (insert (widget-get widget :entry-format))) | |
2628 | ;; Parse % escapes in format. | |
2629 | (while (re-search-forward "%\\(.\\)" nil t) | |
2630 | (let ((escape (aref (match-string 1) 0))) | |
2631 | (replace-match "" t t) | |
2632 | (cond ((eq escape ?%) | |
2633 | (insert "%")) | |
2634 | ((eq escape ?i) | |
2635 | (setq insert (apply 'widget-create-child-and-convert | |
2636 | widget 'insert-button | |
2637 | (widget-get widget :insert-button-args)))) | |
2638 | ((eq escape ?d) | |
2639 | (setq delete (apply 'widget-create-child-and-convert | |
2640 | widget 'delete-button | |
2641 | (widget-get widget :delete-button-args)))) | |
2642 | ((eq escape ?v) | |
2643 | (if conv | |
2644 | (setq child (widget-create-child-value | |
2645 | widget type value)) | |
783824f5 | 2646 | (setq child (widget-create-child-value |
416cd771 RS |
2647 | widget type |
2648 | (widget-apply type :value-to-external | |
2649 | (widget-default-get type)))))) | |
d543e20b PA |
2650 | (t |
2651 | (error "Unknown escape `%c'" escape))))) | |
2652 | (widget-put widget | |
2653 | :buttons (cons delete | |
2654 | (cons insert | |
2655 | (widget-get widget :buttons)))) | |
2656 | (let ((entry-from (copy-marker (point-min))) | |
2657 | (entry-to (copy-marker (point-max)))) | |
d543e20b PA |
2658 | (set-marker-insertion-type entry-from t) |
2659 | (set-marker-insertion-type entry-to nil) | |
2660 | (widget-put child :entry-from entry-from) | |
2661 | (widget-put child :entry-to entry-to))) | |
2662 | (widget-put insert :widget child) | |
2663 | (widget-put delete :widget child) | |
2664 | child)) | |
2665 | ||
2666 | ;;; The `group' Widget. | |
2667 | ||
2668 | (define-widget 'group 'default | |
a89a9d34 | 2669 | "A widget which groups other widgets inside." |
d543e20b PA |
2670 | :convert-widget 'widget-types-convert-widget |
2671 | :format "%v" | |
2672 | :value-create 'widget-group-value-create | |
2673 | :value-delete 'widget-children-value-delete | |
2674 | :value-get 'widget-editable-list-value-get | |
783824f5 | 2675 | :default-get 'widget-group-default-get |
a3c88c59 | 2676 | :validate 'widget-children-validate |
d543e20b PA |
2677 | :match 'widget-group-match |
2678 | :match-inline 'widget-group-match-inline) | |
2679 | ||
2680 | (defun widget-group-value-create (widget) | |
2681 | ;; Create each component. | |
2682 | (let ((args (widget-get widget :args)) | |
2683 | (value (widget-get widget :value)) | |
2684 | arg answer children) | |
2685 | (while args | |
2686 | (setq arg (car args) | |
2687 | args (cdr args) | |
2688 | answer (widget-match-inline arg value) | |
2689 | value (cdr answer)) | |
2690 | (and (eq (preceding-char) ?\n) | |
2691 | (widget-get widget :indent) | |
2692 | (insert-char ? (widget-get widget :indent))) | |
3acab5ef PA |
2693 | (push (cond ((null answer) |
2694 | (widget-create-child widget arg)) | |
2695 | ((widget-get arg :inline) | |
2696 | (widget-create-child-value widget arg (car answer))) | |
2697 | (t | |
2698 | (widget-create-child-value widget arg (car (car answer))))) | |
2699 | children)) | |
d543e20b PA |
2700 | (widget-put widget :children (nreverse children)))) |
2701 | ||
783824f5 RS |
2702 | (defun widget-group-default-get (widget) |
2703 | ;; Get the default of the components. | |
2704 | (mapcar 'widget-default-get (widget-get widget :args))) | |
2705 | ||
d543e20b PA |
2706 | (defun widget-group-match (widget values) |
2707 | ;; Match if the components match. | |
2708 | (and (listp values) | |
2709 | (let ((match (widget-group-match-inline widget values))) | |
2710 | (and match (null (cdr match)))))) | |
2711 | ||
2712 | (defun widget-group-match-inline (widget vals) | |
2713 | ;; Match if the components match. | |
2714 | (let ((args (widget-get widget :args)) | |
2715 | argument answer found) | |
2716 | (while args | |
2717 | (setq argument (car args) | |
2718 | args (cdr args) | |
2719 | answer (widget-match-inline argument vals)) | |
2720 | (if answer | |
2721 | (setq vals (cdr answer) | |
2722 | found (append found (car answer))) | |
2723 | (setq vals nil | |
2724 | args nil))) | |
2725 | (if answer | |
2726 | (cons found vals) | |
2727 | nil))) | |
2728 | ||
3acab5ef | 2729 | ;;; The `visibility' Widget. |
d543e20b | 2730 | |
3acab5ef PA |
2731 | (define-widget 'visibility 'item |
2732 | "An indicator and manipulator for hidden items." | |
2733 | :format "%[%v%]" | |
2734 | :button-prefix "" | |
2735 | :button-suffix "" | |
c6753d66 RS |
2736 | :on "Hide" |
2737 | :off "Show" | |
3acab5ef PA |
2738 | :value-create 'widget-visibility-value-create |
2739 | :action 'widget-toggle-action | |
2740 | :match (lambda (widget value) t)) | |
d543e20b | 2741 | |
3acab5ef PA |
2742 | (defun widget-visibility-value-create (widget) |
2743 | ;; Insert text representing the `on' and `off' states. | |
2744 | (let ((on (widget-get widget :on)) | |
2745 | (off (widget-get widget :off))) | |
2746 | (if on | |
2747 | (setq on (concat widget-push-button-prefix | |
2748 | on | |
2749 | widget-push-button-suffix)) | |
2750 | (setq on "")) | |
2751 | (if off | |
2752 | (setq off (concat widget-push-button-prefix | |
c6753d66 RS |
2753 | off |
2754 | widget-push-button-suffix)) | |
3acab5ef PA |
2755 | (setq off "")) |
2756 | (if (widget-value widget) | |
2757 | (widget-glyph-insert widget on "down" "down-pushed") | |
c6753d66 RS |
2758 | (widget-glyph-insert widget off "right" "right-pushed")))) |
2759 | ||
8697863a PA |
2760 | ;;; The `documentation-link' Widget. |
2761 | ;; | |
2762 | ;; This is a helper widget for `documentation-string'. | |
3acab5ef | 2763 | |
8697863a PA |
2764 | (define-widget 'documentation-link 'link |
2765 | "Link type used in documentation strings." | |
2766 | :tab-order -1 | |
2767 | :help-echo 'widget-documentation-link-echo-help | |
2768 | :action 'widget-documentation-link-action) | |
2769 | ||
2770 | (defun widget-documentation-link-echo-help (widget) | |
2771 | "Tell what this link will describe." | |
2772 | (concat "Describe the `" (widget-get widget :value) "' symbol.")) | |
2773 | ||
2774 | (defun widget-documentation-link-action (widget &optional event) | |
f9923499 | 2775 | "Display documentation for WIDGET's value. Ignore optional argument EVENT." |
9dccd7ef RS |
2776 | (let* ((string (widget-get widget :value)) |
2777 | (symbol (intern string))) | |
2778 | (if (and (fboundp symbol) (boundp symbol)) | |
f9923499 | 2779 | ;; If there are two doc strings, give the user a way to pick one. |
9dccd7ef RS |
2780 | (apropos (concat "\\`" (regexp-quote string) "\\'")) |
2781 | (if (fboundp symbol) | |
2782 | (describe-function symbol) | |
2783 | (describe-variable symbol))))) | |
8697863a PA |
2784 | |
2785 | (defcustom widget-documentation-links t | |
2786 | "Add hyperlinks to documentation strings when non-nil." | |
2787 | :type 'boolean | |
2788 | :group 'widget-documentation) | |
2789 | ||
2790 | (defcustom widget-documentation-link-regexp "`\\([^\n`' ]+\\)'" | |
2791 | "Regexp for matching potential links in documentation strings. | |
2792 | The first group should be the link itself." | |
2793 | :type 'regexp | |
2794 | :group 'widget-documentation) | |
2795 | ||
2796 | (defcustom widget-documentation-link-p 'intern-soft | |
2797 | "Predicate used to test if a string is useful as a link. | |
2798 | The value should be a function. The function will be called one | |
2799 | argument, a string, and should return non-nil if there should be a | |
2800 | link for that string." | |
2801 | :type 'function | |
2802 | :options '(widget-documentation-link-p) | |
2803 | :group 'widget-documentation) | |
2804 | ||
2805 | (defcustom widget-documentation-link-type 'documentation-link | |
2806 | "Widget type used for links in documentation strings." | |
2807 | :type 'symbol | |
2808 | :group 'widget-documentation) | |
2809 | ||
2810 | (defun widget-documentation-link-add (widget from to) | |
2811 | (widget-specify-doc widget from to) | |
2812 | (when widget-documentation-links | |
2813 | (let ((regexp widget-documentation-link-regexp) | |
2814 | (predicate widget-documentation-link-p) | |
2815 | (type widget-documentation-link-type) | |
a89a9d34 DL |
2816 | (buttons (widget-get widget :buttons)) |
2817 | (widget-mouse-face (default-value 'widget-mouse-face)) | |
2818 | (widget-button-face widget-documentation-face) | |
2819 | (widget-button-pressed-face widget-documentation-face)) | |
8697863a PA |
2820 | (save-excursion |
2821 | (goto-char from) | |
2822 | (while (re-search-forward regexp to t) | |
2823 | (let ((name (match-string 1)) | |
a1a4fa22 PA |
2824 | (begin (match-beginning 1)) |
2825 | (end (match-end 1))) | |
8697863a PA |
2826 | (when (funcall predicate name) |
2827 | (push (widget-convert-button type begin end :value name) | |
2828 | buttons))))) | |
2829 | (widget-put widget :buttons buttons))) | |
2830 | (let ((indent (widget-get widget :indent))) | |
2831 | (when (and indent (not (zerop indent))) | |
2832 | (save-excursion | |
2833 | (save-restriction | |
2834 | (narrow-to-region from to) | |
2835 | (goto-char (point-min)) | |
2836 | (while (search-forward "\n" nil t) | |
2837 | (insert-char ?\ indent))))))) | |
2838 | ||
2839 | ;;; The `documentation-string' Widget. | |
0ce5b5d5 | 2840 | |
3acab5ef PA |
2841 | (define-widget 'documentation-string 'item |
2842 | "A documentation string." | |
2843 | :format "%v" | |
2844 | :action 'widget-documentation-string-action | |
2845 | :value-delete 'widget-children-value-delete | |
2846 | :value-create 'widget-documentation-string-value-create) | |
2847 | ||
2848 | (defun widget-documentation-string-value-create (widget) | |
2849 | ;; Insert documentation string. | |
2850 | (let ((doc (widget-value widget)) | |
8697863a | 2851 | (indent (widget-get widget :indent)) |
6aaedd12 PA |
2852 | (shown (widget-get (widget-get widget :parent) :documentation-shown)) |
2853 | (start (point))) | |
3acab5ef PA |
2854 | (if (string-match "\n" doc) |
2855 | (let ((before (substring doc 0 (match-beginning 0))) | |
2856 | (after (substring doc (match-beginning 0))) | |
2857 | buttons) | |
2858 | (insert before " ") | |
8697863a | 2859 | (widget-documentation-link-add widget start (point)) |
3acab5ef PA |
2860 | (push (widget-create-child-and-convert |
2861 | widget 'visibility | |
8697863a | 2862 | :help-echo "Show or hide rest of the documentation." |
c6753d66 | 2863 | :off "More" |
0640c647 | 2864 | :always-active t |
3acab5ef PA |
2865 | :action 'widget-parent-action |
2866 | shown) | |
2867 | buttons) | |
2868 | (when shown | |
0ce5b5d5 | 2869 | (setq start (point)) |
8697863a PA |
2870 | (when (and indent (not (zerop indent))) |
2871 | (insert-char ?\ indent)) | |
0ce5b5d5 | 2872 | (insert after) |
8697863a | 2873 | (widget-documentation-link-add widget start (point))) |
3acab5ef | 2874 | (widget-put widget :buttons buttons)) |
6aaedd12 | 2875 | (insert doc) |
8697863a | 2876 | (widget-documentation-link-add widget start (point)))) |
3acab5ef PA |
2877 | (insert "\n")) |
2878 | ||
2879 | (defun widget-documentation-string-action (widget &rest ignore) | |
2880 | ;; Toggle documentation. | |
2881 | (let ((parent (widget-get widget :parent))) | |
2882 | (widget-put parent :documentation-shown | |
2883 | (not (widget-get parent :documentation-shown)))) | |
2884 | ;; Redraw. | |
d543e20b | 2885 | (widget-value-set widget (widget-value widget))) |
fc56773e | 2886 | \f |
d543e20b PA |
2887 | ;;; The Sexp Widgets. |
2888 | ||
2889 | (define-widget 'const 'item | |
2890 | "An immutable sexp." | |
6d528fc5 | 2891 | :prompt-value 'widget-const-prompt-value |
d543e20b PA |
2892 | :format "%t\n%d") |
2893 | ||
6d528fc5 PA |
2894 | (defun widget-const-prompt-value (widget prompt value unbound) |
2895 | ;; Return the value of the const. | |
2896 | (widget-value widget)) | |
2897 | ||
2898 | (define-widget 'function-item 'const | |
d543e20b PA |
2899 | "An immutable function name." |
2900 | :format "%v\n%h" | |
2901 | :documentation-property (lambda (symbol) | |
2902 | (condition-case nil | |
2903 | (documentation symbol t) | |
2904 | (error nil)))) | |
2905 | ||
6d528fc5 | 2906 | (define-widget 'variable-item 'const |
d543e20b PA |
2907 | "An immutable variable name." |
2908 | :format "%v\n%h" | |
2909 | :documentation-property 'variable-documentation) | |
2910 | ||
cc0a25e1 RS |
2911 | (define-widget 'other 'sexp |
2912 | "Matches any value, but doesn't let the user edit the value. | |
2913 | This is useful as last item in a `choice' widget. | |
2914 | You should use this widget type with a default value, | |
b720878d | 2915 | as in (other DEFAULT) or (other :tag \"NAME\" DEFAULT). |
cc0a25e1 RS |
2916 | If the user selects this alternative, that specifies DEFAULT |
2917 | as the value." | |
2918 | :tag "Other" | |
2919 | :format "%t%n" | |
2920 | :value 'other) | |
2921 | ||
6d528fc5 PA |
2922 | (defvar widget-string-prompt-value-history nil |
2923 | "History of input to `widget-string-prompt-value'.") | |
2924 | ||
a3c88c59 PA |
2925 | (define-widget 'string 'editable-field |
2926 | "A string" | |
2927 | :tag "String" | |
2928 | :format "%{%t%}: %v" | |
0ce5b5d5 | 2929 | :complete-function 'ispell-complete-word |
a3c88c59 | 2930 | :prompt-history 'widget-string-prompt-value-history) |
6d528fc5 | 2931 | |
d543e20b PA |
2932 | (define-widget 'regexp 'string |
2933 | "A regular expression." | |
6d528fc5 PA |
2934 | :match 'widget-regexp-match |
2935 | :validate 'widget-regexp-validate | |
4ee1cf9f PA |
2936 | ;; Doesn't work well with terminating newline. |
2937 | ;; :value-face 'widget-single-line-field-face | |
d543e20b PA |
2938 | :tag "Regexp") |
2939 | ||
6d528fc5 PA |
2940 | (defun widget-regexp-match (widget value) |
2941 | ;; Match valid regexps. | |
2942 | (and (stringp value) | |
a3c88c59 | 2943 | (condition-case nil |
6d528fc5 PA |
2944 | (prog1 t |
2945 | (string-match value "")) | |
2946 | (error nil)))) | |
2947 | ||
2948 | (defun widget-regexp-validate (widget) | |
2949 | "Check that the value of WIDGET is a valid regexp." | |
2950 | (let ((val (widget-value widget))) | |
2951 | (condition-case data | |
2952 | (prog1 nil | |
2953 | (string-match val "")) | |
2954 | (error (widget-put widget :error (error-message-string data)) | |
2955 | widget)))) | |
2956 | ||
d543e20b PA |
2957 | (define-widget 'file 'string |
2958 | "A file widget. | |
25ac13b5 | 2959 | It will read a file name from the minibuffer when invoked." |
f1231b8e | 2960 | :complete-function 'widget-file-complete |
6d528fc5 | 2961 | :prompt-value 'widget-file-prompt-value |
a3c88c59 | 2962 | :format "%{%t%}: %v" |
4ee1cf9f PA |
2963 | ;; Doesn't work well with terminating newline. |
2964 | ;; :value-face 'widget-single-line-field-face | |
f1231b8e RS |
2965 | :tag "File") |
2966 | ||
2967 | (defun widget-file-complete () | |
2968 | "Perform completion on file name preceding point." | |
2969 | (interactive) | |
2970 | (let* ((end (point)) | |
2971 | (beg (save-excursion | |
2972 | (skip-chars-backward "^ ") | |
2973 | (point))) | |
2974 | (pattern (buffer-substring beg end)) | |
2975 | (name-part (file-name-nondirectory pattern)) | |
2976 | (directory (file-name-directory pattern)) | |
2977 | (completion (file-name-completion name-part directory))) | |
2978 | (cond ((eq completion t)) | |
2979 | ((null completion) | |
2980 | (message "Can't find completion for \"%s\"" pattern) | |
2981 | (ding)) | |
2982 | ((not (string= name-part completion)) | |
2983 | (delete-region beg end) | |
2984 | (insert (expand-file-name completion directory))) | |
2985 | (t | |
2986 | (message "Making completion list...") | |
2987 | (let ((list (file-name-all-completions name-part directory))) | |
2988 | (setq list (sort list 'string<)) | |
2989 | (with-output-to-temp-buffer "*Completions*" | |
2990 | (display-completion-list list))) | |
2991 | (message "Making completion list...%s" "done"))))) | |
d543e20b | 2992 | |
6d528fc5 PA |
2993 | (defun widget-file-prompt-value (widget prompt value unbound) |
2994 | ;; Read file from minibuffer. | |
2995 | (abbreviate-file-name | |
2996 | (if unbound | |
2997 | (read-file-name prompt) | |
a3c88c59 | 2998 | (let ((prompt2 (format "%s (default %s) " prompt value)) |
6d528fc5 PA |
2999 | (dir (file-name-directory value)) |
3000 | (file (file-name-nondirectory value)) | |
3001 | (must-match (widget-get widget :must-match))) | |
3002 | (read-file-name prompt2 dir nil must-match file))))) | |
3003 | ||
f1231b8e RS |
3004 | ;;;(defun widget-file-action (widget &optional event) |
3005 | ;;; ;; Read a file name from the minibuffer. | |
3006 | ;;; (let* ((value (widget-value widget)) | |
3007 | ;;; (dir (file-name-directory value)) | |
3008 | ;;; (file (file-name-nondirectory value)) | |
3009 | ;;; (menu-tag (widget-apply widget :menu-tag-get)) | |
3010 | ;;; (must-match (widget-get widget :must-match)) | |
3011 | ;;; (answer (read-file-name (concat menu-tag ": (default `" value "') ") | |
3012 | ;;; dir nil must-match file))) | |
3013 | ;;; (widget-value-set widget (abbreviate-file-name answer)) | |
3014 | ;;; (widget-setup) | |
3015 | ;;; (widget-apply widget :notify widget event))) | |
d543e20b PA |
3016 | |
3017 | (define-widget 'directory 'file | |
3018 | "A directory widget. | |
25ac13b5 | 3019 | It will read a directory name from the minibuffer when invoked." |
d543e20b PA |
3020 | :tag "Directory") |
3021 | ||
a3c88c59 PA |
3022 | (defvar widget-symbol-prompt-value-history nil |
3023 | "History of input to `widget-symbol-prompt-value'.") | |
3024 | ||
3025 | (define-widget 'symbol 'editable-field | |
4084d128 | 3026 | "A Lisp symbol." |
d543e20b PA |
3027 | :value nil |
3028 | :tag "Symbol" | |
a3c88c59 | 3029 | :format "%{%t%}: %v" |
d543e20b | 3030 | :match (lambda (widget value) (symbolp value)) |
f1231b8e | 3031 | :complete-function 'lisp-complete-symbol |
a3c88c59 PA |
3032 | :prompt-internal 'widget-symbol-prompt-internal |
3033 | :prompt-match 'symbolp | |
3034 | :prompt-history 'widget-symbol-prompt-value-history | |
d543e20b PA |
3035 | :value-to-internal (lambda (widget value) |
3036 | (if (symbolp value) | |
3037 | (symbol-name value) | |
3038 | value)) | |
3039 | :value-to-external (lambda (widget value) | |
3040 | (if (stringp value) | |
3041 | (intern value) | |
3042 | value))) | |
3043 | ||
a3c88c59 PA |
3044 | (defun widget-symbol-prompt-internal (widget prompt initial history) |
3045 | ;; Read file from minibuffer. | |
3046 | (let ((answer (completing-read prompt obarray | |
3047 | (widget-get widget :prompt-match) | |
3048 | nil initial history))) | |
3049 | (if (and (stringp answer) | |
3050 | (not (zerop (length answer)))) | |
3051 | answer | |
3052 | (error "No value")))) | |
3053 | ||
3054 | (defvar widget-function-prompt-value-history nil | |
3055 | "History of input to `widget-function-prompt-value'.") | |
3056 | ||
d543e20b | 3057 | (define-widget 'function 'sexp |
4084d128 | 3058 | "A Lisp function." |
0ce5b5d5 | 3059 | :complete-function 'lisp-complete-symbol |
a3c88c59 PA |
3060 | :prompt-value 'widget-field-prompt-value |
3061 | :prompt-internal 'widget-symbol-prompt-internal | |
3062 | :prompt-match 'fboundp | |
3063 | :prompt-history 'widget-function-prompt-value-history | |
3064 | :action 'widget-field-action | |
d543e20b PA |
3065 | :tag "Function") |
3066 | ||
a3c88c59 PA |
3067 | (defvar widget-variable-prompt-value-history nil |
3068 | "History of input to `widget-variable-prompt-value'.") | |
3069 | ||
d543e20b PA |
3070 | (define-widget 'variable 'symbol |
3071 | ;; Should complete on variables. | |
be96282a | 3072 | "A Lisp variable." |
a3c88c59 PA |
3073 | :prompt-match 'boundp |
3074 | :prompt-history 'widget-variable-prompt-value-history | |
d543e20b PA |
3075 | :tag "Variable") |
3076 | ||
fc56773e RS |
3077 | (defvar widget-coding-system-prompt-value-history nil |
3078 | "History of input to `widget-coding-system-prompt-value'.") | |
6aaedd12 | 3079 | |
fc56773e RS |
3080 | (define-widget 'coding-system 'symbol |
3081 | "A MULE coding-system." | |
3082 | :format "%{%t%}: %v" | |
3083 | :tag "Coding system" | |
3084 | :prompt-history 'widget-coding-system-prompt-value-history | |
3085 | :prompt-value 'widget-coding-system-prompt-value | |
3086 | :action 'widget-coding-system-action) | |
6aaedd12 | 3087 | |
fc56773e RS |
3088 | (defun widget-coding-system-prompt-value (widget prompt value unbound) |
3089 | ;; Read coding-system from minibuffer. | |
3090 | (intern | |
3091 | (completing-read (format "%s (default %s) " prompt value) | |
3092 | (mapcar (function | |
3093 | (lambda (sym) | |
3094 | (list (symbol-name sym)) | |
3095 | )) | |
3096 | (coding-system-list))))) | |
3097 | ||
3098 | (defun widget-coding-system-action (widget &optional event) | |
3099 | ;; Read a file name from the minibuffer. | |
3100 | (let ((answer | |
3101 | (widget-coding-system-prompt-value | |
3102 | widget | |
3103 | (widget-apply widget :menu-tag-get) | |
3104 | (widget-value widget) | |
3105 | t))) | |
3106 | (widget-value-set widget answer) | |
3107 | (widget-apply widget :notify widget event) | |
3108 | (widget-setup))) | |
fc56773e | 3109 | \f |
a3c88c59 | 3110 | (define-widget 'sexp 'editable-field |
be96282a | 3111 | "An arbitrary Lisp expression." |
d543e20b | 3112 | :tag "Lisp expression" |
a3c88c59 | 3113 | :format "%{%t%}: %v" |
d543e20b PA |
3114 | :value nil |
3115 | :validate 'widget-sexp-validate | |
3116 | :match (lambda (widget value) t) | |
3117 | :value-to-internal 'widget-sexp-value-to-internal | |
6d528fc5 | 3118 | :value-to-external (lambda (widget value) (read value)) |
a3c88c59 | 3119 | :prompt-history 'widget-sexp-prompt-value-history |
6d528fc5 | 3120 | :prompt-value 'widget-sexp-prompt-value) |
d543e20b PA |
3121 | |
3122 | (defun widget-sexp-value-to-internal (widget value) | |
3123 | ;; Use pp for printer representation. | |
6d1ab9d4 RS |
3124 | (let ((pp (if (symbolp value) |
3125 | (prin1-to-string value) | |
3126 | (pp-to-string value)))) | |
d543e20b PA |
3127 | (while (string-match "\n\\'" pp) |
3128 | (setq pp (substring pp 0 -1))) | |
3129 | (if (or (string-match "\n\\'" pp) | |
3130 | (> (length pp) 40)) | |
3131 | (concat "\n" pp) | |
3132 | pp))) | |
3133 | ||
3134 | (defun widget-sexp-validate (widget) | |
3135 | ;; Valid if we can read the string and there is no junk left after it. | |
99f01612 DL |
3136 | (with-temp-buffer |
3137 | (insert (widget-apply widget :value-get)) | |
3138 | (goto-char (point-min)) | |
3139 | (condition-case data | |
3140 | (progn | |
3141 | ;; Avoid a confusing end-of-file error. | |
3142 | (skip-syntax-forward "\\s-") | |
3143 | (if (eobp) | |
3144 | (error "Empty sexp -- use `nil'?")) | |
3145 | (let ((value (read (current-buffer)))) | |
d543e20b PA |
3146 | (if (eobp) |
3147 | (if (widget-apply widget :match value) | |
3148 | nil | |
3149 | (widget-put widget :error (widget-get widget :type-error)) | |
3150 | widget) | |
3151 | (widget-put widget | |
3152 | :error (format "Junk at end of expression: %s" | |
3153 | (buffer-substring (point) | |
3154 | (point-max)))) | |
99f01612 DL |
3155 | widget))) |
3156 | (end-of-file ; Avoid confusing error message. | |
3157 | (widget-put widget :error "Unbalanced sexp") | |
3158 | widget) | |
3159 | (error (widget-put widget :error (error-message-string data)) | |
3160 | widget)))) | |
d543e20b | 3161 | |
6d528fc5 PA |
3162 | (defvar widget-sexp-prompt-value-history nil |
3163 | "History of input to `widget-sexp-prompt-value'.") | |
3164 | ||
3165 | (defun widget-sexp-prompt-value (widget prompt value unbound) | |
3166 | ;; Read an arbitrary sexp. | |
3167 | (let ((found (read-string prompt | |
a3c88c59 PA |
3168 | (if unbound nil (cons (prin1-to-string value) 0)) |
3169 | (widget-get widget :prompt-history)))) | |
3170 | (save-excursion | |
3171 | (let ((buffer (set-buffer (get-buffer-create " *Widget Scratch*")))) | |
3172 | (erase-buffer) | |
3173 | (insert found) | |
3174 | (goto-char (point-min)) | |
3175 | (let ((answer (read buffer))) | |
3176 | (unless (eobp) | |
3177 | (error "Junk at end of expression: %s" | |
3178 | (buffer-substring (point) (point-max)))) | |
3179 | answer))))) | |
3180 | ||
0b296dac RS |
3181 | (define-widget 'restricted-sexp 'sexp |
3182 | "A Lisp expression restricted to values that match. | |
3183 | To use this type, you must define :match or :match-alternatives." | |
3184 | :type-error "The specified value is not valid" | |
3185 | :match 'widget-restricted-sexp-match | |
3186 | :value-to-internal (lambda (widget value) | |
3187 | (if (widget-apply widget :match value) | |
3188 | (prin1-to-string value) | |
3189 | value))) | |
3190 | ||
3191 | (defun widget-restricted-sexp-match (widget value) | |
3192 | (let ((alternatives (widget-get widget :match-alternatives)) | |
3193 | matched) | |
3194 | (while (and alternatives (not matched)) | |
3195 | (if (cond ((functionp (car alternatives)) | |
3196 | (funcall (car alternatives) value)) | |
3197 | ((and (consp (car alternatives)) | |
3198 | (eq (car (car alternatives)) 'quote)) | |
3199 | (eq value (nth 1 (car alternatives))))) | |
3200 | (setq matched t)) | |
3201 | (setq alternatives (cdr alternatives))) | |
3202 | matched)) | |
fc56773e | 3203 | \f |
0b296dac | 3204 | (define-widget 'integer 'restricted-sexp |
d543e20b PA |
3205 | "An integer." |
3206 | :tag "Integer" | |
3207 | :value 0 | |
3208 | :type-error "This field should contain an integer" | |
0b296dac RS |
3209 | :match-alternatives '(integerp)) |
3210 | ||
3211 | (define-widget 'number 'restricted-sexp | |
3212 | "A floating point number." | |
3213 | :tag "Number" | |
3214 | :value 0.0 | |
3215 | :type-error "This field should contain a number" | |
3216 | :match-alternatives '(numberp)) | |
d543e20b | 3217 | |
a3c88c59 | 3218 | (define-widget 'character 'editable-field |
0b296dac | 3219 | "A character." |
d543e20b PA |
3220 | :tag "Character" |
3221 | :value 0 | |
3222 | :size 1 | |
3223 | :format "%{%t%}: %v\n" | |
6d528fc5 PA |
3224 | :valid-regexp "\\`.\\'" |
3225 | :error "This field should contain a single character" | |
d543e20b | 3226 | :value-to-internal (lambda (widget value) |
a3c88c59 PA |
3227 | (if (stringp value) |
3228 | value | |
3229 | (char-to-string value))) | |
d543e20b PA |
3230 | :value-to-external (lambda (widget value) |
3231 | (if (stringp value) | |
3232 | (aref value 0) | |
3233 | value)) | |
a3c88c59 | 3234 | :match (lambda (widget value) |
99f01612 | 3235 | (char-valid-p value))) |
d543e20b | 3236 | |
d543e20b | 3237 | (define-widget 'list 'group |
be96282a | 3238 | "A Lisp list." |
d543e20b PA |
3239 | :tag "List" |
3240 | :format "%{%t%}:\n%v") | |
3241 | ||
3242 | (define-widget 'vector 'group | |
be96282a | 3243 | "A Lisp vector." |
d543e20b PA |
3244 | :tag "Vector" |
3245 | :format "%{%t%}:\n%v" | |
3246 | :match 'widget-vector-match | |
3247 | :value-to-internal (lambda (widget value) (append value nil)) | |
3248 | :value-to-external (lambda (widget value) (apply 'vector value))) | |
3249 | ||
3250 | (defun widget-vector-match (widget value) | |
3251 | (and (vectorp value) | |
3252 | (widget-group-match widget | |
bd042c03 | 3253 | (widget-apply widget :value-to-internal value)))) |
d543e20b PA |
3254 | |
3255 | (define-widget 'cons 'group | |
3256 | "A cons-cell." | |
3257 | :tag "Cons-cell" | |
3258 | :format "%{%t%}:\n%v" | |
3259 | :match 'widget-cons-match | |
3260 | :value-to-internal (lambda (widget value) | |
3261 | (list (car value) (cdr value))) | |
3262 | :value-to-external (lambda (widget value) | |
3263 | (cons (nth 0 value) (nth 1 value)))) | |
3264 | ||
3265 | (defun widget-cons-match (widget value) | |
3266 | (and (consp value) | |
3267 | (widget-group-match widget | |
3268 | (widget-apply widget :value-to-internal value)))) | |
fc56773e RS |
3269 | \f |
3270 | ;;; The `plist' Widget. | |
3271 | ;; | |
3272 | ;; Property lists. | |
3273 | ||
3274 | (define-widget 'plist 'list | |
3275 | "A property list." | |
3276 | :key-type '(symbol :tag "Key") | |
3277 | :value-type '(sexp :tag "Value") | |
3278 | :convert-widget 'widget-plist-convert-widget | |
3279 | :tag "Plist") | |
3280 | ||
3281 | (defvar widget-plist-value-type) ;Dynamic variable | |
3282 | ||
3283 | (defun widget-plist-convert-widget (widget) | |
3284 | ;; Handle `:options'. | |
3285 | (let* ((options (widget-get widget :options)) | |
3286 | (key-type (widget-get widget :key-type)) | |
3287 | (widget-plist-value-type (widget-get widget :value-type)) | |
3288 | (other `(editable-list :inline t | |
3289 | (group :inline t | |
3290 | ,key-type | |
3291 | ,widget-plist-value-type))) | |
3292 | (args (if options | |
3293 | (list `(checklist :inline t | |
3294 | :greedy t | |
3295 | ,@(mapcar 'widget-plist-convert-option | |
3296 | options)) | |
3297 | other) | |
3298 | (list other)))) | |
3299 | (widget-put widget :args args) | |
3300 | widget)) | |
d543e20b | 3301 | |
fc56773e RS |
3302 | (defun widget-plist-convert-option (option) |
3303 | ;; Convert a single plist option. | |
3304 | (let (key-type value-type) | |
3305 | (if (listp option) | |
3306 | (let ((key (nth 0 option))) | |
3307 | (setq value-type (nth 1 option)) | |
3308 | (if (listp key) | |
31d5543d | 3309 | (setq key-type key) |
fc56773e RS |
3310 | (setq key-type `(const ,key)))) |
3311 | (setq key-type `(const ,option) | |
3312 | value-type widget-plist-value-type)) | |
3313 | `(group :format "Key: %v" :inline t ,key-type ,value-type))) | |
3314 | ||
3315 | ||
3316 | ;;; The `alist' Widget. | |
3317 | ;; | |
3318 | ;; Association lists. | |
3319 | ||
3320 | (define-widget 'alist 'list | |
3321 | "An association list." | |
a7013a02 | 3322 | :key-type '(sexp :tag "Key") |
fc56773e RS |
3323 | :value-type '(sexp :tag "Value") |
3324 | :convert-widget 'widget-alist-convert-widget | |
3325 | :tag "Alist") | |
3326 | ||
3327 | (defvar widget-alist-value-type) ;Dynamic variable | |
3328 | ||
3329 | (defun widget-alist-convert-widget (widget) | |
3330 | ;; Handle `:options'. | |
3331 | (let* ((options (widget-get widget :options)) | |
3332 | (key-type (widget-get widget :key-type)) | |
3333 | (widget-alist-value-type (widget-get widget :value-type)) | |
3334 | (other `(editable-list :inline t | |
3335 | (cons :format "%v" | |
3336 | ,key-type | |
3337 | ,widget-alist-value-type))) | |
3338 | (args (if options | |
3339 | (list `(checklist :inline t | |
3340 | :greedy t | |
3341 | ,@(mapcar 'widget-alist-convert-option | |
3342 | options)) | |
3343 | other) | |
3344 | (list other)))) | |
3345 | (widget-put widget :args args) | |
3346 | widget)) | |
3347 | ||
3348 | (defun widget-alist-convert-option (option) | |
3349 | ;; Convert a single alist option. | |
3350 | (let (key-type value-type) | |
3351 | (if (listp option) | |
3352 | (let ((key (nth 0 option))) | |
3353 | (setq value-type (nth 1 option)) | |
3354 | (if (listp key) | |
31d5543d | 3355 | (setq key-type key) |
fc56773e RS |
3356 | (setq key-type `(const ,key)))) |
3357 | (setq key-type `(const ,option) | |
3358 | value-type widget-alist-value-type)) | |
3359 | `(cons :format "Key: %v" ,key-type ,value-type))) | |
3360 | \f | |
d543e20b PA |
3361 | (define-widget 'choice 'menu-choice |
3362 | "A union of several sexp types." | |
3363 | :tag "Choice" | |
c6753d66 | 3364 | :format "%{%t%}: %[Value Menu%] %v" |
8697863a PA |
3365 | :button-prefix 'widget-push-button-prefix |
3366 | :button-suffix 'widget-push-button-suffix | |
a3c88c59 PA |
3367 | :prompt-value 'widget-choice-prompt-value) |
3368 | ||
3369 | (defun widget-choice-prompt-value (widget prompt value unbound) | |
3370 | "Make a choice." | |
3371 | (let ((args (widget-get widget :args)) | |
3372 | (completion-ignore-case (widget-get widget :case-fold)) | |
3373 | current choices old) | |
3374 | ;; Find the first arg that match VALUE. | |
3375 | (let ((look args)) | |
3376 | (while look | |
3377 | (if (widget-apply (car look) :match value) | |
3378 | (setq old (car look) | |
3379 | look nil) | |
3380 | (setq look (cdr look))))) | |
3381 | ;; Find new choice. | |
3382 | (setq current | |
3383 | (cond ((= (length args) 0) | |
3384 | nil) | |
3385 | ((= (length args) 1) | |
3386 | (nth 0 args)) | |
3387 | ((and (= (length args) 2) | |
3388 | (memq old args)) | |
3389 | (if (eq old (nth 0 args)) | |
3390 | (nth 1 args) | |
3391 | (nth 0 args))) | |
3392 | (t | |
3393 | (while args | |
3394 | (setq current (car args) | |
3395 | args (cdr args)) | |
3396 | (setq choices | |
3397 | (cons (cons (widget-apply current :menu-tag-get) | |
3398 | current) | |
3399 | choices))) | |
3400 | (let ((val (completing-read prompt choices nil t))) | |
3401 | (if (stringp val) | |
3402 | (let ((try (try-completion val choices))) | |
3403 | (when (stringp try) | |
3404 | (setq val try)) | |
3405 | (cdr (assoc val choices))) | |
3406 | nil))))) | |
3407 | (if current | |
3408 | (widget-prompt-value current prompt nil t) | |
3409 | value))) | |
fc56773e | 3410 | \f |
d543e20b PA |
3411 | (define-widget 'radio 'radio-button-choice |
3412 | "A union of several sexp types." | |
3413 | :tag "Choice" | |
a3c88c59 PA |
3414 | :format "%{%t%}:\n%v" |
3415 | :prompt-value 'widget-choice-prompt-value) | |
d543e20b PA |
3416 | |
3417 | (define-widget 'repeat 'editable-list | |
3418 | "A variable length homogeneous list." | |
3419 | :tag "Repeat" | |
3420 | :format "%{%t%}:\n%v%i\n") | |
3421 | ||
3422 | (define-widget 'set 'checklist | |
3423 | "A list of members from a fixed set." | |
3424 | :tag "Set" | |
3425 | :format "%{%t%}:\n%v") | |
3426 | ||
3427 | (define-widget 'boolean 'toggle | |
3428 | "To be nil or non-nil, that is the question." | |
3429 | :tag "Boolean" | |
6d528fc5 | 3430 | :prompt-value 'widget-boolean-prompt-value |
8697863a PA |
3431 | :button-prefix 'widget-push-button-prefix |
3432 | :button-suffix 'widget-push-button-suffix | |
c6753d66 RS |
3433 | :format "%{%t%}: %[Toggle%] %v\n" |
3434 | :on "on (non-nil)" | |
3435 | :off "off (nil)") | |
d543e20b | 3436 | |
6d528fc5 PA |
3437 | (defun widget-boolean-prompt-value (widget prompt value unbound) |
3438 | ;; Toggle a boolean. | |
a3c88c59 | 3439 | (y-or-n-p prompt)) |
fc56773e | 3440 | \f |
d543e20b PA |
3441 | ;;; The `color' Widget. |
3442 | ||
0f648ca2 PA |
3443 | (define-widget 'color 'editable-field |
3444 | "Choose a color name (with sample)." | |
3445 | :format "%t: %v (%{sample%})\n" | |
3446 | :size 10 | |
3447 | :tag "Color" | |
3448 | :value "black" | |
3449 | :complete 'widget-color-complete | |
3450 | :sample-face-get 'widget-color-sample-face-get | |
3451 | :notify 'widget-color-notify | |
3452 | :action 'widget-color-action) | |
3453 | ||
3454 | (defun widget-color-complete (widget) | |
3455 | "Complete the color in WIDGET." | |
99f01612 | 3456 | (require 'facemenu) ; for facemenu-color-alist |
0f648ca2 PA |
3457 | (let* ((prefix (buffer-substring-no-properties (widget-field-start widget) |
3458 | (point))) | |
99f01612 DL |
3459 | (list (or facemenu-color-alist |
3460 | (mapcar 'list (defined-colors)))) | |
0f648ca2 PA |
3461 | (completion (try-completion prefix list))) |
3462 | (cond ((eq completion t) | |
3463 | (message "Exact match.")) | |
3464 | ((null completion) | |
3465 | (error "Can't find completion for \"%s\"" prefix)) | |
3466 | ((not (string-equal prefix completion)) | |
3467 | (insert-and-inherit (substring completion (length prefix)))) | |
3468 | (t | |
3469 | (message "Making completion list...") | |
3470 | (let ((list (all-completions prefix list nil))) | |
3471 | (with-output-to-temp-buffer "*Completions*" | |
3472 | (display-completion-list list))) | |
3473 | (message "Making completion list...done"))))) | |
d543e20b | 3474 | |
0f648ca2 | 3475 | (defun widget-color-sample-face-get (widget) |
4ee1cf9f PA |
3476 | (let* ((value (condition-case nil |
3477 | (widget-value widget) | |
3478 | (error (widget-get widget :value)))) | |
3479 | (symbol (intern (concat "fg:" value)))) | |
17030183 RS |
3480 | (condition-case nil |
3481 | (facemenu-get-face symbol) | |
3482 | (error 'default)))) | |
d543e20b | 3483 | |
d543e20b PA |
3484 | (defun widget-color-action (widget &optional event) |
3485 | ;; Prompt for a color. | |
3486 | (let* ((tag (widget-apply widget :menu-tag-get)) | |
3487 | (prompt (concat tag ": ")) | |
4ee1cf9f PA |
3488 | (value (widget-value widget)) |
3489 | (start (widget-field-start widget)) | |
3490 | (pos (cond ((< (point) start) | |
3491 | 0) | |
3492 | ((> (point) (+ start (length value))) | |
3493 | (length value)) | |
3494 | (t | |
3495 | (- (point) start)))) | |
99f01612 | 3496 | (answer (facemenu-read-color prompt))) |
d543e20b PA |
3497 | (unless (zerop (length answer)) |
3498 | (widget-value-set widget answer) | |
0a3a0b56 PA |
3499 | (widget-setup) |
3500 | (widget-apply widget :notify widget event)))) | |
d543e20b | 3501 | |
0f648ca2 PA |
3502 | (defun widget-color-notify (widget child &optional event) |
3503 | "Update the sample, and notofy the parent." | |
3504 | (overlay-put (widget-get widget :sample-overlay) | |
3505 | 'face (widget-apply widget :sample-face-get)) | |
3506 | (widget-default-notify widget child event)) | |
fc56773e | 3507 | \f |
d543e20b PA |
3508 | ;;; The Help Echo |
3509 | ||
d543e20b PA |
3510 | (defun widget-at (pos) |
3511 | "The button or field at POS." | |
0a3a0b56 PA |
3512 | (or (get-char-property pos 'button) |
3513 | (get-char-property pos 'field))) | |
d543e20b PA |
3514 | |
3515 | (defun widget-echo-help (pos) | |
3516 | "Display the help echo for widget at POS." | |
3517 | (let* ((widget (widget-at pos)) | |
3518 | (help-echo (and widget (widget-get widget :help-echo)))) | |
3519 | (cond ((stringp help-echo) | |
3520 | (message "%s" help-echo)) | |
3521 | ((and (symbolp help-echo) (fboundp help-echo) | |
3522 | (stringp (setq help-echo (funcall help-echo widget)))) | |
3523 | (message "%s" help-echo))))) | |
3524 | ||
3525 | ;;; The End: | |
3526 | ||
3527 | (provide 'wid-edit) | |
3528 | ||
3529 | ;; wid-edit.el ends here |