1 ;;; wid-edit.el --- Functions for creating and using widgets -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1996, 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7 ;; Keywords: extensions
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Wishlist items (from widget.texi):
28 ;; * The `menu-choice' tag should be prettier, something like the
29 ;; abbreviated menus in Open Look.
31 ;; * Finish `:tab-order'.
33 ;; * Make indentation work with glyphs and proportional fonts.
35 ;; * Add commands to show overview of object and class hierarchies to
38 ;; * Find a way to disable mouse highlight for inactive widgets.
40 ;; * Find a way to make glyphs look inactive.
42 ;; * Add `key-binding' widget.
44 ;; * Add `widget' widget for editing widget specifications.
46 ;; * Find clean way to implement variable length list. See
47 ;; `TeX-printer-list' for an explanation.
49 ;; * `C-h' in `widget-prompt-value' should give type specific help.
51 ;; * A mailto widget. [This should work OK as a url-link if with
52 ;; browse-url-browser-function' set up appropriately.]
62 (defun widget-event-point (event)
63 "Character position of the end of event if that exists, or nil."
64 (posn-point (event-end event)))
66 (autoload 'pp-to-string "pp")
67 (autoload 'Info-goto-node "info")
69 (defun widget-button-release-event-p (event)
70 "Non-nil if EVENT is a mouse-button-release event object."
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)))))
79 "Customization support for the Widget Library."
80 :link '(custom-manual "(widget)Top")
81 :link '(emacs-library-link :tag "Lisp File" "widget.el")
86 (defgroup widget-documentation nil
87 "Options controling the display of documentation strings."
90 (defgroup widget-faces nil
91 "Faces used by the widget library."
95 (defvar widget-documentation-face 'widget-documentation-face
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-face '((((class color)
101 (:foreground "lime green"))
104 (:foreground "dark green"))
106 "Face used for documentation text."
107 :group 'widget-documentation
108 :group 'widget-faces)
110 (defvar widget-button-face 'widget-button-face
111 "Face used for buttons in widgets.
112 This exists as a variable so it can be set locally in certain buffers.")
114 (defface widget-button-face '((t (:bold t)))
115 "Face used for widget buttons."
116 :group 'widget-faces)
118 (defcustom widget-mouse-face 'highlight
119 "Face used for widget buttons when the mouse is above them."
121 :group 'widget-faces)
123 ;; TTY gets special definitions here and in the next defface, because
124 ;; the gray colors defined for other displays cause black text on a black
125 ;; background, at least on light-background TTYs.
126 (defface widget-field-face '((((type tty))
127 (:background "yellow3"))
128 (((class grayscale color)
130 (:background "gray85"))
131 (((class grayscale color)
133 (:background "dim gray"))
136 "Face used for editable fields."
137 :group 'widget-faces)
139 (defface widget-single-line-field-face '((((type tty))
140 (:background "green3"))
141 (((class grayscale color)
143 (:background "gray85"))
144 (((class grayscale color)
146 (:background "dim gray"))
149 "Face used for editable fields spanning only a single line."
150 :group 'widget-faces)
152 ;;; This causes display-table to be loaded, and not usefully.
153 ;;;(defvar widget-single-line-display-table
154 ;;; (let ((table (make-display-table)))
155 ;;; (aset table 9 "^I")
156 ;;; (aset table 10 "^J")
158 ;;; "Display table used for single-line editable fields.")
160 ;;;(when (fboundp 'set-face-display-table)
161 ;;; (set-face-display-table 'widget-single-line-field-face
162 ;;; widget-single-line-display-table))
164 ;;; Utility functions.
166 ;; These are not really widget specific.
168 (defun widget-princ-to-string (object)
169 "Return string representation of OBJECT, any Lisp object.
170 No quoting characters are used; no delimiters are printed around
171 the contents of strings."
172 (with-output-to-string
175 (defun widget-clear-undo ()
176 "Clear all undo information."
177 (buffer-disable-undo (current-buffer))
178 (buffer-enable-undo))
180 (defcustom widget-menu-max-size 40
181 "Largest number of items allowed in a popup-menu.
182 Larger menus are read through the minibuffer."
186 (defcustom widget-menu-max-shortcuts 40
187 "Largest number of items for which it works to choose one with a character.
188 For a larger number of items, the minibuffer is used."
192 (defcustom widget-menu-minibuffer-flag nil
193 "*Control how to ask for a choice from the keyboard.
194 Non-nil means use the minibuffer;
195 nil means read a single character."
199 (defun widget-choose (title items &optional event)
200 "Choose an item from a list.
202 First argument TITLE is the name of the list.
203 Second argument ITEMS is an list whose members are either
204 (NAME . VALUE), to indicate selectable items, or just strings to
205 indicate unselectable items.
206 Optional third argument EVENT is an input event.
208 The user is asked to choose between each NAME from the items alist,
209 and the VALUE of the chosen element will be returned. If EVENT is a
210 mouse event, and the number of elements in items is less than
211 `widget-menu-max-size', a popup menu will be used, otherwise the
213 (cond ((and (< (length items) widget-menu-max-size)
214 event (display-popup-menus-p))
217 (list title (cons "" items))))
218 ((or widget-menu-minibuffer-flag
219 (> (length items) widget-menu-max-shortcuts))
220 ;; Read the choice of name from the minibuffer.
221 (setq items (widget-remove-if 'stringp items))
222 (let ((val (completing-read (concat title ": ") items nil t)))
224 (let ((try (try-completion val items)))
227 (cdr (assoc val items))))))
229 ;; Construct a menu of the choices
230 ;; and then use it for prompting for a single character.
231 (let* ((overriding-terminal-local-map (make-sparse-keymap))
233 map choice some-choice-enabled value)
234 ;; Define SPC as a prefix char to get to this menu.
235 (define-key overriding-terminal-local-map " "
236 (setq map (make-sparse-keymap title)))
238 (set-buffer (get-buffer-create " widget-choose"))
240 (insert "Available choices:\n\n")
242 (setq choice (car items) items (cdr items))
244 (let* ((name (car choice))
245 (function (cdr choice)))
246 (insert (format "%c = %s\n" next-digit name))
247 (define-key map (vector next-digit) function)
248 (setq some-choice-enabled t)))
249 ;; Allocate digits to disabled alternatives
250 ;; so that the digit of a given alternative never varies.
251 (setq next-digit (1+ next-digit)))
252 (insert "\nC-g = Quit"))
253 (or some-choice-enabled
254 (error "None of the choices is currently meaningful"))
255 (define-key map [?\C-g] 'keyboard-quit)
256 (define-key map [t] 'keyboard-quit)
257 (define-key map [?\M-\C-v] 'scroll-other-window)
258 (define-key map [?\M--] 'negative-argument)
259 (setcdr map (nreverse (cdr map)))
260 ;; Read a char with the menu, and return the result
261 ;; that corresponds to it.
262 (save-window-excursion
263 (let ((buf (get-buffer " widget-choose")))
264 (fit-window-to-buffer (display-buffer buf))
265 (let ((cursor-in-echo-area t)
269 (while (not (or (and (>= char ?0) (< char next-digit))
270 (eq value 'keyboard-quit)))
271 ;; Unread a SPC to lead to our new menu.
272 (setq unread-command-events (cons ?\ unread-command-events))
273 (setq keys (read-key-sequence title))
275 (lookup-key overriding-terminal-local-map keys t)
276 char (string-to-char (substring keys 1)))
277 (cond ((eq value 'scroll-other-window)
278 (let ((minibuffer-scroll-window
279 (get-buffer-window buf)))
281 (scroll-other-window-down
282 (window-height minibuffer-scroll-window))
283 (scroll-other-window))
285 ((eq value 'negative-argument)
289 (when (eq value 'keyboard-quit)
293 (defun widget-remove-if (predictate list)
294 (let (result (tail list))
296 (or (funcall predictate (car tail))
297 (setq result (cons (car tail) result)))
298 (setq tail (cdr tail)))
301 ;;; Widget text specifications.
303 ;; These functions are for specifying text properties.
305 (defvar widget-field-add-space t
306 "Non-nil means add extra space at the end of editable text fields.
307 If you don't add the space, it will become impossible to edit a zero
310 (defvar widget-field-use-before-change t
311 "Non-nil means use `before-change-functions' to track editable fields.
312 This enables the use of undo, but doesn't work on Emacs 19.34 and earlier.
313 Using before hooks also means that the :notify function can't know the
316 (defun widget-specify-field (widget from to)
317 "Specify editable button for WIDGET between FROM and TO."
318 ;; Terminating space is not part of the field, but necessary in
319 ;; order for local-map to work. Remove next sexp if local-map works
320 ;; at the end of the overlay.
323 (cond ((null (widget-get widget :size))
325 (widget-field-add-space
326 (insert-and-inherit " ")))
328 (let ((keymap (widget-get widget :keymap))
329 (face (or (widget-get widget :value-face) 'widget-field-face))
330 (help-echo (widget-get widget :help-echo))
332 (or (not widget-field-add-space) (widget-get widget :size))))
333 (if (functionp help-echo)
334 (setq help-echo 'widget-mouse-help))
335 (when (= (char-before to) ?\n)
336 ;; When the last character in the field is a newline, we want to
337 ;; give it a `field' char-property of `boundary', which helps the
338 ;; C-n/C-p act more naturally when entering/leaving the field. We
339 ;; do this by making a small secondary overlay to contain just that
341 (let ((overlay (make-overlay (1- to) to nil t nil)))
342 (overlay-put overlay 'field 'boundary)
343 ;; Use `local-map' here, not `keymap', so that normal editing
344 ;; works in the field when, say, Custom uses `suppress-keymap'.
345 (overlay-put overlay 'local-map keymap)
346 (overlay-put overlay 'face face)
347 (overlay-put overlay 'help-echo help-echo))
349 (setq rear-sticky t))
350 (let ((overlay (make-overlay from to nil nil rear-sticky)))
351 (widget-put widget :field-overlay overlay)
352 ;;(overlay-put overlay 'detachable nil)
353 (overlay-put overlay 'field widget)
354 (overlay-put overlay 'local-map keymap)
355 (overlay-put overlay 'face face)
356 (overlay-put overlay 'help-echo help-echo)))
357 (widget-specify-secret widget))
359 (defun widget-specify-secret (field)
360 "Replace text in FIELD with value of `:secret', if non-nil."
361 (let ((secret (widget-get field :secret))
362 (size (widget-get field :size)))
364 (let ((begin (widget-field-start field))
365 (end (widget-field-end field)))
367 (while (and (> end begin)
368 (eq (char-after (1- end)) ?\ ))
369 (setq end (1- end))))
371 (let ((old (char-after begin)))
372 (unless (eq old secret)
373 (subst-char-in-region begin (1+ begin) old secret)
374 (put-text-property begin (1+ begin) 'secret old))
375 (setq begin (1+ begin))))))))
377 (defun widget-specify-button (widget from to)
378 "Specify button for WIDGET between FROM and TO."
379 (let ((overlay (make-overlay from to nil t nil))
380 (help-echo (widget-get widget :help-echo)))
381 (widget-put widget :button-overlay overlay)
382 (if (functionp help-echo)
383 (setq help-echo 'widget-mouse-help))
384 (overlay-put overlay 'button widget)
385 (overlay-put overlay 'keymap (widget-get widget :keymap))
386 ;; We want to avoid the face with image buttons.
387 (unless (widget-get widget :suppress-face)
388 (overlay-put overlay 'face (widget-apply widget :button-face-get))
389 (overlay-put overlay 'mouse-face widget-mouse-face))
390 (overlay-put overlay 'help-echo help-echo)))
392 (defun widget-mouse-help (window overlay point)
393 "Help-echo callback for widgets whose :help-echo is a function."
394 (with-current-buffer (overlay-buffer overlay)
395 (let* ((widget (widget-at (overlay-start overlay)))
396 (help-echo (if widget (widget-get widget :help-echo))))
397 (if (functionp help-echo)
398 (funcall help-echo widget)
401 (defun widget-specify-sample (widget from to)
402 "Specify sample for WIDGET between FROM and TO."
403 (let ((overlay (make-overlay from to nil t nil)))
404 (overlay-put overlay 'face (widget-apply widget :sample-face-get))
405 (widget-put widget :sample-overlay overlay)))
407 (defun widget-specify-doc (widget from to)
408 "Specify documentation for WIDGET between FROM and TO."
409 (let ((overlay (make-overlay from to nil t nil)))
410 (overlay-put overlay 'widget-doc widget)
411 (overlay-put overlay 'face widget-documentation-face)
412 (widget-put widget :doc-overlay overlay)))
414 (defmacro widget-specify-insert (&rest form)
415 "Execute FORM without inheriting any text properties."
417 (let ((inhibit-read-only t)
418 (inhibit-modification-hooks t)
421 (narrow-to-region (- (point) 2) (point))
422 (goto-char (1+ (point-min)))
423 (setq result (progn ,@form))
424 (delete-region (point-min) (1+ (point-min)))
425 (delete-region (1- (point-max)) (point-max))
426 (goto-char (point-max))
429 (defface widget-inactive-face '((((class grayscale color)
431 (:foreground "light gray"))
432 (((class grayscale color)
434 (:foreground "dim gray"))
437 "Face used for inactive widgets."
438 :group 'widget-faces)
440 (defun widget-specify-inactive (widget from to)
441 "Make WIDGET inactive for user modifications."
442 (unless (widget-get widget :inactive)
443 (let ((overlay (make-overlay from to nil t nil)))
444 (overlay-put overlay 'face 'widget-inactive-face)
445 ;; This is disabled, as it makes the mouse cursor change shape.
446 ;; (overlay-put overlay 'mouse-face 'widget-inactive-face)
447 (overlay-put overlay 'evaporate t)
448 (overlay-put overlay 'priority 100)
449 (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
450 (widget-put widget :inactive overlay))))
452 (defun widget-overlay-inactive (&rest junk)
453 "Ignoring the arguments, signal an error."
454 (unless inhibit-read-only
455 (error "The widget here is not active")))
458 (defun widget-specify-active (widget)
459 "Make WIDGET active for user modifications."
460 (let ((inactive (widget-get widget :inactive)))
462 (delete-overlay inactive)
463 (widget-put widget :inactive nil))))
465 ;;; Widget Properties.
467 (defsubst widget-type (widget)
468 "Return the type of WIDGET, a symbol."
471 (defun widget-get-indirect (widget property)
472 "In WIDGET, get the value of PROPERTY.
473 If the value is a symbol, return its binding.
474 Otherwise, just return the value."
475 (let ((value (widget-get widget property)))
480 (defun widget-member (widget property)
481 "Non-nil iff there is a definition in WIDGET for PROPERTY."
482 (cond ((plist-member (cdr widget) property)
485 (widget-member (get (car widget) 'widget-type) property))
488 (defun widget-value (widget)
489 "Extract the current value of WIDGET."
491 :value-to-external (widget-apply widget :value-get)))
493 (defun widget-value-set (widget value)
494 "Set the current value of WIDGET to VALUE."
496 :value-set (widget-apply widget
497 :value-to-internal value)))
499 (defun widget-default-get (widget)
500 "Extract the default value of WIDGET."
501 (or (widget-get widget :value)
502 (widget-apply widget :default-get)))
504 (defun widget-match-inline (widget vals)
505 "In WIDGET, match the start of VALS."
506 (cond ((widget-get widget :inline)
507 (widget-apply widget :match-inline vals))
509 (widget-apply widget :match (car vals)))
510 (cons (list (car vals)) (cdr vals)))
513 (defun widget-apply-action (widget &optional event)
514 "Apply :action in WIDGET in response to EVENT."
515 (if (widget-apply widget :active)
516 (widget-apply widget :action event)
517 (error "Attempt to perform action on inactive widget")))
519 ;;; Helper functions.
521 ;; These are widget specific.
524 (defun widget-prompt-value (widget prompt &optional value unbound)
525 "Prompt for a value matching WIDGET, using PROMPT.
526 The current value is assumed to be VALUE, unless UNBOUND is non-nil."
527 (unless (listp widget)
528 (setq widget (list widget)))
529 (setq prompt (format "[%s] %s" (widget-type widget) prompt))
530 (setq widget (widget-convert widget))
531 (let ((answer (widget-apply widget :prompt-value prompt value unbound)))
532 (unless (widget-apply widget :match answer)
533 (error "Value does not match %S type" (car widget)))
536 (defun widget-get-sibling (widget)
537 "Get the item WIDGET is assumed to toggle.
538 This is only meaningful for radio buttons or checkboxes in a list."
539 (let* ((children (widget-get (widget-get widget :parent) :children))
543 (setq child (car children)
544 children (cdr children))
545 (when (eq (widget-get child :button) widget)
546 (throw 'child child)))
549 (defun widget-map-buttons (function &optional buffer maparg)
550 "Map FUNCTION over the buttons in BUFFER.
551 FUNCTION is called with the arguments WIDGET and MAPARG.
553 If FUNCTION returns non-nil, the walk is cancelled.
555 The arguments MAPARG, and BUFFER default to nil and (current-buffer),
557 (let ((cur (point-min))
561 (save-excursion (set-buffer buffer) (overlay-lists))
563 (setq overlays (append (car overlays) (cdr overlays)))
564 (while (setq cur (pop overlays))
565 (setq widget (overlay-get cur 'button))
566 (if (and widget (funcall function widget maparg))
567 (setq overlays nil)))))
571 (defcustom widget-image-directory (file-name-as-directory
572 (expand-file-name "custom" data-directory))
573 "Where widget button images are located.
574 If this variable is nil, widget will try to locate the directory
579 (defcustom widget-image-enable t
580 "If non nil, use image buttons in widgets when available."
585 (defcustom widget-image-conversion
586 '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg")
588 "Conversion alist from image formats to file name suffixes."
590 :type '(repeat (cons :format "%v"
591 (symbol :tag "Image Format" unknown)
592 (repeat :tag "Suffixes"
593 (string :format "%v")))))
595 (defun widget-image-find (image)
596 "Create a graphical button from IMAGE.
597 IMAGE should either already be an image, or be a file name sans
598 extension (xpm, xbm, gif, jpg, or png) located in
599 `widget-image-directory' or otherwise where `find-image' will find it."
600 (cond ((not (and image widget-image-enable (display-graphic-p)))
601 ;; We don't want or can't use images.
604 (eq 'image (car image)))
605 ;; Already an image spec. Use it.
608 ;; A string. Look it up in relevant directories.
609 (let* ((load-path (cons widget-image-directory load-path))
611 (dolist (elt widget-image-conversion)
612 (dolist (ext (cdr elt))
613 (push (list :type (car elt) :file (concat image ext)) specs)))
614 (setq specs (nreverse specs))
620 (defvar widget-button-pressed-face 'widget-button-pressed-face
621 "Face used for pressed buttons in widgets.
622 This exists as a variable so it can be set locally in certain
625 (defun widget-image-insert (widget tag image &optional down inactive)
626 "In WIDGET, insert the text TAG or, if supported, IMAGE.
627 IMAGE should either be an image or an image file name sans extension
628 \(xpm, xbm, gif, jpg, or png) located in `widget-image-directory'.
630 Optional arguments DOWN and INACTIVE are used instead of IMAGE when the
631 button is pressed or inactive, respectively. These are currently ignored."
632 (if (and (display-graphic-p)
633 (setq image (widget-image-find image)))
634 (progn (widget-put widget :suppress-face t)
637 tag 'mouse-face widget-button-pressed-face)))
642 (defgroup widget-button nil
643 "The look of various kinds of buttons."
646 (defcustom widget-button-prefix ""
647 "String used as prefix for buttons."
649 :group 'widget-button)
651 (defcustom widget-button-suffix ""
652 "String used as suffix for buttons."
654 :group 'widget-button)
656 ;;; Creating Widgets.
659 (defun widget-create (type &rest args)
660 "Create widget of TYPE.
661 The optional ARGS are additional keyword arguments."
662 (let ((widget (apply 'widget-convert type args)))
663 (widget-apply widget :create)
666 (defun widget-create-child-and-convert (parent type &rest args)
667 "As part of the widget PARENT, create a child widget TYPE.
668 The child is converted, using the keyword arguments ARGS."
669 (let ((widget (apply 'widget-convert type args)))
670 (widget-put widget :parent parent)
671 (unless (widget-get widget :indent)
672 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
673 (or (widget-get widget :extra-offset) 0)
674 (widget-get parent :offset))))
675 (widget-apply widget :create)
678 (defun widget-create-child (parent type)
679 "Create widget of TYPE."
680 (let ((widget (copy-sequence type)))
681 (widget-put widget :parent parent)
682 (unless (widget-get widget :indent)
683 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
684 (or (widget-get widget :extra-offset) 0)
685 (widget-get parent :offset))))
686 (widget-apply widget :create)
689 (defun widget-create-child-value (parent type value)
690 "Create widget of TYPE with value VALUE."
691 (let ((widget (copy-sequence type)))
692 (widget-put widget :value (widget-apply widget :value-to-internal value))
693 (widget-put widget :parent parent)
694 (unless (widget-get widget :indent)
695 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
696 (or (widget-get widget :extra-offset) 0)
697 (widget-get parent :offset))))
698 (widget-apply widget :create)
702 (defun widget-delete (widget)
704 (widget-apply widget :delete))
706 (defun widget-convert (type &rest args)
707 "Convert TYPE to a widget without inserting it in the buffer.
708 The optional ARGS are additional keyword arguments."
709 ;; Don't touch the type.
710 (let* ((widget (if (symbolp type)
712 (copy-sequence type)))
715 ;; First set the :args keyword.
716 (while (cdr current) ;Look in the type.
717 (if (keywordp (car (cdr current)))
718 (setq current (cdr (cdr current)))
719 (setcdr current (list :args (cdr current)))
721 (while args ;Look in the args.
722 (if (keywordp (nth 0 args))
723 (setq args (nthcdr 2 args))
724 (widget-put widget :args args)
726 ;; Then Convert the widget.
729 (let ((convert-widget (plist-get (cdr type) :convert-widget)))
731 (setq widget (funcall convert-widget widget))))
732 (setq type (get (car type) 'widget-type)))
733 ;; Finally set the keyword args.
735 (let ((next (nth 0 keys)))
738 (widget-put widget next (nth 1 keys))
739 (setq keys (nthcdr 2 keys)))
741 ;; Convert the :value to internal format.
742 (if (widget-member widget :value)
744 :value (widget-apply widget
746 (widget-get widget :value))))
747 ;; Return the newly create widget.
750 (defun widget-insert (&rest args)
751 "Call `insert' with ARGS even if surrounding text is read only."
752 (let ((inhibit-read-only t)
753 (inhibit-modification-hooks t))
754 (apply 'insert args)))
756 (defun widget-convert-text (type from to
757 &optional button-from button-to
759 "Return a widget of type TYPE with endpoint FROM TO.
760 Optional ARGS are extra keyword arguments for TYPE.
761 and TO will be used as the widgets end points. If optional arguments
762 BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets
764 Optional ARGS are extra keyword arguments for TYPE."
765 (let ((widget (apply 'widget-convert type :delete 'widget-leave-text args))
766 (from (copy-marker from))
767 (to (copy-marker to)))
768 (set-marker-insertion-type from t)
769 (set-marker-insertion-type to nil)
770 (widget-put widget :from from)
771 (widget-put widget :to to)
773 (widget-specify-button widget button-from button-to))
776 (defun widget-convert-button (type from to &rest args)
777 "Return a widget of type TYPE with endpoint FROM TO.
778 Optional ARGS are extra keyword arguments for TYPE.
779 No text will be inserted to the buffer, instead the text between FROM
780 and TO will be used as the widgets end points, as well as the widgets
782 (apply 'widget-convert-text type from to from to args))
784 (defun widget-leave-text (widget)
785 "Remove markers and overlays from WIDGET and its children."
786 (let ((button (widget-get widget :button-overlay))
787 (sample (widget-get widget :sample-overlay))
788 (doc (widget-get widget :doc-overlay))
789 (field (widget-get widget :field-overlay)))
790 (set-marker (widget-get widget :from) nil)
791 (set-marker (widget-get widget :to) nil)
793 (delete-overlay button))
795 (delete-overlay sample))
797 (delete-overlay doc))
799 (delete-overlay field))
800 (mapc 'widget-leave-text (widget-get widget :children))))
802 ;;; Keymap and Commands.
804 (defvar widget-keymap
805 (let ((map (make-sparse-keymap)))
806 (define-key map "\t" 'widget-forward)
807 (define-key map [(shift tab)] 'widget-backward)
808 (define-key map [backtab] 'widget-backward)
809 (define-key map [down-mouse-2] 'widget-button-click)
810 (define-key map "\C-m" 'widget-button-press)
812 "Keymap containing useful binding for buffers containing widgets.
813 Recommended as a parent keymap for modes using widgets.")
815 (defvar widget-global-map global-map
816 "Keymap used for events a widget does not handle itself.")
817 (make-variable-buffer-local 'widget-global-map)
819 (defvar widget-field-keymap
820 (let ((map (copy-keymap widget-keymap)))
821 (define-key map "\C-k" 'widget-kill-line)
822 (define-key map "\M-\t" 'widget-complete)
823 (define-key map "\C-m" 'widget-field-activate)
824 ;; Since the widget code uses a `field' property to identify fields,
825 ;; ordinary beginning-of-line does the right thing.
826 ;; (define-key map "\C-a" 'widget-beginning-of-line)
827 (define-key map "\C-e" 'widget-end-of-line)
829 "Keymap used inside an editable field.")
831 (defvar widget-text-keymap
832 (let ((map (copy-keymap widget-keymap)))
833 ;; Since the widget code uses a `field' property to identify fields,
834 ;; ordinary beginning-of-line does the right thing.
835 ;; (define-key map "\C-a" 'widget-beginning-of-line)
836 (define-key map "\C-e" 'widget-end-of-line)
838 "Keymap used inside a text field.")
840 (defun widget-field-activate (pos &optional event)
841 "Invoke the editable field at point."
843 (let ((field (widget-field-at pos)))
845 (widget-apply-action field event)
847 (lookup-key widget-global-map (this-command-keys))))))
849 (defface widget-button-pressed-face
853 (:bold t :underline t)))
854 "Face used for pressed buttons."
855 :group 'widget-faces)
857 (defun widget-button-click (event)
858 "Invoke the button that the mouse is pointing at."
860 (if (widget-event-point event)
861 (let* ((pos (widget-event-point event))
862 (start (event-start event))
863 (button (get-char-property
864 pos 'button (and (windowp (posn-window start))
865 (window-buffer (posn-window start))))))
867 ;; Mouse click on a widget button. Do the following
868 ;; in a save-excursion so that the click on the button
869 ;; doesn't change point.
870 (save-selected-window
871 (select-window (posn-window (event-start event)))
873 (goto-char (posn-point (event-start event)))
874 (let* ((overlay (widget-get button :button-overlay))
875 (face (overlay-get overlay 'face))
876 (mouse-face (overlay-get overlay 'mouse-face)))
878 ;; Read events, including mouse-movement events
879 ;; until we receive a release event. Highlight/
880 ;; unhighlight the button the mouse was initially
881 ;; on when we move over it.
882 (let ((track-mouse t))
884 (when face ; avoid changing around image
886 'face widget-button-pressed-face)
888 'mouse-face widget-button-pressed-face))
889 (unless (widget-apply button :mouse-down-action event)
890 (while (not (widget-button-release-event-p event))
891 (setq event (read-event)
892 pos (widget-event-point event))
894 (eq (get-char-property pos 'button)
899 widget-button-pressed-face)
902 widget-button-pressed-face))
903 (overlay-put overlay 'face face)
904 (overlay-put overlay 'mouse-face mouse-face))))
906 ;; When mouse is released over the button, run
907 ;; its action function.
909 (eq (get-char-property pos 'button) button))
910 (widget-apply-action button event))))
911 (overlay-put overlay 'face face)
912 (overlay-put overlay 'mouse-face mouse-face))))
914 (unless (pos-visible-in-window-p (widget-event-point event))
915 (mouse-set-point event)
920 (let ((up t) command)
921 ;; Mouse click not on a widget button. Find the global
922 ;; command to run, and check whether it is bound to an
924 (mouse-set-point event)
925 (if (memq (event-basic-type event) '(mouse-1 down-mouse-1))
926 (cond ((setq command ;down event
927 (lookup-key widget-global-map [down-mouse-1]))
929 ((setq command ;up event
930 (lookup-key widget-global-map [mouse-1]))))
931 (cond ((setq command ;down event
932 (lookup-key widget-global-map [down-mouse-2]))
934 ((setq command ;up event
935 (lookup-key widget-global-map [mouse-2])))))
937 ;; Don't execute up events twice.
938 (while (not (widget-button-release-event-p event))
939 (setq event (read-event))))
941 (call-interactively command)))))
942 (message "You clicked somewhere weird.")))
944 (defun widget-button-press (pos &optional event)
945 "Invoke button at POS."
947 (let ((button (get-char-property pos 'button)))
949 (widget-apply-action button event)
950 (let ((command (lookup-key widget-global-map (this-command-keys))))
951 (when (commandp command)
952 (call-interactively command))))))
954 (defun widget-tabable-at (&optional pos)
955 "Return the tabable widget at POS, or nil.
956 POS defaults to the value of (point)."
957 (let ((widget (widget-at pos)))
959 (let ((order (widget-get widget :tab-order)))
965 (defvar widget-use-overlay-change t
966 "If non-nil, use overlay change functions to tab around in the buffer.
967 This is much faster, but doesn't work reliably on Emacs 19.34.")
969 (defun widget-move (arg)
970 "Move point to the ARG next field or button.
971 ARG may be negative to move backward."
972 (or (bobp) (> arg 0) (backward-char))
975 (old (widget-tabable-at))
980 (goto-char (point-min)))
981 (widget-use-overlay-change
982 (goto-char (next-overlay-change (point))))
985 (and (eq pos (point))
987 (error "No buttons or fields found"))
988 (let ((new (widget-tabable-at)))
996 (goto-char (point-max)))
997 (widget-use-overlay-change
998 (goto-char (previous-overlay-change (point))))
1001 (and (eq pos (point))
1003 (error "No buttons or fields found"))
1004 (let ((new (widget-tabable-at)))
1006 (unless (eq new old)
1007 (setq arg (1+ arg))))))
1008 (let ((new (widget-tabable-at)))
1009 (while (eq (widget-tabable-at) new)
1012 (widget-echo-help (point))
1013 (run-hooks 'widget-move-hook))
1015 (defun widget-forward (arg)
1016 "Move point to the next field or button.
1017 With optional ARG, move across that many fields."
1019 (run-hooks 'widget-forward-hook)
1022 (defun widget-backward (arg)
1023 "Move point to the previous field or button.
1024 With optional ARG, move across that many fields."
1026 (run-hooks 'widget-backward-hook)
1027 (widget-move (- arg)))
1029 ;; Since the widget code uses a `field' property to identify fields,
1030 ;; ordinary beginning-of-line does the right thing.
1031 (defalias 'widget-beginning-of-line 'beginning-of-line)
1033 (defun widget-end-of-line ()
1034 "Go to end of field or end of line, whichever is first.
1035 Trailing spaces at the end of padded fields are not considered part of
1038 ;; Ordinary end-of-line does the right thing, because we're inside
1039 ;; text with a `field' property.
1042 ;; ... except that we want to ignore trailing spaces in fields that
1043 ;; aren't terminated by a newline, because they are used as padding,
1044 ;; and ignored when extracting the entered value of the field.
1045 (skip-chars-backward " " (field-beginning (1- (point))))))
1047 (defun widget-kill-line ()
1048 "Kill to end of field or end of line, whichever is first."
1050 (let* ((field (widget-field-find (point)))
1051 (end (and field (widget-field-end field))))
1052 (if (and field (> (line-beginning-position 2) end))
1053 (kill-region (point) end)
1054 (call-interactively 'kill-line))))
1056 (defcustom widget-complete-field (lookup-key global-map "\M-\t")
1057 "Default function to call for completion inside fields."
1058 :options '(ispell-complete-word complete-tag lisp-complete-symbol)
1062 (defun widget-complete ()
1063 "Complete content of editable field from point.
1064 When not inside a field, move to the previous button or field."
1066 (let ((field (widget-field-find (point))))
1068 (widget-apply field :complete)
1069 (error "Not in an editable field"))))
1071 ;;; Setting up the buffer.
1073 (defvar widget-field-new nil)
1074 ;; List of all newly created editable fields in the buffer.
1075 (make-variable-buffer-local 'widget-field-new)
1077 (defvar widget-field-list nil)
1078 ;; List of all editable fields in the buffer.
1079 (make-variable-buffer-local 'widget-field-list)
1081 (defun widget-at (&optional pos)
1082 "The button or field at POS (default, point)."
1083 (or (get-char-property (or pos (point)) 'button)
1084 (widget-field-at pos)))
1086 (defun widget-setup ()
1087 "Setup current buffer so editing string widgets works."
1088 (let ((inhibit-read-only t)
1089 (inhibit-modification-hooks t)
1091 (while widget-field-new
1092 (setq field (car widget-field-new)
1093 widget-field-new (cdr widget-field-new)
1094 widget-field-list (cons field widget-field-list))
1095 (let ((from (car (widget-get field :field-overlay)))
1096 (to (cdr (widget-get field :field-overlay))))
1097 (widget-specify-field field
1098 (marker-position from) (marker-position to))
1099 (set-marker from nil)
1100 (set-marker to nil))))
1102 (widget-add-change))
1104 (defvar widget-field-last nil)
1105 ;; Last field containing point.
1106 (make-variable-buffer-local 'widget-field-last)
1108 (defvar widget-field-was nil)
1109 ;; The widget data before the change.
1110 (make-variable-buffer-local 'widget-field-was)
1112 (defun widget-field-at (pos)
1113 "Return the widget field at POS, or nil if none."
1114 (let ((field (get-char-property (or pos (point)) 'field)))
1115 (if (eq field 'boundary)
1119 (defun widget-field-buffer (widget)
1120 "Return the start of WIDGET's editing field."
1121 (let ((overlay (widget-get widget :field-overlay)))
1122 (cond ((overlayp overlay)
1123 (overlay-buffer overlay))
1125 (marker-buffer (car overlay))))))
1127 (defun widget-field-start (widget)
1128 "Return the start of WIDGET's editing field."
1129 (let ((overlay (widget-get widget :field-overlay)))
1130 (if (overlayp overlay)
1131 (overlay-start overlay)
1134 (defun widget-field-end (widget)
1135 "Return the end of WIDGET's editing field."
1136 (let ((overlay (widget-get widget :field-overlay)))
1137 ;; Don't subtract one if local-map works at the end of the overlay,
1138 ;; or if a special `boundary' field has been added after the widget
1140 (if (overlayp overlay)
1141 (if (and (not (eq (get-char-property (overlay-end overlay)
1143 (widget-field-buffer widget))
1145 (or widget-field-add-space
1146 (null (widget-get widget :size))))
1147 (1- (overlay-end overlay))
1148 (overlay-end overlay))
1151 (defun widget-field-find (pos)
1152 "Return the field at POS.
1153 Unlike (get-char-property POS 'field) this, works with empty fields too."
1154 (let ((fields widget-field-list)
1157 (setq field (car fields)
1158 fields (cdr fields))
1159 (when (and (<= (widget-field-start field) pos)
1160 (<= pos (widget-field-end field)))
1162 (error "Overlapping fields"))
1163 (setq found field)))
1166 (defun widget-before-change (from to)
1167 ;; This is how, for example, a variable changes its state to `modified'.
1168 ;; when it is being edited.
1169 (unless inhibit-read-only
1170 (let ((from-field (widget-field-find from))
1171 (to-field (widget-field-find to)))
1172 (cond ((not (eq from-field to-field))
1173 (add-hook 'post-command-hook 'widget-add-change nil t)
1174 (signal 'text-read-only
1175 '("Change should be restricted to a single field")))
1177 (add-hook 'post-command-hook 'widget-add-change nil t)
1178 (signal 'text-read-only
1179 '("Attempt to change text outside editable field")))
1180 (widget-field-use-before-change
1181 (widget-apply from-field :notify from-field))))))
1183 (defun widget-add-change ()
1184 (remove-hook 'post-command-hook 'widget-add-change t)
1185 (add-hook 'before-change-functions 'widget-before-change nil t)
1186 (add-hook 'after-change-functions 'widget-after-change nil t))
1188 (defun widget-after-change (from to old)
1189 "Adjust field size and text properties."
1190 (let ((field (widget-field-find from))
1191 (other (widget-field-find to)))
1193 (unless (eq field other)
1194 (error "Change in different fields"))
1195 (let ((size (widget-get field :size)))
1197 (let ((begin (widget-field-start field))
1198 (end (widget-field-end field)))
1199 (cond ((< (- end begin) size)
1203 (insert-char ?\ (- (+ begin size) end))))
1204 ((> (- end begin) size)
1205 ;; Field too large and
1206 (if (or (< (point) (+ begin size))
1208 ;; Point is outside extra space.
1209 (setq begin (+ begin size))
1210 ;; Point is within the extra space.
1211 (setq begin (point)))
1214 (while (and (eq (preceding-char) ?\ )
1216 (delete-backward-char 1)))))))
1217 (widget-specify-secret field))
1218 (widget-apply field :notify field))))
1220 ;;; Widget Functions
1222 ;; These functions are used in the definition of multiple widgets.
1224 (defun widget-parent-action (widget &optional event)
1225 "Tell :parent of WIDGET to handle the :action.
1226 Optional EVENT is the event that triggered the action."
1227 (widget-apply (widget-get widget :parent) :action event))
1229 (defun widget-children-value-delete (widget)
1230 "Delete all :children and :buttons in WIDGET."
1231 (mapc 'widget-delete (widget-get widget :children))
1232 (widget-put widget :children nil)
1233 (mapc 'widget-delete (widget-get widget :buttons))
1234 (widget-put widget :buttons nil))
1236 (defun widget-children-validate (widget)
1237 "All the :children must be valid."
1238 (let ((children (widget-get widget :children))
1240 (while (and children (not found))
1241 (setq child (car children)
1242 children (cdr children)
1243 found (widget-apply child :validate)))
1246 ;; Made defsubst to speed up face editor creation.
1247 (defsubst widget-types-convert-widget (widget)
1248 "Convert :args as widget types in WIDGET."
1249 (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args)))
1252 (defun widget-value-convert-widget (widget)
1253 "Initialize :value from :args in WIDGET."
1254 (let ((args (widget-get widget :args)))
1256 (widget-put widget :value (car args))
1257 ;; Don't convert :value here, as this is done in `widget-convert'.
1258 ;; (widget-put widget :value (widget-apply widget
1259 ;; :value-to-internal (car args)))
1260 (widget-put widget :args nil)))
1263 (defun widget-value-value-get (widget)
1264 "Return the :value property of WIDGET."
1265 (widget-get widget :value))
1267 ;;; The `default' Widget.
1269 (define-widget 'default nil
1270 "Basic widget other widgets are derived from."
1271 :value-to-internal (lambda (widget value) value)
1272 :value-to-external (lambda (widget value) value)
1273 :button-prefix 'widget-button-prefix
1274 :button-suffix 'widget-button-suffix
1275 :complete 'widget-default-complete
1276 :create 'widget-default-create
1279 :format-handler 'widget-default-format-handler
1280 :button-face-get 'widget-default-button-face-get
1281 :sample-face-get 'widget-default-sample-face-get
1282 :delete 'widget-default-delete
1283 :value-set 'widget-default-value-set
1284 :value-inline 'widget-default-value-inline
1285 :default-get 'widget-default-default-get
1286 :menu-tag-get 'widget-default-menu-tag-get
1288 :active 'widget-default-active
1289 :activate 'widget-specify-active
1290 :deactivate 'widget-default-deactivate
1291 :mouse-down-action #'ignore
1292 :action 'widget-default-action
1293 :notify 'widget-default-notify
1294 :prompt-value 'widget-default-prompt-value)
1296 (defun widget-default-complete (widget)
1297 "Call the value of the :complete-function property of WIDGET.
1298 If that does not exists, call the value of `widget-complete-field'."
1299 (call-interactively (or (widget-get widget :complete-function)
1300 widget-complete-field)))
1302 (defun widget-default-create (widget)
1303 "Create WIDGET at point in the current buffer."
1304 (widget-specify-insert
1305 (let ((from (point))
1306 button-begin button-end
1307 sample-begin sample-end
1310 (insert (widget-get widget :format))
1312 ;; Parse escapes in format.
1313 (while (re-search-forward "%\\(.\\)" nil t)
1314 (let ((escape (char-after (match-beginning 1))))
1315 (delete-backward-char 2)
1316 (cond ((eq escape ?%)
1319 (setq button-begin (point))
1320 (insert (widget-get-indirect widget :button-prefix)))
1322 (insert (widget-get-indirect widget :button-suffix))
1323 (setq button-end (point)))
1325 (setq sample-begin (point)))
1327 (setq sample-end (point)))
1329 (when (widget-get widget :indent)
1331 (insert-char ? (widget-get widget :indent))))
1333 (let ((image (widget-get widget :tag-glyph))
1334 (tag (widget-get widget :tag)))
1336 (widget-image-insert widget (or tag "image") image))
1340 (princ (widget-get widget :value)
1341 (current-buffer))))))
1343 (let ((doc (widget-get widget :doc)))
1345 (setq doc-begin (point))
1347 (while (eq (preceding-char) ?\n)
1348 (delete-backward-char 1))
1350 (setq doc-end (point)))))
1352 (if (and button-begin (not button-end))
1353 (widget-apply widget :value-create)
1354 (setq value-pos (point))))
1356 (widget-apply widget :format-handler escape)))))
1357 ;; Specify button, sample, and doc, and insert value.
1358 (and button-begin button-end
1359 (widget-specify-button widget button-begin button-end))
1360 (and sample-begin sample-end
1361 (widget-specify-sample widget sample-begin sample-end))
1362 (and doc-begin doc-end
1363 (widget-specify-doc widget doc-begin doc-end))
1365 (goto-char value-pos)
1366 (widget-apply widget :value-create)))
1367 (let ((from (point-min-marker))
1368 (to (point-max-marker)))
1369 (set-marker-insertion-type from t)
1370 (set-marker-insertion-type to nil)
1371 (widget-put widget :from from)
1372 (widget-put widget :to to)))
1373 (widget-clear-undo))
1375 (defun widget-default-format-handler (widget escape)
1376 ;; We recognize the %h escape by default.
1377 (let* ((buttons (widget-get widget :buttons)))
1378 (cond ((eq escape ?h)
1379 (let* ((doc-property (widget-get widget :documentation-property))
1380 (doc-try (cond ((widget-get widget :doc))
1381 ((functionp doc-property)
1382 (funcall doc-property
1383 (widget-get widget :value)))
1384 ((symbolp doc-property)
1385 (documentation-property
1386 (widget-get widget :value)
1388 (doc-text (and (stringp doc-try)
1389 (> (length doc-try) 1)
1391 (doc-indent (widget-get widget :documentation-indent)))
1393 (and (eq (preceding-char) ?\n)
1394 (widget-get widget :indent)
1395 (insert-char ? (widget-get widget :indent)))
1396 ;; The `*' in the beginning is redundant.
1397 (when (eq (aref doc-text 0) ?*)
1398 (setq doc-text (substring doc-text 1)))
1399 ;; Get rid of trailing newlines.
1400 (when (string-match "\n+\\'" doc-text)
1401 (setq doc-text (substring doc-text 0 (match-beginning 0))))
1402 (push (widget-create-child-and-convert
1403 widget 'documentation-string
1404 :indent (cond ((numberp doc-indent )
1412 (error "Unknown escape `%c'" escape)))
1413 (widget-put widget :buttons buttons)))
1415 (defun widget-default-button-face-get (widget)
1416 ;; Use :button-face or widget-button-face
1417 (or (widget-get widget :button-face)
1418 (let ((parent (widget-get widget :parent)))
1420 (widget-apply parent :button-face-get)
1421 widget-button-face))))
1423 (defun widget-default-sample-face-get (widget)
1424 ;; Use :sample-face.
1425 (widget-get widget :sample-face))
1427 (defun widget-default-delete (widget)
1428 "Remove widget from the buffer."
1429 (let ((from (widget-get widget :from))
1430 (to (widget-get widget :to))
1431 (inactive-overlay (widget-get widget :inactive))
1432 (button-overlay (widget-get widget :button-overlay))
1433 (sample-overlay (widget-get widget :sample-overlay))
1434 (doc-overlay (widget-get widget :doc-overlay))
1435 (inhibit-modification-hooks t)
1436 (inhibit-read-only t))
1437 (widget-apply widget :value-delete)
1438 (when inactive-overlay
1439 (delete-overlay inactive-overlay))
1440 (when button-overlay
1441 (delete-overlay button-overlay))
1442 (when sample-overlay
1443 (delete-overlay sample-overlay))
1445 (delete-overlay doc-overlay))
1447 ;; Kludge: this doesn't need to be true for empty formats.
1448 (delete-region from to))
1449 (set-marker from nil)
1450 (set-marker to nil))
1451 (widget-clear-undo))
1453 (defun widget-default-value-set (widget value)
1454 "Recreate widget with new value."
1455 (let* ((old-pos (point))
1456 (from (copy-marker (widget-get widget :from)))
1457 (to (copy-marker (widget-get widget :to)))
1458 (offset (if (and (<= from old-pos) (<= old-pos to))
1459 (if (>= old-pos (1- to))
1461 (- old-pos from)))))
1462 ;;??? Bug: this ought to insert the new value before deleting the old one,
1463 ;; so that markers on either side of the value automatically
1464 ;; stay on the same side. -- rms.
1466 (goto-char (widget-get widget :from))
1467 (widget-apply widget :delete)
1468 (widget-put widget :value value)
1469 (widget-apply widget :create))
1472 (goto-char (+ (widget-get widget :to) offset 1))
1473 (goto-char (min (+ from offset) (1- (widget-get widget :to))))))))
1475 (defun widget-default-value-inline (widget)
1476 "Wrap value in a list unless it is inline."
1477 (if (widget-get widget :inline)
1478 (widget-value widget)
1479 (list (widget-value widget))))
1481 (defun widget-default-default-get (widget)
1483 (widget-get widget :value))
1485 (defun widget-default-menu-tag-get (widget)
1486 "Use tag or value for menus."
1487 (or (widget-get widget :menu-tag)
1488 (widget-get widget :tag)
1489 (widget-princ-to-string (widget-get widget :value))))
1491 (defun widget-default-active (widget)
1492 "Return t iff this widget active (user modifiable)."
1493 (or (widget-get widget :always-active)
1494 (and (not (widget-get widget :inactive))
1495 (let ((parent (widget-get widget :parent)))
1497 (widget-apply parent :active))))))
1499 (defun widget-default-deactivate (widget)
1500 "Make WIDGET inactive for user modifications."
1501 (widget-specify-inactive widget
1502 (widget-get widget :from)
1503 (widget-get widget :to)))
1505 (defun widget-default-action (widget &optional event)
1506 "Notify the parent when a widget changes."
1507 (let ((parent (widget-get widget :parent)))
1509 (widget-apply parent :notify widget event))))
1511 (defun widget-default-notify (widget child &optional event)
1512 "Pass notification to parent."
1513 (widget-default-action widget event))
1515 (defun widget-default-prompt-value (widget prompt value unbound)
1516 "Read an arbitrary value. Stolen from `set-variable'."
1517 ;; (let ((initial (if unbound
1519 ;; It would be nice if we could do a `(cons val 1)' here.
1520 ;; (prin1-to-string (custom-quote value))))))
1521 (eval-minibuffer prompt))
1523 ;;; The `item' Widget.
1525 (define-widget 'item 'default
1526 "Constant items for inclusion in other widgets."
1527 :convert-widget 'widget-value-convert-widget
1528 :value-create 'widget-item-value-create
1529 :value-delete 'ignore
1530 :value-get 'widget-value-value-get
1531 :match 'widget-item-match
1532 :match-inline 'widget-item-match-inline
1533 :action 'widget-item-action
1536 (defun widget-item-value-create (widget)
1537 "Insert the printed representation of the value."
1538 (princ (widget-get widget :value) (current-buffer)))
1540 (defun widget-item-match (widget value)
1541 ;; Match if the value is the same.
1542 (equal (widget-get widget :value) value))
1544 (defun widget-item-match-inline (widget values)
1545 ;; Match if the value is the same.
1546 (let ((value (widget-get widget :value)))
1548 (<= (length value) (length values))
1549 (let ((head (widget-sublist values 0 (length value))))
1550 (and (equal head value)
1551 (cons head (widget-sublist values (length value))))))))
1553 (defun widget-sublist (list start &optional end)
1554 "Return the sublist of LIST from START to END.
1555 If END is omitted, it defaults to the length of LIST."
1556 (if (> start 0) (setq list (nthcdr start list)))
1558 (unless (<= end start)
1559 (setq list (copy-sequence list))
1560 (setcdr (nthcdr (- end start 1) list) nil)
1562 (copy-sequence list)))
1564 (defun widget-item-action (widget &optional event)
1565 ;; Just notify itself.
1566 (widget-apply widget :notify widget event))
1568 ;;; The `push-button' Widget.
1570 ;; (defcustom widget-push-button-gui t
1571 ;; "If non nil, use GUI push buttons when available."
1575 ;; Cache already created GUI objects.
1576 ;; (defvar widget-push-button-cache nil)
1578 (defcustom widget-push-button-prefix "["
1579 "String used as prefix for buttons."
1581 :group 'widget-button)
1583 (defcustom widget-push-button-suffix "]"
1584 "String used as suffix for buttons."
1586 :group 'widget-button)
1588 (define-widget 'push-button 'item
1589 "A pushable button."
1592 :value-create 'widget-push-button-value-create
1595 (defun widget-push-button-value-create (widget)
1596 "Insert text representing the `on' and `off' states."
1597 (let* ((tag (or (widget-get widget :tag)
1598 (widget-get widget :value)))
1599 (tag-glyph (widget-get widget :tag-glyph))
1600 (text (concat widget-push-button-prefix
1601 tag widget-push-button-suffix)))
1603 (widget-image-insert widget text tag-glyph)
1606 ;; (defun widget-gui-action (widget)
1607 ;; "Apply :action for WIDGET."
1608 ;; (widget-apply-action widget (this-command-keys)))
1610 ;;; The `link' Widget.
1612 (defcustom widget-link-prefix "["
1613 "String used as prefix for links."
1615 :group 'widget-button)
1617 (defcustom widget-link-suffix "]"
1618 "String used as suffix for links."
1620 :group 'widget-button)
1622 (define-widget 'link 'item
1624 :button-prefix 'widget-link-prefix
1625 :button-suffix 'widget-link-suffix
1626 :help-echo "Follow the link."
1629 ;;; The `info-link' Widget.
1631 (define-widget 'info-link 'link
1632 "A link to an info file."
1633 :action 'widget-info-link-action)
1635 (defun widget-info-link-action (widget &optional event)
1636 "Open the info node specified by WIDGET."
1637 (Info-goto-node (widget-value widget)))
1639 ;;; The `url-link' Widget.
1641 (define-widget 'url-link 'link
1642 "A link to an www page."
1643 :action 'widget-url-link-action)
1645 (defun widget-url-link-action (widget &optional event)
1646 "Open the url specified by WIDGET."
1647 (browse-url (widget-value widget)))
1649 ;;; The `function-link' Widget.
1651 (define-widget 'function-link 'link
1652 "A link to an Emacs function."
1653 :action 'widget-function-link-action)
1655 (defun widget-function-link-action (widget &optional event)
1656 "Show the function specified by WIDGET."
1657 (describe-function (widget-value widget)))
1659 ;;; The `variable-link' Widget.
1661 (define-widget 'variable-link 'link
1662 "A link to an Emacs variable."
1663 :action 'widget-variable-link-action)
1665 (defun widget-variable-link-action (widget &optional event)
1666 "Show the variable specified by WIDGET."
1667 (describe-variable (widget-value widget)))
1669 ;;; The `file-link' Widget.
1671 (define-widget 'file-link 'link
1673 :action 'widget-file-link-action)
1675 (defun widget-file-link-action (widget &optional event)
1676 "Find the file specified by WIDGET."
1677 (find-file (widget-value widget)))
1679 ;;; The `emacs-library-link' Widget.
1681 (define-widget 'emacs-library-link 'link
1682 "A link to an Emacs Lisp library file."
1683 :action 'widget-emacs-library-link-action)
1685 (defun widget-emacs-library-link-action (widget &optional event)
1686 "Find the Emacs Library file specified by WIDGET."
1687 (find-file (locate-library (widget-value widget))))
1689 ;;; The `emacs-commentary-link' Widget.
1691 (define-widget 'emacs-commentary-link 'link
1692 "A link to Commentary in an Emacs Lisp library file."
1693 :action 'widget-emacs-commentary-link-action)
1695 (defun widget-emacs-commentary-link-action (widget &optional event)
1696 "Find the Commentary section of the Emacs file specified by WIDGET."
1697 (finder-commentary (widget-value widget)))
1699 ;;; The `editable-field' Widget.
1701 (define-widget 'editable-field 'default
1702 "An editable text field."
1703 :convert-widget 'widget-value-convert-widget
1704 :keymap widget-field-keymap
1706 :help-echo "M-TAB: complete field; RET: enter value"
1708 :prompt-internal 'widget-field-prompt-internal
1709 :prompt-history 'widget-field-history
1710 :prompt-value 'widget-field-prompt-value
1711 :action 'widget-field-action
1712 :validate 'widget-field-validate
1714 :error "Field's value doesn't match allowed forms"
1715 :value-create 'widget-field-value-create
1716 :value-delete 'widget-field-value-delete
1717 :value-get 'widget-field-value-get
1718 :match 'widget-field-match)
1720 (defvar widget-field-history nil
1721 "History of field minibuffer edits.")
1723 (defun widget-field-prompt-internal (widget prompt initial history)
1724 "Read string for WIDGET promptinhg with PROMPT.
1725 INITIAL is the initial input and HISTORY is a symbol containing
1727 (read-string prompt initial history))
1729 (defun widget-field-prompt-value (widget prompt value unbound)
1730 "Prompt for a string."
1731 (widget-apply widget
1733 (widget-apply widget
1734 :prompt-internal prompt
1736 (cons (widget-apply widget
1737 :value-to-internal value)
1739 (widget-get widget :prompt-history))))
1741 (defvar widget-edit-functions nil)
1743 (defun widget-field-action (widget &optional event)
1744 "Move to next field."
1746 (run-hook-with-args 'widget-edit-functions widget))
1748 (defun widget-field-validate (widget)
1749 "Valid if the content matches `:valid-regexp'."
1750 (unless (string-match (widget-get widget :valid-regexp)
1751 (widget-apply widget :value-get))
1754 (defun widget-field-value-create (widget)
1755 "Create an editable text field."
1756 (let ((size (widget-get widget :size))
1757 (value (widget-get widget :value))
1759 ;; This is changed to a real overlay in `widget-setup'. We
1760 ;; need the end points to behave differently until
1761 ;; `widget-setup' is called.
1762 (overlay (cons (make-marker) (make-marker))))
1763 (widget-put widget :field-overlay overlay)
1766 (< (length value) size)
1767 (insert-char ?\ (- size (length value))))
1768 (unless (memq widget widget-field-list)
1769 (setq widget-field-new (cons widget widget-field-new)))
1770 (move-marker (cdr overlay) (point))
1771 (set-marker-insertion-type (cdr overlay) nil)
1774 (move-marker (car overlay) from)
1775 (set-marker-insertion-type (car overlay) t)))
1777 (defun widget-field-value-delete (widget)
1778 "Remove the widget from the list of active editing fields."
1779 (setq widget-field-list (delq widget widget-field-list))
1780 (setq widget-field-new (delq widget widget-field-new))
1781 ;; These are nil if the :format string doesn't contain `%v'.
1782 (let ((overlay (widget-get widget :field-overlay)))
1783 (when (overlayp overlay)
1784 (delete-overlay overlay))))
1786 (defun widget-field-value-get (widget)
1787 "Return current text in editing field."
1788 (let ((from (widget-field-start widget))
1789 (to (widget-field-end widget))
1790 (buffer (widget-field-buffer widget))
1791 (size (widget-get widget :size))
1792 (secret (widget-get widget :secret))
1793 (old (current-buffer)))
1800 (eq (char-after (1- to)) ?\ ))
1802 (let ((result (buffer-substring-no-properties from to)))
1805 (while (< (+ from index) to)
1807 (get-char-property (+ from index) 'secret))
1808 (setq index (1+ index)))))
1811 (widget-get widget :value))))
1813 (defun widget-field-match (widget value)
1814 ;; Match any string.
1817 ;;; The `text' Widget.
1819 (define-widget 'text 'editable-field
1820 "A multiline text area."
1821 :keymap widget-text-keymap)
1823 ;;; The `menu-choice' Widget.
1825 (define-widget 'menu-choice 'default
1826 "A menu of options."
1827 :convert-widget 'widget-types-convert-widget
1828 :format "%[%t%]: %v"
1831 :void '(item :format "invalid (%t)\n")
1832 :value-create 'widget-choice-value-create
1833 :value-delete 'widget-children-value-delete
1834 :value-get 'widget-choice-value-get
1835 :value-inline 'widget-choice-value-inline
1836 :default-get 'widget-choice-default-get
1837 :mouse-down-action 'widget-choice-mouse-down-action
1838 :action 'widget-choice-action
1839 :error "Make a choice"
1840 :validate 'widget-choice-validate
1841 :match 'widget-choice-match
1842 :match-inline 'widget-choice-match-inline)
1844 (defun widget-choice-value-create (widget)
1845 "Insert the first choice that matches the value."
1846 (let ((value (widget-get widget :value))
1847 (args (widget-get widget :args))
1848 (explicit (widget-get widget :explicit-choice))
1850 (if (and explicit (equal value (widget-get widget :explicit-choice-value)))
1852 ;; If the user specified the choice for this value,
1853 ;; respect that choice as long as the value is the same.
1854 (widget-put widget :children (list (widget-create-child-value
1855 widget explicit value)))
1856 (widget-put widget :choice explicit))
1858 (setq current (car args)
1860 (when (widget-apply current :match value)
1861 (widget-put widget :children (list (widget-create-child-value
1862 widget current value)))
1863 (widget-put widget :choice current)
1867 (let ((void (widget-get widget :void)))
1868 (widget-put widget :children (list (widget-create-child-and-convert
1869 widget void :value value)))
1870 (widget-put widget :choice void))))))
1872 (defun widget-choice-value-get (widget)
1873 ;; Get value of the child widget.
1874 (widget-value (car (widget-get widget :children))))
1876 (defun widget-choice-value-inline (widget)
1877 ;; Get value of the child widget.
1878 (widget-apply (car (widget-get widget :children)) :value-inline))
1880 (defun widget-choice-default-get (widget)
1881 ;; Get default for the first choice.
1882 (widget-default-get (car (widget-get widget :args))))
1884 (defcustom widget-choice-toggle nil
1885 "If non-nil, a binary choice will just toggle between the values.
1886 Otherwise, the user will explicitly have to choose between the values
1887 when he invoked the menu."
1891 (defun widget-choice-mouse-down-action (widget &optional event)
1892 ;; Return non-nil if we need a menu.
1893 (let ((args (widget-get widget :args))
1894 (old (widget-get widget :choice)))
1895 (cond ((not (display-popup-menus-p))
1896 ;; No place to pop up a menu.
1898 ((< (length args) 2)
1899 ;; Empty or singleton list, just return the value.
1901 ((> (length args) widget-menu-max-size)
1902 ;; Too long, prompt.
1904 ((> (length args) 2)
1905 ;; Reasonable sized list, use menu.
1907 ((and widget-choice-toggle (memq old args))
1911 ;; Ask which of the two.
1914 (defun widget-choice-action (widget &optional event)
1916 (let ((args (widget-get widget :args))
1917 (old (widget-get widget :choice))
1918 (tag (widget-apply widget :menu-tag-get))
1919 (completion-ignore-case (widget-get widget :case-fold))
1922 ;; Remember old value.
1923 (if (and old (not (widget-apply widget :validate)))
1924 (let* ((external (widget-value widget))
1925 (internal (widget-apply old :value-to-internal external)))
1926 (widget-put old :value internal)))
1929 (cond ((= (length args) 0)
1931 ((= (length args) 1)
1933 ((and widget-choice-toggle
1936 (if (eq old (nth 0 args))
1941 (setq current (car args)
1944 (cons (cons (widget-apply current :menu-tag-get)
1947 (setq this-explicit t)
1948 (widget-choose tag (reverse choices) event))))
1950 ;; If this was an explicit user choice,
1951 ;; record the choice, and the record the value it was made for.
1952 ;; widget-choice-value-create will respect this choice,
1953 ;; as long as the value is the same.
1955 (widget-put widget :explicit-choice current)
1956 (widget-put widget :explicit-choice-value (widget-get widget :value)))
1958 widget (widget-apply current
1959 :value-to-external (widget-default-get current)))
1961 (widget-apply widget :notify widget event)))
1962 (run-hook-with-args 'widget-edit-functions widget))
1964 (defun widget-choice-validate (widget)
1965 ;; Valid if we have made a valid choice.
1966 (if (eq (widget-get widget :void) (widget-get widget :choice))
1968 (widget-apply (car (widget-get widget :children)) :validate)))
1970 (defun widget-choice-match (widget value)
1971 ;; Matches if one of the choices matches.
1972 (let ((args (widget-get widget :args))
1974 (while (and args (not found))
1975 (setq current (car args)
1977 found (widget-apply current :match value)))
1980 (defun widget-choice-match-inline (widget values)
1981 ;; Matches if one of the choices matches.
1982 (let ((args (widget-get widget :args))
1984 (while (and args (null found))
1985 (setq current (car args)
1987 found (widget-match-inline current values)))
1990 ;;; The `toggle' Widget.
1992 (define-widget 'toggle 'item
1993 "Toggle between two states."
1995 :value-create 'widget-toggle-value-create
1996 :action 'widget-toggle-action
1997 :match (lambda (widget value) t)
2001 (defun widget-toggle-value-create (widget)
2002 "Insert text representing the `on' and `off' states."
2003 (if (widget-value widget)
2004 (let ((image (widget-get widget :on-glyph)))
2005 (and (display-graphic-p)
2007 (not (eq (car image) 'image))
2008 (widget-put widget :on-glyph (setq image (eval image))))
2009 (widget-image-insert widget
2010 (widget-get widget :on)
2012 (let ((image (widget-get widget :off-glyph)))
2013 (and (display-graphic-p)
2015 (not (eq (car image) 'image))
2016 (widget-put widget :off-glyph (setq image (eval image))))
2017 (widget-image-insert widget (widget-get widget :off) image))))
2019 (defun widget-toggle-action (widget &optional event)
2021 (widget-value-set widget (not (widget-value widget)))
2022 (widget-apply widget :notify widget event)
2023 (run-hook-with-args 'widget-edit-functions widget))
2025 ;;; The `checkbox' Widget.
2027 (define-widget 'checkbox 'toggle
2028 "A checkbox toggle."
2033 ;; We could probably do the same job as the images using single
2034 ;; space characters in a boxed face with a stretch specification to
2035 ;; make them square.
2036 :on-glyph '(create-image "\000\066\076\034\076\066\000"
2037 'xbm t :width 7 :height 7
2038 :background "grey75" ; like default mode line
2043 :off-glyph '(create-image (make-string 7 0)
2044 'xbm t :width 7 :height 7
2045 :background "grey75"
2049 :help-echo "Toggle this item."
2050 :action 'widget-checkbox-action)
2052 (defun widget-checkbox-action (widget &optional event)
2053 "Toggle checkbox, notify parent, and set active state of sibling."
2054 (widget-toggle-action widget event)
2055 (let ((sibling (widget-get-sibling widget)))
2057 (if (widget-value widget)
2058 (widget-apply sibling :activate)
2059 (widget-apply sibling :deactivate)))))
2061 ;;; The `checklist' Widget.
2063 (define-widget 'checklist 'default
2064 "A multiple choice widget."
2065 :convert-widget 'widget-types-convert-widget
2068 :entry-format "%b %v"
2070 :value-create 'widget-checklist-value-create
2071 :value-delete 'widget-children-value-delete
2072 :value-get 'widget-checklist-value-get
2073 :validate 'widget-checklist-validate
2074 :match 'widget-checklist-match
2075 :match-inline 'widget-checklist-match-inline)
2077 (defun widget-checklist-value-create (widget)
2078 ;; Insert all values
2079 (let ((alist (widget-checklist-match-find widget (widget-get widget :value)))
2080 (args (widget-get widget :args)))
2082 (widget-checklist-add-item widget (car args) (assq (car args) alist))
2083 (setq args (cdr args)))
2084 (widget-put widget :children (nreverse (widget-get widget :children)))))
2086 (defun widget-checklist-add-item (widget type chosen)
2087 "Create checklist item in WIDGET of type TYPE.
2088 If the item is checked, CHOSEN is a cons whose cdr is the value."
2089 (and (eq (preceding-char) ?\n)
2090 (widget-get widget :indent)
2091 (insert-char ? (widget-get widget :indent)))
2092 (widget-specify-insert
2093 (let* ((children (widget-get widget :children))
2094 (buttons (widget-get widget :buttons))
2095 (button-args (or (widget-get type :sibling-args)
2096 (widget-get widget :button-args)))
2099 (insert (widget-get widget :entry-format))
2101 ;; Parse % escapes in format.
2102 (while (re-search-forward "%\\([bv%]\\)" nil t)
2103 (let ((escape (char-after (match-beginning 1))))
2104 (delete-backward-char 2)
2105 (cond ((eq escape ?%)
2108 (setq button (apply 'widget-create-child-and-convert
2110 :value (not (null chosen))
2115 (let ((child (widget-create-child widget type)))
2116 (widget-apply child :deactivate)
2118 ((widget-get type :inline)
2119 (widget-create-child-value
2120 widget type (cdr chosen)))
2122 (widget-create-child-value
2123 widget type (car (cdr chosen)))))))
2125 (error "Unknown escape `%c'" escape)))))
2126 ;; Update properties.
2127 (and button child (widget-put child :button button))
2128 (and button (widget-put widget :buttons (cons button buttons)))
2129 (and child (widget-put widget :children (cons child children))))))
2131 (defun widget-checklist-match (widget values)
2132 ;; All values must match a type in the checklist.
2134 (null (cdr (widget-checklist-match-inline widget values)))))
2136 (defun widget-checklist-match-inline (widget values)
2137 ;; Find the values which match a type in the checklist.
2138 (let ((greedy (widget-get widget :greedy))
2139 (args (copy-sequence (widget-get widget :args)))
2142 (let ((answer (widget-checklist-match-up args values)))
2144 (let ((vals (widget-match-inline answer values)))
2145 (setq found (append found (car vals))
2147 args (delq answer args))))
2149 (setq rest (append rest (list (car values)))
2150 values (cdr values)))
2152 (setq rest (append rest values)
2156 (defun widget-checklist-match-find (widget vals)
2157 "Find the vals which match a type in the checklist.
2158 Return an alist of (TYPE MATCH)."
2159 (let ((greedy (widget-get widget :greedy))
2160 (args (copy-sequence (widget-get widget :args)))
2163 (let ((answer (widget-checklist-match-up args vals)))
2165 (let ((match (widget-match-inline answer vals)))
2166 (setq found (cons (cons answer (car match)) found)
2168 args (delq answer args))))
2170 (setq vals (cdr vals)))
2175 (defun widget-checklist-match-up (args vals)
2176 "Return the first type from ARGS that matches VALS."
2177 (let (current found)
2178 (while (and args (null found))
2179 (setq current (car args)
2181 found (widget-match-inline current vals)))
2185 (defun widget-checklist-value-get (widget)
2186 ;; The values of all selected items.
2187 (let ((children (widget-get widget :children))
2190 (setq child (car children)
2191 children (cdr children))
2192 (if (widget-value (widget-get child :button))
2193 (setq result (append result (widget-apply child :value-inline)))))
2196 (defun widget-checklist-validate (widget)
2197 ;; Ticked chilren must be valid.
2198 (let ((children (widget-get widget :children))
2200 (while (and children (not found))
2201 (setq child (car children)
2202 children (cdr children)
2203 button (widget-get child :button)
2204 found (and (widget-value button)
2205 (widget-apply child :validate))))
2208 ;;; The `option' Widget
2210 (define-widget 'option 'checklist
2211 "An widget with an optional item."
2214 ;;; The `choice-item' Widget.
2216 (define-widget 'choice-item 'item
2217 "Button items that delegate action events to their parents."
2218 :action 'widget-parent-action
2219 :format "%[%t%] \n")
2221 ;;; The `radio-button' Widget.
2223 (define-widget 'radio-button 'toggle
2224 "A radio button for use in the `radio' widget."
2225 :notify 'widget-radio-button-notify
2232 :off-glyph "radio0")
2234 (defun widget-radio-button-notify (widget child &optional event)
2236 (widget-apply (widget-get widget :parent) :action widget event))
2238 ;;; The `radio-button-choice' Widget.
2240 (define-widget 'radio-button-choice 'default
2241 "Select one of multiple options."
2242 :convert-widget 'widget-types-convert-widget
2245 :entry-format "%b %v"
2246 :value-create 'widget-radio-value-create
2247 :value-delete 'widget-children-value-delete
2248 :value-get 'widget-radio-value-get
2249 :value-inline 'widget-radio-value-inline
2250 :value-set 'widget-radio-value-set
2251 :error "You must push one of the buttons"
2252 :validate 'widget-radio-validate
2253 :match 'widget-choice-match
2254 :match-inline 'widget-choice-match-inline
2255 :action 'widget-radio-action)
2257 (defun widget-radio-value-create (widget)
2258 ;; Insert all values
2259 (let ((args (widget-get widget :args))
2262 (setq arg (car args)
2264 (widget-radio-add-item widget arg))))
2266 (defun widget-radio-add-item (widget type)
2267 "Add to radio widget WIDGET a new radio button item of type TYPE."
2268 ;; (setq type (widget-convert type))
2269 (and (eq (preceding-char) ?\n)
2270 (widget-get widget :indent)
2271 (insert-char ? (widget-get widget :indent)))
2272 (widget-specify-insert
2273 (let* ((value (widget-get widget :value))
2274 (children (widget-get widget :children))
2275 (buttons (widget-get widget :buttons))
2276 (button-args (or (widget-get type :sibling-args)
2277 (widget-get widget :button-args)))
2279 (chosen (and (null (widget-get widget :choice))
2280 (widget-apply type :match value)))
2282 (insert (widget-get widget :entry-format))
2284 ;; Parse % escapes in format.
2285 (while (re-search-forward "%\\([bv%]\\)" nil t)
2286 (let ((escape (char-after (match-beginning 1))))
2287 (delete-backward-char 2)
2288 (cond ((eq escape ?%)
2291 (setq button (apply 'widget-create-child-and-convert
2292 widget 'radio-button
2293 :value (not (null chosen))
2296 (setq child (if chosen
2297 (widget-create-child-value
2299 (widget-create-child widget type)))
2301 (widget-apply child :deactivate)))
2303 (error "Unknown escape `%c'" escape)))))
2304 ;; Update properties.
2306 (widget-put widget :choice type))
2308 (widget-put child :button button)
2309 (widget-put widget :buttons (nconc buttons (list button))))
2311 (widget-put widget :children (nconc children (list child))))
2314 (defun widget-radio-value-get (widget)
2315 ;; Get value of the child widget.
2316 (let ((chosen (widget-radio-chosen widget)))
2317 (and chosen (widget-value chosen))))
2319 (defun widget-radio-chosen (widget)
2320 "Return the widget representing the chosen radio button."
2321 (let ((children (widget-get widget :children))
2324 (setq current (car children)
2325 children (cdr children))
2326 (when (widget-apply (widget-get current :button) :value-get)
2331 (defun widget-radio-value-inline (widget)
2332 ;; Get value of the child widget.
2333 (let ((children (widget-get widget :children))
2336 (setq current (car children)
2337 children (cdr children))
2338 (when (widget-apply (widget-get current :button) :value-get)
2339 (setq found (widget-apply current :value-inline)
2343 (defun widget-radio-value-set (widget value)
2344 ;; We can't just delete and recreate a radio widget, since children
2345 ;; can be added after the original creation and won't be recreated
2347 (let ((children (widget-get widget :children))
2350 (setq current (car children)
2351 children (cdr children))
2352 (let* ((button (widget-get current :button))
2353 (match (and (not found)
2354 (widget-apply current :match value))))
2355 (widget-value-set button match)
2358 (widget-value-set current value)
2359 (widget-apply current :activate))
2360 (widget-apply current :deactivate))
2361 (setq found (or found match))))))
2363 (defun widget-radio-validate (widget)
2364 ;; Valid if we have made a valid choice.
2365 (let ((children (widget-get widget :children))
2366 current found button)
2367 (while (and children (not found))
2368 (setq current (car children)
2369 children (cdr children)
2370 button (widget-get current :button)
2371 found (widget-apply button :value-get)))
2373 (widget-apply current :validate)
2376 (defun widget-radio-action (widget child event)
2377 ;; Check if a radio button was pressed.
2378 (let ((children (widget-get widget :children))
2379 (buttons (widget-get widget :buttons))
2381 (when (memq child buttons)
2383 (setq current (car children)
2384 children (cdr children))
2385 (let* ((button (widget-get current :button)))
2386 (cond ((eq child button)
2387 (widget-value-set button t)
2388 (widget-apply current :activate))
2389 ((widget-value button)
2390 (widget-value-set button nil)
2391 (widget-apply current :deactivate)))))))
2392 ;; Pass notification to parent.
2393 (widget-apply widget :notify child event))
2395 ;;; The `insert-button' Widget.
2397 (define-widget 'insert-button 'push-button
2398 "An insert button for the `editable-list' widget."
2400 :help-echo "Insert a new item into the list at this position."
2401 :action 'widget-insert-button-action)
2403 (defun widget-insert-button-action (widget &optional event)
2404 ;; Ask the parent to insert a new item.
2405 (widget-apply (widget-get widget :parent)
2406 :insert-before (widget-get widget :widget)))
2408 ;;; The `delete-button' Widget.
2410 (define-widget 'delete-button 'push-button
2411 "A delete button for the `editable-list' widget."
2413 :help-echo "Delete this item from the list."
2414 :action 'widget-delete-button-action)
2416 (defun widget-delete-button-action (widget &optional event)
2417 ;; Ask the parent to insert a new item.
2418 (widget-apply (widget-get widget :parent)
2419 :delete-at (widget-get widget :widget)))
2421 ;;; The `editable-list' Widget.
2423 ;; (defcustom widget-editable-list-gui nil
2424 ;; "If non nil, use GUI push-buttons in editable list when available."
2428 (define-widget 'editable-list 'default
2429 "A variable list of widgets of the same type."
2430 :convert-widget 'widget-types-convert-widget
2433 :format-handler 'widget-editable-list-format-handler
2434 :entry-format "%i %d %v"
2435 :value-create 'widget-editable-list-value-create
2436 :value-delete 'widget-children-value-delete
2437 :value-get 'widget-editable-list-value-get
2438 :validate 'widget-children-validate
2439 :match 'widget-editable-list-match
2440 :match-inline 'widget-editable-list-match-inline
2441 :insert-before 'widget-editable-list-insert-before
2442 :delete-at 'widget-editable-list-delete-at)
2444 (defun widget-editable-list-format-handler (widget escape)
2445 ;; We recognize the insert button.
2446 ;;; (let ((widget-push-button-gui widget-editable-list-gui))
2447 (cond ((eq escape ?i)
2448 (and (widget-get widget :indent)
2449 (insert-char ?\ (widget-get widget :indent)))
2450 (apply 'widget-create-child-and-convert
2451 widget 'insert-button
2452 (widget-get widget :append-button-args)))
2454 (widget-default-format-handler widget escape)))
2458 (defun widget-editable-list-value-create (widget)
2459 ;; Insert all values
2460 (let* ((value (widget-get widget :value))
2461 (type (nth 0 (widget-get widget :args)))
2463 (widget-put widget :value-pos (copy-marker (point)))
2464 (set-marker-insertion-type (widget-get widget :value-pos) t)
2466 (let ((answer (widget-match-inline type value)))
2468 (setq children (cons (widget-editable-list-entry-create
2470 (if (widget-get type :inline)
2477 (widget-put widget :children (nreverse children))))
2479 (defun widget-editable-list-value-get (widget)
2480 ;; Get value of the child widget.
2481 (apply 'append (mapcar (lambda (child) (widget-apply child :value-inline))
2482 (widget-get widget :children))))
2484 (defun widget-editable-list-match (widget value)
2485 ;; Value must be a list and all the members must match the type.
2487 (null (cdr (widget-editable-list-match-inline widget value)))))
2489 (defun widget-editable-list-match-inline (widget value)
2490 (let ((type (nth 0 (widget-get widget :args)))
2493 (while (and value ok)
2494 (let ((answer (widget-match-inline type value)))
2496 (setq found (append found (car answer))
2499 (cons found value)))
2501 (defun widget-editable-list-insert-before (widget before)
2502 ;; Insert a new child in the list of children.
2504 (let ((children (widget-get widget :children))
2505 (inhibit-read-only t)
2506 before-change-functions
2507 after-change-functions)
2509 (goto-char (widget-get before :entry-from)))
2511 (goto-char (widget-get widget :value-pos))))
2512 (let ((child (widget-editable-list-entry-create
2514 (when (< (widget-get child :entry-from) (widget-get widget :from))
2515 (set-marker (widget-get widget :from)
2516 (widget-get child :entry-from)))
2517 (if (eq (car children) before)
2518 (widget-put widget :children (cons child children))
2519 (while (not (eq (car (cdr children)) before))
2520 (setq children (cdr children)))
2521 (setcdr children (cons child (cdr children)))))))
2523 (widget-apply widget :notify widget))
2525 (defun widget-editable-list-delete-at (widget child)
2526 ;; Delete child from list of children.
2528 (let ((buttons (copy-sequence (widget-get widget :buttons)))
2530 (inhibit-read-only t)
2531 before-change-functions
2532 after-change-functions)
2534 (setq button (car buttons)
2535 buttons (cdr buttons))
2536 (when (eq (widget-get button :widget) child)
2538 :buttons (delq button (widget-get widget :buttons)))
2539 (widget-delete button))))
2540 (let ((entry-from (widget-get child :entry-from))
2541 (entry-to (widget-get child :entry-to))
2542 (inhibit-read-only t)
2543 before-change-functions
2544 after-change-functions)
2545 (widget-delete child)
2546 (delete-region entry-from entry-to)
2547 (set-marker entry-from nil)
2548 (set-marker entry-to nil))
2549 (widget-put widget :children (delq child (widget-get widget :children))))
2551 (widget-apply widget :notify widget))
2553 (defun widget-editable-list-entry-create (widget value conv)
2554 ;; Create a new entry to the list.
2555 (let ((type (nth 0 (widget-get widget :args)))
2556 ;;; (widget-push-button-gui widget-editable-list-gui)
2557 child delete insert)
2558 (widget-specify-insert
2560 (and (widget-get widget :indent)
2561 (insert-char ?\ (widget-get widget :indent)))
2562 (insert (widget-get widget :entry-format)))
2563 ;; Parse % escapes in format.
2564 (while (re-search-forward "%\\(.\\)" nil t)
2565 (let ((escape (char-after (match-beginning 1))))
2566 (delete-backward-char 2)
2567 (cond ((eq escape ?%)
2570 (setq insert (apply 'widget-create-child-and-convert
2571 widget 'insert-button
2572 (widget-get widget :insert-button-args))))
2574 (setq delete (apply 'widget-create-child-and-convert
2575 widget 'delete-button
2576 (widget-get widget :delete-button-args))))
2579 (setq child (widget-create-child-value
2581 (setq child (widget-create-child-value
2583 (widget-apply type :value-to-external
2584 (widget-default-get type))))))
2586 (error "Unknown escape `%c'" escape)))))
2588 :buttons (cons delete
2590 (widget-get widget :buttons))))
2591 (let ((entry-from (point-min-marker))
2592 (entry-to (point-max-marker)))
2593 (set-marker-insertion-type entry-from t)
2594 (set-marker-insertion-type entry-to nil)
2595 (widget-put child :entry-from entry-from)
2596 (widget-put child :entry-to entry-to)))
2597 (widget-put insert :widget child)
2598 (widget-put delete :widget child)
2601 ;;; The `group' Widget.
2603 (define-widget 'group 'default
2604 "A widget which groups other widgets inside."
2605 :convert-widget 'widget-types-convert-widget
2607 :value-create 'widget-group-value-create
2608 :value-delete 'widget-children-value-delete
2609 :value-get 'widget-editable-list-value-get
2610 :default-get 'widget-group-default-get
2611 :validate 'widget-children-validate
2612 :match 'widget-group-match
2613 :match-inline 'widget-group-match-inline)
2615 (defun widget-group-value-create (widget)
2616 ;; Create each component.
2617 (let ((args (widget-get widget :args))
2618 (value (widget-get widget :value))
2619 arg answer children)
2621 (setq arg (car args)
2623 answer (widget-match-inline arg value)
2625 (and (eq (preceding-char) ?\n)
2626 (widget-get widget :indent)
2627 (insert-char ?\ (widget-get widget :indent)))
2628 (push (cond ((null answer)
2629 (widget-create-child widget arg))
2630 ((widget-get arg :inline)
2631 (widget-create-child-value widget arg (car answer)))
2633 (widget-create-child-value widget arg (car (car answer)))))
2635 (widget-put widget :children (nreverse children))))
2637 (defun widget-group-default-get (widget)
2638 ;; Get the default of the components.
2639 (mapcar 'widget-default-get (widget-get widget :args)))
2641 (defun widget-group-match (widget values)
2642 ;; Match if the components match.
2644 (let ((match (widget-group-match-inline widget values)))
2645 (and match (null (cdr match))))))
2647 (defun widget-group-match-inline (widget vals)
2648 ;; Match if the components match.
2649 (let ((args (widget-get widget :args))
2650 argument answer found)
2652 (setq argument (car args)
2654 answer (widget-match-inline argument vals))
2656 (setq vals (cdr answer)
2657 found (append found (car answer)))
2661 (cons found vals))))
2663 ;;; The `visibility' Widget.
2665 (define-widget 'visibility 'item
2666 "An indicator and manipulator for hidden items."
2672 :value-create 'widget-visibility-value-create
2673 :action 'widget-toggle-action
2674 :match (lambda (widget value) t))
2676 (defun widget-visibility-value-create (widget)
2677 ;; Insert text representing the `on' and `off' states.
2678 (let ((on (widget-get widget :on))
2679 (off (widget-get widget :off)))
2681 (setq on (concat widget-push-button-prefix
2683 widget-push-button-suffix))
2686 (setq off (concat widget-push-button-prefix
2688 widget-push-button-suffix))
2690 (if (widget-value widget)
2691 (widget-image-insert widget on "down" "down-pushed")
2692 (widget-image-insert widget off "right" "right-pushed"))))
2694 ;;; The `documentation-link' Widget.
2696 ;; This is a helper widget for `documentation-string'.
2698 (define-widget 'documentation-link 'link
2699 "Link type used in documentation strings."
2701 :help-echo "Describe this symbol"
2702 :action 'widget-documentation-link-action)
2704 (defun widget-documentation-link-action (widget &optional event)
2705 "Display documentation for WIDGET's value. Ignore optional argument EVENT."
2706 (let* ((string (widget-get widget :value))
2707 (symbol (intern string)))
2708 (if (and (fboundp symbol) (boundp symbol))
2709 ;; If there are two doc strings, give the user a way to pick one.
2710 (apropos (concat "\\`" (regexp-quote string) "\\'"))
2711 (if (fboundp symbol)
2712 (describe-function symbol)
2713 (describe-variable symbol)))))
2715 (defcustom widget-documentation-links t
2716 "Add hyperlinks to documentation strings when non-nil."
2718 :group 'widget-documentation)
2720 (defcustom widget-documentation-link-regexp "`\\([^\n`' ]+\\)'"
2721 "Regexp for matching potential links in documentation strings.
2722 The first group should be the link itself."
2724 :group 'widget-documentation)
2726 (defcustom widget-documentation-link-p 'intern-soft
2727 "Predicate used to test if a string is useful as a link.
2728 The value should be a function. The function will be called one
2729 argument, a string, and should return non-nil if there should be a
2730 link for that string."
2732 :options '(widget-documentation-link-p)
2733 :group 'widget-documentation)
2735 (defcustom widget-documentation-link-type 'documentation-link
2736 "Widget type used for links in documentation strings."
2738 :group 'widget-documentation)
2740 (defun widget-documentation-link-add (widget from to)
2741 (widget-specify-doc widget from to)
2742 (when widget-documentation-links
2743 (let ((regexp widget-documentation-link-regexp)
2744 (buttons (widget-get widget :buttons))
2745 (widget-mouse-face (default-value 'widget-mouse-face))
2746 (widget-button-face widget-documentation-face)
2747 (widget-button-pressed-face widget-documentation-face))
2750 (while (re-search-forward regexp to t)
2751 (let ((name (match-string 1))
2752 (begin (match-beginning 1))
2753 (end (match-end 1)))
2754 (when (funcall widget-documentation-link-p name)
2755 (push (widget-convert-button widget-documentation-link-type
2756 begin end :value name)
2758 (widget-put widget :buttons buttons)))
2759 (let ((indent (widget-get widget :indent)))
2760 (when (and indent (not (zerop indent)))
2763 (narrow-to-region from to)
2764 (goto-char (point-min))
2765 (while (search-forward "\n" nil t)
2766 (insert-char ?\ indent)))))))
2768 ;;; The `documentation-string' Widget.
2770 (define-widget 'documentation-string 'item
2771 "A documentation string."
2773 :action 'widget-documentation-string-action
2774 :value-delete 'widget-children-value-delete
2775 :value-create 'widget-documentation-string-value-create)
2777 (defun widget-documentation-string-value-create (widget)
2778 ;; Insert documentation string.
2779 (let ((doc (widget-value widget))
2780 (indent (widget-get widget :indent))
2781 (shown (widget-get (widget-get widget :parent) :documentation-shown))
2783 (if (string-match "\n" doc)
2784 (let ((before (substring doc 0 (match-beginning 0)))
2785 (after (substring doc (match-beginning 0)))
2788 (widget-documentation-link-add widget start (point))
2790 (widget-create-child-and-convert
2792 :help-echo "Show or hide rest of the documentation."
2795 :action 'widget-parent-action
2798 (setq start (point))
2799 (when (and indent (not (zerop indent)))
2800 (insert-char ?\ indent))
2802 (widget-documentation-link-add widget start (point)))
2803 (widget-put widget :buttons (list button)))
2805 (widget-documentation-link-add widget start (point))))
2808 (defun widget-documentation-string-action (widget &rest ignore)
2809 ;; Toggle documentation.
2810 (let ((parent (widget-get widget :parent)))
2811 (widget-put parent :documentation-shown
2812 (not (widget-get parent :documentation-shown))))
2814 (widget-value-set widget (widget-value widget)))
2816 ;;; The Sexp Widgets.
2818 (define-widget 'const 'item
2819 "An immutable sexp."
2820 :prompt-value 'widget-const-prompt-value
2823 (defun widget-const-prompt-value (widget prompt value unbound)
2824 ;; Return the value of the const.
2825 (widget-value widget))
2827 (define-widget 'function-item 'const
2828 "An immutable function name."
2830 :documentation-property (lambda (symbol)
2832 (documentation symbol t)
2835 (define-widget 'variable-item 'const
2836 "An immutable variable name."
2838 :documentation-property 'variable-documentation)
2840 (define-widget 'other 'sexp
2841 "Matches any value, but doesn't let the user edit the value.
2842 This is useful as last item in a `choice' widget.
2843 You should use this widget type with a default value,
2844 as in (other DEFAULT) or (other :tag \"NAME\" DEFAULT).
2845 If the user selects this alternative, that specifies DEFAULT
2851 (defvar widget-string-prompt-value-history nil
2852 "History of input to `widget-string-prompt-value'.")
2854 (define-widget 'string 'editable-field
2857 :format "%{%t%}: %v"
2858 :complete-function 'ispell-complete-word
2859 :prompt-history 'widget-string-prompt-value-history)
2861 (define-widget 'regexp 'string
2862 "A regular expression."
2863 :match 'widget-regexp-match
2864 :validate 'widget-regexp-validate
2865 ;; Doesn't work well with terminating newline.
2866 ;; :value-face 'widget-single-line-field-face
2869 (defun widget-regexp-match (widget value)
2870 ;; Match valid regexps.
2871 (and (stringp value)
2874 (string-match value ""))
2877 (defun widget-regexp-validate (widget)
2878 "Check that the value of WIDGET is a valid regexp."
2879 (condition-case data
2881 (string-match (widget-value widget) ""))
2882 (error (widget-put widget :error (error-message-string data))
2885 (define-widget 'file 'string
2887 It will read a file name from the minibuffer when invoked."
2888 :complete-function 'widget-file-complete
2889 :prompt-value 'widget-file-prompt-value
2890 :format "%{%t%}: %v"
2891 ;; Doesn't work well with terminating newline.
2892 ;; :value-face 'widget-single-line-field-face
2895 (defun widget-file-complete ()
2896 "Perform completion on file name preceding point."
2898 (let* ((end (point))
2899 (beg (save-excursion
2900 (skip-chars-backward "^ ")
2902 (pattern (buffer-substring beg end))
2903 (name-part (file-name-nondirectory pattern))
2904 (directory (file-name-directory pattern))
2905 (completion (file-name-completion name-part directory)))
2906 (cond ((eq completion t))
2908 (message "Can't find completion for \"%s\"" pattern)
2910 ((not (string= name-part completion))
2911 (delete-region beg end)
2912 (insert (expand-file-name completion directory)))
2914 (message "Making completion list...")
2915 (with-output-to-temp-buffer "*Completions*"
2916 (display-completion-list
2917 (sort (file-name-all-completions name-part directory)
2919 (message "Making completion list...%s" "done")))))
2921 (defun widget-file-prompt-value (widget prompt value unbound)
2922 ;; Read file from minibuffer.
2923 (abbreviate-file-name
2925 (read-file-name prompt)
2926 (let ((prompt2 (format "%s (default %s) " prompt value))
2927 (dir (file-name-directory value))
2928 (file (file-name-nondirectory value))
2929 (must-match (widget-get widget :must-match)))
2930 (read-file-name prompt2 dir nil must-match file)))))
2932 ;;;(defun widget-file-action (widget &optional event)
2933 ;;; ;; Read a file name from the minibuffer.
2934 ;;; (let* ((value (widget-value widget))
2935 ;;; (dir (file-name-directory value))
2936 ;;; (file (file-name-nondirectory value))
2937 ;;; (menu-tag (widget-apply widget :menu-tag-get))
2938 ;;; (must-match (widget-get widget :must-match))
2939 ;;; (answer (read-file-name (concat menu-tag ": (default `" value "') ")
2940 ;;; dir nil must-match file)))
2941 ;;; (widget-value-set widget (abbreviate-file-name answer))
2943 ;;; (widget-apply widget :notify widget event)))
2945 ;; Fixme: use file-name-as-directory.
2946 (define-widget 'directory 'file
2947 "A directory widget.
2948 It will read a directory name from the minibuffer when invoked."
2951 (defvar widget-symbol-prompt-value-history nil
2952 "History of input to `widget-symbol-prompt-value'.")
2954 (define-widget 'symbol 'editable-field
2958 :format "%{%t%}: %v"
2959 :match (lambda (widget value) (symbolp value))
2960 :complete-function 'lisp-complete-symbol
2961 :prompt-internal 'widget-symbol-prompt-internal
2962 :prompt-match 'symbolp
2963 :prompt-history 'widget-symbol-prompt-value-history
2964 :value-to-internal (lambda (widget value)
2968 :value-to-external (lambda (widget value)
2973 (defun widget-symbol-prompt-internal (widget prompt initial history)
2974 ;; Read file from minibuffer.
2975 (let ((answer (completing-read prompt obarray
2976 (widget-get widget :prompt-match)
2977 nil initial history)))
2978 (if (and (stringp answer)
2979 (not (zerop (length answer))))
2981 (error "No value"))))
2983 (defvar widget-function-prompt-value-history nil
2984 "History of input to `widget-function-prompt-value'.")
2986 (define-widget 'function 'sexp
2988 :complete-function (lambda ()
2990 (lisp-complete-symbol 'fboundp))
2991 :prompt-value 'widget-field-prompt-value
2992 :prompt-internal 'widget-symbol-prompt-internal
2993 :prompt-match 'fboundp
2994 :prompt-history 'widget-function-prompt-value-history
2995 :action 'widget-field-action
2996 :match-alternatives '(functionp)
2997 :validate (lambda (widget)
2998 (unless (functionp (widget-value widget))
2999 (widget-put widget :error (format "Invalid function: %S"
3000 (widget-value widget)))
3005 (defvar widget-variable-prompt-value-history nil
3006 "History of input to `widget-variable-prompt-value'.")
3008 (define-widget 'variable 'symbol
3010 :prompt-match 'boundp
3011 :prompt-history 'widget-variable-prompt-value-history
3012 :complete-function (lambda ()
3014 (lisp-complete-symbol 'boundp))
3017 (defvar widget-coding-system-prompt-value-history nil
3018 "History of input to `widget-coding-system-prompt-value'.")
3020 (define-widget 'coding-system 'symbol
3021 "A MULE coding-system."
3022 :format "%{%t%}: %v"
3023 :tag "Coding system"
3025 :prompt-history 'widget-coding-system-prompt-value-history
3026 :prompt-value 'widget-coding-system-prompt-value
3027 :action 'widget-coding-system-action
3028 :complete-function (lambda ()
3030 (lisp-complete-symbol 'coding-system-p))
3031 :validate (lambda (widget)
3032 (unless (coding-system-p (widget-value widget))
3033 (widget-put widget :error (format "Invalid coding system: %S"
3034 (widget-value widget)))
3037 :prompt-match 'coding-system-p)
3039 (defun widget-coding-system-prompt-value (widget prompt value unbound)
3040 "Read coding-system from minibuffer."
3041 (if (widget-get widget :base-only)
3043 (completing-read (format "%s (default %s) " prompt value)
3044 (mapcar #'list (coding-system-list t)) nil nil nil
3045 coding-system-history))
3046 (read-coding-system (format "%s (default %s) " prompt value) value)))
3048 (defun widget-coding-system-action (widget &optional event)
3050 (widget-coding-system-prompt-value
3052 (widget-apply widget :menu-tag-get)
3053 (widget-value widget)
3055 (widget-value-set widget answer)
3056 (widget-apply widget :notify widget event)
3059 (define-widget 'sexp 'editable-field
3060 "An arbitrary Lisp expression."
3061 :tag "Lisp expression"
3062 :format "%{%t%}: %v"
3064 :validate 'widget-sexp-validate
3065 :match (lambda (widget value) t)
3066 :value-to-internal 'widget-sexp-value-to-internal
3067 :value-to-external (lambda (widget value) (read value))
3068 :prompt-history 'widget-sexp-prompt-value-history
3069 :prompt-value 'widget-sexp-prompt-value)
3071 (defun widget-sexp-value-to-internal (widget value)
3072 ;; Use pp for printer representation.
3073 (let ((pp (if (symbolp value)
3074 (prin1-to-string value)
3075 (pp-to-string value))))
3076 (while (string-match "\n\\'" pp)
3077 (setq pp (substring pp 0 -1)))
3078 (if (or (string-match "\n\\'" pp)
3083 (defun widget-sexp-validate (widget)
3084 ;; Valid if we can read the string and there is no junk left after it.
3086 (insert (widget-apply widget :value-get))
3087 (goto-char (point-min))
3089 (condition-case data
3091 ;; Avoid a confusing end-of-file error.
3092 (skip-syntax-forward "\\s-")
3094 (setq err "Empty sexp -- use `nil'?")
3095 (unless (widget-apply widget :match (read (current-buffer)))
3096 (setq err (widget-get widget :type-error))))
3097 (if (and (not (eobp))
3099 (setq err (format "Junk at end of expression: %s"
3100 (buffer-substring (point)
3102 (end-of-file ; Avoid confusing error message.
3103 (setq err "Unbalanced sexp"))
3104 (error (setq err (error-message-string data))))
3107 (widget-put widget :error err)
3110 (defvar widget-sexp-prompt-value-history nil
3111 "History of input to `widget-sexp-prompt-value'.")
3113 (defun widget-sexp-prompt-value (widget prompt value unbound)
3114 ;; Read an arbitrary sexp.
3115 (let ((found (read-string prompt
3116 (if unbound nil (cons (prin1-to-string value) 0))
3117 (widget-get widget :prompt-history))))
3118 (let ((answer (read-from-string found)))
3119 (unless (= (cdr answer) (length found))
3120 (error "Junk at end of expression: %s"
3121 (substring found (cdr answer))))
3124 (define-widget 'restricted-sexp 'sexp
3125 "A Lisp expression restricted to values that match.
3126 To use this type, you must define :match or :match-alternatives."
3127 :type-error "The specified value is not valid"
3128 :match 'widget-restricted-sexp-match
3129 :value-to-internal (lambda (widget value)
3130 (if (widget-apply widget :match value)
3131 (prin1-to-string value)
3134 (defun widget-restricted-sexp-match (widget value)
3135 (let ((alternatives (widget-get widget :match-alternatives))
3137 (while (and alternatives (not matched))
3138 (if (cond ((functionp (car alternatives))
3139 (funcall (car alternatives) value))
3140 ((and (consp (car alternatives))
3141 (eq (car (car alternatives)) 'quote))
3142 (eq value (nth 1 (car alternatives)))))
3144 (setq alternatives (cdr alternatives)))
3147 (define-widget 'integer 'restricted-sexp
3151 :type-error "This field should contain an integer"
3152 :match-alternatives '(integerp))
3154 (define-widget 'number 'restricted-sexp
3155 "A floating point number."
3158 :type-error "This field should contain a number"
3159 :match-alternatives '(numberp))
3161 (define-widget 'character 'editable-field
3166 :format "%{%t%}: %v\n"
3167 :valid-regexp "\\`.\\'"
3168 :error "This field should contain a single character"
3169 :value-to-internal (lambda (widget value)
3172 (char-to-string value)))
3173 :value-to-external (lambda (widget value)
3177 :match (lambda (widget value)
3178 (char-valid-p value)))
3180 (define-widget 'list 'group
3183 :format "%{%t%}:\n%v")
3185 (define-widget 'vector 'group
3188 :format "%{%t%}:\n%v"
3189 :match 'widget-vector-match
3190 :value-to-internal (lambda (widget value) (append value nil))
3191 :value-to-external (lambda (widget value) (apply 'vector value)))
3193 (defun widget-vector-match (widget value)
3194 (and (vectorp value)
3195 (widget-group-match widget
3196 (widget-apply widget :value-to-internal value))))
3198 (define-widget 'cons 'group
3201 :format "%{%t%}:\n%v"
3202 :match 'widget-cons-match
3203 :value-to-internal (lambda (widget value)
3204 (list (car value) (cdr value)))
3205 :value-to-external (lambda (widget value)
3206 (cons (nth 0 value) (nth 1 value))))
3208 (defun widget-cons-match (widget value)
3210 (widget-group-match widget
3211 (widget-apply widget :value-to-internal value))))
3213 ;;; The `plist' Widget.
3217 (define-widget 'plist 'list
3219 :key-type '(symbol :tag "Key")
3220 :value-type '(sexp :tag "Value")
3221 :convert-widget 'widget-plist-convert-widget
3224 (defvar widget-plist-value-type) ;Dynamic variable
3226 (defun widget-plist-convert-widget (widget)
3227 ;; Handle `:options'.
3228 (let* ((options (widget-get widget :options))
3229 (widget-plist-value-type (widget-get widget :value-type))
3230 (other `(editable-list :inline t
3232 ,(widget-get widget :key-type)
3233 ,widget-plist-value-type)))
3235 (list `(checklist :inline t
3237 ,@(mapcar 'widget-plist-convert-option
3241 (widget-put widget :args args)
3244 (defun widget-plist-convert-option (option)
3245 ;; Convert a single plist option.
3246 (let (key-type value-type)
3248 (let ((key (nth 0 option)))
3249 (setq value-type (nth 1 option))
3252 (setq key-type `(const ,key))))
3253 (setq key-type `(const ,option)
3254 value-type widget-plist-value-type))
3255 `(group :format "Key: %v" :inline t ,key-type ,value-type)))
3258 ;;; The `alist' Widget.
3260 ;; Association lists.
3262 (define-widget 'alist 'list
3263 "An association list."
3264 :key-type '(sexp :tag "Key")
3265 :value-type '(sexp :tag "Value")
3266 :convert-widget 'widget-alist-convert-widget
3269 (defvar widget-alist-value-type) ;Dynamic variable
3271 (defun widget-alist-convert-widget (widget)
3272 ;; Handle `:options'.
3273 (let* ((options (widget-get widget :options))
3274 (widget-alist-value-type (widget-get widget :value-type))
3275 (other `(editable-list :inline t
3277 ,(widget-get widget :key-type)
3278 ,widget-alist-value-type)))
3280 (list `(checklist :inline t
3282 ,@(mapcar 'widget-alist-convert-option
3286 (widget-put widget :args args)
3289 (defun widget-alist-convert-option (option)
3290 ;; Convert a single alist option.
3291 (let (key-type value-type)
3293 (let ((key (nth 0 option)))
3294 (setq value-type (nth 1 option))
3297 (setq key-type `(const ,key))))
3298 (setq key-type `(const ,option)
3299 value-type widget-alist-value-type))
3300 `(cons :format "Key: %v" ,key-type ,value-type)))
3302 (define-widget 'choice 'menu-choice
3303 "A union of several sexp types."
3305 :format "%{%t%}: %[Value Menu%] %v"
3306 :button-prefix 'widget-push-button-prefix
3307 :button-suffix 'widget-push-button-suffix
3308 :prompt-value 'widget-choice-prompt-value)
3310 (defun widget-choice-prompt-value (widget prompt value unbound)
3312 (let ((args (widget-get widget :args))
3313 (completion-ignore-case (widget-get widget :case-fold))
3314 current choices old)
3315 ;; Find the first arg that matches VALUE.
3318 (if (widget-apply (car look) :match value)
3319 (setq old (car look)
3321 (setq look (cdr look)))))
3324 (cond ((= (length args) 0)
3326 ((= (length args) 1)
3328 ((and (= (length args) 2)
3330 (if (eq old (nth 0 args))
3335 (setq current (car args)
3338 (cons (cons (widget-apply current :menu-tag-get)
3341 (let ((val (completing-read prompt choices nil t)))
3343 (let ((try (try-completion val choices)))
3346 (cdr (assoc val choices)))
3349 (widget-prompt-value current prompt nil t)
3352 (define-widget 'radio 'radio-button-choice
3353 "A union of several sexp types."
3355 :format "%{%t%}:\n%v"
3356 :prompt-value 'widget-choice-prompt-value)
3358 (define-widget 'repeat 'editable-list
3359 "A variable length homogeneous list."
3361 :format "%{%t%}:\n%v%i\n")
3363 (define-widget 'set 'checklist
3364 "A list of members from a fixed set."
3366 :format "%{%t%}:\n%v")
3368 (define-widget 'boolean 'toggle
3369 "To be nil or non-nil, that is the question."
3371 :prompt-value 'widget-boolean-prompt-value
3372 :button-prefix 'widget-push-button-prefix
3373 :button-suffix 'widget-push-button-suffix
3374 :format "%{%t%}: %[Toggle%] %v\n"
3378 (defun widget-boolean-prompt-value (widget prompt value unbound)
3379 ;; Toggle a boolean.
3382 ;;; The `color' Widget.
3385 (define-widget 'color 'editable-field
3386 "Choose a color name (with sample)."
3387 :format "%t: %v (%{sample%})\n"
3391 :complete 'widget-color-complete
3392 :sample-face-get 'widget-color-sample-face-get
3393 :notify 'widget-color-notify
3394 :action 'widget-color-action)
3396 (defun widget-color-complete (widget)
3397 "Complete the color in WIDGET."
3398 (require 'facemenu) ; for facemenu-color-alist
3399 (let* ((prefix (buffer-substring-no-properties (widget-field-start widget)
3401 (list (or facemenu-color-alist
3402 (mapcar 'list (defined-colors))))
3403 (completion (try-completion prefix list)))
3404 (cond ((eq completion t)
3405 (message "Exact match."))
3407 (error "Can't find completion for \"%s\"" prefix))
3408 ((not (string-equal prefix completion))
3409 (insert-and-inherit (substring completion (length prefix))))
3411 (message "Making completion list...")
3412 (with-output-to-temp-buffer "*Completions*"
3413 (display-completion-list (all-completions prefix list nil)))
3414 (message "Making completion list...done")))))
3416 (defun widget-color-sample-face-get (widget)
3417 (let* ((value (condition-case nil
3418 (widget-value widget)
3419 (error (widget-get widget :value)))))
3420 (if (color-defined-p value)
3421 (list (cons 'foreground-color value))
3424 (defun widget-color-action (widget &optional event)
3425 "Prompt for a color."
3426 (let* ((tag (widget-apply widget :menu-tag-get))
3427 (prompt (concat tag ": "))
3428 (value (widget-value widget))
3429 (start (widget-field-start widget))
3430 (pos (cond ((< (point) start)
3432 ((> (point) (+ start (length value)))
3435 (- (point) start))))
3436 (answer (facemenu-read-color prompt)))
3437 (unless (zerop (length answer))
3438 (widget-value-set widget answer)
3440 (widget-apply widget :notify widget event))))
3442 (defun widget-color-notify (widget child &optional event)
3443 "Update the sample, and notofy the parent."
3444 (overlay-put (widget-get widget :sample-overlay)
3445 'face (widget-apply widget :sample-face-get))
3446 (widget-default-notify widget child event))
3450 (defun widget-echo-help (pos)
3451 "Display help-echo text for widget at POS."
3452 (let* ((widget (widget-at pos))
3453 (help-echo (and widget (widget-get widget :help-echo))))
3454 (if (functionp help-echo)
3455 (setq help-echo (funcall help-echo widget)))
3456 (if (stringp help-echo)
3457 (message "%s" help-echo))))
3463 ;;; wid-edit.el ends here