;;; wid-edit.el --- Functions for creating and using widgets -*-byte-compile-dynamic: t;-*-
;;
-;; Copyright (C) 1996, 1997, 1999, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Maintainer: FSF
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
+;;; Wishlist items (from widget.texi):
+
+;; * The `menu-choice' tag should be prettier, something like the
+;; abbreviated menus in Open Look.
+
+;; * Finish `:tab-order'.
+
+;; * Make indentation work with glyphs and proportional fonts.
+
+;; * Add commands to show overview of object and class hierarchies to
+;; the browser.
+
+;; * Find a way to disable mouse highlight for inactive widgets.
+
+;; * Find a way to make glyphs look inactive.
+
+;; * Add `key-binding' widget.
+
+;; * Add `widget' widget for editing widget specifications.
+
+;; * Find clean way to implement variable length list. See
+;; `TeX-printer-list' for an explanation.
+
+;; * `C-h' in `widget-prompt-value' should give type specific help.
+
+;; * A mailto widget. [This should work OK as a url-link if with
+;; browse-url-browser-function' set up appropriately.]
+
;;; Commentary:
;;
;; See `widget.el'.
:type 'face
:group 'widget-faces)
-(defface widget-field-face '((((class grayscale color)
+;; TTY gets special definitions here and in the next defface, because
+;; the gray colors defined for other displays cause black text on a black
+;; background, at least on light-background TTYs.
+(defface widget-field-face '((((type tty))
+ (:background "yellow3"))
+ (((class grayscale color)
(background light))
(:background "gray85"))
(((class grayscale color)
"Face used for editable fields."
:group 'widget-faces)
-(defface widget-single-line-field-face '((((class grayscale color)
+(defface widget-single-line-field-face '((((type tty))
+ (:background "green3"))
+ (((class grayscale color)
(background light))
(:background "gray85"))
(((class grayscale color)
`widget-menu-max-size', a popup menu will be used, otherwise the
minibuffer."
(cond ((and (< (length items) widget-menu-max-size)
- event (fboundp 'x-popup-menu) window-system)
- ;; We are in Emacs-19, pressed by the mouse
+ event (display-popup-menus-p))
+ ;; Mouse click.
(x-popup-menu event
(list title (cons "" items))))
((or widget-menu-minibuffer-flag
(t
;; Construct a menu of the choices
;; and then use it for prompting for a single character.
- (let* ((overriding-terminal-local-map
- (make-sparse-keymap))
- map choice (next-digit ?0)
- some-choice-enabled
- value)
+ (let* ((overriding-terminal-local-map (make-sparse-keymap))
+ (next-digit ?0)
+ map choice some-choice-enabled value)
;; Define SPC as a prefix char to get to this menu.
(define-key overriding-terminal-local-map " "
(setq map (make-sparse-keymap title)))
;; that corresponds to it.
(save-window-excursion
(let ((buf (get-buffer " widget-choose")))
- (display-buffer buf)
+ (fit-window-to-buffer (display-buffer buf))
(let ((cursor-in-echo-area t)
keys
(char 0)
(widget-field-add-space
(insert-and-inherit " ")))
(setq to (point)))
- (let ((map (widget-get widget :keymap))
+ (let ((keymap (widget-get widget :keymap))
(face (or (widget-get widget :value-face) 'widget-field-face))
(help-echo (widget-get widget :help-echo))
- (overlay (make-overlay from to nil
- nil (or (not widget-field-add-space)
- (widget-get widget :size)))))
- (widget-put widget :field-overlay overlay)
- ;;(overlay-put overlay 'detachable nil)
- (overlay-put overlay 'field widget)
- (overlay-put overlay 'keymap map)
- (overlay-put overlay 'face face)
- ;;(overlay-put overlay 'balloon-help help-echo)
- (if (stringp help-echo)
- (overlay-put overlay 'help-echo help-echo)))
+ (rear-sticky
+ (or (not widget-field-add-space) (widget-get widget :size))))
+ (if (functionp help-echo)
+ (setq help-echo 'widget-mouse-help))
+ (when (= (char-before to) ?\n)
+ ;; When the last character in the field is a newline, we want to
+ ;; give it a `field' char-property of `boundary', which helps the
+ ;; C-n/C-p act more naturally when entering/leaving the field. We
+ ;; do this by making a small secondary overlay to contain just that
+ ;; one character.
+ (let ((overlay (make-overlay (1- to) to nil t nil)))
+ (overlay-put overlay 'field 'boundary)
+ ;; Use `local-map' here, not `keymap', so that normal editing
+ ;; works in the field when, say, Custom uses `suppress-keymap'.
+ (overlay-put overlay 'local-map keymap)
+ (overlay-put overlay 'face face)
+ (overlay-put overlay 'help-echo help-echo))
+ (setq to (1- to))
+ (setq rear-sticky t))
+ (let ((overlay (make-overlay from to nil nil rear-sticky)))
+ (widget-put widget :field-overlay overlay)
+ ;;(overlay-put overlay 'detachable nil)
+ (overlay-put overlay 'field widget)
+ (overlay-put overlay 'local-map keymap)
+ (overlay-put overlay 'face face)
+ (overlay-put overlay 'help-echo help-echo)))
(widget-specify-secret widget))
(defun widget-specify-secret (field)
(defun widget-specify-button (widget from to)
"Specify button for WIDGET between FROM and TO."
- (let ((face (widget-apply widget :button-face-get))
- (help-echo (widget-get widget :help-echo))
- (overlay (make-overlay from to nil t nil)))
+ (let ((overlay (make-overlay from to nil t nil))
+ (help-echo (widget-get widget :help-echo)))
(widget-put widget :button-overlay overlay)
+ (if (functionp help-echo)
+ (setq help-echo 'widget-mouse-help))
(overlay-put overlay 'button widget)
+ (overlay-put overlay 'keymap (widget-get widget :keymap))
;; We want to avoid the face with image buttons.
(unless (widget-get widget :suppress-face)
- (overlay-put overlay 'face face)
+ (overlay-put overlay 'face (widget-apply widget :button-face-get))
(overlay-put overlay 'mouse-face widget-mouse-face))
- ;;(overlay-put overlay 'balloon-help help-echo)
- (if (stringp help-echo)
- (overlay-put overlay 'help-echo help-echo))))
+ (overlay-put overlay 'help-echo help-echo)))
+
+(defun widget-mouse-help (window overlay point)
+ "Help-echo callback for widgets whose :help-echo is a function."
+ (with-current-buffer (overlay-buffer overlay)
+ (let* ((widget (widget-at (overlay-start overlay)))
+ (help-echo (if widget (widget-get widget :help-echo))))
+ (if (functionp help-echo)
+ (funcall help-echo widget)
+ help-echo))))
(defun widget-specify-sample (widget from to)
"Specify sample for WIDGET between FROM and TO."
- (let ((face (widget-apply widget :sample-face-get))
- (overlay (make-overlay from to nil t nil)))
- (overlay-put overlay 'face face)
+ (let ((overlay (make-overlay from to nil t nil)))
+ (overlay-put overlay 'face (widget-apply widget :sample-face-get))
(widget-put widget :sample-overlay overlay)))
(defun widget-specify-doc (widget from to)
"Execute FORM without inheriting any text properties."
`(save-restriction
(let ((inhibit-read-only t)
- result
- before-change-functions
- after-change-functions)
+ (inhibit-modification-hooks t)
+ result)
(insert "<>")
(narrow-to-region (- (point) 2) (point))
(goto-char (1+ (point-min)))
(defun widget-member (widget property)
"Non-nil iff there is a definition in WIDGET for PROPERTY."
- (cond ((widget-plist-member (cdr widget) property)
+ (cond ((plist-member (cdr widget) property)
t)
((car widget)
(widget-member (get (car widget) 'widget-type) property))
(defun widget-get-sibling (widget)
"Get the item WIDGET is assumed to toggle.
This is only meaningful for radio buttons or checkboxes in a list."
- (let* ((parent (widget-get widget :parent))
- (children (widget-get parent :children))
+ (let* ((children (widget-get (widget-get widget :parent) :children))
child)
(catch 'child
(while children
((stringp image)
;; A string. Look it up in relevant directories.
(let* ((load-path (cons widget-image-directory load-path))
- (formats widget-image-conversion)
specs)
(dolist (elt widget-image-conversion)
(dolist (ext (cdr elt))
(keys args))
;; First set the :args keyword.
(while (cdr current) ;Look in the type.
- (let ((next (car (cdr current))))
- (if (keywordp next)
- (setq current (cdr (cdr current)))
- (setcdr current (list :args (cdr current)))
- (setq current nil))))
+ (if (keywordp (car (cdr current)))
+ (setq current (cdr (cdr current)))
+ (setcdr current (list :args (cdr current)))
+ (setq current nil)))
(while args ;Look in the args.
- (let ((next (nth 0 args)))
- (if (keywordp next)
- (setq args (nthcdr 2 args))
- (widget-put widget :args args)
- (setq args nil))))
+ (if (keywordp (nth 0 args))
+ (setq args (nthcdr 2 args))
+ (widget-put widget :args args)
+ (setq args nil)))
;; Then Convert the widget.
(setq type widget)
(while type
(setq keys nil))))
;; Convert the :value to internal format.
(if (widget-member widget :value)
- (let ((value (widget-get widget :value)))
- (widget-put widget
- :value (widget-apply widget :value-to-internal value))))
+ (widget-put widget
+ :value (widget-apply widget
+ :value-to-internal
+ (widget-get widget :value))))
;; Return the newly create widget.
widget))
(defun widget-insert (&rest args)
- "Call `insert' with ARGS and make the text read only."
+ "Call `insert' with ARGS even if surrounding text is read only."
(let ((inhibit-read-only t)
- before-change-functions
- after-change-functions
- (from (point)))
+ (inhibit-modification-hooks t))
(apply 'insert args)))
(defun widget-convert-text (type from to
(defun widget-leave-text (widget)
"Remove markers and overlays from WIDGET and its children."
- (let ((from (widget-get widget :from))
- (to (widget-get widget :to))
- (button (widget-get widget :button-overlay))
+ (let ((button (widget-get widget :button-overlay))
(sample (widget-get widget :sample-overlay))
(doc (widget-get widget :doc-overlay))
- (field (widget-get widget :field-overlay))
- (children (widget-get widget :children)))
- (set-marker from nil)
- (set-marker to nil)
+ (field (widget-get widget :field-overlay)))
+ (set-marker (widget-get widget :from) nil)
+ (set-marker (widget-get widget :to) nil)
(when button
(delete-overlay button))
(when sample
(delete-overlay doc))
(when field
(delete-overlay field))
- (mapc 'widget-leave-text children)))
+ (mapc 'widget-leave-text (widget-get widget :children))))
;;; Keymap and Commands.
Recommended as a parent keymap for modes using widgets.")
(defvar widget-global-map global-map
- "Keymap used for events the widget does not handle themselves.")
+ "Keymap used for events a widget does not handle itself.")
(make-variable-buffer-local 'widget-global-map)
(defvar widget-field-keymap
(let ((map (copy-keymap widget-keymap)))
- (define-key map [menu-bar] nil)
(define-key map "\C-k" 'widget-kill-line)
(define-key map "\M-\t" 'widget-complete)
(define-key map "\C-m" 'widget-field-activate)
- (define-key map "\C-a" 'widget-beginning-of-line)
+ ;; Since the widget code uses a `field' property to identify fields,
+ ;; ordinary beginning-of-line does the right thing.
+ ;; (define-key map "\C-a" 'widget-beginning-of-line)
(define-key map "\C-e" 'widget-end-of-line)
- (set-keymap-parent map global-map)
map)
"Keymap used inside an editable field.")
(defvar widget-text-keymap
(let ((map (copy-keymap widget-keymap)))
- (define-key map [menu-bar] 'nil)
- (define-key map "\C-a" 'widget-beginning-of-line)
+ ;; Since the widget code uses a `field' property to identify fields,
+ ;; ordinary beginning-of-line does the right thing.
+ ;; (define-key map "\C-a" 'widget-beginning-of-line)
(define-key map "\C-e" 'widget-end-of-line)
- (set-keymap-parent map global-map)
map)
"Keymap used inside a text field.")
(defun widget-field-activate (pos &optional event)
- "Invoke the ediable field at point."
+ "Invoke the editable field at point."
(interactive "@d")
- (let ((field (get-char-property pos 'field)))
+ (let ((field (widget-field-at pos)))
(if field
(widget-apply-action field event)
(call-interactively
(defun widget-button-click (event)
"Invoke the button that the mouse is pointing at."
- (interactive "@e")
+ (interactive "e")
(if (widget-event-point event)
- (save-excursion
- (mouse-set-point event)
- (let* ((pos (widget-event-point event))
- (button (get-char-property pos 'button)))
- (if button
- (let* ((overlay (widget-get button :button-overlay))
- (face (overlay-get overlay 'face))
- (mouse-face (overlay-get overlay 'mouse-face)))
- (unwind-protect
- (let ((track-mouse t))
- (save-excursion
- (when face ; avoid changing around image
- (overlay-put overlay
- 'face widget-button-pressed-face)
- (overlay-put overlay
- 'mouse-face widget-button-pressed-face))
- (unless (widget-apply button :mouse-down-action event)
- (while (not (widget-button-release-event-p event))
- (setq event (read-event)
- pos (widget-event-point event))
- (if (and pos
- (eq (get-char-property pos 'button)
- button))
- (when face
- (overlay-put overlay
- 'face
- widget-button-pressed-face)
- (overlay-put overlay
- 'mouse-face
- widget-button-pressed-face))
- (overlay-put overlay 'face face)
- (overlay-put overlay 'mouse-face mouse-face))))
- (when (and pos
- (eq (get-char-property pos 'button) button))
- (widget-apply-action button event))))
- (overlay-put overlay 'face face)
- (overlay-put overlay 'mouse-face mouse-face)))
- (let ((up t)
- command)
- ;; Find the global command to run, and check whether it
- ;; is bound to an up event.
+ (let* ((pos (widget-event-point event))
+ (start (event-start event))
+ (button (get-char-property
+ pos 'button (and (windowp (posn-window start))
+ (window-buffer (posn-window start))))))
+ (if button
+ ;; Mouse click on a widget button. Do the following
+ ;; in a save-excursion so that the click on the button
+ ;; doesn't change point.
+ (save-selected-window
+ (select-window (posn-window (event-start event)))
+ (save-excursion
+ (goto-char (posn-point (event-start event)))
+ (let* ((overlay (widget-get button :button-overlay))
+ (face (overlay-get overlay 'face))
+ (mouse-face (overlay-get overlay 'mouse-face)))
+ (unwind-protect
+ ;; Read events, including mouse-movement events
+ ;; until we receive a release event. Highlight/
+ ;; unhighlight the button the mouse was initially
+ ;; on when we move over it.
+ (let ((track-mouse t))
+ (save-excursion
+ (when face ; avoid changing around image
+ (overlay-put overlay
+ 'face widget-button-pressed-face)
+ (overlay-put overlay
+ 'mouse-face widget-button-pressed-face))
+ (unless (widget-apply button :mouse-down-action event)
+ (while (not (widget-button-release-event-p event))
+ (setq event (read-event)
+ pos (widget-event-point event))
+ (if (and pos
+ (eq (get-char-property pos 'button)
+ button))
+ (when face
+ (overlay-put overlay
+ 'face
+ widget-button-pressed-face)
+ (overlay-put overlay
+ 'mouse-face
+ widget-button-pressed-face))
+ (overlay-put overlay 'face face)
+ (overlay-put overlay 'mouse-face mouse-face))))
+
+ ;; When mouse is released over the button, run
+ ;; its action function.
+ (when (and pos
+ (eq (get-char-property pos 'button) button))
+ (widget-apply-action button event))))
+ (overlay-put overlay 'face face)
+ (overlay-put overlay 'mouse-face mouse-face))))
+
+ (unless (pos-visible-in-window-p (widget-event-point event))
+ (mouse-set-point event)
+ (beginning-of-line)
+ (recenter))
+ )
+
+ (let ((up t) command)
+ ;; Mouse click not on a widget button. Find the global
+ ;; command to run, and check whether it is bound to an
+ ;; up event.
+ (mouse-set-point event)
(if (memq (event-basic-type event) '(mouse-1 down-mouse-1))
(cond ((setq command ;down event
(lookup-key widget-global-map [down-mouse-1]))
(setq event (read-event))))
(when command
(call-interactively command)))))
- (unless (pos-visible-in-window-p (widget-event-point event))
- (mouse-set-point event)
- (beginning-of-line)
- (recenter)))
(message "You clicked somewhere weird.")))
(defun widget-button-press (pos &optional event)
(defun widget-tabable-at (&optional pos)
"Return the tabable widget at POS, or nil.
POS defaults to the value of (point)."
- (unless pos
- (setq pos (point)))
- (let ((widget (or (get-char-property pos 'button)
- (get-char-property pos 'field))))
+ (let ((widget (widget-at pos)))
(if widget
(let ((order (widget-get widget :tab-order)))
(if order
(run-hooks 'widget-backward-hook)
(widget-move (- arg)))
-(defun widget-beginning-of-line ()
- "Go to beginning of field or beginning of line, whichever is first."
- (interactive)
- (let* ((field (widget-field-find (point)))
- (start (and field (widget-field-start field)))
- (bol (line-beginning-position)))
- (goto-char (if start
- (max start bol)
- bol))))
+;; Since the widget code uses a `field' property to identify fields,
+;; ordinary beginning-of-line does the right thing.
+(defalias 'widget-beginning-of-line 'beginning-of-line)
(defun widget-end-of-line ()
- "Go to end of field or end of line, whichever is first."
+ "Go to end of field or end of line, whichever is first.
+Trailing spaces at the end of padded fields are not considered part of
+the field."
(interactive)
- (let* ((field (widget-field-find (point)))
- (end (and field (widget-field-end field)))
- (eol (line-end-position)))
- (goto-char (if end
- (min end eol)
- eol))))
+ ;; Ordinary end-of-line does the right thing, because we're inside
+ ;; text with a `field' property.
+ (end-of-line)
+ (unless (eolp)
+ ;; ... except that we want to ignore trailing spaces in fields that
+ ;; aren't terminated by a newline, because they are used as padding,
+ ;; and ignored when extracting the entered value of the field.
+ (skip-chars-backward " " (field-beginning (1- (point))))))
(defun widget-kill-line ()
"Kill to end of field or end of line, whichever is first."
(interactive)
(let* ((field (widget-field-find (point)))
- (newline (save-excursion (forward-line 1) (point)))
(end (and field (widget-field-end field))))
- (if (and field (> newline end))
+ (if (and field (> (line-beginning-position 2) end))
(kill-region (point) end)
(call-interactively 'kill-line))))
;; List of all editable fields in the buffer.
(make-variable-buffer-local 'widget-field-list)
+(defun widget-at (&optional pos)
+ "The button or field at POS (default, point)."
+ (or (get-char-property (or pos (point)) 'button)
+ (widget-field-at pos)))
+
(defun widget-setup ()
"Setup current buffer so editing string widgets works."
(let ((inhibit-read-only t)
- (after-change-functions nil)
- before-change-functions
+ (inhibit-modification-hooks t)
field)
(while widget-field-new
(setq field (car widget-field-new)
;; The widget data before the change.
(make-variable-buffer-local 'widget-field-was)
+(defun widget-field-at (pos)
+ "Return the widget field at POS, or nil if none."
+ (let ((field (get-char-property (or pos (point)) 'field)))
+ (if (eq field 'boundary)
+ nil
+ field)))
+
(defun widget-field-buffer (widget)
"Return the start of WIDGET's editing field."
(let ((overlay (widget-get widget :field-overlay)))
- (and overlay (overlay-buffer overlay))))
+ (cond ((overlayp overlay)
+ (overlay-buffer overlay))
+ ((consp overlay)
+ (marker-buffer (car overlay))))))
(defun widget-field-start (widget)
"Return the start of WIDGET's editing field."
(let ((overlay (widget-get widget :field-overlay)))
- (and overlay (overlay-start overlay))))
+ (if (overlayp overlay)
+ (overlay-start overlay)
+ (car overlay))))
(defun widget-field-end (widget)
"Return the end of WIDGET's editing field."
(let ((overlay (widget-get widget :field-overlay)))
- ;; Don't subtract one if local-map works at the end of the overlay.
- (and overlay (if (or widget-field-add-space
- (null (widget-get widget :size)))
- (1- (overlay-end overlay))
- (overlay-end overlay)))))
+ ;; Don't subtract one if local-map works at the end of the overlay,
+ ;; or if a special `boundary' field has been added after the widget
+ ;; field.
+ (if (overlayp overlay)
+ (if (and (not (eq (get-char-property (overlay-end overlay)
+ 'field
+ (widget-field-buffer widget))
+ 'boundary))
+ (or widget-field-add-space
+ (null (widget-get widget :size))))
+ (1- (overlay-end overlay))
+ (overlay-end overlay))
+ (cdr overlay))))
(defun widget-field-find (pos)
"Return the field at POS.
(while fields
(setq field (car fields)
fields (cdr fields))
- (let ((start (widget-field-start field))
- (end (widget-field-end field)))
- (when (and (<= start pos) (<= pos end))
- (when found
- (debug "Overlapping fields"))
- (setq found field))))
+ (when (and (<= (widget-field-start field) pos)
+ (<= pos (widget-field-end field)))
+ (when found
+ (error "Overlapping fields"))
+ (setq found field)))
found))
(defun widget-before-change (from to)
(signal 'text-read-only
'("Attempt to change text outside editable field")))
(widget-field-use-before-change
- (condition-case nil
- (widget-apply from-field :notify from-field)
- (error (debug "Before Change"))))))))
+ (widget-apply from-field :notify from-field))))))
(defun widget-add-change ()
- (make-local-hook 'post-command-hook)
(remove-hook 'post-command-hook 'widget-add-change t)
- (make-local-hook 'before-change-functions)
(add-hook 'before-change-functions 'widget-before-change nil t)
- (make-local-hook 'after-change-functions)
(add-hook 'after-change-functions 'widget-after-change nil t))
(defun widget-after-change (from to old)
"Adjust field size and text properties."
- (condition-case nil
- (let ((field (widget-field-find from))
- (other (widget-field-find to)))
- (when field
- (unless (eq field other)
- (debug "Change in different fields"))
- (let ((size (widget-get field :size)))
- (when size
- (let ((begin (widget-field-start field))
- (end (widget-field-end field)))
- (cond ((< (- end begin) size)
- ;; Field too small.
- (save-excursion
- (goto-char end)
- (insert-char ?\ (- (+ begin size) end))))
- ((> (- end begin) size)
- ;; Field too large and
- (if (or (< (point) (+ begin size))
- (> (point) end))
- ;; Point is outside extra space.
- (setq begin (+ begin size))
- ;; Point is within the extra space.
- (setq begin (point)))
- (save-excursion
- (goto-char end)
- (while (and (eq (preceding-char) ?\ )
- (> (point) begin))
- (delete-backward-char 1)))))))
- (widget-specify-secret field))
- (widget-apply field :notify field)))
- (error (debug "After Change"))))
+ (let ((field (widget-field-find from))
+ (other (widget-field-find to)))
+ (when field
+ (unless (eq field other)
+ (error "Change in different fields"))
+ (let ((size (widget-get field :size)))
+ (when size
+ (let ((begin (widget-field-start field))
+ (end (widget-field-end field)))
+ (cond ((< (- end begin) size)
+ ;; Field too small.
+ (save-excursion
+ (goto-char end)
+ (insert-char ?\ (- (+ begin size) end))))
+ ((> (- end begin) size)
+ ;; Field too large and
+ (if (or (< (point) (+ begin size))
+ (> (point) end))
+ ;; Point is outside extra space.
+ (setq begin (+ begin size))
+ ;; Point is within the extra space.
+ (setq begin (point)))
+ (save-excursion
+ (goto-char end)
+ (while (and (eq (preceding-char) ?\ )
+ (> (point) begin))
+ (delete-backward-char 1)))))))
+ (widget-specify-secret field))
+ (widget-apply field :notify field))))
;;; Widget Functions
;;
found (widget-apply child :validate)))
found))
-(defun widget-types-convert-widget (widget)
+;; Made defsubst to speed up face editor creation.
+(defsubst widget-types-convert-widget (widget)
"Convert :args as widget types in WIDGET."
(widget-put widget :args (mapcar 'widget-convert (widget-get widget :args)))
widget)
(defun widget-default-complete (widget)
"Call the value of the :complete-function property of WIDGET.
If that does not exists, call the value of `widget-complete-field'."
- (let ((fun (widget-get widget :complete-function)))
- (call-interactively (or fun widget-complete-field))))
+ (call-interactively (or (widget-get widget :complete-function)
+ widget-complete-field)))
(defun widget-default-create (widget)
"Create WIDGET at point in the current buffer."
(goto-char from)
;; Parse escapes in format.
(while (re-search-forward "%\\(.\\)" nil t)
- (let ((escape (aref (match-string 1) 0)))
- (replace-match "" t t)
+ (let ((escape (char-after (match-beginning 1))))
+ (delete-backward-char 2)
(cond ((eq escape ?%)
(insert ?%))
((eq escape ?\[)
(when value-pos
(goto-char value-pos)
(widget-apply widget :value-create)))
- (let ((from (copy-marker (point-min)))
- (to (copy-marker (point-max))))
+ (let ((from (point-min-marker))
+ (to (point-max-marker)))
(set-marker-insertion-type from t)
(set-marker-insertion-type to nil)
(widget-put widget :from from)
(cond ((eq escape ?h)
(let* ((doc-property (widget-get widget :documentation-property))
(doc-try (cond ((widget-get widget :doc))
+ ((functionp doc-property)
+ (funcall doc-property
+ (widget-get widget :value)))
((symbolp doc-property)
(documentation-property
(widget-get widget :value)
- doc-property))
- (t
- (funcall doc-property
- (widget-get widget :value)))))
+ doc-property))))
(doc-text (and (stringp doc-try)
(> (length doc-try) 1)
doc-try))
(button-overlay (widget-get widget :button-overlay))
(sample-overlay (widget-get widget :sample-overlay))
(doc-overlay (widget-get widget :doc-overlay))
- before-change-functions
- after-change-functions
+ (inhibit-modification-hooks t)
(inhibit-read-only t))
(widget-apply widget :value-delete)
(when inactive-overlay
(defun widget-default-prompt-value (widget prompt value unbound)
"Read an arbitrary value. Stolen from `set-variable'."
;; (let ((initial (if unbound
-nil
+;; nil
;; It would be nice if we could do a `(cons val 1)' here.
;; (prin1-to-string (custom-quote value))))))
- (eval-minibuffer prompt ))
+ (eval-minibuffer prompt))
;;; The `item' Widget.
;;; The `push-button' Widget.
-(defcustom widget-push-button-gui t
- "If non nil, use GUI push buttons when available."
- :group 'widgets
- :type 'boolean)
+;; (defcustom widget-push-button-gui t
+;; "If non nil, use GUI push buttons when available."
+;; :group 'widgets
+;; :type 'boolean)
;; Cache already created GUI objects.
-(defvar widget-push-button-cache nil)
+;; (defvar widget-push-button-cache nil)
(defcustom widget-push-button-prefix "["
"String used as prefix for buttons."
(widget-get widget :value)))
(tag-glyph (widget-get widget :tag-glyph))
(text (concat widget-push-button-prefix
- tag widget-push-button-suffix))
- (gui (cdr (assoc tag widget-push-button-cache))))
- (cond (tag-glyph
- (widget-image-insert widget text tag-glyph))
- (t
- (insert text)))))
+ tag widget-push-button-suffix)))
+ (if tag-glyph
+ (widget-image-insert widget text tag-glyph)
+ (insert text))))
-(defun widget-gui-action (widget)
- "Apply :action for WIDGET."
- (widget-apply-action widget (this-command-keys)))
+;; (defun widget-gui-action (widget)
+;; "Apply :action for WIDGET."
+;; (widget-apply-action widget (this-command-keys)))
;;; The `link' Widget.
:convert-widget 'widget-value-convert-widget
:keymap widget-field-keymap
:format "%v"
+ :help-echo "M-TAB: complete field; RET: enter value"
:value ""
:prompt-internal 'widget-field-prompt-internal
:prompt-history 'widget-field-history
:action 'widget-field-action
:validate 'widget-field-validate
:valid-regexp ""
- :error "No match"
+ :error "Field's value doesn't match allowed forms"
:value-create 'widget-field-value-create
:value-delete 'widget-field-value-delete
:value-get 'widget-field-value-get
(defun widget-field-prompt-value (widget prompt value unbound)
"Prompt for a string."
- (let ((initial (if unbound
- nil
- (cons (widget-apply widget :value-to-internal
- value) 0)))
- (history (widget-get widget :prompt-history)))
- (let ((answer (widget-apply widget
- :prompt-internal prompt initial history)))
- (widget-apply widget :value-to-external answer))))
+ (widget-apply widget
+ :value-to-external
+ (widget-apply widget
+ :prompt-internal prompt
+ (unless unbound
+ (cons (widget-apply widget
+ :value-to-internal value)
+ 0))
+ (widget-get widget :prompt-history))))
(defvar widget-edit-functions nil)
(defun widget-field-validate (widget)
"Valid if the content matches `:valid-regexp'."
- (save-excursion
- (let ((value (widget-apply widget :value-get))
- (regexp (widget-get widget :valid-regexp)))
- (if (string-match regexp value)
- nil
- widget))))
+ (unless (string-match (widget-get widget :valid-regexp)
+ (widget-apply widget :value-get))
+ widget))
(defun widget-field-value-create (widget)
"Create an editable text field."
(defun widget-field-value-delete (widget)
"Remove the widget from the list of active editing fields."
(setq widget-field-list (delq widget widget-field-list))
+ (setq widget-field-new (delq widget widget-field-new))
;; These are nil if the :format string doesn't contain `%v'.
(let ((overlay (widget-get widget :field-overlay)))
- (when overlay
+ (when (overlayp overlay)
(delete-overlay overlay))))
(defun widget-field-value-get (widget)
;;; The `text' Widget.
(define-widget 'text 'editable-field
- :keymap widget-text-keymap
- "A multiline text area.")
+ "A multiline text area."
+ :keymap widget-text-keymap)
;;; The `menu-choice' Widget.
(let ((value (widget-get widget :value))
(args (widget-get widget :args))
(explicit (widget-get widget :explicit-choice))
- (explicit-value (widget-get widget :explicit-choice-value))
current)
- (if (and explicit (equal value explicit-value))
+ (if (and explicit (equal value (widget-get widget :explicit-choice-value)))
(progn
;; If the user specified the choice for this value,
;; respect that choice as long as the value is the same.
;; Return non-nil if we need a menu.
(let ((args (widget-get widget :args))
(old (widget-get widget :choice)))
- (cond ((not window-system)
+ (cond ((not (display-popup-menus-p))
;; No place to pop up a menu.
nil)
- ((not (or (fboundp 'x-popup-menu) (fboundp 'popup-menu)))
- ;; No way to pop up a menu.
- nil)
((< (length args) 2)
;; Empty or singleton list, just return the value.
nil)
(when this-explicit
(widget-put widget :explicit-choice current)
(widget-put widget :explicit-choice-value (widget-get widget :value)))
- (let ((value (widget-default-get current)))
- (widget-value-set widget
- (widget-apply current :value-to-external value)))
+ (widget-value-set
+ widget (widget-apply current
+ :value-to-external (widget-default-get current)))
(widget-setup)
(widget-apply widget :notify widget event)))
(run-hook-with-args 'widget-edit-functions widget))
(defun widget-choice-validate (widget)
;; Valid if we have made a valid choice.
- (let ((void (widget-get widget :void))
- (choice (widget-get widget :choice))
- (child (car (widget-get widget :children))))
- (if (eq void choice)
- widget
- (widget-apply child :validate))))
+ (if (eq (widget-get widget :void) (widget-get widget :choice))
+ widget
+ (widget-apply (car (widget-get widget :children)) :validate)))
(defun widget-choice-match (widget value)
;; Matches if one of the choices matches.
(defun widget-toggle-value-create (widget)
"Insert text representing the `on' and `off' states."
(if (widget-value widget)
- (widget-image-insert widget
- (widget-get widget :on)
- (widget-get widget :on-glyph))
+ (progn
+ (and (display-graphic-p)
+ (listp (widget-get widget :on-glyph))
+ (widget-put widget :on-glyph
+ (eval (widget-get widget :on-glyph))))
+ (widget-image-insert widget
+ (widget-get widget :on)
+ (widget-get widget :on-glyph)))
+ (and (display-graphic-p)
+ (listp (widget-get widget :off-glyph))
+ (widget-put widget :off-glyph
+ (eval (widget-get widget :off-glyph))))
(widget-image-insert widget
(widget-get widget :off)
(widget-get widget :off-glyph))))
;; We could probably do the same job as the images using single
;; space characters in a boxed face with a stretch specification to
;; make them square.
- :on-glyph (create-image (make-bool-vector 49 1)
- 'xbm t :width 7 :height 7
- :foreground "grey75" ; like default mode line
- :relief -3 :ascent 'center)
- :off "[ ]"
- :off-glyph (create-image (make-bool-vector 49 1)
+ :on-glyph '(create-image "\000\066\076\034\076\066\000"
'xbm t :width 7 :height 7
- :foreground "grey75"
- :relief 3 :ascent 'center)
+ :background "grey75" ; like default mode line
+ :foreground "black"
+ :relief -3
+ :ascent 'center)
+ :off "[ ]"
+ :off-glyph '(create-image (make-string 7 0)
+ 'xbm t :width 7 :height 7
+ :background "grey75"
+ :foreground "black"
+ :relief 3
+ :ascent 'center)
:help-echo "Toggle this item."
:action 'widget-checkbox-action)
:format "%v"
:offset 4
:entry-format "%b %v"
- :menu-tag "checklist"
:greedy nil
:value-create 'widget-checklist-value-create
:value-delete 'widget-children-value-delete
(goto-char from)
;; Parse % escapes in format.
(while (re-search-forward "%\\([bv%]\\)" nil t)
- (let ((escape (aref (match-string 1) 0)))
- (replace-match "" t t)
+ (let ((escape (char-after (match-beginning 1))))
+ (delete-backward-char 2)
(cond ((eq escape ?%)
(insert ?%))
((eq escape ?b)
:offset 4
:format "%v"
:entry-format "%b %v"
- :menu-tag "radio"
:value-create 'widget-radio-value-create
:value-delete 'widget-children-value-delete
:value-get 'widget-radio-value-get
(goto-char from)
;; Parse % escapes in format.
(while (re-search-forward "%\\([bv%]\\)" nil t)
- (let ((escape (aref (match-string 1) 0)))
- (replace-match "" t t)
+ (let ((escape (char-after (match-beginning 1))))
+ (delete-backward-char 2)
(cond ((eq escape ?%)
(insert ?%))
((eq escape ?b)
(while children
(setq current (car children)
children (cdr children))
- (let* ((button (widget-get current :button))
- (value (widget-apply button :value-get)))
- (when value
- (setq found current
- children nil))))
+ (when (widget-apply (widget-get current :button) :value-get)
+ (setq found current
+ children nil)))
found))
(defun widget-radio-value-inline (widget)
(while children
(setq current (car children)
children (cdr children))
- (let* ((button (widget-get current :button))
- (value (widget-apply button :value-get)))
- (when value
- (setq found (widget-apply current :value-inline)
- children nil))))
+ (when (widget-apply (widget-get current :button) :value-get)
+ (setq found (widget-apply current :value-inline)
+ children nil)))
found))
(defun widget-radio-value-set (widget value)
;;; The `editable-list' Widget.
-(defcustom widget-editable-list-gui nil
- "If non nil, use GUI push-buttons in editable list when available."
- :type 'boolean
- :group 'widgets)
+;; (defcustom widget-editable-list-gui nil
+;; "If non nil, use GUI push-buttons in editable list when available."
+;; :type 'boolean
+;; :group 'widgets)
(define-widget 'editable-list 'default
"A variable list of widgets of the same type."
:format "%v%i\n"
:format-handler 'widget-editable-list-format-handler
:entry-format "%i %d %v"
- :menu-tag "editable-list"
:value-create 'widget-editable-list-value-create
:value-delete 'widget-children-value-delete
:value-get 'widget-editable-list-value-get
(defun widget-editable-list-format-handler (widget escape)
;; We recognize the insert button.
- (let ((widget-push-button-gui widget-editable-list-gui))
+;;; (let ((widget-push-button-gui widget-editable-list-gui))
(cond ((eq escape ?i)
(and (widget-get widget :indent)
- (insert-char ? (widget-get widget :indent)))
+ (insert-char ?\ (widget-get widget :indent)))
(apply 'widget-create-child-and-convert
widget 'insert-button
(widget-get widget :append-button-args)))
(t
- (widget-default-format-handler widget escape)))))
+ (widget-default-format-handler widget escape)))
+;;; )
+ )
(defun widget-editable-list-value-create (widget)
;; Insert all values
(let* ((value (widget-get widget :value))
(type (nth 0 (widget-get widget :args)))
- (inlinep (widget-get type :inline))
children)
(widget-put widget :value-pos (copy-marker (point)))
(set-marker-insertion-type (widget-get widget :value-pos) t)
(if answer
(setq children (cons (widget-editable-list-entry-create
widget
- (if inlinep
+ (if (widget-get type :inline)
(car answer)
(car (car answer)))
t)
(defun widget-editable-list-entry-create (widget value conv)
;; Create a new entry to the list.
(let ((type (nth 0 (widget-get widget :args)))
- (widget-push-button-gui widget-editable-list-gui)
+;;; (widget-push-button-gui widget-editable-list-gui)
child delete insert)
(widget-specify-insert
(save-excursion
(and (widget-get widget :indent)
- (insert-char ? (widget-get widget :indent)))
+ (insert-char ?\ (widget-get widget :indent)))
(insert (widget-get widget :entry-format)))
;; Parse % escapes in format.
(while (re-search-forward "%\\(.\\)" nil t)
- (let ((escape (aref (match-string 1) 0)))
- (replace-match "" t t)
+ (let ((escape (char-after (match-beginning 1))))
+ (delete-backward-char 2)
(cond ((eq escape ?%)
(insert ?%))
((eq escape ?i)
:buttons (cons delete
(cons insert
(widget-get widget :buttons))))
- (let ((entry-from (copy-marker (point-min)))
- (entry-to (copy-marker (point-max))))
+ (let ((entry-from (point-min-marker))
+ (entry-to (point-max-marker)))
(set-marker-insertion-type entry-from t)
(set-marker-insertion-type entry-to nil)
(widget-put child :entry-from entry-from)
value (cdr answer))
(and (eq (preceding-char) ?\n)
(widget-get widget :indent)
- (insert-char ? (widget-get widget :indent)))
+ (insert-char ?\ (widget-get widget :indent)))
(push (cond ((null answer)
(widget-create-child widget arg))
((widget-get arg :inline)
- (widget-create-child-value widget arg (car answer)))
+ (widget-create-child-value widget arg (car answer)))
(t
- (widget-create-child-value widget arg (car (car answer)))))
+ (widget-create-child-value widget arg (car (car answer)))))
children))
(widget-put widget :children (nreverse children))))
(widget-specify-doc widget from to)
(when widget-documentation-links
(let ((regexp widget-documentation-link-regexp)
- (predicate widget-documentation-link-p)
- (type widget-documentation-link-type)
(buttons (widget-get widget :buttons))
(widget-mouse-face (default-value 'widget-mouse-face))
(widget-button-face widget-documentation-face)
(let ((name (match-string 1))
(begin (match-beginning 1))
(end (match-end 1)))
- (when (funcall predicate name)
- (push (widget-convert-button type begin end :value name)
+ (when (funcall widget-documentation-link-p name)
+ (push (widget-convert-button widget-documentation-link-type
+ begin end :value name)
buttons)))))
(widget-put widget :buttons buttons)))
(let ((indent (widget-get widget :indent)))
(if (string-match "\n" doc)
(let ((before (substring doc 0 (match-beginning 0)))
(after (substring doc (match-beginning 0)))
- buttons)
+ button)
(insert before ?\ )
(widget-documentation-link-add widget start (point))
- (push (widget-create-child-and-convert
+ (setq button
+ (widget-create-child-and-convert
widget 'visibility
:help-echo "Show or hide rest of the documentation."
:off "More"
:always-active t
:action 'widget-parent-action
- shown)
- buttons)
+ shown))
(when shown
(setq start (point))
(when (and indent (not (zerop indent)))
(insert-char ?\ indent))
(insert after)
(widget-documentation-link-add widget start (point)))
- (widget-put widget :buttons buttons))
+ (widget-put widget :buttons (list button)))
(insert doc)
(widget-documentation-link-add widget start (point))))
(insert ?\n))
(defun widget-regexp-validate (widget)
"Check that the value of WIDGET is a valid regexp."
- (let ((val (widget-value widget)))
- (condition-case data
- (prog1 nil
- (string-match val ""))
- (error (widget-put widget :error (error-message-string data))
- widget))))
+ (condition-case data
+ (prog1 nil
+ (string-match (widget-value widget) ""))
+ (error (widget-put widget :error (error-message-string data))
+ widget)))
(define-widget 'file 'string
"A file widget.
(insert (expand-file-name completion directory)))
(t
(message "Making completion list...")
- (let ((list (file-name-all-completions name-part directory)))
- (setq list (sort list 'string<))
- (with-output-to-temp-buffer "*Completions*"
- (display-completion-list list)))
+ (with-output-to-temp-buffer "*Completions*"
+ (display-completion-list
+ (sort (file-name-all-completions name-part directory)
+ 'string<)))
(message "Making completion list...%s" "done")))))
(defun widget-file-prompt-value (widget prompt value unbound)
;;; (widget-setup)
;;; (widget-apply widget :notify widget event)))
+;; Fixme: use file-name-as-directory.
(define-widget 'directory 'file
"A directory widget.
It will read a directory name from the minibuffer when invoked."
(define-widget 'function 'sexp
"A Lisp function."
- :complete-function 'lisp-complete-symbol
+ :complete-function (lambda ()
+ (interactive)
+ (lisp-complete-symbol 'fboundp))
:prompt-value 'widget-field-prompt-value
:prompt-internal 'widget-symbol-prompt-internal
:prompt-match 'fboundp
:prompt-history 'widget-function-prompt-value-history
:action 'widget-field-action
+ :match-alternatives '(functionp)
+ :validate (lambda (widget)
+ (unless (functionp (widget-value widget))
+ (widget-put widget :error (format "Invalid function: %S"
+ (widget-value widget)))
+ widget))
+ :value 'ignore
:tag "Function")
(defvar widget-variable-prompt-value-history nil
"History of input to `widget-variable-prompt-value'.")
(define-widget 'variable 'symbol
- ;; Should complete on variables.
"A Lisp variable."
:prompt-match 'boundp
:prompt-history 'widget-variable-prompt-value-history
+ :complete-function (lambda ()
+ (interactive)
+ (lisp-complete-symbol 'boundp))
:tag "Variable")
(defvar widget-coding-system-prompt-value-history nil
"A MULE coding-system."
:format "%{%t%}: %v"
:tag "Coding system"
+ :base-only nil
:prompt-history 'widget-coding-system-prompt-value-history
:prompt-value 'widget-coding-system-prompt-value
- :action 'widget-coding-system-action)
-
+ :action 'widget-coding-system-action
+ :complete-function (lambda ()
+ (interactive)
+ (lisp-complete-symbol 'coding-system-p))
+ :validate (lambda (widget)
+ (unless (coding-system-p (widget-value widget))
+ (widget-put widget :error (format "Invalid coding system: %S"
+ (widget-value widget)))
+ widget))
+ :value 'undecided
+ :prompt-match 'coding-system-p)
+
(defun widget-coding-system-prompt-value (widget prompt value unbound)
- ;; Read coding-system from minibuffer.
- (intern
- (completing-read (format "%s (default %s) " prompt value)
- (mapcar (lambda (sym)
- (list (symbol-name sym)))
- (coding-system-list)))))
+ "Read coding-system from minibuffer."
+ (if (widget-get widget :base-only)
+ (intern
+ (completing-read (format "%s (default %s) " prompt value)
+ (mapcar #'list (coding-system-list t)) nil nil nil
+ coding-system-history))
+ (read-coding-system (format "%s (default %s) " prompt value) value)))
(defun widget-coding-system-action (widget &optional event)
- ;; Read a file name from the minibuffer.
(let ((answer
(widget-coding-system-prompt-value
widget
(with-temp-buffer
(insert (widget-apply widget :value-get))
(goto-char (point-min))
- (condition-case data
- (progn
- ;; Avoid a confusing end-of-file error.
- (skip-syntax-forward "\\s-")
- (if (eobp)
- (error "Empty sexp -- use `nil'?"))
- (let ((value (read (current-buffer))))
+ (let (err)
+ (condition-case data
+ (progn
+ ;; Avoid a confusing end-of-file error.
+ (skip-syntax-forward "\\s-")
(if (eobp)
- (if (widget-apply widget :match value)
- nil
- (widget-put widget :error (widget-get widget :type-error))
- widget)
- (widget-put widget
- :error (format "Junk at end of expression: %s"
- (buffer-substring (point)
- (point-max))))
- widget)))
- (end-of-file ; Avoid confusing error message.
- (widget-put widget :error "Unbalanced sexp")
- widget)
- (error (widget-put widget :error (error-message-string data))
- widget))))
+ (setq err "Empty sexp -- use `nil'?")
+ (unless (widget-apply widget :match (read (current-buffer)))
+ (setq err (widget-get widget :type-error))))
+ (if (and (not (eobp))
+ (not err))
+ (setq err (format "Junk at end of expression: %s"
+ (buffer-substring (point)
+ (point-max))))))
+ (end-of-file ; Avoid confusing error message.
+ (setq err "Unbalanced sexp"))
+ (error (setq err (error-message-string data))))
+ (if (not err)
+ nil
+ (widget-put widget :error err)
+ widget))))
(defvar widget-sexp-prompt-value-history nil
"History of input to `widget-sexp-prompt-value'.")
(defun widget-plist-convert-widget (widget)
;; Handle `:options'.
(let* ((options (widget-get widget :options))
- (key-type (widget-get widget :key-type))
(widget-plist-value-type (widget-get widget :value-type))
(other `(editable-list :inline t
(group :inline t
- ,key-type
+ ,(widget-get widget :key-type)
,widget-plist-value-type)))
(args (if options
(list `(checklist :inline t
(defun widget-alist-convert-widget (widget)
;; Handle `:options'.
(let* ((options (widget-get widget :options))
- (key-type (widget-get widget :key-type))
(widget-alist-value-type (widget-get widget :value-type))
(other `(editable-list :inline t
(cons :format "%v"
- ,key-type
+ ,(widget-get widget :key-type)
,widget-alist-value-type)))
(args (if options
(list `(checklist :inline t
(let ((args (widget-get widget :args))
(completion-ignore-case (widget-get widget :case-fold))
current choices old)
- ;; Find the first arg that match VALUE.
+ ;; Find the first arg that matches VALUE.
(let ((look args))
(while look
(if (widget-apply (car look) :match value)
\f
;;; The `color' Widget.
+;; Fixme: match
(define-widget 'color 'editable-field
"Choose a color name (with sample)."
:format "%t: %v (%{sample%})\n"
(insert-and-inherit (substring completion (length prefix))))
(t
(message "Making completion list...")
- (let ((list (all-completions prefix list nil)))
- (with-output-to-temp-buffer "*Completions*"
- (display-completion-list list)))
+ (with-output-to-temp-buffer "*Completions*"
+ (display-completion-list (all-completions prefix list nil)))
(message "Making completion list...done")))))
(defun widget-color-sample-face-get (widget)
(let* ((value (condition-case nil
(widget-value widget)
- (error (widget-get widget :value))))
- (symbol (intern (concat "fg:" value))))
- (condition-case nil
- (facemenu-get-face symbol)
- (error 'default))))
+ (error (widget-get widget :value)))))
+ (if (color-defined-p value)
+ (list (cons 'foreground-color value))
+ 'default)))
(defun widget-color-action (widget &optional event)
- ;; Prompt for a color.
+ "Prompt for a color."
(let* ((tag (widget-apply widget :menu-tag-get))
(prompt (concat tag ": "))
(value (widget-value widget))
\f
;;; The Help Echo
-(defun widget-at (pos)
- "The button or field at POS."
- (or (get-char-property pos 'button)
- (get-char-property pos 'field)))
-
(defun widget-echo-help (pos)
- "Display the help echo for widget at POS."
+ "Display help-echo text for widget at POS."
(let* ((widget (widget-at pos))
(help-echo (and widget (widget-get widget :help-echo))))
- (if (or (stringp help-echo)
- (and (symbolp help-echo) (fboundp help-echo)
- (stringp (setq help-echo (funcall help-echo widget)))))
+ (if (functionp help-echo)
+ (setq help-echo (funcall help-echo widget)))
+ (if (stringp help-echo)
(message "%s" help-echo))))
;;; The End:
(provide 'wid-edit)
-;; wid-edit.el ends here
+;;; wid-edit.el ends here
HCoop / bpt / emacs.git / blobdiff