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