wid-edit.el 108 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)))
321
  (let ((overlay (make-overlay from to nil
Per Abrahamsen's avatar
Per Abrahamsen committed
322
			       nil (or (not widget-field-add-space)
323
				       (widget-get widget :size)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
324
    (widget-put widget :field-overlay overlay)
325
    ;;(overlay-put overlay 'detachable nil)
Per Abrahamsen's avatar
Per Abrahamsen committed
326
    (overlay-put overlay 'field widget)
327 328 329 330
    (overlay-put overlay 'keymap (widget-get widget :keymap))
    (overlay-put overlay 'face (or (widget-get widget :value-face)
				   'widget-field-face))
    (overlay-put overlay 'help-echo (widget-get widget :help-echo)))
331 332 333 334 335 336 337 338 339
  (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)))
340
	(when size
341 342 343 344 345 346 347 348 349
	  (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
350 351

(defun widget-specify-button (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
352
  "Specify button for WIDGET between FROM and TO."
353
  (let ((overlay (make-overlay from to nil t nil)))
Per Abrahamsen's avatar
Per Abrahamsen committed
354 355
    (widget-put widget :button-overlay overlay)
    (overlay-put overlay 'button widget)
356
    (overlay-put overlay 'keymap (widget-get widget :keymap))
357 358
    ;; We want to avoid the face with image buttons.
    (unless (widget-get widget :suppress-face)
359
      (overlay-put overlay 'face (widget-apply widget :button-face-get))
360
      (overlay-put overlay 'mouse-face widget-mouse-face))
361
    (overlay-put overlay 'help-echo (widget-get widget :help-echo))))
Per Abrahamsen's avatar
Per Abrahamsen committed
362 363

(defun widget-specify-sample (widget from to)
364
  "Specify sample for WIDGET between FROM and TO."
365 366
  (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
367 368
    (widget-put widget :sample-overlay overlay)))

Per Abrahamsen's avatar
Per Abrahamsen committed
369
(defun widget-specify-doc (widget from to)
370
  "Specify documentation for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
371 372 373 374
  (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
375 376

(defmacro widget-specify-insert (&rest form)
377 378 379
  "Execute FORM without inheriting any text properties."
  `(save-restriction
    (let ((inhibit-read-only t)
380 381
	  (inhibit-modification-hooks t)
	  result)
382 383 384 385 386 387 388 389
      (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
390 391 392 393 394 395

(defface widget-inactive-face '((((class grayscale color)
				  (background dark))
				 (:foreground "light gray"))
				(((class grayscale color)
				  (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
396
				 (:foreground "dim gray"))
397
				(t
Per Abrahamsen's avatar
Per Abrahamsen committed
398 399
				 (:italic t)))
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
400
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
401 402 403 404 405 406

(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
407 408
      ;; 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
409 410
      (overlay-put overlay 'evaporate t)
      (overlay-put overlay 'priority 100)
411
      (overlay-put overlay 'modification-hooks '(widget-overlay-inactive))
Per Abrahamsen's avatar
Per Abrahamsen committed
412 413 414 415 416
      (widget-put widget :inactive overlay))))

(defun widget-overlay-inactive (&rest junk)
  "Ignoring the arguments, signal an error."
  (unless inhibit-read-only
417
    (error "The widget here is not active")))
Per Abrahamsen's avatar
Per Abrahamsen committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432


(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
433 434
(defun widget-get-indirect (widget property)
  "In WIDGET, get the value of PROPERTY.
435
If the value is a symbol, return its binding.
Per Abrahamsen's avatar
Per Abrahamsen committed
436 437 438 439 440 441
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
442 443
(defun widget-member (widget property)
  "Non-nil iff there is a definition in WIDGET for PROPERTY."
444
  (cond ((plist-member (cdr widget) property)
Per Abrahamsen's avatar
Per Abrahamsen committed
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
	 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)))

461
(defun widget-default-get (widget)
462
  "Extract the default value of WIDGET."
463 464 465
  (or (widget-get widget :value)
      (widget-apply widget :default-get)))

Per Abrahamsen's avatar
Per Abrahamsen committed
466
(defun widget-match-inline (widget vals)
467
  "In WIDGET, match the start of VALS."
Per Abrahamsen's avatar
Per Abrahamsen committed
468 469
  (cond ((widget-get widget :inline)
	 (widget-apply widget :match-inline vals))
470
	((and (listp vals)
Per Abrahamsen's avatar
Per Abrahamsen committed
471 472 473 474 475 476
	      (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
477 478 479
  (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
480

Per Abrahamsen's avatar
Per Abrahamsen committed
481 482 483 484 485 486 487 488 489 490 491 492 493 494
;;; 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)
495
      (error "Value does not match %S type" (car widget)))
Per Abrahamsen's avatar
Per Abrahamsen committed
496 497 498 499 500
    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."
501
  (let* ((children (widget-get (widget-get widget :parent) :children))
Per Abrahamsen's avatar
Per Abrahamsen committed
502 503 504 505 506 507 508 509 510
	 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
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
(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)))))

531
;;; Images.
Per Abrahamsen's avatar
Per Abrahamsen committed
532

533 534 535
(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
536
If this variable is nil, widget will try to locate the directory
Per Abrahamsen's avatar
Per Abrahamsen committed
537
automatically."
Per Abrahamsen's avatar
Per Abrahamsen committed
538 539 540
  :group 'widgets
  :type 'directory)

541 542 543
(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
544 545 546
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
547 548 549 550 551 552 553 554 555 556
(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")))))

557 558 559
(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
560
extension (xpm, xbm, gif, jpg, or png) located in
561 562 563
`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
564
	 nil)
565 566 567
	((and (consp image)
	      (eq 'image (car image)))
	 ;; Already an image spec.  Use it.
Per Abrahamsen's avatar
Per Abrahamsen committed
568
	 image)
Per Abrahamsen's avatar
Per Abrahamsen committed
569 570
	((stringp image)
	 ;; A string.  Look it up in relevant directories.
571 572 573 574 575 576 577
	 (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
578
	(t
Per Abrahamsen's avatar
Per Abrahamsen committed
579
	 ;; Oh well.
Per Abrahamsen's avatar
Per Abrahamsen committed
580 581
	 nil)))

582 583 584 585 586 587
(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
588
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
589 590 591 592 593 594 595 596 597 598 599 600
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
601

Per Abrahamsen's avatar
Per Abrahamsen committed
602 603 604 605 606 607 608 609 610
;;; 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
611
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
612 613 614 615

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

Per Abrahamsen's avatar
Per Abrahamsen committed
618 619 620 621
;;; Creating Widgets.

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

(defun widget-insert (&rest args)
713
  "Call `insert' with ARGS even if surrounding text is read only."
Per Abrahamsen's avatar
Per Abrahamsen committed
714
  (let ((inhibit-read-only t)
715
	(inhibit-modification-hooks t))
Per Abrahamsen's avatar
Per Abrahamsen committed
716
    (apply 'insert args)))
Per Abrahamsen's avatar
Per Abrahamsen committed
717

Per Abrahamsen's avatar
Per Abrahamsen committed
718 719 720
(defun widget-convert-text (type from to
				 &optional button-from button-to
				 &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
721
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
722
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
723 724
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
725 726 727
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
728 729 730 731 732 733 734 735 736 737
	(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
738
(defun widget-convert-button (type from to &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
739
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
740
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
741 742 743
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
744 745 746 747
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
748
  (let ((button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
749
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
750
	(doc (widget-get widget :doc-overlay))
751 752 753
	(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
754 755
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
756 757
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
758 759
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
760 761
    (when field
      (delete-overlay field))
762
    (mapc 'widget-leave-text (widget-get widget :children))))
Per Abrahamsen's avatar
Per Abrahamsen committed
763

Per Abrahamsen's avatar
Per Abrahamsen committed
764 765
;;; Keymap and Commands.

766 767 768 769 770 771 772 773
(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
774 775 776 777 778 779 780
  "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)

781 782 783
(defvar widget-field-keymap
  (let ((map (copy-keymap widget-keymap)))
    (define-key map [menu-bar] nil)
784
    (define-key map [tool-bar] nil)
785 786 787
    (define-key map "\C-k" 'widget-kill-line)
    (define-key map "\M-\t" 'widget-complete)
    (define-key map "\C-m" 'widget-field-activate)
788 789 790 791
    ;; 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)
792 793
    (set-keymap-parent map global-map)
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
794 795
  "Keymap used inside an editable field.")

796 797
(defvar widget-text-keymap
  (let ((map (copy-keymap widget-keymap)))
798 799
    (define-key map [menu-bar] nil)
    (define-key map [tool-bar] nil)
800 801 802 803
    ;; 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)
804 805
    (set-keymap-parent map global-map)
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
806 807 808
  "Keymap used inside a text field.")

(defun widget-field-activate (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
809
  "Invoke the ediable field at point."
Per Abrahamsen's avatar
Per Abrahamsen committed
810
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
811
  (let ((field (get-char-property pos 'field)))
Per Abrahamsen's avatar
Per Abrahamsen committed
812 813 814 815 816
    (if field
	(widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

817
(defface widget-button-pressed-face
Per Abrahamsen's avatar
Per Abrahamsen committed
818 819 820 821 822
  '((((class color))
     (:foreground "red"))
    (t
     (:bold t :underline t)))
  "Face used for pressed buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
823
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
824

Per Abrahamsen's avatar
Per Abrahamsen committed
825
(defun widget-button-click (event)
826
  "Invoke the button that the mouse is pointing at."
Per Abrahamsen's avatar
Per Abrahamsen committed
827
  (interactive "@e")
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 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
  (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
892

Per Abrahamsen's avatar
Per Abrahamsen committed
893
(defun widget-button-press (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
894
  "Invoke button at POS."
Per Abrahamsen's avatar
Per Abrahamsen committed
895
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
896
  (let ((button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
897 898 899 900 901 902
    (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
903 904 905 906 907
(defun widget-tabable-at (&optional pos)
  "Return the tabable widget at POS, or nil.
POS defaults to the value of (point)."
  (unless pos
    (setq pos (point)))
908 909
  (let ((widget (or (get-char-property pos 'button)
		    (get-char-property pos 'field))))
Per Abrahamsen's avatar
Per Abrahamsen committed
910 911 912 913
    (if widget
	(let ((order (widget-get widget :tab-order)))
	  (if order
	      (if (>= order 0)
914 915
		  widget)
	    widget)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
916

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

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

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

981 982 983 984
;; 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
985 986 987 988

(defun widget-kill-line ()
  "Kill to end of field or end of line, whichever is first."
  (interactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
989 990
  (let* ((field (widget-field-find (point)))
	 (end (and field (widget-field-end field))))
991
    (if (and field (> (line-beginning-position 2) end))
Per Abrahamsen's avatar
Per Abrahamsen committed
992
	(kill-region (point) end)
Per Abrahamsen's avatar
Per Abrahamsen committed
993 994
      (call-interactively 'kill-line))))

Per Abrahamsen's avatar
Per Abrahamsen committed
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
(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
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
;;; 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)

(defun widget-setup ()
  "Setup current buffer so editing string widgets works."
  (let ((inhibit-read-only t)
1023
	(inhibit-modification-hooks t)
Per Abrahamsen's avatar
Per Abrahamsen committed
1024 1025 1026 1027 1028
	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
1029 1030
      (let ((from (car (widget-get field :field-overlay)))
	    (to (cdr (widget-get field :field-overlay))))
1031
	(widget-specify-field field
Per Abrahamsen's avatar
Per Abrahamsen committed
1032
			      (marker-position from) (marker-position to))
Per Abrahamsen's avatar
Per Abrahamsen committed
1033 1034
	(set-marker from nil)
	(set-marker to nil))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1035
  (widget-clear-undo)
Per Abrahamsen's avatar
Per Abrahamsen committed
1036
  (widget-add-change))
Per Abrahamsen's avatar
Per Abrahamsen committed
1037 1038 1039 1040 1041 1042 1043 1044 1045

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

Per Abrahamsen's avatar
Per Abrahamsen committed
1046 1047
(defun widget-field-buffer (widget)
  "Return the start of WIDGET's editing field."
Per Abrahamsen's avatar
Per Abrahamsen committed
1048 1049
  (let ((overlay (widget-get widget :field-overlay)))
    (and overlay (overlay-buffer overlay))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1050 1051 1052

(defun widget-field-start (widget)
  "Return the start of WIDGET's editing field."
Per Abrahamsen's avatar
Per Abrahamsen committed
1053 1054
  (let ((overlay (widget-get widget :field-overlay)))
    (and overlay (overlay-start overlay))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1055 1056 1057

(defun widget-field-end (widget)
  "Return the end of WIDGET's editing field."
Per Abrahamsen's avatar
Per Abrahamsen committed
1058 1059
  (let ((overlay (widget-get widget :field-overlay)))
    ;; Don't subtract one if local-map works at the end of the overlay.
Per Abrahamsen's avatar
Per Abrahamsen committed
1060 1061
    (and overlay (if (or widget-field-add-space
			 (null (widget-get widget :size)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1062 1063
		     (1- (overlay-end overlay))
		   (overlay-end overlay)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1064

Per Abrahamsen's avatar
Per Abrahamsen committed
1065
(defun widget-field-find (pos)
Per Abrahamsen's avatar
Per Abrahamsen committed
1066 1067
  "Return the field at POS.
Unlike (get-char-property POS 'field) this, works with empty fields too."
Per Abrahamsen's avatar
Per Abrahamsen committed
1068 1069 1070 1071 1072
  (let ((fields widget-field-list)
	field found)
    (while fields
      (setq field (car fields)
	    fields (cdr fields))
1073 1074 1075 1076 1077
      (when (and (<= (widget-field-start field) pos)
		 (<= pos (widget-field-end field)))
	(when found
	  (error "Overlapping fields"))
	(setq found field)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1078 1079
    found))

Per Abrahamsen's avatar
Per Abrahamsen committed
1080
(defun widget-before-change (from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
1081 1082
  ;; This is how, for example, a variable changes its state to `modified'.
  ;; when it is being edited.
1083 1084 1085 1086 1087
  (unless inhibit-read-only
    (let ((from-field (widget-field-find from))
	  (to-field (widget-field-find to)))
      (cond ((not (eq from-field to-field))
	     (add-hook 'post-command-hook 'widget-add-change nil t)
1088 1089
	     (signal 'text-read-only
		     '("Change should be restricted to a single field")))
1090 1091
	    ((null from-field)
	     (add-hook 'post-command-hook 'widget-add-change nil t)
1092 1093
	     (signal 'text-read-only
		     '("Attempt to change text outside editable field")))
1094
	    (widget-field-use-before-change
1095
	     (widget-apply from-field :notify from-field))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1096 1097 1098 1099 1100 1101 1102 1103

(defun widget-add-change ()
  (make-local-hook 'post-command-hook)
  (remove-hook 'post-command-hook 'widget-add-change t)
  (make-local-hook 'before-change-functions)
  (add-hook 'before-change-functions 'widget-before-change nil t)
  (make-local-hook 'after-change-functions)
  (add-hook 'after-change-functions 'widget-after-change nil t))
1104

Per Abrahamsen's avatar
Per Abrahamsen committed
1105
(defun widget-after-change (from to old)
1106
  "Adjust field size and text properties."
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
  (let ((field (widget-field-find from))
	(other (widget-field-find to)))
    (when field
      (unless (eq field other)
	(error "Change in different fields"))
      (let ((size (widget-get field :size)))
	(when size
	  (let ((begin (widget-field-start field))
		(end (widget-field-end field)))
	    (cond ((< (- end begin) size)
		   ;; Field too small.
		   (save-excursion
		     (goto-char end)
		     (insert-char ?\  (- (+ begin size) end))))
		  ((> (- end begin) size)
		   ;; Field too large and
		   (if (or (< (point) (+ begin size))
			   (> (point) end))
		       ;; Point is outside extra space.
		       (setq begin (+ begin size))
		     ;; Point is within the extra space.
		     (setq begin (point)))
		   (save-excursion
		     (goto-char end)
		     (while (and (eq (preceding-char) ?\ )
				 (> (point) begin))
		       (delete-backward-char 1)))))))
	(widget-specify-secret field))
      (widget-apply field :notify field))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1136 1137 1138

;;; Widget Functions
;;
1139
;; These functions are used in the definition of multiple widgets.
Per Abrahamsen's avatar
Per Abrahamsen committed
1140

Per Abrahamsen's avatar
Per Abrahamsen committed
1141 1142 1143 1144 1145
(defun widget-parent-action (widget &optional event)
  "Tell :parent of WIDGET to handle the :action.
Optional EVENT is the event that triggered the action."
  (widget-apply (widget-get widget :parent) :action event))

Per Abrahamsen's avatar
Per Abrahamsen committed
1146 1147
(defun widget-children-value-delete (widget)
  "Delete all :children and :buttons in WIDGET."
1148
  (mapc 'widget-delete (widget-get widget :children))
Per Abrahamsen's avatar
Per Abrahamsen committed
1149
  (widget-put widget :children nil)
1150
  (mapc 'widget-delete (widget-get widget :buttons))
Per Abrahamsen's avatar
Per Abrahamsen committed
1151 1152
  (widget-put widget :buttons nil))

Per Abrahamsen's avatar
Per Abrahamsen committed
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
(defun widget-children-validate (widget)
  "All the :children must be valid."
  (let ((children (widget-get widget :children))
	child found)
    (while (and children (not found))
      (setq child (car children)
	    children (cdr children)
	    found (widget-apply child :validate)))
    found))

1163 1164
;; Made defsubst to speed up face editor creation.
(defsubst widget-types-convert-widget (widget)
Per Abrahamsen's avatar
Per Abrahamsen committed
1165 1166 1167 1168
  "Convert :args as widget types in WIDGET."
  (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args)))
  widget)

Per Abrahamsen's avatar
Per Abrahamsen committed
1169 1170 1171
(defun widget-value-convert-widget (widget)
  "Initialize :value from :args in WIDGET."
  (let ((args (widget-get widget :args)))
1172
    (when args
Per Abrahamsen's avatar
Per Abrahamsen committed
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
      (widget-put widget :value (car args))
      ;; Don't convert :value here, as this is done in `widget-convert'.
      ;; (widget-put widget :value (widget-apply widget
      ;;  				      :value-to-internal (car args)))
      (widget-put widget :args nil)))
  widget)

(defun widget-value-value-get (widget)
  "Return the :value property of WIDGET."
  (widget-get widget :value))

Per Abrahamsen's avatar
Per Abrahamsen committed
1184 1185 1186 1187 1188 1189
;;; The `default' Widget.

(define-widget 'default nil
  "Basic widget other widgets are derived from."
  :value-to-internal (lambda (widget value) value)
  :value-to-external (lambda (widget value) value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1190 1191
  :button-prefix 'widget-button-prefix
  :button-suffix 'widget-button-suffix
1192
  :complete 'widget-default-complete
Per Abrahamsen's avatar
Per Abrahamsen committed
1193 1194 1195 1196 1197 1198 1199 1200 1201
  :create 'widget-default-create
  :indent nil
  :offset 0
  :format-handler 'widget-default-format-handler
  :button-face-get 'widget-default-button-face-get 
  :sample-face-get 'widget-default-sample-face-get 
  :delete 'widget-default-delete
  :value-set 'widget-default-value-set
  :value-inline 'widget-default-value-inline
1202
  :default-get 'widget-default-default-get
Per Abrahamsen's avatar
Per Abrahamsen committed
1203
  :menu-tag-get 'widget-default-menu-tag-get
1204
  :validate #'ignore
Per Abrahamsen's avatar
Per Abrahamsen committed
1205 1206 1207
  :active 'widget-default-active
  :activate 'widget-specify-active
  :deactivate 'widget-default-deactivate
1208
  :mouse-down-action #'ignore
Per Abrahamsen's avatar
Per Abrahamsen committed
1209
  :action 'widget-default-action
Per Abrahamsen's avatar
Per Abrahamsen committed
1210 1211
  :notify 'widget-default-notify
  :prompt-value 'widget-default-prompt-value)