wid-edit.el 117 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,97,1999,2000,01,02,2003, 2004, 2005  Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
4 5
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6
;; Maintainer: FSF
Per Abrahamsen's avatar
Per Abrahamsen committed
7 8
;; Keywords: extensions

9 10 11 12 13 14 15 16 17 18 19 20 21 22
;; 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
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
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 80 81 82
  :prefix "widget-"
  :group 'extensions
  :group 'hypermedia)

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

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

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

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

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

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

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

124 125 126
;; 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.
127 128 129 130 131 132 133 134 135 136 137
(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
138
  "Face used for editable fields."
Per Abrahamsen's avatar
Per Abrahamsen committed
139
  :group 'widget-faces)
140 141 142 143 144 145 146 147 148 149 150 151 152 153
;; 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
154 155
  "Face used for editable fields spanning only a single line."
  :group 'widget-faces)
156 157
;; backward-compatibility alias
(put 'widget-single-line-field-face 'face-alias 'widget-single-line-field)
Per Abrahamsen's avatar
Per Abrahamsen committed
158

159 160 161 162 163 164 165 166 167 168 169
;;; 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
170

Per Abrahamsen's avatar
Per Abrahamsen committed
171 172 173 174 175
;;; Utility functions.
;;
;; These are not really widget specific.

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
187 188 189 190 191 192
(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)

193 194 195 196 197 198 199
(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
200 201 202 203 204 205
  "*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
206 207 208 209
(defun widget-choose (title items &optional event)
  "Choose an item from a list.

First argument TITLE is the name of the list.
210
Second argument ITEMS is a list whose members are either
Per Abrahamsen's avatar
Per Abrahamsen committed
211 212
 (NAME . VALUE), to indicate selectable items, or just strings to
 indicate unselectable items.
Per Abrahamsen's avatar
Per Abrahamsen committed
213 214 215 216 217 218 219 220
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)
221
	      event (display-popup-menus-p))
222
	 ;; Mouse click.
Per Abrahamsen's avatar
Per Abrahamsen committed
223 224
	 (x-popup-menu event
		       (list title (cons "" items))))
225 226
	((or widget-menu-minibuffer-flag
	     (> (length items) widget-menu-max-shortcuts))
227
	 ;; Read the choice of name from the minibuffer.
228
	 (setq items (widget-remove-if 'stringp items))
Per Abrahamsen's avatar
Per Abrahamsen committed
229 230 231 232 233
	 (let ((val (completing-read (concat title ": ") items nil t)))
	   (if (stringp val)
	       (let ((try (try-completion val items)))
		 (when (stringp try)
		   (setq val try))
234
		 (cdr (assoc val items))))))
235 236 237
	(t
	 ;; Construct a menu of the choices
	 ;; and then use it for prompting for a single character.
238 239 240
	 (let* ((overriding-terminal-local-map (make-sparse-keymap))
		(next-digit ?0)
		map choice some-choice-enabled value)
241 242 243
	   ;; Define SPC as a prefix char to get to this menu.
	   (define-key overriding-terminal-local-map " "
	     (setq map (make-sparse-keymap title)))
244
	   (with-current-buffer (get-buffer-create " widget-choose")
245 246 247 248 249 250 251 252
	     (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))
253 254
		     (define-key map (vector next-digit) function)
		     (setq some-choice-enabled t)))
255 256 257 258
	       ;; 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"))
259 260
	   (or some-choice-enabled
	       (error "None of the choices is currently meaningful"))
261
	   (define-key map [?\C-g] 'keyboard-quit)
262
	   (define-key map [t] 'keyboard-quit)
263 264
	   (define-key map [?\M-\C-v] 'scroll-other-window)
	   (define-key map [?\M--] 'negative-argument)
265 266 267
	   (setcdr map (nreverse (cdr map)))
	   ;; Read a char with the menu, and return the result
	   ;; that corresponds to it.
268
	   (save-window-excursion
269
	     (let ((buf (get-buffer " widget-choose")))
270
	       (fit-window-to-buffer (display-buffer buf))
271 272 273 274 275 276 277
	       (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.
278
		   (setq unread-command-events (cons ?\  unread-command-events))
279
		   (setq keys (read-key-sequence title))
280 281
		   (setq value
			 (lookup-key overriding-terminal-local-map keys t)
282 283
			 char (string-to-char (substring keys 1)))
		   (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))
Miles Bader's avatar
Miles Bader committed
343 344 345 346 347 348 349 350
    (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)
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 380 381 382 383 384 385 386 387
	  (while (and (> end begin)
		      (eq (char-after (1- end)) ?\ ))
	    (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 403 404 405 406
      (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)))
407
    (overlay-put overlay 'pointer 'hand)
408
    (overlay-put overlay 'follow-link follow-link)
409 410 411 412 413 414 415 416 417 418
    (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
419 420

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

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

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

444 445 446 447 448 449 450 451
(defface widget-inactive '((((class grayscale color)
			     (background dark))
			    (:foreground "light gray"))
			   (((class grayscale color)
			     (background light))
			    (:foreground "dim gray"))
			   (t
			    (:slant italic)))
Per Abrahamsen's avatar
Per Abrahamsen committed
452
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
453
  :group 'widget-faces)
454 455
;; backward-compatibility alias
(put 'widget-inactive-face 'face-alias 'widget-inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
456 457 458 459 460

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

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


(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))

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

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

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

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

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

595
;;; Images.
Per Abrahamsen's avatar
Per Abrahamsen committed
596

597 598 599
(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
600
If this variable is nil, widget will try to locate the directory
Per Abrahamsen's avatar
Per Abrahamsen committed
601
automatically."
Per Abrahamsen's avatar
Per Abrahamsen committed
602 603 604
  :group 'widgets
  :type 'directory)

605 606 607
(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
608 609 610
  :group 'widgets
  :type 'boolean)

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

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

646
(defvar widget-button-pressed-face 'widget-button-pressed
647 648 649 650 651
  "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
652
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
653 654 655 656 657 658 659 660 661 662 663 664
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
665

Per Abrahamsen's avatar
Per Abrahamsen committed
666 667 668 669 670 671 672 673 674
;;; 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
675
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
676 677 678 679

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

Per Abrahamsen's avatar
Per Abrahamsen committed
682 683 684 685
;;; Creating Widgets.

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

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

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

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

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
831
  (let ((button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
832
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
833
	(doc (widget-get widget :doc-overlay))
834 835 836
	(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
837 838
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
839 840
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
841 842
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
843 844
    (when field
      (delete-overlay field))
845
    (mapc 'widget-leave-text (widget-get widget :children))))
Per Abrahamsen's avatar
Per Abrahamsen committed
846

Per Abrahamsen's avatar
Per Abrahamsen committed
847 848
;;; Keymap and Commands.

849
;;;###autoload
850 851 852 853 854 855 856 857
(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)
    (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
858 859 860 861
  "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
862
  "Keymap used for events a widget does not handle itself.")
Per Abrahamsen's avatar
Per Abrahamsen committed
863 864
(make-variable-buffer-local 'widget-global-map)

865 866 867 868 869
(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)
870
    ;; Since the widget code uses a `field' property to identify fields,
871
    ;; ordinary beginning-of-line does the right thing.
872
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
873
    (define-key map "\C-e" 'widget-end-of-line)
874
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
875 876
  "Keymap used inside an editable field.")

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

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

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

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

956 957 958 959 960
			;; 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)))
961 962 963
		    (overlay-put overlay 'face face)
		    (overlay-put overlay 'mouse-face mouse-face))))

964 965 966 967 968
	      (unless (pos-visible-in-window-p (widget-event-point event))
		(mouse-set-point event)
		(beginning-of-line)
		(recenter))
	      )
969

Richard M. Stallman's avatar
Richard M. Stallman committed
970 971 972 973 974 975
	  (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))
976
		(cond ((setq command	;down event
Richard M. Stallman's avatar
Richard M. Stallman committed
977
			     (lookup-key widget-global-map [down-mouse-1]))
978 979
		       (setq up nil))
		      ((setq command	;up event
Richard M. Stallman's avatar
Richard M. Stallman committed
980 981 982 983 984 985 986 987 988 989 990 991
			     (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)))))
992
    (message "You clicked somewhere weird.")))
Per Abrahamsen's avatar
Per Abrahamsen committed
993

Per Abrahamsen's avatar
Per Abrahamsen committed
994
(defun widget-button-press (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
995
  "Invoke button at POS."
Per Abrahamsen's avatar
Per Abrahamsen committed
996
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
997
  (let ((button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
998 999 1000 1001 1002 1003
    (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
1004 1005 1006
(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
1007
  (let ((widget (widget-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1008 1009 1010 1011
    (if widget
	(let ((order (widget-get widget :tab-order)))
	  (if order
	      (if (>= order 0)
1012 1013
		  widget)
	    widget)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1014

1015
(defvar widget-use-overlay-change t
Per Abrahamsen's avatar
Per Abrahamsen committed
1016
  "If non-nil, use overlay change functions to tab around in the buffer.
1017
This is much faster, but doesn't work reliably on Emacs 19.34.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1018

Per Abrahamsen's avatar
Per Abrahamsen committed
1019 1020 1021
(defun widget-move (arg)
  "Move point to the ARG next field or button.
ARG may be negative to move backward."
Per Abrahamsen's avatar
Per Abrahamsen committed
1022
  (or (bobp) (> arg 0) (backward-char))
1023
  (let ((wrapped 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
1024
	(number arg)
1025
	(old (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1026 1027
    ;; Forward.
    (while (> arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
1028
      (cond ((eobp)
1029 1030
	     (goto-char (point-min))
	     (setq wrapped (1+ wrapped)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1031 1032 1033 1034
	    (widget-use-overlay-change
	     (goto-char (next-overlay-change (point))))
	    (t
	     (forward-char 1)))
1035
      (and (= wrapped 2)
Per Abrahamsen's avatar
Per Abrahamsen committed
1036 1037
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
1038
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1039 1040
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
1041
	    (setq arg (1- arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
1042 1043 1044
	    (setq old new)))))
    ;; Backward.
    (while (< arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
1045
      (cond ((bobp)
1046 1047
	     (goto-char (point-max))
	     (setq wrapped (1+ wrapped)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1048 1049 1050 1051
	    (widget-use-overlay-change
	     (goto-char (previous-overlay-change (point))))
	    (t
	     (backward-char 1)))
1052
      (and (= wrapped 2)
Per Abrahamsen's avatar
Per Abrahamsen committed
1053 1054
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
1055
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1056 1057
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
1058 1059 1060 1061
	    (setq arg (1+ arg))))))
    (let ((new (widget-tabable-at)))
      (while (eq (widget-tabable-at) new)
	(backward-char)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1062 1063 1064
    (forward-char))
  (widget-echo-help (point))
  (run-hooks 'widget-move-hook))
Per Abrahamsen's avatar
Per Abrahamsen committed
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

(defun widget-forward (arg)
  "Move point to the next field or button.
With optional ARG, move across that many fields."
  (interactive "p")
  (run-hooks 'widget-forward-hook)
  (widget-move arg))

(defun widget-backward (arg)
  "Move point to the previous field or button.
With optional ARG, move across that many fields."
  (interactive "p")
  (run-hooks 'widget-backward-hook)
  (widget-move (- arg)))

1080
;; Since the widget code uses a `field' property to identify fields,
1081
;; ordinary beginning-of-line does the right thing.
1082
(defalias 'widget-beginning-of-line 'beginning-of-line)
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096

(defun widget-end-of-line ()
  "Go to end of field or end of line, whichever is first.
Trailing spaces at the end of padded fields are not considered part of
the field."
  (interactive)
  ;; Ordinary end-of-line does the right thing, because we're inside
  ;; text with a `field' property.
  (end-of-line)
  (unless (eolp)
    ;; ... except that we want to ignore trailing spaces in fields that
    ;; aren't terminated by a newline, because they are used as padding,
    ;; and ignored when extracting the entered value of the field.
    (skip-chars-backward " " (field-beginning (1- (point))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1097 1098 1099 1100

(defun widget-kill-line ()
  "Kill to end of field or end of line, whichever is first."
  (interactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
1101 1102
  (let* ((field (widget-field-find (point)))
	 (end (and field (widget-field-end field))))