wid-edit.el 125 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
;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2006, 2007, 2008, 2009, 2010  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
;; Keywords: extensions
9
;; Package: emacs
Per Abrahamsen's avatar
Per Abrahamsen committed
10

11 12
;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
17 18 19 20 21 22 23

;; 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
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
25

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
;;; 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
54 55 56 57 58 59 60
;;; Commentary:
;;
;; See `widget.el'.

;;; Code:

;;; Compatibility.
61

62 63
(defun widget-event-point (event)
  "Character position of the end of event if that exists, or nil."
64
  (posn-point (event-end event)))
65

66 67 68 69 70 71
(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
72 73 74 75 76 77

;;; Customization.

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

Per Abrahamsen's avatar
Per Abrahamsen committed
82
(defgroup widget-documentation nil
83
  "Options controlling the display of documentation strings."
Per Abrahamsen's avatar
Per Abrahamsen committed
84 85
  :group 'widgets)

Per Abrahamsen's avatar
Per Abrahamsen committed
86 87 88 89 90
(defgroup widget-faces nil
  "Faces used by the widget library."
  :group 'widgets
  :group 'faces)

91
(defvar widget-documentation-face 'widget-documentation
92
  "Face used for documentation strings in widgets.
93 94
This exists as a variable so it can be set locally in certain buffers.")

95 96 97 98 99 100 101
(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
102 103 104
  "Face used for documentation text."
  :group 'widget-documentation
  :group 'widget-faces)
105 106
(define-obsolete-face-alias 'widget-documentation-face
  'widget-documentation "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
107

108
(defvar widget-button-face 'widget-button
109
  "Face used for buttons in widgets.
110 111
This exists as a variable so it can be set locally in certain buffers.")

112
(defface widget-button '((t (:weight bold)))
Per Abrahamsen's avatar
Per Abrahamsen committed
113
  "Face used for widget buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
114
  :group 'widget-faces)
115
(define-obsolete-face-alias 'widget-button-face 'widget-button "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
116 117 118 119

(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
120
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
121

122 123 124
;; 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.
125 126 127 128 129 130 131 132 133 134 135
(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
136
  "Face used for editable fields."
Per Abrahamsen's avatar
Per Abrahamsen committed
137
  :group 'widget-faces)
138
(define-obsolete-face-alias 'widget-field-face 'widget-field "22.1")
139 140 141 142 143 144 145 146 147 148 149 150

(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
151 152
  "Face used for editable fields spanning only a single line."
  :group 'widget-faces)
153 154
(define-obsolete-face-alias 'widget-single-line-field-face
  'widget-single-line-field "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
155

156 157 158 159 160 161 162 163 164 165 166
;;; 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
167

Per Abrahamsen's avatar
Per Abrahamsen committed
168 169 170 171 172
;;; Utility functions.
;;
;; These are not really widget specific.

(defun widget-princ-to-string (object)
173 174 175 176 177
  "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
178 179 180 181 182 183

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

Per Abrahamsen's avatar
Per Abrahamsen committed
184 185 186 187 188 189
(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)

190 191 192 193 194 195 196
(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
Lute Kamstra's avatar
Lute Kamstra committed
197
  "Control how to ask for a choice from the keyboard.
198 199 200 201 202
Non-nil means use the minibuffer;
nil means read a single character."
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
203 204 205 206
(defun widget-choose (title items &optional event)
  "Choose an item from a list.

First argument TITLE is the name of the list.
207
Second argument ITEMS is a list whose members are either
Per Abrahamsen's avatar
Per Abrahamsen committed
208 209
 (NAME . VALUE), to indicate selectable items, or just strings to
 indicate unselectable items.
Per Abrahamsen's avatar
Per Abrahamsen committed
210 211 212 213 214 215 216 217
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)
218
	      event (display-popup-menus-p))
219
	 ;; Mouse click.
Per Abrahamsen's avatar
Per Abrahamsen committed
220 221
	 (x-popup-menu event
		       (list title (cons "" items))))
222 223
	((or widget-menu-minibuffer-flag
	     (> (length items) widget-menu-max-shortcuts))
224
	 ;; Read the choice of name from the minibuffer.
225
	 (setq items (widget-remove-if 'stringp items))
Per Abrahamsen's avatar
Per Abrahamsen committed
226 227 228 229 230
	 (let ((val (completing-read (concat title ": ") items nil t)))
	   (if (stringp val)
	       (let ((try (try-completion val items)))
		 (when (stringp try)
		   (setq val try))
231
		 (cdr (assoc val items))))))
232 233 234
	(t
	 ;; Construct a menu of the choices
	 ;; and then use it for prompting for a single character.
235 236 237
	 (let* ((overriding-terminal-local-map (make-sparse-keymap))
		(next-digit ?0)
		map choice some-choice-enabled value)
238 239 240
	   ;; Define SPC as a prefix char to get to this menu.
	   (define-key overriding-terminal-local-map " "
	     (setq map (make-sparse-keymap title)))
241
	   (with-current-buffer (get-buffer-create " widget-choose")
242 243 244 245 246 247 248 249
	     (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))
250 251
		     (define-key map (vector next-digit) function)
		     (setq some-choice-enabled t)))
252 253 254
	       ;; Allocate digits to disabled alternatives
	       ;; so that the digit of a given alternative never varies.
	       (setq next-digit (1+ next-digit)))
255 256 257
	     (insert "\nC-g = Quit")
	     (goto-char (point-min))
	     (forward-line))
258 259
	   (or some-choice-enabled
	       (error "None of the choices is currently meaningful"))
260
	   (define-key map [?\C-g] 'keyboard-quit)
261
	   (define-key map [t] 'keyboard-quit)
262 263
	   (define-key map [?\M-\C-v] 'scroll-other-window)
	   (define-key map [?\M--] 'negative-argument)
264 265 266
	   (setcdr map (nreverse (cdr map)))
	   ;; Read a char with the menu, and return the result
	   ;; that corresponds to it.
267
	   (save-window-excursion
268
	     (let ((buf (get-buffer " widget-choose")))
269
	       (fit-window-to-buffer (display-buffer buf))
270 271 272 273
	       (let ((cursor-in-echo-area t)
		     keys
		     (char 0)
		     (arg 1))
274 275
		 (while (not (or (and (integerp char)
				      (>= char ?0) (< char next-digit))
276 277
				 (eq value 'keyboard-quit)))
		   ;; Unread a SPC to lead to our new menu.
278
		   (setq unread-command-events (cons ?\s unread-command-events))
279
		   (setq keys (read-key-sequence title))
280 281
		   (setq value
			 (lookup-key overriding-terminal-local-map keys t)
282
			 char (aref keys 1))
283
		   (cond ((eq value 'scroll-other-window)
284 285
			  (let ((minibuffer-scroll-window
				 (get-buffer-window buf)))
286
			    (if (> 0 arg)
287 288
				(scroll-other-window-down
				 (window-height minibuffer-scroll-window))
289 290 291 292 293 294
			      (scroll-other-window))
			    (setq arg 1)))
			 ((eq value 'negative-argument)
			  (setq arg -1))
			 (t
			  (setq arg 1)))))))
295 296 297
	   (when (eq value 'keyboard-quit)
	     (error "Canceled"))
	   value))))
Per Abrahamsen's avatar
Per Abrahamsen committed
298

299 300 301 302 303 304 305 306
(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
307
;;; Widget text specifications.
308
;;
309
;; These functions are for specifying text properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
310

311 312
;; 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
313 314
  "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
315
size field.")
Per Abrahamsen's avatar
Per Abrahamsen committed
316

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

Per Abrahamsen's avatar
Per Abrahamsen committed
323
(defun widget-specify-field (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
324
  "Specify editable button for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
325 326 327 328 329
  ;; 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
330 331 332 333
    (cond ((null (widget-get widget :size))
	   (forward-char 1))
	  (widget-field-add-space
	   (insert-and-inherit " ")))
Per Abrahamsen's avatar
Per Abrahamsen committed
334
    (setq to (point)))
Miles Bader's avatar
Miles Bader committed
335
  (let ((keymap (widget-get widget :keymap))
336
	(face (or (widget-get widget :value-face) 'widget-field))
Miles Bader's avatar
Miles Bader committed
337
	(help-echo (widget-get widget :help-echo))
338
	(follow-link (widget-get widget :follow-link))
Miles Bader's avatar
Miles Bader committed
339 340
	(rear-sticky
	 (or (not widget-field-add-space) (widget-get widget :size))))
341
    (if (functionp help-echo)
342
      (setq help-echo 'widget-mouse-help))
343
    (when (= (char-before to) ?\n)
Miles Bader's avatar
Miles Bader committed
344 345 346
      ;; 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
347
     ;; do this by making a small secondary overlay to contain just that
Miles Bader's avatar
Miles Bader committed
348 349 350
      ;; one character.
      (let ((overlay (make-overlay (1- to) to nil t nil)))
	(overlay-put overlay 'field 'boundary)
351 352
        ;; We need the real field for tabbing.
	(overlay-put overlay 'real-field widget)
353 354 355
	;; 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
356
	(overlay-put overlay 'face face)
357
	(overlay-put overlay 'follow-link follow-link)
Miles Bader's avatar
Miles Bader committed
358 359 360 361 362 363 364
	(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)
365
      (overlay-put overlay 'local-map keymap)
Miles Bader's avatar
Miles Bader committed
366
      (overlay-put overlay 'face face)
367
      (overlay-put overlay 'follow-link follow-link)
Miles Bader's avatar
Miles Bader committed
368
      (overlay-put overlay 'help-echo help-echo)))
369 370 371 372 373 374 375 376 377
  (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)))
378
	(when size
379
	  (while (and (> end begin)
380
		      (eq (char-after (1- end)) ?\s))
381 382 383 384 385 386 387
	    (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
388 389

(defun widget-specify-button (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
390
  "Specify button for WIDGET between FROM and TO."
391
  (let ((overlay (make-overlay from to nil t nil))
392
	(follow-link (widget-get widget :follow-link))
393
	(help-echo (widget-get widget :help-echo)))
Per Abrahamsen's avatar
Per Abrahamsen committed
394
    (widget-put widget :button-overlay overlay)
395 396
    (if (functionp help-echo)
      (setq help-echo 'widget-mouse-help))
Per Abrahamsen's avatar
Per Abrahamsen committed
397
    (overlay-put overlay 'button widget)
398
    (overlay-put overlay 'keymap (widget-get widget :keymap))
399
    (overlay-put overlay 'evaporate t)
400 401
    ;; We want to avoid the face with image buttons.
    (unless (widget-get widget :suppress-face)
402
      (overlay-put overlay 'face (widget-apply widget :button-face-get))
403
      (overlay-put overlay 'mouse-face
404 405 406 407 408 409 410 411 412 413 414
		   ;; Make new list structure for the mouse-face value
		   ;; so that different widgets will have
		   ;; different `mouse-face' property values
		   ;; and will highlight separately.
		   (let ((mouse-face-value
			  (widget-apply widget :mouse-face-get)))
		     ;; If it's a list, copy it.
		     (if (listp mouse-face-value)
			 (copy-sequence mouse-face-value)
		       ;; If it's a symbol, put it in a list.
		       (list mouse-face-value)))))
415
    (overlay-put overlay 'pointer 'hand)
416
    (overlay-put overlay 'follow-link follow-link)
417 418 419 420 421 422 423 424 425 426
    (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
427 428

(defun widget-specify-sample (widget from to)
429
  "Specify sample for WIDGET between FROM and TO."
430 431
  (let ((overlay (make-overlay from to nil t nil)))
    (overlay-put overlay 'face (widget-apply widget :sample-face-get))
432
    (overlay-put overlay 'evaporate t)
Per Abrahamsen's avatar
Per Abrahamsen committed
433 434
    (widget-put widget :sample-overlay overlay)))

Per Abrahamsen's avatar
Per Abrahamsen committed
435
(defun widget-specify-doc (widget from to)
436
  "Specify documentation for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
437 438 439
  (let ((overlay (make-overlay from to nil t nil)))
    (overlay-put overlay 'widget-doc widget)
    (overlay-put overlay 'face widget-documentation-face)
440
    (overlay-put overlay 'evaporate t)
Per Abrahamsen's avatar
Per Abrahamsen committed
441
    (widget-put widget :doc-overlay overlay)))
Per Abrahamsen's avatar
Per Abrahamsen committed
442 443

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

452 453
(defface widget-inactive
  '((t :inherit shadow))
Per Abrahamsen's avatar
Per Abrahamsen committed
454
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
455
  :group 'widget-faces)
456 457
(define-obsolete-face-alias 'widget-inactive-face
  'widget-inactive "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
458 459 460 461 462

(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)))
463
      (overlay-put overlay 'face 'widget-inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
464
      ;; This is disabled, as it makes the mouse cursor change shape.
465
      ;; (overlay-put overlay 'mouse-face 'widget-inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
466 467
      (overlay-put overlay 'evaporate t)
      (overlay-put overlay 'priority 100)
468
      (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
Per Abrahamsen's avatar
Per Abrahamsen committed
469 470 471 472 473
      (widget-put widget :inactive overlay))))

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


(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)
Richard M. Stallman's avatar
Richard M. Stallman committed
487
  "Return the type of WIDGET.  The type is a symbol."
Per Abrahamsen's avatar
Per Abrahamsen committed
488 489
  (car widget))

490 491
;;;###autoload
(defun widgetp (widget)
492
  "Return non-nil if WIDGET is a widget."
493 494 495
  (if (symbolp widget)
      (get widget 'widget-type)
    (and (consp widget)
496 497
	 (symbolp (car widget))
	 (get (car widget) 'widget-type))))
498

Per Abrahamsen's avatar
Per Abrahamsen committed
499 500
(defun widget-get-indirect (widget property)
  "In WIDGET, get the value of PROPERTY.
501
If the value is a symbol, return its binding.
Per Abrahamsen's avatar
Per Abrahamsen committed
502 503 504 505 506 507
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
508
(defun widget-member (widget property)
509
  "Non-nil if there is a definition in WIDGET for PROPERTY."
510
  (cond ((plist-member (cdr widget) property)
Per Abrahamsen's avatar
Per Abrahamsen committed
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
	 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)))

527
(defun widget-default-get (widget)
Per Abrahamsen's avatar
Per Abrahamsen committed
528
  "Extract the default external value of WIDGET."
529
  (widget-apply widget :value-to-external
Per Abrahamsen's avatar
Per Abrahamsen committed
530 531
		(or (widget-get widget :value)
		    (widget-apply widget :default-get))))
532

Per Abrahamsen's avatar
Per Abrahamsen committed
533
(defun widget-match-inline (widget vals)
534
  "In WIDGET, match the start of VALS."
Per Abrahamsen's avatar
Per Abrahamsen committed
535 536
  (cond ((widget-get widget :inline)
	 (widget-apply widget :match-inline vals))
537
	((and (listp vals)
Per Abrahamsen's avatar
Per Abrahamsen committed
538 539 540 541 542 543
	      (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
544 545 546
  (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
547

Per Abrahamsen's avatar
Per Abrahamsen committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561
;;; 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)
562
      (error "Value does not match %S type" (car widget)))
Per Abrahamsen's avatar
Per Abrahamsen committed
563 564 565 566 567
    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."
568
  (let* ((children (widget-get (widget-get widget :parent) :children))
Per Abrahamsen's avatar
Per Abrahamsen committed
569 570 571 572 573 574 575 576 577
	 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
578 579 580 581 582 583 584 585 586 587 588
(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
589
		      (with-current-buffer buffer (overlay-lists))
Per Abrahamsen's avatar
Per Abrahamsen committed
590 591 592 593 594 595 596
		    (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)))))

597
;;; Images.
Per Abrahamsen's avatar
Per Abrahamsen committed
598

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

607
(defcustom widget-image-enable t
608
  "If non-nil, use image buttons in widgets when available."
609
  :version "21.1"
Per Abrahamsen's avatar
Per Abrahamsen committed
610 611 612
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
613 614 615 616 617 618 619 620 621 622
(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")))))

623 624 625
(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
626
extension (xpm, xbm, gif, jpg, or png) located in
627 628 629
`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
630
	 nil)
631 632 633
	((and (consp image)
	      (eq 'image (car image)))
	 ;; Already an image spec.  Use it.
Per Abrahamsen's avatar
Per Abrahamsen committed
634
	 image)
Per Abrahamsen's avatar
Per Abrahamsen committed
635 636
	((stringp image)
	 ;; A string.  Look it up in relevant directories.
637 638 639 640 641
	 (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)))
642
 	   (find-image (nreverse specs))))
Per Abrahamsen's avatar
Per Abrahamsen committed
643
	(t
Per Abrahamsen's avatar
Per Abrahamsen committed
644
	 ;; Oh well.
Per Abrahamsen's avatar
Per Abrahamsen committed
645 646
	 nil)))

647
(defvar widget-button-pressed-face 'widget-button-pressed
648 649 650 651 652
  "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
653
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
654 655 656 657 658
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."
659
  (if (and (featurep 'image)
660 661
	   (setq image (widget-image-find image)))
      (progn (widget-put widget :suppress-face t)
662
	     (insert-image image tag))
663
    (insert tag)))
Per Abrahamsen's avatar
Per Abrahamsen committed
664

665 666 667 668
(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)
669 670 671
  (let ((pos (widget-event-point event)))
    (if (and pos (get-char-property pos 'button))
	(widget-button-click event))))
672

Per Abrahamsen's avatar
Per Abrahamsen committed
673 674 675 676 677 678 679 680 681
;;; 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
682
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
683 684 685 686

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

Per Abrahamsen's avatar
Per Abrahamsen committed
689 690 691 692
;;; Creating Widgets.

;;;###autoload
(defun widget-create (type &rest args)
693
  "Create widget of TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
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
713
  (let ((widget (widget-copy type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
714 715 716 717 718 719 720 721 722 723
    (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
724
  (let ((widget (widget-copy type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738
    (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
739 740 741 742
(defun widget-copy (widget)
  "Make a deep copy of WIDGET."
  (widget-apply (copy-sequence widget) :copy))

Per Abrahamsen's avatar
Per Abrahamsen committed
743
(defun widget-convert (type &rest args)
744
  "Convert TYPE to a widget without inserting it in the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
745 746
The optional ARGS are additional keyword arguments."
  ;; Don't touch the type.
747
  (let* ((widget (if (symbolp type)
Per Abrahamsen's avatar
Per Abrahamsen committed
748
		     (list type)
749
		   (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
750
	 (current widget)
751
	 done
Per Abrahamsen's avatar
Per Abrahamsen committed
752 753 754
	 (keys args))
    ;; First set the :args keyword.
    (while (cdr current)		;Look in the type.
755 756 757 758 759 760 761 762 763 764
      (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))))
765 766
	(setcdr current (list :args (cdr current)))
	(setq current nil)))
767 768 769 770 771 772 773 774 775 776
    (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
777 778 779 780 781 782 783 784
    ;; 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.
785
    (while keys
Per Abrahamsen's avatar
Per Abrahamsen committed
786
      (let ((next (nth 0 keys)))
787 788
	(if (keywordp next)
	    (progn
Per Abrahamsen's avatar
Per Abrahamsen committed
789 790 791 792 793
	      (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)
794 795 796 797
	(widget-put widget
		    :value (widget-apply widget
					 :value-to-internal
					 (widget-get widget :value))))
Per Abrahamsen's avatar
Per Abrahamsen committed
798 799 800
    ;; Return the newly create widget.
    widget))

801
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
802
(defun widget-insert (&rest args)
803
  "Call `insert' with ARGS even if surrounding text is read only."
Per Abrahamsen's avatar
Per Abrahamsen committed
804
  (let ((inhibit-read-only t)
805
	(inhibit-modification-hooks t))
Per Abrahamsen's avatar
Per Abrahamsen committed
806
    (apply 'insert args)))
Per Abrahamsen's avatar
Per Abrahamsen committed
807

Per Abrahamsen's avatar
Per Abrahamsen committed
808 809 810
(defun widget-convert-text (type from to
				 &optional button-from button-to
				 &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
811
  "Return a widget of type TYPE with endpoint FROM TO.
812 813
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
814
BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets
Per Abrahamsen's avatar
Per Abrahamsen committed
815 816 817
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
818
	(from (copy-marker from))
819
	(to (copy-marker to)))
Per Abrahamsen's avatar
Per Abrahamsen committed
820 821 822 823 824 825 826 827
    (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
828
(defun widget-convert-button (type from to &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
829
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
830
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
831 832 833
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
834 835 836 837
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
838
  (let ((button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
839
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
840
	(doc (widget-get widget :doc-overlay))
841 842 843
	(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
844 845
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
846 847
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
848 849
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
850 851
    (when field
      (delete-overlay field))
852
    (mapc 'widget-leave-text (widget-get widget :children))))
Per Abrahamsen's avatar
Per Abrahamsen committed
853

Per Abrahamsen's avatar
Per Abrahamsen committed
854 855
;;; Keymap and Commands.

856 857 858
;; This alias exists only so that one can choose in doc-strings (e.g.
;; Custom-mode) which key-binding of widget-keymap one wants to refer to.
;; http://lists.gnu.org/archive/html/emacs-devel/2008-11/msg00480.html
859 860
(define-obsolete-function-alias 'advertised-widget-backward
  'widget-backward "23.2")
861

862
;;;###autoload
863 864 865
(defvar widget-keymap
  (let ((map (make-sparse-keymap)))
    (define-key map "\t" 'widget-forward)
866
    (define-key map "\e\t" 'widget-backward)
867 868
    (define-key map [(shift tab)] 'widget-backward)
    (put 'widget-backward :advertised-binding [(shift tab)])
869 870
    (define-key map [backtab] 'widget-backward)
    (define-key map [down-mouse-2] 'widget-button-click)
871
    (define-key map [down-mouse-1] 'widget-button-click)
Jason Rumney's avatar
Jason Rumney committed
872 873 874
    ;; The following definition needs to avoid using escape sequences that
    ;; might get converted to ^M when building loaddefs.el
    (define-key map [(control ?m)] 'widget-button-press)
875
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
876
  "Keymap containing useful binding for buffers containing widgets.
Glenn Morris's avatar
Glenn Morris committed
877 878
Recommended as a parent keymap for modes using widgets.
Note that such modes will need to require wid-edit.")
Per Abrahamsen's avatar
Per Abrahamsen committed
879 880

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

884 885 886 887 888
(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)
889
    ;; Since the widget code uses a `field' property to identify fields,
890
    ;; ordinary beginning-of-line does the right thing.
891
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
892
    (define-key map "\C-e" 'widget-end-of-line)
893
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
894 895
  "Keymap used inside an editable field.")

896 897
(defvar widget-text-keymap
  (let ((map (copy-keymap widget-keymap)))
898
    ;; Since the widget code uses a `field' property to identify fields,
899
    ;; ordinary beginning-of-line does the right thing.
900
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
901
    (define-key map "\C-e" 'widget-end-of-line)
902
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
903 904 905
  "Keymap used inside a text field.")

(defun widget-field-activate (pos &optional event)
Dave Love's avatar
Dave Love committed
906
  "Invoke the editable field at point."
Per Abrahamsen's avatar
Per Abrahamsen committed
907
  (interactive "@d")
Miles Bader's avatar
Miles Bader committed
908
  (let ((field (widget-field-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
909 910 911 912 913
    (if field
	(widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

914
(defface widget-button-pressed
915 916 917
  '((((min-colors 88) (class color))
     (:foreground "red1"))
    (((class color))
Per Abrahamsen's avatar
Per Abrahamsen committed
918 919
     (:foreground "red"))
    (t
920
     (:weight bold :underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
921
  "Face used for pressed buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
922
  :group 'widget-faces)
923 924
(define-obsolete-face-alias 'widget-button-pressed-face
  'widget-button-pressed "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
925

926 927 928 929
(defvar widget-button-click-moves-point nil
  "If non-nil, `widget-button-click' moves point to a button after invoking it.
If nil, point returns to its original position after invoking a button.")

Per Abrahamsen's avatar
Per Abrahamsen committed
930
(defun widget-button-click (event)
931
  "Invoke the button that the mouse is pointing at."
932
  (interactive "e")
933
  (if (widget-event-point event)
934 935 936
      (let* ((oevent event)
	     (mouse-1 (memq (event-basic-type event) '(mouse-1 down-mouse-1)))
	     (pos (widget-event-point event))
937
	     (start (event-start event))
938
	     (button (get-char-property
939
		      pos 'button (and (windowp (posn-window start))
940 941
				       (window-buffer (posn-window start)))))
	     newpoint)
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
	(when (or (null button)
		  (catch 'button-press-cancelled
	      ;; 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))
			 (pressed-face (or (widget-get button :pressed-face)
					   widget-button-pressed-face))
			 (face (overlay-get overlay 'face))
			 (mouse-face (overlay-get overlay 'mouse-face)))
		    (unwind-protect
			;; Read events, including mouse-movement
			;; events, waiting for a release event.  If we
			;; began with a mouse-1 event and receive a
			;; movement event, that means the user wants
			;; to perform drag-selection, so cancel the
			;; button press and do the default mouse-1
			;; action.  For mouse-2, just highlight/
			;; unhighlight the button the mouse was
			;; initially on when we move over it.
			(save-excursion
			  (when face	; avoid changing around image
			    (overlay-put overlay 'face pressed-face)
			    (overlay-put overlay 'mouse-face pressed-face))
			  (unless (widget-apply button :mouse-down-action event)
			    (let ((track-mouse t))
			      (while (not (widget-button-release-event-p event))
				(setq event (read-event))
				(when (and mouse-1 (mouse-movement-p event))
				  (push event unread-command-events)
				  (setq event oevent)
				  (throw 'button-press-cancelled t))
978 979 980 981 982 983 984 985 986 987 988 989
				(unless (or (integerp event)
					    (memq (car event) '(switch-frame select-window))
					    (eq (car event) 'scroll-bar-movement))
				  (setq pos (widget-event-point event))
				  (if (and pos
					   (eq (get-char-property pos 'button)
					       button))
				      (when face
					(overlay-put overlay 'face pressed-face)
					(overlay-put overlay 'mouse-face pressed-face))
				    (overlay-put overlay 'face face)
				    (overlay-put overlay 'mouse-face mouse-face))))))
990 991 992

			  ;; When mouse is released over the button, run
			  ;; its action function.
993 994 995 996 997
			  (when (and pos (eq (get-char-property pos 'button) button))
			    (goto-char pos)
			    (widget-apply-action button event)
			    (if widget-button-click-moves-point
				(setq newpoint (point)))))
998 999 1000
		      (overlay-put overlay 'face face)
		      (overlay-put overlay 'mouse-face mouse-face))))

1001
		(if newpoint (goto-char newpoint))
1002 1003 1004 1005 1006 1007 1008
		;; This loses if the widget action switches windows. -- cyd
		;; (unless (pos-visible-in-window-p (widget-event-point event))
		;;   (mouse-set-point event)
		;;   (beginning-of-line)
		;;   (recenter))
		)
	      nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
1009 1010 1011 1012
	  (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.
1013
	    (if mouse-1
1014
		(cond ((setq command	;down event
Richard M. Stallman's avatar
Richard M. Stallman committed
1015
			     (lookup-key widget-global-map [down-mouse-1]))
1016 1017
		       (setq up nil))
		      ((setq command	;up event
Richard M. Stallman's avatar
Richard M. Stallman committed
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
			     (lookup-key widget-global-map [mouse-1]))))
	      (cond ((setq command	;down event
			   (lookup-key widget-global-map [down-mouse-2]))
		     (setq up nil))
		    ((setq command	;up event
			   (lookup-key widget-global-map [mouse-2])))))
	    (when up
	      ;; Don't execute up events twice.
	      (while (not (widget-button-release-event-p event))
		(setq event (read-event))))
	    (when command
	      (call-interactively command)))))
1030
    (message "You clicked somewhere weird.")))
Per Abrahamsen's avatar
Per Abrahamsen committed
1031

Per Abrahamsen's avatar
Per Abrahamsen committed
1032
(defun widget-button-press (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
1033
  "Invoke button at POS."
Per Abrahamsen's avatar
Per Abrahamsen committed
1034
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
1035
  (let ((button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1036 1037 1038 1039 1040 1041
    (if button
	(widget-apply-action button event)
      (let ((command (lookup-key widget-global-map (this-command-keys))))
	(when (commandp command)
	  (call-interactively command))))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1042 1043 1044
(defun widget-tabable-at (&optional pos)
  "Return the tabable widget at POS, or nil.
POS defaults to the value of (point)."
Miles Bader's avatar
Miles Bader committed
1045
  (let ((widget (widget-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1046 1047 1048 1049
    (if widget
	(let ((order (widget-get widget :tab-order)))
	  (if order
	      (if (>= order 0)
1050 1051
		  widget)
	    widget)))))
Per Abrahamsen's avatar
Per Abrahamsen committed