wid-edit.el 116 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
;;
Per Abrahamsen's avatar
Per Abrahamsen committed
3
;; Copyright (C) 1996,97,1999,2000,01,02,2003, 2004  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 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-face
93
  "Face used for documentation strings in widgets.
94 95
This exists as a variable so it can be set locally in certain buffers.")

Per Abrahamsen's avatar
Per Abrahamsen committed
96 97 98 99 100 101 102 103 104 105 106
(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)

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

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

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

120 121 122 123
;; 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))
124 125
			      :background "yellow3"
			      :foreground "black")
126
			     (((class grayscale color)
Per Abrahamsen's avatar
Per Abrahamsen committed
127
			       (background light))
128
			      :background "gray85")
Per Abrahamsen's avatar
Per Abrahamsen committed
129 130
			     (((class grayscale color)
			       (background dark))
131
			      :background "dim gray")
132
			     (t
133
			      :slant italic))
Per Abrahamsen's avatar
Per Abrahamsen committed
134
  "Face used for editable fields."
Per Abrahamsen's avatar
Per Abrahamsen committed
135
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
136

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

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

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

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

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

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

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

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

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

303 304
;; 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
305 306
  "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
307
size field.")
Per Abrahamsen's avatar
Per Abrahamsen committed
308

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

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

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

(defun widget-specify-sample (widget from to)
401
  "Specify sample for WIDGET between FROM and TO."
402 403
  (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
404 405
    (widget-put widget :sample-overlay overlay)))

Per Abrahamsen's avatar
Per Abrahamsen committed
406
(defun widget-specify-doc (widget from to)
407
  "Specify documentation for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
408 409 410 411
  (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
412 413

(defmacro widget-specify-insert (&rest form)
414 415 416
  "Execute FORM without inheriting any text properties."
  `(save-restriction
    (let ((inhibit-read-only t)
417 418 419 420
	  (inhibit-modification-hooks t))
      (narrow-to-region (point) (point))
      (prog1 (progn ,@form)
	(goto-char (point-max))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
421 422 423 424 425 426

(defface widget-inactive-face '((((class grayscale color)
				  (background dark))
				 (:foreground "light gray"))
				(((class grayscale color)
				  (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
427
				 (:foreground "dim gray"))
428
				(t
429
				 (:slant italic)))
Per Abrahamsen's avatar
Per Abrahamsen committed
430
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
431
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
432 433 434 435 436 437

(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
438 439
      ;; 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
440 441
      (overlay-put overlay 'evaporate t)
      (overlay-put overlay 'priority 100)
442
      (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
Per Abrahamsen's avatar
Per Abrahamsen committed
443 444 445 446 447
      (widget-put widget :inactive overlay))))

(defun widget-overlay-inactive (&rest junk)
  "Ignoring the arguments, signal an error."
  (unless inhibit-read-only
448
    (error "The widget here is not active")))
Per Abrahamsen's avatar
Per Abrahamsen committed
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463


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

464 465 466 467 468 469
;;;###autoload
(defun widgetp (widget)
  "Return non-nil iff WIDGET is a widget."
  (if (symbolp widget)
      (get widget 'widget-type)
    (and (consp widget)
470 471
	 (symbolp (car widget))
	 (get (car widget) 'widget-type))))
472

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

501
(defun widget-default-get (widget)
Per Abrahamsen's avatar
Per Abrahamsen committed
502
  "Extract the default external value of WIDGET."
503
  (widget-apply widget :value-to-external
Per Abrahamsen's avatar
Per Abrahamsen committed
504 505
		(or (widget-get widget :value)
		    (widget-apply widget :default-get))))
506

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

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

571
;;; Images.
Per Abrahamsen's avatar
Per Abrahamsen committed
572

573 574 575
(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
576
If this variable is nil, widget will try to locate the directory
Per Abrahamsen's avatar
Per Abrahamsen committed
577
automatically."
Per Abrahamsen's avatar
Per Abrahamsen committed
578 579 580
  :group 'widgets
  :type 'directory)

581 582 583
(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
584 585 586
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
587 588 589 590 591 592 593 594 595 596
(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")))))

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

622 623 624 625 626 627
(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
628
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
629 630 631 632 633 634 635 636 637 638 639 640
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
641

Per Abrahamsen's avatar
Per Abrahamsen committed
642 643 644 645 646 647 648 649 650
;;; 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
651
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
652 653 654 655

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

Per Abrahamsen's avatar
Per Abrahamsen committed
658 659 660 661
;;; Creating Widgets.

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

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

770
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
771
(defun widget-insert (&rest args)
772
  "Call `insert' with ARGS even if surrounding text is read only."
Per Abrahamsen's avatar
Per Abrahamsen committed
773
  (let ((inhibit-read-only t)
774
	(inhibit-modification-hooks t))
Per Abrahamsen's avatar
Per Abrahamsen committed
775
    (apply 'insert args)))
Per Abrahamsen's avatar
Per Abrahamsen committed
776

Per Abrahamsen's avatar
Per Abrahamsen committed
777 778 779
(defun widget-convert-text (type from to
				 &optional button-from button-to
				 &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
780
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
781
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
782 783
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
784 785 786
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
787
	(from (copy-marker from))
788
	(to (copy-marker to)))
Per Abrahamsen's avatar
Per Abrahamsen committed
789 790 791 792 793 794 795 796
    (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
797
(defun widget-convert-button (type from to &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
798
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
799
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
800 801 802
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
803 804 805 806
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
807
  (let ((button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
808
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
809
	(doc (widget-get widget :doc-overlay))
810 811 812
	(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
813 814
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
815 816
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
817 818
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
819 820
    (when field
      (delete-overlay field))
821
    (mapc 'widget-leave-text (widget-get widget :children))))
Per Abrahamsen's avatar
Per Abrahamsen committed
822

Per Abrahamsen's avatar
Per Abrahamsen committed
823 824
;;; Keymap and Commands.

825
;;;###autoload
826 827 828 829 830 831 832 833
(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
834 835 836 837
  "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
838
  "Keymap used for events a widget does not handle itself.")
Per Abrahamsen's avatar
Per Abrahamsen committed
839 840
(make-variable-buffer-local 'widget-global-map)

841 842 843 844 845
(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)
846
    ;; Since the widget code uses a `field' property to identify fields,
847
    ;; ordinary beginning-of-line does the right thing.
848
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
849
    (define-key map "\C-e" 'widget-end-of-line)
850
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
851 852
  "Keymap used inside an editable field.")

853 854
(defvar widget-text-keymap
  (let ((map (copy-keymap widget-keymap)))
855
    ;; Since the widget code uses a `field' property to identify fields,
856
    ;; ordinary beginning-of-line does the right thing.
857
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
858
    (define-key map "\C-e" 'widget-end-of-line)
859
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
860 861 862
  "Keymap used inside a text field.")

(defun widget-field-activate (pos &optional event)
Dave Love's avatar
Dave Love committed
863
  "Invoke the editable field at point."
Per Abrahamsen's avatar
Per Abrahamsen committed
864
  (interactive "@d")
Miles Bader's avatar
Miles Bader committed
865
  (let ((field (widget-field-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
866 867 868 869 870
    (if field
	(widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

871
(defface widget-button-pressed-face
Per Abrahamsen's avatar
Per Abrahamsen committed
872 873 874
  '((((class color))
     (:foreground "red"))
    (t
875
     (:weight bold :underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
876
  "Face used for pressed buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
877
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
878

Per Abrahamsen's avatar
Per Abrahamsen committed
879
(defun widget-button-click (event)
880
  "Invoke the button that the mouse is pointing at."
881
  (interactive "e")
882
  (if (widget-event-point event)
883
      (let* ((pos (widget-event-point event))
884
	     (start (event-start event))
885
	     (button (get-char-property
886 887
		      pos 'button (and (windowp (posn-window start))
				       (window-buffer (posn-window start))))))
888 889 890 891
	(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.
892
	    (save-selected-window
893
	      (select-window (posn-window (event-start event)))
894
	      (save-excursion
895
		(goto-char (posn-point (event-start event)))
896 897 898 899
		(let* ((overlay (widget-get button :button-overlay))
		       (face (overlay-get overlay 'face))
		       (mouse-face (overlay-get overlay 'mouse-face)))
		  (unwind-protect
900 901 902 903
		      ;; 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.
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
		      (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))))
927 928 929

			  ;; When mouse is released over the button, run
			  ;; its action function.
930 931 932 933 934 935
			  (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))))

936 937 938 939 940
	      (unless (pos-visible-in-window-p (widget-event-point event))
		(mouse-set-point event)
		(beginning-of-line)
		(recenter))
	      )
941 942 943 944 945 946

	    (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)
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
	      (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
965

Per Abrahamsen's avatar
Per Abrahamsen committed
966
(defun widget-button-press (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
967
  "Invoke button at POS."
Per Abrahamsen's avatar
Per Abrahamsen committed
968
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
969
  (let ((button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
970 971 972 973 974 975
    (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
976 977 978
(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
979
  (let ((widget (widget-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
980 981 982 983
    (if widget
	(let ((order (widget-get widget :tab-order)))
	  (if order
	      (if (>= order 0)
984 985
		  widget)
	    widget)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
986

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

Per Abrahamsen's avatar
Per Abrahamsen committed
991 992 993
(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
994
  (or (bobp) (> arg 0) (backward-char))
995
  (let ((wrapped 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
996
	(number arg)
997
	(old (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
998 999
    ;; Forward.
    (while (> arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
1000
      (cond ((eobp)
1001 1002
	     (goto-char (point-min))
	     (setq wrapped (1+ wrapped)))<