*** empty log message ***
[emacs.git] / lisp / wid-edit.el
blob4c560918594b9e72f07076d0eaa645a9eabce14c
1 ;;; wid-edit.el --- Functions for creating and using widgets -*-byte-compile-dynamic: t;-*-
2 ;;
3 ;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7 ;; Maintainer: FSF
8 ;; Keywords: extensions
10 ;; This file is part of GNU Emacs.
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.
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.
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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Wishlist items (from widget.texi):
29 ;; * The `menu-choice' tag should be prettier, something like the
30 ;; abbreviated menus in Open Look.
32 ;; * Finish `:tab-order'.
34 ;; * Make indentation work with glyphs and proportional fonts.
36 ;; * Add commands to show overview of object and class hierarchies to
37 ;; the browser.
39 ;; * Find a way to disable mouse highlight for inactive widgets.
41 ;; * Find a way to make glyphs look inactive.
43 ;; * Add `key-binding' widget.
45 ;; * Add `widget' widget for editing widget specifications.
47 ;; * Find clean way to implement variable length list. See
48 ;; `TeX-printer-list' for an explanation.
50 ;; * `C-h' in `widget-prompt-value' should give type specific help.
52 ;; * A mailto widget. [This should work OK as a url-link if with
53 ;; browse-url-browser-function' set up appropriately.]
55 ;;; Commentary:
57 ;; See `widget.el'.
59 ;;; Code:
61 (defvar widget)
63 ;;; Compatibility.
65 (defun widget-event-point (event)
66 "Character position of the end of event if that exists, or nil."
67 (posn-point (event-end event)))
69 (defun widget-button-release-event-p (event)
70 "Non-nil if EVENT is a mouse-button-release event object."
71 (and (eventp event)
72 (memq (event-basic-type event) '(mouse-1 mouse-2 mouse-3))
73 (or (memq 'click (event-modifiers event))
74 (memq 'drag (event-modifiers event)))))
76 ;;; Customization.
78 (defgroup widgets nil
79 "Customization support for the Widget Library."
80 :link '(custom-manual "(widget)Top")
81 :link '(emacs-library-link :tag "Lisp File" "widget.el")
82 :prefix "widget-"
83 :group 'extensions
84 :group 'hypermedia)
86 (defgroup widget-documentation nil
87 "Options controlling the display of documentation strings."
88 :group 'widgets)
90 (defgroup widget-faces nil
91 "Faces used by the widget library."
92 :group 'widgets
93 :group 'faces)
95 (defvar widget-documentation-face 'widget-documentation
96 "Face used for documentation strings in widgets.
97 This exists as a variable so it can be set locally in certain buffers.")
99 (defface widget-documentation '((((class color)
100 (background dark))
101 (:foreground "lime green"))
102 (((class color)
103 (background light))
104 (:foreground "dark green"))
105 (t nil))
106 "Face used for documentation text."
107 :group 'widget-documentation
108 :group 'widget-faces)
109 ;; backward compatibility alias
110 (put 'widget-documentation-face 'face-alias 'widget-documentation)
112 (defvar widget-button-face 'widget-button
113 "Face used for buttons in widgets.
114 This exists as a variable so it can be set locally in certain buffers.")
116 (defface widget-button '((t (:weight bold)))
117 "Face used for widget buttons."
118 :group 'widget-faces)
119 ;; backward compatibility alias
120 (put 'widget-button-face 'face-alias 'widget-button)
122 (defcustom widget-mouse-face 'highlight
123 "Face used for widget buttons when the mouse is above them."
124 :type 'face
125 :group 'widget-faces)
127 ;; TTY gets special definitions here and in the next defface, because
128 ;; the gray colors defined for other displays cause black text on a black
129 ;; background, at least on light-background TTYs.
130 (defface widget-field '((((type tty))
131 :background "yellow3"
132 :foreground "black")
133 (((class grayscale color)
134 (background light))
135 :background "gray85")
136 (((class grayscale color)
137 (background dark))
138 :background "dim gray")
140 :slant italic))
141 "Face used for editable fields."
142 :group 'widget-faces)
143 ;; backward-compatibility alias
144 (put 'widget-field-face 'face-alias 'widget-field)
146 (defface widget-single-line-field '((((type tty))
147 :background "green3"
148 :foreground "black")
149 (((class grayscale color)
150 (background light))
151 :background "gray85")
152 (((class grayscale color)
153 (background dark))
154 :background "dim gray")
156 :slant italic))
157 "Face used for editable fields spanning only a single line."
158 :group 'widget-faces)
159 ;; backward-compatibility alias
160 (put 'widget-single-line-field-face 'face-alias 'widget-single-line-field)
162 ;;; This causes display-table to be loaded, and not usefully.
163 ;;;(defvar widget-single-line-display-table
164 ;;; (let ((table (make-display-table)))
165 ;;; (aset table 9 "^I")
166 ;;; (aset table 10 "^J")
167 ;;; table)
168 ;;; "Display table used for single-line editable fields.")
170 ;;;(when (fboundp 'set-face-display-table)
171 ;;; (set-face-display-table 'widget-single-line-field-face
172 ;;; widget-single-line-display-table))
174 ;;; Utility functions.
176 ;; These are not really widget specific.
178 (defun widget-princ-to-string (object)
179 "Return string representation of OBJECT, any Lisp object.
180 No quoting characters are used; no delimiters are printed around
181 the contents of strings."
182 (with-output-to-string
183 (princ object)))
185 (defun widget-clear-undo ()
186 "Clear all undo information."
187 (buffer-disable-undo (current-buffer))
188 (buffer-enable-undo))
190 (defcustom widget-menu-max-size 40
191 "Largest number of items allowed in a popup-menu.
192 Larger menus are read through the minibuffer."
193 :group 'widgets
194 :type 'integer)
196 (defcustom widget-menu-max-shortcuts 40
197 "Largest number of items for which it works to choose one with a character.
198 For a larger number of items, the minibuffer is used."
199 :group 'widgets
200 :type 'integer)
202 (defcustom widget-menu-minibuffer-flag nil
203 "*Control how to ask for a choice from the keyboard.
204 Non-nil means use the minibuffer;
205 nil means read a single character."
206 :group 'widgets
207 :type 'boolean)
209 (defun widget-choose (title items &optional event)
210 "Choose an item from a list.
212 First argument TITLE is the name of the list.
213 Second argument ITEMS is a list whose members are either
214 (NAME . VALUE), to indicate selectable items, or just strings to
215 indicate unselectable items.
216 Optional third argument EVENT is an input event.
218 The user is asked to choose between each NAME from the items alist,
219 and the VALUE of the chosen element will be returned. If EVENT is a
220 mouse event, and the number of elements in items is less than
221 `widget-menu-max-size', a popup menu will be used, otherwise the
222 minibuffer."
223 (cond ((and (< (length items) widget-menu-max-size)
224 event (display-popup-menus-p))
225 ;; Mouse click.
226 (x-popup-menu event
227 (list title (cons "" items))))
228 ((or widget-menu-minibuffer-flag
229 (> (length items) widget-menu-max-shortcuts))
230 ;; Read the choice of name from the minibuffer.
231 (setq items (widget-remove-if 'stringp items))
232 (let ((val (completing-read (concat title ": ") items nil t)))
233 (if (stringp val)
234 (let ((try (try-completion val items)))
235 (when (stringp try)
236 (setq val try))
237 (cdr (assoc val items))))))
239 ;; Construct a menu of the choices
240 ;; and then use it for prompting for a single character.
241 (let* ((overriding-terminal-local-map (make-sparse-keymap))
242 (next-digit ?0)
243 map choice some-choice-enabled value)
244 ;; Define SPC as a prefix char to get to this menu.
245 (define-key overriding-terminal-local-map " "
246 (setq map (make-sparse-keymap title)))
247 (with-current-buffer (get-buffer-create " widget-choose")
248 (erase-buffer)
249 (insert "Available choices:\n\n")
250 (while items
251 (setq choice (car items) items (cdr items))
252 (if (consp choice)
253 (let* ((name (car choice))
254 (function (cdr choice)))
255 (insert (format "%c = %s\n" next-digit name))
256 (define-key map (vector next-digit) function)
257 (setq some-choice-enabled t)))
258 ;; Allocate digits to disabled alternatives
259 ;; so that the digit of a given alternative never varies.
260 (setq next-digit (1+ next-digit)))
261 (insert "\nC-g = Quit"))
262 (or some-choice-enabled
263 (error "None of the choices is currently meaningful"))
264 (define-key map [?\C-g] 'keyboard-quit)
265 (define-key map [t] 'keyboard-quit)
266 (define-key map [?\M-\C-v] 'scroll-other-window)
267 (define-key map [?\M--] 'negative-argument)
268 (setcdr map (nreverse (cdr map)))
269 ;; Read a char with the menu, and return the result
270 ;; that corresponds to it.
271 (save-window-excursion
272 (let ((buf (get-buffer " widget-choose")))
273 (fit-window-to-buffer (display-buffer buf))
274 (let ((cursor-in-echo-area t)
275 keys
276 (char 0)
277 (arg 1))
278 (while (not (or (and (integerp char)
279 (>= char ?0) (< char next-digit))
280 (eq value 'keyboard-quit)))
281 ;; Unread a SPC to lead to our new menu.
282 (setq unread-command-events (cons ?\s unread-command-events))
283 (setq keys (read-key-sequence title))
284 (setq value
285 (lookup-key overriding-terminal-local-map keys t)
286 char (aref keys 1))
287 (cond ((eq value 'scroll-other-window)
288 (let ((minibuffer-scroll-window
289 (get-buffer-window buf)))
290 (if (> 0 arg)
291 (scroll-other-window-down
292 (window-height minibuffer-scroll-window))
293 (scroll-other-window))
294 (setq arg 1)))
295 ((eq value 'negative-argument)
296 (setq arg -1))
298 (setq arg 1)))))))
299 (when (eq value 'keyboard-quit)
300 (error "Canceled"))
301 value))))
303 (defun widget-remove-if (predictate list)
304 (let (result (tail list))
305 (while tail
306 (or (funcall predictate (car tail))
307 (setq result (cons (car tail) result)))
308 (setq tail (cdr tail)))
309 (nreverse result)))
311 ;;; Widget text specifications.
313 ;; These functions are for specifying text properties.
315 ;; We can set it to nil now that get_local_map uses get_pos_property.
316 (defconst widget-field-add-space nil
317 "Non-nil means add extra space at the end of editable text fields.
318 If you don't add the space, it will become impossible to edit a zero
319 size field.")
321 (defvar widget-field-use-before-change t
322 "Non-nil means use `before-change-functions' to track editable fields.
323 This enables the use of undo, but doesn't work on Emacs 19.34 and earlier.
324 Using before hooks also means that the :notify function can't know the
325 new value.")
327 (defun widget-specify-field (widget from to)
328 "Specify editable button for WIDGET between FROM and TO."
329 ;; Terminating space is not part of the field, but necessary in
330 ;; order for local-map to work. Remove next sexp if local-map works
331 ;; at the end of the overlay.
332 (save-excursion
333 (goto-char to)
334 (cond ((null (widget-get widget :size))
335 (forward-char 1))
336 (widget-field-add-space
337 (insert-and-inherit " ")))
338 (setq to (point)))
339 (let ((keymap (widget-get widget :keymap))
340 (face (or (widget-get widget :value-face) 'widget-field))
341 (help-echo (widget-get widget :help-echo))
342 (follow-link (widget-get widget :follow-link))
343 (rear-sticky
344 (or (not widget-field-add-space) (widget-get widget :size))))
345 (if (functionp help-echo)
346 (setq help-echo 'widget-mouse-help))
347 (when (= (char-before to) ?\n)
348 ;; When the last character in the field is a newline, we want to
349 ;; give it a `field' char-property of `boundary', which helps the
350 ;; C-n/C-p act more naturally when entering/leaving the field. We
351 ;; do this by making a small secondary overlay to contain just that
352 ;; one character.
353 (let ((overlay (make-overlay (1- to) to nil t nil)))
354 (overlay-put overlay 'field 'boundary)
355 ;; We need the real field for tabbing.
356 (overlay-put overlay 'real-field widget)
357 ;; Use `local-map' here, not `keymap', so that normal editing
358 ;; works in the field when, say, Custom uses `suppress-keymap'.
359 (overlay-put overlay 'local-map keymap)
360 (overlay-put overlay 'face face)
361 (overlay-put overlay 'follow-link follow-link)
362 (overlay-put overlay 'help-echo help-echo))
363 (setq to (1- to))
364 (setq rear-sticky t))
365 (let ((overlay (make-overlay from to nil nil rear-sticky)))
366 (widget-put widget :field-overlay overlay)
367 ;;(overlay-put overlay 'detachable nil)
368 (overlay-put overlay 'field widget)
369 (overlay-put overlay 'local-map keymap)
370 (overlay-put overlay 'face face)
371 (overlay-put overlay 'follow-link follow-link)
372 (overlay-put overlay 'help-echo help-echo)))
373 (widget-specify-secret widget))
375 (defun widget-specify-secret (field)
376 "Replace text in FIELD with value of `:secret', if non-nil."
377 (let ((secret (widget-get field :secret))
378 (size (widget-get field :size)))
379 (when secret
380 (let ((begin (widget-field-start field))
381 (end (widget-field-end field)))
382 (when size
383 (while (and (> end begin)
384 (eq (char-after (1- end)) ?\s))
385 (setq end (1- end))))
386 (while (< begin end)
387 (let ((old (char-after begin)))
388 (unless (eq old secret)
389 (subst-char-in-region begin (1+ begin) old secret)
390 (put-text-property begin (1+ begin) 'secret old))
391 (setq begin (1+ begin))))))))
393 (defun widget-specify-button (widget from to)
394 "Specify button for WIDGET between FROM and TO."
395 (let ((overlay (make-overlay from to nil t nil))
396 (follow-link (widget-get widget :follow-link))
397 (help-echo (widget-get widget :help-echo)))
398 (widget-put widget :button-overlay overlay)
399 (if (functionp help-echo)
400 (setq help-echo 'widget-mouse-help))
401 (overlay-put overlay 'button widget)
402 (overlay-put overlay 'keymap (widget-get widget :keymap))
403 (overlay-put overlay 'evaporate t)
404 ;; We want to avoid the face with image buttons.
405 (unless (widget-get widget :suppress-face)
406 (overlay-put overlay 'face (widget-apply widget :button-face-get))
407 (overlay-put overlay 'mouse-face
408 (widget-apply widget :mouse-face-get)))
409 (overlay-put overlay 'pointer 'hand)
410 (overlay-put overlay 'follow-link follow-link)
411 (overlay-put overlay 'help-echo help-echo)))
413 (defun widget-mouse-help (window overlay point)
414 "Help-echo callback for widgets whose :help-echo is a function."
415 (with-current-buffer (overlay-buffer overlay)
416 (let* ((widget (widget-at (overlay-start overlay)))
417 (help-echo (if widget (widget-get widget :help-echo))))
418 (if (functionp help-echo)
419 (funcall help-echo widget)
420 help-echo))))
422 (defun widget-specify-sample (widget from to)
423 "Specify sample for WIDGET between FROM and TO."
424 (let ((overlay (make-overlay from to nil t nil)))
425 (overlay-put overlay 'face (widget-apply widget :sample-face-get))
426 (overlay-put overlay 'evaporate t)
427 (widget-put widget :sample-overlay overlay)))
429 (defun widget-specify-doc (widget from to)
430 "Specify documentation for WIDGET between FROM and TO."
431 (let ((overlay (make-overlay from to nil t nil)))
432 (overlay-put overlay 'widget-doc widget)
433 (overlay-put overlay 'face widget-documentation-face)
434 (overlay-put overlay 'evaporate t)
435 (widget-put widget :doc-overlay overlay)))
437 (defmacro widget-specify-insert (&rest form)
438 "Execute FORM without inheriting any text properties."
439 `(save-restriction
440 (let ((inhibit-read-only t)
441 (inhibit-modification-hooks t))
442 (narrow-to-region (point) (point))
443 (prog1 (progn ,@form)
444 (goto-char (point-max))))))
446 (defface widget-inactive
447 '((t :inherit shadow))
448 "Face used for inactive widgets."
449 :group 'widget-faces)
450 ;; backward-compatibility alias
451 (put 'widget-inactive-face 'face-alias 'widget-inactive)
453 (defun widget-specify-inactive (widget from to)
454 "Make WIDGET inactive for user modifications."
455 (unless (widget-get widget :inactive)
456 (let ((overlay (make-overlay from to nil t nil)))
457 (overlay-put overlay 'face 'widget-inactive)
458 ;; This is disabled, as it makes the mouse cursor change shape.
459 ;; (overlay-put overlay 'mouse-face 'widget-inactive)
460 (overlay-put overlay 'evaporate t)
461 (overlay-put overlay 'priority 100)
462 (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
463 (widget-put widget :inactive overlay))))
465 (defun widget-overlay-inactive (&rest junk)
466 "Ignoring the arguments, signal an error."
467 (unless inhibit-read-only
468 (error "The widget here is not active")))
471 (defun widget-specify-active (widget)
472 "Make WIDGET active for user modifications."
473 (let ((inactive (widget-get widget :inactive)))
474 (when inactive
475 (delete-overlay inactive)
476 (widget-put widget :inactive nil))))
478 ;;; Widget Properties.
480 (defsubst widget-type (widget)
481 "Return the type of WIDGET, a symbol."
482 (car widget))
484 ;;;###autoload
485 (defun widgetp (widget)
486 "Return non-nil iff WIDGET is a widget."
487 (if (symbolp widget)
488 (get widget 'widget-type)
489 (and (consp widget)
490 (symbolp (car widget))
491 (get (car widget) 'widget-type))))
493 (defun widget-get-indirect (widget property)
494 "In WIDGET, get the value of PROPERTY.
495 If the value is a symbol, return its binding.
496 Otherwise, just return the value."
497 (let ((value (widget-get widget property)))
498 (if (symbolp value)
499 (symbol-value value)
500 value)))
502 (defun widget-member (widget property)
503 "Non-nil iff there is a definition in WIDGET for PROPERTY."
504 (cond ((plist-member (cdr widget) property)
506 ((car widget)
507 (widget-member (get (car widget) 'widget-type) property))
508 (t nil)))
510 (defun widget-value (widget)
511 "Extract the current value of WIDGET."
512 (widget-apply widget
513 :value-to-external (widget-apply widget :value-get)))
515 (defun widget-value-set (widget value)
516 "Set the current value of WIDGET to VALUE."
517 (widget-apply widget
518 :value-set (widget-apply widget
519 :value-to-internal value)))
521 (defun widget-default-get (widget)
522 "Extract the default external value of WIDGET."
523 (widget-apply widget :value-to-external
524 (or (widget-get widget :value)
525 (widget-apply widget :default-get))))
527 (defun widget-match-inline (widget vals)
528 "In WIDGET, match the start of VALS."
529 (cond ((widget-get widget :inline)
530 (widget-apply widget :match-inline vals))
531 ((and (listp vals)
532 (widget-apply widget :match (car vals)))
533 (cons (list (car vals)) (cdr vals)))
534 (t nil)))
536 (defun widget-apply-action (widget &optional event)
537 "Apply :action in WIDGET in response to EVENT."
538 (if (widget-apply widget :active)
539 (widget-apply widget :action event)
540 (error "Attempt to perform action on inactive widget")))
542 ;;; Helper functions.
544 ;; These are widget specific.
546 ;;;###autoload
547 (defun widget-prompt-value (widget prompt &optional value unbound)
548 "Prompt for a value matching WIDGET, using PROMPT.
549 The current value is assumed to be VALUE, unless UNBOUND is non-nil."
550 (unless (listp widget)
551 (setq widget (list widget)))
552 (setq prompt (format "[%s] %s" (widget-type widget) prompt))
553 (setq widget (widget-convert widget))
554 (let ((answer (widget-apply widget :prompt-value prompt value unbound)))
555 (unless (widget-apply widget :match answer)
556 (error "Value does not match %S type" (car widget)))
557 answer))
559 (defun widget-get-sibling (widget)
560 "Get the item WIDGET is assumed to toggle.
561 This is only meaningful for radio buttons or checkboxes in a list."
562 (let* ((children (widget-get (widget-get widget :parent) :children))
563 child)
564 (catch 'child
565 (while children
566 (setq child (car children)
567 children (cdr children))
568 (when (eq (widget-get child :button) widget)
569 (throw 'child child)))
570 nil)))
572 (defun widget-map-buttons (function &optional buffer maparg)
573 "Map FUNCTION over the buttons in BUFFER.
574 FUNCTION is called with the arguments WIDGET and MAPARG.
576 If FUNCTION returns non-nil, the walk is cancelled.
578 The arguments MAPARG, and BUFFER default to nil and (current-buffer),
579 respectively."
580 (let ((cur (point-min))
581 (widget nil)
582 (overlays (if buffer
583 (with-current-buffer buffer (overlay-lists))
584 (overlay-lists))))
585 (setq overlays (append (car overlays) (cdr overlays)))
586 (while (setq cur (pop overlays))
587 (setq widget (overlay-get cur 'button))
588 (if (and widget (funcall function widget maparg))
589 (setq overlays nil)))))
591 ;;; Images.
593 (defcustom widget-image-directory (file-name-as-directory
594 (expand-file-name "custom" data-directory))
595 "Where widget button images are located.
596 If this variable is nil, widget will try to locate the directory
597 automatically."
598 :group 'widgets
599 :type 'directory)
601 (defcustom widget-image-enable t
602 "If non-nil, use image buttons in widgets when available."
603 :version "21.1"
604 :group 'widgets
605 :type 'boolean)
607 (defcustom widget-image-conversion
608 '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg")
609 (xbm ".xbm"))
610 "Conversion alist from image formats to file name suffixes."
611 :group 'widgets
612 :type '(repeat (cons :format "%v"
613 (symbol :tag "Image Format" unknown)
614 (repeat :tag "Suffixes"
615 (string :format "%v")))))
617 (defun widget-image-find (image)
618 "Create a graphical button from IMAGE.
619 IMAGE should either already be an image, or be a file name sans
620 extension (xpm, xbm, gif, jpg, or png) located in
621 `widget-image-directory' or otherwise where `find-image' will find it."
622 (cond ((not (and image widget-image-enable (display-graphic-p)))
623 ;; We don't want or can't use images.
624 nil)
625 ((and (consp image)
626 (eq 'image (car image)))
627 ;; Already an image spec. Use it.
628 image)
629 ((stringp image)
630 ;; A string. Look it up in relevant directories.
631 (let* ((load-path (cons widget-image-directory load-path))
632 specs)
633 (dolist (elt widget-image-conversion)
634 (dolist (ext (cdr elt))
635 (push (list :type (car elt) :file (concat image ext)) specs)))
636 (setq specs (nreverse specs))
637 (find-image specs)))
639 ;; Oh well.
640 nil)))
642 (defvar widget-button-pressed-face 'widget-button-pressed
643 "Face used for pressed buttons in widgets.
644 This exists as a variable so it can be set locally in certain
645 buffers.")
647 (defun widget-image-insert (widget tag image &optional down inactive)
648 "In WIDGET, insert the text TAG or, if supported, IMAGE.
649 IMAGE should either be an image or an image file name sans extension
650 \(xpm, xbm, gif, jpg, or png) located in `widget-image-directory'.
652 Optional arguments DOWN and INACTIVE are used instead of IMAGE when the
653 button is pressed or inactive, respectively. These are currently ignored."
654 (if (and (display-graphic-p)
655 (setq image (widget-image-find image)))
656 (progn (widget-put widget :suppress-face t)
657 (insert-image image
658 (propertize
659 tag 'mouse-face widget-button-pressed-face)))
660 (insert tag)))
662 (defun widget-move-and-invoke (event)
663 "Move to where you click, and if it is an active field, invoke it."
664 (interactive "e")
665 (mouse-set-point event)
666 (let ((pos (widget-event-point event)))
667 (if (and pos (get-char-property pos 'button))
668 (widget-button-click event))))
670 ;;; Buttons.
672 (defgroup widget-button nil
673 "The look of various kinds of buttons."
674 :group 'widgets)
676 (defcustom widget-button-prefix ""
677 "String used as prefix for buttons."
678 :type 'string
679 :group 'widget-button)
681 (defcustom widget-button-suffix ""
682 "String used as suffix for buttons."
683 :type 'string
684 :group 'widget-button)
686 ;;; Creating Widgets.
688 ;;;###autoload
689 (defun widget-create (type &rest args)
690 "Create widget of TYPE.
691 The optional ARGS are additional keyword arguments."
692 (let ((widget (apply 'widget-convert type args)))
693 (widget-apply widget :create)
694 widget))
696 (defun widget-create-child-and-convert (parent type &rest args)
697 "As part of the widget PARENT, create a child widget TYPE.
698 The child is converted, using the keyword arguments ARGS."
699 (let ((widget (apply 'widget-convert type args)))
700 (widget-put widget :parent parent)
701 (unless (widget-get widget :indent)
702 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
703 (or (widget-get widget :extra-offset) 0)
704 (widget-get parent :offset))))
705 (widget-apply widget :create)
706 widget))
708 (defun widget-create-child (parent type)
709 "Create widget of TYPE."
710 (let ((widget (widget-copy type)))
711 (widget-put widget :parent parent)
712 (unless (widget-get widget :indent)
713 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
714 (or (widget-get widget :extra-offset) 0)
715 (widget-get parent :offset))))
716 (widget-apply widget :create)
717 widget))
719 (defun widget-create-child-value (parent type value)
720 "Create widget of TYPE with value VALUE."
721 (let ((widget (widget-copy type)))
722 (widget-put widget :value (widget-apply widget :value-to-internal value))
723 (widget-put widget :parent parent)
724 (unless (widget-get widget :indent)
725 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
726 (or (widget-get widget :extra-offset) 0)
727 (widget-get parent :offset))))
728 (widget-apply widget :create)
729 widget))
731 ;;;###autoload
732 (defun widget-delete (widget)
733 "Delete WIDGET."
734 (widget-apply widget :delete))
736 (defun widget-copy (widget)
737 "Make a deep copy of WIDGET."
738 (widget-apply (copy-sequence widget) :copy))
740 (defun widget-convert (type &rest args)
741 "Convert TYPE to a widget without inserting it in the buffer.
742 The optional ARGS are additional keyword arguments."
743 ;; Don't touch the type.
744 (let* ((widget (if (symbolp type)
745 (list type)
746 (copy-sequence type)))
747 (current widget)
748 done
749 (keys args))
750 ;; First set the :args keyword.
751 (while (cdr current) ;Look in the type.
752 (if (and (keywordp (cadr current))
753 ;; If the last element is a keyword,
754 ;; it is still the :args element,
755 ;; even though it is a keyword.
756 (cddr current))
757 (if (eq (cadr current) :args)
758 ;; If :args is explicitly specified, obey it.
759 (setq current nil)
760 ;; Some other irrelevant keyword.
761 (setq current (cdr (cdr current))))
762 (setcdr current (list :args (cdr current)))
763 (setq current nil)))
764 (while (and args (not done)) ;Look in ARGS.
765 (cond ((eq (car args) :args)
766 ;; Handle explicit specification of :args.
767 (setq args (cadr args)
768 done t))
769 ((keywordp (car args))
770 (setq args (cddr args)))
771 (t (setq done t))))
772 (when done
773 (widget-put widget :args args))
774 ;; Then Convert the widget.
775 (setq type widget)
776 (while type
777 (let ((convert-widget (plist-get (cdr type) :convert-widget)))
778 (if convert-widget
779 (setq widget (funcall convert-widget widget))))
780 (setq type (get (car type) 'widget-type)))
781 ;; Finally set the keyword args.
782 (while keys
783 (let ((next (nth 0 keys)))
784 (if (keywordp next)
785 (progn
786 (widget-put widget next (nth 1 keys))
787 (setq keys (nthcdr 2 keys)))
788 (setq keys nil))))
789 ;; Convert the :value to internal format.
790 (if (widget-member widget :value)
791 (widget-put widget
792 :value (widget-apply widget
793 :value-to-internal
794 (widget-get widget :value))))
795 ;; Return the newly create widget.
796 widget))
798 ;;;###autoload
799 (defun widget-insert (&rest args)
800 "Call `insert' with ARGS even if surrounding text is read only."
801 (let ((inhibit-read-only t)
802 (inhibit-modification-hooks t))
803 (apply 'insert args)))
805 (defun widget-convert-text (type from to
806 &optional button-from button-to
807 &rest args)
808 "Return a widget of type TYPE with endpoint FROM TO.
809 No text will be inserted to the buffer, instead the text between FROM
810 and TO will be used as the widgets end points. If optional arguments
811 BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets
812 button end points.
813 Optional ARGS are extra keyword arguments for TYPE."
814 (let ((widget (apply 'widget-convert type :delete 'widget-leave-text args))
815 (from (copy-marker from))
816 (to (copy-marker to)))
817 (set-marker-insertion-type from t)
818 (set-marker-insertion-type to nil)
819 (widget-put widget :from from)
820 (widget-put widget :to to)
821 (when button-from
822 (widget-specify-button widget button-from button-to))
823 widget))
825 (defun widget-convert-button (type from to &rest args)
826 "Return a widget of type TYPE with endpoint FROM TO.
827 Optional ARGS are extra keyword arguments for TYPE.
828 No text will be inserted to the buffer, instead the text between FROM
829 and TO will be used as the widgets end points, as well as the widgets
830 button end points."
831 (apply 'widget-convert-text type from to from to args))
833 (defun widget-leave-text (widget)
834 "Remove markers and overlays from WIDGET and its children."
835 (let ((button (widget-get widget :button-overlay))
836 (sample (widget-get widget :sample-overlay))
837 (doc (widget-get widget :doc-overlay))
838 (field (widget-get widget :field-overlay)))
839 (set-marker (widget-get widget :from) nil)
840 (set-marker (widget-get widget :to) nil)
841 (when button
842 (delete-overlay button))
843 (when sample
844 (delete-overlay sample))
845 (when doc
846 (delete-overlay doc))
847 (when field
848 (delete-overlay field))
849 (mapc 'widget-leave-text (widget-get widget :children))))
851 ;;; Keymap and Commands.
853 ;;;###autoload
854 (defalias 'advertised-widget-backward 'widget-backward)
856 ;;;###autoload
857 (defvar widget-keymap
858 (let ((map (make-sparse-keymap)))
859 (define-key map "\t" 'widget-forward)
860 (define-key map "\e\t" 'widget-backward)
861 (define-key map [(shift tab)] 'advertised-widget-backward)
862 (define-key map [backtab] 'widget-backward)
863 (define-key map [down-mouse-2] 'widget-button-click)
864 (define-key map [down-mouse-1] 'widget-button-click)
865 (define-key map "\C-m" 'widget-button-press)
866 map)
867 "Keymap containing useful binding for buffers containing widgets.
868 Recommended as a parent keymap for modes using widgets.")
870 (defvar widget-global-map global-map
871 "Keymap used for events a widget does not handle itself.")
872 (make-variable-buffer-local 'widget-global-map)
874 (defvar widget-field-keymap
875 (let ((map (copy-keymap widget-keymap)))
876 (define-key map "\C-k" 'widget-kill-line)
877 (define-key map "\M-\t" 'widget-complete)
878 (define-key map "\C-m" 'widget-field-activate)
879 ;; Since the widget code uses a `field' property to identify fields,
880 ;; ordinary beginning-of-line does the right thing.
881 ;; (define-key map "\C-a" 'widget-beginning-of-line)
882 (define-key map "\C-e" 'widget-end-of-line)
883 map)
884 "Keymap used inside an editable field.")
886 (defvar widget-text-keymap
887 (let ((map (copy-keymap widget-keymap)))
888 ;; Since the widget code uses a `field' property to identify fields,
889 ;; ordinary beginning-of-line does the right thing.
890 ;; (define-key map "\C-a" 'widget-beginning-of-line)
891 (define-key map "\C-e" 'widget-end-of-line)
892 map)
893 "Keymap used inside a text field.")
895 (defun widget-field-activate (pos &optional event)
896 "Invoke the editable field at point."
897 (interactive "@d")
898 (let ((field (widget-field-at pos)))
899 (if field
900 (widget-apply-action field event)
901 (call-interactively
902 (lookup-key widget-global-map (this-command-keys))))))
904 (defface widget-button-pressed
905 '((((min-colors 88) (class color))
906 (:foreground "red1"))
907 (((class color))
908 (:foreground "red"))
910 (:weight bold :underline t)))
911 "Face used for pressed buttons."
912 :group 'widget-faces)
913 ;; backward-compatibility alias
914 (put 'widget-button-pressed-face 'face-alias 'widget-button-pressed)
916 (defvar widget-button-click-moves-point nil
917 "If non-nil, `widget-button-click' moves point to a button after invoking it.
918 If nil, point returns to its original position after invoking a button.")
920 (defun widget-button-click (event)
921 "Invoke the button that the mouse is pointing at."
922 (interactive "e")
923 (if (widget-event-point event)
924 (let* ((oevent event)
925 (mouse-1 (memq (event-basic-type event) '(mouse-1 down-mouse-1)))
926 (pos (widget-event-point event))
927 (start (event-start event))
928 (button (get-char-property
929 pos 'button (and (windowp (posn-window start))
930 (window-buffer (posn-window start)))))
931 newpoint)
932 (when (or (null button)
933 (catch 'button-press-cancelled
934 ;; Mouse click on a widget button. Do the following
935 ;; in a save-excursion so that the click on the button
936 ;; doesn't change point.
937 (save-selected-window
938 (select-window (posn-window (event-start event)))
939 (save-excursion
940 (goto-char (posn-point (event-start event)))
941 (let* ((overlay (widget-get button :button-overlay))
942 (pressed-face (or (widget-get button :pressed-face)
943 widget-button-pressed-face))
944 (face (overlay-get overlay 'face))
945 (mouse-face (overlay-get overlay 'mouse-face)))
946 (unwind-protect
947 ;; Read events, including mouse-movement
948 ;; events, waiting for a release event. If we
949 ;; began with a mouse-1 event and receive a
950 ;; movement event, that means the user wants
951 ;; to perform drag-selection, so cancel the
952 ;; button press and do the default mouse-1
953 ;; action. For mouse-2, just highlight/
954 ;; unhighlight the button the mouse was
955 ;; initially on when we move over it.
956 (save-excursion
957 (when face ; avoid changing around image
958 (overlay-put overlay 'face pressed-face)
959 (overlay-put overlay 'mouse-face pressed-face))
960 (unless (widget-apply button :mouse-down-action event)
961 (let ((track-mouse t))
962 (while (not (widget-button-release-event-p event))
963 (setq event (read-event))
964 (when (and mouse-1 (mouse-movement-p event))
965 (push event unread-command-events)
966 (setq event oevent)
967 (throw 'button-press-cancelled t))
968 (unless (or (integerp event)
969 (memq (car event) '(switch-frame select-window))
970 (eq (car event) 'scroll-bar-movement))
971 (setq pos (widget-event-point event))
972 (if (and pos
973 (eq (get-char-property pos 'button)
974 button))
975 (when face
976 (overlay-put overlay 'face pressed-face)
977 (overlay-put overlay 'mouse-face pressed-face))
978 (overlay-put overlay 'face face)
979 (overlay-put overlay 'mouse-face mouse-face))))))
981 ;; When mouse is released over the button, run
982 ;; its action function.
983 (when (and pos (eq (get-char-property pos 'button) button))
984 (goto-char pos)
985 (widget-apply-action button event)
986 (if widget-button-click-moves-point
987 (setq newpoint (point)))))
988 (overlay-put overlay 'face face)
989 (overlay-put overlay 'mouse-face mouse-face))))
991 (if newpoint (goto-char newpoint))
992 ;; This loses if the widget action switches windows. -- cyd
993 ;; (unless (pos-visible-in-window-p (widget-event-point event))
994 ;; (mouse-set-point event)
995 ;; (beginning-of-line)
996 ;; (recenter))
998 nil))
999 (let ((up t) command)
1000 ;; Mouse click not on a widget button. Find the global
1001 ;; command to run, and check whether it is bound to an
1002 ;; up event.
1003 (if mouse-1
1004 (cond ((setq command ;down event
1005 (lookup-key widget-global-map [down-mouse-1]))
1006 (setq up nil))
1007 ((setq command ;up event
1008 (lookup-key widget-global-map [mouse-1]))))
1009 (cond ((setq command ;down event
1010 (lookup-key widget-global-map [down-mouse-2]))
1011 (setq up nil))
1012 ((setq command ;up event
1013 (lookup-key widget-global-map [mouse-2])))))
1014 (when up
1015 ;; Don't execute up events twice.
1016 (while (not (widget-button-release-event-p event))
1017 (setq event (read-event))))
1018 (when command
1019 (call-interactively command)))))
1020 (message "You clicked somewhere weird.")))
1022 (defun widget-button-press (pos &optional event)
1023 "Invoke button at POS."
1024 (interactive "@d")
1025 (let ((button (get-char-property pos 'button)))
1026 (if button
1027 (widget-apply-action button event)
1028 (let ((command (lookup-key widget-global-map (this-command-keys))))
1029 (when (commandp command)
1030 (call-interactively command))))))
1032 (defun widget-tabable-at (&optional pos)
1033 "Return the tabable widget at POS, or nil.
1034 POS defaults to the value of (point)."
1035 (let ((widget (widget-at pos)))
1036 (if widget
1037 (let ((order (widget-get widget :tab-order)))
1038 (if order
1039 (if (>= order 0)
1040 widget)
1041 widget)))))
1043 (defvar widget-use-overlay-change t
1044 "If non-nil, use overlay change functions to tab around in the buffer.
1045 This is much faster, but doesn't work reliably on Emacs 19.34.")
1047 (defun widget-move (arg)
1048 "Move point to the ARG next field or button.
1049 ARG may be negative to move backward."
1050 (or (bobp) (> arg 0) (backward-char))
1051 (let ((wrapped 0)
1052 (number arg)
1053 (old (widget-tabable-at)))
1054 ;; Forward.
1055 (while (> arg 0)
1056 (cond ((eobp)
1057 (goto-char (point-min))
1058 (setq wrapped (1+ wrapped)))
1059 (widget-use-overlay-change
1060 (goto-char (next-overlay-change (point))))
1062 (forward-char 1)))
1063 (and (= wrapped 2)
1064 (eq arg number)
1065 (error "No buttons or fields found"))
1066 (let ((new (widget-tabable-at)))
1067 (when new
1068 (unless (eq new old)
1069 (setq arg (1- arg))
1070 (setq old new)))))
1071 ;; Backward.
1072 (while (< arg 0)
1073 (cond ((bobp)
1074 (goto-char (point-max))
1075 (setq wrapped (1+ wrapped)))
1076 (widget-use-overlay-change
1077 (goto-char (previous-overlay-change (point))))
1079 (backward-char 1)))
1080 (and (= wrapped 2)
1081 (eq arg number)
1082 (error "No buttons or fields found"))
1083 (let ((new (widget-tabable-at)))
1084 (when new
1085 (unless (eq new old)
1086 (setq arg (1+ arg))))))
1087 (let ((new (widget-tabable-at)))
1088 (while (eq (widget-tabable-at) new)
1089 (backward-char)))
1090 (forward-char))
1091 (widget-echo-help (point))
1092 (run-hooks 'widget-move-hook))
1094 (defun widget-forward (arg)
1095 "Move point to the next field or button.
1096 With optional ARG, move across that many fields."
1097 (interactive "p")
1098 (run-hooks 'widget-forward-hook)
1099 (widget-move arg))
1101 (defun widget-backward (arg)
1102 "Move point to the previous field or button.
1103 With optional ARG, move across that many fields."
1104 (interactive "p")
1105 (run-hooks 'widget-backward-hook)
1106 (widget-move (- arg)))
1108 ;; Since the widget code uses a `field' property to identify fields,
1109 ;; ordinary beginning-of-line does the right thing.
1110 (defalias 'widget-beginning-of-line 'beginning-of-line)
1112 (defun widget-end-of-line ()
1113 "Go to end of field or end of line, whichever is first.
1114 Trailing spaces at the end of padded fields are not considered part of
1115 the field."
1116 (interactive)
1117 ;; Ordinary end-of-line does the right thing, because we're inside
1118 ;; text with a `field' property.
1119 (end-of-line)
1120 (unless (eolp)
1121 ;; ... except that we want to ignore trailing spaces in fields that
1122 ;; aren't terminated by a newline, because they are used as padding,
1123 ;; and ignored when extracting the entered value of the field.
1124 (skip-chars-backward " " (field-beginning (1- (point))))))
1126 (defun widget-kill-line ()
1127 "Kill to end of field or end of line, whichever is first."
1128 (interactive)
1129 (let* ((field (widget-field-find (point)))
1130 (end (and field (widget-field-end field))))
1131 (if (and field (> (line-beginning-position 2) end))
1132 (kill-region (point) end)
1133 (call-interactively 'kill-line))))
1135 (defcustom widget-complete-field (lookup-key global-map "\M-\t")
1136 "Default function to call for completion inside fields."
1137 :options '(ispell-complete-word complete-tag lisp-complete-symbol)
1138 :type 'function
1139 :group 'widgets)
1141 (defun widget-narrow-to-field ()
1142 "Narrow to field."
1143 (interactive)
1144 (let ((field (widget-field-find (point))))
1145 (if field
1146 (narrow-to-region (line-beginning-position) (line-end-position)))))
1148 (defun widget-complete ()
1149 "Complete content of editable field from point.
1150 When not inside a field, move to the previous button or field."
1151 (interactive)
1152 (let ((field (widget-field-find (point))))
1153 (if field
1154 (save-restriction
1155 (widget-narrow-to-field)
1156 (widget-apply field :complete))
1157 (error "Not in an editable field"))))
1159 ;;; Setting up the buffer.
1161 (defvar widget-field-new nil
1162 "List of all newly created editable fields in the buffer.")
1163 (make-variable-buffer-local 'widget-field-new)
1165 (defvar widget-field-list nil
1166 "List of all editable fields in the buffer.")
1167 (make-variable-buffer-local 'widget-field-list)
1169 (defun widget-at (&optional pos)
1170 "The button or field at POS (default, point)."
1171 (or (get-char-property (or pos (point)) 'button)
1172 (widget-field-at pos)))
1174 ;;;###autoload
1175 (defun widget-setup ()
1176 "Setup current buffer so editing string widgets works."
1177 (let ((inhibit-read-only t)
1178 (inhibit-modification-hooks t)
1179 field)
1180 (while widget-field-new
1181 (setq field (car widget-field-new)
1182 widget-field-new (cdr widget-field-new)
1183 widget-field-list (cons field widget-field-list))
1184 (let ((from (car (widget-get field :field-overlay)))
1185 (to (cdr (widget-get field :field-overlay))))
1186 (widget-specify-field field
1187 (marker-position from) (marker-position to))
1188 (set-marker from nil)
1189 (set-marker to nil))))
1190 (widget-clear-undo)
1191 (widget-add-change))
1193 (defvar widget-field-last nil)
1194 ;; Last field containing point.
1195 (make-variable-buffer-local 'widget-field-last)
1197 (defvar widget-field-was nil)
1198 ;; The widget data before the change.
1199 (make-variable-buffer-local 'widget-field-was)
1201 (defun widget-field-at (pos)
1202 "Return the widget field at POS, or nil if none."
1203 (let ((field (get-char-property (or pos (point)) 'field)))
1204 (if (eq field 'boundary)
1205 (get-char-property (or pos (point)) 'real-field)
1206 field)))
1208 (defun widget-field-buffer (widget)
1209 "Return the buffer of WIDGET's editing field."
1210 (let ((overlay (widget-get widget :field-overlay)))
1211 (cond ((overlayp overlay)
1212 (overlay-buffer overlay))
1213 ((consp overlay)
1214 (marker-buffer (car overlay))))))
1216 (defun widget-field-start (widget)
1217 "Return the start of WIDGET's editing field."
1218 (let ((overlay (widget-get widget :field-overlay)))
1219 (if (overlayp overlay)
1220 (overlay-start overlay)
1221 (car overlay))))
1223 (defun widget-field-end (widget)
1224 "Return the end of WIDGET's editing field."
1225 (let ((overlay (widget-get widget :field-overlay)))
1226 ;; Don't subtract one if local-map works at the end of the overlay,
1227 ;; or if a special `boundary' field has been added after the widget
1228 ;; field.
1229 (if (overlayp overlay)
1230 ;; Don't proceed if overlay has been removed from buffer.
1231 (when (overlay-buffer overlay)
1232 (if (and (not (eq (with-current-buffer
1233 (widget-field-buffer widget)
1234 (save-restriction
1235 ;; `widget-narrow-to-field' can be
1236 ;; active when this function is called
1237 ;; from an change-functions hook. So
1238 ;; temporarily remove field narrowing
1239 ;; before to call `get-char-property'.
1240 (widen)
1241 (get-char-property (overlay-end overlay)
1242 'field)))
1243 'boundary))
1244 (or widget-field-add-space
1245 (null (widget-get widget :size))))
1246 (1- (overlay-end overlay))
1247 (overlay-end overlay)))
1248 (cdr overlay))))
1250 (defun widget-field-find (pos)
1251 "Return the field at POS.
1252 Unlike (get-char-property POS 'field), this works with empty fields too."
1253 (let ((fields widget-field-list)
1254 field found)
1255 (while fields
1256 (setq field (car fields)
1257 fields (cdr fields))
1258 (when (and (<= (widget-field-start field) pos)
1259 (<= pos (widget-field-end field)))
1260 (when found
1261 (error "Overlapping fields"))
1262 (setq found field)))
1263 found))
1265 (defun widget-before-change (from to)
1266 ;; This is how, for example, a variable changes its state to `modified'.
1267 ;; when it is being edited.
1268 (unless inhibit-read-only
1269 (let ((from-field (widget-field-find from))
1270 (to-field (widget-field-find to)))
1271 (cond ((not (eq from-field to-field))
1272 (add-hook 'post-command-hook 'widget-add-change nil t)
1273 (signal 'text-read-only
1274 '("Change should be restricted to a single field")))
1275 ((null from-field)
1276 (add-hook 'post-command-hook 'widget-add-change nil t)
1277 (signal 'text-read-only
1278 '("Attempt to change text outside editable field")))
1279 (widget-field-use-before-change
1280 (widget-apply from-field :notify from-field))))))
1282 (defun widget-add-change ()
1283 (remove-hook 'post-command-hook 'widget-add-change t)
1284 (add-hook 'before-change-functions 'widget-before-change nil t)
1285 (add-hook 'after-change-functions 'widget-after-change nil t))
1287 (defun widget-after-change (from to old)
1288 "Adjust field size and text properties."
1289 (let ((field (widget-field-find from))
1290 (other (widget-field-find to)))
1291 (when field
1292 (unless (eq field other)
1293 (error "Change in different fields"))
1294 (let ((size (widget-get field :size)))
1295 (when size
1296 (let ((begin (widget-field-start field))
1297 (end (widget-field-end field)))
1298 (cond ((< (- end begin) size)
1299 ;; Field too small.
1300 (save-excursion
1301 (goto-char end)
1302 (insert-char ?\s (- (+ begin size) end))))
1303 ((> (- end begin) size)
1304 ;; Field too large and
1305 (if (or (< (point) (+ begin size))
1306 (> (point) end))
1307 ;; Point is outside extra space.
1308 (setq begin (+ begin size))
1309 ;; Point is within the extra space.
1310 (setq begin (point)))
1311 (save-excursion
1312 (goto-char end)
1313 (while (and (eq (preceding-char) ?\s)
1314 (> (point) begin))
1315 (delete-backward-char 1)))))))
1316 (widget-specify-secret field))
1317 (widget-apply field :notify field))))
1319 ;;; Widget Functions
1321 ;; These functions are used in the definition of multiple widgets.
1323 (defun widget-parent-action (widget &optional event)
1324 "Tell :parent of WIDGET to handle the :action.
1325 Optional EVENT is the event that triggered the action."
1326 (widget-apply (widget-get widget :parent) :action event))
1328 (defun widget-children-value-delete (widget)
1329 "Delete all :children and :buttons in WIDGET."
1330 (mapc 'widget-delete (widget-get widget :children))
1331 (widget-put widget :children nil)
1332 (mapc 'widget-delete (widget-get widget :buttons))
1333 (widget-put widget :buttons nil))
1335 (defun widget-children-validate (widget)
1336 "All the :children must be valid."
1337 (let ((children (widget-get widget :children))
1338 child found)
1339 (while (and children (not found))
1340 (setq child (car children)
1341 children (cdr children)
1342 found (widget-apply child :validate)))
1343 found))
1345 (defun widget-child-value-get (widget)
1346 "Get the value of the first member of :children in WIDGET."
1347 (widget-value (car (widget-get widget :children))))
1349 (defun widget-child-value-inline (widget)
1350 "Get the inline value of the first member of :children in WIDGET."
1351 (widget-apply (car (widget-get widget :children)) :value-inline))
1353 (defun widget-child-validate (widget)
1354 "The result of validating the first member of :children in WIDGET."
1355 (widget-apply (car (widget-get widget :children)) :validate))
1357 (defun widget-type-value-create (widget)
1358 "Convert and instantiate the value of the :type attribute of WIDGET.
1359 Store the newly created widget in the :children attribute.
1361 The value of the :type attribute should be an unconverted widget type."
1362 (let ((value (widget-get widget :value))
1363 (type (widget-get widget :type)))
1364 (widget-put widget :children
1365 (list (widget-create-child-value widget
1366 (widget-convert type)
1367 value)))))
1369 (defun widget-type-default-get (widget)
1370 "Get default value from the :type attribute of WIDGET.
1372 The value of the :type attribute should be an unconverted widget type."
1373 (widget-default-get (widget-convert (widget-get widget :type))))
1375 (defun widget-type-match (widget value)
1376 "Non-nil if the :type value of WIDGET matches VALUE.
1378 The value of the :type attribute should be an unconverted widget type."
1379 (widget-apply (widget-convert (widget-get widget :type)) :match value))
1381 (defun widget-types-copy (widget)
1382 "Copy :args as widget types in WIDGET."
1383 (widget-put widget :args (mapcar 'widget-copy (widget-get widget :args)))
1384 widget)
1386 ;; Made defsubst to speed up face editor creation.
1387 (defsubst widget-types-convert-widget (widget)
1388 "Convert :args as widget types in WIDGET."
1389 (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args)))
1390 widget)
1392 (defun widget-value-convert-widget (widget)
1393 "Initialize :value from :args in WIDGET."
1394 (let ((args (widget-get widget :args)))
1395 (when args
1396 (widget-put widget :value (car args))
1397 ;; Don't convert :value here, as this is done in `widget-convert'.
1398 ;; (widget-put widget :value (widget-apply widget
1399 ;; :value-to-internal (car args)))
1400 (widget-put widget :args nil)))
1401 widget)
1403 (defun widget-value-value-get (widget)
1404 "Return the :value property of WIDGET."
1405 (widget-get widget :value))
1407 ;;; The `default' Widget.
1409 (define-widget 'default nil
1410 "Basic widget other widgets are derived from."
1411 :value-to-internal (lambda (widget value) value)
1412 :value-to-external (lambda (widget value) value)
1413 :button-prefix 'widget-button-prefix
1414 :button-suffix 'widget-button-suffix
1415 :complete 'widget-default-complete
1416 :create 'widget-default-create
1417 :indent nil
1418 :offset 0
1419 :format-handler 'widget-default-format-handler
1420 :button-face-get 'widget-default-button-face-get
1421 :mouse-face-get 'widget-default-mouse-face-get
1422 :sample-face-get 'widget-default-sample-face-get
1423 :delete 'widget-default-delete
1424 :copy 'identity
1425 :value-set 'widget-default-value-set
1426 :value-inline 'widget-default-value-inline
1427 :value-delete 'ignore
1428 :default-get 'widget-default-default-get
1429 :menu-tag-get 'widget-default-menu-tag-get
1430 :validate #'ignore
1431 :active 'widget-default-active
1432 :activate 'widget-specify-active
1433 :deactivate 'widget-default-deactivate
1434 :mouse-down-action #'ignore
1435 :action 'widget-default-action
1436 :notify 'widget-default-notify
1437 :prompt-value 'widget-default-prompt-value)
1439 (defun widget-default-complete (widget)
1440 "Call the value of the :complete-function property of WIDGET.
1441 If that does not exists, call the value of `widget-complete-field'."
1442 (call-interactively (or (widget-get widget :complete-function)
1443 widget-complete-field)))
1445 (defun widget-default-create (widget)
1446 "Create WIDGET at point in the current buffer."
1447 (widget-specify-insert
1448 (let ((from (point))
1449 button-begin button-end
1450 sample-begin sample-end
1451 doc-begin doc-end
1452 value-pos)
1453 (insert (widget-get widget :format))
1454 (goto-char from)
1455 ;; Parse escapes in format.
1456 (while (re-search-forward "%\\(.\\)" nil t)
1457 (let ((escape (char-after (match-beginning 1))))
1458 (delete-backward-char 2)
1459 (cond ((eq escape ?%)
1460 (insert ?%))
1461 ((eq escape ?\[)
1462 (setq button-begin (point))
1463 (insert (widget-get-indirect widget :button-prefix)))
1464 ((eq escape ?\])
1465 (insert (widget-get-indirect widget :button-suffix))
1466 (setq button-end (point)))
1467 ((eq escape ?\{)
1468 (setq sample-begin (point)))
1469 ((eq escape ?\})
1470 (setq sample-end (point)))
1471 ((eq escape ?n)
1472 (when (widget-get widget :indent)
1473 (insert ?\n)
1474 (insert-char ?\s (widget-get widget :indent))))
1475 ((eq escape ?t)
1476 (let ((image (widget-get widget :tag-glyph))
1477 (tag (widget-get widget :tag)))
1478 (cond (image
1479 (widget-image-insert widget (or tag "image") image))
1480 (tag
1481 (insert tag))
1483 (princ (widget-get widget :value)
1484 (current-buffer))))))
1485 ((eq escape ?d)
1486 (let ((doc (widget-get widget :doc)))
1487 (when doc
1488 (setq doc-begin (point))
1489 (insert doc)
1490 (while (eq (preceding-char) ?\n)
1491 (delete-backward-char 1))
1492 (insert ?\n)
1493 (setq doc-end (point)))))
1494 ((eq escape ?v)
1495 (if (and button-begin (not button-end))
1496 (widget-apply widget :value-create)
1497 (setq value-pos (point))))
1499 (widget-apply widget :format-handler escape)))))
1500 ;; Specify button, sample, and doc, and insert value.
1501 (and button-begin button-end
1502 (widget-specify-button widget button-begin button-end))
1503 (and sample-begin sample-end
1504 (widget-specify-sample widget sample-begin sample-end))
1505 (and doc-begin doc-end
1506 (widget-specify-doc widget doc-begin doc-end))
1507 (when value-pos
1508 (goto-char value-pos)
1509 (widget-apply widget :value-create)))
1510 (let ((from (point-min-marker))
1511 (to (point-max-marker)))
1512 (set-marker-insertion-type from t)
1513 (set-marker-insertion-type to nil)
1514 (widget-put widget :from from)
1515 (widget-put widget :to to)))
1516 (widget-clear-undo))
1518 (defun widget-default-format-handler (widget escape)
1519 ;; We recognize the %h escape by default.
1520 (let* ((buttons (widget-get widget :buttons)))
1521 (cond ((eq escape ?h)
1522 (let* ((doc-property (widget-get widget :documentation-property))
1523 (doc-try (cond ((widget-get widget :doc))
1524 ((functionp doc-property)
1525 (funcall doc-property
1526 (widget-get widget :value)))
1527 ((symbolp doc-property)
1528 (documentation-property
1529 (widget-get widget :value)
1530 doc-property))))
1531 (doc-text (and (stringp doc-try)
1532 (> (length doc-try) 1)
1533 doc-try))
1534 (doc-indent (widget-get widget :documentation-indent)))
1535 (when doc-text
1536 (and (eq (preceding-char) ?\n)
1537 (widget-get widget :indent)
1538 (insert-char ?\s (widget-get widget :indent)))
1539 ;; The `*' in the beginning is redundant.
1540 (when (eq (aref doc-text 0) ?*)
1541 (setq doc-text (substring doc-text 1)))
1542 ;; Get rid of trailing newlines.
1543 (when (string-match "\n+\\'" doc-text)
1544 (setq doc-text (substring doc-text 0 (match-beginning 0))))
1545 (push (widget-create-child-and-convert
1546 widget 'documentation-string
1547 :indent (cond ((numberp doc-indent )
1548 doc-indent)
1549 ((null doc-indent)
1550 nil)
1551 (t 0))
1552 doc-text)
1553 buttons))))
1555 (error "Unknown escape `%c'" escape)))
1556 (widget-put widget :buttons buttons)))
1558 (defun widget-default-button-face-get (widget)
1559 ;; Use :button-face or widget-button-face
1560 (or (widget-get widget :button-face)
1561 (let ((parent (widget-get widget :parent)))
1562 (if parent
1563 (widget-apply parent :button-face-get)
1564 widget-button-face))))
1566 (defun widget-default-mouse-face-get (widget)
1567 ;; Use :mouse-face or widget-mouse-face
1568 (or (widget-get widget :mouse-face)
1569 (let ((parent (widget-get widget :parent)))
1570 (if parent
1571 (widget-apply parent :mouse-face-get)
1572 widget-mouse-face))))
1574 (defun widget-default-sample-face-get (widget)
1575 ;; Use :sample-face.
1576 (widget-get widget :sample-face))
1578 (defun widget-default-delete (widget)
1579 "Remove widget from the buffer."
1580 (let ((from (widget-get widget :from))
1581 (to (widget-get widget :to))
1582 (inactive-overlay (widget-get widget :inactive))
1583 (button-overlay (widget-get widget :button-overlay))
1584 (sample-overlay (widget-get widget :sample-overlay))
1585 (doc-overlay (widget-get widget :doc-overlay))
1586 (inhibit-modification-hooks t)
1587 (inhibit-read-only t))
1588 (widget-apply widget :value-delete)
1589 (widget-children-value-delete widget)
1590 (when inactive-overlay
1591 (delete-overlay inactive-overlay))
1592 (when button-overlay
1593 (delete-overlay button-overlay))
1594 (when sample-overlay
1595 (delete-overlay sample-overlay))
1596 (when doc-overlay
1597 (delete-overlay doc-overlay))
1598 (when (< from to)
1599 ;; Kludge: this doesn't need to be true for empty formats.
1600 (delete-region from to))
1601 (set-marker from nil)
1602 (set-marker to nil))
1603 (widget-clear-undo))
1605 (defun widget-default-value-set (widget value)
1606 "Recreate widget with new value."
1607 (let* ((old-pos (point))
1608 (from (copy-marker (widget-get widget :from)))
1609 (to (copy-marker (widget-get widget :to)))
1610 (offset (if (and (<= from old-pos) (<= old-pos to))
1611 (if (>= old-pos (1- to))
1612 (- old-pos to 1)
1613 (- old-pos from)))))
1614 ;;??? Bug: this ought to insert the new value before deleting the old one,
1615 ;; so that markers on either side of the value automatically
1616 ;; stay on the same side. -- rms.
1617 (save-excursion
1618 (goto-char (widget-get widget :from))
1619 (widget-apply widget :delete)
1620 (widget-put widget :value value)
1621 (widget-apply widget :create))
1622 (if offset
1623 (if (< offset 0)
1624 (goto-char (+ (widget-get widget :to) offset 1))
1625 (goto-char (min (+ from offset) (1- (widget-get widget :to))))))))
1627 (defun widget-default-value-inline (widget)
1628 "Wrap value in a list unless it is inline."
1629 (if (widget-get widget :inline)
1630 (widget-value widget)
1631 (list (widget-value widget))))
1633 (defun widget-default-default-get (widget)
1634 "Get `:value'."
1635 (widget-get widget :value))
1637 (defun widget-default-menu-tag-get (widget)
1638 "Use tag or value for menus."
1639 (or (widget-get widget :menu-tag)
1640 (widget-get widget :tag)
1641 (widget-princ-to-string (widget-get widget :value))))
1643 (defun widget-default-active (widget)
1644 "Return t iff this widget active (user modifiable)."
1645 (or (widget-get widget :always-active)
1646 (and (not (widget-get widget :inactive))
1647 (let ((parent (widget-get widget :parent)))
1648 (or (null parent)
1649 (widget-apply parent :active))))))
1651 (defun widget-default-deactivate (widget)
1652 "Make WIDGET inactive for user modifications."
1653 (widget-specify-inactive widget
1654 (widget-get widget :from)
1655 (widget-get widget :to)))
1657 (defun widget-default-action (widget &optional event)
1658 "Notify the parent when a widget changes."
1659 (let ((parent (widget-get widget :parent)))
1660 (when parent
1661 (widget-apply parent :notify widget event))))
1663 (defun widget-default-notify (widget child &optional event)
1664 "Pass notification to parent."
1665 (widget-default-action widget event))
1667 (defun widget-default-prompt-value (widget prompt value unbound)
1668 "Read an arbitrary value. Stolen from `set-variable'."
1669 ;; (let ((initial (if unbound
1670 ;; nil
1671 ;; It would be nice if we could do a `(cons val 1)' here.
1672 ;; (prin1-to-string (custom-quote value))))))
1673 (eval-minibuffer prompt))
1675 ;;; The `item' Widget.
1677 (define-widget 'item 'default
1678 "Constant items for inclusion in other widgets."
1679 :convert-widget 'widget-value-convert-widget
1680 :value-create 'widget-item-value-create
1681 :value-delete 'ignore
1682 :value-get 'widget-value-value-get
1683 :match 'widget-item-match
1684 :match-inline 'widget-item-match-inline
1685 :action 'widget-item-action
1686 :format "%t\n")
1688 (defun widget-item-value-create (widget)
1689 "Insert the printed representation of the value."
1690 (princ (widget-get widget :value) (current-buffer)))
1692 (defun widget-item-match (widget value)
1693 ;; Match if the value is the same.
1694 (equal (widget-get widget :value) value))
1696 (defun widget-item-match-inline (widget values)
1697 ;; Match if the value is the same.
1698 (let ((value (widget-get widget :value)))
1699 (and (listp value)
1700 (<= (length value) (length values))
1701 (let ((head (widget-sublist values 0 (length value))))
1702 (and (equal head value)
1703 (cons head (widget-sublist values (length value))))))))
1705 (defun widget-sublist (list start &optional end)
1706 "Return the sublist of LIST from START to END.
1707 If END is omitted, it defaults to the length of LIST."
1708 (if (> start 0) (setq list (nthcdr start list)))
1709 (if end
1710 (unless (<= end start)
1711 (setq list (copy-sequence list))
1712 (setcdr (nthcdr (- end start 1) list) nil)
1713 list)
1714 (copy-sequence list)))
1716 (defun widget-item-action (widget &optional event)
1717 ;; Just notify itself.
1718 (widget-apply widget :notify widget event))
1720 ;;; The `push-button' Widget.
1722 ;; (defcustom widget-push-button-gui t
1723 ;; "If non-nil, use GUI push buttons when available."
1724 ;; :group 'widgets
1725 ;; :type 'boolean)
1727 ;; Cache already created GUI objects.
1728 ;; (defvar widget-push-button-cache nil)
1730 (defcustom widget-push-button-prefix "["
1731 "String used as prefix for buttons."
1732 :type 'string
1733 :group 'widget-button)
1735 (defcustom widget-push-button-suffix "]"
1736 "String used as suffix for buttons."
1737 :type 'string
1738 :group 'widget-button)
1740 (define-widget 'push-button 'item
1741 "A pushable button."
1742 :button-prefix ""
1743 :button-suffix ""
1744 :value-create 'widget-push-button-value-create
1745 :format "%[%v%]")
1747 (defun widget-push-button-value-create (widget)
1748 "Insert text representing the `on' and `off' states."
1749 (let* ((tag (or (widget-get widget :tag)
1750 (widget-get widget :value)))
1751 (tag-glyph (widget-get widget :tag-glyph))
1752 (text (concat widget-push-button-prefix
1753 tag widget-push-button-suffix)))
1754 (if tag-glyph
1755 (widget-image-insert widget text tag-glyph)
1756 (insert text))))
1758 ;; (defun widget-gui-action (widget)
1759 ;; "Apply :action for WIDGET."
1760 ;; (widget-apply-action widget (this-command-keys)))
1762 ;;; The `link' Widget.
1764 (defcustom widget-link-prefix "["
1765 "String used as prefix for links."
1766 :type 'string
1767 :group 'widget-button)
1769 (defcustom widget-link-suffix "]"
1770 "String used as suffix for links."
1771 :type 'string
1772 :group 'widget-button)
1774 (define-widget 'link 'item
1775 "An embedded link."
1776 :button-prefix 'widget-link-prefix
1777 :button-suffix 'widget-link-suffix
1778 :follow-link "\C-m"
1779 :help-echo "Follow the link."
1780 :format "%[%t%]")
1782 ;;; The `info-link' Widget.
1784 (define-widget 'info-link 'link
1785 "A link to an info file."
1786 :action 'widget-info-link-action)
1788 (defun widget-info-link-action (widget &optional event)
1789 "Open the info node specified by WIDGET."
1790 (info (widget-value widget)))
1792 ;;; The `url-link' Widget.
1794 (define-widget 'url-link 'link
1795 "A link to an www page."
1796 :action 'widget-url-link-action)
1798 (defun widget-url-link-action (widget &optional event)
1799 "Open the URL specified by WIDGET."
1800 (browse-url (widget-value widget)))
1802 ;;; The `function-link' Widget.
1804 (define-widget 'function-link 'link
1805 "A link to an Emacs function."
1806 :action 'widget-function-link-action)
1808 (defun widget-function-link-action (widget &optional event)
1809 "Show the function specified by WIDGET."
1810 (describe-function (widget-value widget)))
1812 ;;; The `variable-link' Widget.
1814 (define-widget 'variable-link 'link
1815 "A link to an Emacs variable."
1816 :action 'widget-variable-link-action)
1818 (defun widget-variable-link-action (widget &optional event)
1819 "Show the variable specified by WIDGET."
1820 (describe-variable (widget-value widget)))
1822 ;;; The `file-link' Widget.
1824 (define-widget 'file-link 'link
1825 "A link to a file."
1826 :action 'widget-file-link-action)
1828 (defun widget-file-link-action (widget &optional event)
1829 "Find the file specified by WIDGET."
1830 (find-file (widget-value widget)))
1832 ;;; The `emacs-library-link' Widget.
1834 (define-widget 'emacs-library-link 'link
1835 "A link to an Emacs Lisp library file."
1836 :action 'widget-emacs-library-link-action)
1838 (defun widget-emacs-library-link-action (widget &optional event)
1839 "Find the Emacs library file specified by WIDGET."
1840 (find-file (locate-library (widget-value widget))))
1842 ;;; The `emacs-commentary-link' Widget.
1844 (define-widget 'emacs-commentary-link 'link
1845 "A link to Commentary in an Emacs Lisp library file."
1846 :action 'widget-emacs-commentary-link-action)
1848 (defun widget-emacs-commentary-link-action (widget &optional event)
1849 "Find the Commentary section of the Emacs file specified by WIDGET."
1850 (finder-commentary (widget-value widget)))
1852 ;;; The `editable-field' Widget.
1854 (define-widget 'editable-field 'default
1855 "An editable text field.
1856 Note: In an `editable-field' widget, the `%v' escape must be preceded
1857 by some other text in the `:format' string (if specified)."
1858 :convert-widget 'widget-value-convert-widget
1859 :keymap widget-field-keymap
1860 :format "%v"
1861 :help-echo "M-TAB: complete field; RET: enter value"
1862 :value ""
1863 :prompt-internal 'widget-field-prompt-internal
1864 :prompt-history 'widget-field-history
1865 :prompt-value 'widget-field-prompt-value
1866 :action 'widget-field-action
1867 :validate 'widget-field-validate
1868 :valid-regexp ""
1869 :error "Field's value doesn't match allowed forms"
1870 :value-create 'widget-field-value-create
1871 :value-delete 'widget-field-value-delete
1872 :value-get 'widget-field-value-get
1873 :match 'widget-field-match)
1875 (defvar widget-field-history nil
1876 "History of field minibuffer edits.")
1878 (defun widget-field-prompt-internal (widget prompt initial history)
1879 "Read string for WIDGET prompting with PROMPT.
1880 INITIAL is the initial input and HISTORY is a symbol containing
1881 the earlier input."
1882 (read-string prompt initial history))
1884 (defun widget-field-prompt-value (widget prompt value unbound)
1885 "Prompt for a string."
1886 (widget-apply widget
1887 :value-to-external
1888 (widget-apply widget
1889 :prompt-internal prompt
1890 (unless unbound
1891 (cons (widget-apply widget
1892 :value-to-internal value)
1894 (widget-get widget :prompt-history))))
1896 (defvar widget-edit-functions nil)
1898 (defun widget-field-action (widget &optional event)
1899 "Move to next field."
1900 (widget-forward 1)
1901 (run-hook-with-args 'widget-edit-functions widget))
1903 (defun widget-field-validate (widget)
1904 "Valid if the content matches `:valid-regexp'."
1905 (unless (string-match (widget-get widget :valid-regexp)
1906 (widget-apply widget :value-get))
1907 widget))
1909 (defun widget-field-value-create (widget)
1910 "Create an editable text field."
1911 (let ((size (widget-get widget :size))
1912 (value (widget-get widget :value))
1913 (from (point))
1914 ;; This is changed to a real overlay in `widget-setup'. We
1915 ;; need the end points to behave differently until
1916 ;; `widget-setup' is called.
1917 (overlay (cons (make-marker) (make-marker))))
1918 (widget-put widget :field-overlay overlay)
1919 (insert value)
1920 (and size
1921 (< (length value) size)
1922 (insert-char ?\s (- size (length value))))
1923 (unless (memq widget widget-field-list)
1924 (setq widget-field-new (cons widget widget-field-new)))
1925 (move-marker (cdr overlay) (point))
1926 (set-marker-insertion-type (cdr overlay) nil)
1927 (when (null size)
1928 (insert ?\n))
1929 (move-marker (car overlay) from)
1930 (set-marker-insertion-type (car overlay) t)))
1932 (defun widget-field-value-delete (widget)
1933 "Remove the widget from the list of active editing fields."
1934 (setq widget-field-list (delq widget widget-field-list))
1935 (setq widget-field-new (delq widget widget-field-new))
1936 ;; These are nil if the :format string doesn't contain `%v'.
1937 (let ((overlay (widget-get widget :field-overlay)))
1938 (when (overlayp overlay)
1939 (delete-overlay overlay))))
1941 (defun widget-field-value-get (widget)
1942 "Return current text in editing field."
1943 (let ((from (widget-field-start widget))
1944 (to (widget-field-end widget))
1945 (buffer (widget-field-buffer widget))
1946 (size (widget-get widget :size))
1947 (secret (widget-get widget :secret))
1948 (old (current-buffer)))
1949 (if (and from to)
1950 (progn
1951 (set-buffer buffer)
1952 (while (and size
1953 (not (zerop size))
1954 (> to from)
1955 (eq (char-after (1- to)) ?\s))
1956 (setq to (1- to)))
1957 (let ((result (buffer-substring-no-properties from to)))
1958 (when secret
1959 (let ((index 0))
1960 (while (< (+ from index) to)
1961 (aset result index
1962 (get-char-property (+ from index) 'secret))
1963 (setq index (1+ index)))))
1964 (set-buffer old)
1965 result))
1966 (widget-get widget :value))))
1968 (defun widget-field-match (widget value)
1969 ;; Match any string.
1970 (stringp value))
1972 ;;; The `text' Widget.
1974 (define-widget 'text 'editable-field
1975 "A multiline text area."
1976 :keymap widget-text-keymap)
1978 ;;; The `menu-choice' Widget.
1980 (define-widget 'menu-choice 'default
1981 "A menu of options."
1982 :convert-widget 'widget-types-convert-widget
1983 :copy 'widget-types-copy
1984 :format "%[%t%]: %v"
1985 :case-fold t
1986 :tag "choice"
1987 :void '(item :format "invalid (%t)\n")
1988 :value-create 'widget-choice-value-create
1989 :value-get 'widget-child-value-get
1990 :value-inline 'widget-child-value-inline
1991 :default-get 'widget-choice-default-get
1992 :mouse-down-action 'widget-choice-mouse-down-action
1993 :action 'widget-choice-action
1994 :error "Make a choice"
1995 :validate 'widget-choice-validate
1996 :match 'widget-choice-match
1997 :match-inline 'widget-choice-match-inline)
1999 (defun widget-choice-value-create (widget)
2000 "Insert the first choice that matches the value."
2001 (let ((value (widget-get widget :value))
2002 (args (widget-get widget :args))
2003 (explicit (widget-get widget :explicit-choice))
2004 current)
2005 (if explicit
2006 (progn
2007 ;; If the user specified the choice for this value,
2008 ;; respect that choice.
2009 (widget-put widget :children (list (widget-create-child-value
2010 widget explicit value)))
2011 (widget-put widget :choice explicit)
2012 (widget-put widget :explicit-choice nil))
2013 (while args
2014 (setq current (car args)
2015 args (cdr args))
2016 (when (widget-apply current :match value)
2017 (widget-put widget :children (list (widget-create-child-value
2018 widget current value)))
2019 (widget-put widget :choice current)
2020 (setq args nil
2021 current nil)))
2022 (when current
2023 (let ((void (widget-get widget :void)))
2024 (widget-put widget :children (list (widget-create-child-and-convert
2025 widget void :value value)))
2026 (widget-put widget :choice void))))))
2028 (defun widget-choice-default-get (widget)
2029 ;; Get default for the first choice.
2030 (widget-default-get (car (widget-get widget :args))))
2032 (defcustom widget-choice-toggle nil
2033 "If non-nil, a binary choice will just toggle between the values.
2034 Otherwise, the user will explicitly have to choose between the values
2035 when he invoked the menu."
2036 :type 'boolean
2037 :group 'widgets)
2039 (defun widget-choice-mouse-down-action (widget &optional event)
2040 ;; Return non-nil if we need a menu.
2041 (let ((args (widget-get widget :args))
2042 (old (widget-get widget :choice)))
2043 (cond ((not (display-popup-menus-p))
2044 ;; No place to pop up a menu.
2045 nil)
2046 ((< (length args) 2)
2047 ;; Empty or singleton list, just return the value.
2048 nil)
2049 ((> (length args) widget-menu-max-size)
2050 ;; Too long, prompt.
2051 nil)
2052 ((> (length args) 2)
2053 ;; Reasonable sized list, use menu.
2055 ((and widget-choice-toggle (memq old args))
2056 ;; We toggle.
2057 nil)
2059 ;; Ask which of the two.
2060 t))))
2062 (defun widget-choice-action (widget &optional event)
2063 ;; Make a choice.
2064 (let ((args (widget-get widget :args))
2065 (old (widget-get widget :choice))
2066 (tag (widget-apply widget :menu-tag-get))
2067 (completion-ignore-case (widget-get widget :case-fold))
2068 this-explicit
2069 current choices)
2070 ;; Remember old value.
2071 (if (and old (not (widget-apply widget :validate)))
2072 (let* ((external (widget-value widget))
2073 (internal (widget-apply old :value-to-internal external)))
2074 (widget-put old :value internal)))
2075 ;; Find new choice.
2076 (setq current
2077 (cond ((= (length args) 0)
2078 nil)
2079 ((= (length args) 1)
2080 (nth 0 args))
2081 ((and widget-choice-toggle
2082 (= (length args) 2)
2083 (memq old args))
2084 (if (eq old (nth 0 args))
2085 (nth 1 args)
2086 (nth 0 args)))
2088 (while args
2089 (setq current (car args)
2090 args (cdr args))
2091 (setq choices
2092 (cons (cons (widget-apply current :menu-tag-get)
2093 current)
2094 choices)))
2095 (setq this-explicit t)
2096 (widget-choose tag (reverse choices) event))))
2097 (when current
2098 ;; If this was an explicit user choice, record the choice,
2099 ;; so that widget-choice-value-create will respect it.
2100 (when this-explicit
2101 (widget-put widget :explicit-choice current))
2102 (widget-value-set widget (widget-default-get current))
2103 (widget-setup)
2104 (widget-apply widget :notify widget event)))
2105 (run-hook-with-args 'widget-edit-functions widget))
2107 (defun widget-choice-validate (widget)
2108 ;; Valid if we have made a valid choice.
2109 (if (eq (widget-get widget :void) (widget-get widget :choice))
2110 widget
2111 (widget-apply (car (widget-get widget :children)) :validate)))
2113 (defun widget-choice-match (widget value)
2114 ;; Matches if one of the choices matches.
2115 (let ((args (widget-get widget :args))
2116 current found)
2117 (while (and args (not found))
2118 (setq current (car args)
2119 args (cdr args)
2120 found (widget-apply current :match value)))
2121 found))
2123 (defun widget-choice-match-inline (widget values)
2124 ;; Matches if one of the choices matches.
2125 (let ((args (widget-get widget :args))
2126 current found)
2127 (while (and args (null found))
2128 (setq current (car args)
2129 args (cdr args)
2130 found (widget-match-inline current values)))
2131 found))
2133 ;;; The `toggle' Widget.
2135 (define-widget 'toggle 'item
2136 "Toggle between two states."
2137 :format "%[%v%]\n"
2138 :value-create 'widget-toggle-value-create
2139 :action 'widget-toggle-action
2140 :match (lambda (widget value) t)
2141 :on "on"
2142 :off "off")
2144 (defun widget-toggle-value-create (widget)
2145 "Insert text representing the `on' and `off' states."
2146 (if (widget-value widget)
2147 (let ((image (widget-get widget :on-glyph)))
2148 (and (display-graphic-p)
2149 (listp image)
2150 (not (eq (car image) 'image))
2151 (widget-put widget :on-glyph (setq image (eval image))))
2152 (widget-image-insert widget
2153 (widget-get widget :on)
2154 image))
2155 (let ((image (widget-get widget :off-glyph)))
2156 (and (display-graphic-p)
2157 (listp image)
2158 (not (eq (car image) 'image))
2159 (widget-put widget :off-glyph (setq image (eval image))))
2160 (widget-image-insert widget (widget-get widget :off) image))))
2162 (defun widget-toggle-action (widget &optional event)
2163 ;; Toggle value.
2164 (widget-value-set widget (not (widget-value widget)))
2165 (widget-apply widget :notify widget event)
2166 (run-hook-with-args 'widget-edit-functions widget))
2168 ;;; The `checkbox' Widget.
2170 (define-widget 'checkbox 'toggle
2171 "A checkbox toggle."
2172 :button-suffix ""
2173 :button-prefix ""
2174 :format "%[%v%]"
2175 :on "[X]"
2176 ;; We could probably do the same job as the images using single
2177 ;; space characters in a boxed face with a stretch specification to
2178 ;; make them square.
2179 :on-glyph '(create-image "\300\300\141\143\067\076\034\030"
2180 'xbm t :width 8 :height 8
2181 :background "grey75" ; like default mode line
2182 :foreground "black"
2183 :relief -2
2184 :ascent 'center)
2185 :off "[ ]"
2186 :off-glyph '(create-image (make-string 8 0)
2187 'xbm t :width 8 :height 8
2188 :background "grey75"
2189 :foreground "black"
2190 :relief -2
2191 :ascent 'center)
2192 :help-echo "Toggle this item."
2193 :action 'widget-checkbox-action)
2195 (defun widget-checkbox-action (widget &optional event)
2196 "Toggle checkbox, notify parent, and set active state of sibling."
2197 (widget-toggle-action widget event)
2198 (let ((sibling (widget-get-sibling widget)))
2199 (when sibling
2200 (if (widget-value widget)
2201 (widget-apply sibling :activate)
2202 (widget-apply sibling :deactivate))
2203 (widget-clear-undo))))
2205 ;;; The `checklist' Widget.
2207 (define-widget 'checklist 'default
2208 "A multiple choice widget."
2209 :convert-widget 'widget-types-convert-widget
2210 :copy 'widget-types-copy
2211 :format "%v"
2212 :offset 4
2213 :entry-format "%b %v"
2214 :greedy nil
2215 :value-create 'widget-checklist-value-create
2216 :value-get 'widget-checklist-value-get
2217 :validate 'widget-checklist-validate
2218 :match 'widget-checklist-match
2219 :match-inline 'widget-checklist-match-inline)
2221 (defun widget-checklist-value-create (widget)
2222 ;; Insert all values
2223 (let ((alist (widget-checklist-match-find widget (widget-get widget :value)))
2224 (args (widget-get widget :args)))
2225 (while args
2226 (widget-checklist-add-item widget (car args) (assq (car args) alist))
2227 (setq args (cdr args)))
2228 (widget-put widget :children (nreverse (widget-get widget :children)))))
2230 (defun widget-checklist-add-item (widget type chosen)
2231 "Create checklist item in WIDGET of type TYPE.
2232 If the item is checked, CHOSEN is a cons whose cdr is the value."
2233 (and (eq (preceding-char) ?\n)
2234 (widget-get widget :indent)
2235 (insert-char ?\s (widget-get widget :indent)))
2236 (widget-specify-insert
2237 (let* ((children (widget-get widget :children))
2238 (buttons (widget-get widget :buttons))
2239 (button-args (or (widget-get type :sibling-args)
2240 (widget-get widget :button-args)))
2241 (from (point))
2242 child button)
2243 (insert (widget-get widget :entry-format))
2244 (goto-char from)
2245 ;; Parse % escapes in format.
2246 (while (re-search-forward "%\\([bv%]\\)" nil t)
2247 (let ((escape (char-after (match-beginning 1))))
2248 (delete-backward-char 2)
2249 (cond ((eq escape ?%)
2250 (insert ?%))
2251 ((eq escape ?b)
2252 (setq button (apply 'widget-create-child-and-convert
2253 widget 'checkbox
2254 :value (not (null chosen))
2255 button-args)))
2256 ((eq escape ?v)
2257 (setq child
2258 (cond ((not chosen)
2259 (let ((child (widget-create-child widget type)))
2260 (widget-apply child :deactivate)
2261 child))
2262 ((widget-get type :inline)
2263 (widget-create-child-value
2264 widget type (cdr chosen)))
2266 (widget-create-child-value
2267 widget type (car (cdr chosen)))))))
2269 (error "Unknown escape `%c'" escape)))))
2270 ;; Update properties.
2271 (and button child (widget-put child :button button))
2272 (and button (widget-put widget :buttons (cons button buttons)))
2273 (and child (widget-put widget :children (cons child children))))))
2275 (defun widget-checklist-match (widget values)
2276 ;; All values must match a type in the checklist.
2277 (and (listp values)
2278 (null (cdr (widget-checklist-match-inline widget values)))))
2280 (defun widget-checklist-match-inline (widget values)
2281 ;; Find the values which match a type in the checklist.
2282 (let ((greedy (widget-get widget :greedy))
2283 (args (copy-sequence (widget-get widget :args)))
2284 found rest)
2285 (while values
2286 (let ((answer (widget-checklist-match-up args values)))
2287 (cond (answer
2288 (let ((vals (widget-match-inline answer values)))
2289 (setq found (append found (car vals))
2290 values (cdr vals)
2291 args (delq answer args))))
2292 (greedy
2293 (setq rest (append rest (list (car values)))
2294 values (cdr values)))
2296 (setq rest (append rest values)
2297 values nil)))))
2298 (cons found rest)))
2300 (defun widget-checklist-match-find (widget vals)
2301 "Find the vals which match a type in the checklist.
2302 Return an alist of (TYPE MATCH)."
2303 (let ((greedy (widget-get widget :greedy))
2304 (args (copy-sequence (widget-get widget :args)))
2305 found)
2306 (while vals
2307 (let ((answer (widget-checklist-match-up args vals)))
2308 (cond (answer
2309 (let ((match (widget-match-inline answer vals)))
2310 (setq found (cons (cons answer (car match)) found)
2311 vals (cdr match)
2312 args (delq answer args))))
2313 (greedy
2314 (setq vals (cdr vals)))
2316 (setq vals nil)))))
2317 found))
2319 (defun widget-checklist-match-up (args vals)
2320 "Return the first type from ARGS that matches VALS."
2321 (let (current found)
2322 (while (and args (null found))
2323 (setq current (car args)
2324 args (cdr args)
2325 found (widget-match-inline current vals)))
2326 (if found
2327 current)))
2329 (defun widget-checklist-value-get (widget)
2330 ;; The values of all selected items.
2331 (let ((children (widget-get widget :children))
2332 child result)
2333 (while children
2334 (setq child (car children)
2335 children (cdr children))
2336 (if (widget-value (widget-get child :button))
2337 (setq result (append result (widget-apply child :value-inline)))))
2338 result))
2340 (defun widget-checklist-validate (widget)
2341 ;; Ticked chilren must be valid.
2342 (let ((children (widget-get widget :children))
2343 child button found)
2344 (while (and children (not found))
2345 (setq child (car children)
2346 children (cdr children)
2347 button (widget-get child :button)
2348 found (and (widget-value button)
2349 (widget-apply child :validate))))
2350 found))
2352 ;;; The `option' Widget
2354 (define-widget 'option 'checklist
2355 "An widget with an optional item."
2356 :inline t)
2358 ;;; The `choice-item' Widget.
2360 (define-widget 'choice-item 'item
2361 "Button items that delegate action events to their parents."
2362 :action 'widget-parent-action
2363 :format "%[%t%] \n")
2365 ;;; The `radio-button' Widget.
2367 (define-widget 'radio-button 'toggle
2368 "A radio button for use in the `radio' widget."
2369 :notify 'widget-radio-button-notify
2370 :format "%[%v%]"
2371 :button-suffix ""
2372 :button-prefix ""
2373 :on "(*)"
2374 :on-glyph "radio1"
2375 :off "( )"
2376 :off-glyph "radio0")
2378 (defun widget-radio-button-notify (widget child &optional event)
2379 ;; Tell daddy.
2380 (widget-apply (widget-get widget :parent) :action widget event))
2382 ;;; The `radio-button-choice' Widget.
2384 (define-widget 'radio-button-choice 'default
2385 "Select one of multiple options."
2386 :convert-widget 'widget-types-convert-widget
2387 :copy 'widget-types-copy
2388 :offset 4
2389 :format "%v"
2390 :entry-format "%b %v"
2391 :value-create 'widget-radio-value-create
2392 :value-get 'widget-radio-value-get
2393 :value-inline 'widget-radio-value-inline
2394 :value-set 'widget-radio-value-set
2395 :error "You must push one of the buttons"
2396 :validate 'widget-radio-validate
2397 :match 'widget-choice-match
2398 :match-inline 'widget-choice-match-inline
2399 :action 'widget-radio-action)
2401 (defun widget-radio-value-create (widget)
2402 ;; Insert all values
2403 (let ((args (widget-get widget :args))
2404 arg)
2405 (while args
2406 (setq arg (car args)
2407 args (cdr args))
2408 (widget-radio-add-item widget arg))))
2410 (defun widget-radio-add-item (widget type)
2411 "Add to radio widget WIDGET a new radio button item of type TYPE."
2412 ;; (setq type (widget-convert type))
2413 (and (eq (preceding-char) ?\n)
2414 (widget-get widget :indent)
2415 (insert-char ?\s (widget-get widget :indent)))
2416 (widget-specify-insert
2417 (let* ((value (widget-get widget :value))
2418 (children (widget-get widget :children))
2419 (buttons (widget-get widget :buttons))
2420 (button-args (or (widget-get type :sibling-args)
2421 (widget-get widget :button-args)))
2422 (from (point))
2423 (chosen (and (null (widget-get widget :choice))
2424 (widget-apply type :match value)))
2425 child button)
2426 (insert (widget-get widget :entry-format))
2427 (goto-char from)
2428 ;; Parse % escapes in format.
2429 (while (re-search-forward "%\\([bv%]\\)" nil t)
2430 (let ((escape (char-after (match-beginning 1))))
2431 (delete-backward-char 2)
2432 (cond ((eq escape ?%)
2433 (insert ?%))
2434 ((eq escape ?b)
2435 (setq button (apply 'widget-create-child-and-convert
2436 widget 'radio-button
2437 :value (not (null chosen))
2438 button-args)))
2439 ((eq escape ?v)
2440 (setq child (if chosen
2441 (widget-create-child-value
2442 widget type value)
2443 (widget-create-child widget type)))
2444 (unless chosen
2445 (widget-apply child :deactivate)))
2447 (error "Unknown escape `%c'" escape)))))
2448 ;; Update properties.
2449 (when chosen
2450 (widget-put widget :choice type))
2451 (when button
2452 (widget-put child :button button)
2453 (widget-put widget :buttons (nconc buttons (list button))))
2454 (when child
2455 (widget-put widget :children (nconc children (list child))))
2456 child)))
2458 (defun widget-radio-value-get (widget)
2459 ;; Get value of the child widget.
2460 (let ((chosen (widget-radio-chosen widget)))
2461 (and chosen (widget-value chosen))))
2463 (defun widget-radio-chosen (widget)
2464 "Return the widget representing the chosen radio button."
2465 (let ((children (widget-get widget :children))
2466 current found)
2467 (while children
2468 (setq current (car children)
2469 children (cdr children))
2470 (when (widget-apply (widget-get current :button) :value-get)
2471 (setq found current
2472 children nil)))
2473 found))
2475 (defun widget-radio-value-inline (widget)
2476 ;; Get value of the child widget.
2477 (let ((children (widget-get widget :children))
2478 current found)
2479 (while children
2480 (setq current (car children)
2481 children (cdr children))
2482 (when (widget-apply (widget-get current :button) :value-get)
2483 (setq found (widget-apply current :value-inline)
2484 children nil)))
2485 found))
2487 (defun widget-radio-value-set (widget value)
2488 ;; We can't just delete and recreate a radio widget, since children
2489 ;; can be added after the original creation and won't be recreated
2490 ;; by `:create'.
2491 (let ((children (widget-get widget :children))
2492 current found)
2493 (while children
2494 (setq current (car children)
2495 children (cdr children))
2496 (let* ((button (widget-get current :button))
2497 (match (and (not found)
2498 (widget-apply current :match value))))
2499 (widget-value-set button match)
2500 (if match
2501 (progn
2502 (widget-value-set current value)
2503 (widget-apply current :activate))
2504 (widget-apply current :deactivate))
2505 (setq found (or found match))))))
2507 (defun widget-radio-validate (widget)
2508 ;; Valid if we have made a valid choice.
2509 (let ((children (widget-get widget :children))
2510 current found button)
2511 (while (and children (not found))
2512 (setq current (car children)
2513 children (cdr children)
2514 button (widget-get current :button)
2515 found (widget-apply button :value-get)))
2516 (if found
2517 (widget-apply current :validate)
2518 widget)))
2520 (defun widget-radio-action (widget child event)
2521 ;; Check if a radio button was pressed.
2522 (let ((children (widget-get widget :children))
2523 (buttons (widget-get widget :buttons))
2524 current)
2525 (when (memq child buttons)
2526 (while children
2527 (setq current (car children)
2528 children (cdr children))
2529 (let* ((button (widget-get current :button)))
2530 (cond ((eq child button)
2531 (widget-value-set button t)
2532 (widget-apply current :activate))
2533 ((widget-value button)
2534 (widget-value-set button nil)
2535 (widget-apply current :deactivate)))))))
2536 ;; Pass notification to parent.
2537 (widget-apply widget :notify child event))
2539 ;;; The `insert-button' Widget.
2541 (define-widget 'insert-button 'push-button
2542 "An insert button for the `editable-list' widget."
2543 :tag "INS"
2544 :help-echo "Insert a new item into the list at this position."
2545 :action 'widget-insert-button-action)
2547 (defun widget-insert-button-action (widget &optional event)
2548 ;; Ask the parent to insert a new item.
2549 (widget-apply (widget-get widget :parent)
2550 :insert-before (widget-get widget :widget)))
2552 ;;; The `delete-button' Widget.
2554 (define-widget 'delete-button 'push-button
2555 "A delete button for the `editable-list' widget."
2556 :tag "DEL"
2557 :help-echo "Delete this item from the list."
2558 :action 'widget-delete-button-action)
2560 (defun widget-delete-button-action (widget &optional event)
2561 ;; Ask the parent to insert a new item.
2562 (widget-apply (widget-get widget :parent)
2563 :delete-at (widget-get widget :widget)))
2565 ;;; The `editable-list' Widget.
2567 ;; (defcustom widget-editable-list-gui nil
2568 ;; "If non-nil, use GUI push-buttons in editable list when available."
2569 ;; :type 'boolean
2570 ;; :group 'widgets)
2572 (define-widget 'editable-list 'default
2573 "A variable list of widgets of the same type."
2574 :convert-widget 'widget-types-convert-widget
2575 :copy 'widget-types-copy
2576 :offset 12
2577 :format "%v%i\n"
2578 :format-handler 'widget-editable-list-format-handler
2579 :entry-format "%i %d %v"
2580 :value-create 'widget-editable-list-value-create
2581 :value-get 'widget-editable-list-value-get
2582 :validate 'widget-children-validate
2583 :match 'widget-editable-list-match
2584 :match-inline 'widget-editable-list-match-inline
2585 :insert-before 'widget-editable-list-insert-before
2586 :delete-at 'widget-editable-list-delete-at)
2588 (defun widget-editable-list-format-handler (widget escape)
2589 ;; We recognize the insert button.
2590 ;; (let ((widget-push-button-gui widget-editable-list-gui))
2591 (cond ((eq escape ?i)
2592 (and (widget-get widget :indent)
2593 (insert-char ?\s (widget-get widget :indent)))
2594 (apply 'widget-create-child-and-convert
2595 widget 'insert-button
2596 (widget-get widget :append-button-args)))
2598 (widget-default-format-handler widget escape)))
2599 ;; )
2602 (defun widget-editable-list-value-create (widget)
2603 ;; Insert all values
2604 (let* ((value (widget-get widget :value))
2605 (type (nth 0 (widget-get widget :args)))
2606 children)
2607 (widget-put widget :value-pos (copy-marker (point)))
2608 (set-marker-insertion-type (widget-get widget :value-pos) t)
2609 (while value
2610 (let ((answer (widget-match-inline type value)))
2611 (if answer
2612 (setq children (cons (widget-editable-list-entry-create
2613 widget
2614 (if (widget-get type :inline)
2615 (car answer)
2616 (car (car answer)))
2618 children)
2619 value (cdr answer))
2620 (setq value nil))))
2621 (widget-put widget :children (nreverse children))))
2623 (defun widget-editable-list-value-get (widget)
2624 ;; Get value of the child widget.
2625 (apply 'append (mapcar (lambda (child) (widget-apply child :value-inline))
2626 (widget-get widget :children))))
2628 (defun widget-editable-list-match (widget value)
2629 ;; Value must be a list and all the members must match the type.
2630 (and (listp value)
2631 (null (cdr (widget-editable-list-match-inline widget value)))))
2633 (defun widget-editable-list-match-inline (widget value)
2634 (let ((type (nth 0 (widget-get widget :args)))
2635 (ok t)
2636 found)
2637 (while (and value ok)
2638 (let ((answer (widget-match-inline type value)))
2639 (if answer
2640 (setq found (append found (car answer))
2641 value (cdr answer))
2642 (setq ok nil))))
2643 (cons found value)))
2645 (defun widget-editable-list-insert-before (widget before)
2646 ;; Insert a new child in the list of children.
2647 (save-excursion
2648 (let ((children (widget-get widget :children))
2649 (inhibit-read-only t)
2650 before-change-functions
2651 after-change-functions)
2652 (cond (before
2653 (goto-char (widget-get before :entry-from)))
2655 (goto-char (widget-get widget :value-pos))))
2656 (let ((child (widget-editable-list-entry-create
2657 widget nil nil)))
2658 (when (< (widget-get child :entry-from) (widget-get widget :from))
2659 (set-marker (widget-get widget :from)
2660 (widget-get child :entry-from)))
2661 (if (eq (car children) before)
2662 (widget-put widget :children (cons child children))
2663 (while (not (eq (car (cdr children)) before))
2664 (setq children (cdr children)))
2665 (setcdr children (cons child (cdr children)))))))
2666 (widget-setup)
2667 (widget-apply widget :notify widget))
2669 (defun widget-editable-list-delete-at (widget child)
2670 ;; Delete child from list of children.
2671 (save-excursion
2672 (let ((buttons (copy-sequence (widget-get widget :buttons)))
2673 button
2674 (inhibit-read-only t)
2675 before-change-functions
2676 after-change-functions)
2677 (while buttons
2678 (setq button (car buttons)
2679 buttons (cdr buttons))
2680 (when (eq (widget-get button :widget) child)
2681 (widget-put widget
2682 :buttons (delq button (widget-get widget :buttons)))
2683 (widget-delete button))))
2684 (let ((entry-from (widget-get child :entry-from))
2685 (entry-to (widget-get child :entry-to))
2686 (inhibit-read-only t)
2687 before-change-functions
2688 after-change-functions)
2689 (widget-delete child)
2690 (delete-region entry-from entry-to)
2691 (set-marker entry-from nil)
2692 (set-marker entry-to nil))
2693 (widget-put widget :children (delq child (widget-get widget :children))))
2694 (widget-setup)
2695 (widget-apply widget :notify widget))
2697 (defun widget-editable-list-entry-create (widget value conv)
2698 ;; Create a new entry to the list.
2699 (let ((type (nth 0 (widget-get widget :args)))
2700 ;; (widget-push-button-gui widget-editable-list-gui)
2701 child delete insert)
2702 (widget-specify-insert
2703 (save-excursion
2704 (and (widget-get widget :indent)
2705 (insert-char ?\s (widget-get widget :indent)))
2706 (insert (widget-get widget :entry-format)))
2707 ;; Parse % escapes in format.
2708 (while (re-search-forward "%\\(.\\)" nil t)
2709 (let ((escape (char-after (match-beginning 1))))
2710 (delete-backward-char 2)
2711 (cond ((eq escape ?%)
2712 (insert ?%))
2713 ((eq escape ?i)
2714 (setq insert (apply 'widget-create-child-and-convert
2715 widget 'insert-button
2716 (widget-get widget :insert-button-args))))
2717 ((eq escape ?d)
2718 (setq delete (apply 'widget-create-child-and-convert
2719 widget 'delete-button
2720 (widget-get widget :delete-button-args))))
2721 ((eq escape ?v)
2722 (if conv
2723 (setq child (widget-create-child-value
2724 widget type value))
2725 (setq child (widget-create-child-value
2726 widget type (widget-default-get type)))))
2728 (error "Unknown escape `%c'" escape)))))
2729 (let ((buttons (widget-get widget :buttons)))
2730 (if insert (push insert buttons))
2731 (if delete (push delete buttons))
2732 (widget-put widget :buttons buttons))
2733 (let ((entry-from (point-min-marker))
2734 (entry-to (point-max-marker)))
2735 (set-marker-insertion-type entry-from t)
2736 (set-marker-insertion-type entry-to nil)
2737 (widget-put child :entry-from entry-from)
2738 (widget-put child :entry-to entry-to)))
2739 (if insert (widget-put insert :widget child))
2740 (if delete (widget-put delete :widget child))
2741 child))
2743 ;;; The `group' Widget.
2745 (define-widget 'group 'default
2746 "A widget which groups other widgets inside."
2747 :convert-widget 'widget-types-convert-widget
2748 :copy 'widget-types-copy
2749 :format "%v"
2750 :value-create 'widget-group-value-create
2751 :value-get 'widget-editable-list-value-get
2752 :default-get 'widget-group-default-get
2753 :validate 'widget-children-validate
2754 :match 'widget-group-match
2755 :match-inline 'widget-group-match-inline)
2757 (defun widget-group-value-create (widget)
2758 ;; Create each component.
2759 (let ((args (widget-get widget :args))
2760 (value (widget-get widget :value))
2761 arg answer children)
2762 (while args
2763 (setq arg (car args)
2764 args (cdr args)
2765 answer (widget-match-inline arg value)
2766 value (cdr answer))
2767 (and (eq (preceding-char) ?\n)
2768 (widget-get widget :indent)
2769 (insert-char ?\s (widget-get widget :indent)))
2770 (push (cond ((null answer)
2771 (widget-create-child widget arg))
2772 ((widget-get arg :inline)
2773 (widget-create-child-value widget arg (car answer)))
2775 (widget-create-child-value widget arg (car (car answer)))))
2776 children))
2777 (widget-put widget :children (nreverse children))))
2779 (defun widget-group-default-get (widget)
2780 ;; Get the default of the components.
2781 (mapcar 'widget-default-get (widget-get widget :args)))
2783 (defun widget-group-match (widget values)
2784 ;; Match if the components match.
2785 (and (listp values)
2786 (let ((match (widget-group-match-inline widget values)))
2787 (and match (null (cdr match))))))
2789 (defun widget-group-match-inline (widget vals)
2790 ;; Match if the components match.
2791 (let ((args (widget-get widget :args))
2792 argument answer found)
2793 (while args
2794 (setq argument (car args)
2795 args (cdr args)
2796 answer (widget-match-inline argument vals))
2797 (if answer
2798 (setq vals (cdr answer)
2799 found (append found (car answer)))
2800 (setq vals nil
2801 args nil)))
2802 (if answer
2803 (cons found vals))))
2805 ;;; The `visibility' Widget.
2807 (define-widget 'visibility 'item
2808 "An indicator and manipulator for hidden items."
2809 :format "%[%v%]"
2810 :button-prefix ""
2811 :button-suffix ""
2812 :on "Hide"
2813 :off "Show"
2814 :value-create 'widget-visibility-value-create
2815 :action 'widget-toggle-action
2816 :match (lambda (widget value) t))
2818 (defun widget-visibility-value-create (widget)
2819 ;; Insert text representing the `on' and `off' states.
2820 (let ((on (widget-get widget :on))
2821 (off (widget-get widget :off)))
2822 (if on
2823 (setq on (concat widget-push-button-prefix
2825 widget-push-button-suffix))
2826 (setq on ""))
2827 (if off
2828 (setq off (concat widget-push-button-prefix
2830 widget-push-button-suffix))
2831 (setq off ""))
2832 (if (widget-value widget)
2833 (widget-image-insert widget on "down" "down-pushed")
2834 (widget-image-insert widget off "right" "right-pushed"))))
2836 ;;; The `documentation-link' Widget.
2838 ;; This is a helper widget for `documentation-string'.
2840 (define-widget 'documentation-link 'link
2841 "Link type used in documentation strings."
2842 :tab-order -1
2843 :help-echo "Describe this symbol"
2844 :action 'widget-documentation-link-action)
2846 (defun widget-documentation-link-action (widget &optional event)
2847 "Display documentation for WIDGET's value. Ignore optional argument EVENT."
2848 (let* ((string (widget-get widget :value))
2849 (symbol (intern string)))
2850 (if (and (fboundp symbol) (boundp symbol))
2851 ;; If there are two doc strings, give the user a way to pick one.
2852 (apropos (concat "\\`" (regexp-quote string) "\\'"))
2853 (if (fboundp symbol)
2854 (describe-function symbol)
2855 (describe-variable symbol)))))
2857 (defcustom widget-documentation-links t
2858 "Add hyperlinks to documentation strings when non-nil."
2859 :type 'boolean
2860 :group 'widget-documentation)
2862 (defcustom widget-documentation-link-regexp "`\\([^\n`' ]+\\)'"
2863 "Regexp for matching potential links in documentation strings.
2864 The first group should be the link itself."
2865 :type 'regexp
2866 :group 'widget-documentation)
2868 (defcustom widget-documentation-link-p 'intern-soft
2869 "Predicate used to test if a string is useful as a link.
2870 The value should be a function. The function will be called with one
2871 argument, a string, and should return non-nil if there should be a
2872 link for that string."
2873 :type 'function
2874 :options '(widget-documentation-link-p)
2875 :group 'widget-documentation)
2877 (defcustom widget-documentation-link-type 'documentation-link
2878 "Widget type used for links in documentation strings."
2879 :type 'symbol
2880 :group 'widget-documentation)
2882 (defun widget-documentation-link-add (widget from to)
2883 (widget-specify-doc widget from to)
2884 (when widget-documentation-links
2885 (let ((regexp widget-documentation-link-regexp)
2886 (buttons (widget-get widget :buttons))
2887 (widget-mouse-face (default-value 'widget-mouse-face))
2888 (widget-button-face widget-documentation-face)
2889 (widget-button-pressed-face widget-documentation-face))
2890 (save-excursion
2891 (goto-char from)
2892 (while (re-search-forward regexp to t)
2893 (let ((name (match-string 1))
2894 (begin (match-beginning 1))
2895 (end (match-end 1)))
2896 (when (funcall widget-documentation-link-p name)
2897 (push (widget-convert-button widget-documentation-link-type
2898 begin end :value name)
2899 buttons)))))
2900 (widget-put widget :buttons buttons)))
2901 (let ((indent (widget-get widget :indent)))
2902 (when (and indent (not (zerop indent)))
2903 (save-excursion
2904 (save-restriction
2905 (narrow-to-region from to)
2906 (goto-char (point-min))
2907 (while (search-forward "\n" nil t)
2908 (insert-char ?\s indent)))))))
2910 ;;; The `documentation-string' Widget.
2912 (define-widget 'documentation-string 'item
2913 "A documentation string."
2914 :format "%v"
2915 :action 'widget-documentation-string-action
2916 :value-create 'widget-documentation-string-value-create)
2918 (defun widget-documentation-string-value-create (widget)
2919 ;; Insert documentation string.
2920 (let ((doc (widget-value widget))
2921 (indent (widget-get widget :indent))
2922 (shown (widget-get (widget-get widget :parent) :documentation-shown))
2923 (start (point)))
2924 (if (string-match "\n" doc)
2925 (let ((before (substring doc 0 (match-beginning 0)))
2926 (after (substring doc (match-beginning 0)))
2927 button)
2928 (insert before ?\s)
2929 (widget-documentation-link-add widget start (point))
2930 (setq button
2931 (widget-create-child-and-convert
2932 widget 'visibility
2933 :help-echo "Show or hide rest of the documentation."
2934 :on "Hide Rest"
2935 :off "More"
2936 :always-active t
2937 :action 'widget-parent-action
2938 shown))
2939 (when shown
2940 (setq start (point))
2941 (when (and indent (not (zerop indent)))
2942 (insert-char ?\s indent))
2943 (insert after)
2944 (widget-documentation-link-add widget start (point)))
2945 (widget-put widget :buttons (list button)))
2946 (insert doc)
2947 (widget-documentation-link-add widget start (point))))
2948 (insert ?\n))
2950 (defun widget-documentation-string-action (widget &rest ignore)
2951 ;; Toggle documentation.
2952 (let ((parent (widget-get widget :parent)))
2953 (widget-put parent :documentation-shown
2954 (not (widget-get parent :documentation-shown))))
2955 ;; Redraw.
2956 (widget-value-set widget (widget-value widget)))
2958 ;;; The Sexp Widgets.
2960 (define-widget 'const 'item
2961 "An immutable sexp."
2962 :prompt-value 'widget-const-prompt-value
2963 :format "%t\n%d")
2965 (defun widget-const-prompt-value (widget prompt value unbound)
2966 ;; Return the value of the const.
2967 (widget-value widget))
2969 (define-widget 'function-item 'const
2970 "An immutable function name."
2971 :format "%v\n%h"
2972 :documentation-property (lambda (symbol)
2973 (condition-case nil
2974 (documentation symbol t)
2975 (error nil))))
2977 (define-widget 'variable-item 'const
2978 "An immutable variable name."
2979 :format "%v\n%h"
2980 :documentation-property 'variable-documentation)
2982 (define-widget 'other 'sexp
2983 "Matches any value, but doesn't let the user edit the value.
2984 This is useful as last item in a `choice' widget.
2985 You should use this widget type with a default value,
2986 as in (other DEFAULT) or (other :tag \"NAME\" DEFAULT).
2987 If the user selects this alternative, that specifies DEFAULT
2988 as the value."
2989 :tag "Other"
2990 :format "%t%n"
2991 :value 'other)
2993 (defvar widget-string-prompt-value-history nil
2994 "History of input to `widget-string-prompt-value'.")
2996 (define-widget 'string 'editable-field
2997 "A string"
2998 :tag "String"
2999 :format "%{%t%}: %v"
3000 :complete-function 'ispell-complete-word
3001 :prompt-history 'widget-string-prompt-value-history)
3003 (define-widget 'regexp 'string
3004 "A regular expression."
3005 :match 'widget-regexp-match
3006 :validate 'widget-regexp-validate
3007 ;; Doesn't work well with terminating newline.
3008 ;; :value-face 'widget-single-line-field
3009 :tag "Regexp")
3011 (defun widget-regexp-match (widget value)
3012 ;; Match valid regexps.
3013 (and (stringp value)
3014 (condition-case nil
3015 (prog1 t
3016 (string-match value ""))
3017 (error nil))))
3019 (defun widget-regexp-validate (widget)
3020 "Check that the value of WIDGET is a valid regexp."
3021 (condition-case data
3022 (prog1 nil
3023 (string-match (widget-value widget) ""))
3024 (error (widget-put widget :error (error-message-string data))
3025 widget)))
3027 (define-widget 'file 'string
3028 "A file widget.
3029 It reads a file name from an editable text field."
3030 :complete-function 'widget-file-complete
3031 :prompt-value 'widget-file-prompt-value
3032 :format "%{%t%}: %v"
3033 ;; Doesn't work well with terminating newline.
3034 ;; :value-face 'widget-single-line-field
3035 :tag "File")
3037 (defun widget-file-complete ()
3038 "Perform completion on file name preceding point."
3039 (interactive)
3040 (let* ((end (point))
3041 (beg (widget-field-start widget))
3042 (pattern (buffer-substring beg end))
3043 (name-part (file-name-nondirectory pattern))
3044 ;; I think defaulting to root is right
3045 ;; because these really should be absolute file names.
3046 (directory (or (file-name-directory pattern) "/"))
3047 (completion (file-name-completion name-part directory)))
3048 (cond ((eq completion t))
3049 ((null completion)
3050 (message "Can't find completion for \"%s\"" pattern)
3051 (ding))
3052 ((not (string= name-part completion))
3053 (delete-region beg end)
3054 (insert (expand-file-name completion directory)))
3056 (message "Making completion list...")
3057 (with-output-to-temp-buffer "*Completions*"
3058 (display-completion-list
3059 (sort (file-name-all-completions name-part directory)
3060 'string<)
3061 name-part))
3062 (message "Making completion list...%s" "done")))))
3064 (defun widget-file-prompt-value (widget prompt value unbound)
3065 ;; Read file from minibuffer.
3066 (abbreviate-file-name
3067 (if unbound
3068 (read-file-name prompt)
3069 (let ((prompt2 (format "%s (default %s): " prompt value))
3070 (dir (file-name-directory value))
3071 (file (file-name-nondirectory value))
3072 (must-match (widget-get widget :must-match)))
3073 (read-file-name prompt2 dir nil must-match file)))))
3075 ;;;(defun widget-file-action (widget &optional event)
3076 ;;; ;; Read a file name from the minibuffer.
3077 ;;; (let* ((value (widget-value widget))
3078 ;;; (dir (file-name-directory value))
3079 ;;; (file (file-name-nondirectory value))
3080 ;;; (menu-tag (widget-apply widget :menu-tag-get))
3081 ;;; (must-match (widget-get widget :must-match))
3082 ;;; (answer (read-file-name (concat menu-tag " (default " value "): ")
3083 ;;; dir nil must-match file)))
3084 ;;; (widget-value-set widget (abbreviate-file-name answer))
3085 ;;; (widget-setup)
3086 ;;; (widget-apply widget :notify widget event)))
3088 ;; Fixme: use file-name-as-directory.
3089 (define-widget 'directory 'file
3090 "A directory widget.
3091 It reads a directory name from an editable text field."
3092 :tag "Directory")
3094 (defvar widget-symbol-prompt-value-history nil
3095 "History of input to `widget-symbol-prompt-value'.")
3097 (define-widget 'symbol 'editable-field
3098 "A Lisp symbol."
3099 :value nil
3100 :tag "Symbol"
3101 :format "%{%t%}: %v"
3102 :match (lambda (widget value) (symbolp value))
3103 :complete-function 'lisp-complete-symbol
3104 :prompt-internal 'widget-symbol-prompt-internal
3105 :prompt-match 'symbolp
3106 :prompt-history 'widget-symbol-prompt-value-history
3107 :value-to-internal (lambda (widget value)
3108 (if (symbolp value)
3109 (symbol-name value)
3110 value))
3111 :value-to-external (lambda (widget value)
3112 (if (stringp value)
3113 (intern value)
3114 value)))
3116 (defun widget-symbol-prompt-internal (widget prompt initial history)
3117 ;; Read file from minibuffer.
3118 (let ((answer (completing-read prompt obarray
3119 (widget-get widget :prompt-match)
3120 nil initial history)))
3121 (if (and (stringp answer)
3122 (not (zerop (length answer))))
3123 answer
3124 (error "No value"))))
3126 (defvar widget-function-prompt-value-history nil
3127 "History of input to `widget-function-prompt-value'.")
3129 (define-widget 'function 'restricted-sexp
3130 "A Lisp function."
3131 :complete-function (lambda ()
3132 (interactive)
3133 (lisp-complete-symbol 'fboundp))
3134 :prompt-value 'widget-field-prompt-value
3135 :prompt-internal 'widget-symbol-prompt-internal
3136 :prompt-match 'fboundp
3137 :prompt-history 'widget-function-prompt-value-history
3138 :action 'widget-field-action
3139 :match-alternatives '(functionp)
3140 :validate (lambda (widget)
3141 (unless (functionp (widget-value widget))
3142 (widget-put widget :error (format "Invalid function: %S"
3143 (widget-value widget)))
3144 widget))
3145 :value 'ignore
3146 :tag "Function")
3148 (defvar widget-variable-prompt-value-history nil
3149 "History of input to `widget-variable-prompt-value'.")
3151 (define-widget 'variable 'symbol
3152 "A Lisp variable."
3153 :prompt-match 'boundp
3154 :prompt-history 'widget-variable-prompt-value-history
3155 :complete-function (lambda ()
3156 (interactive)
3157 (lisp-complete-symbol 'boundp))
3158 :tag "Variable")
3160 (defvar widget-coding-system-prompt-value-history nil
3161 "History of input to `widget-coding-system-prompt-value'.")
3163 (define-widget 'coding-system 'symbol
3164 "A MULE coding-system."
3165 :format "%{%t%}: %v"
3166 :tag "Coding system"
3167 :base-only nil
3168 :prompt-history 'widget-coding-system-prompt-value-history
3169 :prompt-value 'widget-coding-system-prompt-value
3170 :action 'widget-coding-system-action
3171 :complete-function (lambda ()
3172 (interactive)
3173 (lisp-complete-symbol 'coding-system-p))
3174 :validate (lambda (widget)
3175 (unless (coding-system-p (widget-value widget))
3176 (widget-put widget :error (format "Invalid coding system: %S"
3177 (widget-value widget)))
3178 widget))
3179 :value 'undecided
3180 :prompt-match 'coding-system-p)
3182 (defun widget-coding-system-prompt-value (widget prompt value unbound)
3183 "Read coding-system from minibuffer."
3184 (if (widget-get widget :base-only)
3185 (intern
3186 (completing-read (format "%s (default %s): " prompt value)
3187 (mapcar #'list (coding-system-list t)) nil nil nil
3188 coding-system-history))
3189 (read-coding-system (format "%s (default %s): " prompt value) value)))
3191 (defun widget-coding-system-action (widget &optional event)
3192 (let ((answer
3193 (widget-coding-system-prompt-value
3194 widget
3195 (widget-apply widget :menu-tag-get)
3196 (widget-value widget)
3197 t)))
3198 (widget-value-set widget answer)
3199 (widget-apply widget :notify widget event)
3200 (widget-setup)))
3202 ;;; I'm not sure about what this is good for? KFS.
3203 (defvar widget-key-sequence-prompt-value-history nil
3204 "History of input to `widget-key-sequence-prompt-value'.")
3206 (defvar widget-key-sequence-default-value [ignore]
3207 "Default value for an empty key sequence.")
3209 (defvar widget-key-sequence-map
3210 (let ((map (make-sparse-keymap)))
3211 (set-keymap-parent map widget-field-keymap)
3212 (define-key map [(control ?q)] 'widget-key-sequence-read-event)
3213 map))
3215 (define-widget 'key-sequence 'restricted-sexp
3216 "A key sequence."
3217 :prompt-value 'widget-field-prompt-value
3218 :prompt-internal 'widget-symbol-prompt-internal
3219 ; :prompt-match 'fboundp ;; What was this good for? KFS
3220 :prompt-history 'widget-key-sequence-prompt-value-history
3221 :action 'widget-field-action
3222 :match-alternatives '(stringp vectorp)
3223 :format "%{%t%}: %v"
3224 :validate 'widget-key-sequence-validate
3225 :value-to-internal 'widget-key-sequence-value-to-internal
3226 :value-to-external 'widget-key-sequence-value-to-external
3227 :value widget-key-sequence-default-value
3228 :keymap widget-key-sequence-map
3229 :help-echo "C-q: insert KEY, EVENT, or CODE; RET: enter value"
3230 :tag "Key sequence")
3232 (defun widget-key-sequence-read-event (ev)
3233 (interactive (list
3234 (let ((inhibit-quit t) quit-flag)
3235 (read-event "Insert KEY, EVENT, or CODE: "))))
3236 (let ((ev2 (and (memq 'down (event-modifiers ev))
3237 (read-event)))
3238 (tr (and (keymapp function-key-map)
3239 (lookup-key function-key-map (vector ev)))))
3240 (when (and (integerp ev)
3241 (or (and (<= ?0 ev) (< ev (+ ?0 (min 10 read-quoted-char-radix))))
3242 (and (<= ?a (downcase ev))
3243 (< (downcase ev) (+ ?a -10 (min 36 read-quoted-char-radix))))))
3244 (setq unread-command-events (cons ev unread-command-events)
3245 ev (read-quoted-char (format "Enter code (radix %d)" read-quoted-char-radix))
3246 tr nil)
3247 (if (and (integerp ev) (not (char-valid-p ev)))
3248 (insert (char-to-string ev)))) ;; throw invalid char error
3249 (setq ev (key-description (list ev)))
3250 (when (arrayp tr)
3251 (setq tr (key-description (list (aref tr 0))))
3252 (if (y-or-n-p (format "Key %s is translated to %s -- use %s? " ev tr tr))
3253 (setq ev tr ev2 nil)))
3254 (insert (if (= (char-before) ?\s) "" " ") ev " ")
3255 (if ev2
3256 (insert (key-description (list ev2)) " "))))
3258 (defun widget-key-sequence-validate (widget)
3259 (unless (or (stringp (widget-value widget))
3260 (vectorp (widget-value widget)))
3261 (widget-put widget :error (format "Invalid key sequence: %S"
3262 (widget-value widget)))
3263 widget))
3265 (defun widget-key-sequence-value-to-internal (widget value)
3266 (if (widget-apply widget :match value)
3267 (if (equal value widget-key-sequence-default-value)
3269 (key-description value))
3270 value))
3272 (defun widget-key-sequence-value-to-external (widget value)
3273 (if (stringp value)
3274 (if (string-match "\\`[[:space:]]*\\'" value)
3275 widget-key-sequence-default-value
3276 (read-kbd-macro value))
3277 value))
3280 (define-widget 'sexp 'editable-field
3281 "An arbitrary Lisp expression."
3282 :tag "Lisp expression"
3283 :format "%{%t%}: %v"
3284 :value nil
3285 :validate 'widget-sexp-validate
3286 :match (lambda (widget value) t)
3287 :value-to-internal 'widget-sexp-value-to-internal
3288 :value-to-external (lambda (widget value) (read value))
3289 :prompt-history 'widget-sexp-prompt-value-history
3290 :prompt-value 'widget-sexp-prompt-value)
3292 (defun widget-sexp-value-to-internal (widget value)
3293 ;; Use pp for printer representation.
3294 (let ((pp (if (symbolp value)
3295 (prin1-to-string value)
3296 (pp-to-string value))))
3297 (while (string-match "\n\\'" pp)
3298 (setq pp (substring pp 0 -1)))
3299 (if (or (string-match "\n\\'" pp)
3300 (> (length pp) 40))
3301 (concat "\n" pp)
3302 pp)))
3304 (defun widget-sexp-validate (widget)
3305 ;; Valid if we can read the string and there is no junk left after it.
3306 (with-temp-buffer
3307 (insert (widget-apply widget :value-get))
3308 (goto-char (point-min))
3309 (let (err)
3310 (condition-case data
3311 (progn
3312 ;; Avoid a confusing end-of-file error.
3313 (skip-syntax-forward "\\s-")
3314 (if (eobp)
3315 (setq err "Empty sexp -- use `nil'?")
3316 (unless (widget-apply widget :match (read (current-buffer)))
3317 (setq err (widget-get widget :type-error))))
3318 ;; Allow whitespace after expression.
3319 (skip-syntax-forward "\\s-")
3320 (if (and (not (eobp))
3321 (not err))
3322 (setq err (format "Junk at end of expression: %s"
3323 (buffer-substring (point)
3324 (point-max))))))
3325 (end-of-file ; Avoid confusing error message.
3326 (setq err "Unbalanced sexp"))
3327 (error (setq err (error-message-string data))))
3328 (if (not err)
3330 (widget-put widget :error err)
3331 widget))))
3333 (defvar widget-sexp-prompt-value-history nil
3334 "History of input to `widget-sexp-prompt-value'.")
3336 (defun widget-sexp-prompt-value (widget prompt value unbound)
3337 ;; Read an arbitrary sexp.
3338 (let ((found (read-string prompt
3339 (if unbound nil (cons (prin1-to-string value) 0))
3340 (widget-get widget :prompt-history))))
3341 (let ((answer (read-from-string found)))
3342 (unless (= (cdr answer) (length found))
3343 (error "Junk at end of expression: %s"
3344 (substring found (cdr answer))))
3345 (car answer))))
3347 (define-widget 'restricted-sexp 'sexp
3348 "A Lisp expression restricted to values that match.
3349 To use this type, you must define :match or :match-alternatives."
3350 :type-error "The specified value is not valid"
3351 :match 'widget-restricted-sexp-match
3352 :value-to-internal (lambda (widget value)
3353 (if (widget-apply widget :match value)
3354 (prin1-to-string value)
3355 value)))
3357 (defun widget-restricted-sexp-match (widget value)
3358 (let ((alternatives (widget-get widget :match-alternatives))
3359 matched)
3360 (while (and alternatives (not matched))
3361 (if (cond ((functionp (car alternatives))
3362 (funcall (car alternatives) value))
3363 ((and (consp (car alternatives))
3364 (eq (car (car alternatives)) 'quote))
3365 (eq value (nth 1 (car alternatives)))))
3366 (setq matched t))
3367 (setq alternatives (cdr alternatives)))
3368 matched))
3370 (define-widget 'integer 'restricted-sexp
3371 "An integer."
3372 :tag "Integer"
3373 :value 0
3374 :type-error "This field should contain an integer"
3375 :match-alternatives '(integerp))
3377 (define-widget 'number 'restricted-sexp
3378 "A number (floating point or integer)."
3379 :tag "Number"
3380 :value 0.0
3381 :type-error "This field should contain a number (floating point or integer)"
3382 :match-alternatives '(numberp))
3384 (define-widget 'float 'restricted-sexp
3385 "A floating point number."
3386 :tag "Floating point number"
3387 :value 0.0
3388 :type-error "This field should contain a floating point number"
3389 :match-alternatives '(floatp))
3391 (define-widget 'character 'editable-field
3392 "A character."
3393 :tag "Character"
3394 :value 0
3395 :size 1
3396 :format "%{%t%}: %v\n"
3397 :valid-regexp "\\`.\\'"
3398 :error "This field should contain a single character"
3399 :value-to-internal (lambda (widget value)
3400 (if (stringp value)
3401 value
3402 (char-to-string value)))
3403 :value-to-external (lambda (widget value)
3404 (if (stringp value)
3405 (aref value 0)
3406 value))
3407 :match (lambda (widget value)
3408 (char-valid-p value)))
3410 (define-widget 'list 'group
3411 "A Lisp list."
3412 :tag "List"
3413 :format "%{%t%}:\n%v")
3415 (define-widget 'vector 'group
3416 "A Lisp vector."
3417 :tag "Vector"
3418 :format "%{%t%}:\n%v"
3419 :match 'widget-vector-match
3420 :value-to-internal (lambda (widget value) (append value nil))
3421 :value-to-external (lambda (widget value) (apply 'vector value)))
3423 (defun widget-vector-match (widget value)
3424 (and (vectorp value)
3425 (widget-group-match widget
3426 (widget-apply widget :value-to-internal value))))
3428 (define-widget 'cons 'group
3429 "A cons-cell."
3430 :tag "Cons-cell"
3431 :format "%{%t%}:\n%v"
3432 :match 'widget-cons-match
3433 :value-to-internal (lambda (widget value)
3434 (list (car value) (cdr value)))
3435 :value-to-external (lambda (widget value)
3436 (apply 'cons value)))
3438 (defun widget-cons-match (widget value)
3439 (and (consp value)
3440 (widget-group-match widget
3441 (widget-apply widget :value-to-internal value))))
3443 ;;; The `lazy' Widget.
3445 ;; Recursive datatypes.
3447 (define-widget 'lazy 'default
3448 "Base widget for recursive datastructures.
3450 The `lazy' widget will, when instantiated, contain a single inferior
3451 widget, of the widget type specified by the :type parameter. The
3452 value of the `lazy' widget is the same as the value of the inferior
3453 widget. When deriving a new widget from the 'lazy' widget, the :type
3454 parameter is allowed to refer to the widget currently being defined,
3455 thus allowing recursive datastructures to be described.
3457 The :type parameter takes the same arguments as the defcustom
3458 parameter with the same name.
3460 Most composite widgets, i.e. widgets containing other widgets, does
3461 not allow recursion. That is, when you define a new widget type, none
3462 of the inferior widgets may be of the same type you are currently
3463 defining.
3465 In Lisp, however, it is custom to define datastructures in terms of
3466 themselves. A list, for example, is defined as either nil, or a cons
3467 cell whose cdr itself is a list. The obvious way to translate this
3468 into a widget type would be
3470 (define-widget 'my-list 'choice
3471 \"A list of sexps.\"
3472 :tag \"Sexp list\"
3473 :args '((const nil) (cons :value (nil) sexp my-list)))
3475 Here we attempt to define my-list as a choice of either the constant
3476 nil, or a cons-cell containing a sexp and my-lisp. This will not work
3477 because the `choice' widget does not allow recursion.
3479 Using the `lazy' widget you can overcome this problem, as in this
3480 example:
3482 (define-widget 'sexp-list 'lazy
3483 \"A list of sexps.\"
3484 :tag \"Sexp list\"
3485 :type '(choice (const nil) (cons :value (nil) sexp sexp-list)))"
3486 :format "%{%t%}: %v"
3487 ;; We don't convert :type because we want to allow recursive
3488 ;; datastructures. This is slow, so we should not create speed
3489 ;; critical widgets by deriving from this.
3490 :convert-widget 'widget-value-convert-widget
3491 :value-create 'widget-type-value-create
3492 :value-get 'widget-child-value-get
3493 :value-inline 'widget-child-value-inline
3494 :default-get 'widget-type-default-get
3495 :match 'widget-type-match
3496 :validate 'widget-child-validate)
3499 ;;; The `plist' Widget.
3501 ;; Property lists.
3503 (define-widget 'plist 'list
3504 "A property list."
3505 :key-type '(symbol :tag "Key")
3506 :value-type '(sexp :tag "Value")
3507 :convert-widget 'widget-plist-convert-widget
3508 :tag "Plist")
3510 (defvar widget-plist-value-type) ;Dynamic variable
3512 (defun widget-plist-convert-widget (widget)
3513 ;; Handle `:options'.
3514 (let* ((options (widget-get widget :options))
3515 (widget-plist-value-type (widget-get widget :value-type))
3516 (other `(editable-list :inline t
3517 (group :inline t
3518 ,(widget-get widget :key-type)
3519 ,widget-plist-value-type)))
3520 (args (if options
3521 (list `(checklist :inline t
3522 :greedy t
3523 ,@(mapcar 'widget-plist-convert-option
3524 options))
3525 other)
3526 (list other))))
3527 (widget-put widget :args args)
3528 widget))
3530 (defun widget-plist-convert-option (option)
3531 ;; Convert a single plist option.
3532 (let (key-type value-type)
3533 (if (listp option)
3534 (let ((key (nth 0 option)))
3535 (setq value-type (nth 1 option))
3536 (if (listp key)
3537 (setq key-type key)
3538 (setq key-type `(const ,key))))
3539 (setq key-type `(const ,option)
3540 value-type widget-plist-value-type))
3541 `(group :format "Key: %v" :inline t ,key-type ,value-type)))
3544 ;;; The `alist' Widget.
3546 ;; Association lists.
3548 (define-widget 'alist 'list
3549 "An association list."
3550 :key-type '(sexp :tag "Key")
3551 :value-type '(sexp :tag "Value")
3552 :convert-widget 'widget-alist-convert-widget
3553 :tag "Alist")
3555 (defvar widget-alist-value-type) ;Dynamic variable
3557 (defun widget-alist-convert-widget (widget)
3558 ;; Handle `:options'.
3559 (let* ((options (widget-get widget :options))
3560 (widget-alist-value-type (widget-get widget :value-type))
3561 (other `(editable-list :inline t
3562 (cons :format "%v"
3563 ,(widget-get widget :key-type)
3564 ,widget-alist-value-type)))
3565 (args (if options
3566 (list `(checklist :inline t
3567 :greedy t
3568 ,@(mapcar 'widget-alist-convert-option
3569 options))
3570 other)
3571 (list other))))
3572 (widget-put widget :args args)
3573 widget))
3575 (defun widget-alist-convert-option (option)
3576 ;; Convert a single alist option.
3577 (let (key-type value-type)
3578 (if (listp option)
3579 (let ((key (nth 0 option)))
3580 (setq value-type (nth 1 option))
3581 (if (listp key)
3582 (setq key-type key)
3583 (setq key-type `(const ,key))))
3584 (setq key-type `(const ,option)
3585 value-type widget-alist-value-type))
3586 `(cons :format "Key: %v" ,key-type ,value-type)))
3588 (define-widget 'choice 'menu-choice
3589 "A union of several sexp types."
3590 :tag "Choice"
3591 :format "%{%t%}: %[Value Menu%] %v"
3592 :button-prefix 'widget-push-button-prefix
3593 :button-suffix 'widget-push-button-suffix
3594 :prompt-value 'widget-choice-prompt-value)
3596 (defun widget-choice-prompt-value (widget prompt value unbound)
3597 "Make a choice."
3598 (let ((args (widget-get widget :args))
3599 (completion-ignore-case (widget-get widget :case-fold))
3600 current choices old)
3601 ;; Find the first arg that matches VALUE.
3602 (let ((look args))
3603 (while look
3604 (if (widget-apply (car look) :match value)
3605 (setq old (car look)
3606 look nil)
3607 (setq look (cdr look)))))
3608 ;; Find new choice.
3609 (setq current
3610 (cond ((= (length args) 0)
3611 nil)
3612 ((= (length args) 1)
3613 (nth 0 args))
3614 ((and (= (length args) 2)
3615 (memq old args))
3616 (if (eq old (nth 0 args))
3617 (nth 1 args)
3618 (nth 0 args)))
3620 (while args
3621 (setq current (car args)
3622 args (cdr args))
3623 (setq choices
3624 (cons (cons (widget-apply current :menu-tag-get)
3625 current)
3626 choices)))
3627 (let ((val (completing-read prompt choices nil t)))
3628 (if (stringp val)
3629 (let ((try (try-completion val choices)))
3630 (when (stringp try)
3631 (setq val try))
3632 (cdr (assoc val choices)))
3633 nil)))))
3634 (if current
3635 (widget-prompt-value current prompt nil t)
3636 value)))
3638 (define-widget 'radio 'radio-button-choice
3639 "A union of several sexp types."
3640 :tag "Choice"
3641 :format "%{%t%}:\n%v"
3642 :prompt-value 'widget-choice-prompt-value)
3644 (define-widget 'repeat 'editable-list
3645 "A variable length homogeneous list."
3646 :tag "Repeat"
3647 :format "%{%t%}:\n%v%i\n")
3649 (define-widget 'set 'checklist
3650 "A list of members from a fixed set."
3651 :tag "Set"
3652 :format "%{%t%}:\n%v")
3654 (define-widget 'boolean 'toggle
3655 "To be nil or non-nil, that is the question."
3656 :tag "Boolean"
3657 :prompt-value 'widget-boolean-prompt-value
3658 :button-prefix 'widget-push-button-prefix
3659 :button-suffix 'widget-push-button-suffix
3660 :format "%{%t%}: %[Toggle%] %v\n"
3661 :on "on (non-nil)"
3662 :off "off (nil)")
3664 (defun widget-boolean-prompt-value (widget prompt value unbound)
3665 ;; Toggle a boolean.
3666 (y-or-n-p prompt))
3668 ;;; The `color' Widget.
3670 ;; Fixme: match
3671 (define-widget 'color 'editable-field
3672 "Choose a color name (with sample)."
3673 :format "%{%t%}: %v (%{sample%})\n"
3674 :size 10
3675 :tag "Color"
3676 :value "black"
3677 :complete 'widget-color-complete
3678 :sample-face-get 'widget-color-sample-face-get
3679 :notify 'widget-color-notify
3680 :action 'widget-color-action)
3682 (defun widget-color-complete (widget)
3683 "Complete the color in WIDGET."
3684 (require 'facemenu) ; for facemenu-color-alist
3685 (let* ((prefix (buffer-substring-no-properties (widget-field-start widget)
3686 (point)))
3687 (list (or facemenu-color-alist (defined-colors)))
3688 (completion (try-completion prefix list)))
3689 (cond ((eq completion t)
3690 (message "Exact match."))
3691 ((null completion)
3692 (error "Can't find completion for \"%s\"" prefix))
3693 ((not (string-equal prefix completion))
3694 (insert-and-inherit (substring completion (length prefix))))
3696 (message "Making completion list...")
3697 (with-output-to-temp-buffer "*Completions*"
3698 (display-completion-list (all-completions prefix list nil)
3699 prefix))
3700 (message "Making completion list...done")))))
3702 (defun widget-color-sample-face-get (widget)
3703 (let* ((value (condition-case nil
3704 (widget-value widget)
3705 (error (widget-get widget :value)))))
3706 (if (color-defined-p value)
3707 (list (cons 'foreground-color value))
3708 'default)))
3710 (defun widget-color-action (widget &optional event)
3711 "Prompt for a color."
3712 (let* ((tag (widget-apply widget :menu-tag-get))
3713 (prompt (concat tag ": "))
3714 (value (widget-value widget))
3715 (start (widget-field-start widget))
3716 (answer (facemenu-read-color prompt)))
3717 (unless (zerop (length answer))
3718 (widget-value-set widget answer)
3719 (widget-setup)
3720 (widget-apply widget :notify widget event))))
3722 (defun widget-color-notify (widget child &optional event)
3723 "Update the sample, and notify the parent."
3724 (overlay-put (widget-get widget :sample-overlay)
3725 'face (widget-apply widget :sample-face-get))
3726 (widget-default-notify widget child event))
3728 ;;; The Help Echo
3730 (defun widget-echo-help (pos)
3731 "Display help-echo text for widget at POS."
3732 (let* ((widget (widget-at pos))
3733 (help-echo (and widget (widget-get widget :help-echo))))
3734 (if (functionp help-echo)
3735 (setq help-echo (funcall help-echo widget)))
3736 (if help-echo (message "%s" (eval help-echo)))))
3738 ;;; The End:
3740 (provide 'wid-edit)
3742 ;;; arch-tag: a076e75e-18a1-4b46-8be5-3f317bcbc707
3743 ;;; wid-edit.el ends here