1 ;;; wid-edit.el --- Functions for creating and using widgets.
3 ;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Keywords: extensions
8 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
34 (eval-when-compile (require 'cl
))
38 (defun widget-event-point (event)
39 "Character position of the end of event if that exists, or nil."
40 (posn-point (event-end event
)))
42 (defalias 'widget-read-event
'read-event
)
45 (autoload 'pp-to-string
"pp")
46 (autoload 'Info-goto-node
"info")
47 (autoload 'finder-commentary
"finder" nil t
)
49 (unless (and (featurep 'custom
) (fboundp 'custom-declare-variable
))
50 ;; We have the old custom-library, hack around it!
51 (defmacro defgroup
(&rest args
) nil
)
52 (defmacro defcustom
(var value doc
&rest args
)
53 (` (defvar (, var
) (, value
) (, doc
))))
54 (defmacro defface
(&rest args
) nil
)
55 (define-widget-keywords :prefix
:tag
:load
:link
:options
:type
:group
)
56 (when (fboundp 'copy-face
)
57 (copy-face 'default
'widget-documentation-face
)
58 (copy-face 'bold
'widget-button-face
)
59 (copy-face 'italic
'widget-field-face
)))
61 (unless (fboundp 'button-release-event-p
)
62 ;; XEmacs function missing from Emacs.
63 (defun button-release-event-p (event)
64 "Non-nil if EVENT is a mouse-button-release event object."
66 (memq (event-basic-type event
) '(mouse-1 mouse-2 mouse-3
))
67 (or (memq 'click
(event-modifiers event
))
68 (memq 'drag
(event-modifiers event
)))))))
73 "Customization support for the Widget Library."
74 :link
'(custom-manual "(widget)Top")
75 :link
'(url-link :tag
"Development Page"
76 "http://www.dina.kvl.dk/~abraham/custom/")
77 :link
'(emacs-library-link :tag
"Lisp File" "widget.el")
82 (defgroup widget-documentation nil
83 "Options controling the display of documentation strings."
86 (defgroup widget-faces nil
87 "Faces used by the widget library."
91 (defvar widget-documentation-face
'widget-documentation-face
92 "Face used for documentation strings in widges.
93 This exists as a variable so it can be set locally in certain buffers.")
95 (defface widget-documentation-face
'((((class color
)
97 (:foreground
"lime green"))
100 (:foreground
"dark green"))
102 "Face used for documentation text."
103 :group
'widget-documentation
104 :group
'widget-faces
)
106 (defvar widget-button-face
'widget-button-face
107 "Face used for buttons in widges.
108 This exists as a variable so it can be set locally in certain buffers.")
110 (defface widget-button-face
'((t (:bold t
)))
111 "Face used for widget buttons."
112 :group
'widget-faces
)
114 (defcustom widget-mouse-face
'highlight
115 "Face used for widget buttons when the mouse is above them."
117 :group
'widget-faces
)
119 (defface widget-field-face
'((((class grayscale color
)
121 (:background
"gray85"))
122 (((class grayscale color
)
124 (:background
"dim gray"))
127 "Face used for editable fields."
128 :group
'widget-faces
)
130 (defface widget-single-line-field-face
'((((class grayscale color
)
132 (:background
"gray85"))
133 (((class grayscale color
)
135 (:background
"dim gray"))
138 "Face used for editable fields spanning only a single line."
139 :group
'widget-faces
)
141 ;;; This causes display-table to be loaded, and not usefully.
142 ;;;(defvar widget-single-line-display-table
143 ;;; (let ((table (make-display-table)))
144 ;;; (aset table 9 "^I")
145 ;;; (aset table 10 "^J")
147 ;;; "Display table used for single-line editable fields.")
149 ;;;(when (fboundp 'set-face-display-table)
150 ;;; (set-face-display-table 'widget-single-line-field-face
151 ;;; widget-single-line-display-table))
153 ;;; Utility functions.
155 ;; These are not really widget specific.
157 (defun widget-princ-to-string (object)
158 ;; Return string representation of OBJECT, any Lisp object.
159 ;; No quoting characters are used; no delimiters are printed around
160 ;; the contents of strings.
162 (set-buffer (get-buffer-create " *widget-tmp*"))
164 (let ((standard-output (current-buffer)))
168 (defun widget-clear-undo ()
169 "Clear all undo information."
170 (buffer-disable-undo (current-buffer))
171 (buffer-enable-undo))
173 (defcustom widget-menu-max-size
40
174 "Largest number of items allowed in a popup-menu.
175 Larger menus are read through the minibuffer."
179 (defcustom widget-menu-max-shortcuts
40
180 "Largest number of items for which it works to choose one with a character.
181 For a larger number of items, the minibuffer is used."
185 (defcustom widget-menu-minibuffer-flag nil
186 "*Control how to ask for a choice from the keyboard.
187 Non-nil means use the minibuffer;
188 nil means read a single character."
192 (defun widget-choose (title items
&optional event
)
193 "Choose an item from a list.
195 First argument TITLE is the name of the list.
196 Second argument ITEMS is an list whose members are either
197 (NAME . VALUE), to indicate selectable items, or just strings to
198 indicate unselectable items.
199 Optional third argument EVENT is an input event.
201 The user is asked to choose between each NAME from the items alist,
202 and the VALUE of the chosen element will be returned. If EVENT is a
203 mouse event, and the number of elements in items is less than
204 `widget-menu-max-size', a popup menu will be used, otherwise the
206 (cond ((and (< (length items
) widget-menu-max-size
)
207 event
(fboundp 'x-popup-menu
) window-system
)
208 ;; We are in Emacs-19, pressed by the mouse
210 (list title
(cons "" items
))))
211 ((or widget-menu-minibuffer-flag
212 (> (length items
) widget-menu-max-shortcuts
))
213 ;; Read the choice of name from the minibuffer.
214 (setq items
(widget-remove-if 'stringp items
))
215 (let ((val (completing-read (concat title
": ") items nil t
)))
217 (let ((try (try-completion val items
)))
220 (cdr (assoc val items
)))
223 ;; Construct a menu of the choices
224 ;; and then use it for prompting for a single character.
225 (let* ((overriding-terminal-local-map
226 (make-sparse-keymap))
227 map choice
(next-digit ?
0)
230 ;; Define SPC as a prefix char to get to this menu.
231 (define-key overriding-terminal-local-map
" "
232 (setq map
(make-sparse-keymap title
)))
234 (set-buffer (get-buffer-create " widget-choose"))
236 (insert "Available choices:\n\n")
238 (setq choice
(car items
) items
(cdr items
))
240 (let* ((name (car choice
))
241 (function (cdr choice
)))
242 (insert (format "%c = %s\n" next-digit name
))
243 (define-key map
(vector next-digit
) function
)
244 (setq some-choice-enabled t
)))
245 ;; Allocate digits to disabled alternatives
246 ;; so that the digit of a given alternative never varies.
247 (setq next-digit
(1+ next-digit
)))
248 (insert "\nC-g = Quit"))
249 (or some-choice-enabled
250 (error "None of the choices is currently meaningful"))
251 (define-key map
[?\C-g
] 'keyboard-quit
)
252 (define-key map
[t] 'keyboard-quit)
253 (define-key map [?\M-\C-v] 'scroll-other-window)
254 (define-key map [?\M--] 'negative-argument)
255 (setcdr map (nreverse (cdr map)))
256 ;; Read a char with the menu, and return the result
257 ;; that corresponds to it.
258 (save-window-excursion
259 (let ((buf (get-buffer " widget-choose")))
261 (let ((cursor-in-echo-area t)
265 (while (not (or (and (>= char ?0) (< char next-digit))
266 (eq value 'keyboard-quit)))
267 ;; Unread a SPC to lead to our new menu.
268 (setq unread-command-events (cons ?\ unread-command-events))
269 (setq keys (read-key-sequence title))
270 (setq value (lookup-key overriding-terminal-local-map keys t)
271 char (string-to-char (substring keys 1)))
272 (cond ((eq value 'scroll-other-window)
273 (let ((minibuffer-scroll-window (get-buffer-window buf)))
275 (scroll-other-window-down (window-height minibuffer-scroll-window))
276 (scroll-other-window))
278 ((eq value 'negative-argument)
282 (when (eq value 'keyboard-quit)
286 (defun widget-remove-if (predictate list)
287 (let (result (tail list))
289 (or (funcall predictate (car tail))
290 (setq result (cons (car tail) result)))
291 (setq tail (cdr tail)))
294 ;;; Widget text specifications.
296 ;; These functions are for specifying text properties.
298 (defcustom widget-field-add-space
299 (or (< emacs-major-version 20)
300 (and (eq emacs-major-version 20)
301 (< emacs-minor-version 3))
302 (not (string-match "XEmacs" emacs-version)))
303 "Non-nil means add extra space at the end of editable text fields.
305 This is needed on all versions of Emacs, and on XEmacs before 20.3.
306 If you don't add the space, it will become impossible to edit a zero
311 (defcustom widget-field-use-before-change
312 (and (or (> emacs-minor-version 34)
313 (> emacs-major-version 19))
314 (not (string-match "XEmacs" emacs-version)))
315 "Non-nil means use `before-change-functions' to track editable fields.
316 This enables the use of undo, but doesn't work on Emacs 19.34 and earlier.
317 Using before hooks also means that the :notify function can't know the
322 (defun widget-specify-field (widget from to)
323 "Specify editable button for WIDGET between FROM and TO."
324 ;; Terminating space is not part of the field, but necessary in
325 ;; order for local-map to work. Remove next sexp if local-map works
326 ;; at the end of the overlay.
329 (cond ((null (widget-get widget :size))
331 (widget-field-add-space
332 (insert-and-inherit " ")))
334 (let ((map (widget-get widget :keymap))
335 (face (or (widget-get widget :value-face) 'widget-field-face))
336 (help-echo (widget-get widget :help-echo))
337 (overlay (make-overlay from to nil
338 nil (or (not widget-field-add-space)
339 (widget-get widget :size)))))
340 (unless (or (stringp help-echo) (null help-echo))
341 (setq help-echo 'widget-mouse-help))
342 (widget-put widget :field-overlay overlay)
343 (overlay-put overlay 'detachable nil)
344 (overlay-put overlay 'field widget)
345 (overlay-put overlay 'local-map map)
346 (overlay-put overlay 'keymap map)
347 (overlay-put overlay 'face face)
348 (overlay-put overlay 'balloon-help help-echo)
349 (overlay-put overlay 'help-echo help-echo))
350 (widget-specify-secret widget))
352 (defun widget-specify-secret (field)
353 "Replace text in FIELD with value of `:secret', if non-nil."
354 (let ((secret (widget-get field :secret))
355 (size (widget-get field :size)))
357 (let ((begin (widget-field-start field))
358 (end (widget-field-end field)))
360 (while (and (> end begin)
361 (eq (char-after (1- end)) ?\ ))
362 (setq end (1- end))))
364 (let ((old (char-after begin)))
365 (unless (eq old secret)
366 (subst-char-in-region begin (1+ begin) old secret)
367 (put-text-property begin (1+ begin) 'secret old))
368 (setq begin (1+ begin))))))))
370 (defun widget-specify-button (widget from to)
371 "Specify button for WIDGET between FROM and TO."
372 (let ((face (widget-apply widget :button-face-get))
373 (help-echo (widget-get widget :help-echo))
374 (overlay (make-overlay from to nil t nil)))
375 (widget-put widget :button-overlay overlay)
376 (unless (or (null help-echo) (stringp help-echo))
377 (setq help-echo 'widget-mouse-help))
378 (overlay-put overlay 'button widget)
379 (overlay-put overlay 'mouse-face widget-mouse-face)
380 (overlay-put overlay 'balloon-help help-echo)
381 (overlay-put overlay 'help-echo help-echo)
382 (overlay-put overlay 'face face)))
384 (defun widget-mouse-help (extent)
385 "Find mouse help string for button in extent."
386 (let* ((widget (widget-at (extent-start-position extent)))
387 (help-echo (and widget (widget-get widget :help-echo))))
388 (cond ((stringp help-echo)
390 ((and (symbolp help-echo) (fboundp help-echo)
391 (stringp (setq help-echo (funcall help-echo widget))))
394 (format "(widget %S :help-echo %S)" widget help-echo)))))
396 (defun widget-specify-sample (widget from to)
397 ;; Specify sample for WIDGET between FROM and TO.
398 (let ((face (widget-apply widget :sample-face-get))
399 (overlay (make-overlay from to nil t nil)))
400 (overlay-put overlay 'face face)
401 (widget-put widget :sample-overlay overlay)))
403 (defun widget-specify-doc (widget from to)
404 ;; Specify documentation for WIDGET between FROM and TO.
405 (let ((overlay (make-overlay from to nil t nil)))
406 (overlay-put overlay 'widget-doc widget)
407 (overlay-put overlay 'face widget-documentation-face)
408 (widget-put widget :doc-overlay overlay)))
410 (defmacro widget-specify-insert (&rest form)
411 ;; Execute FORM without inheriting any text properties.
414 (let ((inhibit-read-only t)
416 before-change-functions
417 after-change-functions)
419 (narrow-to-region (- (point) 2) (point))
420 (goto-char (1+ (point-min)))
421 (setq result (progn (,@ form)))
422 (delete-region (point-min) (1+ (point-min)))
423 (delete-region (1- (point-max)) (point-max))
424 (goto-char (point-max))
427 (defface widget-inactive-face '((((class grayscale color)
429 (:foreground "light gray"))
430 (((class grayscale color)
432 (:foreground "dim gray"))
435 "Face used for inactive widgets."
436 :group 'widget-faces)
438 (defun widget-specify-inactive (widget from to)
439 "Make WIDGET inactive for user modifications."
440 (unless (widget-get widget :inactive)
441 (let ((overlay (make-overlay from to nil t nil)))
442 (overlay-put overlay 'face 'widget-inactive-face)
443 ;; This is disabled, as it makes the mouse cursor change shape.
444 ;; (overlay-put overlay 'mouse-face 'widget-inactive-face)
445 (overlay-put overlay 'evaporate t)
446 (overlay-put overlay 'priority 100)
447 (overlay-put overlay (if (string-match "XEmacs" emacs-version)
449 '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 "Attempt to modify inactive widget")))
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 ((widget-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* ((parent (widget-get widget :parent))
540 (children (widget-get parent :children))
544 (setq child (car children)
545 children (cdr children))
546 (when (eq (widget-get child :button) widget)
547 (throw 'child child)))
550 (defun widget-map-buttons (function &optional buffer maparg)
551 "Map FUNCTION over the buttons in BUFFER.
552 FUNCTION is called with the arguments WIDGET and MAPARG.
554 If FUNCTION returns non-nil, the walk is cancelled.
556 The arguments MAPARG, and BUFFER default to nil and (current-buffer),
558 (let ((cur (point-min))
562 (save-excursion (set-buffer buffer) (overlay-lists))
564 (setq overlays (append (car overlays) (cdr overlays)))
565 (while (setq cur (pop overlays))
566 (setq widget (overlay-get cur 'button))
567 (if (and widget (funcall function widget maparg))
568 (setq overlays nil)))))
572 (defcustom widget-glyph-directory (concat data-directory "custom/")
573 "Where widget glyphs are located.
574 If this variable is nil, widget will try to locate the directory
579 (defcustom widget-glyph-enable t
580 "If non nil, use glyphs in images when available."
584 (defcustom widget-image-conversion
585 '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg")
587 "Conversion alist from image formats to file name suffixes."
589 :type '(repeat (cons :format "%v"
590 (symbol :tag "Image Format" unknown)
591 (repeat :tag "Suffixes"
592 (string :format "%v")))))
594 (defun widget-glyph-find (image tag)
595 "Create a glyph corresponding to IMAGE with string TAG as fallback.
596 IMAGE should either already be a glyph, or be a file name sans
597 extension (xpm, xbm, gif, jpg, or png) located in
598 `widget-glyph-directory'."
599 (cond ((not (and image
600 (string-match "XEmacs" emacs-version)
602 (fboundp 'make-glyph)
603 (fboundp 'locate-file)
605 ;; We don't want or can't use glyphs.
607 ((and (fboundp 'glyphp)
609 ;; Already a glyph. Use it.
612 ;; A string. Look it up in relevant directories.
613 (let* ((dirlist (list (or widget-glyph-directory
614 (concat data-directory
617 (formats widget-image-conversion)
619 (while (and formats (not file))
620 (when (valid-image-instantiator-format-p (car (car formats)))
621 (setq file (locate-file image dirlist
626 (setq formats (cdr formats))))
628 ;; We create a glyph with the file as the default image
629 ;; instantiator, and the TAG fallback
630 (make-glyph (list (vector (car (car formats)) ':file file)
631 (vector 'string ':data tag))))))
632 ((valid-instantiator-p image 'image)
633 ;; A valid image instantiator (e.g. [gif :file "somefile"] etc.)
634 (make-glyph (list image
635 (vector 'string ':data tag))))
637 ;; This could be virtually anything. Let `make-glyph' sort it out.
643 (defun widget-glyph-insert (widget tag image &optional down inactive)
644 "In WIDGET, insert the text TAG or, if supported, IMAGE.
645 IMAGE should either be a glyph, an image instantiator, or an image file
646 name sans extension (xpm, xbm, gif, jpg, or png) located in
647 `widget-glyph-directory'.
649 Optional arguments DOWN and INACTIVE is used instead of IMAGE when the
650 glyph is pressed or inactive, respectively.
652 WARNING: If you call this with a glyph, and you want the user to be
653 able to invoke the glyph, make sure it is unique. If you use the
654 same glyph for multiple widgets, invoking any of the glyphs will
655 cause the last created widget to be invoked.
657 Instead of an instantiator, you can also use a list of instantiators,
658 or whatever `make-glyph' will accept. However, in that case you must
659 provide the fallback TAG as a part of the instantiator yourself."
660 (let ((glyph (widget-glyph-find image tag)))
662 (widget-glyph-insert-glyph widget
664 (widget-glyph-find down tag)
665 (widget-glyph-find inactive tag))
668 (defun widget-glyph-insert-glyph (widget glyph &optional down inactive)
669 "In WIDGET, insert GLYPH.
670 If optional arguments DOWN and INACTIVE are given, they should be
671 glyphs used when the widget is pushed and inactive, respectively."
673 (set-glyph-property glyph 'widget widget)
675 (set-glyph-property down 'widget widget))
677 (set-glyph-property inactive 'widget widget)))
679 (let ((ext (make-extent (point) (1- (point))))
680 (help-echo (and widget (widget-get widget :help-echo))))
681 (set-extent-property ext 'invisible t)
682 (set-extent-property ext 'start-open t)
683 (set-extent-property ext 'end-open t)
684 (set-extent-end-glyph ext glyph)
686 (set-extent-property ext 'balloon-help help-echo)
687 (set-extent-property ext 'help-echo help-echo)))
689 (widget-put widget :glyph-up glyph)
690 (when down (widget-put widget :glyph-down down))
691 (when inactive (widget-put widget :glyph-inactive inactive))))
695 (defgroup widget-button nil
696 "The look of various kinds of buttons."
699 (defcustom widget-button-prefix ""
700 "String used as prefix for buttons."
702 :group 'widget-button)
704 (defcustom widget-button-suffix ""
705 "String used as suffix for buttons."
707 :group 'widget-button)
709 ;;; Creating Widgets.
712 (defun widget-create (type &rest args)
713 "Create widget of TYPE.
714 The optional ARGS are additional keyword arguments."
715 (let ((widget (apply 'widget-convert type args)))
716 (widget-apply widget :create)
719 (defun widget-create-child-and-convert (parent type &rest args)
720 "As part of the widget PARENT, create a child widget TYPE.
721 The child is converted, using the keyword arguments ARGS."
722 (let ((widget (apply 'widget-convert type args)))
723 (widget-put widget :parent parent)
724 (unless (widget-get widget :indent)
725 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
726 (or (widget-get widget :extra-offset) 0)
727 (widget-get parent :offset))))
728 (widget-apply widget :create)
731 (defun widget-create-child (parent type)
732 "Create widget of TYPE."
733 (let ((widget (copy-sequence type)))
734 (widget-put widget :parent parent)
735 (unless (widget-get widget :indent)
736 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
737 (or (widget-get widget :extra-offset) 0)
738 (widget-get parent :offset))))
739 (widget-apply widget :create)
742 (defun widget-create-child-value (parent type value)
743 "Create widget of TYPE with value VALUE."
744 (let ((widget (copy-sequence type)))
745 (widget-put widget :value (widget-apply widget :value-to-internal value))
746 (widget-put widget :parent parent)
747 (unless (widget-get widget :indent)
748 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
749 (or (widget-get widget :extra-offset) 0)
750 (widget-get parent :offset))))
751 (widget-apply widget :create)
755 (defun widget-delete (widget)
757 (widget-apply widget :delete))
759 (defun widget-convert (type &rest args)
760 "Convert TYPE to a widget without inserting it in the buffer.
761 The optional ARGS are additional keyword arguments."
762 ;; Don't touch the type.
763 (let* ((widget (if (symbolp type)
765 (copy-sequence type)))
768 ;; First set the :args keyword.
769 (while (cdr current) ;Look in the type.
770 (let ((next (car (cdr current))))
771 (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
772 (setq current (cdr (cdr current)))
773 (setcdr current (list :args (cdr current)))
774 (setq current nil))))
775 (while args ;Look in the args.
776 (let ((next (nth 0 args)))
777 (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
778 (setq args (nthcdr 2 args))
779 (widget-put widget :args args)
781 ;; Then Convert the widget.
784 (let ((convert-widget (plist-get (cdr type) :convert-widget)))
786 (setq widget (funcall convert-widget widget))))
787 (setq type (get (car type) 'widget-type)))
788 ;; Finally set the keyword args.
790 (let ((next (nth 0 keys)))
791 (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
793 (widget-put widget next (nth 1 keys))
794 (setq keys (nthcdr 2 keys)))
796 ;; Convert the :value to internal format.
797 (if (widget-member widget :value)
798 (let ((value (widget-get widget :value)))
800 :value (widget-apply widget :value-to-internal value))))
801 ;; Return the newly create widget.
804 (defun widget-insert (&rest args)
805 "Call `insert' with ARGS and make the text read only."
806 (let ((inhibit-read-only t)
807 before-change-functions
808 after-change-functions
810 (apply 'insert args)))
812 (defun widget-convert-text (type from to
813 &optional button-from button-to
815 "Return a widget of type TYPE with endpoint FROM TO.
816 Optional ARGS are extra keyword arguments for TYPE.
817 and TO will be used as the widgets end points. If optional arguments
818 BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets
820 Optional ARGS are extra keyword arguments for TYPE."
821 (let ((widget (apply 'widget-convert type :delete 'widget-leave-text args))
822 (from (copy-marker from))
823 (to (copy-marker to)))
824 (set-marker-insertion-type from t)
825 (set-marker-insertion-type to nil)
826 (widget-put widget :from from)
827 (widget-put widget :to to)
829 (widget-specify-button widget button-from button-to))
832 (defun widget-convert-button (type from to &rest args)
833 "Return a widget of type TYPE with endpoint FROM TO.
834 Optional ARGS are extra keyword arguments for TYPE.
835 No text will be inserted to the buffer, instead the text between FROM
836 and TO will be used as the widgets end points, as well as the widgets
838 (apply 'widget-convert-text type from to from to args))
840 (defun widget-leave-text (widget)
841 "Remove markers and overlays from WIDGET and its children."
842 (let ((from (widget-get widget :from))
843 (to (widget-get widget :to))
844 (button (widget-get widget :button-overlay))
845 (sample (widget-get widget :sample-overlay))
846 (doc (widget-get widget :doc-overlay))
847 (field (widget-get widget :field-overlay))
848 (children (widget-get widget :children)))
849 (set-marker from nil)
852 (delete-overlay button))
854 (delete-overlay sample))
856 (delete-overlay doc))
858 (delete-overlay field))
859 (mapcar 'widget-leave-text children)))
861 ;;; Keymap and Commands.
863 (defvar widget-keymap nil
864 "Keymap containing useful binding for buffers containing widgets.
865 Recommended as a parent keymap for modes using widgets.")
867 (unless widget-keymap
868 (setq widget-keymap (make-sparse-keymap))
869 (define-key widget-keymap "\t" 'widget-forward)
870 (define-key widget-keymap [(shift tab)] 'widget-backward)
871 (define-key widget-keymap [backtab] 'widget-backward)
872 (if (string-match "XEmacs" emacs-version)
875 (define-key widget-keymap [button1] 'widget-button1-click)
876 (define-key widget-keymap [button2] 'widget-button-click))
877 (define-key widget-keymap [down-mouse-2] 'widget-button-click))
878 (define-key widget-keymap "\C-m" 'widget-button-press))
880 (defvar widget-global-map global-map
881 "Keymap used for events the widget does not handle themselves.")
882 (make-variable-buffer-local 'widget-global-map)
884 (defvar widget-field-keymap nil
885 "Keymap used inside an editable field.")
887 (unless widget-field-keymap
888 (setq widget-field-keymap (copy-keymap widget-keymap))
889 (unless (string-match "XEmacs" (emacs-version))
890 (define-key widget-field-keymap [menu-bar] 'nil))
891 (define-key widget-field-keymap "\C-k" 'widget-kill-line)
892 (define-key widget-field-keymap "\M-\t" 'widget-complete)
893 (define-key widget-field-keymap "\C-m" 'widget-field-activate)
894 (define-key widget-field-keymap "\C-a" 'widget-beginning-of-line)
895 (define-key widget-field-keymap "\C-e" 'widget-end-of-line)
896 (set-keymap-parent widget-field-keymap global-map))
898 (defvar widget-text-keymap nil
899 "Keymap used inside a text field.")
901 (unless widget-text-keymap
902 (setq widget-text-keymap (copy-keymap widget-keymap))
903 (unless (string-match "XEmacs" (emacs-version))
904 (define-key widget-text-keymap [menu-bar] 'nil))
905 (define-key widget-text-keymap "\C-a" 'widget-beginning-of-line)
906 (define-key widget-text-keymap "\C-e" 'widget-end-of-line)
907 (set-keymap-parent widget-text-keymap global-map))
909 (defun widget-field-activate (pos &optional event)
910 "Invoke the ediable field at point."
912 (let ((field (get-char-property pos 'field)))
914 (widget-apply-action field event)
916 (lookup-key widget-global-map (this-command-keys))))))
918 (defface widget-button-pressed-face
922 (:bold t :underline t)))
923 "Face used for pressed buttons."
924 :group 'widget-faces)
926 (defun widget-button-click (event)
927 "Invoke the button that the mouse is pointing at, and move there."
929 (mouse-set-point event)
930 (cond ((and (fboundp 'event-glyph)
932 (widget-glyph-click event))
933 ((widget-event-point event)
934 (let* ((pos (widget-event-point event))
935 (button (get-char-property pos 'button)))
937 (let* ((overlay (widget-get button :button-overlay))
938 (face (overlay-get overlay 'face))
939 (mouse-face (overlay-get overlay 'mouse-face)))
941 (let ((track-mouse t))
943 'face 'widget-button-pressed-face)
945 'mouse-face 'widget-button-pressed-face)
946 (unless (widget-apply button :mouse-down-action event)
947 (while (not (button-release-event-p event))
948 (setq event (widget-read-event)
949 pos (widget-event-point event))
951 (eq (get-char-property pos 'button)
956 'widget-button-pressed-face)
959 'widget-button-pressed-face))
960 (overlay-put overlay 'face face)
961 (overlay-put overlay 'mouse-face mouse-face))))
963 (eq (get-char-property pos 'button) button))
964 (widget-apply-action button event)))
965 (overlay-put overlay 'face face)
966 (overlay-put overlay 'mouse-face mouse-face)))
969 ;; Find the global command to run, and check whether it
970 ;; is bound to an up event.
971 (cond ((setq command ;down event
972 (lookup-key widget-global-map [ button2 ]))
974 ((setq command ;down event
975 (lookup-key widget-global-map [ down-mouse-2 ]))
977 ((setq command ;up event
978 (lookup-key widget-global-map [ button2up ])))
979 ((setq command ;up event
980 (lookup-key widget-global-map [ mouse-2]))))
982 ;; Don't execute up events twice.
983 (while (not (button-release-event-p event))
984 (setq event (widget-read-event))))
986 (call-interactively command))))))
988 (message "You clicked somewhere weird."))))
990 (defun widget-button1-click (event)
991 "Invoke glyph below mouse pointer."
993 (if (and (fboundp 'event-glyph)
995 (widget-glyph-click event)
996 (call-interactively (lookup-key widget-global-map (this-command-keys)))))
998 (defun widget-glyph-click (event)
999 "Handle click on a glyph."
1000 (let* ((glyph (event-glyph event))
1001 (widget (glyph-property glyph 'widget))
1002 (extent (event-glyph-extent event))
1003 (down-glyph (or (and widget (widget-get widget :glyph-down)) glyph))
1004 (up-glyph (or (and widget (widget-get widget :glyph-up)) glyph))
1006 ;; Wait for the release.
1007 (while (not (button-release-event-p last))
1008 (if (eq extent (event-glyph-extent last))
1009 (set-extent-property extent 'end-glyph down-glyph)
1010 (set-extent-property extent 'end-glyph up-glyph))
1011 (setq last (read-event event)))
1014 (set-extent-property extent 'end-glyph up-glyph))
1015 ;; Apply widget action.
1016 (when (eq extent (event-glyph-extent last))
1017 (let ((widget (glyph-property (event-glyph event) 'widget)))
1018 (cond ((null widget)
1019 (message "You clicked on a glyph."))
1020 ((not (widget-apply widget :active))
1021 (message "This glyph is inactive."))
1023 (widget-apply-action widget event)))))))
1025 (defun widget-button-press (pos &optional event)
1026 "Invoke button at POS."
1028 (let ((button (get-char-property pos 'button)))
1030 (widget-apply-action button event)
1031 (let ((command (lookup-key widget-global-map (this-command-keys))))
1032 (when (commandp command)
1033 (call-interactively command))))))
1035 (defun widget-tabable-at (&optional pos)
1036 "Return the tabable widget at POS, or nil.
1037 POS defaults to the value of (point)."
1040 (let ((widget (or (get-char-property (point) 'button)
1041 (get-char-property (point) 'field))))
1043 (let ((order (widget-get widget :tab-order)))
1051 (defcustom widget-use-overlay-change (string-match "XEmacs" emacs-version)
1052 "If non-nil, use overlay change functions to tab around in the buffer.
1053 This is much faster, but doesn't work reliably on Emacs 19.34."
1057 (defun widget-move (arg)
1058 "Move point to the ARG next field or button.
1059 ARG may be negative to move backward."
1060 (or (bobp) (> arg 0) (backward-char))
1063 (old (widget-tabable-at))
1068 (goto-char (point-min)))
1069 (widget-use-overlay-change
1070 (goto-char (next-overlay-change (point))))
1073 (and (eq pos (point))
1075 (error "No buttons or fields found"))
1076 (let ((new (widget-tabable-at)))
1078 (unless (eq new old)
1084 (goto-char (point-max)))
1085 (widget-use-overlay-change
1086 (goto-char (previous-overlay-change (point))))
1089 (and (eq pos (point))
1091 (error "No buttons or fields found"))
1092 (let ((new (widget-tabable-at)))
1094 (unless (eq new old)
1095 (setq arg (1+ arg))))))
1096 (let ((new (widget-tabable-at)))
1097 (while (eq (widget-tabable-at) new)
1100 (widget-echo-help (point))
1101 (run-hooks 'widget-move-hook))
1103 (defun widget-forward (arg)
1104 "Move point to the next field or button.
1105 With optional ARG, move across that many fields."
1107 (run-hooks 'widget-forward-hook)
1110 (defun widget-backward (arg)
1111 "Move point to the previous field or button.
1112 With optional ARG, move across that many fields."
1114 (run-hooks 'widget-backward-hook)
1115 (widget-move (- arg)))
1117 (defun widget-beginning-of-line ()
1118 "Go to beginning of field or beginning of line, whichever is first."
1120 (let* ((field (widget-field-find (point)))
1121 (start (and field (widget-field-start field)))
1122 (bol (save-excursion
1125 (goto-char (if start
1129 (defun widget-end-of-line ()
1130 "Go to end of field or end of line, whichever is first."
1132 (let* ((field (widget-field-find (point)))
1133 (end (and field (widget-field-end field)))
1134 (eol (save-excursion
1141 (defun widget-kill-line ()
1142 "Kill to end of field or end of line, whichever is first."
1144 (let* ((field (widget-field-find (point)))
1145 (newline (save-excursion (forward-line 1) (point)))
1146 (end (and field (widget-field-end field))))
1147 (if (and field (> newline end))
1148 (kill-region (point) end)
1149 (call-interactively 'kill-line))))
1151 (defcustom widget-complete-field (lookup-key global-map "\M-\t")
1152 "Default function to call for completion inside fields."
1153 :options '(ispell-complete-word complete-tag lisp-complete-symbol)
1157 (defun widget-complete ()
1158 "Complete content of editable field from point.
1159 When not inside a field, move to the previous button or field."
1161 (let ((field (widget-field-find (point))))
1163 (widget-apply field :complete)
1164 (error "Not in an editable field"))))
1166 ;;; Setting up the buffer.
1168 (defvar widget-field-new nil)
1169 ;; List of all newly created editable fields in the buffer.
1170 (make-variable-buffer-local 'widget-field-new)
1172 (defvar widget-field-list nil)
1173 ;; List of all editable fields in the buffer.
1174 (make-variable-buffer-local 'widget-field-list)
1176 (defun widget-setup ()
1177 "Setup current buffer so editing string widgets works."
1178 (let ((inhibit-read-only t)
1179 (after-change-functions nil)
1180 before-change-functions
1182 (while widget-field-new
1183 (setq field (car widget-field-new)
1184 widget-field-new (cdr widget-field-new)
1185 widget-field-list (cons field widget-field-list))
1186 (let ((from (car (widget-get field :field-overlay)))
1187 (to (cdr (widget-get field :field-overlay))))
1188 (widget-specify-field field
1189 (marker-position from) (marker-position to))
1190 (set-marker from nil)
1191 (set-marker to nil))))
1193 (widget-add-change))
1195 (defvar widget-field-last nil)
1196 ;; Last field containing point.
1197 (make-variable-buffer-local 'widget-field-last)
1199 (defvar widget-field-was nil)
1200 ;; The widget data before the change.
1201 (make-variable-buffer-local 'widget-field-was)
1203 (defun widget-field-buffer (widget)
1204 "Return the start of WIDGET's editing field."
1205 (let ((overlay (widget-get widget :field-overlay)))
1206 (and overlay (overlay-buffer overlay))))
1208 (defun widget-field-start (widget)
1209 "Return the start of WIDGET's editing field."
1210 (let ((overlay (widget-get widget :field-overlay)))
1211 (and overlay (overlay-start overlay))))
1213 (defun widget-field-end (widget)
1214 "Return the end of WIDGET's editing field."
1215 (let ((overlay (widget-get widget :field-overlay)))
1216 ;; Don't subtract one if local-map works at the end of the overlay.
1217 (and overlay (if (or widget-field-add-space
1218 (null (widget-get widget :size)))
1219 (1- (overlay-end overlay))
1220 (overlay-end overlay)))))
1222 (defun widget-field-find (pos)
1223 "Return the field at POS.
1224 Unlike (get-char-property POS 'field) this, works with empty fields too."
1225 (let ((fields widget-field-list)
1228 (setq field (car fields)
1229 fields (cdr fields))
1230 (let ((start (widget-field-start field))
1231 (end (widget-field-end field)))
1232 (when (and (<= start pos) (<= pos end))
1234 (debug "Overlapping fields"))
1235 (setq found field))))
1238 (defun widget-before-change (from to)
1239 ;; This is how, for example, a variable changes its state to `modified'.
1240 ;; when it is being edited.
1241 (unless inhibit-read-only
1242 (let ((from-field (widget-field-find from))
1243 (to-field (widget-field-find to)))
1244 (cond ((not (eq from-field to-field))
1245 (add-hook 'post-command-hook 'widget-add-change nil t)
1246 (signal 'text-read-only
1247 '("Change should be restricted to a single field")))
1249 (add-hook 'post-command-hook 'widget-add-change nil t)
1250 (signal 'text-read-only
1251 '("Attempt to change text outside editable field")))
1252 (widget-field-use-before-change
1254 (widget-apply from-field :notify from-field)
1255 (error (debug "Before Change"))))))))
1257 (defun widget-add-change ()
1258 (make-local-hook 'post-command-hook)
1259 (remove-hook 'post-command-hook 'widget-add-change t)
1260 (make-local-hook 'before-change-functions)
1261 (add-hook 'before-change-functions 'widget-before-change nil t)
1262 (make-local-hook 'after-change-functions)
1263 (add-hook 'after-change-functions 'widget-after-change nil t))
1265 (defun widget-after-change (from to old)
1266 ;; Adjust field size and text properties.
1268 (let ((field (widget-field-find from))
1269 (other (widget-field-find to)))
1271 (unless (eq field other)
1272 (debug "Change in different fields"))
1273 (let ((size (widget-get field :size)))
1275 (let ((begin (widget-field-start field))
1276 (end (widget-field-end field)))
1277 (cond ((< (- end begin) size)
1281 (insert-char ?\ (- (+ begin size) end))))
1282 ((> (- end begin) size)
1283 ;; Field too large and
1284 (if (or (< (point) (+ begin size))
1286 ;; Point is outside extra space.
1287 (setq begin (+ begin size))
1288 ;; Point is within the extra space.
1289 (setq begin (point)))
1292 (while (and (eq (preceding-char) ?\ )
1294 (delete-backward-char 1)))))))
1295 (widget-specify-secret field))
1296 (widget-apply field :notify field)))
1297 (error (debug "After Change"))))
1299 ;;; Widget Functions
1301 ;; These functions are used in the definition of multiple widgets.
1303 (defun widget-parent-action (widget &optional event)
1304 "Tell :parent of WIDGET to handle the :action.
1305 Optional EVENT is the event that triggered the action."
1306 (widget-apply (widget-get widget :parent) :action event))
1308 (defun widget-children-value-delete (widget)
1309 "Delete all :children and :buttons in WIDGET."
1310 (mapcar 'widget-delete (widget-get widget :children))
1311 (widget-put widget :children nil)
1312 (mapcar 'widget-delete (widget-get widget :buttons))
1313 (widget-put widget :buttons nil))
1315 (defun widget-children-validate (widget)
1316 "All the :children must be valid."
1317 (let ((children (widget-get widget :children))
1319 (while (and children (not found))
1320 (setq child (car children)
1321 children (cdr children)
1322 found (widget-apply child :validate)))
1325 (defun widget-types-convert-widget (widget)
1326 "Convert :args as widget types in WIDGET."
1327 (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args)))
1330 (defun widget-value-convert-widget (widget)
1331 "Initialize :value from :args in WIDGET."
1332 (let ((args (widget-get widget :args)))
1334 (widget-put widget :value (car args))
1335 ;; Don't convert :value here, as this is done in `widget-convert'.
1336 ;; (widget-put widget :value (widget-apply widget
1337 ;; :value-to-internal (car args)))
1338 (widget-put widget :args nil)))
1341 (defun widget-value-value-get (widget)
1342 "Return the :value property of WIDGET."
1343 (widget-get widget :value))
1345 ;;; The `default' Widget.
1347 (define-widget 'default nil
1348 "Basic widget other widgets are derived from."
1349 :value-to-internal (lambda (widget value) value)
1350 :value-to-external (lambda (widget value) value)
1351 :button-prefix 'widget-button-prefix
1352 :button-suffix 'widget-button-suffix
1353 :complete 'widget-default-complete
1354 :create 'widget-default-create
1357 :format-handler 'widget-default-format-handler
1358 :button-face-get 'widget-default-button-face-get
1359 :sample-face-get 'widget-default-sample-face-get
1360 :delete 'widget-default-delete
1361 :value-set 'widget-default-value-set
1362 :value-inline 'widget-default-value-inline
1363 :default-get 'widget-default-default-get
1364 :menu-tag-get 'widget-default-menu-tag-get
1365 :validate (lambda (widget) nil)
1366 :active 'widget-default-active
1367 :activate 'widget-specify-active
1368 :deactivate 'widget-default-deactivate
1369 :mouse-down-action (lambda (widget event) nil)
1370 :action 'widget-default-action
1371 :notify 'widget-default-notify
1372 :prompt-value 'widget-default-prompt-value)
1374 (defun widget-default-complete (widget)
1375 "Call the value of the :complete-function property of WIDGET.
1376 If that does not exists, call the value of `widget-complete-field'."
1377 (let ((fun (widget-get widget :complete-function)))
1378 (call-interactively (or fun widget-complete-field))))
1380 (defun widget-default-create (widget)
1381 "Create WIDGET at point in the current buffer."
1382 (widget-specify-insert
1383 (let ((from (point))
1384 button-begin button-end
1385 sample-begin sample-end
1388 (insert (widget-get widget :format))
1390 ;; Parse escapes in format.
1391 (while (re-search-forward "%\\(.\\)" nil t)
1392 (let ((escape (aref (match-string 1) 0)))
1393 (replace-match "" t t)
1394 (cond ((eq escape ?%)
1397 (setq button-begin (point))
1398 (insert (widget-get-indirect widget :button-prefix)))
1400 (insert (widget-get-indirect widget :button-suffix))
1401 (setq button-end (point)))
1403 (setq sample-begin (point)))
1405 (setq sample-end (point)))
1407 (when (widget-get widget :indent)
1409 (insert-char ? (widget-get widget :indent))))
1411 (let ((glyph (widget-get widget :tag-glyph))
1412 (tag (widget-get widget :tag)))
1414 (widget-glyph-insert widget (or tag "image") glyph))
1418 (let ((standard-output (current-buffer)))
1419 (princ (widget-get widget :value)))))))
1421 (let ((doc (widget-get widget :doc)))
1423 (setq doc-begin (point))
1425 (while (eq (preceding-char) ?\n)
1426 (delete-backward-char 1))
1428 (setq doc-end (point)))))
1430 (if (and button-begin (not button-end))
1431 (widget-apply widget :value-create)
1432 (setq value-pos (point))))
1434 (widget-apply widget :format-handler escape)))))
1435 ;; Specify button, sample, and doc, and insert value.
1436 (and button-begin button-end
1437 (widget-specify-button widget button-begin button-end))
1438 (and sample-begin sample-end
1439 (widget-specify-sample widget sample-begin sample-end))
1440 (and doc-begin doc-end
1441 (widget-specify-doc widget doc-begin doc-end))
1443 (goto-char value-pos)
1444 (widget-apply widget :value-create)))
1445 (let ((from (copy-marker (point-min)))
1446 (to (copy-marker (point-max))))
1447 (set-marker-insertion-type from t)
1448 (set-marker-insertion-type to nil)
1449 (widget-put widget :from from)
1450 (widget-put widget :to to)))
1451 (widget-clear-undo))
1453 (defun widget-default-format-handler (widget escape)
1454 ;; We recognize the %h escape by default.
1455 (let* ((buttons (widget-get widget :buttons)))
1456 (cond ((eq escape ?h)
1457 (let* ((doc-property (widget-get widget :documentation-property))
1458 (doc-try (cond ((widget-get widget :doc))
1459 ((symbolp doc-property)
1460 (documentation-property
1461 (widget-get widget :value)
1464 (funcall doc-property
1465 (widget-get widget :value)))))
1466 (doc-text (and (stringp doc-try)
1467 (> (length doc-try) 1)
1469 (doc-indent (widget-get widget :documentation-indent)))
1471 (and (eq (preceding-char) ?\n)
1472 (widget-get widget :indent)
1473 (insert-char ? (widget-get widget :indent)))
1474 ;; The `*' in the beginning is redundant.
1475 (when (eq (aref doc-text 0) ?*)
1476 (setq doc-text (substring doc-text 1)))
1477 ;; Get rid of trailing newlines.
1478 (when (string-match "\n+\\'" doc-text)
1479 (setq doc-text (substring doc-text 0 (match-beginning 0))))
1480 (push (widget-create-child-and-convert
1481 widget 'documentation-string
1482 :indent (cond ((numberp doc-indent )
1490 (error "Unknown escape `%c'" escape)))
1491 (widget-put widget :buttons buttons)))
1493 (defun widget-default-button-face-get (widget)
1494 ;; Use :button-face or widget-button-face
1495 (or (widget-get widget :button-face)
1496 (let ((parent (widget-get widget :parent)))
1498 (widget-apply parent :button-face-get)
1499 widget-button-face))))
1501 (defun widget-default-sample-face-get (widget)
1502 ;; Use :sample-face.
1503 (widget-get widget :sample-face))
1505 (defun widget-default-delete (widget)
1506 ;; Remove widget from the buffer.
1507 (let ((from (widget-get widget :from))
1508 (to (widget-get widget :to))
1509 (inactive-overlay (widget-get widget :inactive))
1510 (button-overlay (widget-get widget :button-overlay))
1511 (sample-overlay (widget-get widget :sample-overlay))
1512 (doc-overlay (widget-get widget :doc-overlay))
1513 before-change-functions
1514 after-change-functions
1515 (inhibit-read-only t))
1516 (widget-apply widget :value-delete)
1517 (when inactive-overlay
1518 (delete-overlay inactive-overlay))
1519 (when button-overlay
1520 (delete-overlay button-overlay))
1521 (when sample-overlay
1522 (delete-overlay sample-overlay))
1524 (delete-overlay doc-overlay))
1526 ;; Kludge: this doesn't need to be true for empty formats.
1527 (delete-region from to))
1528 (set-marker from nil)
1529 (set-marker to nil))
1530 (widget-clear-undo))
1532 (defun widget-default-value-set (widget value)
1533 ;; Recreate widget with new value.
1534 (let* ((old-pos (point))
1535 (from (copy-marker (widget-get widget :from)))
1536 (to (copy-marker (widget-get widget :to)))
1537 (offset (if (and (<= from old-pos) (<= old-pos to))
1538 (if (>= old-pos (1- to))
1540 (- old-pos from)))))
1541 ;;??? Bug: this ought to insert the new value before deleting the old one,
1542 ;; so that markers on either side of the value automatically
1543 ;; stay on the same side. -- rms.
1545 (goto-char (widget-get widget :from))
1546 (widget-apply widget :delete)
1547 (widget-put widget :value value)
1548 (widget-apply widget :create))
1551 (goto-char (+ (widget-get widget :to) offset 1))
1552 (goto-char (min (+ from offset) (1- (widget-get widget :to))))))))
1554 (defun widget-default-value-inline (widget)
1555 ;; Wrap value in a list unless it is inline.
1556 (if (widget-get widget :inline)
1557 (widget-value widget)
1558 (list (widget-value widget))))
1560 (defun widget-default-default-get (widget)
1562 (widget-get widget :value))
1564 (defun widget-default-menu-tag-get (widget)
1565 ;; Use tag or value for menus.
1566 (or (widget-get widget :menu-tag)
1567 (widget-get widget :tag)
1568 (widget-princ-to-string (widget-get widget :value))))
1570 (defun widget-default-active (widget)
1571 "Return t iff this widget active (user modifiable)."
1572 (and (not (widget-get widget :inactive))
1573 (let ((parent (widget-get widget :parent)))
1575 (widget-apply parent :active)))))
1577 (defun widget-default-deactivate (widget)
1578 "Make WIDGET inactive for user modifications."
1579 (widget-specify-inactive widget
1580 (widget-get widget :from)
1581 (widget-get widget :to)))
1583 (defun widget-default-action (widget &optional event)
1584 ;; Notify the parent when a widget change
1585 (let ((parent (widget-get widget :parent)))
1587 (widget-apply parent :notify widget event))))
1589 (defun widget-default-notify (widget child &optional event)
1590 ;; Pass notification to parent.
1591 (widget-default-action widget event))
1593 (defun widget-default-prompt-value (widget prompt value unbound)
1594 ;; Read an arbitrary value. Stolen from `set-variable'.
1595 ;; (let ((initial (if unbound
1597 ;; ;; It would be nice if we could do a `(cons val 1)' here.
1598 ;; (prin1-to-string (custom-quote value))))))
1599 (eval-minibuffer prompt ))
1601 ;;; The `item' Widget.
1603 (define-widget 'item 'default
1604 "Constant items for inclusion in other widgets."
1605 :convert-widget 'widget-value-convert-widget
1606 :value-create 'widget-item-value-create
1607 :value-delete 'ignore
1608 :value-get 'widget-value-value-get
1609 :match 'widget-item-match
1610 :match-inline 'widget-item-match-inline
1611 :action 'widget-item-action
1614 (defun widget-item-value-create (widget)
1615 ;; Insert the printed representation of the value.
1616 (let ((standard-output (current-buffer)))
1617 (princ (widget-get widget :value))))
1619 (defun widget-item-match (widget value)
1620 ;; Match if the value is the same.
1621 (equal (widget-get widget :value) value))
1623 (defun widget-item-match-inline (widget values)
1624 ;; Match if the value is the same.
1625 (let ((value (widget-get widget :value)))
1627 (<= (length value) (length values))
1628 (let ((head (widget-sublist values 0 (length value))))
1629 (and (equal head value)
1630 (cons head (widget-sublist values (length value))))))))
1632 (defun widget-sublist (list start &optional end)
1633 "Return the sublist of LIST from START to END.
1634 If END is omitted, it defaults to the length of LIST."
1635 (if (> start 0) (setq list (nthcdr start list)))
1639 (setq list (copy-sequence list))
1640 (setcdr (nthcdr (- end start 1) list) nil)
1642 (copy-sequence list)))
1644 (defun widget-item-action (widget &optional event)
1645 ;; Just notify itself.
1646 (widget-apply widget :notify widget event))
1648 ;;; The `push-button' Widget.
1650 (defcustom widget-push-button-gui t
1651 "If non nil, use GUI push buttons when available."
1655 ;; Cache already created GUI objects.
1656 (defvar widget-push-button-cache nil)
1658 (defcustom widget-push-button-prefix "["
1659 "String used as prefix for buttons."
1661 :group 'widget-button)
1663 (defcustom widget-push-button-suffix "]"
1664 "String used as suffix for buttons."
1666 :group 'widget-button)
1668 (define-widget 'push-button 'item
1669 "A pushable button."
1672 :value-create 'widget-push-button-value-create
1675 (defun widget-push-button-value-create (widget)
1676 ;; Insert text representing the `on' and `off' states.
1677 (let* ((tag (or (widget-get widget :tag)
1678 (widget-get widget :value)))
1679 (tag-glyph (widget-get widget :tag-glyph))
1680 (text (concat widget-push-button-prefix
1681 tag widget-push-button-suffix))
1682 (gui (cdr (assoc tag widget-push-button-cache))))
1684 (widget-glyph-insert widget text tag-glyph))
1685 ((and (fboundp 'make-gui-button)
1686 (fboundp 'make-glyph)
1687 widget-push-button-gui
1688 (fboundp 'device-on-window-system-p)
1689 (device-on-window-system-p)
1690 (string-match "XEmacs" emacs-version))
1692 (setq gui (make-gui-button tag 'widget-gui-action widget))
1693 (push (cons tag gui) widget-push-button-cache))
1694 (widget-glyph-insert-glyph widget
1696 (list (nth 0 (aref gui 1))
1697 (vector 'string ':data text)))
1699 (list (nth 1 (aref gui 1))
1700 (vector 'string ':data text)))
1702 (list (nth 2 (aref gui 1))
1703 (vector 'string ':data text)))))
1707 (defun widget-gui-action (widget)
1708 "Apply :action for WIDGET."
1709 (widget-apply-action widget (this-command-keys)))
1711 ;;; The `link' Widget.
1713 (defcustom widget-link-prefix "["
1714 "String used as prefix for links."
1716 :group 'widget-button)
1718 (defcustom widget-link-suffix "]"
1719 "String used as suffix for links."
1721 :group 'widget-button)
1723 (define-widget 'link 'item
1725 :button-prefix 'widget-link-prefix
1726 :button-suffix 'widget-link-suffix
1727 :help-echo "Follow the link."
1730 ;;; The `info-link' Widget.
1732 (define-widget 'info-link 'link
1733 "A link to an info file."
1734 :action 'widget-info-link-action)
1736 (defun widget-info-link-action (widget &optional event)
1737 "Open the info node specified by WIDGET."
1738 (Info-goto-node (widget-value widget)))
1740 ;;; The `url-link' Widget.
1742 (define-widget 'url-link 'link
1743 "A link to an www page."
1744 :action 'widget-url-link-action)
1746 (defun widget-url-link-action (widget &optional event)
1747 "Open the url specified by WIDGET."
1748 (browse-url (widget-value widget)))
1750 ;;; The `function-link' Widget.
1752 (define-widget 'function-link 'link
1753 "A link to an Emacs function."
1754 :action 'widget-function-link-action)
1756 (defun widget-function-link-action (widget &optional event)
1757 "Show the function specified by WIDGET."
1758 (describe-function (widget-value widget)))
1760 ;;; The `variable-link' Widget.
1762 (define-widget 'variable-link 'link
1763 "A link to an Emacs variable."
1764 :action 'widget-variable-link-action)
1766 (defun widget-variable-link-action (widget &optional event)
1767 "Show the variable specified by WIDGET."
1768 (describe-variable (widget-value widget)))
1770 ;;; The `file-link' Widget.
1772 (define-widget 'file-link 'link
1774 :action 'widget-file-link-action)
1776 (defun widget-file-link-action (widget &optional event)
1777 "Find the file specified by WIDGET."
1778 (find-file (widget-value widget)))
1780 ;;; The `emacs-library-link' Widget.
1782 (define-widget 'emacs-library-link 'link
1783 "A link to an Emacs Lisp library file."
1784 :action 'widget-emacs-library-link-action)
1786 (defun widget-emacs-library-link-action (widget &optional event)
1787 "Find the Emacs Library file specified by WIDGET."
1788 (find-file (locate-library (widget-value widget))))
1790 ;;; The `emacs-commentary-link' Widget.
1792 (define-widget 'emacs-commentary-link 'link
1793 "A link to Commentary in an Emacs Lisp library file."
1794 :action 'widget-emacs-commentary-link-action)
1796 (defun widget-emacs-commentary-link-action (widget &optional event)
1797 "Find the Commentary section of the Emacs file specified by WIDGET."
1798 (finder-commentary (widget-value widget)))
1800 ;;; The `editable-field' Widget.
1802 (define-widget 'editable-field 'default
1803 "An editable text field."
1804 :convert-widget 'widget-value-convert-widget
1805 :keymap widget-field-keymap
1808 :prompt-internal 'widget-field-prompt-internal
1809 :prompt-history 'widget-field-history
1810 :prompt-value 'widget-field-prompt-value
1811 :action 'widget-field-action
1812 :validate 'widget-field-validate
1815 :value-create 'widget-field-value-create
1816 :value-delete 'widget-field-value-delete
1817 :value-get 'widget-field-value-get
1818 :match 'widget-field-match)
1820 (defvar widget-field-history nil
1821 "History of field minibuffer edits.")
1823 (defun widget-field-prompt-internal (widget prompt initial history)
1824 ;; Read string for WIDGET promptinhg with PROMPT.
1825 ;; INITIAL is the initial input and HISTORY is a symbol containing
1826 ;; the earlier input.
1827 (read-string prompt initial history))
1829 (defun widget-field-prompt-value (widget prompt value unbound)
1830 ;; Prompt for a string.
1831 (let ((initial (if unbound
1833 (cons (widget-apply widget :value-to-internal
1835 (history (widget-get widget :prompt-history)))
1836 (let ((answer (widget-apply widget
1837 :prompt-internal prompt initial history)))
1838 (widget-apply widget :value-to-external answer))))
1840 (defvar widget-edit-functions nil)
1842 (defun widget-field-action (widget &optional event)
1843 ;; Move to next field.
1845 (run-hook-with-args 'widget-edit-functions widget))
1847 (defun widget-field-validate (widget)
1848 ;; Valid if the content matches `:valid-regexp'.
1850 (let ((value (widget-apply widget :value-get))
1851 (regexp (widget-get widget :valid-regexp)))
1852 (if (string-match regexp value)
1856 (defun widget-field-value-create (widget)
1857 ;; Create an editable text field.
1858 (let ((size (widget-get widget :size))
1859 (value (widget-get widget :value))
1861 ;; This is changed to a real overlay in `widget-setup'. We
1862 ;; need the end points to behave differently until
1863 ;; `widget-setup' is called.
1864 (overlay (cons (make-marker) (make-marker))))
1865 (widget-put widget :field-overlay overlay)
1868 (< (length value) size)
1869 (insert-char ?\ (- size (length value))))
1870 (unless (memq widget widget-field-list)
1871 (setq widget-field-new (cons widget widget-field-new)))
1872 (move-marker (cdr overlay) (point))
1873 (set-marker-insertion-type (cdr overlay) nil)
1876 (move-marker (car overlay) from)
1877 (set-marker-insertion-type (car overlay) t)))
1879 (defun widget-field-value-delete (widget)
1880 ;; Remove the widget from the list of active editing fields.
1881 (setq widget-field-list (delq widget widget-field-list))
1882 ;; These are nil if the :format string doesn't contain `%v'.
1883 (let ((overlay (widget-get widget :field-overlay)))
1885 (delete-overlay overlay))))
1887 (defun widget-field-value-get (widget)
1888 ;; Return current text in editing field.
1889 (let ((from (widget-field-start widget))
1890 (to (widget-field-end widget))
1891 (buffer (widget-field-buffer widget))
1892 (size (widget-get widget :size))
1893 (secret (widget-get widget :secret))
1894 (old (current-buffer)))
1901 (eq (char-after (1- to)) ?\ ))
1903 (let ((result (buffer-substring-no-properties from to)))
1906 (while (< (+ from index) to)
1908 (get-char-property (+ from index) 'secret))
1909 (setq index (1+ index)))))
1912 (widget-get widget :value))))
1914 (defun widget-field-match (widget value)
1915 ;; Match any string.
1918 ;;; The `text' Widget.
1920 (define-widget 'text 'editable-field
1921 :keymap widget-text-keymap
1922 "A multiline text area.")
1924 ;;; The `menu-choice' Widget.
1926 (define-widget 'menu-choice 'default
1927 "A menu of options."
1928 :convert-widget 'widget-types-convert-widget
1929 :format "%[%t%]: %v"
1932 :void '(item :format "invalid (%t)\n")
1933 :value-create 'widget-choice-value-create
1934 :value-delete 'widget-children-value-delete
1935 :value-get 'widget-choice-value-get
1936 :value-inline 'widget-choice-value-inline
1937 :default-get 'widget-choice-default-get
1938 :mouse-down-action 'widget-choice-mouse-down-action
1939 :action 'widget-choice-action
1940 :error "Make a choice"
1941 :validate 'widget-choice-validate
1942 :match 'widget-choice-match
1943 :match-inline 'widget-choice-match-inline)
1945 (defun widget-choice-value-create (widget)
1946 ;; Insert the first choice that matches the value.
1947 (let ((value (widget-get widget :value))
1948 (args (widget-get widget :args))
1949 (explicit (widget-get widget :explicit-choice))
1950 (explicit-value (widget-get widget :explicit-choice-value))
1952 (if (and explicit (equal value explicit-value))
1954 ;; If the user specified the choice for this value,
1955 ;; respect that choice as long as the value is the same.
1956 (widget-put widget :children (list (widget-create-child-value
1957 widget explicit value)))
1958 (widget-put widget :choice explicit))
1960 (setq current (car args)
1962 (when (widget-apply current :match value)
1963 (widget-put widget :children (list (widget-create-child-value
1964 widget current value)))
1965 (widget-put widget :choice current)
1969 (let ((void (widget-get widget :void)))
1970 (widget-put widget :children (list (widget-create-child-and-convert
1971 widget void :value value)))
1972 (widget-put widget :choice void))))))
1974 (defun widget-choice-value-get (widget)
1975 ;; Get value of the child widget.
1976 (widget-value (car (widget-get widget :children))))
1978 (defun widget-choice-value-inline (widget)
1979 ;; Get value of the child widget.
1980 (widget-apply (car (widget-get widget :children)) :value-inline))
1982 (defun widget-choice-default-get (widget)
1983 ;; Get default for the first choice.
1984 (widget-default-get (car (widget-get widget :args))))
1986 (defcustom widget-choice-toggle nil
1987 "If non-nil, a binary choice will just toggle between the values.
1988 Otherwise, the user will explicitly have to choose between the values
1989 when he invoked the menu."
1993 (defun widget-choice-mouse-down-action (widget &optional event)
1994 ;; Return non-nil if we need a menu.
1995 (let ((args (widget-get widget :args))
1996 (old (widget-get widget :choice)))
1997 (cond ((not window-system)
1998 ;; No place to pop up a menu.
2000 ((not (or (fboundp 'x-popup-menu) (fboundp 'popup-menu)))
2001 ;; No way to pop up a menu.
2003 ((< (length args) 2)
2004 ;; Empty or singleton list, just return the value.
2006 ((> (length args) widget-menu-max-size)
2007 ;; Too long, prompt.
2009 ((> (length args) 2)
2010 ;; Reasonable sized list, use menu.
2012 ((and widget-choice-toggle (memq old args))
2016 ;; Ask which of the two.
2019 (defun widget-choice-action (widget &optional event)
2021 (let ((args (widget-get widget :args))
2022 (old (widget-get widget :choice))
2023 (tag (widget-apply widget :menu-tag-get))
2024 (completion-ignore-case (widget-get widget :case-fold))
2027 ;; Remember old value.
2028 (if (and old (not (widget-apply widget :validate)))
2029 (let* ((external (widget-value widget))
2030 (internal (widget-apply old :value-to-internal external)))
2031 (widget-put old :value internal)))
2034 (cond ((= (length args) 0)
2036 ((= (length args) 1)
2038 ((and widget-choice-toggle
2041 (if (eq old (nth 0 args))
2046 (setq current (car args)
2049 (cons (cons (widget-apply current :menu-tag-get)
2052 (setq this-explicit t)
2053 (widget-choose tag (reverse choices) event))))
2055 ;; If this was an explicit user choice,
2056 ;; record the choice, and the record the value it was made for.
2057 ;; widget-choice-value-create will respect this choice,
2058 ;; as long as the value is the same.
2060 (widget-put widget :explicit-choice current)
2061 (widget-put widget :explicit-choice-value (widget-get widget :value)))
2062 (let ((value (widget-default-get current)))
2063 (widget-value-set widget
2064 (widget-apply current :value-to-external value)))
2066 (widget-apply widget :notify widget event)))
2067 (run-hook-with-args 'widget-edit-functions widget))
2069 (defun widget-choice-validate (widget)
2070 ;; Valid if we have made a valid choice.
2071 (let ((void (widget-get widget :void))
2072 (choice (widget-get widget :choice))
2073 (child (car (widget-get widget :children))))
2074 (if (eq void choice)
2076 (widget-apply child :validate))))
2078 (defun widget-choice-match (widget value)
2079 ;; Matches if one of the choices matches.
2080 (let ((args (widget-get widget :args))
2082 (while (and args (not found))
2083 (setq current (car args)
2085 found (widget-apply current :match value)))
2088 (defun widget-choice-match-inline (widget values)
2089 ;; Matches if one of the choices matches.
2090 (let ((args (widget-get widget :args))
2092 (while (and args (null found))
2093 (setq current (car args)
2095 found (widget-match-inline current values)))
2098 ;;; The `toggle' Widget.
2100 (define-widget 'toggle 'item
2101 "Toggle between two states."
2103 :value-create 'widget-toggle-value-create
2104 :action 'widget-toggle-action
2105 :match (lambda (widget value) t)
2109 (defun widget-toggle-value-create (widget)
2110 ;; Insert text representing the `on' and `off' states.
2111 (if (widget-value widget)
2112 (widget-glyph-insert widget
2113 (widget-get widget :on)
2114 (widget-get widget :on-glyph))
2115 (widget-glyph-insert widget
2116 (widget-get widget :off)
2117 (widget-get widget :off-glyph))))
2119 (defun widget-toggle-action (widget &optional event)
2121 (widget-value-set widget (not (widget-value widget)))
2122 (widget-apply widget :notify widget event)
2123 (run-hook-with-args 'widget-edit-functions widget))
2125 ;;; The `checkbox' Widget.
2127 (define-widget 'checkbox 'toggle
2128 "A checkbox toggle."
2136 :action 'widget-checkbox-action)
2138 (defun widget-checkbox-action (widget &optional event)
2139 "Toggle checkbox, notify parent, and set active state of sibling."
2140 (widget-toggle-action widget event)
2141 (let ((sibling (widget-get-sibling widget)))
2143 (if (widget-value widget)
2144 (widget-apply sibling :activate)
2145 (widget-apply sibling :deactivate)))))
2147 ;;; The `checklist' Widget.
2149 (define-widget 'checklist 'default
2150 "A multiple choice widget."
2151 :convert-widget 'widget-types-convert-widget
2154 :entry-format "%b %v"
2155 :menu-tag "checklist"
2157 :value-create 'widget-checklist-value-create
2158 :value-delete 'widget-children-value-delete
2159 :value-get 'widget-checklist-value-get
2160 :validate 'widget-checklist-validate
2161 :match 'widget-checklist-match
2162 :match-inline 'widget-checklist-match-inline)
2164 (defun widget-checklist-value-create (widget)
2165 ;; Insert all values
2166 (let ((alist (widget-checklist-match-find widget (widget-get widget :value)))
2167 (args (widget-get widget :args)))
2169 (widget-checklist-add-item widget (car args) (assq (car args) alist))
2170 (setq args (cdr args)))
2171 (widget-put widget :children (nreverse (widget-get widget :children)))))
2173 (defun widget-checklist-add-item (widget type chosen)
2174 ;; Create checklist item in WIDGET of type TYPE.
2175 ;; If the item is checked, CHOSEN is a cons whose cdr is the value.
2176 (and (eq (preceding-char) ?\n)
2177 (widget-get widget :indent)
2178 (insert-char ? (widget-get widget :indent)))
2179 (widget-specify-insert
2180 (let* ((children (widget-get widget :children))
2181 (buttons (widget-get widget :buttons))
2182 (button-args (or (widget-get type :sibling-args)
2183 (widget-get widget :button-args)))
2186 (insert (widget-get widget :entry-format))
2188 ;; Parse % escapes in format.
2189 (while (re-search-forward "%\\([bv%]\\)" nil t)
2190 (let ((escape (aref (match-string 1) 0)))
2191 (replace-match "" t t)
2192 (cond ((eq escape ?%)
2195 (setq button (apply 'widget-create-child-and-convert
2197 :value (not (null chosen))
2202 (let ((child (widget-create-child widget type)))
2203 (widget-apply child :deactivate)
2205 ((widget-get type :inline)
2206 (widget-create-child-value
2207 widget type (cdr chosen)))
2209 (widget-create-child-value
2210 widget type (car (cdr chosen)))))))
2212 (error "Unknown escape `%c'" escape)))))
2213 ;; Update properties.
2214 (and button child (widget-put child :button button))
2215 (and button (widget-put widget :buttons (cons button buttons)))
2216 (and child (widget-put widget :children (cons child children))))))
2218 (defun widget-checklist-match (widget values)
2219 ;; All values must match a type in the checklist.
2221 (null (cdr (widget-checklist-match-inline widget values)))))
2223 (defun widget-checklist-match-inline (widget values)
2224 ;; Find the values which match a type in the checklist.
2225 (let ((greedy (widget-get widget :greedy))
2226 (args (copy-sequence (widget-get widget :args)))
2229 (let ((answer (widget-checklist-match-up args values)))
2231 (let ((vals (widget-match-inline answer values)))
2232 (setq found (append found (car vals))
2234 args (delq answer args))))
2236 (setq rest (append rest (list (car values)))
2237 values (cdr values)))
2239 (setq rest (append rest values)
2243 (defun widget-checklist-match-find (widget vals)
2244 ;; Find the vals which match a type in the checklist.
2245 ;; Return an alist of (TYPE MATCH).
2246 (let ((greedy (widget-get widget :greedy))
2247 (args (copy-sequence (widget-get widget :args)))
2250 (let ((answer (widget-checklist-match-up args vals)))
2252 (let ((match (widget-match-inline answer vals)))
2253 (setq found (cons (cons answer (car match)) found)
2255 args (delq answer args))))
2257 (setq vals (cdr vals)))
2262 (defun widget-checklist-match-up (args vals)
2263 ;; Rerturn the first type from ARGS that matches VALS.
2264 (let (current found)
2265 (while (and args (null found))
2266 (setq current (car args)
2268 found (widget-match-inline current vals)))
2273 (defun widget-checklist-value-get (widget)
2274 ;; The values of all selected items.
2275 (let ((children (widget-get widget :children))
2278 (setq child (car children)
2279 children (cdr children))
2280 (if (widget-value (widget-get child :button))
2281 (setq result (append result (widget-apply child :value-inline)))))
2284 (defun widget-checklist-validate (widget)
2285 ;; Ticked chilren must be valid.
2286 (let ((children (widget-get widget :children))
2288 (while (and children (not found))
2289 (setq child (car children)
2290 children (cdr children)
2291 button (widget-get child :button)
2292 found (and (widget-value button)
2293 (widget-apply child :validate))))
2296 ;;; The `option' Widget
2298 (define-widget 'option 'checklist
2299 "An widget with an optional item."
2302 ;;; The `choice-item' Widget.
2304 (define-widget 'choice-item 'item
2305 "Button items that delegate action events to their parents."
2306 :action 'widget-parent-action
2307 :format "%[%t%] \n")
2309 ;;; The `radio-button' Widget.
2311 (define-widget 'radio-button 'toggle
2312 "A radio button for use in the `radio' widget."
2313 :notify 'widget-radio-button-notify
2320 :off-glyph "radio0")
2322 (defun widget-radio-button-notify (widget child &optional event)
2324 (widget-apply (widget-get widget :parent) :action widget event))
2326 ;;; The `radio-button-choice' Widget.
2328 (define-widget 'radio-button-choice 'default
2329 "Select one of multiple options."
2330 :convert-widget 'widget-types-convert-widget
2333 :entry-format "%b %v"
2335 :value-create 'widget-radio-value-create
2336 :value-delete 'widget-children-value-delete
2337 :value-get 'widget-radio-value-get
2338 :value-inline 'widget-radio-value-inline
2339 :value-set 'widget-radio-value-set
2340 :error "You must push one of the buttons"
2341 :validate 'widget-radio-validate
2342 :match 'widget-choice-match
2343 :match-inline 'widget-choice-match-inline
2344 :action 'widget-radio-action)
2346 (defun widget-radio-value-create (widget)
2347 ;; Insert all values
2348 (let ((args (widget-get widget :args))
2351 (setq arg (car args)
2353 (widget-radio-add-item widget arg))))
2355 (defun widget-radio-add-item (widget type)
2356 "Add to radio widget WIDGET a new radio button item of type TYPE."
2357 ;; (setq type (widget-convert type))
2358 (and (eq (preceding-char) ?\n)
2359 (widget-get widget :indent)
2360 (insert-char ? (widget-get widget :indent)))
2361 (widget-specify-insert
2362 (let* ((value (widget-get widget :value))
2363 (children (widget-get widget :children))
2364 (buttons (widget-get widget :buttons))
2365 (button-args (or (widget-get type :sibling-args)
2366 (widget-get widget :button-args)))
2368 (chosen (and (null (widget-get widget :choice))
2369 (widget-apply type :match value)))
2371 (insert (widget-get widget :entry-format))
2373 ;; Parse % escapes in format.
2374 (while (re-search-forward "%\\([bv%]\\)" nil t)
2375 (let ((escape (aref (match-string 1) 0)))
2376 (replace-match "" t t)
2377 (cond ((eq escape ?%)
2380 (setq button (apply 'widget-create-child-and-convert
2381 widget 'radio-button
2382 :value (not (null chosen))
2385 (setq child (if chosen
2386 (widget-create-child-value
2388 (widget-create-child widget type)))
2390 (widget-apply child :deactivate)))
2392 (error "Unknown escape `%c'" escape)))))
2393 ;; Update properties.
2395 (widget-put widget :choice type))
2397 (widget-put child :button button)
2398 (widget-put widget :buttons (nconc buttons (list button))))
2400 (widget-put widget :children (nconc children (list child))))
2403 (defun widget-radio-value-get (widget)
2404 ;; Get value of the child widget.
2405 (let ((chosen (widget-radio-chosen widget)))
2406 (and chosen (widget-value chosen))))
2408 (defun widget-radio-chosen (widget)
2409 "Return the widget representing the chosen radio button."
2410 (let ((children (widget-get widget :children))
2413 (setq current (car children)
2414 children (cdr children))
2415 (let* ((button (widget-get current :button))
2416 (value (widget-apply button :value-get)))
2422 (defun widget-radio-value-inline (widget)
2423 ;; Get value of the child widget.
2424 (let ((children (widget-get widget :children))
2427 (setq current (car children)
2428 children (cdr children))
2429 (let* ((button (widget-get current :button))
2430 (value (widget-apply button :value-get)))
2432 (setq found (widget-apply current :value-inline)
2436 (defun widget-radio-value-set (widget value)
2437 ;; We can't just delete and recreate a radio widget, since children
2438 ;; can be added after the original creation and won't be recreated
2440 (let ((children (widget-get widget :children))
2443 (setq current (car children)
2444 children (cdr children))
2445 (let* ((button (widget-get current :button))
2446 (match (and (not found)
2447 (widget-apply current :match value))))
2448 (widget-value-set button match)
2451 (widget-value-set current value)
2452 (widget-apply current :activate))
2453 (widget-apply current :deactivate))
2454 (setq found (or found match))))))
2456 (defun widget-radio-validate (widget)
2457 ;; Valid if we have made a valid choice.
2458 (let ((children (widget-get widget :children))
2459 current found button)
2460 (while (and children (not found))
2461 (setq current (car children)
2462 children (cdr children)
2463 button (widget-get current :button)
2464 found (widget-apply button :value-get)))
2466 (widget-apply current :validate)
2469 (defun widget-radio-action (widget child event)
2470 ;; Check if a radio button was pressed.
2471 (let ((children (widget-get widget :children))
2472 (buttons (widget-get widget :buttons))
2474 (when (memq child buttons)
2476 (setq current (car children)
2477 children (cdr children))
2478 (let* ((button (widget-get current :button)))
2479 (cond ((eq child button)
2480 (widget-value-set button t)
2481 (widget-apply current :activate))
2482 ((widget-value button)
2483 (widget-value-set button nil)
2484 (widget-apply current :deactivate)))))))
2485 ;; Pass notification to parent.
2486 (widget-apply widget :notify child event))
2488 ;;; The `insert-button' Widget.
2490 (define-widget 'insert-button 'push-button
2491 "An insert button for the `editable-list' widget."
2493 :help-echo "Insert a new item into the list at this position."
2494 :action 'widget-insert-button-action)
2496 (defun widget-insert-button-action (widget &optional event)
2497 ;; Ask the parent to insert a new item.
2498 (widget-apply (widget-get widget :parent)
2499 :insert-before (widget-get widget :widget)))
2501 ;;; The `delete-button' Widget.
2503 (define-widget 'delete-button 'push-button
2504 "A delete button for the `editable-list' widget."
2506 :help-echo "Delete this item from the list."
2507 :action 'widget-delete-button-action)
2509 (defun widget-delete-button-action (widget &optional event)
2510 ;; Ask the parent to insert a new item.
2511 (widget-apply (widget-get widget :parent)
2512 :delete-at (widget-get widget :widget)))
2514 ;;; The `editable-list' Widget.
2516 (defcustom widget-editable-list-gui nil
2517 "If non nil, use GUI push-buttons in editable list when available."
2521 (define-widget 'editable-list 'default
2522 "A variable list of widgets of the same type."
2523 :convert-widget 'widget-types-convert-widget
2526 :format-handler 'widget-editable-list-format-handler
2527 :entry-format "%i %d %v"
2528 :menu-tag "editable-list"
2529 :value-create 'widget-editable-list-value-create
2530 :value-delete 'widget-children-value-delete
2531 :value-get 'widget-editable-list-value-get
2532 :validate 'widget-children-validate
2533 :match 'widget-editable-list-match
2534 :match-inline 'widget-editable-list-match-inline
2535 :insert-before 'widget-editable-list-insert-before
2536 :delete-at 'widget-editable-list-delete-at)
2538 (defun widget-editable-list-format-handler (widget escape)
2539 ;; We recognize the insert button.
2540 (let ((widget-push-button-gui widget-editable-list-gui))
2541 (cond ((eq escape ?i)
2542 (and (widget-get widget :indent)
2543 (insert-char ? (widget-get widget :indent)))
2544 (apply 'widget-create-child-and-convert
2545 widget 'insert-button
2546 (widget-get widget :append-button-args)))
2548 (widget-default-format-handler widget escape)))))
2550 (defun widget-editable-list-value-create (widget)
2551 ;; Insert all values
2552 (let* ((value (widget-get widget :value))
2553 (type (nth 0 (widget-get widget :args)))
2554 (inlinep (widget-get type :inline))
2556 (widget-put widget :value-pos (copy-marker (point)))
2557 (set-marker-insertion-type (widget-get widget :value-pos) t)
2559 (let ((answer (widget-match-inline type value)))
2561 (setq children (cons (widget-editable-list-entry-create
2570 (widget-put widget :children (nreverse children))))
2572 (defun widget-editable-list-value-get (widget)
2573 ;; Get value of the child widget.
2574 (apply 'append (mapcar (lambda (child) (widget-apply child :value-inline))
2575 (widget-get widget :children))))
2577 (defun widget-editable-list-match (widget value)
2578 ;; Value must be a list and all the members must match the type.
2580 (null (cdr (widget-editable-list-match-inline widget value)))))
2582 (defun widget-editable-list-match-inline (widget value)
2583 (let ((type (nth 0 (widget-get widget :args)))
2586 (while (and value ok)
2587 (let ((answer (widget-match-inline type value)))
2589 (setq found (append found (car answer))
2592 (cons found value)))
2594 (defun widget-editable-list-insert-before (widget before)
2595 ;; Insert a new child in the list of children.
2597 (let ((children (widget-get widget :children))
2598 (inhibit-read-only t)
2599 before-change-functions
2600 after-change-functions)
2602 (goto-char (widget-get before :entry-from)))
2604 (goto-char (widget-get widget :value-pos))))
2605 (let ((child (widget-editable-list-entry-create
2607 (when (< (widget-get child :entry-from) (widget-get widget :from))
2608 (set-marker (widget-get widget :from)
2609 (widget-get child :entry-from)))
2610 (if (eq (car children) before)
2611 (widget-put widget :children (cons child children))
2612 (while (not (eq (car (cdr children)) before))
2613 (setq children (cdr children)))
2614 (setcdr children (cons child (cdr children)))))))
2616 (widget-apply widget :notify widget))
2618 (defun widget-editable-list-delete-at (widget child)
2619 ;; Delete child from list of children.
2621 (let ((buttons (copy-sequence (widget-get widget :buttons)))
2623 (inhibit-read-only t)
2624 before-change-functions
2625 after-change-functions)
2627 (setq button (car buttons)
2628 buttons (cdr buttons))
2629 (when (eq (widget-get button :widget) child)
2631 :buttons (delq button (widget-get widget :buttons)))
2632 (widget-delete button))))
2633 (let ((entry-from (widget-get child :entry-from))
2634 (entry-to (widget-get child :entry-to))
2635 (inhibit-read-only t)
2636 before-change-functions
2637 after-change-functions)
2638 (widget-delete child)
2639 (delete-region entry-from entry-to)
2640 (set-marker entry-from nil)
2641 (set-marker entry-to nil))
2642 (widget-put widget :children (delq child (widget-get widget :children))))
2644 (widget-apply widget :notify widget))
2646 (defun widget-editable-list-entry-create (widget value conv)
2647 ;; Create a new entry to the list.
2648 (let ((type (nth 0 (widget-get widget :args)))
2649 (widget-push-button-gui widget-editable-list-gui)
2650 child delete insert)
2651 (widget-specify-insert
2653 (and (widget-get widget :indent)
2654 (insert-char ? (widget-get widget :indent)))
2655 (insert (widget-get widget :entry-format)))
2656 ;; Parse % escapes in format.
2657 (while (re-search-forward "%\\(.\\)" nil t)
2658 (let ((escape (aref (match-string 1) 0)))
2659 (replace-match "" t t)
2660 (cond ((eq escape ?%)
2663 (setq insert (apply 'widget-create-child-and-convert
2664 widget 'insert-button
2665 (widget-get widget :insert-button-args))))
2667 (setq delete (apply 'widget-create-child-and-convert
2668 widget 'delete-button
2669 (widget-get widget :delete-button-args))))
2672 (setq child (widget-create-child-value
2674 (setq child (widget-create-child-value
2676 (widget-apply type :value-to-external
2677 (widget-default-get type))))))
2679 (error "Unknown escape `%c'" escape)))))
2681 :buttons (cons delete
2683 (widget-get widget :buttons))))
2684 (let ((entry-from (copy-marker (point-min)))
2685 (entry-to (copy-marker (point-max))))
2686 (set-marker-insertion-type entry-from t)
2687 (set-marker-insertion-type entry-to nil)
2688 (widget-put child :entry-from entry-from)
2689 (widget-put child :entry-to entry-to)))
2690 (widget-put insert :widget child)
2691 (widget-put delete :widget child)
2694 ;;; The `group' Widget.
2696 (define-widget 'group 'default
2697 "A widget which group other widgets inside."
2698 :convert-widget 'widget-types-convert-widget
2700 :value-create 'widget-group-value-create
2701 :value-delete 'widget-children-value-delete
2702 :value-get 'widget-editable-list-value-get
2703 :default-get 'widget-group-default-get
2704 :validate 'widget-children-validate
2705 :match 'widget-group-match
2706 :match-inline 'widget-group-match-inline)
2708 (defun widget-group-value-create (widget)
2709 ;; Create each component.
2710 (let ((args (widget-get widget :args))
2711 (value (widget-get widget :value))
2712 arg answer children)
2714 (setq arg (car args)
2716 answer (widget-match-inline arg value)
2718 (and (eq (preceding-char) ?\n)
2719 (widget-get widget :indent)
2720 (insert-char ? (widget-get widget :indent)))
2721 (push (cond ((null answer)
2722 (widget-create-child widget arg))
2723 ((widget-get arg :inline)
2724 (widget-create-child-value widget arg (car answer)))
2726 (widget-create-child-value widget arg (car (car answer)))))
2728 (widget-put widget :children (nreverse children))))
2730 (defun widget-group-default-get (widget)
2731 ;; Get the default of the components.
2732 (mapcar 'widget-default-get (widget-get widget :args)))
2734 (defun widget-group-match (widget values)
2735 ;; Match if the components match.
2737 (let ((match (widget-group-match-inline widget values)))
2738 (and match (null (cdr match))))))
2740 (defun widget-group-match-inline (widget vals)
2741 ;; Match if the components match.
2742 (let ((args (widget-get widget :args))
2743 argument answer found)
2745 (setq argument (car args)
2747 answer (widget-match-inline argument vals))
2749 (setq vals (cdr answer)
2750 found (append found (car answer)))
2757 ;;; The `visibility' Widget.
2759 (define-widget 'visibility 'item
2760 "An indicator and manipulator for hidden items."
2766 :value-create 'widget-visibility-value-create
2767 :action 'widget-toggle-action
2768 :match (lambda (widget value) t))
2770 (defun widget-visibility-value-create (widget)
2771 ;; Insert text representing the `on' and `off' states.
2772 (let ((on (widget-get widget :on))
2773 (off (widget-get widget :off)))
2775 (setq on (concat widget-push-button-prefix
2777 widget-push-button-suffix))
2780 (setq off (concat widget-push-button-prefix
2782 widget-push-button-suffix))
2784 (if (widget-value widget)
2785 (widget-glyph-insert widget on "down" "down-pushed")
2786 (widget-glyph-insert widget off "right" "right-pushed"))))
2788 ;;; The `documentation-link' Widget.
2790 ;; This is a helper widget for `documentation-string'.
2792 (define-widget 'documentation-link 'link
2793 "Link type used in documentation strings."
2795 :help-echo 'widget-documentation-link-echo-help
2796 :action 'widget-documentation-link-action)
2798 (defun widget-documentation-link-echo-help (widget)
2799 "Tell what this link will describe."
2800 (concat "Describe the `" (widget-get widget :value) "' symbol."))
2802 (defun widget-documentation-link-action (widget &optional event)
2803 "Display documentation for WIDGET's value. Ignore optional argument EVENT."
2804 (let* ((string (widget-get widget :value))
2805 (symbol (intern string)))
2806 (if (and (fboundp symbol) (boundp symbol))
2807 ;; If there are two doc strings, give the user a way to pick one.
2808 (apropos (concat "\\`" (regexp-quote string) "\\'"))
2809 (if (fboundp symbol)
2810 (describe-function symbol)
2811 (describe-variable symbol)))))
2813 (defcustom widget-documentation-links t
2814 "Add hyperlinks to documentation strings when non-nil."
2816 :group 'widget-documentation)
2818 (defcustom widget-documentation-link-regexp "`\\([^\n`' ]+\\)'"
2819 "Regexp for matching potential links in documentation strings.
2820 The first group should be the link itself."
2822 :group 'widget-documentation)
2824 (defcustom widget-documentation-link-p 'intern-soft
2825 "Predicate used to test if a string is useful as a link.
2826 The value should be a function. The function will be called one
2827 argument, a string, and should return non-nil if there should be a
2828 link for that string."
2830 :options '(widget-documentation-link-p)
2831 :group 'widget-documentation)
2833 (defcustom widget-documentation-link-type 'documentation-link
2834 "Widget type used for links in documentation strings."
2836 :group 'widget-documentation)
2838 (defun widget-documentation-link-add (widget from to)
2839 (widget-specify-doc widget from to)
2840 (when widget-documentation-links
2841 (let ((regexp widget-documentation-link-regexp)
2842 (predicate widget-documentation-link-p)
2843 (type widget-documentation-link-type)
2844 (buttons (widget-get widget :buttons)))
2847 (while (re-search-forward regexp to t)
2848 (let ((name (match-string 1))
2849 (begin (match-beginning 1))
2850 (end (match-end 1)))
2851 (when (funcall predicate name)
2852 (push (widget-convert-button type begin end :value name)
2854 (widget-put widget :buttons buttons)))
2855 (let ((indent (widget-get widget :indent)))
2856 (when (and indent (not (zerop indent)))
2859 (narrow-to-region from to)
2860 (goto-char (point-min))
2861 (while (search-forward "\n" nil t)
2862 (insert-char ?\ indent)))))))
2864 ;;; The `documentation-string' Widget.
2866 (define-widget 'documentation-string 'item
2867 "A documentation string."
2869 :action 'widget-documentation-string-action
2870 :value-delete 'widget-children-value-delete
2871 :value-create 'widget-documentation-string-value-create)
2873 (defun widget-documentation-string-value-create (widget)
2874 ;; Insert documentation string.
2875 (let ((doc (widget-value widget))
2876 (indent (widget-get widget :indent))
2877 (shown (widget-get (widget-get widget :parent) :documentation-shown))
2879 (if (string-match "\n" doc)
2880 (let ((before (substring doc 0 (match-beginning 0)))
2881 (after (substring doc (match-beginning 0)))
2884 (widget-documentation-link-add widget start (point))
2885 (push (widget-create-child-and-convert
2887 :help-echo "Show or hide rest of the documentation."
2889 :action 'widget-parent-action
2893 (setq start (point))
2894 (when (and indent (not (zerop indent)))
2895 (insert-char ?\ indent))
2897 (widget-documentation-link-add widget start (point)))
2898 (widget-put widget :buttons buttons))
2900 (widget-documentation-link-add widget start (point))))
2903 (defun widget-documentation-string-action (widget &rest ignore)
2904 ;; Toggle documentation.
2905 (let ((parent (widget-get widget :parent)))
2906 (widget-put parent :documentation-shown
2907 (not (widget-get parent :documentation-shown))))
2909 (widget-value-set widget (widget-value widget)))
2911 ;;; The Sexp Widgets.
2913 (define-widget 'const 'item
2914 "An immutable sexp."
2915 :prompt-value 'widget-const-prompt-value
2918 (defun widget-const-prompt-value (widget prompt value unbound)
2919 ;; Return the value of the const.
2920 (widget-value widget))
2922 (define-widget 'function-item 'const
2923 "An immutable function name."
2925 :documentation-property (lambda (symbol)
2927 (documentation symbol t)
2930 (define-widget 'variable-item 'const
2931 "An immutable variable name."
2933 :documentation-property 'variable-documentation)
2935 (define-widget 'other 'sexp
2936 "Matches any value, but doesn't let the user edit the value.
2937 This is useful as last item in a `choice' widget.
2938 You should use this widget type with a default value,
2939 as in (other DEFAULT) or (other :tag \"NAME\" DEFAULT).
2940 If the user selects this alternative, that specifies DEFAULT
2946 (defvar widget-string-prompt-value-history nil
2947 "History of input to `widget-string-prompt-value'.")
2949 (define-widget 'string 'editable-field
2952 :format "%{%t%}: %v"
2953 :complete-function 'ispell-complete-word
2954 :prompt-history 'widget-string-prompt-value-history)
2956 (define-widget 'regexp 'string
2957 "A regular expression."
2958 :match 'widget-regexp-match
2959 :validate 'widget-regexp-validate
2960 ;; Doesn't work well with terminating newline.
2961 ;; :value-face 'widget-single-line-field-face
2964 (defun widget-regexp-match (widget value)
2965 ;; Match valid regexps.
2966 (and (stringp value)
2969 (string-match value ""))
2972 (defun widget-regexp-validate (widget)
2973 "Check that the value of WIDGET is a valid regexp."
2974 (let ((val (widget-value widget)))
2975 (condition-case data
2977 (string-match val ""))
2978 (error (widget-put widget :error (error-message-string data))
2981 (define-widget 'file 'string
2983 It will read a file name from the minibuffer when invoked."
2984 :complete-function 'widget-file-complete
2985 :prompt-value 'widget-file-prompt-value
2986 :format "%{%t%}: %v"
2987 ;; Doesn't work well with terminating newline.
2988 ;; :value-face 'widget-single-line-field-face
2991 (defun widget-file-complete ()
2992 "Perform completion on file name preceding point."
2994 (let* ((end (point))
2995 (beg (save-excursion
2996 (skip-chars-backward "^ ")
2998 (pattern (buffer-substring beg end))
2999 (name-part (file-name-nondirectory pattern))
3000 (directory (file-name-directory pattern))
3001 (completion (file-name-completion name-part directory)))
3002 (cond ((eq completion t))
3004 (message "Can't find completion for \"%s\"" pattern)
3006 ((not (string= name-part completion))
3007 (delete-region beg end)
3008 (insert (expand-file-name completion directory)))
3010 (message "Making completion list...")
3011 (let ((list (file-name-all-completions name-part directory)))
3012 (setq list (sort list 'string<))
3013 (with-output-to-temp-buffer "*Completions*"
3014 (display-completion-list list)))
3015 (message "Making completion list...%s" "done")))))
3017 (defun widget-file-prompt-value (widget prompt value unbound)
3018 ;; Read file from minibuffer.
3019 (abbreviate-file-name
3021 (read-file-name prompt)
3022 (let ((prompt2 (format "%s (default %s) " prompt value))
3023 (dir (file-name-directory value))
3024 (file (file-name-nondirectory value))
3025 (must-match (widget-get widget :must-match)))
3026 (read-file-name prompt2 dir nil must-match file)))))
3028 ;;;(defun widget-file-action (widget &optional event)
3029 ;;; ;; Read a file name from the minibuffer.
3030 ;;; (let* ((value (widget-value widget))
3031 ;;; (dir (file-name-directory value))
3032 ;;; (file (file-name-nondirectory value))
3033 ;;; (menu-tag (widget-apply widget :menu-tag-get))
3034 ;;; (must-match (widget-get widget :must-match))
3035 ;;; (answer (read-file-name (concat menu-tag ": (default `" value "') ")
3036 ;;; dir nil must-match file)))
3037 ;;; (widget-value-set widget (abbreviate-file-name answer))
3039 ;;; (widget-apply widget :notify widget event)))
3041 (define-widget 'directory 'file
3042 "A directory widget.
3043 It will read a directory name from the minibuffer when invoked."
3046 (defvar widget-symbol-prompt-value-history nil
3047 "History of input to `widget-symbol-prompt-value'.")
3049 (define-widget 'symbol 'editable-field
3053 :format "%{%t%}: %v"
3054 :match (lambda (widget value) (symbolp value))
3055 :complete-function 'lisp-complete-symbol
3056 :prompt-internal 'widget-symbol-prompt-internal
3057 :prompt-match 'symbolp
3058 :prompt-history 'widget-symbol-prompt-value-history
3059 :value-to-internal (lambda (widget value)
3063 :value-to-external (lambda (widget value)
3068 (defun widget-symbol-prompt-internal (widget prompt initial history)
3069 ;; Read file from minibuffer.
3070 (let ((answer (completing-read prompt obarray
3071 (widget-get widget :prompt-match)
3072 nil initial history)))
3073 (if (and (stringp answer)
3074 (not (zerop (length answer))))
3076 (error "No value"))))
3078 (defvar widget-function-prompt-value-history nil
3079 "History of input to `widget-function-prompt-value'.")
3081 (define-widget 'function 'sexp
3083 :complete-function 'lisp-complete-symbol
3084 :prompt-value 'widget-field-prompt-value
3085 :prompt-internal 'widget-symbol-prompt-internal
3086 :prompt-match 'fboundp
3087 :prompt-history 'widget-function-prompt-value-history
3088 :action 'widget-field-action
3091 (defvar widget-variable-prompt-value-history nil
3092 "History of input to `widget-variable-prompt-value'.")
3094 (define-widget 'variable 'symbol
3095 ;; Should complete on variables.
3097 :prompt-match 'boundp
3098 :prompt-history 'widget-variable-prompt-value-history
3101 (defvar widget-coding-system-prompt-value-history nil
3102 "History of input to `widget-coding-system-prompt-value'.")
3104 (define-widget 'coding-system 'symbol
3105 "A MULE coding-system."
3106 :format "%{%t%}: %v"
3107 :tag "Coding system"
3108 :prompt-history 'widget-coding-system-prompt-value-history
3109 :prompt-value 'widget-coding-system-prompt-value
3110 :action 'widget-coding-system-action)
3112 (defun widget-coding-system-prompt-value (widget prompt value unbound)
3113 ;; Read coding-system from minibuffer.
3115 (completing-read (format "%s (default %s) " prompt value)
3118 (list (symbol-name sym))
3120 (coding-system-list)))))
3122 (defun widget-coding-system-action (widget &optional event)
3123 ;; Read a file name from the minibuffer.
3125 (widget-coding-system-prompt-value
3127 (widget-apply widget :menu-tag-get)
3128 (widget-value widget)
3130 (widget-value-set widget answer)
3131 (widget-apply widget :notify widget event)
3134 (define-widget 'sexp 'editable-field
3135 "An arbitrary Lisp expression."
3136 :tag "Lisp expression"
3137 :format "%{%t%}: %v"
3139 :validate 'widget-sexp-validate
3140 :match (lambda (widget value) t)
3141 :value-to-internal 'widget-sexp-value-to-internal
3142 :value-to-external (lambda (widget value) (read value))
3143 :prompt-history 'widget-sexp-prompt-value-history
3144 :prompt-value 'widget-sexp-prompt-value)
3146 (defun widget-sexp-value-to-internal (widget value)
3147 ;; Use pp for printer representation.
3148 (let ((pp (if (symbolp value)
3149 (prin1-to-string value)
3150 (pp-to-string value))))
3151 (while (string-match "\n\\'" pp)
3152 (setq pp (substring pp 0 -1)))
3153 (if (or (string-match "\n\\'" pp)
3158 (defun widget-sexp-validate (widget)
3159 ;; Valid if we can read the string and there is no junk left after it.
3161 (let ((buffer (set-buffer (get-buffer-create " *Widget Scratch*"))))
3163 (insert (widget-apply widget :value-get))
3164 (goto-char (point-min))
3165 (condition-case data
3166 (let ((value (read buffer)))
3168 (if (widget-apply widget :match value)
3170 (widget-put widget :error (widget-get widget :type-error))
3173 :error (format "Junk at end of expression: %s"
3174 (buffer-substring (point)
3177 (error (widget-put widget :error (error-message-string data))
3180 (defvar widget-sexp-prompt-value-history nil
3181 "History of input to `widget-sexp-prompt-value'.")
3183 (defun widget-sexp-prompt-value (widget prompt value unbound)
3184 ;; Read an arbitrary sexp.
3185 (let ((found (read-string prompt
3186 (if unbound nil (cons (prin1-to-string value) 0))
3187 (widget-get widget :prompt-history))))
3189 (let ((buffer (set-buffer (get-buffer-create " *Widget Scratch*"))))
3192 (goto-char (point-min))
3193 (let ((answer (read buffer)))
3195 (error "Junk at end of expression: %s"
3196 (buffer-substring (point) (point-max))))
3199 (define-widget 'restricted-sexp 'sexp
3200 "A Lisp expression restricted to values that match.
3201 To use this type, you must define :match or :match-alternatives."
3202 :type-error "The specified value is not valid"
3203 :match 'widget-restricted-sexp-match
3204 :value-to-internal (lambda (widget value)
3205 (if (widget-apply widget :match value)
3206 (prin1-to-string value)
3209 (defun widget-restricted-sexp-match (widget value)
3210 (let ((alternatives (widget-get widget :match-alternatives))
3212 (while (and alternatives (not matched))
3213 (if (cond ((functionp (car alternatives))
3214 (funcall (car alternatives) value))
3215 ((and (consp (car alternatives))
3216 (eq (car (car alternatives)) 'quote))
3217 (eq value (nth 1 (car alternatives)))))
3219 (setq alternatives (cdr alternatives)))
3222 (define-widget 'integer 'restricted-sexp
3226 :type-error "This field should contain an integer"
3227 :match-alternatives '(integerp))
3229 (define-widget 'number 'restricted-sexp
3230 "A floating point number."
3233 :type-error "This field should contain a number"
3234 :match-alternatives '(numberp))
3236 (define-widget 'character 'editable-field
3241 :format "%{%t%}: %v\n"
3242 :valid-regexp "\\`.\\'"
3243 :error "This field should contain a single character"
3244 :value-to-internal (lambda (widget value)
3247 (char-to-string value)))
3248 :value-to-external (lambda (widget value)
3252 :match (lambda (widget value)
3253 (if (fboundp 'characterp)
3257 (define-widget 'list 'group
3260 :format "%{%t%}:\n%v")
3262 (define-widget 'vector 'group
3265 :format "%{%t%}:\n%v"
3266 :match 'widget-vector-match
3267 :value-to-internal (lambda (widget value) (append value nil))
3268 :value-to-external (lambda (widget value) (apply 'vector value)))
3270 (defun widget-vector-match (widget value)
3271 (and (vectorp value)
3272 (widget-group-match widget
3273 (widget-apply widget :value-to-internal value))))
3275 (define-widget 'cons 'group
3278 :format "%{%t%}:\n%v"
3279 :match 'widget-cons-match
3280 :value-to-internal (lambda (widget value)
3281 (list (car value) (cdr value)))
3282 :value-to-external (lambda (widget value)
3283 (cons (nth 0 value) (nth 1 value))))
3285 (defun widget-cons-match (widget value)
3287 (widget-group-match widget
3288 (widget-apply widget :value-to-internal value))))
3290 ;;; The `plist' Widget.
3294 (define-widget 'plist 'list
3296 :key-type '(symbol :tag "Key")
3297 :value-type '(sexp :tag "Value")
3298 :convert-widget 'widget-plist-convert-widget
3301 (defvar widget-plist-value-type) ;Dynamic variable
3303 (defun widget-plist-convert-widget (widget)
3304 ;; Handle `:options'.
3305 (let* ((options (widget-get widget :options))
3306 (key-type (widget-get widget :key-type))
3307 (widget-plist-value-type (widget-get widget :value-type))
3308 (other `(editable-list :inline t
3311 ,widget-plist-value-type)))
3313 (list `(checklist :inline t
3315 ,@(mapcar 'widget-plist-convert-option
3319 (widget-put widget :args args)
3322 (defun widget-plist-convert-option (option)
3323 ;; Convert a single plist option.
3324 (let (key-type value-type)
3326 (let ((key (nth 0 option)))
3327 (setq value-type (nth 1 option))
3330 (setq key-type `(const ,key))))
3331 (setq key-type `(const ,option)
3332 value-type widget-plist-value-type))
3333 `(group :format "Key: %v" :inline t ,key-type ,value-type)))
3336 ;;; The `alist' Widget.
3338 ;; Association lists.
3340 (define-widget 'alist 'list
3341 "An association list."
3342 :key-type '(sexp :tag "Key")
3343 :value-type '(sexp :tag "Value")
3344 :convert-widget 'widget-alist-convert-widget
3347 (defvar widget-alist-value-type) ;Dynamic variable
3349 (defun widget-alist-convert-widget (widget)
3350 ;; Handle `:options'.
3351 (let* ((options (widget-get widget :options))
3352 (key-type (widget-get widget :key-type))
3353 (widget-alist-value-type (widget-get widget :value-type))
3354 (other `(editable-list :inline t
3357 ,widget-alist-value-type)))
3359 (list `(checklist :inline t
3361 ,@(mapcar 'widget-alist-convert-option
3365 (widget-put widget :args args)
3368 (defun widget-alist-convert-option (option)
3369 ;; Convert a single alist option.
3370 (let (key-type value-type)
3372 (let ((key (nth 0 option)))
3373 (setq value-type (nth 1 option))
3376 (setq key-type `(const ,key))))
3377 (setq key-type `(const ,option)
3378 value-type widget-alist-value-type))
3379 `(cons :format "Key: %v" ,key-type ,value-type)))
3381 (define-widget 'choice 'menu-choice
3382 "A union of several sexp types."
3384 :format "%{%t%}: %[Value Menu%] %v"
3385 :button-prefix 'widget-push-button-prefix
3386 :button-suffix 'widget-push-button-suffix
3387 :prompt-value 'widget-choice-prompt-value)
3389 (defun widget-choice-prompt-value (widget prompt value unbound)
3391 (let ((args (widget-get widget :args))
3392 (completion-ignore-case (widget-get widget :case-fold))
3393 current choices old)
3394 ;; Find the first arg that match VALUE.
3397 (if (widget-apply (car look) :match value)
3398 (setq old (car look)
3400 (setq look (cdr look)))))
3403 (cond ((= (length args) 0)
3405 ((= (length args) 1)
3407 ((and (= (length args) 2)
3409 (if (eq old (nth 0 args))
3414 (setq current (car args)
3417 (cons (cons (widget-apply current :menu-tag-get)
3420 (let ((val (completing-read prompt choices nil t)))
3422 (let ((try (try-completion val choices)))
3425 (cdr (assoc val choices)))
3428 (widget-prompt-value current prompt nil t)
3431 (define-widget 'radio 'radio-button-choice
3432 "A union of several sexp types."
3434 :format "%{%t%}:\n%v"
3435 :prompt-value 'widget-choice-prompt-value)
3437 (define-widget 'repeat 'editable-list
3438 "A variable length homogeneous list."
3440 :format "%{%t%}:\n%v%i\n")
3442 (define-widget 'set 'checklist
3443 "A list of members from a fixed set."
3445 :format "%{%t%}:\n%v")
3447 (define-widget 'boolean 'toggle
3448 "To be nil or non-nil, that is the question."
3450 :prompt-value 'widget-boolean-prompt-value
3451 :button-prefix 'widget-push-button-prefix
3452 :button-suffix 'widget-push-button-suffix
3453 :format "%{%t%}: %[Toggle%] %v\n"
3457 (defun widget-boolean-prompt-value (widget prompt value unbound)
3458 ;; Toggle a boolean.
3461 ;;; The `color' Widget.
3463 (define-widget 'color 'editable-field
3464 "Choose a color name (with sample)."
3465 :format "%t: %v (%{sample%})\n"
3469 :complete 'widget-color-complete
3470 :sample-face-get 'widget-color-sample-face-get
3471 :notify 'widget-color-notify
3472 :action 'widget-color-action)
3474 (defun widget-color-complete (widget)
3475 "Complete the color in WIDGET."
3476 (let* ((prefix (buffer-substring-no-properties (widget-field-start widget)
3478 (list (widget-color-choice-list))
3479 (completion (try-completion prefix list)))
3480 (cond ((eq completion t)
3481 (message "Exact match."))
3483 (error "Can't find completion for \"%s\"" prefix))
3484 ((not (string-equal prefix completion))
3485 (insert-and-inherit (substring completion (length prefix))))
3487 (message "Making completion list...")
3488 (let ((list (all-completions prefix list nil)))
3489 (with-output-to-temp-buffer "*Completions*"
3490 (display-completion-list list)))
3491 (message "Making completion list...done")))))
3493 (defun widget-color-sample-face-get (widget)
3494 (let* ((value (condition-case nil
3495 (widget-value widget)
3496 (error (widget-get widget :value))))
3497 (symbol (intern (concat "fg:" value))))
3499 (facemenu-get-face symbol)
3502 (defvar widget-color-choice-list nil)
3503 ;; Variable holding the possible colors.
3505 (defun widget-color-choice-list ()
3506 (unless widget-color-choice-list
3507 (setq widget-color-choice-list
3508 (mapcar '(lambda (color) (list color))
3509 (x-defined-colors))))
3510 widget-color-choice-list)
3512 (defvar widget-color-history nil
3513 "History of entered colors")
3515 (defun widget-color-action (widget &optional event)
3516 ;; Prompt for a color.
3517 (let* ((tag (widget-apply widget :menu-tag-get))
3518 (prompt (concat tag ": "))
3519 (value (widget-value widget))
3520 (start (widget-field-start widget))
3521 (pos (cond ((< (point) start)
3523 ((> (point) (+ start (length value)))
3526 (- (point) start))))
3527 (answer (if (commandp 'read-color)
3529 (completing-read (concat tag ": ")
3530 (widget-color-choice-list)
3533 'widget-color-history))))
3534 (unless (zerop (length answer))
3535 (widget-value-set widget answer)
3537 (widget-apply widget :notify widget event))))
3539 (defun widget-color-notify (widget child &optional event)
3540 "Update the sample, and notofy the parent."
3541 (overlay-put (widget-get widget :sample-overlay)
3542 'face (widget-apply widget :sample-face-get))
3543 (widget-default-notify widget child event))
3547 (defun widget-echo-help-mouse ()
3548 "Display the help message for the widget under the mouse.
3549 Enable with (run-with-idle-timer 1 t 'widget-echo-help-mouse)"
3550 (let* ((pos (mouse-position))
3554 (win (window-at x y frame))
3555 (where (coordinates-in-window-p (cons x y) win)))
3557 (save-window-excursion
3558 (progn ; save-excursion
3560 (let* ((result (compute-motion (window-start win)
3565 (cons (window-hscroll) 0)
3567 (when (and (eq (nth 1 result) x)
3568 (eq (nth 2 result) y))
3569 (widget-echo-help (nth 0 result))))))))
3571 (setq track-mouse t)
3572 (add-hook 'post-command-hook 'widget-stop-mouse-tracking)))
3574 (defun widget-stop-mouse-tracking (&rest args)
3575 "Stop the mouse tracking done while idle."
3576 (remove-hook 'post-command-hook 'widget-stop-mouse-tracking)
3577 (setq track-mouse nil))
3579 (defun widget-at (pos)
3580 "The button or field at POS."
3581 (or (get-char-property pos 'button)
3582 (get-char-property pos 'field)))
3584 (defun widget-echo-help (pos)
3585 "Display the help echo for widget at POS."
3586 (let* ((widget (widget-at pos))
3587 (help-echo (and widget (widget-get widget :help-echo))))
3588 (cond ((stringp help-echo)
3589 (message "%s" help-echo))
3590 ((and (symbolp help-echo) (fboundp help-echo)
3591 (stringp (setq help-echo (funcall help-echo widget))))
3592 (message "%s" help-echo)))))
3598 ;; wid-edit.el ends here