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))
39 (autoload 'pp-to-string "pp")
40 (autoload 'Info-goto-node "info")
42 (when (string-match "XEmacs" emacs-version)
45 (error (load-library "x-overlay"))))
47 (if (string-match "XEmacs" emacs-version)
48 (defun widget-event-point (event)
49 "Character position of the end of event if that exists, or nil."
50 (if (mouse-event-p event)
53 (defun widget-event-point (event)
54 "Character position of the end of event if that exists, or nil."
55 (posn-point (event-end event))))
57 (defalias 'widget-read-event (if (string-match "XEmacs" emacs-version)
61 ;; The following should go away when bundled with Emacs.
66 (unless (and (featurep 'custom) (fboundp 'custom-declare-variable))
67 ;; We have the old custom-library, hack around it!
68 (defmacro defgroup (&rest args) nil)
69 (defmacro defcustom (var value doc &rest args)
70 (` (defvar (, var) (, value) (, doc))))
71 (defmacro defface (&rest args) nil)
72 (define-widget-keywords :prefix :tag :load :link :options :type :group)
73 (when (fboundp 'copy-face)
74 (copy-face 'default 'widget-documentation-face)
75 (copy-face 'bold 'widget-button-face)
76 (copy-face 'italic 'widget-field-face)))
78 (unless (fboundp 'button-release-event-p)
79 ;; XEmacs function missing from Emacs.
80 (defun button-release-event-p (event)
81 "Non-nil if EVENT is a mouse-button-release event object."
83 (memq (event-basic-type event) '(mouse-1 mouse-2 mouse-3))
84 (or (memq 'click (event-modifiers event))
85 (memq 'drag (event-modifiers event))))))
87 (unless (fboundp 'error-message-string)
88 ;; Emacs function missing in XEmacs.
89 (defun error-message-string (obj)
90 "Convert an error value to an error message."
91 (let ((buf (get-buffer-create " *error-message*")))
93 (display-error obj buf)
94 (buffer-string buf)))))
96 (when (let ((a "foo"))
97 (put-text-property 1 2 'foo 1 a)
98 (put-text-property 1 2 'bar 2 a)
99 (set-text-properties 1 2 nil a)
100 (text-properties-at 1 a))
101 ;; XEmacs 20.2 and earlier had a buggy set-text-properties.
102 (defun set-text-properties (start end props &optional buffer-or-string)
103 "Completely replace properties of text from START to END.
104 The third argument PROPS is the new property list.
105 The optional fourth argument, BUFFER-OR-STRING,
106 is the string or buffer containing the text."
107 (map-extents #'(lambda (extent ignored)
108 (remove-text-properties
110 (list (extent-property extent 'text-prop)
114 buffer-or-string start end nil nil 'text-prop)
115 (add-text-properties start end props buffer-or-string)))
119 (defgroup widgets nil
120 "Customization support for the Widget Library."
121 :link '(custom-manual "(widget)Top")
122 :link '(url-link :tag "Development Page"
123 "http://www.dina.kvl.dk/~abraham/custom/")
129 (defface widget-button-face '((t (:bold t)))
130 "Face used for widget buttons."
133 (defcustom widget-mouse-face 'highlight
134 "Face used for widget buttons when the mouse is above them."
138 (defface widget-field-face '((((class grayscale color)
140 (:background "gray85"))
141 (((class grayscale color)
143 (:background "dim gray"))
146 "Face used for editable fields."
149 ;;; Utility functions.
151 ;; These are not really widget specific.
153 (defsubst widget-plist-member (plist prop)
154 ;; Return non-nil if PLIST has the property PROP.
155 ;; PLIST is a property list, which is a list of the form
156 ;; (PROP1 VALUE1 PROP2 VALUE2 ...). PROP is a symbol.
157 ;; Unlike `plist-get', this allows you to distinguish between a missing
158 ;; property and a property with the value nil.
159 ;; The value is actually the tail of PLIST whose car is PROP.
160 (while (and plist (not (eq (car plist) prop)))
161 (setq plist (cdr (cdr plist))))
164 (defun widget-princ-to-string (object)
165 ;; Return string representation of OBJECT, any Lisp object.
166 ;; No quoting characters are used; no delimiters are printed around
167 ;; the contents of strings.
169 (set-buffer (get-buffer-create " *widget-tmp*"))
171 (let ((standard-output (current-buffer)))
175 (defun widget-clear-undo ()
176 "Clear all undo information."
177 (buffer-disable-undo (current-buffer))
178 (buffer-enable-undo))
180 (defcustom widget-menu-max-size 40
181 "Largest number of items allowed in a popup-menu.
182 Larger menus are read through the minibuffer."
186 (defun widget-choose (title items &optional event)
187 "Choose an item from a list.
189 First argument TITLE is the name of the list.
190 Second argument ITEMS is an list whose members are either
191 (NAME . VALUE), to indicate selectable items, or just strings to
192 indicate unselectable items.
193 Optional third argument EVENT is an input event.
195 The user is asked to choose between each NAME from the items alist,
196 and the VALUE of the chosen element will be returned. If EVENT is a
197 mouse event, and the number of elements in items is less than
198 `widget-menu-max-size', a popup menu will be used, otherwise the
200 (cond ((and (< (length items) widget-menu-max-size)
201 event (fboundp 'x-popup-menu) window-system)
202 ;; We are in Emacs-19, pressed by the mouse
204 (list title (cons "" items))))
205 ((and (< (length items) widget-menu-max-size)
206 event (fboundp 'popup-menu) window-system)
207 ;; We are in XEmacs, pressed by the mouse
208 (let ((val (get-popup-menu-response
215 (vector (car x) (list (car x)) t))))
218 (listp (event-object val))
219 (stringp (car-safe (event-object val)))
220 (car (event-object val))))
221 (cdr (assoc val items))))
223 (setq items (widget-remove-if 'stringp items))
224 (let ((val (completing-read (concat title ": ") items nil t)))
226 (let ((try (try-completion val items)))
229 (cdr (assoc val items)))
232 (defun widget-remove-if (predictate list)
233 (let (result (tail list))
235 (or (funcall predictate (car tail))
236 (setq result (cons (car tail) result)))
237 (setq tail (cdr tail)))
240 ;;; Widget text specifications.
242 ;; These functions are for specifying text properties.
244 (defun widget-specify-none (from to)
245 ;; Clear all text properties between FROM and TO.
246 (set-text-properties from to nil))
248 (defun widget-specify-text (from to)
249 ;; Default properties.
250 (add-text-properties from to (list 'read-only t
256 (defun widget-specify-field (widget from to)
257 "Specify editable button for WIDGET between FROM and TO."
258 (put-text-property from to 'read-only nil)
259 ;; Terminating space is not part of the field, but necessary in
260 ;; order for local-map to work. Remove next sexp if local-map works
261 ;; at the end of the overlay.
264 (insert-and-inherit " ")
266 (add-text-properties (1- to) to ;to (1+ to)
267 '(front-sticky nil start-open t read-only to))
268 (add-text-properties (1- from) from
269 '(rear-nonsticky t end-open t read-only from))
270 (let ((map (widget-get widget :keymap))
271 (face (or (widget-get widget :value-face) 'widget-field-face))
272 (help-echo (widget-get widget :help-echo))
273 (overlay (make-overlay from to nil nil t)))
274 (unless (or (stringp help-echo) (null help-echo))
275 (setq help-echo 'widget-mouse-help))
276 (widget-put widget :field-overlay overlay)
277 (overlay-put overlay 'detachable nil)
278 (overlay-put overlay 'field widget)
279 (overlay-put overlay 'local-map map)
280 (overlay-put overlay 'keymap map)
281 (overlay-put overlay 'face face)
282 (overlay-put overlay 'balloon-help help-echo)
283 (overlay-put overlay 'help-echo help-echo)))
285 (defun widget-specify-button (widget from to)
286 "Specify button for WIDGET between FROM and TO."
287 (let ((face (widget-apply widget :button-face-get))
288 (help-echo (widget-get widget :help-echo))
289 (overlay (make-overlay from to nil t nil)))
290 (widget-put widget :button-overlay overlay)
291 (unless (or (null help-echo) (stringp help-echo))
292 (setq help-echo 'widget-mouse-help))
293 (overlay-put overlay 'button widget)
294 (overlay-put overlay 'mouse-face widget-mouse-face)
295 (overlay-put overlay 'balloon-help help-echo)
296 (overlay-put overlay 'help-echo help-echo)
297 (overlay-put overlay 'face face)))
299 (defun widget-mouse-help (extent)
300 "Find mouse help string for button in extent."
301 (let* ((widget (widget-at (extent-start-position extent)))
302 (help-echo (and widget (widget-get widget :help-echo))))
303 (cond ((stringp help-echo)
305 ((and (symbolp help-echo) (fboundp help-echo)
306 (stringp (setq help-echo (funcall help-echo widget))))
309 (format "(widget %S :help-echo %S)" widget help-echo)))))
311 (defun widget-specify-sample (widget from to)
312 ;; Specify sample for WIDGET between FROM and TO.
313 (let ((face (widget-apply widget :sample-face-get)))
315 (add-text-properties from to (list 'start-open t
319 (defun widget-specify-doc (widget from to)
320 ;; Specify documentation for WIDGET between FROM and TO.
321 (add-text-properties from to (list 'widget-doc widget
322 'face 'widget-documentation-face)))
324 (defmacro widget-specify-insert (&rest form)
325 ;; Execute FORM without inheriting any text properties.
328 (let ((inhibit-read-only t)
330 after-change-functions)
332 (narrow-to-region (- (point) 2) (point))
333 (widget-specify-none (point-min) (point-max))
334 (goto-char (1+ (point-min)))
335 (setq result (progn (,@ form)))
336 (delete-region (point-min) (1+ (point-min)))
337 (delete-region (1- (point-max)) (point-max))
338 (goto-char (point-max))
341 (defface widget-inactive-face '((((class grayscale color)
343 (:foreground "light gray"))
344 (((class grayscale color)
346 (:foreground "dark gray"))
349 "Face used for inactive widgets."
352 (defun widget-specify-inactive (widget from to)
353 "Make WIDGET inactive for user modifications."
354 (unless (widget-get widget :inactive)
355 (let ((overlay (make-overlay from to nil t nil)))
356 (overlay-put overlay 'face 'widget-inactive-face)
357 (overlay-put overlay 'mouse-face 'widget-inactive-face)
358 (overlay-put overlay 'evaporate t)
359 (overlay-put overlay 'priority 100)
360 (overlay-put overlay (if (string-match "XEmacs" emacs-version)
362 'modification-hooks) '(widget-overlay-inactive))
363 (widget-put widget :inactive overlay))))
365 (defun widget-overlay-inactive (&rest junk)
366 "Ignoring the arguments, signal an error."
367 (unless inhibit-read-only
368 (error "Attempt to modify inactive widget")))
371 (defun widget-specify-active (widget)
372 "Make WIDGET active for user modifications."
373 (let ((inactive (widget-get widget :inactive)))
375 (delete-overlay inactive)
376 (widget-put widget :inactive nil))))
378 ;;; Widget Properties.
380 (defsubst widget-type (widget)
381 "Return the type of WIDGET, a symbol."
384 (defun widget-put (widget property value)
385 "In WIDGET set PROPERTY to VALUE.
386 The value can later be retrived with `widget-get'."
387 (setcdr widget (plist-put (cdr widget) property value)))
389 (defun widget-get (widget property)
390 "In WIDGET, get the value of PROPERTY.
391 The value could either be specified when the widget was created, or
392 later with `widget-put'."
396 (cond ((setq tmp (widget-plist-member (cdr widget) property))
397 (setq value (car (cdr tmp))
399 ((setq tmp (car widget))
400 (setq widget (get tmp 'widget-type)))
402 (setq missing nil))))
405 (defun widget-member (widget property)
406 "Non-nil iff there is a definition in WIDGET for PROPERTY."
407 (cond ((widget-plist-member (cdr widget) property)
410 (widget-member (get (car widget) 'widget-type) property))
414 (defun widget-apply (widget property &rest args)
415 "Apply the value of WIDGET's PROPERTY to the widget itself.
416 ARGS are passed as extra arguments to the function."
417 (apply (widget-get widget property) widget args))
419 (defun widget-value (widget)
420 "Extract the current value of WIDGET."
422 :value-to-external (widget-apply widget :value-get)))
424 (defun widget-value-set (widget value)
425 "Set the current value of WIDGET to VALUE."
427 :value-set (widget-apply widget
428 :value-to-internal value)))
430 (defun widget-match-inline (widget vals)
431 ;; In WIDGET, match the start of VALS.
432 (cond ((widget-get widget :inline)
433 (widget-apply widget :match-inline vals))
435 (widget-apply widget :match (car vals)))
436 (cons (list (car vals)) (cdr vals)))
439 (defun widget-apply-action (widget &optional event)
440 "Apply :action in WIDGET in response to EVENT."
441 (let (after-change-functions)
442 (if (widget-apply widget :active)
443 (widget-apply widget :action event)
444 (error "Attempt to perform action on inactive widget"))))
446 ;;; Helper functions.
448 ;; These are widget specific.
451 (defun widget-prompt-value (widget prompt &optional value unbound)
452 "Prompt for a value matching WIDGET, using PROMPT.
453 The current value is assumed to be VALUE, unless UNBOUND is non-nil."
454 (unless (listp widget)
455 (setq widget (list widget)))
456 (setq prompt (format "[%s] %s" (widget-type widget) prompt))
457 (setq widget (widget-convert widget))
458 (let ((answer (widget-apply widget :prompt-value prompt value unbound)))
459 (unless (widget-apply widget :match answer)
460 (error "Value does not match %S type." (car widget)))
463 (defun widget-get-sibling (widget)
464 "Get the item WIDGET is assumed to toggle.
465 This is only meaningful for radio buttons or checkboxes in a list."
466 (let* ((parent (widget-get widget :parent))
467 (children (widget-get parent :children))
471 (setq child (car children)
472 children (cdr children))
473 (when (eq (widget-get child :button) widget)
474 (throw 'child child)))
479 (defcustom widget-glyph-directory (concat data-directory "custom/")
480 "Where widget glyphs are located.
481 If this variable is nil, widget will try to locate the directory
486 (defcustom widget-glyph-enable t
487 "If non nil, use glyphs in images when available."
491 (defcustom widget-image-conversion
492 '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg")
494 "Conversion alist from image formats to file name suffixes."
496 :type '(repeat (cons :format "%v"
497 (symbol :tag "Image Format" unknown)
498 (repeat :tag "Suffixes"
499 (string :format "%v")))))
501 (defun widget-glyph-find (image tag)
502 "Create a glyph corresponding to IMAGE with string TAG as fallback.
503 IMAGE should either already be a glyph, or be a file name sans
504 extension (xpm, xbm, gif, jpg, or png) located in
505 `widget-glyph-directory'."
506 (cond ((not (and image
507 (string-match "XEmacs" emacs-version)
509 (fboundp 'make-glyph)
510 (fboundp 'locate-file)
512 ;; We don't want or can't use glyphs.
514 ((and (fboundp 'glyphp)
516 ;; Already a glyph. Use it.
519 ;; A string. Look it up in relevant directories.
520 (let* ((dirlist (list (or widget-glyph-directory
521 (concat data-directory
524 (formats widget-image-conversion)
526 (while (and formats (not file))
527 (when (valid-image-instantiator-format-p (car (car formats)))
528 (setq file (locate-file image dirlist
533 (setq formats (cdr formats))))
535 ;; We create a glyph with the file as the default image
536 ;; instantiator, and the TAG fallback
537 (make-glyph (list (vector (car (car formats)) ':file file)
538 (vector 'string ':data tag))))))
539 ((valid-instantiator-p image 'image)
540 ;; A valid image instantiator (e.g. [gif :file "somefile"] etc.)
541 (make-glyph (list image
542 (vector 'string ':data tag))))
544 ;; This could be virtually anything. Let `make-glyph' sort it out.
550 (defun widget-glyph-insert (widget tag image &optional down inactive)
551 "In WIDGET, insert the text TAG or, if supported, IMAGE.
552 IMAGE should either be a glyph, an image instantiator, or an image file
553 name sans extension (xpm, xbm, gif, jpg, or png) located in
554 `widget-glyph-directory'.
556 Optional arguments DOWN and INACTIVE is used instead of IMAGE when the
557 glyph is pressed or inactive, respectively.
559 WARNING: If you call this with a glyph, and you want the user to be
560 able to invoke the glyph, make sure it is unique. If you use the
561 same glyph for multiple widgets, invoking any of the glyphs will
562 cause the last created widget to be invoked.
564 Instead of an instantiator, you can also use a list of instantiators,
565 or whatever `make-glyph' will accept. However, in that case you must
566 provide the fallback TAG as a part of the instantiator yourself."
567 (let ((glyph (widget-glyph-find image tag)))
569 (widget-glyph-insert-glyph widget
571 (widget-glyph-find down tag)
572 (widget-glyph-find inactive tag))
575 (defun widget-glyph-insert-glyph (widget glyph &optional down inactive)
576 "In WIDGET, insert GLYPH.
577 If optional arguments DOWN and INACTIVE are given, they should be
578 glyphs used when the widget is pushed and inactive, respectively."
579 (set-glyph-property glyph 'widget widget)
581 (set-glyph-property down 'widget widget))
583 (set-glyph-property inactive 'widget widget))
585 (let ((ext (make-extent (point) (1- (point))))
586 (help-echo (widget-get widget :help-echo)))
587 (set-extent-property ext 'invisible t)
588 (set-extent-end-glyph ext glyph)
590 (set-extent-property ext 'balloon-help help-echo)
591 (set-extent-property ext 'help-echo help-echo)))
592 (widget-put widget :glyph-up glyph)
593 (when down (widget-put widget :glyph-down down))
594 (when inactive (widget-put widget :glyph-inactive inactive)))
598 (defgroup widget-button nil
599 "The look of various kinds of buttons."
602 (defcustom widget-button-prefix ""
603 "String used as prefix for buttons."
605 :group 'widget-button)
607 (defcustom widget-button-suffix ""
608 "String used as suffix for buttons."
610 :group 'widget-button)
612 (defun widget-button-insert-indirect (widget key)
613 "Insert value of WIDGET's KEY property."
614 (let ((val (widget-get widget key)))
615 (while (and val (symbolp val))
616 (setq val (symbol-value val)))
620 ;;; Creating Widgets.
623 (defun widget-create (type &rest args)
624 "Create widget of TYPE.
625 The optional ARGS are additional keyword arguments."
626 (let ((widget (apply 'widget-convert type args)))
627 (widget-apply widget :create)
630 (defun widget-create-child-and-convert (parent type &rest args)
631 "As part of the widget PARENT, create a child widget TYPE.
632 The child is converted, using the keyword arguments ARGS."
633 (let ((widget (apply 'widget-convert type args)))
634 (widget-put widget :parent parent)
635 (unless (widget-get widget :indent)
636 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
637 (or (widget-get widget :extra-offset) 0)
638 (widget-get parent :offset))))
639 (widget-apply widget :create)
642 (defun widget-create-child (parent type)
643 "Create widget of TYPE."
644 (let ((widget (copy-sequence type)))
645 (widget-put widget :parent parent)
646 (unless (widget-get widget :indent)
647 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
648 (or (widget-get widget :extra-offset) 0)
649 (widget-get parent :offset))))
650 (widget-apply widget :create)
653 (defun widget-create-child-value (parent type value)
654 "Create widget of TYPE with value VALUE."
655 (let ((widget (copy-sequence type)))
656 (widget-put widget :value (widget-apply widget :value-to-internal value))
657 (widget-put widget :parent parent)
658 (unless (widget-get widget :indent)
659 (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
660 (or (widget-get widget :extra-offset) 0)
661 (widget-get parent :offset))))
662 (widget-apply widget :create)
666 (defun widget-delete (widget)
668 (widget-apply widget :delete))
670 (defun widget-convert (type &rest args)
671 "Convert TYPE to a widget without inserting it in the buffer.
672 The optional ARGS are additional keyword arguments."
673 ;; Don't touch the type.
674 (let* ((widget (if (symbolp type)
676 (copy-sequence type)))
679 ;; First set the :args keyword.
680 (while (cdr current) ;Look in the type.
681 (let ((next (car (cdr current))))
682 (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
683 (setq current (cdr (cdr current)))
684 (setcdr current (list :args (cdr current)))
685 (setq current nil))))
686 (while args ;Look in the args.
687 (let ((next (nth 0 args)))
688 (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
689 (setq args (nthcdr 2 args))
690 (widget-put widget :args args)
692 ;; Then Convert the widget.
695 (let ((convert-widget (plist-get (cdr type) :convert-widget)))
697 (setq widget (funcall convert-widget widget))))
698 (setq type (get (car type) 'widget-type)))
699 ;; Finally set the keyword args.
701 (let ((next (nth 0 keys)))
702 (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
704 (widget-put widget next (nth 1 keys))
705 (setq keys (nthcdr 2 keys)))
707 ;; Convert the :value to internal format.
708 (if (widget-member widget :value)
709 (let ((value (widget-get widget :value)))
711 :value (widget-apply widget :value-to-internal value))))
712 ;; Return the newly create widget.
715 (defun widget-insert (&rest args)
716 "Call `insert' with ARGS and make the text read only."
717 (let ((inhibit-read-only t)
718 after-change-functions
721 (widget-specify-text from (point))))
723 ;;; Keymap and Commands.
725 (defvar widget-keymap nil
726 "Keymap containing useful binding for buffers containing widgets.
727 Recommended as a parent keymap for modes using widgets.")
729 (unless widget-keymap
730 (setq widget-keymap (make-sparse-keymap))
731 (define-key widget-keymap "\t" 'widget-forward)
732 (define-key widget-keymap [(shift tab)] 'widget-backward)
733 (define-key widget-keymap [backtab] 'widget-backward)
734 (if (string-match "XEmacs" emacs-version)
737 (define-key widget-keymap [button1] 'widget-button1-click)
738 (define-key widget-keymap [button2] 'widget-button-click))
739 (define-key widget-keymap [down-mouse-2] 'widget-button-click))
740 (define-key widget-keymap "\C-m" 'widget-button-press))
742 (defvar widget-global-map global-map
743 "Keymap used for events the widget does not handle themselves.")
744 (make-variable-buffer-local 'widget-global-map)
746 (defvar widget-field-keymap nil
747 "Keymap used inside an editable field.")
749 (unless widget-field-keymap
750 (setq widget-field-keymap (copy-keymap widget-keymap))
751 (unless (string-match "XEmacs" (emacs-version))
752 (define-key widget-field-keymap [menu-bar] 'nil))
753 (define-key widget-field-keymap "\C-k" 'widget-kill-line)
754 (define-key widget-field-keymap "\M-\t" 'widget-complete)
755 (define-key widget-field-keymap "\C-m" 'widget-field-activate)
756 (define-key widget-field-keymap "\C-a" 'widget-beginning-of-line)
757 (define-key widget-field-keymap "\C-e" 'widget-end-of-line)
758 (set-keymap-parent widget-field-keymap global-map))
760 (defvar widget-text-keymap nil
761 "Keymap used inside a text field.")
763 (unless widget-text-keymap
764 (setq widget-text-keymap (copy-keymap widget-keymap))
765 (unless (string-match "XEmacs" (emacs-version))
766 (define-key widget-text-keymap [menu-bar] 'nil))
767 (define-key widget-text-keymap "\C-a" 'widget-beginning-of-line)
768 (define-key widget-text-keymap "\C-e" 'widget-end-of-line)
769 (set-keymap-parent widget-text-keymap global-map))
771 (defun widget-field-activate (pos &optional event)
772 "Invoke the ediable field at point."
774 (let ((field (get-char-property pos 'field)))
776 (widget-apply-action field event)
778 (lookup-key widget-global-map (this-command-keys))))))
780 (defface widget-button-pressed-face
784 (:bold t :underline t)))
785 "Face used for pressed buttons."
788 (defun widget-button-click (event)
789 "Invoke button below mouse pointer."
791 (cond ((and (fboundp 'event-glyph)
793 (widget-glyph-click event))
794 ((widget-event-point event)
795 (let* ((pos (widget-event-point event))
796 (button (get-char-property pos 'button)))
798 (let* ((overlay (widget-get button :button-overlay))
799 (face (overlay-get overlay 'face))
800 (mouse-face (overlay-get overlay 'mouse-face)))
802 (let ((track-mouse t))
804 'face 'widget-button-pressed-face)
806 'mouse-face 'widget-button-pressed-face)
807 (unless (widget-apply button :mouse-down-action event)
808 (while (not (button-release-event-p event))
809 (setq event (widget-read-event)
810 pos (widget-event-point event))
812 (eq (get-char-property pos 'button)
817 'widget-button-pressed-face)
820 'widget-button-pressed-face))
821 (overlay-put overlay 'face face)
822 (overlay-put overlay 'mouse-face mouse-face))))
824 (eq (get-char-property pos 'button) button))
825 (widget-apply-action button event)))
826 (overlay-put overlay 'face face)
827 (overlay-put overlay 'mouse-face mouse-face)))
829 ;; Find the global command to run, and check whether it
830 ;; is bound to an up event.
831 (cond ((setq command ;down event
832 (lookup-key widget-global-map [ button2 ])))
833 ((setq command ;down event
834 (lookup-key widget-global-map [ down-mouse-2 ])))
835 ((setq command ;up event
836 (lookup-key widget-global-map [ button2up ]))
838 ((setq command ;up event
839 (lookup-key widget-global-map [ mouse-2]))
842 ;; Don't execute up events twice.
844 (while (not (button-release-event-p event))
845 (setq event (widget-read-event))))
846 (call-interactively command))))))
848 (message "You clicked somewhere weird."))))
850 (defun widget-button1-click (event)
851 "Invoke glyph below mouse pointer."
853 (if (and (fboundp 'event-glyph)
855 (widget-glyph-click event)
856 (call-interactively (lookup-key widget-global-map (this-command-keys)))))
858 (defun widget-glyph-click (event)
859 "Handle click on a glyph."
860 (let* ((glyph (event-glyph event))
861 (widget (glyph-property glyph 'widget))
862 (extent (event-glyph-extent event))
863 (down-glyph (or (and widget (widget-get widget :glyph-down)) glyph))
864 (up-glyph (or (and widget (widget-get widget :glyph-up)) glyph))
866 ;; Wait for the release.
867 (while (not (button-release-event-p last))
868 (if (eq extent (event-glyph-extent last))
869 (set-extent-property extent 'end-glyph down-glyph)
870 (set-extent-property extent 'end-glyph up-glyph))
871 (setq last (next-event event)))
874 (set-extent-property extent 'end-glyph up-glyph))
875 ;; Apply widget action.
876 (when (eq extent (event-glyph-extent last))
877 (let ((widget (glyph-property (event-glyph event) 'widget)))
879 (message "You clicked on a glyph."))
880 ((not (widget-apply widget :active))
881 (message "This glyph is inactive."))
883 (widget-apply-action widget event)))))))
885 (defun widget-button-press (pos &optional event)
886 "Invoke button at POS."
888 (let ((button (get-char-property pos 'button)))
890 (widget-apply-action button event)
891 (let ((command (lookup-key widget-global-map (this-command-keys))))
892 (when (commandp command)
893 (call-interactively command))))))
895 (defun widget-move (arg)
896 "Move point to the ARG next field or button.
897 ARG may be negative to move backward."
898 (or (bobp) (> arg 0) (backward-char))
901 (old (or (get-char-property (point) 'button)
902 (get-char-property (point) 'field)))
907 (goto-char (point-min))
909 (and (eq pos (point))
911 (error "No buttons or fields found"))
912 (let ((new (or (get-char-property (point) 'button)
913 (get-char-property (point) 'field))))
916 (unless (and (widget-get new :tab-order)
917 (< (widget-get new :tab-order) 0))
923 (goto-char (point-max))
925 (and (eq pos (point))
927 (error "No buttons or fields found"))
928 (let ((new (or (get-char-property (point) 'button)
929 (get-char-property (point) 'field))))
932 (unless (and (widget-get new :tab-order)
933 (< (widget-get new :tab-order) 0))
934 (setq arg (1+ arg)))))))
935 (while (or (get-char-property (point) 'button)
936 (get-char-property (point) 'field))
939 (widget-echo-help (point))
940 (run-hooks 'widget-move-hook))
942 (defun widget-forward (arg)
943 "Move point to the next field or button.
944 With optional ARG, move across that many fields."
946 (run-hooks 'widget-forward-hook)
949 (defun widget-backward (arg)
950 "Move point to the previous field or button.
951 With optional ARG, move across that many fields."
953 (run-hooks 'widget-backward-hook)
954 (widget-move (- arg)))
956 (defun widget-beginning-of-line ()
957 "Go to beginning of field or beginning of line, whichever is first."
959 (let* ((field (widget-field-find (point)))
960 (start (and field (widget-field-start field))))
961 (if (and start (not (eq start (point))))
963 (call-interactively 'beginning-of-line))))
965 (defun widget-end-of-line ()
966 "Go to end of field or end of line, whichever is first."
968 (let* ((field (widget-field-find (point)))
969 (end (and field (widget-field-end field))))
970 (if (and end (not (eq end (point))))
972 (call-interactively 'end-of-line))))
974 (defun widget-kill-line ()
975 "Kill to end of field or end of line, whichever is first."
977 (let* ((field (widget-field-find (point)))
978 (newline (save-excursion (forward-line 1) (point)))
979 (end (and field (widget-field-end field))))
980 (if (and field (> newline end))
981 (kill-region (point) end)
982 (call-interactively 'kill-line))))
984 (defcustom widget-complete-field (lookup-key global-map "\M-\t")
985 "Default function to call for completion inside fields."
986 :options '(ispell-complete-word complete-tag lisp-complete-symbol)
990 (defun widget-complete ()
991 "Complete content of editable field from point.
992 When not inside a field, move to the previous button or field."
994 (let ((field (widget-field-find (point))))
996 (widget-apply field :complete)
997 (error "Not in an editable field"))))
999 ;;; Setting up the buffer.
1001 (defvar widget-field-new nil)
1002 ;; List of all newly created editable fields in the buffer.
1003 (make-variable-buffer-local 'widget-field-new)
1005 (defvar widget-field-list nil)
1006 ;; List of all editable fields in the buffer.
1007 (make-variable-buffer-local 'widget-field-list)
1009 (defun widget-setup ()
1010 "Setup current buffer so editing string widgets works."
1011 (let ((inhibit-read-only t)
1012 (after-change-functions nil)
1014 (while widget-field-new
1015 (setq field (car widget-field-new)
1016 widget-field-new (cdr widget-field-new)
1017 widget-field-list (cons field widget-field-list))
1018 (let ((from (car (widget-get field :field-overlay)))
1019 (to (cdr (widget-get field :field-overlay))))
1020 (widget-specify-field field from to)
1021 (set-marker from nil)
1022 (set-marker to nil))))
1024 ;; We need to maintain text properties and size of the editing fields.
1025 (make-local-variable 'after-change-functions)
1026 (if (and widget-field-list)
1027 (setq after-change-functions '(widget-after-change))
1028 (setq after-change-functions nil)))
1030 (defvar widget-field-last nil)
1031 ;; Last field containing point.
1032 (make-variable-buffer-local 'widget-field-last)
1034 (defvar widget-field-was nil)
1035 ;; The widget data before the change.
1036 (make-variable-buffer-local 'widget-field-was)
1038 (defun widget-field-buffer (widget)
1039 "Return the start of WIDGET's editing field."
1040 (overlay-buffer (widget-get widget :field-overlay)))
1042 (defun widget-field-start (widget)
1043 "Return the start of WIDGET's editing field."
1044 (overlay-start (widget-get widget :field-overlay)))
1046 (defun widget-field-end (widget)
1047 "Return the end of WIDGET's editing field."
1048 ;; Don't subtract one if local-map works at the end of the overlay.
1049 (1- (overlay-end (widget-get widget :field-overlay))))
1051 (defun widget-field-find (pos)
1052 "Return the field at POS.
1053 Unlike (get-char-property POS 'field) this, works with empty fields too."
1054 (let ((fields widget-field-list)
1057 (setq field (car fields)
1058 fields (cdr fields))
1059 (let ((start (widget-field-start field))
1060 (end (widget-field-end field)))
1061 (when (and (<= start pos) (<= pos end))
1063 (debug "Overlapping fields"))
1064 (setq found field))))
1067 (defun widget-after-change (from to old)
1068 ;; Adjust field size and text properties.
1070 (let ((field (widget-field-find from))
1071 (other (widget-field-find to)))
1073 (unless (eq field other)
1074 (debug "Change in different fields"))
1075 (let ((size (widget-get field :size)))
1077 (let ((begin (widget-field-start field))
1078 (end (widget-field-end field)))
1079 (cond ((< (- end begin) size)
1083 (insert-char ?\ (- (+ begin size) end))))
1084 ((> (- end begin) size)
1085 ;; Field too large and
1086 (if (or (< (point) (+ begin size))
1088 ;; Point is outside extra space.
1089 (setq begin (+ begin size))
1090 ;; Point is within the extra space.
1091 (setq begin (point)))
1094 (while (and (eq (preceding-char) ?\ )
1096 (delete-backward-char 1))))))))
1097 (widget-apply field :notify field)))
1098 (error (debug "After Change"))))
1100 ;;; Widget Functions
1102 ;; These functions are used in the definition of multiple widgets.
1104 (defun widget-parent-action (widget &optional event)
1105 "Tell :parent of WIDGET to handle the :action.
1106 Optional EVENT is the event that triggered the action."
1107 (widget-apply (widget-get widget :parent) :action event))
1109 (defun widget-children-value-delete (widget)
1110 "Delete all :children and :buttons in WIDGET."
1111 (mapcar 'widget-delete (widget-get widget :children))
1112 (widget-put widget :children nil)
1113 (mapcar 'widget-delete (widget-get widget :buttons))
1114 (widget-put widget :buttons nil))
1116 (defun widget-children-validate (widget)
1117 "All the :children must be valid."
1118 (let ((children (widget-get widget :children))
1120 (while (and children (not found))
1121 (setq child (car children)
1122 children (cdr children)
1123 found (widget-apply child :validate)))
1126 (defun widget-types-convert-widget (widget)
1127 "Convert :args as widget types in WIDGET."
1128 (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args)))
1131 (defun widget-value-convert-widget (widget)
1132 "Initialize :value from :args in WIDGET."
1133 (let ((args (widget-get widget :args)))
1135 (widget-put widget :value (car args))
1136 ;; Don't convert :value here, as this is done in `widget-convert'.
1137 ;; (widget-put widget :value (widget-apply widget
1138 ;; :value-to-internal (car args)))
1139 (widget-put widget :args nil)))
1142 (defun widget-value-value-get (widget)
1143 "Return the :value property of WIDGET."
1144 (widget-get widget :value))
1146 ;;; The `default' Widget.
1148 (define-widget 'default nil
1149 "Basic widget other widgets are derived from."
1150 :value-to-internal (lambda (widget value) value)
1151 :value-to-external (lambda (widget value) value)
1152 :button-prefix 'widget-button-prefix
1153 :button-suffix 'widget-button-suffix
1154 :complete 'widget-default-complete
1155 :create 'widget-default-create
1158 :format-handler 'widget-default-format-handler
1159 :button-face-get 'widget-default-button-face-get
1160 :sample-face-get 'widget-default-sample-face-get
1161 :delete 'widget-default-delete
1162 :value-set 'widget-default-value-set
1163 :value-inline 'widget-default-value-inline
1164 :menu-tag-get 'widget-default-menu-tag-get
1165 :validate (lambda (widget) nil)
1166 :active 'widget-default-active
1167 :activate 'widget-specify-active
1168 :deactivate 'widget-default-deactivate
1169 :mouse-down-action (lambda (widget event) nil)
1170 :action 'widget-default-action
1171 :notify 'widget-default-notify
1172 :prompt-value 'widget-default-prompt-value)
1174 (defun widget-default-complete (widget)
1175 "Call the value of the :complete-function property of WIDGET.
1176 If that does not exists, call the value of `widget-complete-field'."
1177 (let ((fun (widget-get widget :complete-function)))
1178 (call-interactively (or fun widget-complete-field))))
1180 (defun widget-default-create (widget)
1181 "Create WIDGET at point in the current buffer."
1182 (widget-specify-insert
1183 (let ((from (point))
1184 button-begin button-end
1185 sample-begin sample-end
1188 (insert (widget-get widget :format))
1190 ;; Parse escapes in format.
1191 (while (re-search-forward "%\\(.\\)" nil t)
1192 (let ((escape (aref (match-string 1) 0)))
1193 (replace-match "" t t)
1194 (cond ((eq escape ?%)
1197 (setq button-begin (point))
1198 (widget-button-insert-indirect widget :button-prefix))
1200 (widget-button-insert-indirect widget :button-suffix)
1201 (setq button-end (point)))
1203 (setq sample-begin (point)))
1205 (setq sample-end (point)))
1207 (when (widget-get widget :indent)
1209 (insert-char ? (widget-get widget :indent))))
1211 (let ((glyph (widget-get widget :tag-glyph))
1212 (tag (widget-get widget :tag)))
1214 (widget-glyph-insert widget (or tag "image") glyph))
1218 (let ((standard-output (current-buffer)))
1219 (princ (widget-get widget :value)))))))
1221 (let ((doc (widget-get widget :doc)))
1223 (setq doc-begin (point))
1225 (while (eq (preceding-char) ?\n)
1226 (delete-backward-char 1))
1228 (setq doc-end (point)))))
1230 (if (and button-begin (not button-end))
1231 (widget-apply widget :value-create)
1232 (setq value-pos (point))))
1234 (widget-apply widget :format-handler escape)))))
1235 ;; Specify button, sample, and doc, and insert value.
1236 (and button-begin button-end
1237 (widget-specify-button widget button-begin button-end))
1238 (and sample-begin sample-end
1239 (widget-specify-sample widget sample-begin sample-end))
1240 (and doc-begin doc-end
1241 (widget-specify-doc widget doc-begin doc-end))
1243 (goto-char value-pos)
1244 (widget-apply widget :value-create)))
1245 (let ((from (copy-marker (point-min)))
1246 (to (copy-marker (point-max))))
1247 (widget-specify-text from to)
1248 (set-marker-insertion-type from t)
1249 (set-marker-insertion-type to nil)
1250 (widget-put widget :from from)
1251 (widget-put widget :to to)))
1252 (widget-clear-undo))
1254 (defun widget-default-format-handler (widget escape)
1255 ;; We recognize the %h escape by default.
1256 (let* ((buttons (widget-get widget :buttons))
1257 (doc-property (widget-get widget :documentation-property))
1258 (doc-try (cond ((widget-get widget :doc))
1259 ((symbolp doc-property)
1260 (documentation-property (widget-get widget :value)
1263 (funcall doc-property (widget-get widget :value)))))
1264 (doc-text (and (stringp doc-try)
1265 (> (length doc-try) 1)
1267 (cond ((eq escape ?h)
1269 (and (eq (preceding-char) ?\n)
1270 (widget-get widget :indent)
1271 (insert-char ? (widget-get widget :indent)))
1272 ;; The `*' in the beginning is redundant.
1273 (when (eq (aref doc-text 0) ?*)
1274 (setq doc-text (substring doc-text 1)))
1275 ;; Get rid of trailing newlines.
1276 (when (string-match "\n+\\'" doc-text)
1277 (setq doc-text (substring doc-text 0 (match-beginning 0))))
1278 (push (widget-create-child-and-convert
1279 widget 'documentation-string
1283 (error "Unknown escape `%c'" escape)))
1284 (widget-put widget :buttons buttons)))
1286 (defun widget-default-button-face-get (widget)
1287 ;; Use :button-face or widget-button-face
1288 (or (widget-get widget :button-face) 'widget-button-face))
1290 (defun widget-default-sample-face-get (widget)
1291 ;; Use :sample-face.
1292 (widget-get widget :sample-face))
1294 (defun widget-default-delete (widget)
1295 ;; Remove widget from the buffer.
1296 (let ((from (widget-get widget :from))
1297 (to (widget-get widget :to))
1298 (inactive-overlay (widget-get widget :inactive))
1299 (button-overlay (widget-get widget :button-overlay))
1300 after-change-functions
1301 (inhibit-read-only t))
1302 (widget-apply widget :value-delete)
1303 (when inactive-overlay
1304 (delete-overlay inactive-overlay))
1305 (when button-overlay
1306 (delete-overlay button-overlay))
1308 ;; Kludge: this doesn't need to be true for empty formats.
1309 (delete-region from to))
1310 (set-marker from nil)
1311 (set-marker to nil))
1312 (widget-clear-undo))
1314 (defun widget-default-value-set (widget value)
1315 ;; Recreate widget with new value.
1317 (goto-char (widget-get widget :from))
1318 (widget-apply widget :delete)
1319 (widget-put widget :value value)
1320 (widget-apply widget :create)))
1322 (defun widget-default-value-inline (widget)
1323 ;; Wrap value in a list unless it is inline.
1324 (if (widget-get widget :inline)
1325 (widget-value widget)
1326 (list (widget-value widget))))
1328 (defun widget-default-menu-tag-get (widget)
1329 ;; Use tag or value for menus.
1330 (or (widget-get widget :menu-tag)
1331 (widget-get widget :tag)
1332 (widget-princ-to-string (widget-get widget :value))))
1334 (defun widget-default-active (widget)
1335 "Return t iff this widget active (user modifiable)."
1336 (and (not (widget-get widget :inactive))
1337 (let ((parent (widget-get widget :parent)))
1339 (widget-apply parent :active)))))
1341 (defun widget-default-deactivate (widget)
1342 "Make WIDGET inactive for user modifications."
1343 (widget-specify-inactive widget
1344 (widget-get widget :from)
1345 (widget-get widget :to)))
1347 (defun widget-default-action (widget &optional event)
1348 ;; Notify the parent when a widget change
1349 (let ((parent (widget-get widget :parent)))
1351 (widget-apply parent :notify widget event))))
1353 (defun widget-default-notify (widget child &optional event)
1354 ;; Pass notification to parent.
1355 (widget-default-action widget event))
1357 (defun widget-default-prompt-value (widget prompt value unbound)
1358 ;; Read an arbitrary value. Stolen from `set-variable'.
1359 ;; (let ((initial (if unbound
1361 ;; ;; It would be nice if we could do a `(cons val 1)' here.
1362 ;; (prin1-to-string (custom-quote value))))))
1363 (eval-minibuffer prompt ))
1365 ;;; The `item' Widget.
1367 (define-widget 'item 'default
1368 "Constant items for inclusion in other widgets."
1369 :convert-widget 'widget-value-convert-widget
1370 :value-create 'widget-item-value-create
1371 :value-delete 'ignore
1372 :value-get 'widget-value-value-get
1373 :match 'widget-item-match
1374 :match-inline 'widget-item-match-inline
1375 :action 'widget-item-action
1378 (defun widget-item-value-create (widget)
1379 ;; Insert the printed representation of the value.
1380 (let ((standard-output (current-buffer)))
1381 (princ (widget-get widget :value))))
1383 (defun widget-item-match (widget value)
1384 ;; Match if the value is the same.
1385 (equal (widget-get widget :value) value))
1387 (defun widget-item-match-inline (widget values)
1388 ;; Match if the value is the same.
1389 (let ((value (widget-get widget :value)))
1391 (<= (length value) (length values))
1392 (let ((head (widget-sublist values 0 (length value))))
1393 (and (equal head value)
1394 (cons head (widget-sublist values (length value))))))))
1396 (defun widget-sublist (list start &optional end)
1397 "Return the sublist of LIST from START to END.
1398 If END is omitted, it defaults to the length of LIST."
1399 (if (> start 0) (setq list (nthcdr start list)))
1403 (setq list (copy-sequence list))
1404 (setcdr (nthcdr (- end start 1) list) nil)
1406 (copy-sequence list)))
1408 (defun widget-item-action (widget &optional event)
1409 ;; Just notify itself.
1410 (widget-apply widget :notify widget event))
1412 ;;; The `push-button' Widget.
1414 (defcustom widget-push-button-gui t
1415 "If non nil, use GUI push buttons when available."
1419 ;; Cache already created GUI objects.
1420 (defvar widget-push-button-cache nil)
1422 (defcustom widget-push-button-prefix "["
1423 "String used as prefix for buttons."
1425 :group 'widget-button)
1427 (defcustom widget-push-button-suffix "]"
1428 "String used as suffix for buttons."
1430 :group 'widget-button)
1432 (define-widget 'push-button 'item
1433 "A pushable button."
1436 :value-create 'widget-push-button-value-create
1439 (defun widget-push-button-value-create (widget)
1440 ;; Insert text representing the `on' and `off' states.
1441 (let* ((tag (or (widget-get widget :tag)
1442 (widget-get widget :value)))
1443 (text (concat widget-push-button-prefix
1444 tag widget-push-button-suffix))
1445 (gui (cdr (assoc tag widget-push-button-cache))))
1446 (if (and (fboundp 'make-gui-button)
1447 (fboundp 'make-glyph)
1448 widget-push-button-gui
1449 (fboundp 'device-on-window-system-p)
1450 (device-on-window-system-p)
1451 (string-match "XEmacs" emacs-version))
1454 (setq gui (make-gui-button tag 'widget-gui-action widget))
1455 (push (cons tag gui) widget-push-button-cache))
1456 (widget-glyph-insert-glyph widget
1458 (list (nth 0 (aref gui 1))
1459 (vector 'string ':data text)))
1461 (list (nth 1 (aref gui 1))
1462 (vector 'string ':data text)))
1464 (list (nth 2 (aref gui 1))
1465 (vector 'string ':data text)))))
1468 (defun widget-gui-action (widget)
1469 "Apply :action for WIDGET."
1470 (widget-apply-action widget (this-command-keys)))
1472 ;;; The `link' Widget.
1474 (defcustom widget-link-prefix "["
1475 "String used as prefix for links."
1477 :group 'widget-button)
1479 (defcustom widget-link-suffix "]"
1480 "String used as suffix for links."
1482 :group 'widget-button)
1484 (define-widget 'link 'item
1486 :button-prefix 'widget-link-prefix
1487 :button-suffix 'widget-link-suffix
1488 :help-echo "Follow the link."
1491 ;;; The `info-link' Widget.
1493 (define-widget 'info-link 'link
1494 "A link to an info file."
1495 :action 'widget-info-link-action)
1497 (defun widget-info-link-action (widget &optional event)
1498 "Open the info node specified by WIDGET."
1499 (Info-goto-node (widget-value widget)))
1501 ;;; The `url-link' Widget.
1503 (define-widget 'url-link 'link
1504 "A link to an www page."
1505 :action 'widget-url-link-action)
1507 (defun widget-url-link-action (widget &optional event)
1508 "Open the url specified by WIDGET."
1509 (require 'browse-url)
1510 (funcall browse-url-browser-function (widget-value widget)))
1512 ;;; The `editable-field' Widget.
1514 (define-widget 'editable-field 'default
1515 "An editable text field."
1516 :convert-widget 'widget-value-convert-widget
1517 :keymap widget-field-keymap
1520 :prompt-internal 'widget-field-prompt-internal
1521 :prompt-history 'widget-field-history
1522 :prompt-value 'widget-field-prompt-value
1523 :action 'widget-field-action
1524 :validate 'widget-field-validate
1527 :value-create 'widget-field-value-create
1528 :value-delete 'widget-field-value-delete
1529 :value-get 'widget-field-value-get
1530 :match 'widget-field-match)
1532 (defvar widget-field-history nil
1533 "History of field minibuffer edits.")
1535 (defun widget-field-prompt-internal (widget prompt initial history)
1536 ;; Read string for WIDGET promptinhg with PROMPT.
1537 ;; INITIAL is the initial input and HISTORY is a symbol containing
1538 ;; the earlier input.
1539 (read-string prompt initial history))
1541 (defun widget-field-prompt-value (widget prompt value unbound)
1542 ;; Prompt for a string.
1543 (let ((initial (if unbound
1545 (cons (widget-apply widget :value-to-internal
1547 (history (widget-get widget :prompt-history)))
1548 (let ((answer (widget-apply widget
1549 :prompt-internal prompt initial history)))
1550 (widget-apply widget :value-to-external answer))))
1552 (defun widget-field-action (widget &optional event)
1553 ;; Edit the value in the minibuffer.
1554 (let ((invalid (widget-apply widget :validate)))
1555 (let ((prompt (concat (widget-apply widget :menu-tag-get) ": "))
1556 (value (unless invalid
1557 (widget-value widget))))
1558 (let ((answer (widget-apply widget :prompt-value prompt value invalid) ))
1559 (widget-value-set widget answer)))
1561 (widget-apply widget :notify widget event)))
1563 (defun widget-field-validate (widget)
1564 ;; Valid if the content matches `:valid-regexp'.
1566 (let ((value (widget-apply widget :value-get))
1567 (regexp (widget-get widget :valid-regexp)))
1568 (if (string-match regexp value)
1572 (defun widget-field-value-create (widget)
1573 ;; Create an editable text field.
1574 (let ((size (widget-get widget :size))
1575 (value (widget-get widget :value))
1577 (overlay (cons (make-marker) (make-marker))))
1578 (widget-put widget :field-overlay overlay)
1581 (< (length value) size)
1582 (insert-char ?\ (- size (length value))))
1583 (unless (memq widget widget-field-list)
1584 (setq widget-field-new (cons widget widget-field-new)))
1585 (move-marker (cdr overlay) (point))
1586 (set-marker-insertion-type (cdr overlay) nil)
1589 (move-marker (car overlay) from)
1590 (set-marker-insertion-type (car overlay) t)))
1592 (defun widget-field-value-delete (widget)
1593 ;; Remove the widget from the list of active editing fields.
1594 (setq widget-field-list (delq widget widget-field-list))
1595 ;; These are nil if the :format string doesn't contain `%v'.
1596 (let ((overlay (widget-get widget :field-overlay)))
1598 (delete-overlay overlay))))
1600 (defun widget-field-value-get (widget)
1601 ;; Return current text in editing field.
1602 (let ((from (widget-field-start widget))
1603 (to (widget-field-end widget))
1604 (buffer (widget-field-buffer widget))
1605 (size (widget-get widget :size))
1606 (secret (widget-get widget :secret))
1607 (old (current-buffer)))
1614 (eq (char-after (1- to)) ?\ ))
1616 (let ((result (buffer-substring-no-properties from to)))
1619 (while (< (+ from index) to)
1621 (get-char-property (+ from index) 'secret))
1622 (setq index (1+ index)))))
1625 (widget-get widget :value))))
1627 (defun widget-field-match (widget value)
1628 ;; Match any string.
1631 ;;; The `text' Widget.
1633 (define-widget 'text 'editable-field
1634 :keymap widget-text-keymap
1635 "A multiline text area.")
1637 ;;; The `menu-choice' Widget.
1639 (define-widget 'menu-choice 'default
1640 "A menu of options."
1641 :convert-widget 'widget-types-convert-widget
1642 :format "%[%t%]: %v"
1645 :void '(item :format "invalid (%t)\n")
1646 :value-create 'widget-choice-value-create
1647 :value-delete 'widget-children-value-delete
1648 :value-get 'widget-choice-value-get
1649 :value-inline 'widget-choice-value-inline
1650 :mouse-down-action 'widget-choice-mouse-down-action
1651 :action 'widget-choice-action
1652 :error "Make a choice"
1653 :validate 'widget-choice-validate
1654 :match 'widget-choice-match
1655 :match-inline 'widget-choice-match-inline)
1657 (defun widget-choice-value-create (widget)
1658 ;; Insert the first choice that matches the value.
1659 (let ((value (widget-get widget :value))
1660 (args (widget-get widget :args))
1663 (setq current (car args)
1665 (when (widget-apply current :match value)
1666 (widget-put widget :children (list (widget-create-child-value
1667 widget current value)))
1668 (widget-put widget :choice current)
1672 (let ((void (widget-get widget :void)))
1673 (widget-put widget :children (list (widget-create-child-and-convert
1674 widget void :value value)))
1675 (widget-put widget :choice void)))))
1677 (defun widget-choice-value-get (widget)
1678 ;; Get value of the child widget.
1679 (widget-value (car (widget-get widget :children))))
1681 (defun widget-choice-value-inline (widget)
1682 ;; Get value of the child widget.
1683 (widget-apply (car (widget-get widget :children)) :value-inline))
1685 (defcustom widget-choice-toggle nil
1686 "If non-nil, a binary choice will just toggle between the values.
1687 Otherwise, the user will explicitly have to choose between the values
1688 when he invoked the menu."
1692 (defun widget-choice-mouse-down-action (widget &optional event)
1693 ;; Return non-nil if we need a menu.
1694 (let ((args (widget-get widget :args))
1695 (old (widget-get widget :choice)))
1696 (cond ((not window-system)
1697 ;; No place to pop up a menu.
1699 ((not (or (fboundp 'x-popup-menu) (fboundp 'popup-menu)))
1700 ;; No way to pop up a menu.
1702 ((< (length args) 2)
1703 ;; Empty or singleton list, just return the value.
1705 ((> (length args) widget-menu-max-size)
1706 ;; Too long, prompt.
1708 ((> (length args) 2)
1709 ;; Reasonable sized list, use menu.
1711 ((and widget-choice-toggle (memq old args))
1715 ;; Ask which of the two.
1718 (defun widget-choice-action (widget &optional event)
1720 (let ((args (widget-get widget :args))
1721 (old (widget-get widget :choice))
1722 (tag (widget-apply widget :menu-tag-get))
1723 (completion-ignore-case (widget-get widget :case-fold))
1725 ;; Remember old value.
1726 (if (and old (not (widget-apply widget :validate)))
1727 (let* ((external (widget-value widget))
1728 (internal (widget-apply old :value-to-internal external)))
1729 (widget-put old :value internal)))
1732 (cond ((= (length args) 0)
1734 ((= (length args) 1)
1736 ((and widget-choice-toggle
1739 (if (eq old (nth 0 args))
1744 (setq current (car args)
1747 (cons (cons (widget-apply current :menu-tag-get)
1750 (widget-choose tag (reverse choices) event))))
1752 (widget-value-set widget
1753 (widget-apply current :value-to-external
1754 (widget-get current :value)))
1756 (widget-apply widget :notify widget event))))
1758 (defun widget-choice-validate (widget)
1759 ;; Valid if we have made a valid choice.
1760 (let ((void (widget-get widget :void))
1761 (choice (widget-get widget :choice))
1762 (child (car (widget-get widget :children))))
1763 (if (eq void choice)
1765 (widget-apply child :validate))))
1767 (defun widget-choice-match (widget value)
1768 ;; Matches if one of the choices matches.
1769 (let ((args (widget-get widget :args))
1771 (while (and args (not found))
1772 (setq current (car args)
1774 found (widget-apply current :match value)))
1777 (defun widget-choice-match-inline (widget values)
1778 ;; Matches if one of the choices matches.
1779 (let ((args (widget-get widget :args))
1781 (while (and args (null found))
1782 (setq current (car args)
1784 found (widget-match-inline current values)))
1787 ;;; The `toggle' Widget.
1789 (define-widget 'toggle 'item
1790 "Toggle between two states."
1792 :value-create 'widget-toggle-value-create
1793 :action 'widget-toggle-action
1794 :match (lambda (widget value) t)
1798 (defun widget-toggle-value-create (widget)
1799 ;; Insert text representing the `on' and `off' states.
1800 (if (widget-value widget)
1801 (widget-glyph-insert widget
1802 (widget-get widget :on)
1803 (widget-get widget :on-glyph))
1804 (widget-glyph-insert widget
1805 (widget-get widget :off)
1806 (widget-get widget :off-glyph))))
1808 (defun widget-toggle-action (widget &optional event)
1810 (widget-value-set widget (not (widget-value widget)))
1811 (widget-apply widget :notify widget event))
1813 ;;; The `checkbox' Widget.
1815 (define-widget 'checkbox 'toggle
1816 "A checkbox toggle."
1824 :action 'widget-checkbox-action)
1826 (defun widget-checkbox-action (widget &optional event)
1827 "Toggle checkbox, notify parent, and set active state of sibling."
1828 (widget-toggle-action widget event)
1829 (let ((sibling (widget-get-sibling widget)))
1831 (if (widget-value widget)
1832 (widget-apply sibling :activate)
1833 (widget-apply sibling :deactivate)))))
1835 ;;; The `checklist' Widget.
1837 (define-widget 'checklist 'default
1838 "A multiple choice widget."
1839 :convert-widget 'widget-types-convert-widget
1842 :entry-format "%b %v"
1843 :menu-tag "checklist"
1845 :value-create 'widget-checklist-value-create
1846 :value-delete 'widget-children-value-delete
1847 :value-get 'widget-checklist-value-get
1848 :validate 'widget-checklist-validate
1849 :match 'widget-checklist-match
1850 :match-inline 'widget-checklist-match-inline)
1852 (defun widget-checklist-value-create (widget)
1853 ;; Insert all values
1854 (let ((alist (widget-checklist-match-find widget (widget-get widget :value)))
1855 (args (widget-get widget :args)))
1857 (widget-checklist-add-item widget (car args) (assq (car args) alist))
1858 (setq args (cdr args)))
1859 (widget-put widget :children (nreverse (widget-get widget :children)))))
1861 (defun widget-checklist-add-item (widget type chosen)
1862 ;; Create checklist item in WIDGET of type TYPE.
1863 ;; If the item is checked, CHOSEN is a cons whose cdr is the value.
1864 (and (eq (preceding-char) ?\n)
1865 (widget-get widget :indent)
1866 (insert-char ? (widget-get widget :indent)))
1867 (widget-specify-insert
1868 (let* ((children (widget-get widget :children))
1869 (buttons (widget-get widget :buttons))
1870 (button-args (or (widget-get type :sibling-args)
1871 (widget-get widget :button-args)))
1874 (insert (widget-get widget :entry-format))
1876 ;; Parse % escapes in format.
1877 (while (re-search-forward "%\\([bv%]\\)" nil t)
1878 (let ((escape (aref (match-string 1) 0)))
1879 (replace-match "" t t)
1880 (cond ((eq escape ?%)
1883 (setq button (apply 'widget-create-child-and-convert
1885 :value (not (null chosen))
1890 (let ((child (widget-create-child widget type)))
1891 (widget-apply child :deactivate)
1893 ((widget-get type :inline)
1894 (widget-create-child-value
1895 widget type (cdr chosen)))
1897 (widget-create-child-value
1898 widget type (car (cdr chosen)))))))
1900 (error "Unknown escape `%c'" escape)))))
1901 ;; Update properties.
1902 (and button child (widget-put child :button button))
1903 (and button (widget-put widget :buttons (cons button buttons)))
1904 (and child (widget-put widget :children (cons child children))))))
1906 (defun widget-checklist-match (widget values)
1907 ;; All values must match a type in the checklist.
1909 (null (cdr (widget-checklist-match-inline widget values)))))
1911 (defun widget-checklist-match-inline (widget values)
1912 ;; Find the values which match a type in the checklist.
1913 (let ((greedy (widget-get widget :greedy))
1914 (args (copy-sequence (widget-get widget :args)))
1917 (let ((answer (widget-checklist-match-up args values)))
1919 (let ((vals (widget-match-inline answer values)))
1920 (setq found (append found (car vals))
1922 args (delq answer args))))
1924 (setq rest (append rest (list (car values)))
1925 values (cdr values)))
1927 (setq rest (append rest values)
1931 (defun widget-checklist-match-find (widget vals)
1932 ;; Find the vals which match a type in the checklist.
1933 ;; Return an alist of (TYPE MATCH).
1934 (let ((greedy (widget-get widget :greedy))
1935 (args (copy-sequence (widget-get widget :args)))
1938 (let ((answer (widget-checklist-match-up args vals)))
1940 (let ((match (widget-match-inline answer vals)))
1941 (setq found (cons (cons answer (car match)) found)
1943 args (delq answer args))))
1945 (setq vals (cdr vals)))
1950 (defun widget-checklist-match-up (args vals)
1951 ;; Rerturn the first type from ARGS that matches VALS.
1952 (let (current found)
1953 (while (and args (null found))
1954 (setq current (car args)
1956 found (widget-match-inline current vals)))
1961 (defun widget-checklist-value-get (widget)
1962 ;; The values of all selected items.
1963 (let ((children (widget-get widget :children))
1966 (setq child (car children)
1967 children (cdr children))
1968 (if (widget-value (widget-get child :button))
1969 (setq result (append result (widget-apply child :value-inline)))))
1972 (defun widget-checklist-validate (widget)
1973 ;; Ticked chilren must be valid.
1974 (let ((children (widget-get widget :children))
1976 (while (and children (not found))
1977 (setq child (car children)
1978 children (cdr children)
1979 button (widget-get child :button)
1980 found (and (widget-value button)
1981 (widget-apply child :validate))))
1984 ;;; The `option' Widget
1986 (define-widget 'option 'checklist
1987 "An widget with an optional item."
1990 ;;; The `choice-item' Widget.
1992 (define-widget 'choice-item 'item
1993 "Button items that delegate action events to their parents."
1994 :action 'widget-parent-action
1995 :format "%[%t%] \n")
1997 ;;; The `radio-button' Widget.
1999 (define-widget 'radio-button 'toggle
2000 "A radio button for use in the `radio' widget."
2001 :notify 'widget-radio-button-notify
2008 :off-glyph "radio0")
2010 (defun widget-radio-button-notify (widget child &optional event)
2012 (widget-apply (widget-get widget :parent) :action widget event))
2014 ;;; The `radio-button-choice' Widget.
2016 (define-widget 'radio-button-choice 'default
2017 "Select one of multiple options."
2018 :convert-widget 'widget-types-convert-widget
2021 :entry-format "%b %v"
2023 :value-create 'widget-radio-value-create
2024 :value-delete 'widget-children-value-delete
2025 :value-get 'widget-radio-value-get
2026 :value-inline 'widget-radio-value-inline
2027 :value-set 'widget-radio-value-set
2028 :error "You must push one of the buttons"
2029 :validate 'widget-radio-validate
2030 :match 'widget-choice-match
2031 :match-inline 'widget-choice-match-inline
2032 :action 'widget-radio-action)
2034 (defun widget-radio-value-create (widget)
2035 ;; Insert all values
2036 (let ((args (widget-get widget :args))
2039 (setq arg (car args)
2041 (widget-radio-add-item widget arg))))
2043 (defun widget-radio-add-item (widget type)
2044 "Add to radio widget WIDGET a new radio button item of type TYPE."
2045 ;; (setq type (widget-convert type))
2046 (and (eq (preceding-char) ?\n)
2047 (widget-get widget :indent)
2048 (insert-char ? (widget-get widget :indent)))
2049 (widget-specify-insert
2050 (let* ((value (widget-get widget :value))
2051 (children (widget-get widget :children))
2052 (buttons (widget-get widget :buttons))
2053 (button-args (or (widget-get type :sibling-args)
2054 (widget-get widget :button-args)))
2056 (chosen (and (null (widget-get widget :choice))
2057 (widget-apply type :match value)))
2059 (insert (widget-get widget :entry-format))
2061 ;; Parse % escapes in format.
2062 (while (re-search-forward "%\\([bv%]\\)" nil t)
2063 (let ((escape (aref (match-string 1) 0)))
2064 (replace-match "" t t)
2065 (cond ((eq escape ?%)
2068 (setq button (apply 'widget-create-child-and-convert
2069 widget 'radio-button
2070 :value (not (null chosen))
2073 (setq child (if chosen
2074 (widget-create-child-value
2076 (widget-create-child widget type)))
2078 (widget-apply child :deactivate)))
2080 (error "Unknown escape `%c'" escape)))))
2081 ;; Update properties.
2083 (widget-put widget :choice type))
2085 (widget-put child :button button)
2086 (widget-put widget :buttons (nconc buttons (list button))))
2088 (widget-put widget :children (nconc children (list child))))
2091 (defun widget-radio-value-get (widget)
2092 ;; Get value of the child widget.
2093 (let ((chosen (widget-radio-chosen widget)))
2094 (and chosen (widget-value chosen))))
2096 (defun widget-radio-chosen (widget)
2097 "Return the widget representing the chosen radio button."
2098 (let ((children (widget-get widget :children))
2101 (setq current (car children)
2102 children (cdr children))
2103 (let* ((button (widget-get current :button))
2104 (value (widget-apply button :value-get)))
2110 (defun widget-radio-value-inline (widget)
2111 ;; Get value of the child widget.
2112 (let ((children (widget-get widget :children))
2115 (setq current (car children)
2116 children (cdr children))
2117 (let* ((button (widget-get current :button))
2118 (value (widget-apply button :value-get)))
2120 (setq found (widget-apply current :value-inline)
2124 (defun widget-radio-value-set (widget value)
2125 ;; We can't just delete and recreate a radio widget, since children
2126 ;; can be added after the original creation and won't be recreated
2128 (let ((children (widget-get widget :children))
2131 (setq current (car children)
2132 children (cdr children))
2133 (let* ((button (widget-get current :button))
2134 (match (and (not found)
2135 (widget-apply current :match value))))
2136 (widget-value-set button match)
2139 (widget-value-set current value)
2140 (widget-apply current :activate))
2141 (widget-apply current :deactivate))
2142 (setq found (or found match))))))
2144 (defun widget-radio-validate (widget)
2145 ;; Valid if we have made a valid choice.
2146 (let ((children (widget-get widget :children))
2147 current found button)
2148 (while (and children (not found))
2149 (setq current (car children)
2150 children (cdr children)
2151 button (widget-get current :button)
2152 found (widget-apply button :value-get)))
2154 (widget-apply current :validate)
2157 (defun widget-radio-action (widget child event)
2158 ;; Check if a radio button was pressed.
2159 (let ((children (widget-get widget :children))
2160 (buttons (widget-get widget :buttons))
2162 (when (memq child buttons)
2164 (setq current (car children)
2165 children (cdr children))
2166 (let* ((button (widget-get current :button)))
2167 (cond ((eq child button)
2168 (widget-value-set button t)
2169 (widget-apply current :activate))
2170 ((widget-value button)
2171 (widget-value-set button nil)
2172 (widget-apply current :deactivate)))))))
2173 ;; Pass notification to parent.
2174 (widget-apply widget :notify child event))
2176 ;;; The `insert-button' Widget.
2178 (define-widget 'insert-button 'push-button
2179 "An insert button for the `editable-list' widget."
2181 :help-echo "Insert a new item into the list at this position."
2182 :action 'widget-insert-button-action)
2184 (defun widget-insert-button-action (widget &optional event)
2185 ;; Ask the parent to insert a new item.
2186 (widget-apply (widget-get widget :parent)
2187 :insert-before (widget-get widget :widget)))
2189 ;;; The `delete-button' Widget.
2191 (define-widget 'delete-button 'push-button
2192 "A delete button for the `editable-list' widget."
2194 :help-echo "Delete this item from the list."
2195 :action 'widget-delete-button-action)
2197 (defun widget-delete-button-action (widget &optional event)
2198 ;; Ask the parent to insert a new item.
2199 (widget-apply (widget-get widget :parent)
2200 :delete-at (widget-get widget :widget)))
2202 ;;; The `editable-list' Widget.
2204 (defcustom widget-editable-list-gui nil
2205 "If non nil, use GUI push-buttons in editable list when available."
2209 (define-widget 'editable-list 'default
2210 "A variable list of widgets of the same type."
2211 :convert-widget 'widget-types-convert-widget
2214 :format-handler 'widget-editable-list-format-handler
2215 :entry-format "%i %d %v"
2216 :menu-tag "editable-list"
2217 :value-create 'widget-editable-list-value-create
2218 :value-delete 'widget-children-value-delete
2219 :value-get 'widget-editable-list-value-get
2220 :validate 'widget-children-validate
2221 :match 'widget-editable-list-match
2222 :match-inline 'widget-editable-list-match-inline
2223 :insert-before 'widget-editable-list-insert-before
2224 :delete-at 'widget-editable-list-delete-at)
2226 (defun widget-editable-list-format-handler (widget escape)
2227 ;; We recognize the insert button.
2228 (let ((widget-push-button-gui widget-editable-list-gui))
2229 (cond ((eq escape ?i)
2230 (and (widget-get widget :indent)
2231 (insert-char ? (widget-get widget :indent)))
2232 (apply 'widget-create-child-and-convert
2233 widget 'insert-button
2234 (widget-get widget :append-button-args)))
2236 (widget-default-format-handler widget escape)))))
2238 (defun widget-editable-list-value-create (widget)
2239 ;; Insert all values
2240 (let* ((value (widget-get widget :value))
2241 (type (nth 0 (widget-get widget :args)))
2242 (inlinep (widget-get type :inline))
2244 (widget-put widget :value-pos (copy-marker (point)))
2245 (set-marker-insertion-type (widget-get widget :value-pos) t)
2247 (let ((answer (widget-match-inline type value)))
2249 (setq children (cons (widget-editable-list-entry-create
2258 (widget-put widget :children (nreverse children))))
2260 (defun widget-editable-list-value-get (widget)
2261 ;; Get value of the child widget.
2262 (apply 'append (mapcar (lambda (child) (widget-apply child :value-inline))
2263 (widget-get widget :children))))
2265 (defun widget-editable-list-match (widget value)
2266 ;; Value must be a list and all the members must match the type.
2268 (null (cdr (widget-editable-list-match-inline widget value)))))
2270 (defun widget-editable-list-match-inline (widget value)
2271 (let ((type (nth 0 (widget-get widget :args)))
2274 (while (and value ok)
2275 (let ((answer (widget-match-inline type value)))
2277 (setq found (append found (car answer))
2280 (cons found value)))
2282 (defun widget-editable-list-insert-before (widget before)
2283 ;; Insert a new child in the list of children.
2285 (let ((children (widget-get widget :children))
2286 (inhibit-read-only t)
2287 after-change-functions)
2289 (goto-char (widget-get before :entry-from)))
2291 (goto-char (widget-get widget :value-pos))))
2292 (let ((child (widget-editable-list-entry-create
2294 (when (< (widget-get child :entry-from) (widget-get widget :from))
2295 (set-marker (widget-get widget :from)
2296 (widget-get child :entry-from)))
2297 (widget-specify-text (widget-get child :entry-from)
2298 (widget-get child :entry-to))
2299 (if (eq (car children) before)
2300 (widget-put widget :children (cons child children))
2301 (while (not (eq (car (cdr children)) before))
2302 (setq children (cdr children)))
2303 (setcdr children (cons child (cdr children)))))))
2305 (widget-apply widget :notify widget))
2307 (defun widget-editable-list-delete-at (widget child)
2308 ;; Delete child from list of children.
2310 (let ((buttons (copy-sequence (widget-get widget :buttons)))
2312 (inhibit-read-only t)
2313 after-change-functions)
2315 (setq button (car buttons)
2316 buttons (cdr buttons))
2317 (when (eq (widget-get button :widget) child)
2319 :buttons (delq button (widget-get widget :buttons)))
2320 (widget-delete button))))
2321 (let ((entry-from (widget-get child :entry-from))
2322 (entry-to (widget-get child :entry-to))
2323 (inhibit-read-only t)
2324 after-change-functions)
2325 (widget-delete child)
2326 (delete-region entry-from entry-to)
2327 (set-marker entry-from nil)
2328 (set-marker entry-to nil))
2329 (widget-put widget :children (delq child (widget-get widget :children))))
2331 (widget-apply widget :notify widget))
2333 (defun widget-editable-list-entry-create (widget value conv)
2334 ;; Create a new entry to the list.
2335 (let ((type (nth 0 (widget-get widget :args)))
2336 (widget-push-button-gui widget-editable-list-gui)
2337 child delete insert)
2338 (widget-specify-insert
2340 (and (widget-get widget :indent)
2341 (insert-char ? (widget-get widget :indent)))
2342 (insert (widget-get widget :entry-format)))
2343 ;; Parse % escapes in format.
2344 (while (re-search-forward "%\\(.\\)" nil t)
2345 (let ((escape (aref (match-string 1) 0)))
2346 (replace-match "" t t)
2347 (cond ((eq escape ?%)
2350 (setq insert (apply 'widget-create-child-and-convert
2351 widget 'insert-button
2352 (widget-get widget :insert-button-args))))
2354 (setq delete (apply 'widget-create-child-and-convert
2355 widget 'delete-button
2356 (widget-get widget :delete-button-args))))
2359 (setq child (widget-create-child-value
2361 (setq child (widget-create-child widget type))))
2363 (error "Unknown escape `%c'" escape)))))
2365 :buttons (cons delete
2367 (widget-get widget :buttons))))
2368 (let ((entry-from (copy-marker (point-min)))
2369 (entry-to (copy-marker (point-max))))
2370 (widget-specify-text entry-from entry-to)
2371 (set-marker-insertion-type entry-from t)
2372 (set-marker-insertion-type entry-to nil)
2373 (widget-put child :entry-from entry-from)
2374 (widget-put child :entry-to entry-to)))
2375 (widget-put insert :widget child)
2376 (widget-put delete :widget child)
2379 ;;; The `group' Widget.
2381 (define-widget 'group 'default
2382 "A widget which group other widgets inside."
2383 :convert-widget 'widget-types-convert-widget
2385 :value-create 'widget-group-value-create
2386 :value-delete 'widget-children-value-delete
2387 :value-get 'widget-editable-list-value-get
2388 :validate 'widget-children-validate
2389 :match 'widget-group-match
2390 :match-inline 'widget-group-match-inline)
2392 (defun widget-group-value-create (widget)
2393 ;; Create each component.
2394 (let ((args (widget-get widget :args))
2395 (value (widget-get widget :value))
2396 arg answer children)
2398 (setq arg (car args)
2400 answer (widget-match-inline arg value)
2402 (and (eq (preceding-char) ?\n)
2403 (widget-get widget :indent)
2404 (insert-char ? (widget-get widget :indent)))
2405 (push (cond ((null answer)
2406 (widget-create-child widget arg))
2407 ((widget-get arg :inline)
2408 (widget-create-child-value widget arg (car answer)))
2410 (widget-create-child-value widget arg (car (car answer)))))
2412 (widget-put widget :children (nreverse children))))
2414 (defun widget-group-match (widget values)
2415 ;; Match if the components match.
2417 (let ((match (widget-group-match-inline widget values)))
2418 (and match (null (cdr match))))))
2420 (defun widget-group-match-inline (widget vals)
2421 ;; Match if the components match.
2422 (let ((args (widget-get widget :args))
2423 argument answer found)
2425 (setq argument (car args)
2427 answer (widget-match-inline argument vals))
2429 (setq vals (cdr answer)
2430 found (append found (car answer)))
2437 ;;; The `visibility' Widget.
2439 (define-widget 'visibility 'item
2440 "An indicator and manipulator for hidden items."
2446 :value-create 'widget-visibility-value-create
2447 :action 'widget-toggle-action
2448 :match (lambda (widget value) t))
2450 (defun widget-visibility-value-create (widget)
2451 ;; Insert text representing the `on' and `off' states.
2452 (let ((on (widget-get widget :on))
2453 (off (widget-get widget :off)))
2455 (setq on (concat widget-push-button-prefix
2457 widget-push-button-suffix))
2460 (setq off (concat widget-push-button-prefix
2462 widget-push-button-suffix))
2464 (if (widget-value widget)
2465 (widget-glyph-insert widget on "down" "down-pushed")
2466 (widget-glyph-insert widget off "right" "right-pushed")
2469 ;;; The `documentation-string' Widget.
2471 (defface widget-documentation-face '((((class color)
2473 (:foreground "lime green"))
2476 (:foreground "dark green"))
2478 "Face used for documentation text."
2481 (define-widget 'documentation-string 'item
2482 "A documentation string."
2484 :action 'widget-documentation-string-action
2485 :value-delete 'widget-children-value-delete
2486 :value-create 'widget-documentation-string-value-create)
2488 (defun widget-documentation-string-value-create (widget)
2489 ;; Insert documentation string.
2490 (let ((doc (widget-value widget))
2491 (shown (widget-get (widget-get widget :parent) :documentation-shown)))
2492 (if (string-match "\n" doc)
2493 (let ((before (substring doc 0 (match-beginning 0)))
2494 (after (substring doc (match-beginning 0)))
2498 (widget-specify-doc widget start (point))
2499 (push (widget-create-child-and-convert
2502 :action 'widget-parent-action
2506 (setq start (point))
2508 (widget-specify-doc widget start (point)))
2509 (widget-put widget :buttons buttons))
2513 (defun widget-documentation-string-action (widget &rest ignore)
2514 ;; Toggle documentation.
2515 (let ((parent (widget-get widget :parent)))
2516 (widget-put parent :documentation-shown
2517 (not (widget-get parent :documentation-shown))))
2519 (widget-value-set widget (widget-value widget)))
2521 ;;; The Sexp Widgets.
2523 (define-widget 'const 'item
2524 "An immutable sexp."
2525 :prompt-value 'widget-const-prompt-value
2528 (defun widget-const-prompt-value (widget prompt value unbound)
2529 ;; Return the value of the const.
2530 (widget-value widget))
2532 (define-widget 'function-item 'const
2533 "An immutable function name."
2535 :documentation-property (lambda (symbol)
2537 (documentation symbol t)
2540 (define-widget 'variable-item 'const
2541 "An immutable variable name."
2543 :documentation-property 'variable-documentation)
2545 (defvar widget-string-prompt-value-history nil
2546 "History of input to `widget-string-prompt-value'.")
2548 (define-widget 'string 'editable-field
2551 :format "%{%t%}: %v"
2552 :complete-function 'ispell-complete-word
2553 :prompt-history 'widget-string-prompt-value-history)
2555 (define-widget 'regexp 'string
2556 "A regular expression."
2557 :match 'widget-regexp-match
2558 :validate 'widget-regexp-validate
2561 (defun widget-regexp-match (widget value)
2562 ;; Match valid regexps.
2563 (and (stringp value)
2566 (string-match value ""))
2569 (defun widget-regexp-validate (widget)
2570 "Check that the value of WIDGET is a valid regexp."
2571 (let ((val (widget-value widget)))
2572 (condition-case data
2574 (string-match val ""))
2575 (error (widget-put widget :error (error-message-string data))
2578 (define-widget 'file 'string
2580 It will read a file name from the minibuffer when invoked."
2581 :prompt-value 'widget-file-prompt-value
2582 :format "%{%t%}: %v"
2584 :action 'widget-file-action)
2586 (defun widget-file-prompt-value (widget prompt value unbound)
2587 ;; Read file from minibuffer.
2588 (abbreviate-file-name
2590 (read-file-name prompt)
2591 (let ((prompt2 (format "%s (default %s) " prompt value))
2592 (dir (file-name-directory value))
2593 (file (file-name-nondirectory value))
2594 (must-match (widget-get widget :must-match)))
2595 (read-file-name prompt2 dir nil must-match file)))))
2597 (defun widget-file-action (widget &optional event)
2598 ;; Read a file name from the minibuffer.
2599 (let* ((value (widget-value widget))
2600 (dir (file-name-directory value))
2601 (file (file-name-nondirectory value))
2602 (menu-tag (widget-apply widget :menu-tag-get))
2603 (must-match (widget-get widget :must-match))
2604 (answer (read-file-name (concat menu-tag ": (default `" value "') ")
2605 dir nil must-match file)))
2606 (widget-value-set widget (abbreviate-file-name answer))
2608 (widget-apply widget :notify widget event)))
2610 (define-widget 'directory 'file
2611 "A directory widget.
2612 It will read a directory name from the minibuffer when invoked."
2615 (defvar widget-symbol-prompt-value-history nil
2616 "History of input to `widget-symbol-prompt-value'.")
2618 (define-widget 'symbol 'editable-field
2622 :format "%{%t%}: %v"
2623 :match (lambda (widget value) (symbolp value))
2624 :prompt-internal 'widget-symbol-prompt-internal
2625 :prompt-match 'symbolp
2626 :prompt-history 'widget-symbol-prompt-value-history
2627 :value-to-internal (lambda (widget value)
2631 :value-to-external (lambda (widget value)
2636 (defun widget-symbol-prompt-internal (widget prompt initial history)
2637 ;; Read file from minibuffer.
2638 (let ((answer (completing-read prompt obarray
2639 (widget-get widget :prompt-match)
2640 nil initial history)))
2641 (if (and (stringp answer)
2642 (not (zerop (length answer))))
2644 (error "No value"))))
2646 (defvar widget-function-prompt-value-history nil
2647 "History of input to `widget-function-prompt-value'.")
2649 (define-widget 'function 'sexp
2651 :complete-function 'lisp-complete-symbol
2652 :prompt-value 'widget-field-prompt-value
2653 :prompt-internal 'widget-symbol-prompt-internal
2654 :prompt-match 'fboundp
2655 :prompt-history 'widget-function-prompt-value-history
2656 :action 'widget-field-action
2659 (defvar widget-variable-prompt-value-history nil
2660 "History of input to `widget-variable-prompt-value'.")
2662 (define-widget 'variable 'symbol
2663 ;; Should complete on variables.
2665 :prompt-match 'boundp
2666 :prompt-history 'widget-variable-prompt-value-history
2669 (define-widget 'sexp 'editable-field
2670 "An arbitrary lisp expression."
2671 :tag "Lisp expression"
2672 :format "%{%t%}: %v"
2674 :validate 'widget-sexp-validate
2675 :match (lambda (widget value) t)
2676 :value-to-internal 'widget-sexp-value-to-internal
2677 :value-to-external (lambda (widget value) (read value))
2678 :prompt-history 'widget-sexp-prompt-value-history
2679 :prompt-value 'widget-sexp-prompt-value)
2681 (defun widget-sexp-value-to-internal (widget value)
2682 ;; Use pp for printer representation.
2683 (let ((pp (if (symbolp value)
2684 (prin1-to-string value)
2685 (pp-to-string value))))
2686 (while (string-match "\n\\'" pp)
2687 (setq pp (substring pp 0 -1)))
2688 (if (or (string-match "\n\\'" pp)
2693 (defun widget-sexp-validate (widget)
2694 ;; Valid if we can read the string and there is no junk left after it.
2696 (let ((buffer (set-buffer (get-buffer-create " *Widget Scratch*"))))
2698 (insert (widget-apply widget :value-get))
2699 (goto-char (point-min))
2700 (condition-case data
2701 (let ((value (read buffer)))
2703 (if (widget-apply widget :match value)
2705 (widget-put widget :error (widget-get widget :type-error))
2708 :error (format "Junk at end of expression: %s"
2709 (buffer-substring (point)
2712 (error (widget-put widget :error (error-message-string data))
2715 (defvar widget-sexp-prompt-value-history nil
2716 "History of input to `widget-sexp-prompt-value'.")
2718 (defun widget-sexp-prompt-value (widget prompt value unbound)
2719 ;; Read an arbitrary sexp.
2720 (let ((found (read-string prompt
2721 (if unbound nil (cons (prin1-to-string value) 0))
2722 (widget-get widget :prompt-history))))
2724 (let ((buffer (set-buffer (get-buffer-create " *Widget Scratch*"))))
2727 (goto-char (point-min))
2728 (let ((answer (read buffer)))
2730 (error "Junk at end of expression: %s"
2731 (buffer-substring (point) (point-max))))
2734 (define-widget 'integer 'sexp
2738 :type-error "This field should contain an integer"
2739 :value-to-internal (lambda (widget value)
2740 (if (integerp value)
2741 (prin1-to-string value)
2743 :match (lambda (widget value) (integerp value)))
2745 (define-widget 'character 'editable-field
2750 :format "%{%t%}: %v\n"
2751 :valid-regexp "\\`.\\'"
2752 :error "This field should contain a single character"
2753 :value-to-internal (lambda (widget value)
2756 (char-to-string value)))
2757 :value-to-external (lambda (widget value)
2761 :match (lambda (widget value)
2762 (if (fboundp 'characterp)
2766 (define-widget 'number 'sexp
2767 "A floating point number."
2770 :type-error "This field should contain a number"
2771 :value-to-internal (lambda (widget value)
2773 (prin1-to-string value)
2775 :match (lambda (widget value) (numberp value)))
2777 (define-widget 'list 'group
2780 :format "%{%t%}:\n%v")
2782 (define-widget 'vector 'group
2785 :format "%{%t%}:\n%v"
2786 :match 'widget-vector-match
2787 :value-to-internal (lambda (widget value) (append value nil))
2788 :value-to-external (lambda (widget value) (apply 'vector value)))
2790 (defun widget-vector-match (widget value)
2791 (and (vectorp value)
2792 (widget-group-match widget
2793 (widget-apply widget :value-to-internal value))))
2795 (define-widget 'cons 'group
2798 :format "%{%t%}:\n%v"
2799 :match 'widget-cons-match
2800 :value-to-internal (lambda (widget value)
2801 (list (car value) (cdr value)))
2802 :value-to-external (lambda (widget value)
2803 (cons (nth 0 value) (nth 1 value))))
2805 (defun widget-cons-match (widget value)
2807 (widget-group-match widget
2808 (widget-apply widget :value-to-internal value))))
2810 (define-widget 'choice 'menu-choice
2811 "A union of several sexp types."
2813 :format "%[%t%]: %v"
2814 :prompt-value 'widget-choice-prompt-value)
2816 (defun widget-choice-prompt-value (widget prompt value unbound)
2818 (let ((args (widget-get widget :args))
2819 (completion-ignore-case (widget-get widget :case-fold))
2820 current choices old)
2821 ;; Find the first arg that match VALUE.
2824 (if (widget-apply (car look) :match value)
2825 (setq old (car look)
2827 (setq look (cdr look)))))
2830 (cond ((= (length args) 0)
2832 ((= (length args) 1)
2834 ((and (= (length args) 2)
2836 (if (eq old (nth 0 args))
2841 (setq current (car args)
2844 (cons (cons (widget-apply current :menu-tag-get)
2847 (let ((val (completing-read prompt choices nil t)))
2849 (let ((try (try-completion val choices)))
2852 (cdr (assoc val choices)))
2855 (widget-prompt-value current prompt nil t)
2858 (define-widget 'radio 'radio-button-choice
2859 "A union of several sexp types."
2861 :format "%{%t%}:\n%v"
2862 :prompt-value 'widget-choice-prompt-value)
2864 (define-widget 'repeat 'editable-list
2865 "A variable length homogeneous list."
2867 :format "%{%t%}:\n%v%i\n")
2869 (define-widget 'set 'checklist
2870 "A list of members from a fixed set."
2872 :format "%{%t%}:\n%v")
2874 (define-widget 'boolean 'toggle
2875 "To be nil or non-nil, that is the question."
2877 :prompt-value 'widget-boolean-prompt-value
2878 :format "%[%t%]: %v\n")
2880 (defun widget-boolean-prompt-value (widget prompt value unbound)
2881 ;; Toggle a boolean.
2884 ;;; The `color' Widget.
2886 (define-widget 'color-item 'choice-item
2887 "A color name (with sample)."
2888 :format "%v (%{sample%})\n"
2889 :sample-face-get 'widget-color-item-button-face-get)
2891 (defun widget-color-item-button-face-get (widget)
2892 (let ((symbol (intern (concat "fg:" (widget-value widget)))))
2893 (if (string-match "XEmacs" emacs-version)
2895 (or (find-face symbol)
2896 (set-face-foreground (make-face symbol) (widget-value widget))))
2898 (facemenu-get-face symbol)
2899 (error 'default)))))
2901 (define-widget 'color 'push-button
2902 "Choose a color name (with sample)."
2903 :format "%[%t%]: %v"
2906 :value-create 'widget-color-value-create
2907 :value-delete 'widget-children-value-delete
2908 :value-get 'widget-color-value-get
2909 :value-set 'widget-color-value-set
2910 :action 'widget-color-action
2911 :match 'widget-field-match
2914 (defvar widget-color-choice-list nil)
2915 ;; Variable holding the possible colors.
2917 (defun widget-color-choice-list ()
2918 (unless widget-color-choice-list
2919 (setq widget-color-choice-list
2920 (mapcar '(lambda (color) (list color))
2921 (x-defined-colors))))
2922 widget-color-choice-list)
2924 (defun widget-color-value-create (widget)
2925 (let ((child (widget-create-child-and-convert
2926 widget 'color-item (widget-get widget :value))))
2927 (widget-put widget :children (list child))))
2929 (defun widget-color-value-get (widget)
2930 ;; Pass command to first child.
2931 (widget-apply (car (widget-get widget :children)) :value-get))
2933 (defun widget-color-value-set (widget value)
2934 ;; Pass command to first child.
2935 (widget-apply (car (widget-get widget :children)) :value-set value))
2937 (defvar widget-color-history nil
2938 "History of entered colors")
2940 (defun widget-color-action (widget &optional event)
2941 ;; Prompt for a color.
2942 (let* ((tag (widget-apply widget :menu-tag-get))
2943 (prompt (concat tag ": "))
2944 (answer (cond ((string-match "XEmacs" emacs-version)
2945 (read-color prompt))
2946 ((fboundp 'x-defined-colors)
2947 (completing-read (concat tag ": ")
2948 (widget-color-choice-list)
2949 nil nil nil 'widget-color-history))
2951 (read-string prompt (widget-value widget))))))
2952 (unless (zerop (length answer))
2953 (widget-value-set widget answer)
2955 (widget-apply widget :notify widget event))))
2959 (defun widget-echo-help-mouse ()
2960 "Display the help message for the widget under the mouse.
2961 Enable with (run-with-idle-timer 1 t 'widget-echo-help-mouse)"
2962 (let* ((pos (mouse-position))
2966 (win (window-at x y frame))
2967 (where (coordinates-in-window-p (cons x y) win)))
2969 (save-window-excursion
2970 (progn ; save-excursion
2972 (let* ((result (compute-motion (window-start win)
2977 (cons (window-hscroll) 0)
2979 (when (and (eq (nth 1 result) x)
2980 (eq (nth 2 result) y))
2981 (widget-echo-help (nth 0 result))))))))
2983 (setq track-mouse t)
2984 (add-hook 'post-command-hook 'widget-stop-mouse-tracking)))
2986 (defun widget-stop-mouse-tracking (&rest args)
2987 "Stop the mouse tracking done while idle."
2988 (remove-hook 'post-command-hook 'widget-stop-mouse-tracking)
2989 (setq track-mouse nil))
2991 (defun widget-at (pos)
2992 "The button or field at POS."
2993 (or (get-char-property pos 'button)
2994 (get-char-property pos 'field)))
2996 (defun widget-echo-help (pos)
2997 "Display the help echo for widget at POS."
2998 (let* ((widget (widget-at pos))
2999 (help-echo (and widget (widget-get widget :help-echo))))
3000 (cond ((stringp help-echo)
3001 (message "%s" help-echo))
3002 ((and (symbolp help-echo) (fboundp help-echo)
3003 (stringp (setq help-echo (funcall help-echo widget))))
3004 (message "%s" help-echo)))))
3010 ;; wid-edit.el ends here