wid-edit.el 112 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 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 23 24 25
;; 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
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
;;; 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
(autoload 'pp-to-string "pp")
(autoload 'Info-goto-node "info")
Per Abrahamsen's avatar
Per Abrahamsen committed
68

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

;;; Customization.

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

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

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

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

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

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

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

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

123 124 125 126 127 128
;; TTY gets special definitions here and in the next defface, because
;; the gray colors defined for other displays cause black text on a black
;; background, at least on light-background TTYs.
(defface widget-field-face '((((type tty))
			      (:background "yellow3"))
			     (((class grayscale color)
Per Abrahamsen's avatar
Per Abrahamsen committed
129
			       (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
130
			      (:background "gray85"))
Per Abrahamsen's avatar
Per Abrahamsen committed
131 132
			     (((class grayscale color)
			       (background dark))
Per Abrahamsen's avatar
Per Abrahamsen committed
133
			      (:background "dim gray"))
134
			     (t
135
			      (: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)
Per Abrahamsen's avatar
Per Abrahamsen committed
138

139 140 141
(defface widget-single-line-field-face '((((type tty))
					  (:background "green3"))
					 (((class grayscale color)
Per Abrahamsen's avatar
Per Abrahamsen committed
142 143 144 145 146
					   (background light))
					  (:background "gray85"))
					 (((class grayscale color)
					   (background dark))
					  (:background "dim gray"))
147
					 (t
148
					  (:slant italic)))
Per Abrahamsen's avatar
Per Abrahamsen committed
149 150 151
  "Face used for editable fields spanning only a single line."
  :group 'widget-faces)

152 153 154 155 156 157 158 159 160 161 162
;;; 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
163

Per Abrahamsen's avatar
Per Abrahamsen committed
164 165 166 167 168
;;; Utility functions.
;;
;; These are not really widget specific.

(defun widget-princ-to-string (object)
169 170 171 172 173
  "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
174 175 176 177 178 179

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

Per Abrahamsen's avatar
Per Abrahamsen committed
180 181 182 183 184 185
(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)

186 187 188 189 190 191 192
(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
193 194 195 196 197 198
  "*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
199 200 201 202
(defun widget-choose (title items &optional event)
  "Choose an item from a list.

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

293 294 295 296 297 298 299 300
(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
301 302
;;; Widget text specifications.
;; 
303
;; These functions are for specifying text properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
304

305
(defvar widget-field-add-space t
Per Abrahamsen's avatar
Per Abrahamsen committed
306 307
  "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
308
size field.")
Per Abrahamsen's avatar
Per Abrahamsen committed
309

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

Per Abrahamsen's avatar
Per Abrahamsen committed
316
(defun widget-specify-field (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
317
  "Specify editable button for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
318 319 320 321 322
  ;; 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
323 324 325 326
    (cond ((null (widget-get widget :size))
	   (forward-char 1))
	  (widget-field-add-space
	   (insert-and-inherit " ")))
Per Abrahamsen's avatar
Per Abrahamsen committed
327
    (setq to (point)))
Miles Bader's avatar
Miles Bader committed
328 329 330 331 332
  (let ((keymap (widget-get widget :keymap))
	(face (or (widget-get widget :value-face) 'widget-field-face))
	(help-echo (widget-get widget :help-echo))
	(rear-sticky
	 (or (not widget-field-add-space) (widget-get widget :size))))
333 334
    (if (functionp help-echo)
      (setq help-echo 'widget-mouse-help))    
Miles Bader's avatar
Miles Bader committed
335 336 337 338 339 340 341 342
    (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)
343 344 345
	;; 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
346 347 348 349 350 351 352 353
	(overlay-put overlay 'face face)
	(overlay-put overlay 'help-echo help-echo))
      (setq to (1- to))
      (setq rear-sticky t))
    (let ((overlay (make-overlay from to nil nil rear-sticky)))
      (widget-put widget :field-overlay overlay)
      ;;(overlay-put overlay 'detachable nil)
      (overlay-put overlay 'field widget)
354
      (overlay-put overlay 'local-map keymap)
Miles Bader's avatar
Miles Bader committed
355 356
      (overlay-put overlay 'face face)
      (overlay-put overlay 'help-echo help-echo)))
357 358 359 360 361 362 363 364 365
  (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)))
366
	(when size
367 368 369 370 371 372 373 374 375
	  (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
376 377

(defun widget-specify-button (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
378
  "Specify button for WIDGET between FROM and TO."
379 380
  (let ((overlay (make-overlay from to nil t nil))
	(help-echo (widget-get widget :help-echo)))
Per Abrahamsen's avatar
Per Abrahamsen committed
381
    (widget-put widget :button-overlay overlay)
382 383
    (if (functionp help-echo)
      (setq help-echo 'widget-mouse-help))
Per Abrahamsen's avatar
Per Abrahamsen committed
384
    (overlay-put overlay 'button widget)
385
    (overlay-put overlay 'keymap (widget-get widget :keymap))
386 387
    ;; We want to avoid the face with image buttons.
    (unless (widget-get widget :suppress-face)
388
      (overlay-put overlay 'face (widget-apply widget :button-face-get))
389
      (overlay-put overlay 'mouse-face widget-mouse-face))
390 391 392 393 394 395 396 397 398 399
    (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
400 401

(defun widget-specify-sample (widget from to)
402
  "Specify sample for WIDGET between FROM and TO."
403 404
  (let ((overlay (make-overlay from to nil t nil)))
    (overlay-put overlay 'face (widget-apply widget :sample-face-get))
Per Abrahamsen's avatar
Per Abrahamsen committed
405 406
    (widget-put widget :sample-overlay overlay)))

Per Abrahamsen's avatar
Per Abrahamsen committed
407
(defun widget-specify-doc (widget from to)
408
  "Specify documentation for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
409 410 411 412
  (let ((overlay (make-overlay from to nil t nil)))
    (overlay-put overlay 'widget-doc widget)
    (overlay-put overlay 'face widget-documentation-face)
    (widget-put widget :doc-overlay overlay)))
Per Abrahamsen's avatar
Per Abrahamsen committed
413 414

(defmacro widget-specify-insert (&rest form)
415 416 417
  "Execute FORM without inheriting any text properties."
  `(save-restriction
    (let ((inhibit-read-only t)
418 419
	  (inhibit-modification-hooks t)
	  result)
420 421 422 423 424 425 426 427
      (insert "<>")
      (narrow-to-region (- (point) 2) (point))
      (goto-char (1+ (point-min)))
      (setq result (progn ,@form))
      (delete-region (point-min) (1+ (point-min)))
      (delete-region (1- (point-max)) (point-max))
      (goto-char (point-max))
      result)))
Per Abrahamsen's avatar
Per Abrahamsen committed
428 429 430 431 432 433

(defface widget-inactive-face '((((class grayscale color)
				  (background dark))
				 (:foreground "light gray"))
				(((class grayscale color)
				  (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
434
				 (:foreground "dim gray"))
435
				(t
436
				 (:slant italic)))
Per Abrahamsen's avatar
Per Abrahamsen committed
437
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
438
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
439 440 441 442 443 444

(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)))
      (overlay-put overlay 'face 'widget-inactive-face)
Per Abrahamsen's avatar
Per Abrahamsen committed
445 446
      ;; This is disabled, as it makes the mouse cursor change shape.
      ;; (overlay-put overlay 'mouse-face 'widget-inactive-face)
Per Abrahamsen's avatar
Per Abrahamsen committed
447 448
      (overlay-put overlay 'evaporate t)
      (overlay-put overlay 'priority 100)
449
      (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
Per Abrahamsen's avatar
Per Abrahamsen committed
450 451 452 453 454
      (widget-put widget :inactive overlay))))

(defun widget-overlay-inactive (&rest junk)
  "Ignoring the arguments, signal an error."
  (unless inhibit-read-only
455
    (error "The widget here is not active")))
Per Abrahamsen's avatar
Per Abrahamsen committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470


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

471 472 473 474 475 476 477 478
;;;###autoload
(defun widgetp (widget)
  "Return non-nil iff WIDGET is a widget."
  (if (symbolp widget)
      (get widget 'widget-type)
    (and (consp widget)
	 (get (widget-type widget) 'widget-type))))

Per Abrahamsen's avatar
Per Abrahamsen committed
479 480
(defun widget-get-indirect (widget property)
  "In WIDGET, get the value of PROPERTY.
481
If the value is a symbol, return its binding.
Per Abrahamsen's avatar
Per Abrahamsen committed
482 483 484 485 486 487
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
488 489
(defun widget-member (widget property)
  "Non-nil iff there is a definition in WIDGET for PROPERTY."
490
  (cond ((plist-member (cdr widget) property)
Per Abrahamsen's avatar
Per Abrahamsen committed
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
	 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)))

507
(defun widget-default-get (widget)
508
  "Extract the default value of WIDGET."
509 510 511
  (or (widget-get widget :value)
      (widget-apply widget :default-get)))

Per Abrahamsen's avatar
Per Abrahamsen committed
512
(defun widget-match-inline (widget vals)
513
  "In WIDGET, match the start of VALS."
Per Abrahamsen's avatar
Per Abrahamsen committed
514 515
  (cond ((widget-get widget :inline)
	 (widget-apply widget :match-inline vals))
516
	((and (listp vals)
Per Abrahamsen's avatar
Per Abrahamsen committed
517 518 519 520 521 522
	      (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
523 524 525
  (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
526

Per Abrahamsen's avatar
Per Abrahamsen committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540
;;; 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)
541
      (error "Value does not match %S type" (car widget)))
Per Abrahamsen's avatar
Per Abrahamsen committed
542 543 544 545 546
    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."
547
  (let* ((children (widget-get (widget-get widget :parent) :children))
Per Abrahamsen's avatar
Per Abrahamsen committed
548 549 550 551 552 553 554 555 556
	 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
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
(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)
	(parent nil)
	(overlays (if buffer
		      (save-excursion (set-buffer buffer) (overlay-lists))
		    (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)))))

577
;;; Images.
Per Abrahamsen's avatar
Per Abrahamsen committed
578

579 580 581
(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
582
If this variable is nil, widget will try to locate the directory
Per Abrahamsen's avatar
Per Abrahamsen committed
583
automatically."
Per Abrahamsen's avatar
Per Abrahamsen committed
584 585 586
  :group 'widgets
  :type 'directory)

587 588 589
(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
590 591 592
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
593 594 595 596 597 598 599 600 601 602
(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")))))

603 604 605
(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
606
extension (xpm, xbm, gif, jpg, or png) located in
607 608 609
`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
610
	 nil)
611 612 613
	((and (consp image)
	      (eq 'image (car image)))
	 ;; Already an image spec.  Use it.
Per Abrahamsen's avatar
Per Abrahamsen committed
614
	 image)
Per Abrahamsen's avatar
Per Abrahamsen committed
615 616
	((stringp image)
	 ;; A string.  Look it up in relevant directories.
617 618 619 620 621 622 623
	 (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
624
	(t
Per Abrahamsen's avatar
Per Abrahamsen committed
625
	 ;; Oh well.
Per Abrahamsen's avatar
Per Abrahamsen committed
626 627
	 nil)))

628 629 630 631 632 633
(defvar widget-button-pressed-face 'widget-button-pressed-face
  "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
634
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
635 636 637 638 639 640 641 642 643 644 645 646
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
647

Per Abrahamsen's avatar
Per Abrahamsen committed
648 649 650 651 652 653 654 655 656
;;; 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
657
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
658 659 660 661

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

Per Abrahamsen's avatar
Per Abrahamsen committed
664 665 666 667
;;; Creating Widgets.

;;;###autoload
(defun widget-create (type &rest args)
668
  "Create widget of TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
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."
688
  (let ((widget (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
689 690 691 692 693 694 695 696 697 698
    (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."
699
  (let ((widget (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
    (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))

(defun widget-convert (type &rest args)
715
  "Convert TYPE to a widget without inserting it in the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
716 717
The optional ARGS are additional keyword arguments."
  ;; Don't touch the type.
718
  (let* ((widget (if (symbolp type)
Per Abrahamsen's avatar
Per Abrahamsen committed
719
		     (list type)
720
		   (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
721 722 723 724
	 (current widget)
	 (keys args))
    ;; First set the :args keyword.
    (while (cdr current)		;Look in the type.
725 726 727 728
      (if (keywordp (car (cdr current)))
	  (setq current (cdr (cdr current)))
	(setcdr current (list :args (cdr current)))
	(setq current nil)))
Per Abrahamsen's avatar
Per Abrahamsen committed
729
    (while args				;Look in the args.
730 731 732 733
      (if (keywordp (nth 0 args))
	  (setq args (nthcdr 2 args))
	(widget-put widget :args args)
	(setq args nil)))
Per Abrahamsen's avatar
Per Abrahamsen committed
734 735 736 737 738 739 740 741
    ;; 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.
742
    (while keys
Per Abrahamsen's avatar
Per Abrahamsen committed
743
      (let ((next (nth 0 keys)))
744 745
	(if (keywordp next)
	    (progn
Per Abrahamsen's avatar
Per Abrahamsen committed
746 747 748 749 750
	      (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)
751 752 753 754
	(widget-put widget
		    :value (widget-apply widget
					 :value-to-internal
					 (widget-get widget :value))))
Per Abrahamsen's avatar
Per Abrahamsen committed
755 756 757
    ;; Return the newly create widget.
    widget))

758
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
759
(defun widget-insert (&rest args)
760
  "Call `insert' with ARGS even if surrounding text is read only."
Per Abrahamsen's avatar
Per Abrahamsen committed
761
  (let ((inhibit-read-only t)
762
	(inhibit-modification-hooks t))
Per Abrahamsen's avatar
Per Abrahamsen committed
763
    (apply 'insert args)))
Per Abrahamsen's avatar
Per Abrahamsen committed
764

Per Abrahamsen's avatar
Per Abrahamsen committed
765 766 767
(defun widget-convert-text (type from to
				 &optional button-from button-to
				 &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
768
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
769
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
770 771
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
772 773 774
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
775
	(from (copy-marker from))
776
	(to (copy-marker to)))
Per Abrahamsen's avatar
Per Abrahamsen committed
777 778 779 780 781 782 783 784
    (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
785
(defun widget-convert-button (type from to &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
786
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
787
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
788 789 790
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
791 792 793 794
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
795
  (let ((button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
796
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
797
	(doc (widget-get widget :doc-overlay))
798 799 800
	(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
801 802
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
803 804
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
805 806
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
807 808
    (when field
      (delete-overlay field))
809
    (mapc 'widget-leave-text (widget-get widget :children))))
Per Abrahamsen's avatar
Per Abrahamsen committed
810

Per Abrahamsen's avatar
Per Abrahamsen committed
811 812
;;; Keymap and Commands.

813
;;;###autoload
814 815 816 817 818 819 820 821
(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
822 823 824 825
  "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
826
  "Keymap used for events a widget does not handle itself.")
Per Abrahamsen's avatar
Per Abrahamsen committed
827 828
(make-variable-buffer-local 'widget-global-map)

829 830 831 832 833
(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)
834
    ;; Since the widget code uses a `field' property to identify fields,
835
    ;; ordinary beginning-of-line does the right thing.
836
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
837
    (define-key map "\C-e" 'widget-end-of-line)
838
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
839 840
  "Keymap used inside an editable field.")

841 842
(defvar widget-text-keymap
  (let ((map (copy-keymap widget-keymap)))
843
    ;; Since the widget code uses a `field' property to identify fields,
844
    ;; ordinary beginning-of-line does the right thing.
845
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
846
    (define-key map "\C-e" 'widget-end-of-line)
847
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
848 849 850
  "Keymap used inside a text field.")

(defun widget-field-activate (pos &optional event)
Dave Love's avatar
Dave Love committed
851
  "Invoke the editable field at point."
Per Abrahamsen's avatar
Per Abrahamsen committed
852
  (interactive "@d")
Miles Bader's avatar
Miles Bader committed
853
  (let ((field (widget-field-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
854 855 856 857 858
    (if field
	(widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

859
(defface widget-button-pressed-face
Per Abrahamsen's avatar
Per Abrahamsen committed
860 861 862
  '((((class color))
     (:foreground "red"))
    (t
863
     (:weight bold :underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
864
  "Face used for pressed buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
865
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
866

Per Abrahamsen's avatar
Per Abrahamsen committed
867
(defun widget-button-click (event)
868
  "Invoke the button that the mouse is pointing at."
869
  (interactive "e")
870
  (if (widget-event-point event)
871
      (let* ((pos (widget-event-point event))
872 873 874 875
	     (start (event-start event))
	     (button (get-char-property 
		      pos 'button (and (windowp (posn-window start))
				       (window-buffer (posn-window start))))))
876 877 878 879
	(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.
880
	    (save-selected-window
881
	      (select-window (posn-window (event-start event)))
882
	      (save-excursion
883
		(goto-char (posn-point (event-start event)))
884 885 886 887
		(let* ((overlay (widget-get button :button-overlay))
		       (face (overlay-get overlay 'face))
		       (mouse-face (overlay-get overlay 'mouse-face)))
		  (unwind-protect
888 889 890 891
		      ;; 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.
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
		      (let ((track-mouse t))
			(save-excursion
			  (when face	; avoid changing around image
			    (overlay-put overlay
					 'face widget-button-pressed-face)
			    (overlay-put overlay
					 'mouse-face widget-button-pressed-face))
			  (unless (widget-apply button :mouse-down-action event)
			    (while (not (widget-button-release-event-p event))
			      (setq event (read-event)
				    pos (widget-event-point event))
			      (if (and pos
				       (eq (get-char-property pos 'button)
					   button))
				  (when face
				    (overlay-put overlay
						 'face
						 widget-button-pressed-face)
				    (overlay-put overlay
						 'mouse-face
						 widget-button-pressed-face))
				(overlay-put overlay 'face face)
				(overlay-put overlay 'mouse-face mouse-face))))
915 916 917

			  ;; When mouse is released over the button, run
			  ;; its action function.
918 919 920 921 922 923
			  (when (and pos
				     (eq (get-char-property pos 'button) button))
			    (widget-apply-action button event))))
		    (overlay-put overlay 'face face)
		    (overlay-put overlay 'mouse-face mouse-face))))

924 925 926 927 928
	      (unless (pos-visible-in-window-p (widget-event-point event))
		(mouse-set-point event)
		(beginning-of-line)
		(recenter))
	      )
929 930 931 932 933 934

	    (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)
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
	      (if (memq (event-basic-type event) '(mouse-1 down-mouse-1))
		  (cond ((setq command	;down event
			       (lookup-key widget-global-map [down-mouse-1]))
			 (setq up nil))
			((setq command	;up event
			       (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)))))
    (message "You clicked somewhere weird.")))
Per Abrahamsen's avatar
Per Abrahamsen committed
953

Per Abrahamsen's avatar
Per Abrahamsen committed
954
(defun widget-button-press (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
955
  "Invoke button at POS."
Per Abrahamsen's avatar
Per Abrahamsen committed
956
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
957
  (let ((button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
958 959 960 961 962 963
    (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
964 965 966
(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
967
  (let ((widget (widget-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
968 969 970 971
    (if widget
	(let ((order (widget-get widget :tab-order)))
	  (if order
	      (if (>= order 0)
972 973
		  widget)
	    widget)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
974

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

Per Abrahamsen's avatar
Per Abrahamsen committed
979 980 981
(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
982
  (or (bobp) (> arg 0) (backward-char))
Per Abrahamsen's avatar
Per Abrahamsen committed
983
  (let ((pos (point))
Per Abrahamsen's avatar
Per Abrahamsen committed
984
	(number arg)
Per Abrahamsen's avatar
Per Abrahamsen committed
985
	(old (widget-tabable-at))
Per Abrahamsen's avatar
Per Abrahamsen committed
986 987 988
	new)
    ;; Forward.
    (while (> arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
989 990 991 992 993 994
      (cond ((eobp)
	     (goto-char (point-min)))
	    (widget-use-overlay-change
	     (goto-char (next-overlay-change (point))))
	    (t
	     (forward-char 1)))
Per Abrahamsen's avatar
Per Abrahamsen committed
995 996 997
      (and (eq pos (point))
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
998
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
999 1000
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
1001
	    (setq arg (1- arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
1002 1003 1004
	    (setq old new)))))
    ;; Backward.
    (while (< arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
1005 1006 1007 1008 1009 1010
      (cond ((bobp)
	     (goto-char (point-max)))
	    (widget-use-overlay-change
	     (goto-char (previous-overlay-change (point))))
	    (t
	     (backward-char 1)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1011 1012 1013
      (and (eq pos (point))
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
1014
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1015 1016
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
1017 1018 1019 1020
	    (setq arg (1+ arg))))))
    (let ((new (widget-tabable-at)))
      (while (eq (widget-tabable-at) new)
	(backward-char)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1021 1022 1023
    (forward-char))
  (widget-echo-help (point))
  (run-hooks 'widget-move-hook))
Per Abrahamsen's avatar
Per Abrahamsen committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038

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