wid-edit.el 113 KB
Newer Older
Per Abrahamsen's avatar
Per Abrahamsen committed
1 2 3 4 5 6
;;; wid-edit.el --- Functions for creating and using widgets.
;;
;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: extensions
Per Abrahamsen's avatar
Per Abrahamsen committed
7
;; Version: 1.9951
Per Abrahamsen's avatar
Per Abrahamsen committed
8 9
;; X-URL: http://www.dina.kvl.dk/~abraham/custom/

10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
;; 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.

Per Abrahamsen's avatar
Per Abrahamsen committed
27 28 29 30 31 32 33
;;; Commentary:
;;
;; See `widget.el'.

;;; Code:

(require 'widget)
Per Abrahamsen's avatar
Per Abrahamsen committed
34
(eval-when-compile (require 'cl))
Per Abrahamsen's avatar
Per Abrahamsen committed
35 36 37 38 39 40

;;; Compatibility.

(eval-and-compile
  (autoload 'pp-to-string "pp")
  (autoload 'Info-goto-node "info")
Per Abrahamsen's avatar
Per Abrahamsen committed
41
  (autoload 'finder-commentary "finder" nil t)
Per Abrahamsen's avatar
Per Abrahamsen committed
42 43 44 45 46 47

  (when (string-match "XEmacs" emacs-version)
    (condition-case nil
	(require 'overlay)
      (error (load-library "x-overlay"))))
  
Per Abrahamsen's avatar
Per Abrahamsen committed
48 49 50 51 52 53 54 55 56 57
  (if (string-match "XEmacs" emacs-version)
      (defun widget-event-point (event)
	"Character position of the end of event if that exists, or nil."
	(if (mouse-event-p event)
	    (event-point event)
	  nil))
    (defun widget-event-point (event)
      "Character position of the end of event if that exists, or nil."
      (posn-point (event-end event))))

Per Abrahamsen's avatar
Per Abrahamsen committed
58
  (defalias 'widget-read-event (if (string-match "XEmacs" emacs-version)
Per Abrahamsen's avatar
Per Abrahamsen committed
59 60 61 62
				   'next-event
				 'read-event))

  ;; The following should go away when bundled with Emacs.
Per Abrahamsen's avatar
Per Abrahamsen committed
63 64 65 66 67 68 69 70
  (condition-case ()
      (require 'custom)
    (error nil))

  (unless (and (featurep 'custom) (fboundp 'custom-declare-variable))
    ;; We have the old custom-library, hack around it!
    (defmacro defgroup (&rest args) nil)
    (defmacro defcustom (var value doc &rest args) 
Per Abrahamsen's avatar
Per Abrahamsen committed
71
      (` (defvar (, var) (, value) (, doc))))
Per Abrahamsen's avatar
Per Abrahamsen committed
72 73 74 75 76 77 78
    (defmacro defface (&rest args) nil)
    (define-widget-keywords :prefix :tag :load :link :options :type :group)
    (when (fboundp 'copy-face)
      (copy-face 'default 'widget-documentation-face)
      (copy-face 'bold 'widget-button-face)
      (copy-face 'italic 'widget-field-face)))

Per Abrahamsen's avatar
Per Abrahamsen committed
79 80 81 82 83 84 85 86
  (unless (fboundp 'button-release-event-p)
    ;; XEmacs function missing from Emacs.
    (defun 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
87

Per Abrahamsen's avatar
Per Abrahamsen committed
88 89 90 91 92 93 94 95
  (unless (fboundp 'functionp)
    ;; Missing from Emacs 19.34 and earlier.
    (defun functionp (object)
      "Non-nil of OBJECT is a type of object that can be called as a function."
      (or (subrp object) (byte-code-function-p object)
	  (eq (car-safe object) 'lambda)
	  (and (symbolp object) (fboundp object)))))

Per Abrahamsen's avatar
Per Abrahamsen committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
  (unless (fboundp 'error-message-string)
    ;; Emacs function missing in XEmacs.
    (defun error-message-string (obj)
      "Convert an error value to an error message."
      (let ((buf (get-buffer-create " *error-message*")))
	(erase-buffer buf)
	(display-error obj buf)
	(buffer-string buf)))))

;;; Customization.

(defgroup widgets nil
  "Customization support for the Widget Library."
  :link '(custom-manual "(widget)Top")
  :link '(url-link :tag "Development Page" 
		   "http://www.dina.kvl.dk/~abraham/custom/")
Per Abrahamsen's avatar
Per Abrahamsen committed
112
  :link '(emacs-library-link :tag "Lisp File" "widget.el")
Per Abrahamsen's avatar
Per Abrahamsen committed
113 114 115 116
  :prefix "widget-"
  :group 'extensions
  :group 'hypermedia)

Per Abrahamsen's avatar
Per Abrahamsen committed
117 118 119 120
(defgroup widget-documentation nil
  "Options controling the display of documentation strings."
  :group 'widgets)

Per Abrahamsen's avatar
Per Abrahamsen committed
121 122 123 124 125
(defgroup widget-faces nil
  "Faces used by the widget library."
  :group 'widgets
  :group 'faces)

126 127 128 129
(defvar widget-documentation-face 'widget-documentation-face
  "Face used for documentation strings in widges.
This exists as a variable so it can be set locally in certain buffers.")

Per Abrahamsen's avatar
Per Abrahamsen committed
130 131 132 133 134 135 136 137 138 139 140
(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)

141 142 143 144
(defvar widget-button-face 'widget-button-face
  "Face used for buttons in widges.
This exists as a variable so it can be set locally in certain buffers.")

Per Abrahamsen's avatar
Per Abrahamsen committed
145 146
(defface widget-button-face '((t (:bold t)))
  "Face used for widget buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
147
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
148 149 150 151

(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
152
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
153 154 155

(defface widget-field-face '((((class grayscale color)
			       (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
156
			      (:background "gray85"))
Per Abrahamsen's avatar
Per Abrahamsen committed
157 158
			     (((class grayscale color)
			       (background dark))
Per Abrahamsen's avatar
Per Abrahamsen committed
159
			      (:background "dim gray"))
Per Abrahamsen's avatar
Per Abrahamsen committed
160 161 162
			     (t 
			      (:italic t)))
  "Face used for editable fields."
Per Abrahamsen's avatar
Per Abrahamsen committed
163
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
164

Per Abrahamsen's avatar
Per Abrahamsen committed
165 166 167 168 169 170 171 172 173 174 175
(defface widget-single-line-field-face '((((class grayscale color)
					   (background light))
					  (:background "gray85"))
					 (((class grayscale color)
					   (background dark))
					  (:background "dim gray"))
					 (t 
					  (:italic t)))
  "Face used for editable fields spanning only a single line."
  :group 'widget-faces)

176 177 178 179 180 181 182 183 184 185 186
;;; 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
187

Per Abrahamsen's avatar
Per Abrahamsen committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
;;; Utility functions.
;;
;; These are not really widget specific.

(defsubst widget-plist-member (plist prop)
  ;; Return non-nil if PLIST has the property PROP.
  ;; PLIST is a property list, which is a list of the form
  ;; (PROP1 VALUE1 PROP2 VALUE2 ...).  PROP is a symbol.
  ;; Unlike `plist-get', this allows you to distinguish between a missing
  ;; property and a property with the value nil.
  ;; The value is actually the tail of PLIST whose car is PROP.
  (while (and plist (not (eq (car plist) prop)))
    (setq plist (cdr (cdr plist))))
  plist)

(defun widget-princ-to-string (object)
  ;; Return string representation of OBJECT, any Lisp object.
  ;; No quoting characters are used; no delimiters are printed around
  ;; the contents of strings.
  (save-excursion
    (set-buffer (get-buffer-create " *widget-tmp*"))
    (erase-buffer)
    (let ((standard-output (current-buffer)))
      (princ object))
    (buffer-string)))

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

Per Abrahamsen's avatar
Per Abrahamsen committed
219 220 221 222 223 224
(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)

Per Abrahamsen's avatar
Per Abrahamsen committed
225
(defcustom widget-menu-minibuffer-flag (string-match "XEmacs" emacs-version)
226 227 228 229 230 231
  "*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
232 233 234 235
(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
236 237 238
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
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
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)
	      event (fboundp 'x-popup-menu) window-system)
	 ;; We are in Emacs-19, pressed by the mouse
	 (x-popup-menu event
		       (list title (cons "" items))))
	((and (< (length items) widget-menu-max-size)
	      event (fboundp 'popup-menu) window-system)
	 ;; We are in XEmacs, pressed by the mouse
	 (let ((val (get-popup-menu-response
		     (cons title
			   (mapcar
			    (function
			     (lambda (x)
Per Abrahamsen's avatar
Per Abrahamsen committed
259 260 261
			       (if (stringp x)
				   (vector x nil nil) 
				 (vector (car x) (list (car x)) t))))
Per Abrahamsen's avatar
Per Abrahamsen committed
262 263 264 265 266 267
			    items)))))
	   (setq val (and val
			  (listp (event-object val))
			  (stringp (car-safe (event-object val)))
			  (car (event-object val))))
	   (cdr (assoc val items))))
268 269
	(widget-menu-minibuffer-flag
	 ;; Read the choice of name from the minibuffer.
270
	 (setq items (widget-remove-if 'stringp items))
Per Abrahamsen's avatar
Per Abrahamsen committed
271 272 273 274 275 276
	 (let ((val (completing-read (concat title ": ") items nil t)))
	   (if (stringp val)
	       (let ((try (try-completion val items)))
		 (when (stringp try)
		   (setq val try))
		 (cdr (assoc val items)))
277 278 279 280 281 282 283
	     nil)))
	(t
	 ;; Construct a menu of the choices
	 ;; and then use it for prompting for a single character.
	 (let* ((overriding-terminal-local-map
		 (make-sparse-keymap))
		map choice (next-digit ?0)
284
		some-choice-enabled
285 286 287 288
		value)
	   ;; Define SPC as a prefix char to get to this menu.
	   (define-key overriding-terminal-local-map " "
	     (setq map (make-sparse-keymap title)))
289 290 291 292 293 294 295 296 297 298
	   (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))
299 300
		     (define-key map (vector next-digit) function)
		     (setq some-choice-enabled t)))
301 302 303 304
	       ;; 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"))
305 306
	   (or some-choice-enabled
	       (error "None of the choices is currently meaningful"))
307
	   (define-key map [?\C-g] 'keyboard-quit)
308 309 310 311 312 313
	   (define-key map [t] 'keyboard-quit)
	   (setcdr map (nreverse (cdr map)))
	   ;; Unread a SPC to lead to our new menu.
	   (setq unread-command-events (cons ?\ unread-command-events))
	   ;; Read a char with the menu, and return the result
	   ;; that corresponds to it.
314 315 316 317 318 319
	   (save-window-excursion
	     (display-buffer (get-buffer " widget-choose"))
	     (let ((cursor-in-echo-area t))
	       (setq value
		     (lookup-key overriding-terminal-local-map
				 (read-key-sequence title) t))))
320 321 322
	   (when (eq value 'keyboard-quit)
	     (error "Canceled"))
	   value))))
Per Abrahamsen's avatar
Per Abrahamsen committed
323

324 325 326 327 328 329 330 331
(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
332 333 334 335
;;; Widget text specifications.
;; 
;; These functions are for specifying text properties. 

Per Abrahamsen's avatar
Per Abrahamsen committed
336 337 338 339 340 341 342 343 344 345 346 347 348
(defcustom widget-field-add-space 
  (or (< emacs-major-version 20)
      (and (eq emacs-major-version 20)
	   (< emacs-minor-version 3))
      (not (string-match "XEmacs" emacs-version)))
  "Non-nil means add extra space at the end of editable text fields.

This is needed on all versions of Emacs, and on XEmacs before 20.3.  
If you don't add the space, it will become impossible to edit a zero
size field."
  :type 'boolean
  :group 'widgets)

Per Abrahamsen's avatar
Per Abrahamsen committed
349
(defcustom widget-field-use-before-change
Per Abrahamsen's avatar
Per Abrahamsen committed
350 351 352
  (and (or (> emacs-minor-version 34)
	   (> emacs-major-version 19))
       (not (string-match "XEmacs" emacs-version)))
Per Abrahamsen's avatar
Per Abrahamsen committed
353
  "Non-nil means use `before-change-functions' to track editable fields.
354
This enables the use of undo, but doesn't work on Emacs 19.34 and earlier. 
Per Abrahamsen's avatar
Per Abrahamsen committed
355 356 357 358 359
Using before hooks also means that the :notify function can't know the
new value."
  :type 'boolean
  :group 'widgets)

Per Abrahamsen's avatar
Per Abrahamsen committed
360
(defun widget-specify-field (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
361
  "Specify editable button for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
362 363 364 365 366
  ;; 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
367 368 369 370
    (cond ((null (widget-get widget :size))
	   (forward-char 1))
	  (widget-field-add-space
	   (insert-and-inherit " ")))
Per Abrahamsen's avatar
Per Abrahamsen committed
371
    (setq to (point)))
Per Abrahamsen's avatar
Per Abrahamsen committed
372
  (let ((map (widget-get widget :keymap))
Per Abrahamsen's avatar
Per Abrahamsen committed
373 374
	(face (or (widget-get widget :value-face) 'widget-field-face))
	(help-echo (widget-get widget :help-echo))
Per Abrahamsen's avatar
Per Abrahamsen committed
375 376 377
	(overlay (make-overlay from to nil 
			       nil (or (not widget-field-add-space)
				       (widget-get widget :size)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
378
    (unless (or (stringp help-echo) (null help-echo))
Per Abrahamsen's avatar
Per Abrahamsen committed
379 380 381 382 383 384 385 386 387
      (setq help-echo 'widget-mouse-help))    
    (widget-put widget :field-overlay overlay)
    (overlay-put overlay 'detachable nil)
    (overlay-put overlay 'field widget)
    (overlay-put overlay 'local-map map)
    (overlay-put overlay 'keymap map)
    (overlay-put overlay 'face face)
    (overlay-put overlay 'balloon-help help-echo)
    (overlay-put overlay 'help-echo help-echo)))
Per Abrahamsen's avatar
Per Abrahamsen committed
388 389

(defun widget-specify-button (widget from to)
Per Abrahamsen's avatar
Per Abrahamsen committed
390
  "Specify button for WIDGET between FROM and TO."
Per Abrahamsen's avatar
Per Abrahamsen committed
391
  (let ((face (widget-apply widget :button-face-get))
Per Abrahamsen's avatar
Per Abrahamsen committed
392 393 394
	(help-echo (widget-get widget :help-echo))
	(overlay (make-overlay from to nil t nil)))
    (widget-put widget :button-overlay overlay)
Per Abrahamsen's avatar
Per Abrahamsen committed
395 396
    (unless (or (null help-echo) (stringp help-echo))
      (setq help-echo 'widget-mouse-help))
Per Abrahamsen's avatar
Per Abrahamsen committed
397 398 399 400 401
    (overlay-put overlay 'button widget)
    (overlay-put overlay 'mouse-face widget-mouse-face)
    (overlay-put overlay 'balloon-help help-echo)
    (overlay-put overlay 'help-echo help-echo)
    (overlay-put overlay 'face face)))
Per Abrahamsen's avatar
Per Abrahamsen committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

(defun widget-mouse-help (extent)
  "Find mouse help string for button in extent."
  (let* ((widget (widget-at (extent-start-position extent)))
	 (help-echo (and widget (widget-get widget :help-echo))))
    (cond ((stringp help-echo)
	   help-echo)
	  ((and (symbolp help-echo) (fboundp help-echo)
		(stringp (setq help-echo (funcall help-echo widget))))
	   help-echo)
	  (t
	   (format "(widget %S :help-echo %S)" widget help-echo)))))

(defun widget-specify-sample (widget from to)
  ;; Specify sample for WIDGET between FROM and TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
417 418 419 420 421
  (let ((face (widget-apply widget :sample-face-get))
	(overlay (make-overlay from to nil t nil)))
    (overlay-put overlay 'face face)
    (widget-put widget :sample-overlay overlay)))

Per Abrahamsen's avatar
Per Abrahamsen committed
422 423
(defun widget-specify-doc (widget from to)
  ;; Specify documentation for WIDGET between FROM and TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
424 425 426 427
  (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
428 429 430

(defmacro widget-specify-insert (&rest form)
  ;; Execute FORM without inheriting any text properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
431 432
  (`
   (save-restriction
Per Abrahamsen's avatar
Per Abrahamsen committed
433 434
     (let ((inhibit-read-only t)
	   result
435
	   before-change-functions
Per Abrahamsen's avatar
Per Abrahamsen committed
436 437 438 439
	   after-change-functions)
       (insert "<>")
       (narrow-to-region (- (point) 2) (point))
       (goto-char (1+ (point-min)))
Per Abrahamsen's avatar
Per Abrahamsen committed
440
       (setq result (progn (,@ form)))
Per Abrahamsen's avatar
Per Abrahamsen committed
441 442 443
       (delete-region (point-min) (1+ (point-min)))
       (delete-region (1- (point-max)) (point-max))
       (goto-char (point-max))
Per Abrahamsen's avatar
Per Abrahamsen committed
444
       result))))
Per Abrahamsen's avatar
Per Abrahamsen committed
445 446 447 448 449 450

(defface widget-inactive-face '((((class grayscale color)
				  (background dark))
				 (:foreground "light gray"))
				(((class grayscale color)
				  (background light))
Per Abrahamsen's avatar
Per Abrahamsen committed
451
				 (:foreground "dim gray"))
Per Abrahamsen's avatar
Per Abrahamsen committed
452 453 454
				(t 
				 (:italic t)))
  "Face used for inactive widgets."
Per Abrahamsen's avatar
Per Abrahamsen committed
455
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
456 457 458 459 460 461

(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
462 463
      ;; 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
464 465
      (overlay-put overlay 'evaporate t)
      (overlay-put overlay 'priority 100)
Per Abrahamsen's avatar
Per Abrahamsen committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
      (overlay-put overlay (if (string-match "XEmacs" emacs-version)
			       'read-only
			     'modification-hooks) '(widget-overlay-inactive))
      (widget-put widget :inactive overlay))))

(defun widget-overlay-inactive (&rest junk)
  "Ignoring the arguments, signal an error."
  (unless inhibit-read-only
    (error "Attempt to modify inactive widget")))


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

(defun widget-put (widget property value)
  "In WIDGET set PROPERTY to VALUE.
The value can later be retrived with `widget-get'."
  (setcdr widget (plist-put (cdr widget) property value)))

(defun widget-get (widget property)
  "In WIDGET, get the value of PROPERTY.
The value could either be specified when the widget was created, or
later with `widget-put'."
  (let ((missing t)
	value tmp)
    (while missing
      (cond ((setq tmp (widget-plist-member (cdr widget) property))
	     (setq value (car (cdr tmp))
		   missing nil))
	    ((setq tmp (car widget))
	     (setq widget (get tmp 'widget-type)))
	    (t 
	     (setq missing nil))))
    value))

Per Abrahamsen's avatar
Per Abrahamsen committed
511 512 513 514 515 516 517 518 519
(defun widget-get-indirect (widget property)
  "In WIDGET, get the value of PROPERTY.
If the value is a symbol, return its binding.  
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
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
(defun widget-member (widget property)
  "Non-nil iff there is a definition in WIDGET for PROPERTY."
  (cond ((widget-plist-member (cdr widget) property)
	 t)
	((car widget)
	 (widget-member (get (car widget) 'widget-type) property))
	(t nil)))

;;;###autoload
(defun widget-apply (widget property &rest args)
  "Apply the value of WIDGET's PROPERTY to the widget itself.
ARGS are passed as extra arguments to the function."
  (apply (widget-get widget property) widget args))

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

(defun widget-match-inline (widget vals)
  ;; In WIDGET, match the start of VALS.
  (cond ((widget-get widget :inline)
	 (widget-apply widget :match-inline vals))
	((and vals
	      (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
556 557 558
  (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
559

Per Abrahamsen's avatar
Per Abrahamsen committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
;;; 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)
      (error "Value does not match %S type." (car widget)))
    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."
  (let* ((parent (widget-get widget :parent))
	 (children (widget-get parent :children))
	 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
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
(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)))))

Per Abrahamsen's avatar
Per Abrahamsen committed
611 612 613 614 615
;;; Glyphs.

(defcustom widget-glyph-directory (concat data-directory "custom/")
  "Where widget glyphs are located.
If this variable is nil, widget will try to locate the directory
Per Abrahamsen's avatar
Per Abrahamsen committed
616
automatically."
Per Abrahamsen's avatar
Per Abrahamsen committed
617 618 619 620 621 622 623 624
  :group 'widgets
  :type 'directory)

(defcustom widget-glyph-enable t
  "If non nil, use glyphs in images when available."
  :group 'widgets
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
625 626 627 628 629 630 631 632 633 634
(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")))))

Per Abrahamsen's avatar
Per Abrahamsen committed
635 636 637 638 639 640 641
(defun widget-glyph-find (image tag)
  "Create a glyph corresponding to IMAGE with string TAG as fallback.
IMAGE should either already be a glyph, or be a file name sans
extension (xpm, xbm, gif, jpg, or png) located in
`widget-glyph-directory'." 
  (cond ((not (and image 
		   (string-match "XEmacs" emacs-version)
Per Abrahamsen's avatar
Per Abrahamsen committed
642 643
		   widget-glyph-enable
		   (fboundp 'make-glyph)
Per Abrahamsen's avatar
Per Abrahamsen committed
644
		   (fboundp 'locate-file)
Per Abrahamsen's avatar
Per Abrahamsen committed
645 646
		   image))
	 ;; We don't want or can't use glyphs.
Per Abrahamsen's avatar
Per Abrahamsen committed
647
	 nil)
Per Abrahamsen's avatar
Per Abrahamsen committed
648 649
	((and (fboundp 'glyphp)
	      (glyphp image))
Per Abrahamsen's avatar
Per Abrahamsen committed
650 651
	 ;; Already a glyph.  Use it.
	 image)
Per Abrahamsen's avatar
Per Abrahamsen committed
652 653 654 655 656 657 658 659 660
	((stringp image)
	 ;; A string.  Look it up in relevant directories.
	 (let* ((dirlist (list (or widget-glyph-directory
				   (concat data-directory
					   "custom/"))
			       data-directory))
		(formats widget-image-conversion)
		file)
	   (while (and formats (not file))
Per Abrahamsen's avatar
Per Abrahamsen committed
661 662 663 664 665 666
	     (when (valid-image-instantiator-format-p (car (car formats)))
	       (setq file (locate-file image dirlist
				       (mapconcat 'identity
						  (cdr (car formats))
						  ":"))))
	     (unless file
Per Abrahamsen's avatar
Per Abrahamsen committed
667
	       (setq formats (cdr formats))))
Per Abrahamsen's avatar
Per Abrahamsen committed
668 669 670 671 672
	   (and file
		;; We create a glyph with the file as the default image
		;; instantiator, and the TAG fallback
		(make-glyph (list (vector (car (car formats)) ':file file)
				  (vector 'string ':data tag))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
673 674
	((valid-instantiator-p image 'image)
	 ;; A valid image instantiator (e.g. [gif :file "somefile"] etc.)
Per Abrahamsen's avatar
Per Abrahamsen committed
675 676
	 (make-glyph (list image
			   (vector 'string ':data tag))))
Per Abrahamsen's avatar
Per Abrahamsen committed
677 678 679
	((consp image)
	 ;; This could be virtually anything.  Let `make-glyph' sort it out.
	 (make-glyph image))
Per Abrahamsen's avatar
Per Abrahamsen committed
680
	(t
Per Abrahamsen's avatar
Per Abrahamsen committed
681
	 ;; Oh well.
Per Abrahamsen's avatar
Per Abrahamsen committed
682 683 684 685 686 687 688 689 690 691 692 693 694 695
	 nil)))

(defun widget-glyph-insert (widget tag image &optional down inactive)
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
IMAGE should either be a glyph, an image instantiator, or an image file
name sans extension (xpm, xbm, gif, jpg, or png) located in
`widget-glyph-directory'.

Optional arguments DOWN and INACTIVE is used instead of IMAGE when the
glyph is pressed or inactive, respectively. 

WARNING: If you call this with a glyph, and you want the user to be
able to invoke the glyph, make sure it is unique.  If you use the
same glyph for multiple widgets, invoking any of the glyphs will
Per Abrahamsen's avatar
Per Abrahamsen committed
696 697 698 699 700
cause the last created widget to be invoked.

Instead of an instantiator, you can also use a list of instantiators,
or whatever `make-glyph' will accept.  However, in that case you must
provide the fallback TAG as a part of the instantiator yourself."
Per Abrahamsen's avatar
Per Abrahamsen committed
701 702 703 704 705 706 707
  (let ((glyph (widget-glyph-find image tag)))
    (if glyph 
	(widget-glyph-insert-glyph widget 
				   glyph
				   (widget-glyph-find down tag)
				   (widget-glyph-find inactive tag))
      (insert tag))))
Per Abrahamsen's avatar
Per Abrahamsen committed
708 709

(defun widget-glyph-insert-glyph (widget glyph &optional down inactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
710 711 712
  "In WIDGET, insert GLYPH.
If optional arguments DOWN and INACTIVE are given, they should be
glyphs used when the widget is pushed and inactive, respectively."
Per Abrahamsen's avatar
Per Abrahamsen committed
713 714 715 716 717 718
  (when widget
    (set-glyph-property glyph 'widget widget)
    (when down
      (set-glyph-property down 'widget widget))
    (when inactive
      (set-glyph-property inactive 'widget widget)))
Per Abrahamsen's avatar
Per Abrahamsen committed
719
  (insert "*")
Per Abrahamsen's avatar
Per Abrahamsen committed
720
  (let ((ext (make-extent (point) (1- (point))))
Per Abrahamsen's avatar
Per Abrahamsen committed
721
	(help-echo (and widget (widget-get widget :help-echo))))
Per Abrahamsen's avatar
Per Abrahamsen committed
722
    (set-extent-property ext 'invisible t)
Per Abrahamsen's avatar
Per Abrahamsen committed
723 724
    (set-extent-property ext 'start-open t)
    (set-extent-property ext 'end-open t)
Per Abrahamsen's avatar
Per Abrahamsen committed
725 726 727 728
    (set-extent-end-glyph ext glyph)
    (when help-echo
      (set-extent-property ext 'balloon-help help-echo)
      (set-extent-property ext 'help-echo help-echo)))
Per Abrahamsen's avatar
Per Abrahamsen committed
729 730 731 732
  (when widget
    (widget-put widget :glyph-up glyph)
    (when down (widget-put widget :glyph-down down))
    (when inactive (widget-put widget :glyph-inactive inactive))))
Per Abrahamsen's avatar
Per Abrahamsen committed
733

Per Abrahamsen's avatar
Per Abrahamsen committed
734 735 736 737 738 739 740 741 742
;;; 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
743
  :group 'widget-button)
Per Abrahamsen's avatar
Per Abrahamsen committed
744 745 746 747

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

Per Abrahamsen's avatar
Per Abrahamsen committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
;;; Creating Widgets.

;;;###autoload
(defun widget-create (type &rest args)
  "Create widget of TYPE.  
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."
774
  (let ((widget (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
775 776 777 778 779 780 781 782 783 784
    (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."
785
  (let ((widget (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
    (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)
  "Convert TYPE to a widget without inserting it in the buffer. 
The optional ARGS are additional keyword arguments."
  ;; Don't touch the type.
  (let* ((widget (if (symbolp type) 
		     (list type)
806
		   (copy-sequence type)))
Per Abrahamsen's avatar
Per Abrahamsen committed
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
	 (current widget)
	 (keys args))
    ;; First set the :args keyword.
    (while (cdr current)		;Look in the type.
      (let ((next (car (cdr current))))
	(if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
	    (setq current (cdr (cdr current)))
	  (setcdr current (list :args (cdr current)))
	  (setq current nil))))
    (while args				;Look in the args.
      (let ((next (nth 0 args)))
	(if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
	    (setq args (nthcdr 2 args))
	  (widget-put widget :args args)
	  (setq args nil))))
    ;; 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.
    (while keys 
      (let ((next (nth 0 keys)))
	(if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
	    (progn 
	      (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)
	(let ((value (widget-get widget :value)))
	  (widget-put widget
		      :value (widget-apply widget :value-to-internal value))))
    ;; Return the newly create widget.
    widget))

(defun widget-insert (&rest args)
  "Call `insert' with ARGS and make the text read only."
  (let ((inhibit-read-only t)
848
	before-change-functions
Per Abrahamsen's avatar
Per Abrahamsen committed
849 850
	after-change-functions
	(from (point)))
Per Abrahamsen's avatar
Per Abrahamsen committed
851
    (apply 'insert args)))
Per Abrahamsen's avatar
Per Abrahamsen committed
852

Per Abrahamsen's avatar
Per Abrahamsen committed
853 854 855
(defun widget-convert-text (type from to
				 &optional button-from button-to
				 &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
856
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
857
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
858 859
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
860 861 862
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
863 864 865 866 867 868 869 870 871 872
	(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
873
(defun widget-convert-button (type from to &rest args)
Per Abrahamsen's avatar
Per Abrahamsen committed
874
  "Return a widget of type TYPE with endpoint FROM TO.
Per Abrahamsen's avatar
Per Abrahamsen committed
875
Optional ARGS are extra keyword arguments for TYPE.
Per Abrahamsen's avatar
Per Abrahamsen committed
876 877 878
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
879 880 881 882 883 884 885
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and overlays from WIDGET and its children."
  (let ((from (widget-get widget :from))
	(to (widget-get widget :to))
	(button (widget-get widget :button-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
886
	(sample (widget-get widget :sample-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
887
	(doc (widget-get widget :doc-overlay))
Per Abrahamsen's avatar
Per Abrahamsen committed
888 889 890 891
	(field (widget-get widget :field-overlay))
	(children (widget-get widget :children)))
    (set-marker from nil)
    (set-marker to nil)
Per Abrahamsen's avatar
Per Abrahamsen committed
892 893
    (when button
      (delete-overlay button))
Per Abrahamsen's avatar
Per Abrahamsen committed
894 895
    (when sample
      (delete-overlay sample))
Per Abrahamsen's avatar
Per Abrahamsen committed
896 897
    (when doc
      (delete-overlay doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
898 899
    (when field
      (delete-overlay field))
Per Abrahamsen's avatar
Per Abrahamsen committed
900
    (mapcar 'widget-leave-text children)))
Per Abrahamsen's avatar
Per Abrahamsen committed
901

Per Abrahamsen's avatar
Per Abrahamsen committed
902 903 904 905 906 907 908 909 910 911 912
;;; Keymap and Commands.

(defvar widget-keymap nil
  "Keymap containing useful binding for buffers containing widgets.
Recommended as a parent keymap for modes using widgets.")

(unless widget-keymap 
  (setq widget-keymap (make-sparse-keymap))
  (define-key widget-keymap "\t" 'widget-forward)
  (define-key widget-keymap [(shift tab)] 'widget-backward)
  (define-key widget-keymap [backtab] 'widget-backward)
Per Abrahamsen's avatar
Per Abrahamsen committed
913
  (if (string-match "XEmacs" emacs-version)
Per Abrahamsen's avatar
Per Abrahamsen committed
914
      (progn 
Per Abrahamsen's avatar
Per Abrahamsen committed
915 916 917
	;;Glyph support.
	(define-key widget-keymap [button1] 'widget-button1-click) 
	(define-key widget-keymap [button2] 'widget-button-click))
Per Abrahamsen's avatar
Per Abrahamsen committed
918 919 920 921 922 923 924 925 926 927 928 929 930 931
    (define-key widget-keymap [down-mouse-2] 'widget-button-click))
  (define-key widget-keymap "\C-m" 'widget-button-press))

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

(defvar widget-field-keymap nil
  "Keymap used inside an editable field.")

(unless widget-field-keymap 
  (setq widget-field-keymap (copy-keymap widget-keymap))
  (unless (string-match "XEmacs" (emacs-version))
    (define-key widget-field-keymap [menu-bar] 'nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
932 933
  (define-key widget-field-keymap "\C-k" 'widget-kill-line)
  (define-key widget-field-keymap "\M-\t" 'widget-complete)
Per Abrahamsen's avatar
Per Abrahamsen committed
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
  (define-key widget-field-keymap "\C-m" 'widget-field-activate)
  (define-key widget-field-keymap "\C-a" 'widget-beginning-of-line)
  (define-key widget-field-keymap "\C-e" 'widget-end-of-line)
  (set-keymap-parent widget-field-keymap global-map))

(defvar widget-text-keymap nil
  "Keymap used inside a text field.")

(unless widget-text-keymap 
  (setq widget-text-keymap (copy-keymap widget-keymap))
  (unless (string-match "XEmacs" (emacs-version))
    (define-key widget-text-keymap [menu-bar] 'nil))
  (define-key widget-text-keymap "\C-a" 'widget-beginning-of-line)
  (define-key widget-text-keymap "\C-e" 'widget-end-of-line)
  (set-keymap-parent widget-text-keymap global-map))

(defun widget-field-activate (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
951
  "Invoke the ediable field at point."
Per Abrahamsen's avatar
Per Abrahamsen committed
952
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
953
  (let ((field (get-char-property pos 'field)))
Per Abrahamsen's avatar
Per Abrahamsen committed
954 955 956 957 958
    (if field
	(widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

Per Abrahamsen's avatar
Per Abrahamsen committed
959 960 961 962 963 964
(defface widget-button-pressed-face 
  '((((class color))
     (:foreground "red"))
    (t
     (:bold t :underline t)))
  "Face used for pressed buttons."
Per Abrahamsen's avatar
Per Abrahamsen committed
965
  :group 'widget-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
966

Per Abrahamsen's avatar
Per Abrahamsen committed
967
(defun widget-button-click (event)
Per Abrahamsen's avatar
Per Abrahamsen committed
968
  "Invoke button below mouse pointer."
Per Abrahamsen's avatar
Per Abrahamsen committed
969 970 971
  (interactive "@e")
  (cond ((and (fboundp 'event-glyph)
	      (event-glyph event))
Per Abrahamsen's avatar
Per Abrahamsen committed
972 973 974
	 (widget-glyph-click event))
	((widget-event-point event)
	 (let* ((pos (widget-event-point event))
Per Abrahamsen's avatar
Per Abrahamsen committed
975
		(button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
976
	   (if button
Per Abrahamsen's avatar
Per Abrahamsen committed
977 978
	       (let* ((overlay (widget-get button :button-overlay))
		      (face (overlay-get overlay 'face))
Per Abrahamsen's avatar
Per Abrahamsen committed
979
		      (mouse-face (overlay-get overlay 'mouse-face)))
Per Abrahamsen's avatar
Per Abrahamsen committed
980 981
		 (unwind-protect
		     (let ((track-mouse t))
Per Abrahamsen's avatar
Per Abrahamsen committed
982 983
		       (overlay-put overlay
				    'face 'widget-button-pressed-face)
Per Abrahamsen's avatar
Per Abrahamsen committed
984 985 986 987
		       (overlay-put overlay 
				    'mouse-face 'widget-button-pressed-face)
		       (unless (widget-apply button :mouse-down-action event)
			 (while (not (button-release-event-p event))
Per Abrahamsen's avatar
Per Abrahamsen committed
988
			   (setq event (widget-read-event)
Per Abrahamsen's avatar
Per Abrahamsen committed
989 990
				 pos (widget-event-point event))
			   (if (and pos
Per Abrahamsen's avatar
Per Abrahamsen committed
991
				    (eq (get-char-property pos 'button)
Per Abrahamsen's avatar
Per Abrahamsen committed
992 993 994 995 996 997 998 999
					button))
			       (progn 
				 (overlay-put overlay 
					      'face
					      'widget-button-pressed-face)
				 (overlay-put overlay 
					      'mouse-face 
					      'widget-button-pressed-face))
Per Abrahamsen's avatar
Per Abrahamsen committed
1000 1001
			     (overlay-put overlay 'face face)
			     (overlay-put overlay 'mouse-face mouse-face))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1002
		       (when (and pos 
Per Abrahamsen's avatar
Per Abrahamsen committed
1003
				  (eq (get-char-property pos 'button) button))
Per Abrahamsen's avatar
Per Abrahamsen committed
1004
			 (widget-apply-action button event)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1005 1006
		   (overlay-put overlay 'face face)
		   (overlay-put overlay 'mouse-face mouse-face)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1007 1008
	     (let ((up t)
		   command)
Per Abrahamsen's avatar
Per Abrahamsen committed
1009 1010 1011
	       ;; Find the global command to run, and check whether it
	       ;; is bound to an up event.
	       (cond ((setq command	;down event
Per Abrahamsen's avatar
Per Abrahamsen committed
1012 1013
			    (lookup-key widget-global-map [ button2 ]))
		      (setq up nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
1014
		     ((setq command	;down event
Per Abrahamsen's avatar
Per Abrahamsen committed
1015 1016
			    (lookup-key widget-global-map [ down-mouse-2 ]))
		      (setq up nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
1017
		     ((setq command	;up event
Per Abrahamsen's avatar
Per Abrahamsen committed
1018
			    (lookup-key widget-global-map [ button2up ])))
Per Abrahamsen's avatar
Per Abrahamsen committed
1019
		     ((setq command	;up event
Per Abrahamsen's avatar
Per Abrahamsen committed
1020 1021
			    (lookup-key widget-global-map [ mouse-2]))))
	       (when up
Per Abrahamsen's avatar
Per Abrahamsen committed
1022
		 ;; Don't execute up events twice.
Per Abrahamsen's avatar
Per Abrahamsen committed
1023 1024 1025
		 (while (not (button-release-event-p event))
		   (setq event (widget-read-event))))
	       (when command
Per Abrahamsen's avatar
Per Abrahamsen committed
1026
		 (call-interactively command))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1027 1028 1029 1030
	(t
	 (message "You clicked somewhere weird."))))

(defun widget-button1-click (event)
Per Abrahamsen's avatar
Per Abrahamsen committed
1031
  "Invoke glyph below mouse pointer."
Per Abrahamsen's avatar
Per Abrahamsen committed
1032 1033 1034
  (interactive "@e")
  (if (and (fboundp 'event-glyph)
	   (event-glyph event))
Per Abrahamsen's avatar
Per Abrahamsen committed
1035
      (widget-glyph-click event)
Per Abrahamsen's avatar
Per Abrahamsen committed
1036 1037
    (call-interactively (lookup-key widget-global-map (this-command-keys)))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
(defun widget-glyph-click (event)
  "Handle click on a glyph."
  (let* ((glyph (event-glyph event))
	 (widget (glyph-property glyph 'widget))
	 (extent (event-glyph-extent event))
	 (down-glyph (or (and widget (widget-get widget :glyph-down)) glyph))
	 (up-glyph (or (and widget (widget-get widget :glyph-up)) glyph))
	 (last event))
    ;; Wait for the release.
    (while (not (button-release-event-p last))
      (if (eq extent (event-glyph-extent last))
	  (set-extent-property extent 'end-glyph down-glyph)
	(set-extent-property extent 'end-glyph up-glyph))
      (setq last (next-event event)))
    ;; Release glyph.
    (when down-glyph
      (set-extent-property extent 'end-glyph up-glyph))
    ;; Apply widget action.
    (when (eq extent (event-glyph-extent last))
      (let ((widget (glyph-property (event-glyph event) 'widget)))
	(cond ((null widget)
	       (message "You clicked on a glyph."))
	      ((not (widget-apply widget :active))
	       (message "This glyph is inactive."))
	      (t
	       (widget-apply-action widget event)))))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1065
(defun widget-button-press (pos &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
1066
  "Invoke button at POS."
Per Abrahamsen's avatar
Per Abrahamsen committed
1067
  (interactive "@d")
Per Abrahamsen's avatar
Per Abrahamsen committed
1068
  (let ((button (get-char-property pos 'button)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1069 1070 1071 1072 1073 1074
    (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
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
(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)))
  (let ((widget (or (get-char-property (point) 'button)
		    (get-char-property (point) 'field))))
    (if widget
	(let ((order (widget-get widget :tab-order)))
	  (if order
	      (if (>= order 0)
		  widget
		nil)
	    widget))
      nil)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1091 1092 1093 1094 1095 1096
(defcustom widget-use-overlay-change (string-match "XEmacs" emacs-version)
  "If non-nil, use overlay change functions to tab around in the buffer.
This is much faster, but doesn't work reliably on Emacs 19.34."
  :type 'boolean
  :group 'widgets)

Per Abrahamsen's avatar
Per Abrahamsen committed
1097 1098 1099
(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
1100
  (or (bobp) (> arg 0) (backward-char))
Per Abrahamsen's avatar
Per Abrahamsen committed
1101
  (let ((pos (point))
Per Abrahamsen's avatar
Per Abrahamsen committed
1102
	(number arg)
Per Abrahamsen's avatar
Per Abrahamsen committed
1103
	(old (widget-tabable-at))
Per Abrahamsen's avatar
Per Abrahamsen committed
1104 1105 1106
	new)
    ;; Forward.
    (while (> arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
1107 1108 1109 1110 1111 1112
      (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
1113 1114 1115
      (and (eq pos (point))
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
1116
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1117 1118
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
1119
	    (setq arg (1- arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
1120 1121 1122
	    (setq old new)))))
    ;; Backward.
    (while (< arg 0)
Per Abrahamsen's avatar
Per Abrahamsen committed
1123 1124 1125 1126 1127 1128
      (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
1129 1130 1131
      (and (eq pos (point))
	   (eq arg number)
	   (error "No buttons or fields found"))
Per Abrahamsen's avatar
Per Abrahamsen committed
1132
      (let ((new (widget-tabable-at)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1133 1134
	(when new
	  (unless (eq new old)
Per Abrahamsen's avatar
Per Abrahamsen committed
1135 1136 1137 1138
	    (setq arg (1+ arg))))))
    (let ((new (widget-tabable-at)))
      (while (eq (widget-tabable-at) new)
	(backward-char)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1139 1140 1141
    (forward-char))
  (widget-echo-help (point))
  (run-hooks 'widget-move-hook))
Per Abrahamsen's avatar
Per Abrahamsen committed
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

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

(defun widget-beginning-of-line ()
  "Go to beginning of field or beginning of line, whichever is first."
  (interactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
1160 1161 1162 1163
  (let* ((field (widget-field-find (point)))
	 (start (and field (widget-field-start field))))
    (if (and start (not (eq start (point))))
	(goto-char start)
Per Abrahamsen's avatar
Per Abrahamsen committed
1164 1165 1166
      (call-interactively 'beginning-of-line)))
  ;; XEmacs: preserve the region
  (setq zmacs-region-stays t))
Per Abrahamsen's avatar
Per Abrahamsen committed
1167 1168 1169 1170

(defun widget-end-of-line ()
  "Go to end of field or end of line, whichever is first."
  (interactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
1171 1172 1173 1174
  (let* ((field (widget-field-find (point)))
	 (end (and field (widget-field-end field))))
    (if (and end (not (eq end (point))))
	(goto-char end)
Per Abrahamsen's avatar
Per Abrahamsen committed
1175 1176 1177
      (call-interactively 'end-of-line)))
  ;; XEmacs: preserve the region
  (setq zmacs-region-stays t))
Per Abrahamsen's avatar
Per Abrahamsen committed
1178 1179 1180 1181

(defun widget-kill-line ()
  "Kill to end of field or end of line, whichever is first."
  (interactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
1182 1183 1184 1185 1186
  (let* ((field (widget-field-find (point)))
	 (newline (save-excursion (forward-line 1) (point)))
	 (end (and field (widget-field-end field))))
    (if (and field (> newline end))
	(kill-region (point) end)
Per Abrahamsen's avatar
Per Abrahamsen committed
1187 1188
      (call-interactively 'kill-line))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
(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
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
;;; 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)
	(after-change-functions nil)
1218
	before-change-functions
Per Abrahamsen's avatar
Per Abrahamsen committed
1219 1220 1221 1222 1223
	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
1224 1225
      (let ((from (car (widget-get field :field-overlay)))
	    (to (cdr (widget-get field :field-overlay))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1226 1227
	(widget-specify-field field 
			      (marker-position from) (marker-position to))
Per Abrahamsen's avatar
Per Abrahamsen committed
1228 1229
	(set-marker from nil)
	(set-marker to nil))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1230
  (widget-clear-undo)