wid-edit.el 118 KB
Newer Older
1
;;; wid-edit.el --- Functions for creating and using widgets -*-byte-compile-dynamic: t;-*-
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
3 4
;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003,
;;   2004, 2005 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
5 6
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7
;; Maintainer: FSF
Per Abrahamsen's avatar
Per Abrahamsen committed
8 9
;; Keywords: extensions

10 11 12 13 14 15 16 17 18 19 20 21 22 23
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
26

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
;;; 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.]

Per Abrahamsen's avatar
Per Abrahamsen committed
55 56 57 58 59 60
;;; Commentary:
;;
;; See `widget.el'.

;;; Code:

Juanma Barranquero's avatar
Juanma Barranquero committed
61 62
(defvar widget)

Per Abrahamsen's avatar
Per Abrahamsen committed
63
;;; Compatibility.
64

65 66
(defun widget-event-point (event)
  "Character position of the end of event if that exists, or nil."
67
  (posn-point (event-end event)))
68

69 70 71 72 73 74
(defun widget-button-release-event-p (event)
  "Non-nil if EVENT is a mouse-button-release event object."
  (and (eventp event)
       (memq (event-basic-type event) '(mouse-1 mouse-2 mouse-3))
       (or (memq 'click (event-modifiers event))
	   (memq  'drag (event-modifiers event)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
75 76 77 78 79 80

;;; Customization.

(defgroup widgets nil
  "Customization support for the Widget Library."
  :link '(custom-manual "(widget)Top")
Per Abrahamsen's avatar
Per Abrahamsen committed
81
  :link '(emacs-library-link :tag "Lisp File" "widget.el")
Per Abrahamsen's avatar
Per Abrahamsen committed
82 83 84 85
  :prefix "widget-"
  :group 'extensions
  :group 'hypermedia)

Per Abrahamsen's avatar
Per Abrahamsen committed
86 87 88 89
(defgroup widget-documentation nil
  "Options controling the display of documentation strings."
  :group 'widgets)

Per Abrahamsen's avatar
Per Abrahamsen committed
90 91 92 93 94
(defgroup widget-faces nil
  "Faces used by the widget library."
  :group 'widgets
  :group 'faces)

95
(defvar widget-documentation-face 'widget-documentation
96
  "Face used for documentation strings in widgets.
97 98
This exists as a variable so it can be set locally in certain buffers.")

99 100 101 102 103 104 105
(defface widget-documentation '((((class color)
				  (background dark))
				 (:foreground "lime green"))
				(((class color)
				  (background light))
				 (:foreground "dark green"))
				(t nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
106 107 108
  "Face used for documentation text."
  :group 'widget-documentation
  :group 'widget-faces)
109 110
;; backward compatibility alias
(put 'widget-documentation-face 'face-alias 'widget-documentation)
Per Abrahamsen's avatar
Per Abrahamsen committed
111

112
(defvar widget-button-face 'widget-button
113
  "Face used for buttons in widgets.
114 115
This exists as a variable so it can be set locally in certain buffers.")

116
(defface widget-button '((t (:weight bold)))
Per Abrahamsen's avatar
Per Abrahamsen committed
117
  "Face used for widget buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
118
  :group 'widget-faces)
119 120
;; backward compatibility alias
(put 'widget-button-face 'face-alias 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
121 122 123 124

(defcustom widget-mouse-face 'highlight
  "Face used for widget buttons when the mouse is above them."
  :type 'face
Per Abrahamsen's avatar
Per Abrahamsen committed
125
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
126

127 128 129
;; 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.
130 131 132 133 134 135 136 137 138 139 140
(defface widget-field '((((type tty))
			 :background "yellow3"
			 :foreground "black")
			(((class grayscale color)
			  (background light))
			 :background "gray85")
			(((class grayscale color)
			  (background dark))
			 :background "dim gray")
			(t
			 :slant italic))
Per Abrahamsen's avatar
Per Abrahamsen committed
141
  "Face used for editable fields."
Per Abrahamsen's avatar
Per Abrahamsen committed
142
  :group 'widget-faces)
143 144 145 146 147 148 149 150 151 152 153 154 155 156
;; backward-compatibility alias
(put 'widget-field-face 'face-alias 'widget-field)

(defface widget-single-line-field '((((type tty))
				     :background "green3"
				     :foreground "black")
				    (((class grayscale color)
				      (background light))
				     :background "gray85")
				    (((class grayscale color)
				      (background dark))
				     :background "dim gray")
				    (t
				     :slant italic))
Per Abrahamsen's avatar
Per Abrahamsen committed
157 158
  "Face used for editable fields spanning only a single line."
  :group 'widget-faces)
159 160
;; backward-compatibility alias
(put 'widget-single-line-field-face 'face-alias 'widget-single-line-field)
Per Abrahamsen's avatar
Per Abrahamsen committed
161

162 163 164 165 166 167 168 169 170 171 172
;;; This causes display-table to be loaded, and not usefully.
;;;(defvar widget-single-line-display-table
;;;  (let ((table (make-display-table)))
;;;    (aset table 9  "^I")
;;;    (aset table 10 "^J")
;;;    table)
;;;  "Display table used for single-line editable fields.")

;;;(when (fboundp 'set-face-display-table)
;;;  (set-face-display-table 'widget-single-line-field-face
;;;			  widget-single-line-display-table))
Per Abrahamsen's avatar
Per Abrahamsen committed
173

Per Abrahamsen's avatar
Per Abrahamsen committed
174 175 176 177 178
;;; Utility functions.
;;
;; These are not really widget specific.

(defun widget-princ-to-string (object)
179 180 181 182 183
  "Return string representation of OBJECT, any Lisp object.
No quoting characters are used; no delimiters are printed around
the contents of strings."
  (with-output-to-string
      (princ object)))
Per Abrahamsen's avatar
Per Abrahamsen committed
184 185 186 187 188 189

(defun widget-clear-undo ()
  "Clear all undo information."
  (buffer-disable-undo (current-buffer))
  (buffer-enable-undo))

Per Abrahamsen's avatar
Per Abrahamsen committed
190 191 192 193 194 195
(defcustom widget-menu-max-size 40
  "Largest number of items allowed in a popup-menu.
Larger menus are read through the minibuffer."
  :group 'widgets
  :type 'integer)

196 197 198 199 200 201 202
(defcustom widget-menu-max-shortcuts 40
  "Largest number of items for which it works to choose one with a character.
For a larger number of items, the minibuffer is used."
  :group 'widgets
  :type 'integer)

(defcustom widget-menu-minibuffer-flag nil
203 204 205 206 207 208
  "*Control how to ask for a choice from the keyboard.
Non-nil means use the minibuffer;
nil means read a single character."
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
209 210 211 212
(defun widget-choose (title items &optional event)
  "Choose an item from a list.

First argument TITLE is the name of the list.
213
Second argument ITEMS is a list whose members are either
Per Abrahamsen's avatar
Per Abrahamsen committed
214 215
 (NAME . VALUE), to indicate selectable items, or just strings to
 indicate unselectable items.
Per Abrahamsen's avatar
Per Abrahamsen committed
216 217 218 219 220 221 222 223
Optional third argument EVENT is an input event.

The user is asked to choose between each NAME from the items alist,
and the VALUE of the chosen element will be returned.  If EVENT is a
mouse event, and the number of elements in items is less than
`widget-menu-max-size', a popup menu will be used, otherwise the
minibuffer."
  (cond ((and (< (length items) widget-menu-max-size)
224
	      event (display-popup-menus-p))
225
	 ;; Mouse click.
Per Abrahamsen's avatar
Per Abrahamsen committed
226 227
	 (x-popup-menu event
		       (list title (cons "" items))))
228 229
	((or widget-menu-minibuffer-flag
	     (> (length items) widget-menu-max-shortcuts))
230
	 ;; Read the choice of name from the minibuffer.
231
	 (setq items (widget-remove-if 'stringp items))
Per Abrahamsen's avatar
Per Abrahamsen committed
232 233 234 235 236
	 (let ((val (completing-read (concat title ": ") items nil t)))
	   (if (stringp val)
	       (let ((try (try-completion val items)))
		 (when (stringp try)
		   (setq val try))
237
		 (cdr (assoc val items))))))
238 239 240
	(t
	 ;; Construct a menu of the choices
	 ;; and then use it for prompting for a single character.
241 242 243
	 (let* ((overriding-terminal-local-map (make-sparse-keymap))
		(next-digit ?0)
		map choice some-choice-enabled value)
244 245 246
	   ;; Define SPC as a prefix char to get to this menu.
	   (define-key overriding-terminal-local-map " "
	     (setq map (make-sparse-keymap title)))
247
	   (with-current-buffer (get-buffer-create " widget-choose")
248 249 250 251 252 253 254 255
	     (erase-buffer)
	     (insert "Available choices:\n\n")
	     (while items
	       (setq choice (car items) items (cdr items))
	       (if (consp choice)
		   (let* ((name (car choice))
			 (function (cdr choice)))
		     (insert (format "%c = %s\n" next-digit name))
256 257
		     (define-key map (vector next-digit) function)
		     (setq some-choice-enabled t)))
258 259 260 261
	       ;; Allocate digits to disabled alternatives
	       ;; so that the digit of a given alternative never varies.
	       (setq next-digit (1+ next-digit)))
	     (insert "\nC-g = Quit"))
262 263
	   (or some-choice-enabled
	       (error "None of the choices is currently meaningful"))
264
	   (define-key map [?\C-g] 'keyboard-quit)
265
	   (define-key map [t] 'keyboard-quit)
266 267
	   (define-key map [?\M-\C-v] 'scroll-other-window)
	   (define-key map [?\M--] 'negative-argument)
268 269 270
	   (setcdr map (nreverse (cdr map)))
	   ;; Read a char with the menu, and return the result
	   ;; that corresponds to it.
271
	   (save-window-excursion
272
	     (let ((buf (get-buffer " widget-choose")))
273
	       (fit-window-to-buffer (display-buffer buf))
274 275 276 277 278 279 280
	       (let ((cursor-in-echo-area t)
		     keys
		     (char 0)
		     (arg 1))
		 (while (not (or (and (>= char ?0) (< char next-digit))
				 (eq value 'keyboard-quit)))
		   ;; Unread a SPC to lead to our new menu.
281
		   (setq unread-command-events (cons ?\s unread-command-events))
282
		   (setq keys (read-key-sequence title))
283 284
		   (setq value
			 (lookup-key overriding-terminal-local-map keys t)
285 286
			 char (string-to-char (substring keys 1)))
		   (cond ((eq value 'scroll-other-window)
287 288
			  (let ((minibuffer-scroll-window
				 (get-buffer-window buf)))
289
			    (if (> 0 arg)
290 291
				(scroll-other-window-down
				 (window-height minibuffer-scroll-window))
292 293 294 295 296 297
			      (scroll-other-window))
			    (setq arg 1)))
			 ((eq value 'negative-argument)
			  (setq arg -1))
			 (t
			  (setq arg 1)))))))
298 299 300
	   (when (eq value 'keyboard-quit)
	     (error "Canceled"))
	   value))))
Per Abrahamsen's avatar
Per Abrahamsen committed
301

302 303 304 305 306 307 308 309
(defun widget-remove-if (predictate list)
  (let (result (tail list))
    (while tail
      (or (funcall predictate (car tail))
	  (setq result (cons (car tail) result)))
      (setq tail (cdr tail)))
    (nreverse result)))

Per Abrahamsen's avatar
Per Abrahamsen committed
310
;;; Widget text specifications.
311
;;
312
;; These functions are for specifying text properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
313

314 315
;; We can set it to nil now that get_local_map uses get_pos_property.
(defconst widget-field-add-space nil
Per Abrahamsen's avatar
Per Abrahamsen committed
316 317
  "Non-nil means add extra space at the end of editable text fields.
If you don't add the space, it will become impossible to edit a zero
318
size field.")
Per Abrahamsen's avatar
Per Abrahamsen committed
319

320
(defvar widget-field-use-before-change t
Per Abrahamsen's avatar
Per Abrahamsen committed
321
  "Non-nil means use `before-change-functions' to track editable fields.
322
This enables the use of undo, but doesn't work on Emacs 19.34 and earlier.
Per Abrahamsen's avatar
Per Abrahamsen committed
323
Using before hooks also means that the :notify function can't know the
324
new value.")
Per Abrahamsen's avatar
Per Abrahamsen committed
325

Per Abrahamsen's avatar
Per Abrahamsen committed
326
(defun widget-specify-field (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
327
  "Specify editable button for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
328 329 330 331 332
  ;; Terminating space is not part of the field, but necessary in
  ;; order for local-map to work.  Remove next sexp if local-map works
  ;; at the end of the overlay.
  (save-excursion
    (goto-char to)
Per Abrahamsen's avatar
Per Abrahamsen committed
333 334 335 336
    (cond ((null (widget-get widget :size))
	   (forward-char 1))
	  (widget-field-add-space
	   (insert-and-inherit " ")))
Per Abrahamsen's avatar
Per Abrahamsen committed
337
    (setq to (point)))
Miles Bader's avatar
Miles Bader committed
338
  (let ((keymap (widget-get widget :keymap))
339
	(face (or (widget-get widget :value-face) 'widget-field))
Miles Bader's avatar
Miles Bader committed
340
	(help-echo (widget-get widget :help-echo))
341
	(follow-link (widget-get widget :follow-link))
Miles Bader's avatar
Miles Bader committed
342 343
	(rear-sticky
	 (or (not widget-field-add-space) (widget-get widget :size))))
344
    (if (functionp help-echo)
345
      (setq help-echo 'widget-mouse-help))
Miles Bader's avatar
Miles Bader committed
346 347 348 349 350 351 352 353
    (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)
354 355
        ;; We need the real field for tabbing.
	(overlay-put overlay 'real-field widget)
356 357 358
	;; 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)
Miles Bader's avatar
Miles Bader committed
359
	(overlay-put overlay 'face face)
360
	(overlay-put overlay 'follow-link follow-link)
Miles Bader's avatar
Miles Bader committed
361 362 363 364 365 366 367
	(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)
368
      (overlay-put overlay 'local-map keymap)
Miles Bader's avatar
Miles Bader committed
369
      (overlay-put overlay 'face face)
370
      (overlay-put overlay 'follow-link follow-link)
Miles Bader's avatar
Miles Bader committed
371
      (overlay-put overlay 'help-echo help-echo)))
372 373 374 375 376 377 378 379 380
  (widget-specify-secret widget))

(defun widget-specify-secret (field)
  "Replace text in FIELD with value of `:secret', if non-nil."
  (let ((secret (widget-get field :secret))
	(size (widget-get field :size)))
    (when secret
      (let ((begin (widget-field-start field))
	    (end (widget-field-end field)))
381
	(when size
382
	  (while (and (> end begin)
383
		      (eq (char-after (1- end)) ?\s))
384 385 386 387 388 389 390
	    (setq end (1- end))))
	(while (< begin end)
	  (let ((old (char-after begin)))
	    (unless (eq old secret)
	      (subst-char-in-region begin (1+ begin) old secret)
	      (put-text-property begin (1+ begin) 'secret old))
	    (setq begin (1+ begin))))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
391 392

(defun widget-specify-button (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
393
  "Specify button for WIDGET between FROM and TO."
394
  (let ((overlay (make-overlay from to nil t nil))
395
	(follow-link (widget-get widget :follow-link))
396
	(help-echo (widget-get widget :help-echo)))
Per Abrahamsen's avatar
Per Abrahamsen committed
397
    (widget-put widget :button-overlay overlay)
398 399
    (if (functionp help-echo)
      (setq help-echo 'widget-mouse-help))
Per Abrahamsen's avatar
Per Abrahamsen committed
400
    (overlay-put overlay 'button widget)
401
    (overlay-put overlay 'keymap (widget-get widget :keymap))
402
    (overlay-put overlay 'evaporate t)
403 404
    ;; We want to avoid the face with image buttons.
    (unless (widget-get widget :suppress-face)
405 406 407 408 409
      (overlay-put overlay 'face (widget-apply widget :button-face-get))
      ; Text terminals cannot change mouse pointer shape, so use mouse
      ; face instead.
      (or (display-graphic-p)
	  (overlay-put overlay 'mouse-face widget-mouse-face)))
410
    (overlay-put overlay 'pointer 'hand)
411
    (overlay-put overlay 'follow-link follow-link)
412 413 414 415 416 417 418 419 420 421
    (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))))
Per Abrahamsen's avatar
Per Abrahamsen committed
422 423

(defun widget-specify-sample (widget from to)
424
  "Specify sample for WIDGET between FROM and TO."
425 426
  (let ((overlay (make-overlay from to nil t nil)))
    (overlay-put overlay 'face (widget-apply widget :sample-face-get))
427
    (overlay-put overlay 'evaporate t)
Per Abrahamsen's avatar
Per Abrahamsen committed
428 429
    (widget-put widget :sample-overlay overlay)))

Per Abrahamsen's avatar
Per Abrahamsen committed
430
(defun widget-specify-doc (widget from to)
431
  "Specify documentation for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
432 433 434
  (let ((overlay (make-overlay from to nil t nil)))
    (overlay-put overlay 'widget-doc widget)
    (overlay-put overlay 'face widget-documentation-face)
435
    (overlay-put overlay 'evaporate t)
Per Abrahamsen's avatar
Per Abrahamsen committed
436
    (widget-put widget :doc-overlay overlay)))
Per Abrahamsen's avatar
Per Abrahamsen committed
437 438

(defmacro widget-specify-insert (&rest form)
439 440 441
  "Execute FORM without inheriting any text properties."
  `(save-restriction
    (let ((inhibit-read-only t)
442 443 444 445
	  (inhibit-modification-hooks t))
      (narrow-to-region (point) (point))
      (prog1 (progn ,@form)
	(goto-char (point-max))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
446

447 448
(defface widget-inactive
  '((t :inherit shadow))
Per Abrahamsen's avatar
Per Abrahamsen committed
449
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
450
  :group 'widget-faces)
451 452
;; backward-compatibility alias
(put 'widget-inactive-face 'face-alias 'widget-inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
453 454 455 456 457

(defun widget-specify-inactive (widget from to)
  "Make WIDGET inactive for user modifications."
  (unless (widget-get widget :inactive)
    (let ((overlay (make-overlay from to nil t nil)))
458
      (overlay-put overlay 'face 'widget-inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
459
      ;; This is disabled, as it makes the mouse cursor change shape.
460
      ;; (overlay-put overlay 'mouse-face 'widget-inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
461 462
      (overlay-put overlay 'evaporate t)
      (overlay-put overlay 'priority 100)
463
      (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
Per Abrahamsen's avatar
Per Abrahamsen committed
464 465 466 467 468
      (widget-put widget :inactive overlay))))

(defun widget-overlay-inactive (&rest junk)
  "Ignoring the arguments, signal an error."
  (unless inhibit-read-only
469
    (error "The widget here is not active")))
Per Abrahamsen's avatar
Per Abrahamsen committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484


(defun widget-specify-active (widget)
  "Make WIDGET active for user modifications."
  (let ((inactive (widget-get widget :inactive)))
    (when inactive
      (delete-overlay inactive)
      (widget-put widget :inactive nil))))

;;; Widget Properties.

(defsubst widget-type (widget)
  "Return the type of WIDGET, a symbol."
  (car widget))

485 486 487 488 489 490
;;;###autoload
(defun widgetp (widget)
  "Return non-nil iff WIDGET is a widget."
  (if (symbolp widget)
      (get widget 'widget-type)
    (and (consp widget)
491 492
	 (symbolp (car widget))
	 (get (car widget) 'widget-type))))
493

Per Abrahamsen's avatar
Per Abrahamsen committed
494 495
(defun widget-get-indirect (widget property)
  "In WIDGET, get the value of PROPERTY.
496
If the value is a symbol, return its binding.
Per Abrahamsen's avatar
Per Abrahamsen committed
497 498 499 500 501 502
Otherwise, just return the value."
  (let ((value (widget-get widget property)))
    (if (symbolp value)
	(symbol-value value)
      value)))

Per Abrahamsen's avatar
Per Abrahamsen committed
503 504
(defun widget-member (widget property)
  "Non-nil iff there is a definition in WIDGET for PROPERTY."
505
  (cond ((plist-member (cdr widget) property)
Per Abrahamsen's avatar
Per Abrahamsen committed
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
	 t)
	((car widget)
	 (widget-member (get (car widget) 'widget-type) property))
	(t nil)))

(defun widget-value (widget)
  "Extract the current value of WIDGET."
  (widget-apply widget
		:value-to-external (widget-apply widget :value-get)))

(defun widget-value-set (widget value)
  "Set the current value of WIDGET to VALUE."
  (widget-apply widget
		:value-set (widget-apply widget
					 :value-to-internal value)))

522
(defun widget-default-get (widget)
Per Abrahamsen's avatar
Per Abrahamsen committed
523
  "Extract the default external value of WIDGET."
524
  (widget-apply widget :value-to-external
Per Abrahamsen's avatar
Per Abrahamsen committed
525 526
		(or (widget-get widget :value)
		    (widget-apply widget :default-get))))
527

Per Abrahamsen's avatar
Per Abrahamsen committed
528
(defun widget-match-inline (widget vals)
529
  "In WIDGET, match the start of VALS."
Per Abrahamsen's avatar
Per Abrahamsen committed
530 531
  (cond ((widget-get widget :inline)
	 (widget-apply widget :match-inline vals))
532
	((and (listp vals)
Per Abrahamsen's avatar
Per Abrahamsen committed
533 534 535 536 537 538
	      (widget-apply widget :match (car vals)))
	 (cons (list (car vals)) (cdr vals)))
	(t nil)))

(defun widget-apply-action (widget &optional event)
  "Apply :action in WIDGET in response to EVENT."
Per Abrahamsen's avatar
Per Abrahamsen committed
539 540 541
  (if (widget-apply widget :active)
      (widget-apply widget :action event)
    (error "Attempt to perform action on inactive widget")))
Per Abrahamsen's avatar
Per Abrahamsen committed
542

Per Abrahamsen's avatar
Per Abrahamsen committed
543 544 545 546 547 548 549 550 551 552 553 554 555 556
;;; Helper functions.
;;
;; These are widget specific.

;;;###autoload
(defun widget-prompt-value (widget prompt &optional value unbound)
  "Prompt for a value matching WIDGET, using PROMPT.
The current value is assumed to be VALUE, unless UNBOUND is non-nil."
  (unless (listp widget)
    (setq widget (list widget)))
  (setq prompt (format "[%s] %s" (widget-type widget) prompt))
  (setq widget (widget-convert widget))
  (let ((answer (widget-apply widget :prompt-value prompt value unbound)))
    (unless (widget-apply widget :match answer)
557
      (error "Value does not match %S type" (car widget)))
Per Abrahamsen's avatar
Per Abrahamsen committed
558 559 560 561 562
    answer))

(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."
563
  (let* ((children (widget-get (widget-get widget :parent) :children))
Per Abrahamsen's avatar
Per Abrahamsen committed
564 565 566 567 568 569 570 571 572
	 child)
    (catch 'child
      (while children
	(setq child (car children)
	      children (cdr children))
	(when (eq (widget-get child :button) widget)
	  (throw 'child child)))
      nil)))

Per Abrahamsen's avatar
Per Abrahamsen committed
573 574 575 576 577 578 579 580 581 582 583
(defun widget-map-buttons (function &optional buffer maparg)
  "Map FUNCTION over the buttons in BUFFER.
FUNCTION is called with the arguments WIDGET and MAPARG.

If FUNCTION returns non-nil, the walk is cancelled.

The arguments MAPARG, and BUFFER default to nil and (current-buffer),
respectively."
  (let ((cur (point-min))
	(widget nil)
	(overlays (if buffer
584
		      (with-current-buffer buffer (overlay-lists))
Per Abrahamsen's avatar
Per Abrahamsen committed
585 586 587 588 589 590 591
		    (overlay-lists))))
    (setq overlays (append (car overlays) (cdr overlays)))
    (while (setq cur (pop overlays))
      (setq widget (overlay-get cur 'button))
      (if (and widget (funcall function widget maparg))
	  (setq overlays nil)))))

592
;;; Images.
Per Abrahamsen's avatar
Per Abrahamsen committed
593

594 595 596
(defcustom widget-image-directory (file-name-as-directory
				   (expand-file-name "custom" data-directory))
  "Where widget button images are located.
Per Abrahamsen's avatar
Per Abrahamsen committed
597
If this variable is nil, widget will try to locate the directory
Per Abrahamsen's avatar
Per Abrahamsen committed
598
automatically."
Per Abrahamsen's avatar
Per Abrahamsen committed
599 600 601
  :group 'widgets
  :type 'directory)

602 603 604
(defcustom widget-image-enable t
  "If non nil, use image buttons in widgets when available."
  :version "21.1"
Per Abrahamsen's avatar
Per Abrahamsen committed
605 606 607
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
608 609 610 611 612 613 614 615 616 617
(defcustom widget-image-conversion
  '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg")
    (xbm ".xbm"))
  "Conversion alist from image formats to file name suffixes."
  :group 'widgets
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Image Format" unknown)
		       (repeat :tag "Suffixes"
			       (string :format "%v")))))

618 619 620
(defun widget-image-find (image)
  "Create a graphical button from IMAGE.
IMAGE should either already be an image, or be a file name sans
Per Abrahamsen's avatar
Per Abrahamsen committed
621
extension (xpm, xbm, gif, jpg, or png) located in
622 623 624
`widget-image-directory' or otherwise where `find-image' will find it."
  (cond ((not (and image widget-image-enable (display-graphic-p)))
	 ;; We don't want or can't use images.
Per Abrahamsen's avatar
Per Abrahamsen committed
625
	 nil)
626 627 628
	((and (consp image)
	      (eq 'image (car image)))
	 ;; Already an image spec.  Use it.
Per Abrahamsen's avatar
Per Abrahamsen committed
629
	 image)
Per Abrahamsen's avatar
Per Abrahamsen committed
630 631
	((stringp image)
	 ;; A string.  Look it up in relevant directories.
632 633 634 635 636 637 638
	 (let* ((load-path (cons widget-image-directory load-path))
		specs)
	   (dolist (elt widget-image-conversion)
	     (dolist (ext (cdr elt))
	       (push (list :type (car elt) :file (concat image ext)) specs)))
	   (setq specs (nreverse specs))
	   (find-image specs)))
Per Abrahamsen's avatar
Per Abrahamsen committed
639
	(t
Per Abrahamsen's avatar
Per Abrahamsen committed
640
	 ;; Oh well.
Per Abrahamsen's avatar
Per Abrahamsen committed
641 642
	 nil)))

643
(defvar widget-button-pressed-face 'widget-button-pressed
644 645 646 647 648
  "Face used for pressed buttons in widgets.
This exists as a variable so it can be set locally in certain
buffers.")

(defun widget-image-insert (widget tag image &optional down inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
649
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
650 651 652 653 654 655 656 657 658 659 660 661
IMAGE should either be an image or an image file name sans extension
\(xpm, xbm, gif, jpg, or png) located in `widget-image-directory'.

Optional arguments DOWN and INACTIVE are used instead of IMAGE when the
button is pressed or inactive, respectively.  These are currently ignored."
  (if (and (display-graphic-p)
	   (setq image (widget-image-find image)))
      (progn (widget-put widget :suppress-face t)
	     (insert-image image
			   (propertize
			    tag 'mouse-face widget-button-pressed-face)))
    (insert tag)))
Per Abrahamsen's avatar
Per Abrahamsen committed
662

Per Abrahamsen's avatar
Per Abrahamsen committed
663 664 665 666 667 668 669 670 671
;;; Buttons.

(defgroup widget-button nil
  "The look of various kinds of buttons."
  :group 'widgets)

(defcustom widget-button-prefix ""
  "String used as prefix for buttons."
  :type 'string
Per Abrahamsen's avatar
Per Abrahamsen committed
672
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
673 674 675 676

(defcustom widget-button-suffix ""
  "String used as suffix for buttons."
  :type 'string
Per Abrahamsen's avatar
Per Abrahamsen committed
677
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
678

Per Abrahamsen's avatar
Per Abrahamsen committed
679 680 681 682
;;; Creating Widgets.

;;;###autoload
(defun widget-create (type &rest args)
683
  "Create widget of TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
The optional ARGS are additional keyword arguments."
  (let ((widget (apply 'widget-convert type args)))
    (widget-apply widget :create)
    widget))

(defun widget-create-child-and-convert (parent type &rest args)
  "As part of the widget PARENT, create a child widget TYPE.
The child is converted, using the keyword arguments ARGS."
  (let ((widget (apply 'widget-convert type args)))
    (widget-put widget :parent parent)
    (unless (widget-get widget :indent)
      (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
				    (or (widget-get widget :extra-offset) 0)
				    (widget-get parent :offset))))
    (widget-apply widget :create)
    widget))

(defun widget-create-child (parent type)
  "Create widget of TYPE."
Per Abrahamsen's avatar
Per Abrahamsen committed
703
  (let ((widget (widget-copy type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
704 705 706 707 708 709 710 711 712 713
    (widget-put widget :parent parent)
    (unless (widget-get widget :indent)
      (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
				    (or (widget-get widget :extra-offset) 0)
				    (widget-get parent :offset))))
    (widget-apply widget :create)
    widget))

(defun widget-create-child-value (parent type value)
  "Create widget of TYPE with value VALUE."
Per Abrahamsen's avatar
Per Abrahamsen committed
714
  (let ((widget (widget-copy type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
715 716 717 718 719 720 721 722 723 724 725 726 727 728
    (widget-put widget :value (widget-apply widget :value-to-internal value))
    (widget-put widget :parent parent)
    (unless (widget-get widget :indent)
      (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
				    (or (widget-get widget :extra-offset) 0)
				    (widget-get parent :offset))))
    (widget-apply widget :create)
    widget))

;;;###autoload
(defun widget-delete (widget)
  "Delete WIDGET."
  (widget-apply widget :delete))

Per Abrahamsen's avatar
Per Abrahamsen committed
729 730 731 732
(defun widget-copy (widget)
  "Make a deep copy of WIDGET."
  (widget-apply (copy-sequence widget) :copy))

Per Abrahamsen's avatar
Per Abrahamsen committed
733
(defun widget-convert (type &rest args)
734
  "Convert TYPE to a widget without inserting it in the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
735 736
The optional ARGS are additional keyword arguments."
  ;; Don't touch the type.
737
  (let* ((widget (if (symbolp type)
Per Abrahamsen's avatar
Per Abrahamsen committed
738
		     (list type)
739
		   (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
740
	 (current widget)
741
	 done
Per Abrahamsen's avatar
Per Abrahamsen committed
742 743 744
	 (keys args))
    ;; First set the :args keyword.
    (while (cdr current)		;Look in the type.
745 746 747 748 749 750 751 752 753 754
      (if (and (keywordp (cadr current))
	       ;; If the last element is a keyword,
	       ;; it is still the :args element,
	       ;; even though it is a keyword.
	       (cddr current))
	  (if (eq (cadr current) :args)
	      ;; If :args is explicitly specified, obey it.
	      (setq current nil)
	    ;; Some other irrelevant keyword.
	    (setq current (cdr (cdr current))))
755 756
	(setcdr current (list :args (cdr current)))
	(setq current nil)))
757 758 759 760 761 762 763 764 765 766
    (while (and args (not done))	;Look in ARGS.
      (cond ((eq (car args) :args)
	     ;; Handle explicit specification of :args.
	     (setq args (cadr args)
		   done t))
	    ((keywordp (car args))
	     (setq args (cddr args)))
	    (t (setq done t))))
    (when done
      (widget-put widget :args args))
Per Abrahamsen's avatar
Per Abrahamsen committed
767 768 769 770 771 772 773 774
    ;; Then Convert the widget.
    (setq type widget)
    (while type
      (let ((convert-widget (plist-get (cdr type) :convert-widget)))
	(if convert-widget
	    (setq widget (funcall convert-widget widget))))
      (setq type (get (car type) 'widget-type)))
    ;; Finally set the keyword args.
775
    (while keys
Per Abrahamsen's avatar
Per Abrahamsen committed
776
      (let ((next (nth 0 keys)))
777 778
	(if (keywordp next)
	    (progn
Per Abrahamsen's avatar
Per Abrahamsen committed
779 780 781 782 783
	      (widget-put widget next (nth 1 keys))
	      (setq keys (nthcdr 2 keys)))
	  (setq keys nil))))
    ;; Convert the :value to internal format.
    (if (widget-member widget :value)
784 785 786 787
	(widget-put widget
		    :value (widget-apply widget
					 :value-to-internal
					 (widget-get widget :value))))
Per Abrahamsen's avatar
Per Abrahamsen committed
788 789 790
    ;; Return the newly create widget.
    widget))

791
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
792
(defun widget-insert (&rest args)
793
  "Call `insert' with ARGS even if surrounding text is read only."
Per Abrahamsen's avatar
Per Abrahamsen committed
794
  (let ((inhibit-read-only t)
795
	(inhibit-modification-hooks t))
Per Abrahamsen's avatar
Per Abrahamsen committed
796
    (apply 'insert args)))
Per Abrahamsen's avatar
Per Abrahamsen committed
797

Per Abrahamsen's avatar
Per Abrahamsen committed
798 799 800
(defun widget-convert-text (type from to
				 &optional button-from button-to
				 &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
801
  "Return a widget of type TYPE with endpoint FROM TO.
802 803
No text will be inserted to the buffer, instead the text between FROM
and TO will be used as the widgets end points.  If optional arguments
Per Abrahamsen's avatar
Per Abrahamsen committed
804
BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets
Per Abrahamsen's avatar
Per Abrahamsen committed
805 806 807
button end points.
Optional ARGS are extra keyword arguments for TYPE."
  (let ((widget (apply 'widget-convert type :delete 'widget-leave-text args))
Per Abrahamsen's avatar
Per Abrahamsen committed
808
	(from (copy-marker from))
809
	(to (copy-marker to)))
Per Abrahamsen's avatar
Per Abrahamsen committed
810 811 812 813 814 815 816 817
    (set-marker-insertion-type from t)
    (set-marker-insertion-type to nil)
    (widget-put widget :from from)
    (widget-put widget :to to)
    (when button-from
      (widget-specify-button widget button-from button-to))
    widget))

Per Abrahamsen's avatar
Per Abrahamsen committed
818
(defun widget-convert-button (type from to &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
819
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
820
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
821 822 823
No text will be inserted to the buffer, instead the text between FROM
and TO will be used as the widgets end points, as well as the widgets
button end points."
Per Abrahamsen's avatar
Per Abrahamsen committed
824 825 826 827
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
828
  (let ((button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
829
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
830
	(doc (widget-get widget :doc-overlay))
831 832 833
	(field (widget-get widget :field-overlay)))
    (set-marker (widget-get widget :from) nil)
    (set-marker (widget-get widget :to) nil)
Per Abrahamsen's avatar
Per Abrahamsen committed
834 835
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
836 837
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
838 839
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
840 841
    (when field
      (delete-overlay field))
842
    (mapc 'widget-leave-text (widget-get widget :children))))
Per Abrahamsen's avatar
Per Abrahamsen committed
843

Per Abrahamsen's avatar
Per Abrahamsen committed
844 845
;;; Keymap and Commands.

846
;;;###autoload
847 848 849 850 851
(defvar widget-keymap
  (let ((map (make-sparse-keymap)))
    (define-key map "\t" 'widget-forward)
    (define-key map [(shift tab)] 'widget-backward)
    (define-key map [backtab] 'widget-backward)
852
    (define-key map [mouse-1] 'widget-move-and-invoke)
853 854 855
    (define-key map [down-mouse-2] 'widget-button-click)
    (define-key map "\C-m" 'widget-button-press)
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
856 857 858 859
  "Keymap containing useful binding for buffers containing widgets.
Recommended as a parent keymap for modes using widgets.")

(defvar widget-global-map global-map
Dave Love's avatar
Don't  
Dave Love committed
860
  "Keymap used for events a widget does not handle itself.")
Per Abrahamsen's avatar
Per Abrahamsen committed
861 862
(make-variable-buffer-local 'widget-global-map)

863 864 865 866 867
(defvar widget-field-keymap
  (let ((map (copy-keymap widget-keymap)))
    (define-key map "\C-k" 'widget-kill-line)
    (define-key map "\M-\t" 'widget-complete)
    (define-key map "\C-m" 'widget-field-activate)
868
    ;; Since the widget code uses a `field' property to identify fields,
869
    ;; ordinary beginning-of-line does the right thing.
870
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
871
    (define-key map "\C-e" 'widget-end-of-line)
872
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
873 874
  "Keymap used inside an editable field.")

875 876
(defvar widget-text-keymap
  (let ((map (copy-keymap widget-keymap)))
877
    ;; Since the widget code uses a `field' property to identify fields,
878
    ;; ordinary beginning-of-line does the right thing.
879
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
880
    (define-key map "\C-e" 'widget-end-of-line)
881
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
882 883 884
  "Keymap used inside a text field.")

(defun widget-field-activate (pos &optional event)
Dave Love's avatar
Dave Love committed
885
  "Invoke the editable field at point."
Per Abrahamsen's avatar
Per Abrahamsen committed
886
  (interactive "@d")
Miles Bader's avatar
Miles Bader committed
887
  (let ((field (widget-field-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
888 889 890 891 892
    (if field
	(widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

893
(defface widget-button-pressed
894 895 896
  '((((min-colors 88) (class color))
     (:foreground "red1"))
    (((class color))
Per Abrahamsen's avatar
Per Abrahamsen committed
897 898
     (:foreground "red"))
    (t
899
     (:weight bold :underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
900
  "Face used for pressed buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
901
  :group 'widget-faces)
902 903
;; backward-compatibility alias
(put 'widget-button-pressed-face 'face-alias 'widget-button-pressed)
Per Abrahamsen's avatar
Per Abrahamsen committed
904

905 906 907 908 909 910 911 912
(defun widget-move-and-invoke (event)
  "Move to where you click, and if it is an active field, invoke it."
  (interactive "e")
  (mouse-set-point event)
  (let ((pos (widget-event-point event)))
    (if (and pos (get-char-property pos 'button))
	(widget-button-click event))))
	
Per Abrahamsen's avatar
Per Abrahamsen committed
913
(defun widget-button-click (event)
914
  "Invoke the button that the mouse is pointing at."
915
  (interactive "e")
916
  (if (widget-event-point event)
917
      (let* ((pos (widget-event-point event))
918
	     (start (event-start event))
919
	     (button (get-char-property
920 921
		      pos 'button (and (windowp (posn-window start))
				       (window-buffer (posn-window start))))))
922 923 924 925
	(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.
926
	    (save-selected-window
927
	      (select-window (posn-window (event-start event)))
928
	      (save-excursion
929
		(goto-char (posn-point (event-start event)))
930 931 932 933
		(let* ((overlay (widget-get button :button-overlay))
		       (face (overlay-get overlay 'face))
		       (mouse-face (overlay-get overlay 'mouse-face)))
		  (unwind-protect
934 935 936 937
		      ;; 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.
938 939 940 941 942 943 944 945
		      (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)
			  (let ((track-mouse t))
946 947 948 949 950 951 952 953 954 955 956 957 958 959
			    (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)
960
				(overlay-put overlay 'mouse-face mouse-face)))))
961

962 963 964 965 966
			;; 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)))
967 968 969
		    (overlay-put overlay 'face face)
		    (overlay-put overlay 'mouse-face mouse-face))))

970 971 972 973 974
	      (unless (pos-visible-in-window-p (widget-event-point event))
		(mouse-set-point event)
		(beginning-of-line)
		(recenter))
	      )
975

Richard M. Stallman's avatar
Richard M. Stallman committed
976 977 978 979 980 981
	  (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))
982
		(cond ((setq command	;down event
Richard M. Stallman's avatar
Richard M. Stallman committed
983
			     (lookup-key widget-global-map [down-mouse-1]))
984 985
		       (setq up nil))
		      ((setq command	;up event
Richard M. Stallman's avatar
Richard M. Stallman committed
986 987 988 989 990 991 992 993