wid-edit.el 109 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 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.")

Per Abrahamsen's avatar
Per Abrahamsen committed
114 115
(defface widget-button-face '((t (:bold t)))
  "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

(defface widget-field-face '((((class grayscale color)
			       (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
125
			      (:background "gray85"))
Per Abrahamsen's avatar
Per Abrahamsen committed
126 127
			     (((class grayscale color)
			       (background dark))
Per Abrahamsen's avatar
Per Abrahamsen committed
128
			      (:background "dim gray"))
129
			     (t
Per Abrahamsen's avatar
Per Abrahamsen committed
130 131
			      (:italic t)))
  "Face used for editable fields."
Per Abrahamsen's avatar
Per Abrahamsen committed
132
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
133

Per Abrahamsen's avatar
Per Abrahamsen committed
134 135 136 137 138 139
(defface widget-single-line-field-face '((((class grayscale color)
					   (background light))
					  (:background "gray85"))
					 (((class grayscale color)
					   (background dark))
					  (:background "dim gray"))
140
					 (t
Per Abrahamsen's avatar
Per Abrahamsen committed
141 142 143 144
					  (:italic t)))
  "Face used for editable fields spanning only a single line."
  :group 'widget-faces)

145 146 147 148 149 150 151 152 153 154 155
;;; 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
156

Per Abrahamsen's avatar
Per Abrahamsen committed
157 158 159 160 161
;;; Utility functions.
;;
;; These are not really widget specific.

(defun widget-princ-to-string (object)
162 163 164 165 166
  "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
167 168 169 170 171 172

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

Per Abrahamsen's avatar
Per Abrahamsen committed
173 174 175 176 177 178
(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)

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

286 287 288 289 290 291 292 293
(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
294 295
;;; Widget text specifications.
;; 
296
;; These functions are for specifying text properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
297

298
(defvar widget-field-add-space t
Per Abrahamsen's avatar
Per Abrahamsen committed
299 300
  "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
301
size field.")
Per Abrahamsen's avatar
Per Abrahamsen committed
302

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

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

(defun widget-specify-button (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
367
  "Specify button for WIDGET between FROM and TO."
368
  (let ((overlay (make-overlay from to nil t nil)))
Per Abrahamsen's avatar
Per Abrahamsen committed
369 370
    (widget-put widget :button-overlay overlay)
    (overlay-put overlay 'button widget)
371
    (overlay-put overlay 'keymap (widget-get widget :keymap))
372 373
    ;; We want to avoid the face with image buttons.
    (unless (widget-get widget :suppress-face)
374
      (overlay-put overlay 'face (widget-apply widget :button-face-get))
375
      (overlay-put overlay 'mouse-face widget-mouse-face))
376
    (overlay-put overlay 'help-echo (widget-get widget :help-echo))))
Per Abrahamsen's avatar
Per Abrahamsen committed
377 378

(defun widget-specify-sample (widget from to)
379
  "Specify sample for WIDGET between FROM and TO."
380 381
  (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
382 383
    (widget-put widget :sample-overlay overlay)))

Per Abrahamsen's avatar
Per Abrahamsen committed
384
(defun widget-specify-doc (widget from to)
385
  "Specify documentation for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
386 387 388 389
  (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
390 391

(defmacro widget-specify-insert (&rest form)
392 393 394
  "Execute FORM without inheriting any text properties."
  `(save-restriction
    (let ((inhibit-read-only t)
395 396
	  (inhibit-modification-hooks t)
	  result)
397 398 399 400 401 402 403 404
      (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
405 406 407 408 409 410

(defface widget-inactive-face '((((class grayscale color)
				  (background dark))
				 (:foreground "light gray"))
				(((class grayscale color)
				  (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
411
				 (:foreground "dim gray"))
412
				(t
Per Abrahamsen's avatar
Per Abrahamsen committed
413 414
				 (:italic t)))
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
415
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
416 417 418 419 420 421

(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
422 423
      ;; 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
424 425
      (overlay-put overlay 'evaporate t)
      (overlay-put overlay 'priority 100)
426
      (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
Per Abrahamsen's avatar
Per Abrahamsen committed
427 428 429 430 431
      (widget-put widget :inactive overlay))))

(defun widget-overlay-inactive (&rest junk)
  "Ignoring the arguments, signal an error."
  (unless inhibit-read-only
432
    (error "The widget here is not active")))
Per Abrahamsen's avatar
Per Abrahamsen committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447


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

Per Abrahamsen's avatar
Per Abrahamsen committed
448 449
(defun widget-get-indirect (widget property)
  "In WIDGET, get the value of PROPERTY.
450
If the value is a symbol, return its binding.
Per Abrahamsen's avatar
Per Abrahamsen committed
451 452 453 454 455 456
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
457 458
(defun widget-member (widget property)
  "Non-nil iff there is a definition in WIDGET for PROPERTY."
459
  (cond ((plist-member (cdr widget) property)
Per Abrahamsen's avatar
Per Abrahamsen committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
	 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)))

476
(defun widget-default-get (widget)
477
  "Extract the default value of WIDGET."
478 479 480
  (or (widget-get widget :value)
      (widget-apply widget :default-get)))

Per Abrahamsen's avatar
Per Abrahamsen committed
481
(defun widget-match-inline (widget vals)
482
  "In WIDGET, match the start of VALS."
Per Abrahamsen's avatar
Per Abrahamsen committed
483 484
  (cond ((widget-get widget :inline)
	 (widget-apply widget :match-inline vals))
485
	((and (listp vals)
Per Abrahamsen's avatar
Per Abrahamsen committed
486 487 488 489 490 491
	      (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
492 493 494
  (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
495

Per Abrahamsen's avatar
Per Abrahamsen committed
496 497 498 499 500 501 502 503 504 505 506 507 508 509
;;; 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)
510
      (error "Value does not match %S type" (car widget)))
Per Abrahamsen's avatar
Per Abrahamsen committed
511 512 513 514 515
    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."
516
  (let* ((children (widget-get (widget-get widget :parent) :children))
Per Abrahamsen's avatar
Per Abrahamsen committed
517 518 519 520 521 522 523 524 525
	 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
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
(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)))))

546
;;; Images.
Per Abrahamsen's avatar
Per Abrahamsen committed
547

548 549 550
(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
551
If this variable is nil, widget will try to locate the directory
Per Abrahamsen's avatar
Per Abrahamsen committed
552
automatically."
Per Abrahamsen's avatar
Per Abrahamsen committed
553 554 555
  :group 'widgets
  :type 'directory)

556 557 558
(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
559 560 561
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
562 563 564 565 566 567 568 569 570 571
(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")))))

572 573 574
(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
575
extension (xpm, xbm, gif, jpg, or png) located in
576 577 578
`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
579
	 nil)
580 581 582
	((and (consp image)
	      (eq 'image (car image)))
	 ;; Already an image spec.  Use it.
Per Abrahamsen's avatar
Per Abrahamsen committed
583
	 image)
Per Abrahamsen's avatar
Per Abrahamsen committed
584 585
	((stringp image)
	 ;; A string.  Look it up in relevant directories.
586 587 588 589 590 591 592
	 (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
593
	(t
Per Abrahamsen's avatar
Per Abrahamsen committed
594
	 ;; Oh well.
Per Abrahamsen's avatar
Per Abrahamsen committed
595 596
	 nil)))

597 598 599 600 601 602
(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
603
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
604 605 606 607 608 609 610 611 612 613 614 615
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
616

Per Abrahamsen's avatar
Per Abrahamsen committed
617 618 619 620 621 622 623 624 625
;;; 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
626
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
627 628 629 630

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

Per Abrahamsen's avatar
Per Abrahamsen committed
633 634 635 636
;;; Creating Widgets.

;;;###autoload
(defun widget-create (type &rest args)
637
  "Create widget of TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
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."
657
  (let ((widget (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
658 659 660 661 662 663 664 665 666 667
    (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."
668
  (let ((widget (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
    (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)
684
  "Convert TYPE to a widget without inserting it in the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
685 686
The optional ARGS are additional keyword arguments."
  ;; Don't touch the type.
687
  (let* ((widget (if (symbolp type)
Per Abrahamsen's avatar
Per Abrahamsen committed
688
		     (list type)
689
		   (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
690 691 692 693
	 (current widget)
	 (keys args))
    ;; First set the :args keyword.
    (while (cdr current)		;Look in the type.
694 695 696 697
      (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
698
    (while args				;Look in the args.
699 700 701 702
      (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
703 704 705 706 707 708 709 710
    ;; 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.
711
    (while keys
Per Abrahamsen's avatar
Per Abrahamsen committed
712
      (let ((next (nth 0 keys)))
713 714
	(if (keywordp next)
	    (progn
Per Abrahamsen's avatar
Per Abrahamsen committed
715 716 717 718 719
	      (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)
720 721 722 723
	(widget-put widget
		    :value (widget-apply widget
					 :value-to-internal
					 (widget-get widget :value))))
Per Abrahamsen's avatar
Per Abrahamsen committed
724 725 726 727
    ;; Return the newly create widget.
    widget))

(defun widget-insert (&rest args)
728
  "Call `insert' with ARGS even if surrounding text is read only."
Per Abrahamsen's avatar
Per Abrahamsen committed
729
  (let ((inhibit-read-only t)
730
	(inhibit-modification-hooks t))
Per Abrahamsen's avatar
Per Abrahamsen committed
731
    (apply 'insert args)))
Per Abrahamsen's avatar
Per Abrahamsen committed
732

Per Abrahamsen's avatar
Per Abrahamsen committed
733 734 735
(defun widget-convert-text (type from to
				 &optional button-from button-to
				 &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
736
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
737
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
738 739
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
740 741 742
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
743 744 745 746 747 748 749 750 751 752
	(from (copy-marker from))
	(to (copy-marker to)))
    (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
753
(defun widget-convert-button (type from to &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
754
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
755
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
756 757 758
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
759 760 761 762
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
763
  (let ((button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
764
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
765
	(doc (widget-get widget :doc-overlay))
766 767 768
	(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
769 770
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
771 772
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
773 774
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
775 776
    (when field
      (delete-overlay field))
777
    (mapc 'widget-leave-text (widget-get widget :children))))
Per Abrahamsen's avatar
Per Abrahamsen committed
778

Per Abrahamsen's avatar
Per Abrahamsen committed
779 780
;;; Keymap and Commands.

781 782 783 784 785 786 787 788
(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
789 790 791 792 793 794 795
  "Keymap containing useful binding for buffers containing widgets.
Recommended as a parent keymap for modes using widgets.")

(defvar widget-global-map global-map
  "Keymap used for events the widget does not handle themselves.")
(make-variable-buffer-local 'widget-global-map)

796 797 798
(defvar widget-field-keymap
  (let ((map (copy-keymap widget-keymap)))
    (define-key map [menu-bar] nil)
799
    (define-key map [tool-bar] nil)
800 801 802
    (define-key map "\C-k" 'widget-kill-line)
    (define-key map "\M-\t" 'widget-complete)
    (define-key map "\C-m" 'widget-field-activate)
803 804 805 806
    ;; Since the widget code uses a `field' property to identify fields,
    ;; ordinary beginning-of-line/end-of-line do the right thing.
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
    ;;  (define-key map "\C-e" 'widget-end-of-line)
807 808
    (set-keymap-parent map global-map)
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
809 810
  "Keymap used inside an editable field.")

811 812
(defvar widget-text-keymap
  (let ((map (copy-keymap widget-keymap)))
813 814
    (define-key map [menu-bar] nil)
    (define-key map [tool-bar] nil)
815 816 817 818
    ;; Since the widget code uses a `field' property to identify fields,
    ;; ordinary beginning-of-line/end-of-line do the right thing.
    ;;  (define-key map "\C-a" 'widget-beginning-of-line)
    ;;  (define-key map "\C-e" 'widget-end-of-line)
819 820
    (set-keymap-parent map global-map)
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
821 822 823
  "Keymap used inside a text field.")

(defun widget-field-activate (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
824
  "Invoke the ediable field at point."
Per Abrahamsen's avatar
Per Abrahamsen committed
825
  (interactive "@d")
Miles Bader's avatar
Miles Bader committed
826
  (let ((field (widget-field-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
827 828 829 830 831
    (if field
	(widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

832
(defface widget-button-pressed-face
Per Abrahamsen's avatar
Per Abrahamsen committed
833 834 835 836 837
  '((((class color))
     (:foreground "red"))
    (t
     (:bold t :underline t)))
  "Face used for pressed buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
838
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
839

Per Abrahamsen's avatar
Per Abrahamsen committed
840
(defun widget-button-click (event)
841
  "Invoke the button that the mouse is pointing at."
Per Abrahamsen's avatar
Per Abrahamsen committed
842
  (interactive "@e")
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
  (if (widget-event-point event)
      (save-excursion
	(mouse-set-point event)
	(let* ((pos (widget-event-point event))
	       (button (get-char-property pos 'button)))
	  (if button
	      (let* ((overlay (widget-get button :button-overlay))
		     (face (overlay-get overlay 'face))
		     (mouse-face (overlay-get overlay 'mouse-face)))
		(unwind-protect
		    (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))))
			(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)))
	    (let ((up t)
		  command)
	      ;; Find the global command to run, and check whether it
	      ;; is bound to an up event.
	      (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)))))
	  (unless (pos-visible-in-window-p (widget-event-point event))
	    (mouse-set-point event)
	    (beginning-of-line)
	    (recenter)))
    (message "You clicked somewhere weird.")))
Per Abrahamsen's avatar
Per Abrahamsen committed
907

Per Abrahamsen's avatar
Per Abrahamsen committed
908
(defun widget-button-press (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
909
  "Invoke button at POS."
Per Abrahamsen's avatar
Per Abrahamsen committed
910
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
911
  (let ((button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
912 913 914 915 916 917
    (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
918 919 920
(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
921
  (let ((widget (widget-at pos)))
Per Abrahamsen's avatar
Per Abrahamsen committed
922 923 924 925
    (if widget
	(let ((order (widget-get widget :tab-order)))
	  (if order
	      (if (>= order 0)
926 927
		  widget)
	    widget)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
928

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

Per Abrahamsen's avatar
Per Abrahamsen committed
933 934 935
(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
936
  (or (bobp) (> arg 0) (backward-char))
Per Abrahamsen's avatar
Per Abrahamsen committed
937
  (let ((pos (point))
Per Abrahamsen's avatar
Per Abrahamsen committed
938
	(number arg)
Per Abrahamsen's avatar
Per Abrahamsen committed
939
	(old (widget-tabable-at))
Per Abrahamsen's avatar
Per Abrahamsen committed
940 941 942
	new)
    ;; Forward.
    (while (> arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
943 944 945 946 947 948
      (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
949 950 951
      (and (eq pos (point))
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
952
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
953 954
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
955
	    (setq arg (1- arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
956 957 958
	    (setq old new)))))
    ;; Backward.
    (while (< arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
959 960 961 962 963 964
      (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
965 966 967
      (and (eq pos (point))
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
968
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
969 970
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
971 972 973 974
	    (setq arg (1+ arg))))))
    (let ((new (widget-tabable-at)))
      (while (eq (widget-tabable-at) new)
	(backward-char)))
Per Abrahamsen's avatar
Per Abrahamsen committed
975 976 977
    (forward-char))
  (widget-echo-help (point))
  (run-hooks 'widget-move-hook))
Per Abrahamsen's avatar
Per Abrahamsen committed
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992

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

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

993 994 995 996
;; Since the widget code uses a `field' property to identify fields,
;; ordinary beginning-of-line/end-of-line do the right thing.
(defalias 'widget-beginning-of-line 'beginning-of-line)
(defalias 'widget-end-of-line 'end-of-line)
Per Abrahamsen's avatar
Per Abrahamsen committed
997 998 999 1000

(defun widget-kill-line ()
  "Kill to end of field or end of line, whichever is first."
  (interactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
1001 1002
  (let* ((field (widget-field-find (point)))
	 (end (and field (widget-field-end field))))
1003
    (if (and field (> (line-beginning-position 2) end))
Per Abrahamsen's avatar
Per Abrahamsen committed
1004
	(kill-region (point) end)
Per Abrahamsen's avatar
Per Abrahamsen committed
1005 1006
      (call-interactively 'kill-line))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
(defcustom widget-complete-field (lookup-key global-map "\M-\t")
  "Default function to call for completion inside fields."
  :options '(ispell-complete-word complete-tag lisp-complete-symbol)
  :type 'function
  :group 'widgets)

(defun widget-complete ()
  "Complete content of editable field from point.
When not inside a field, move to the previous button or field."
  (interactive)
  (let ((field (widget-field-find (point))))
    (if field
	(widget-apply field :complete)
      (error "Not in an editable field"))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
;;; Setting up the buffer.

(defvar widget-field-new nil)
;; List of all newly created editable fields in the buffer.
(make-variable-buffer-local 'widget-field-new)

(defvar widget-field-list nil)
;; List of all editable fields in the buffer.
(make-variable-buffer-local 'widget-field-list)

Miles Bader's avatar
Miles Bader committed
1032 1033 1034 1035 1036
(defun widget-at (&optional pos)
  "The button or field at POS (default, point)."
  (or (get-char-property (or pos (point)) 'button)
      (widget-field-at pos)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1037 1038 1039
(defun widget-setup ()
  "Setup current buffer so editing string widgets works."
  (let ((inhibit-read-only t)
1040
	(inhibit-modification-hooks t)
Per Abrahamsen's avatar
Per Abrahamsen committed
1041 1042 1043 1044 1045
	field)
    (while widget-field-new
      (setq field (car widget-field-new)
	    widget-field-new (cdr widget-field-new)
	    widget-field-list (cons field widget-field-list))
Per Abrahamsen's avatar
Per Abrahamsen committed
1046 1047
      (let ((from (car (widget-get field :field-overlay)))
	    (to (cdr (widget-get field :field-overlay))))
1048
	(widget-specify-field field
Per Abrahamsen's avatar
Per Abrahamsen committed
1049
			      (marker-position from) (marker-position to))
Per Abrahamsen's avatar
Per Abrahamsen committed
1050 1051
	(set-marker from nil)
	(set-marker to nil))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1052
  (widget-clear-undo)
Per Abrahamsen's avatar
Per Abrahamsen committed
1053
  (widget-add-change))
Per Abrahamsen's avatar
Per Abrahamsen committed
1054 1055 1056 1057 1058 1059 1060 1061 1062

(defvar widget-field-last nil)
;; Last field containing point.
(make-variable-buffer-local 'widget-field-last)

(defvar widget-field-was nil)
;; The widget data before the change.
(make-variable-buffer-local 'widget-field-was)

Miles Bader's avatar
Miles Bader committed
1063 1064 1065 1066 1067 1068 1069
(defun widget-field-at (pos)
  "Return the widget field at POS, or nil if none."
  (let ((field (get-char-property (or pos (point)) 'field)))
    (if (eq field 'boundary)
	nil
      field)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1070 1071
(defun widget-field-buffer (widget)
  "Return the start of WIDGET's editing field."
Per Abrahamsen's avatar
Per Abrahamsen committed
1072 1073
  (let ((overlay (widget-get widget :field-overlay)))
    (and overlay (overlay-buffer overlay))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1074 1075 1076

(defun widget-field-start (widget)
  "Return the start of WIDGET's editing field."
Per Abrahamsen's avatar
Per Abrahamsen committed
1077 1078
  (let ((overlay (widget-get widget :field-overlay)))
    (and overlay (overlay-start overlay))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1079 1080 1081

(defun widget-field-end (widget)
  "Return the end of WIDGET's editing field."
Per Abrahamsen's avatar
Per Abrahamsen committed
1082
  (let ((overlay (widget-get widget :field-overlay)))
Miles Bader's avatar
Miles Bader committed
1083 1084 1085 1086 1087 1088 1089 1090
    ;; Don't subtract one if local-map works at the end of the overlay,
    ;; or if a special `boundary' field has been added after the widget
    ;; field.
    (and overlay (if (and (not (eq (get-char-property (overlay-end overlay)
						      'field)
				   'boundary))
			  (or widget-field-add-space
			      (null (widget-get widget :size))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1091 1092
		     (1- (overlay-end overlay))
		   (overlay-end overlay)))))