| 1 | ;;; wid-edit.el --- Functions for creating and using widgets -*-byte-compile-dynamic: t;-*- |
| 2 | ;; |
| 3 | ;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005, |
| 4 | ;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
| 5 | ;; |
| 6 | ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> |
| 7 | ;; Maintainer: FSF |
| 8 | ;; Keywords: extensions |
| 9 | ;; Package: emacs |
| 10 | |
| 11 | ;; This file is part of GNU Emacs. |
| 12 | |
| 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
| 14 | ;; it under the terms of the GNU General Public License as published by |
| 15 | ;; the Free Software Foundation, either version 3 of the License, or |
| 16 | ;; (at your option) any later version. |
| 17 | |
| 18 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 21 | ;; GNU General Public License for more details. |
| 22 | |
| 23 | ;; You should have received a copy of the GNU General Public License |
| 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
| 25 | |
| 26 | ;;; Wishlist items (from widget.texi): |
| 27 | |
| 28 | ;; * The `menu-choice' tag should be prettier, something like the |
| 29 | ;; abbreviated menus in Open Look. |
| 30 | |
| 31 | ;; * Finish `:tab-order'. |
| 32 | |
| 33 | ;; * Make indentation work with glyphs and proportional fonts. |
| 34 | |
| 35 | ;; * Add commands to show overview of object and class hierarchies to |
| 36 | ;; the browser. |
| 37 | |
| 38 | ;; * Find a way to disable mouse highlight for inactive widgets. |
| 39 | |
| 40 | ;; * Find a way to make glyphs look inactive. |
| 41 | |
| 42 | ;; * Add `key-binding' widget. |
| 43 | |
| 44 | ;; * Add `widget' widget for editing widget specifications. |
| 45 | |
| 46 | ;; * Find clean way to implement variable length list. See |
| 47 | ;; `TeX-printer-list' for an explanation. |
| 48 | |
| 49 | ;; * `C-h' in `widget-prompt-value' should give type specific help. |
| 50 | |
| 51 | ;; * A mailto widget. [This should work OK as a url-link if with |
| 52 | ;; browse-url-browser-function' set up appropriately.] |
| 53 | |
| 54 | ;;; Commentary: |
| 55 | ;; |
| 56 | ;; See `widget.el'. |
| 57 | |
| 58 | ;;; Code: |
| 59 | |
| 60 | ;;; Compatibility. |
| 61 | |
| 62 | (defun widget-event-point (event) |
| 63 | "Character position of the end of event if that exists, or nil." |
| 64 | (posn-point (event-end event))) |
| 65 | |
| 66 | (defun widget-button-release-event-p (event) |
| 67 | "Non-nil if EVENT is a mouse-button-release event object." |
| 68 | (and (eventp event) |
| 69 | (memq (event-basic-type event) '(mouse-1 mouse-2 mouse-3)) |
| 70 | (or (memq 'click (event-modifiers event)) |
| 71 | (memq 'drag (event-modifiers event))))) |
| 72 | |
| 73 | ;;; Customization. |
| 74 | |
| 75 | (defgroup widgets nil |
| 76 | "Customization support for the Widget Library." |
| 77 | :link '(custom-manual "(widget)Top") |
| 78 | :link '(emacs-library-link :tag "Lisp File" "widget.el") |
| 79 | :prefix "widget-" |
| 80 | :group 'extensions) |
| 81 | |
| 82 | (defgroup widget-documentation nil |
| 83 | "Options controlling the display of documentation strings." |
| 84 | :group 'widgets) |
| 85 | |
| 86 | (defgroup widget-faces nil |
| 87 | "Faces used by the widget library." |
| 88 | :group 'widgets |
| 89 | :group 'faces) |
| 90 | |
| 91 | (defvar widget-documentation-face 'widget-documentation |
| 92 | "Face used for documentation strings in widgets. |
| 93 | This exists as a variable so it can be set locally in certain buffers.") |
| 94 | |
| 95 | (defface widget-documentation '((((class color) |
| 96 | (background dark)) |
| 97 | (:foreground "lime green")) |
| 98 | (((class color) |
| 99 | (background light)) |
| 100 | (:foreground "dark green")) |
| 101 | (t nil)) |
| 102 | "Face used for documentation text." |
| 103 | :group 'widget-documentation |
| 104 | :group 'widget-faces) |
| 105 | (define-obsolete-face-alias 'widget-documentation-face |
| 106 | 'widget-documentation "22.1") |
| 107 | |
| 108 | (defvar widget-button-face 'widget-button |
| 109 | "Face used for buttons in widgets. |
| 110 | This exists as a variable so it can be set locally in certain buffers.") |
| 111 | |
| 112 | (defface widget-button '((t (:weight bold))) |
| 113 | "Face used for widget buttons." |
| 114 | :group 'widget-faces) |
| 115 | (define-obsolete-face-alias 'widget-button-face 'widget-button "22.1") |
| 116 | |
| 117 | (defcustom widget-mouse-face 'highlight |
| 118 | "Face used for widget buttons when the mouse is above them." |
| 119 | :type 'face |
| 120 | :group 'widget-faces) |
| 121 | |
| 122 | ;; TTY gets special definitions here and in the next defface, because |
| 123 | ;; the gray colors defined for other displays cause black text on a black |
| 124 | ;; background, at least on light-background TTYs. |
| 125 | (defface widget-field '((((type tty)) |
| 126 | :background "yellow3" |
| 127 | :foreground "black") |
| 128 | (((class grayscale color) |
| 129 | (background light)) |
| 130 | :background "gray85") |
| 131 | (((class grayscale color) |
| 132 | (background dark)) |
| 133 | :background "dim gray") |
| 134 | (t |
| 135 | :slant italic)) |
| 136 | "Face used for editable fields." |
| 137 | :group 'widget-faces) |
| 138 | (define-obsolete-face-alias 'widget-field-face 'widget-field "22.1") |
| 139 | |
| 140 | (defface widget-single-line-field '((((type tty)) |
| 141 | :background "green3" |
| 142 | :foreground "black") |
| 143 | (((class grayscale color) |
| 144 | (background light)) |
| 145 | :background "gray85") |
| 146 | (((class grayscale color) |
| 147 | (background dark)) |
| 148 | :background "dim gray") |
| 149 | (t |
| 150 | :slant italic)) |
| 151 | "Face used for editable fields spanning only a single line." |
| 152 | :group 'widget-faces) |
| 153 | (define-obsolete-face-alias 'widget-single-line-field-face |
| 154 | 'widget-single-line-field "22.1") |
| 155 | |
| 156 | ;;; This causes display-table to be loaded, and not usefully. |
| 157 | ;;;(defvar widget-single-line-display-table |
| 158 | ;;; (let ((table (make-display-table))) |
| 159 | ;;; (aset table 9 "^I") |
| 160 | ;;; (aset table 10 "^J") |
| 161 | ;;; table) |
| 162 | ;;; "Display table used for single-line editable fields.") |
| 163 | |
| 164 | ;;;(when (fboundp 'set-face-display-table) |
| 165 | ;;; (set-face-display-table 'widget-single-line-field-face |
| 166 | ;;; widget-single-line-display-table)) |
| 167 | |
| 168 | ;;; Utility functions. |
| 169 | ;; |
| 170 | ;; These are not really widget specific. |
| 171 | |
| 172 | (defun widget-princ-to-string (object) |
| 173 | "Return string representation of OBJECT, any Lisp object. |
| 174 | No quoting characters are used; no delimiters are printed around |
| 175 | the contents of strings." |
| 176 | (with-output-to-string |
| 177 | (princ object))) |
| 178 | |
| 179 | (defun widget-clear-undo () |
| 180 | "Clear all undo information." |
| 181 | (buffer-disable-undo (current-buffer)) |
| 182 | (buffer-enable-undo)) |
| 183 | |
| 184 | (defcustom widget-menu-max-size 40 |
| 185 | "Largest number of items allowed in a popup-menu. |
| 186 | Larger menus are read through the minibuffer." |
| 187 | :group 'widgets |
| 188 | :type 'integer) |
| 189 | |
| 190 | (defcustom widget-menu-max-shortcuts 40 |
| 191 | "Largest number of items for which it works to choose one with a character. |
| 192 | For a larger number of items, the minibuffer is used." |
| 193 | :group 'widgets |
| 194 | :type 'integer) |
| 195 | |
| 196 | (defcustom widget-menu-minibuffer-flag nil |
| 197 | "Control how to ask for a choice from the keyboard. |
| 198 | Non-nil means use the minibuffer; |
| 199 | nil means read a single character." |
| 200 | :group 'widgets |
| 201 | :type 'boolean) |
| 202 | |
| 203 | (defun widget-choose (title items &optional event) |
| 204 | "Choose an item from a list. |
| 205 | |
| 206 | First argument TITLE is the name of the list. |
| 207 | Second argument ITEMS is a list whose members are either |
| 208 | (NAME . VALUE), to indicate selectable items, or just strings to |
| 209 | indicate unselectable items. |
| 210 | Optional third argument EVENT is an input event. |
| 211 | |
| 212 | The user is asked to choose between each NAME from the items alist, |
| 213 | and the VALUE of the chosen element will be returned. If EVENT is a |
| 214 | mouse event, and the number of elements in items is less than |
| 215 | `widget-menu-max-size', a popup menu will be used, otherwise the |
| 216 | minibuffer." |
| 217 | (cond ((and (< (length items) widget-menu-max-size) |
| 218 | event (display-popup-menus-p)) |
| 219 | ;; Mouse click. |
| 220 | (x-popup-menu event |
| 221 | (list title (cons "" items)))) |
| 222 | ((or widget-menu-minibuffer-flag |
| 223 | (> (length items) widget-menu-max-shortcuts)) |
| 224 | ;; Read the choice of name from the minibuffer. |
| 225 | (setq items (widget-remove-if 'stringp items)) |
| 226 | (let ((val (completing-read (concat title ": ") items nil t))) |
| 227 | (if (stringp val) |
| 228 | (let ((try (try-completion val items))) |
| 229 | (when (stringp try) |
| 230 | (setq val try)) |
| 231 | (cdr (assoc val items)))))) |
| 232 | (t |
| 233 | ;; Construct a menu of the choices |
| 234 | ;; and then use it for prompting for a single character. |
| 235 | (let* ((overriding-terminal-local-map (make-sparse-keymap)) |
| 236 | (next-digit ?0) |
| 237 | map choice some-choice-enabled value) |
| 238 | ;; Define SPC as a prefix char to get to this menu. |
| 239 | (define-key overriding-terminal-local-map " " |
| 240 | (setq map (make-sparse-keymap title))) |
| 241 | (with-current-buffer (get-buffer-create " widget-choose") |
| 242 | (erase-buffer) |
| 243 | (insert "Available choices:\n\n") |
| 244 | (while items |
| 245 | (setq choice (car items) items (cdr items)) |
| 246 | (if (consp choice) |
| 247 | (let* ((name (car choice)) |
| 248 | (function (cdr choice))) |
| 249 | (insert (format "%c = %s\n" next-digit name)) |
| 250 | (define-key map (vector next-digit) function) |
| 251 | (setq some-choice-enabled t))) |
| 252 | ;; Allocate digits to disabled alternatives |
| 253 | ;; so that the digit of a given alternative never varies. |
| 254 | (setq next-digit (1+ next-digit))) |
| 255 | (insert "\nC-g = Quit") |
| 256 | (goto-char (point-min)) |
| 257 | (forward-line)) |
| 258 | (or some-choice-enabled |
| 259 | (error "None of the choices is currently meaningful")) |
| 260 | (define-key map [?\C-g] 'keyboard-quit) |
| 261 | (define-key map [t] 'keyboard-quit) |
| 262 | (define-key map [?\M-\C-v] 'scroll-other-window) |
| 263 | (define-key map [?\M--] 'negative-argument) |
| 264 | (setcdr map (nreverse (cdr map))) |
| 265 | ;; Read a char with the menu, and return the result |
| 266 | ;; that corresponds to it. |
| 267 | (save-window-excursion |
| 268 | (let ((buf (get-buffer " widget-choose"))) |
| 269 | (fit-window-to-buffer (display-buffer buf)) |
| 270 | (let ((cursor-in-echo-area t) |
| 271 | keys |
| 272 | (char 0) |
| 273 | (arg 1)) |
| 274 | (while (not (or (and (integerp char) |
| 275 | (>= char ?0) (< char next-digit)) |
| 276 | (eq value 'keyboard-quit))) |
| 277 | ;; Unread a SPC to lead to our new menu. |
| 278 | (setq unread-command-events (cons ?\s unread-command-events)) |
| 279 | (setq keys (read-key-sequence title)) |
| 280 | (setq value |
| 281 | (lookup-key overriding-terminal-local-map keys t) |
| 282 | char (aref keys 1)) |
| 283 | (cond ((eq value 'scroll-other-window) |
| 284 | (let ((minibuffer-scroll-window |
| 285 | (get-buffer-window buf))) |
| 286 | (if (> 0 arg) |
| 287 | (scroll-other-window-down |
| 288 | (window-height minibuffer-scroll-window)) |
| 289 | (scroll-other-window)) |
| 290 | (setq arg 1))) |
| 291 | ((eq value 'negative-argument) |
| 292 | (setq arg -1)) |
| 293 | (t |
| 294 | (setq arg 1))))))) |
| 295 | (when (eq value 'keyboard-quit) |
| 296 | (error "Canceled")) |
| 297 | value)))) |
| 298 | |
| 299 | (defun widget-remove-if (predictate list) |
| 300 | (let (result (tail list)) |
| 301 | (while tail |
| 302 | (or (funcall predictate (car tail)) |
| 303 | (setq result (cons (car tail) result))) |
| 304 | (setq tail (cdr tail))) |
| 305 | (nreverse result))) |
| 306 | |
| 307 | ;;; Widget text specifications. |
| 308 | ;; |
| 309 | ;; These functions are for specifying text properties. |
| 310 | |
| 311 | ;; We can set it to nil now that get_local_map uses get_pos_property. |
| 312 | (defconst widget-field-add-space nil |
| 313 | "Non-nil means add extra space at the end of editable text fields. |
| 314 | If you don't add the space, it will become impossible to edit a zero |
| 315 | size field.") |
| 316 | |
| 317 | (defvar widget-field-use-before-change t |
| 318 | "Non-nil means use `before-change-functions' to track editable fields. |
| 319 | This enables the use of undo. Using before hooks also means that |
| 320 | the :notify function can't know the new value.") |
| 321 | |
| 322 | (defun widget-specify-field (widget from to) |
| 323 | "Specify editable button for WIDGET between FROM and TO." |
| 324 | ;; Terminating space is not part of the field, but necessary in |
| 325 | ;; order for local-map to work. Remove next sexp if local-map works |
| 326 | ;; at the end of the overlay. |
| 327 | (save-excursion |
| 328 | (goto-char to) |
| 329 | (cond ((null (widget-get widget :size)) |
| 330 | (forward-char 1)) |
| 331 | (widget-field-add-space |
| 332 | (insert-and-inherit " "))) |
| 333 | (setq to (point))) |
| 334 | (let ((keymap (widget-get widget :keymap)) |
| 335 | (face (or (widget-get widget :value-face) 'widget-field)) |
| 336 | (help-echo (widget-get widget :help-echo)) |
| 337 | (follow-link (widget-get widget :follow-link)) |
| 338 | (rear-sticky |
| 339 | (or (not widget-field-add-space) (widget-get widget :size)))) |
| 340 | (if (functionp help-echo) |
| 341 | (setq help-echo 'widget-mouse-help)) |
| 342 | (when (= (char-before to) ?\n) |
| 343 | ;; When the last character in the field is a newline, we want to |
| 344 | ;; give it a `field' char-property of `boundary', which helps the |
| 345 | ;; C-n/C-p act more naturally when entering/leaving the field. We |
| 346 | ;; do this by making a small secondary overlay to contain just that |
| 347 | ;; one character. |
| 348 | (let ((overlay (make-overlay (1- to) to nil t nil))) |
| 349 | (overlay-put overlay 'field 'boundary) |
| 350 | ;; We need the real field for tabbing. |
| 351 | (overlay-put overlay 'real-field widget) |
| 352 | ;; Use `local-map' here, not `keymap', so that normal editing |
| 353 | ;; works in the field when, say, Custom uses `suppress-keymap'. |
| 354 | (overlay-put overlay 'local-map keymap) |
| 355 | (overlay-put overlay 'face face) |
| 356 | (overlay-put overlay 'follow-link follow-link) |
| 357 | (overlay-put overlay 'help-echo help-echo)) |
| 358 | (setq to (1- to)) |
| 359 | (setq rear-sticky t)) |
| 360 | (let ((overlay (make-overlay from to nil nil rear-sticky))) |
| 361 | (widget-put widget :field-overlay overlay) |
| 362 | ;;(overlay-put overlay 'detachable nil) |
| 363 | (overlay-put overlay 'field widget) |
| 364 | (overlay-put overlay 'local-map keymap) |
| 365 | (overlay-put overlay 'face face) |
| 366 | (overlay-put overlay 'follow-link follow-link) |
| 367 | (overlay-put overlay 'help-echo help-echo))) |
| 368 | (widget-specify-secret widget)) |
| 369 | |
| 370 | (defun widget-specify-secret (field) |
| 371 | "Replace text in FIELD with value of `:secret', if non-nil." |
| 372 | (let ((secret (widget-get field :secret)) |
| 373 | (size (widget-get field :size))) |
| 374 | (when secret |
| 375 | (let ((begin (widget-field-start field)) |
| 376 | (end (widget-field-end field))) |
| 377 | (when size |
| 378 | (while (and (> end begin) |
| 379 | (eq (char-after (1- end)) ?\s)) |
| 380 | (setq end (1- end)))) |
| 381 | (while (< begin end) |
| 382 | (let ((old (char-after begin))) |
| 383 | (unless (eq old secret) |
| 384 | (subst-char-in-region begin (1+ begin) old secret) |
| 385 | (put-text-property begin (1+ begin) 'secret old)) |
| 386 | (setq begin (1+ begin)))))))) |
| 387 | |
| 388 | (defun widget-specify-button (widget from to) |
| 389 | "Specify button for WIDGET between FROM and TO." |
| 390 | (let ((overlay (make-overlay from to nil t nil)) |
| 391 | (follow-link (widget-get widget :follow-link)) |
| 392 | (help-echo (widget-get widget :help-echo))) |
| 393 | (widget-put widget :button-overlay overlay) |
| 394 | (if (functionp help-echo) |
| 395 | (setq help-echo 'widget-mouse-help)) |
| 396 | (overlay-put overlay 'button widget) |
| 397 | (overlay-put overlay 'keymap (widget-get widget :keymap)) |
| 398 | (overlay-put overlay 'evaporate t) |
| 399 | ;; We want to avoid the face with image buttons. |
| 400 | (unless (widget-get widget :suppress-face) |
| 401 | (overlay-put overlay 'face (widget-apply widget :button-face-get)) |
| 402 | (overlay-put overlay 'mouse-face |
| 403 | ;; Make new list structure for the mouse-face value |
| 404 | ;; so that different widgets will have |
| 405 | ;; different `mouse-face' property values |
| 406 | ;; and will highlight separately. |
| 407 | (let ((mouse-face-value |
| 408 | (widget-apply widget :mouse-face-get))) |
| 409 | ;; If it's a list, copy it. |
| 410 | (if (listp mouse-face-value) |
| 411 | (copy-sequence mouse-face-value) |
| 412 | ;; If it's a symbol, put it in a list. |
| 413 | (list mouse-face-value))))) |
| 414 | (overlay-put overlay 'pointer 'hand) |
| 415 | (overlay-put overlay 'follow-link follow-link) |
| 416 | (overlay-put overlay 'help-echo help-echo))) |
| 417 | |
| 418 | (defun widget-mouse-help (window overlay point) |
| 419 | "Help-echo callback for widgets whose :help-echo is a function." |
| 420 | (with-current-buffer (overlay-buffer overlay) |
| 421 | (let* ((widget (widget-at (overlay-start overlay))) |
| 422 | (help-echo (if widget (widget-get widget :help-echo)))) |
| 423 | (if (functionp help-echo) |
| 424 | (funcall help-echo widget) |
| 425 | help-echo)))) |
| 426 | |
| 427 | (defun widget-specify-sample (widget from to) |
| 428 | "Specify sample for WIDGET between FROM and TO." |
| 429 | (let ((overlay (make-overlay from to nil t nil))) |
| 430 | (overlay-put overlay 'face (widget-apply widget :sample-face-get)) |
| 431 | (overlay-put overlay 'evaporate t) |
| 432 | (widget-put widget :sample-overlay overlay))) |
| 433 | |
| 434 | (defun widget-specify-doc (widget from to) |
| 435 | "Specify documentation for WIDGET between FROM and TO." |
| 436 | (let ((overlay (make-overlay from to nil t nil))) |
| 437 | (overlay-put overlay 'widget-doc widget) |
| 438 | (overlay-put overlay 'face widget-documentation-face) |
| 439 | (overlay-put overlay 'evaporate t) |
| 440 | (widget-put widget :doc-overlay overlay))) |
| 441 | |
| 442 | (defmacro widget-specify-insert (&rest form) |
| 443 | "Execute FORM without inheriting any text properties." |
| 444 | `(save-restriction |
| 445 | (let ((inhibit-read-only t) |
| 446 | (inhibit-modification-hooks t)) |
| 447 | (narrow-to-region (point) (point)) |
| 448 | (prog1 (progn ,@form) |
| 449 | (goto-char (point-max)))))) |
| 450 | |
| 451 | (defface widget-inactive |
| 452 | '((t :inherit shadow)) |
| 453 | "Face used for inactive widgets." |
| 454 | :group 'widget-faces) |
| 455 | (define-obsolete-face-alias 'widget-inactive-face |
| 456 | 'widget-inactive "22.1") |
| 457 | |
| 458 | (defun widget-specify-inactive (widget from to) |
| 459 | "Make WIDGET inactive for user modifications." |
| 460 | (unless (widget-get widget :inactive) |
| 461 | (let ((overlay (make-overlay from to nil t nil))) |
| 462 | (overlay-put overlay 'face 'widget-inactive) |
| 463 | ;; This is disabled, as it makes the mouse cursor change shape. |
| 464 | ;; (overlay-put overlay 'mouse-face 'widget-inactive) |
| 465 | (overlay-put overlay 'evaporate t) |
| 466 | (overlay-put overlay 'priority 100) |
| 467 | (overlay-put overlay 'modification-hooks '(widget-overlay-inactive)) |
| 468 | (widget-put widget :inactive overlay)))) |
| 469 | |
| 470 | (defun widget-overlay-inactive (&rest junk) |
| 471 | "Ignoring the arguments, signal an error." |
| 472 | (unless inhibit-read-only |
| 473 | (error "The widget here is not active"))) |
| 474 | |
| 475 | |
| 476 | (defun widget-specify-active (widget) |
| 477 | "Make WIDGET active for user modifications." |
| 478 | (let ((inactive (widget-get widget :inactive))) |
| 479 | (when inactive |
| 480 | (delete-overlay inactive) |
| 481 | (widget-put widget :inactive nil)))) |
| 482 | |
| 483 | ;;; Widget Properties. |
| 484 | |
| 485 | (defsubst widget-type (widget) |
| 486 | "Return the type of WIDGET. The type is a symbol." |
| 487 | (car widget)) |
| 488 | |
| 489 | ;;;###autoload |
| 490 | (defun widgetp (widget) |
| 491 | "Return non-nil if WIDGET is a widget." |
| 492 | (if (symbolp widget) |
| 493 | (get widget 'widget-type) |
| 494 | (and (consp widget) |
| 495 | (symbolp (car widget)) |
| 496 | (get (car widget) 'widget-type)))) |
| 497 | |
| 498 | (defun widget-get-indirect (widget property) |
| 499 | "In WIDGET, get the value of PROPERTY. |
| 500 | If the value is a symbol, return its binding. |
| 501 | Otherwise, just return the value." |
| 502 | (let ((value (widget-get widget property))) |
| 503 | (if (symbolp value) |
| 504 | (symbol-value value) |
| 505 | value))) |
| 506 | |
| 507 | (defun widget-member (widget property) |
| 508 | "Non-nil if there is a definition in WIDGET for PROPERTY." |
| 509 | (cond ((plist-member (cdr widget) property) |
| 510 | t) |
| 511 | ((car widget) |
| 512 | (widget-member (get (car widget) 'widget-type) property)) |
| 513 | (t nil))) |
| 514 | |
| 515 | (defun widget-value (widget) |
| 516 | "Extract the current value of WIDGET." |
| 517 | (widget-apply widget |
| 518 | :value-to-external (widget-apply widget :value-get))) |
| 519 | |
| 520 | (defun widget-value-set (widget value) |
| 521 | "Set the current value of WIDGET to VALUE." |
| 522 | (widget-apply widget |
| 523 | :value-set (widget-apply widget |
| 524 | :value-to-internal value))) |
| 525 | |
| 526 | (defun widget-default-get (widget) |
| 527 | "Extract the default external value of WIDGET." |
| 528 | (widget-apply widget :value-to-external |
| 529 | (or (widget-get widget :value) |
| 530 | (widget-apply widget :default-get)))) |
| 531 | |
| 532 | (defun widget-match-inline (widget vals) |
| 533 | "In WIDGET, match the start of VALS." |
| 534 | (cond ((widget-get widget :inline) |
| 535 | (widget-apply widget :match-inline vals)) |
| 536 | ((and (listp vals) |
| 537 | (widget-apply widget :match (car vals))) |
| 538 | (cons (list (car vals)) (cdr vals))) |
| 539 | (t nil))) |
| 540 | |
| 541 | (defun widget-apply-action (widget &optional event) |
| 542 | "Apply :action in WIDGET in response to EVENT." |
| 543 | (if (widget-apply widget :active) |
| 544 | (widget-apply widget :action event) |
| 545 | (error "Attempt to perform action on inactive widget"))) |
| 546 | |
| 547 | ;;; Helper functions. |
| 548 | ;; |
| 549 | ;; These are widget specific. |
| 550 | |
| 551 | ;;;###autoload |
| 552 | (defun widget-prompt-value (widget prompt &optional value unbound) |
| 553 | "Prompt for a value matching WIDGET, using PROMPT. |
| 554 | The current value is assumed to be VALUE, unless UNBOUND is non-nil." |
| 555 | (unless (listp widget) |
| 556 | (setq widget (list widget))) |
| 557 | (setq prompt (format "[%s] %s" (widget-type widget) prompt)) |
| 558 | (setq widget (widget-convert widget)) |
| 559 | (let ((answer (widget-apply widget :prompt-value prompt value unbound))) |
| 560 | (unless (widget-apply widget :match answer) |
| 561 | (error "Value does not match %S type" (car widget))) |
| 562 | answer)) |
| 563 | |
| 564 | (defun widget-get-sibling (widget) |
| 565 | "Get the item WIDGET is assumed to toggle. |
| 566 | This is only meaningful for radio buttons or checkboxes in a list." |
| 567 | (let* ((children (widget-get (widget-get widget :parent) :children)) |
| 568 | child) |
| 569 | (catch 'child |
| 570 | (while children |
| 571 | (setq child (car children) |
| 572 | children (cdr children)) |
| 573 | (when (eq (widget-get child :button) widget) |
| 574 | (throw 'child child))) |
| 575 | nil))) |
| 576 | |
| 577 | (defun widget-map-buttons (function &optional buffer maparg) |
| 578 | "Map FUNCTION over the buttons in BUFFER. |
| 579 | FUNCTION is called with the arguments WIDGET and MAPARG. |
| 580 | |
| 581 | If FUNCTION returns non-nil, the walk is cancelled. |
| 582 | |
| 583 | The arguments MAPARG, and BUFFER default to nil and (current-buffer), |
| 584 | respectively." |
| 585 | (let ((cur (point-min)) |
| 586 | (widget nil) |
| 587 | (overlays (if buffer |
| 588 | (with-current-buffer buffer (overlay-lists)) |
| 589 | (overlay-lists)))) |
| 590 | (setq overlays (append (car overlays) (cdr overlays))) |
| 591 | (while (setq cur (pop overlays)) |
| 592 | (setq widget (overlay-get cur 'button)) |
| 593 | (if (and widget (funcall function widget maparg)) |
| 594 | (setq overlays nil))))) |
| 595 | |
| 596 | ;;; Images. |
| 597 | |
| 598 | (defcustom widget-image-directory (file-name-as-directory |
| 599 | (expand-file-name "images/custom" data-directory)) |
| 600 | "Where widget button images are located. |
| 601 | If this variable is nil, widget will try to locate the directory |
| 602 | automatically." |
| 603 | :group 'widgets |
| 604 | :type 'directory) |
| 605 | |
| 606 | (defcustom widget-image-enable t |
| 607 | "If non-nil, use image buttons in widgets when available." |
| 608 | :version "21.1" |
| 609 | :group 'widgets |
| 610 | :type 'boolean) |
| 611 | |
| 612 | (defcustom widget-image-conversion |
| 613 | '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg") |
| 614 | (xbm ".xbm")) |
| 615 | "Conversion alist from image formats to file name suffixes." |
| 616 | :group 'widgets |
| 617 | :type '(repeat (cons :format "%v" |
| 618 | (symbol :tag "Image Format" unknown) |
| 619 | (repeat :tag "Suffixes" |
| 620 | (string :format "%v"))))) |
| 621 | |
| 622 | (defun widget-image-find (image) |
| 623 | "Create a graphical button from IMAGE. |
| 624 | IMAGE should either already be an image, or be a file name sans |
| 625 | extension (xpm, xbm, gif, jpg, or png) located in |
| 626 | `widget-image-directory' or otherwise where `find-image' will find it." |
| 627 | (cond ((not (and image widget-image-enable (display-graphic-p))) |
| 628 | ;; We don't want or can't use images. |
| 629 | nil) |
| 630 | ((and (consp image) |
| 631 | (eq 'image (car image))) |
| 632 | ;; Already an image spec. Use it. |
| 633 | image) |
| 634 | ((stringp image) |
| 635 | ;; A string. Look it up in relevant directories. |
| 636 | (let* ((load-path (cons widget-image-directory load-path)) |
| 637 | specs) |
| 638 | (dolist (elt widget-image-conversion) |
| 639 | (dolist (ext (cdr elt)) |
| 640 | (push (list :type (car elt) :file (concat image ext) |
| 641 | :ascent 'center) specs))) |
| 642 | (find-image (nreverse specs)))) |
| 643 | (t |
| 644 | ;; Oh well. |
| 645 | nil))) |
| 646 | |
| 647 | (defvar widget-button-pressed-face 'widget-button-pressed |
| 648 | "Face used for pressed buttons in widgets. |
| 649 | This exists as a variable so it can be set locally in certain |
| 650 | buffers.") |
| 651 | |
| 652 | (defun widget-image-insert (widget tag image &optional down inactive) |
| 653 | "In WIDGET, insert the text TAG or, if supported, IMAGE. |
| 654 | IMAGE should either be an image or an image file name sans extension |
| 655 | \(xpm, xbm, gif, jpg, or png) located in `widget-image-directory'. |
| 656 | |
| 657 | Optional arguments DOWN and INACTIVE are used instead of IMAGE when the |
| 658 | button is pressed or inactive, respectively. These are currently ignored." |
| 659 | (if (and (featurep 'image) |
| 660 | (setq image (widget-image-find image))) |
| 661 | (progn (widget-put widget :suppress-face t) |
| 662 | (insert-image image tag)) |
| 663 | (insert tag))) |
| 664 | |
| 665 | (defun widget-move-and-invoke (event) |
| 666 | "Move to where you click, and if it is an active field, invoke it." |
| 667 | (interactive "e") |
| 668 | (mouse-set-point event) |
| 669 | (let ((pos (widget-event-point event))) |
| 670 | (if (and pos (get-char-property pos 'button)) |
| 671 | (widget-button-click event)))) |
| 672 | |
| 673 | ;;; Buttons. |
| 674 | |
| 675 | (defgroup widget-button nil |
| 676 | "The look of various kinds of buttons." |
| 677 | :group 'widgets) |
| 678 | |
| 679 | (defcustom widget-button-prefix "" |
| 680 | "String used as prefix for buttons." |
| 681 | :type 'string |
| 682 | :group 'widget-button) |
| 683 | |
| 684 | (defcustom widget-button-suffix "" |
| 685 | "String used as suffix for buttons." |
| 686 | :type 'string |
| 687 | :group 'widget-button) |
| 688 | |
| 689 | ;;; Creating Widgets. |
| 690 | |
| 691 | ;;;###autoload |
| 692 | (defun widget-create (type &rest args) |
| 693 | "Create widget of TYPE. |
| 694 | The optional ARGS are additional keyword arguments." |
| 695 | (let ((widget (apply 'widget-convert type args))) |
| 696 | (widget-apply widget :create) |
| 697 | widget)) |
| 698 | |
| 699 | (defun widget-create-child-and-convert (parent type &rest args) |
| 700 | "As part of the widget PARENT, create a child widget TYPE. |
| 701 | The child is converted, using the keyword arguments ARGS." |
| 702 | (let ((widget (apply 'widget-convert type args))) |
| 703 | (widget-put widget :parent parent) |
| 704 | (unless (widget-get widget :indent) |
| 705 | (widget-put widget :indent (+ (or (widget-get parent :indent) 0) |
| 706 | (or (widget-get widget :extra-offset) 0) |
| 707 | (widget-get parent :offset)))) |
| 708 | (widget-apply widget :create) |
| 709 | widget)) |
| 710 | |
| 711 | (defun widget-create-child (parent type) |
| 712 | "Create widget of TYPE." |
| 713 | (let ((widget (widget-copy type))) |
| 714 | (widget-put widget :parent parent) |
| 715 | (unless (widget-get widget :indent) |
| 716 | (widget-put widget :indent (+ (or (widget-get parent :indent) 0) |
| 717 | (or (widget-get widget :extra-offset) 0) |
| 718 | (widget-get parent :offset)))) |
| 719 | (widget-apply widget :create) |
| 720 | widget)) |
| 721 | |
| 722 | (defun widget-create-child-value (parent type value) |
| 723 | "Create widget of TYPE with value VALUE." |
| 724 | (let ((widget (widget-copy type))) |
| 725 | (widget-put widget :value (widget-apply widget :value-to-internal value)) |
| 726 | (widget-put widget :parent parent) |
| 727 | (unless (widget-get widget :indent) |
| 728 | (widget-put widget :indent (+ (or (widget-get parent :indent) 0) |
| 729 | (or (widget-get widget :extra-offset) 0) |
| 730 | (widget-get parent :offset)))) |
| 731 | (widget-apply widget :create) |
| 732 | widget)) |
| 733 | |
| 734 | ;;;###autoload |
| 735 | (defun widget-delete (widget) |
| 736 | "Delete WIDGET." |
| 737 | (widget-apply widget :delete)) |
| 738 | |
| 739 | (defun widget-copy (widget) |
| 740 | "Make a deep copy of WIDGET." |
| 741 | (widget-apply (copy-sequence widget) :copy)) |
| 742 | |
| 743 | (defun widget-convert (type &rest args) |
| 744 | "Convert TYPE to a widget without inserting it in the buffer. |
| 745 | The optional ARGS are additional keyword arguments." |
| 746 | ;; Don't touch the type. |
| 747 | (let* ((widget (if (symbolp type) |
| 748 | (list type) |
| 749 | (copy-sequence type))) |
| 750 | (current widget) |
| 751 | done |
| 752 | (keys args)) |
| 753 | ;; First set the :args keyword. |
| 754 | (while (cdr current) ;Look in the type. |
| 755 | (if (and (keywordp (cadr current)) |
| 756 | ;; If the last element is a keyword, |
| 757 | ;; it is still the :args element, |
| 758 | ;; even though it is a keyword. |
| 759 | (cddr current)) |
| 760 | (if (eq (cadr current) :args) |
| 761 | ;; If :args is explicitly specified, obey it. |
| 762 | (setq current nil) |
| 763 | ;; Some other irrelevant keyword. |
| 764 | (setq current (cdr (cdr current)))) |
| 765 | (setcdr current (list :args (cdr current))) |
| 766 | (setq current nil))) |
| 767 | (while (and args (not done)) ;Look in ARGS. |
| 768 | (cond ((eq (car args) :args) |
| 769 | ;; Handle explicit specification of :args. |
| 770 | (setq args (cadr args) |
| 771 | done t)) |
| 772 | ((keywordp (car args)) |
| 773 | (setq args (cddr args))) |
| 774 | (t (setq done t)))) |
| 775 | (when done |
| 776 | (widget-put widget :args args)) |
| 777 | ;; Then Convert the widget. |
| 778 | (setq type widget) |
| 779 | (while type |
| 780 | (let ((convert-widget (plist-get (cdr type) :convert-widget))) |
| 781 | (if convert-widget |
| 782 | (setq widget (funcall convert-widget widget)))) |
| 783 | (setq type (get (car type) 'widget-type))) |
| 784 | ;; Finally set the keyword args. |
| 785 | (while keys |
| 786 | (let ((next (nth 0 keys))) |
| 787 | (if (keywordp next) |
| 788 | (progn |
| 789 | (widget-put widget next (nth 1 keys)) |
| 790 | (setq keys (nthcdr 2 keys))) |
| 791 | (setq keys nil)))) |
| 792 | ;; Convert the :value to internal format. |
| 793 | (if (widget-member widget :value) |
| 794 | (widget-put widget |
| 795 | :value (widget-apply widget |
| 796 | :value-to-internal |
| 797 | (widget-get widget :value)))) |
| 798 | ;; Return the newly create widget. |
| 799 | widget)) |
| 800 | |
| 801 | ;;;###autoload |
| 802 | (defun widget-insert (&rest args) |
| 803 | "Call `insert' with ARGS even if surrounding text is read only." |
| 804 | (let ((inhibit-read-only t) |
| 805 | (inhibit-modification-hooks t)) |
| 806 | (apply 'insert args))) |
| 807 | |
| 808 | (defun widget-convert-text (type from to |
| 809 | &optional button-from button-to |
| 810 | &rest args) |
| 811 | "Return a widget of type TYPE with endpoint FROM TO. |
| 812 | No text will be inserted to the buffer, instead the text between FROM |
| 813 | and TO will be used as the widgets end points. If optional arguments |
| 814 | BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets |
| 815 | button end points. |
| 816 | Optional ARGS are extra keyword arguments for TYPE." |
| 817 | (let ((widget (apply 'widget-convert type :delete 'widget-leave-text args)) |
| 818 | (from (copy-marker from)) |
| 819 | (to (copy-marker to))) |
| 820 | (set-marker-insertion-type from t) |
| 821 | (set-marker-insertion-type to nil) |
| 822 | (widget-put widget :from from) |
| 823 | (widget-put widget :to to) |
| 824 | (when button-from |
| 825 | (widget-specify-button widget button-from button-to)) |
| 826 | widget)) |
| 827 | |
| 828 | (defun widget-convert-button (type from to &rest args) |
| 829 | "Return a widget of type TYPE with endpoint FROM TO. |
| 830 | Optional ARGS are extra keyword arguments for TYPE. |
| 831 | No text will be inserted to the buffer, instead the text between FROM |
| 832 | and TO will be used as the widgets end points, as well as the widgets |
| 833 | button end points." |
| 834 | (apply 'widget-convert-text type from to from to args)) |
| 835 | |
| 836 | (defun widget-leave-text (widget) |
| 837 | "Remove markers and overlays from WIDGET and its children." |
| 838 | (let ((button (widget-get widget :button-overlay)) |
| 839 | (sample (widget-get widget :sample-overlay)) |
| 840 | (doc (widget-get widget :doc-overlay)) |
| 841 | (field (widget-get widget :field-overlay))) |
| 842 | (set-marker (widget-get widget :from) nil) |
| 843 | (set-marker (widget-get widget :to) nil) |
| 844 | (when button |
| 845 | (delete-overlay button)) |
| 846 | (when sample |
| 847 | (delete-overlay sample)) |
| 848 | (when doc |
| 849 | (delete-overlay doc)) |
| 850 | (when field |
| 851 | (delete-overlay field)) |
| 852 | (mapc 'widget-leave-text (widget-get widget :children)))) |
| 853 | |
| 854 | ;;; Keymap and Commands. |
| 855 | |
| 856 | ;; This alias exists only so that one can choose in doc-strings (e.g. |
| 857 | ;; Custom-mode) which key-binding of widget-keymap one wants to refer to. |
| 858 | ;; http://lists.gnu.org/archive/html/emacs-devel/2008-11/msg00480.html |
| 859 | (define-obsolete-function-alias 'advertised-widget-backward |
| 860 | 'widget-backward "23.2") |
| 861 | |
| 862 | ;;;###autoload |
| 863 | (defvar widget-keymap |
| 864 | (let ((map (make-sparse-keymap))) |
| 865 | (define-key map "\t" 'widget-forward) |
| 866 | (define-key map "\e\t" 'widget-backward) |
| 867 | (define-key map [(shift tab)] 'widget-backward) |
| 868 | (put 'widget-backward :advertised-binding [(shift tab)]) |
| 869 | (define-key map [backtab] 'widget-backward) |
| 870 | (define-key map [down-mouse-2] 'widget-button-click) |
| 871 | (define-key map [down-mouse-1] 'widget-button-click) |
| 872 | ;; The following definition needs to avoid using escape sequences that |
| 873 | ;; might get converted to ^M when building loaddefs.el |
| 874 | (define-key map [(control ?m)] 'widget-button-press) |
| 875 | map) |
| 876 | "Keymap containing useful binding for buffers containing widgets. |
| 877 | Recommended as a parent keymap for modes using widgets. |
| 878 | Note that such modes will need to require wid-edit.") |
| 879 | |
| 880 | (defvar widget-global-map global-map |
| 881 | "Keymap used for events a widget does not handle itself.") |
| 882 | (make-variable-buffer-local 'widget-global-map) |
| 883 | |
| 884 | (defvar widget-field-keymap |
| 885 | (let ((map (copy-keymap widget-keymap))) |
| 886 | (define-key map "\C-k" 'widget-kill-line) |
| 887 | (define-key map "\M-\t" 'widget-complete) |
| 888 | (define-key map "\C-m" 'widget-field-activate) |
| 889 | ;; Since the widget code uses a `field' property to identify fields, |
| 890 | ;; ordinary beginning-of-line does the right thing. |
| 891 | ;; (define-key map "\C-a" 'widget-beginning-of-line) |
| 892 | (define-key map "\C-e" 'widget-end-of-line) |
| 893 | map) |
| 894 | "Keymap used inside an editable field.") |
| 895 | |
| 896 | (defvar widget-text-keymap |
| 897 | (let ((map (copy-keymap widget-keymap))) |
| 898 | ;; Since the widget code uses a `field' property to identify fields, |
| 899 | ;; ordinary beginning-of-line does the right thing. |
| 900 | ;; (define-key map "\C-a" 'widget-beginning-of-line) |
| 901 | (define-key map "\C-e" 'widget-end-of-line) |
| 902 | map) |
| 903 | "Keymap used inside a text field.") |
| 904 | |
| 905 | (defun widget-field-activate (pos &optional event) |
| 906 | "Invoke the editable field at point." |
| 907 | (interactive "@d") |
| 908 | (let ((field (widget-field-at pos))) |
| 909 | (if field |
| 910 | (widget-apply-action field event) |
| 911 | (call-interactively |
| 912 | (lookup-key widget-global-map (this-command-keys)))))) |
| 913 | |
| 914 | (defface widget-button-pressed |
| 915 | '((((min-colors 88) (class color)) |
| 916 | (:foreground "red1")) |
| 917 | (((class color)) |
| 918 | (:foreground "red")) |
| 919 | (t |
| 920 | (:weight bold :underline t))) |
| 921 | "Face used for pressed buttons." |
| 922 | :group 'widget-faces) |
| 923 | (define-obsolete-face-alias 'widget-button-pressed-face |
| 924 | 'widget-button-pressed "22.1") |
| 925 | |
| 926 | (defvar widget-button-click-moves-point nil |
| 927 | "If non-nil, `widget-button-click' moves point to a button after invoking it. |
| 928 | If nil, point returns to its original position after invoking a button.") |
| 929 | |
| 930 | (defun widget-button-click (event) |
| 931 | "Invoke the button that the mouse is pointing at." |
| 932 | (interactive "e") |
| 933 | (if (widget-event-point event) |
| 934 | (let* ((oevent event) |
| 935 | (mouse-1 (memq (event-basic-type event) '(mouse-1 down-mouse-1))) |
| 936 | (pos (widget-event-point event)) |
| 937 | (start (event-start event)) |
| 938 | (button (get-char-property |
| 939 | pos 'button (and (windowp (posn-window start)) |
| 940 | (window-buffer (posn-window start))))) |
| 941 | newpoint) |
| 942 | (when (or (null button) |
| 943 | (catch 'button-press-cancelled |
| 944 | ;; Mouse click on a widget button. Do the following |
| 945 | ;; in a save-excursion so that the click on the button |
| 946 | ;; doesn't change point. |
| 947 | (save-selected-window |
| 948 | (select-window (posn-window (event-start event))) |
| 949 | (save-excursion |
| 950 | (goto-char (posn-point (event-start event))) |
| 951 | (let* ((overlay (widget-get button :button-overlay)) |
| 952 | (pressed-face (or (widget-get button :pressed-face) |
| 953 | widget-button-pressed-face)) |
| 954 | (face (overlay-get overlay 'face)) |
| 955 | (mouse-face (overlay-get overlay 'mouse-face))) |
| 956 | (unwind-protect |
| 957 | ;; Read events, including mouse-movement |
| 958 | ;; events, waiting for a release event. If we |
| 959 | ;; began with a mouse-1 event and receive a |
| 960 | ;; movement event, that means the user wants |
| 961 | ;; to perform drag-selection, so cancel the |
| 962 | ;; button press and do the default mouse-1 |
| 963 | ;; action. For mouse-2, just highlight/ |
| 964 | ;; unhighlight the button the mouse was |
| 965 | ;; initially on when we move over it. |
| 966 | (save-excursion |
| 967 | (when face ; avoid changing around image |
| 968 | (overlay-put overlay 'face pressed-face) |
| 969 | (overlay-put overlay 'mouse-face pressed-face)) |
| 970 | (unless (widget-apply button :mouse-down-action event) |
| 971 | (let ((track-mouse t)) |
| 972 | (while (not (widget-button-release-event-p event)) |
| 973 | (setq event (read-event)) |
| 974 | (when (and mouse-1 (mouse-movement-p event)) |
| 975 | (push event unread-command-events) |
| 976 | (setq event oevent) |
| 977 | (throw 'button-press-cancelled t)) |
| 978 | (unless (or (integerp event) |
| 979 | (memq (car event) '(switch-frame select-window)) |
| 980 | (eq (car event) 'scroll-bar-movement)) |
| 981 | (setq pos (widget-event-point event)) |
| 982 | (if (and pos |
| 983 | (eq (get-char-property pos 'button) |
| 984 | button)) |
| 985 | (when face |
| 986 | (overlay-put overlay 'face pressed-face) |
| 987 | (overlay-put overlay 'mouse-face pressed-face)) |
| 988 | (overlay-put overlay 'face face) |
| 989 | (overlay-put overlay 'mouse-face mouse-face)))))) |
| 990 | |
| 991 | ;; When mouse is released over the button, run |
| 992 | ;; its action function. |
| 993 | (when (and pos (eq (get-char-property pos 'button) button)) |
| 994 | (goto-char pos) |
| 995 | (widget-apply-action button event) |
| 996 | (if widget-button-click-moves-point |
| 997 | (setq newpoint (point))))) |
| 998 | (overlay-put overlay 'face face) |
| 999 | (overlay-put overlay 'mouse-face mouse-face)))) |
| 1000 | |
| 1001 | (if newpoint (goto-char newpoint)) |
| 1002 | ;; This loses if the widget action switches windows. -- cyd |
| 1003 | ;; (unless (pos-visible-in-window-p (widget-event-point event)) |
| 1004 | ;; (mouse-set-point event) |
| 1005 | ;; (beginning-of-line) |
| 1006 | ;; (recenter)) |
| 1007 | ) |
| 1008 | nil)) |
| 1009 | (let ((up t) command) |
| 1010 | ;; Mouse click not on a widget button. Find the global |
| 1011 | ;; command to run, and check whether it is bound to an |
| 1012 | ;; up event. |
| 1013 | (if mouse-1 |
| 1014 | (cond ((setq command ;down event |
| 1015 | (lookup-key widget-global-map [down-mouse-1])) |
| 1016 | (setq up nil)) |
| 1017 | ((setq command ;up event |
| 1018 | (lookup-key widget-global-map [mouse-1])))) |
| 1019 | (cond ((setq command ;down event |
| 1020 | (lookup-key widget-global-map [down-mouse-2])) |
| 1021 | (setq up nil)) |
| 1022 | ((setq command ;up event |
| 1023 | (lookup-key widget-global-map [mouse-2]))))) |
| 1024 | (when up |
| 1025 | ;; Don't execute up events twice. |
| 1026 | (while (not (widget-button-release-event-p event)) |
| 1027 | (setq event (read-event)))) |
| 1028 | (when command |
| 1029 | (call-interactively command))))) |
| 1030 | (message "You clicked somewhere weird."))) |
| 1031 | |
| 1032 | (defun widget-button-press (pos &optional event) |
| 1033 | "Invoke button at POS." |
| 1034 | (interactive "@d") |
| 1035 | (let ((button (get-char-property pos 'button))) |
| 1036 | (if button |
| 1037 | (widget-apply-action button event) |
| 1038 | (let ((command (lookup-key widget-global-map (this-command-keys)))) |
| 1039 | (when (commandp command) |
| 1040 | (call-interactively command)))))) |
| 1041 | |
| 1042 | (defun widget-tabable-at (&optional pos) |
| 1043 | "Return the tabable widget at POS, or nil. |
| 1044 | POS defaults to the value of (point)." |
| 1045 | (let ((widget (widget-at pos))) |
| 1046 | (if widget |
| 1047 | (let ((order (widget-get widget :tab-order))) |
| 1048 | (if order |
| 1049 | (if (>= order 0) |
| 1050 | widget) |
| 1051 | widget))))) |
| 1052 | |
| 1053 | (defvar widget-use-overlay-change t |
| 1054 | "If non-nil, use overlay change functions to tab around in the buffer. |
| 1055 | This is much faster.") |
| 1056 | |
| 1057 | (defun widget-move (arg) |
| 1058 | "Move point to the ARG next field or button. |
| 1059 | ARG may be negative to move backward." |
| 1060 | (or (bobp) (> arg 0) (backward-char)) |
| 1061 | (let ((wrapped 0) |
| 1062 | (number arg) |
| 1063 | (old (widget-tabable-at))) |
| 1064 | ;; Forward. |
| 1065 | (while (> arg 0) |
| 1066 | (cond ((eobp) |
| 1067 | (goto-char (point-min)) |
| 1068 | (setq wrapped (1+ wrapped))) |
| 1069 | (widget-use-overlay-change |
| 1070 | (goto-char (next-overlay-change (point)))) |
| 1071 | (t |
| 1072 | (forward-char 1))) |
| 1073 | (and (= wrapped 2) |
| 1074 | (eq arg number) |
| 1075 | (error "No buttons or fields found")) |
| 1076 | (let ((new (widget-tabable-at))) |
| 1077 | (when new |
| 1078 | (unless (eq new old) |
| 1079 | (setq arg (1- arg)) |
| 1080 | (setq old new))))) |
| 1081 | ;; Backward. |
| 1082 | (while (< arg 0) |
| 1083 | (cond ((bobp) |
| 1084 | (goto-char (point-max)) |
| 1085 | (setq wrapped (1+ wrapped))) |
| 1086 | (widget-use-overlay-change |
| 1087 | (goto-char (previous-overlay-change (point)))) |
| 1088 | (t |
| 1089 | (backward-char 1))) |
| 1090 | (and (= wrapped 2) |
| 1091 | (eq arg number) |
| 1092 | (error "No buttons or fields found")) |
| 1093 | (let ((new (widget-tabable-at))) |
| 1094 | (when new |
| 1095 | (unless (eq new old) |
| 1096 | (setq arg (1+ arg)))))) |
| 1097 | (let ((new (widget-tabable-at))) |
| 1098 | (while (eq (widget-tabable-at) new) |
| 1099 | (backward-char))) |
| 1100 | (forward-char)) |
| 1101 | (widget-echo-help (point)) |
| 1102 | (run-hooks 'widget-move-hook)) |
| 1103 | |
| 1104 | (defun widget-forward (arg) |
| 1105 | "Move point to the next field or button. |
| 1106 | With optional ARG, move across that many fields." |
| 1107 | (interactive "p") |
| 1108 | (run-hooks 'widget-forward-hook) |
| 1109 | (widget-move arg)) |
| 1110 | |
| 1111 | (defun widget-backward (arg) |
| 1112 | "Move point to the previous field or button. |
| 1113 | With optional ARG, move across that many fields." |
| 1114 | (interactive "p") |
| 1115 | (run-hooks 'widget-backward-hook) |
| 1116 | (widget-move (- arg))) |
| 1117 | |
| 1118 | ;; Since the widget code uses a `field' property to identify fields, |
| 1119 | ;; ordinary beginning-of-line does the right thing. |
| 1120 | (defalias 'widget-beginning-of-line 'beginning-of-line) |
| 1121 | |
| 1122 | (defun widget-end-of-line () |
| 1123 | "Go to end of field or end of line, whichever is first. |
| 1124 | Trailing spaces at the end of padded fields are not considered part of |
| 1125 | the field." |
| 1126 | (interactive) |
| 1127 | ;; Ordinary end-of-line does the right thing, because we're inside |
| 1128 | ;; text with a `field' property. |
| 1129 | (end-of-line) |
| 1130 | (unless (eolp) |
| 1131 | ;; ... except that we want to ignore trailing spaces in fields that |
| 1132 | ;; aren't terminated by a newline, because they are used as padding, |
| 1133 | ;; and ignored when extracting the entered value of the field. |
| 1134 | (skip-chars-backward " " (field-beginning (1- (point)))))) |
| 1135 | |
| 1136 | (defun widget-kill-line () |
| 1137 | "Kill to end of field or end of line, whichever is first." |
| 1138 | (interactive) |
| 1139 | (let* ((field (widget-field-find (point))) |
| 1140 | (end (and field (widget-field-end field)))) |
| 1141 | (if (and field (> (line-beginning-position 2) end)) |
| 1142 | (kill-region (point) end) |
| 1143 | (call-interactively 'kill-line)))) |
| 1144 | |
| 1145 | (defcustom widget-complete-field (lookup-key global-map "\M-\t") |
| 1146 | "Default function to call for completion inside fields." |
| 1147 | :options '(ispell-complete-word complete-tag lisp-complete-symbol) |
| 1148 | :type 'function |
| 1149 | :group 'widgets) |
| 1150 | |
| 1151 | (defun widget-narrow-to-field () |
| 1152 | "Narrow to field." |
| 1153 | (interactive) |
| 1154 | (let ((field (widget-field-find (point)))) |
| 1155 | (if field |
| 1156 | (narrow-to-region (line-beginning-position) (line-end-position))))) |
| 1157 | |
| 1158 | ;; This used to say: |
| 1159 | ;; "When not inside a field, move to the previous button or field." |
| 1160 | ;; but AFAICS, it has always just thrown an error. |
| 1161 | (defun widget-complete () |
| 1162 | "Complete content of editable field from point. |
| 1163 | When not inside a field, signal an error." |
| 1164 | (interactive) |
| 1165 | (let ((field (widget-field-find (point)))) |
| 1166 | (if field |
| 1167 | (widget-apply field :complete) |
| 1168 | (error "Not in an editable field")))) |
| 1169 | |
| 1170 | ;;; Setting up the buffer. |
| 1171 | |
| 1172 | (defvar widget-field-new nil |
| 1173 | "List of all newly created editable fields in the buffer.") |
| 1174 | (make-variable-buffer-local 'widget-field-new) |
| 1175 | |
| 1176 | (defvar widget-field-list nil |
| 1177 | "List of all editable fields in the buffer.") |
| 1178 | (make-variable-buffer-local 'widget-field-list) |
| 1179 | |
| 1180 | (defun widget-at (&optional pos) |
| 1181 | "The button or field at POS (default, point)." |
| 1182 | (or (get-char-property (or pos (point)) 'button) |
| 1183 | (widget-field-at pos))) |
| 1184 | |
| 1185 | ;;;###autoload |
| 1186 | (defun widget-setup () |
| 1187 | "Setup current buffer so editing string widgets works." |
| 1188 | (let ((inhibit-read-only t) |
| 1189 | (inhibit-modification-hooks t) |
| 1190 | field) |
| 1191 | (while widget-field-new |
| 1192 | (setq field (car widget-field-new) |
| 1193 | widget-field-new (cdr widget-field-new) |
| 1194 | widget-field-list (cons field widget-field-list)) |
| 1195 | (let ((from (car (widget-get field :field-overlay))) |
| 1196 | (to (cdr (widget-get field :field-overlay)))) |
| 1197 | (widget-specify-field field |
| 1198 | (marker-position from) (marker-position to)) |
| 1199 | (set-marker from nil) |
| 1200 | (set-marker to nil)))) |
| 1201 | (widget-clear-undo) |
| 1202 | (widget-add-change)) |
| 1203 | |
| 1204 | (defvar widget-field-last nil) |
| 1205 | ;; Last field containing point. |
| 1206 | (make-variable-buffer-local 'widget-field-last) |
| 1207 | |
| 1208 | (defvar widget-field-was nil) |
| 1209 | ;; The widget data before the change. |
| 1210 | (make-variable-buffer-local 'widget-field-was) |
| 1211 | |
| 1212 | (defun widget-field-at (pos) |
| 1213 | "Return the widget field at POS, or nil if none." |
| 1214 | (let ((field (get-char-property (or pos (point)) 'field))) |
| 1215 | (if (eq field 'boundary) |
| 1216 | (get-char-property (or pos (point)) 'real-field) |
| 1217 | field))) |
| 1218 | |
| 1219 | (defun widget-field-buffer (widget) |
| 1220 | "Return the buffer of WIDGET's editing field." |
| 1221 | (let ((overlay (widget-get widget :field-overlay))) |
| 1222 | (cond ((overlayp overlay) |
| 1223 | (overlay-buffer overlay)) |
| 1224 | ((consp overlay) |
| 1225 | (marker-buffer (car overlay)))))) |
| 1226 | |
| 1227 | (defun widget-field-start (widget) |
| 1228 | "Return the start of WIDGET's editing field." |
| 1229 | (let ((overlay (widget-get widget :field-overlay))) |
| 1230 | (if (overlayp overlay) |
| 1231 | (overlay-start overlay) |
| 1232 | (car overlay)))) |
| 1233 | |
| 1234 | (defun widget-field-end (widget) |
| 1235 | "Return the end of WIDGET's editing field." |
| 1236 | (let ((overlay (widget-get widget :field-overlay))) |
| 1237 | ;; Don't subtract one if local-map works at the end of the overlay, |
| 1238 | ;; or if a special `boundary' field has been added after the widget |
| 1239 | ;; field. |
| 1240 | (if (overlayp overlay) |
| 1241 | ;; Don't proceed if overlay has been removed from buffer. |
| 1242 | (when (overlay-buffer overlay) |
| 1243 | (if (and (not (eq (with-current-buffer |
| 1244 | (widget-field-buffer widget) |
| 1245 | (save-restriction |
| 1246 | ;; `widget-narrow-to-field' can be |
| 1247 | ;; active when this function is called |
| 1248 | ;; from an change-functions hook. So |
| 1249 | ;; temporarily remove field narrowing |
| 1250 | ;; before to call `get-char-property'. |
| 1251 | (widen) |
| 1252 | (get-char-property (overlay-end overlay) |
| 1253 | 'field))) |
| 1254 | 'boundary)) |
| 1255 | (or widget-field-add-space |
| 1256 | (null (widget-get widget :size)))) |
| 1257 | (1- (overlay-end overlay)) |
| 1258 | (overlay-end overlay))) |
| 1259 | (cdr overlay)))) |
| 1260 | |
| 1261 | (defun widget-field-text-end (widget) |
| 1262 | (let ((to (widget-field-end widget)) |
| 1263 | (size (widget-get widget :size))) |
| 1264 | (if (or (null size) (zerop size)) |
| 1265 | to |
| 1266 | (let ((from (widget-field-start widget))) |
| 1267 | (if (and from to) |
| 1268 | (with-current-buffer (widget-field-buffer widget) |
| 1269 | (while (and (> to from) |
| 1270 | (eq (char-after (1- to)) ?\s)) |
| 1271 | (setq to (1- to))) |
| 1272 | to)))))) |
| 1273 | |
| 1274 | (defun widget-field-find (pos) |
| 1275 | "Return the field at POS. |
| 1276 | Unlike (get-char-property POS 'field), this works with empty fields too." |
| 1277 | (let ((fields widget-field-list) |
| 1278 | field found) |
| 1279 | (while fields |
| 1280 | (setq field (car fields) |
| 1281 | fields (cdr fields)) |
| 1282 | (when (and (<= (widget-field-start field) pos) |
| 1283 | (<= pos (widget-field-end field))) |
| 1284 | (when found |
| 1285 | (error "Overlapping fields")) |
| 1286 | (setq found field))) |
| 1287 | found)) |
| 1288 | |
| 1289 | (defun widget-before-change (from to) |
| 1290 | ;; This is how, for example, a variable changes its state to `modified'. |
| 1291 | ;; when it is being edited. |
| 1292 | (unless inhibit-read-only |
| 1293 | (let ((from-field (widget-field-find from)) |
| 1294 | (to-field (widget-field-find to))) |
| 1295 | (cond ((not (eq from-field to-field)) |
| 1296 | (add-hook 'post-command-hook 'widget-add-change nil t) |
| 1297 | (signal 'text-read-only |
| 1298 | '("Change should be restricted to a single field"))) |
| 1299 | ((null from-field) |
| 1300 | (add-hook 'post-command-hook 'widget-add-change nil t) |
| 1301 | (signal 'text-read-only |
| 1302 | '("Attempt to change text outside editable field"))) |
| 1303 | (widget-field-use-before-change |
| 1304 | (widget-apply from-field :notify from-field)))))) |
| 1305 | |
| 1306 | (defun widget-add-change () |
| 1307 | (remove-hook 'post-command-hook 'widget-add-change t) |
| 1308 | (add-hook 'before-change-functions 'widget-before-change nil t) |
| 1309 | (add-hook 'after-change-functions 'widget-after-change nil t)) |
| 1310 | |
| 1311 | (defun widget-after-change (from to old) |
| 1312 | "Adjust field size and text properties." |
| 1313 | (let ((field (widget-field-find from)) |
| 1314 | (other (widget-field-find to))) |
| 1315 | (when field |
| 1316 | (unless (eq field other) |
| 1317 | (error "Change in different fields")) |
| 1318 | (let ((size (widget-get field :size))) |
| 1319 | (when size |
| 1320 | (let ((begin (widget-field-start field)) |
| 1321 | (end (widget-field-end field))) |
| 1322 | (cond ((< (- end begin) size) |
| 1323 | ;; Field too small. |
| 1324 | (save-excursion |
| 1325 | (goto-char end) |
| 1326 | (insert-char ?\s (- (+ begin size) end)))) |
| 1327 | ((> (- end begin) size) |
| 1328 | ;; Field too large and |
| 1329 | (if (or (< (point) (+ begin size)) |
| 1330 | (> (point) end)) |
| 1331 | ;; Point is outside extra space. |
| 1332 | (setq begin (+ begin size)) |
| 1333 | ;; Point is within the extra space. |
| 1334 | (setq begin (point))) |
| 1335 | (save-excursion |
| 1336 | (goto-char end) |
| 1337 | (while (and (eq (preceding-char) ?\s) |
| 1338 | (> (point) begin)) |
| 1339 | (delete-char -1))))))) |
| 1340 | (widget-specify-secret field)) |
| 1341 | (widget-apply field :notify field)))) |
| 1342 | |
| 1343 | ;;; Widget Functions |
| 1344 | ;; |
| 1345 | ;; These functions are used in the definition of multiple widgets. |
| 1346 | |
| 1347 | (defun widget-parent-action (widget &optional event) |
| 1348 | "Tell :parent of WIDGET to handle the :action. |
| 1349 | Optional EVENT is the event that triggered the action." |
| 1350 | (widget-apply (widget-get widget :parent) :action event)) |
| 1351 | |
| 1352 | (defun widget-children-value-delete (widget) |
| 1353 | "Delete all :children and :buttons in WIDGET." |
| 1354 | (mapc 'widget-delete (widget-get widget :children)) |
| 1355 | (widget-put widget :children nil) |
| 1356 | (mapc 'widget-delete (widget-get widget :buttons)) |
| 1357 | (widget-put widget :buttons nil)) |
| 1358 | |
| 1359 | (defun widget-children-validate (widget) |
| 1360 | "All the :children must be valid." |
| 1361 | (let ((children (widget-get widget :children)) |
| 1362 | child found) |
| 1363 | (while (and children (not found)) |
| 1364 | (setq child (car children) |
| 1365 | children (cdr children) |
| 1366 | found (widget-apply child :validate))) |
| 1367 | found)) |
| 1368 | |
| 1369 | (defun widget-child-value-get (widget) |
| 1370 | "Get the value of the first member of :children in WIDGET." |
| 1371 | (widget-value (car (widget-get widget :children)))) |
| 1372 | |
| 1373 | (defun widget-child-value-inline (widget) |
| 1374 | "Get the inline value of the first member of :children in WIDGET." |
| 1375 | (widget-apply (car (widget-get widget :children)) :value-inline)) |
| 1376 | |
| 1377 | (defun widget-child-validate (widget) |
| 1378 | "The result of validating the first member of :children in WIDGET." |
| 1379 | (widget-apply (car (widget-get widget :children)) :validate)) |
| 1380 | |
| 1381 | (defun widget-type-value-create (widget) |
| 1382 | "Convert and instantiate the value of the :type attribute of WIDGET. |
| 1383 | Store the newly created widget in the :children attribute. |
| 1384 | |
| 1385 | The value of the :type attribute should be an unconverted widget type." |
| 1386 | (let ((value (widget-get widget :value)) |
| 1387 | (type (widget-get widget :type))) |
| 1388 | (widget-put widget :children |
| 1389 | (list (widget-create-child-value widget |
| 1390 | (widget-convert type) |
| 1391 | value))))) |
| 1392 | |
| 1393 | (defun widget-type-default-get (widget) |
| 1394 | "Get default value from the :type attribute of WIDGET. |
| 1395 | |
| 1396 | The value of the :type attribute should be an unconverted widget type." |
| 1397 | (widget-default-get (widget-convert (widget-get widget :type)))) |
| 1398 | |
| 1399 | (defun widget-type-match (widget value) |
| 1400 | "Non-nil if the :type value of WIDGET matches VALUE. |
| 1401 | |
| 1402 | The value of the :type attribute should be an unconverted widget type." |
| 1403 | (widget-apply (widget-convert (widget-get widget :type)) :match value)) |
| 1404 | |
| 1405 | (defun widget-types-copy (widget) |
| 1406 | "Copy :args as widget types in WIDGET." |
| 1407 | (widget-put widget :args (mapcar 'widget-copy (widget-get widget :args))) |
| 1408 | widget) |
| 1409 | |
| 1410 | ;; Made defsubst to speed up face editor creation. |
| 1411 | (defsubst widget-types-convert-widget (widget) |
| 1412 | "Convert :args as widget types in WIDGET." |
| 1413 | (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args))) |
| 1414 | widget) |
| 1415 | |
| 1416 | (defun widget-value-convert-widget (widget) |
| 1417 | "Initialize :value from :args in WIDGET." |
| 1418 | (let ((args (widget-get widget :args))) |
| 1419 | (when args |
| 1420 | (widget-put widget :value (car args)) |
| 1421 | ;; Don't convert :value here, as this is done in `widget-convert'. |
| 1422 | ;; (widget-put widget :value (widget-apply widget |
| 1423 | ;; :value-to-internal (car args))) |
| 1424 | (widget-put widget :args nil))) |
| 1425 | widget) |
| 1426 | |
| 1427 | (defun widget-value-value-get (widget) |
| 1428 | "Return the :value property of WIDGET." |
| 1429 | (widget-get widget :value)) |
| 1430 | |
| 1431 | ;;; The `default' Widget. |
| 1432 | |
| 1433 | (define-widget 'default nil |
| 1434 | "Basic widget other widgets are derived from." |
| 1435 | :value-to-internal (lambda (widget value) value) |
| 1436 | :value-to-external (lambda (widget value) value) |
| 1437 | :button-prefix 'widget-button-prefix |
| 1438 | :button-suffix 'widget-button-suffix |
| 1439 | :complete 'widget-default-complete |
| 1440 | :create 'widget-default-create |
| 1441 | :indent nil |
| 1442 | :offset 0 |
| 1443 | :format-handler 'widget-default-format-handler |
| 1444 | :button-face-get 'widget-default-button-face-get |
| 1445 | :mouse-face-get 'widget-default-mouse-face-get |
| 1446 | :sample-face-get 'widget-default-sample-face-get |
| 1447 | :delete 'widget-default-delete |
| 1448 | :copy 'identity |
| 1449 | :value-set 'widget-default-value-set |
| 1450 | :value-inline 'widget-default-value-inline |
| 1451 | :value-delete 'ignore |
| 1452 | :default-get 'widget-default-default-get |
| 1453 | :menu-tag-get 'widget-default-menu-tag-get |
| 1454 | :validate #'ignore |
| 1455 | :active 'widget-default-active |
| 1456 | :activate 'widget-specify-active |
| 1457 | :deactivate 'widget-default-deactivate |
| 1458 | :mouse-down-action #'ignore |
| 1459 | :action 'widget-default-action |
| 1460 | :notify 'widget-default-notify |
| 1461 | :prompt-value 'widget-default-prompt-value) |
| 1462 | |
| 1463 | (defvar widget--completing-widget) |
| 1464 | |
| 1465 | (defun widget-default-complete (widget) |
| 1466 | "Call the value of the :complete-function property of WIDGET. |
| 1467 | If that does not exist, call the value of `widget-complete-field'. |
| 1468 | During this call, `widget--completing-widget' is bound to WIDGET." |
| 1469 | (let ((widget--completing-widget widget)) |
| 1470 | (call-interactively (or (widget-get widget :complete-function) |
| 1471 | widget-complete-field)))) |
| 1472 | |
| 1473 | (defun widget-default-create (widget) |
| 1474 | "Create WIDGET at point in the current buffer." |
| 1475 | (widget-specify-insert |
| 1476 | (let ((from (point)) |
| 1477 | button-begin button-end |
| 1478 | sample-begin sample-end |
| 1479 | doc-begin doc-end |
| 1480 | value-pos) |
| 1481 | (insert (widget-get widget :format)) |
| 1482 | (goto-char from) |
| 1483 | ;; Parse escapes in format. |
| 1484 | (while (re-search-forward "%\\(.\\)" nil t) |
| 1485 | (let ((escape (char-after (match-beginning 1)))) |
| 1486 | (delete-char -2) |
| 1487 | (cond ((eq escape ?%) |
| 1488 | (insert ?%)) |
| 1489 | ((eq escape ?\[) |
| 1490 | (setq button-begin (point)) |
| 1491 | (insert (widget-get-indirect widget :button-prefix))) |
| 1492 | ((eq escape ?\]) |
| 1493 | (insert (widget-get-indirect widget :button-suffix)) |
| 1494 | (setq button-end (point))) |
| 1495 | ((eq escape ?\{) |
| 1496 | (setq sample-begin (point))) |
| 1497 | ((eq escape ?\}) |
| 1498 | (setq sample-end (point))) |
| 1499 | ((eq escape ?n) |
| 1500 | (when (widget-get widget :indent) |
| 1501 | (insert ?\n) |
| 1502 | (insert-char ?\s (widget-get widget :indent)))) |
| 1503 | ((eq escape ?t) |
| 1504 | (let ((image (widget-get widget :tag-glyph)) |
| 1505 | (tag (widget-get widget :tag))) |
| 1506 | (cond (image |
| 1507 | (widget-image-insert widget (or tag "image") image)) |
| 1508 | (tag |
| 1509 | (insert tag)) |
| 1510 | (t |
| 1511 | (princ (widget-get widget :value) |
| 1512 | (current-buffer)))))) |
| 1513 | ((eq escape ?d) |
| 1514 | (let ((doc (widget-get widget :doc))) |
| 1515 | (when doc |
| 1516 | (setq doc-begin (point)) |
| 1517 | (insert doc) |
| 1518 | (while (eq (preceding-char) ?\n) |
| 1519 | (delete-char -1)) |
| 1520 | (insert ?\n) |
| 1521 | (setq doc-end (point))))) |
| 1522 | ((eq escape ?h) |
| 1523 | (widget-add-documentation-string-button widget)) |
| 1524 | ((eq escape ?v) |
| 1525 | (if (and button-begin (not button-end)) |
| 1526 | (widget-apply widget :value-create) |
| 1527 | (setq value-pos (point)))) |
| 1528 | (t |
| 1529 | (widget-apply widget :format-handler escape))))) |
| 1530 | ;; Specify button, sample, and doc, and insert value. |
| 1531 | (and button-begin button-end |
| 1532 | (widget-specify-button widget button-begin button-end)) |
| 1533 | (and sample-begin sample-end |
| 1534 | (widget-specify-sample widget sample-begin sample-end)) |
| 1535 | (and doc-begin doc-end |
| 1536 | (widget-specify-doc widget doc-begin doc-end)) |
| 1537 | (when value-pos |
| 1538 | (goto-char value-pos) |
| 1539 | (widget-apply widget :value-create))) |
| 1540 | (let ((from (point-min-marker)) |
| 1541 | (to (point-max-marker))) |
| 1542 | (set-marker-insertion-type from t) |
| 1543 | (set-marker-insertion-type to nil) |
| 1544 | (widget-put widget :from from) |
| 1545 | (widget-put widget :to to))) |
| 1546 | (widget-clear-undo)) |
| 1547 | |
| 1548 | (defun widget-default-format-handler (widget escape) |
| 1549 | (error "Unknown escape `%c'" escape)) |
| 1550 | |
| 1551 | (defun widget-default-button-face-get (widget) |
| 1552 | ;; Use :button-face or widget-button-face |
| 1553 | (or (widget-get widget :button-face) |
| 1554 | (let ((parent (widget-get widget :parent))) |
| 1555 | (if parent |
| 1556 | (widget-apply parent :button-face-get) |
| 1557 | widget-button-face)))) |
| 1558 | |
| 1559 | (defun widget-default-mouse-face-get (widget) |
| 1560 | ;; Use :mouse-face or widget-mouse-face |
| 1561 | (or (widget-get widget :mouse-face) |
| 1562 | (let ((parent (widget-get widget :parent))) |
| 1563 | (if parent |
| 1564 | (widget-apply parent :mouse-face-get) |
| 1565 | widget-mouse-face)))) |
| 1566 | |
| 1567 | (defun widget-default-sample-face-get (widget) |
| 1568 | ;; Use :sample-face. |
| 1569 | (widget-get widget :sample-face)) |
| 1570 | |
| 1571 | (defun widget-default-delete (widget) |
| 1572 | "Remove widget from the buffer." |
| 1573 | (let ((from (widget-get widget :from)) |
| 1574 | (to (widget-get widget :to)) |
| 1575 | (inactive-overlay (widget-get widget :inactive)) |
| 1576 | (button-overlay (widget-get widget :button-overlay)) |
| 1577 | (sample-overlay (widget-get widget :sample-overlay)) |
| 1578 | (doc-overlay (widget-get widget :doc-overlay)) |
| 1579 | (inhibit-modification-hooks t) |
| 1580 | (inhibit-read-only t)) |
| 1581 | (widget-apply widget :value-delete) |
| 1582 | (widget-children-value-delete widget) |
| 1583 | (when inactive-overlay |
| 1584 | (delete-overlay inactive-overlay)) |
| 1585 | (when button-overlay |
| 1586 | (delete-overlay button-overlay)) |
| 1587 | (when sample-overlay |
| 1588 | (delete-overlay sample-overlay)) |
| 1589 | (when doc-overlay |
| 1590 | (delete-overlay doc-overlay)) |
| 1591 | (when (< from to) |
| 1592 | ;; Kludge: this doesn't need to be true for empty formats. |
| 1593 | (delete-region from to)) |
| 1594 | (set-marker from nil) |
| 1595 | (set-marker to nil)) |
| 1596 | (widget-clear-undo)) |
| 1597 | |
| 1598 | (defun widget-default-value-set (widget value) |
| 1599 | "Recreate widget with new value." |
| 1600 | (let* ((old-pos (point)) |
| 1601 | (from (copy-marker (widget-get widget :from))) |
| 1602 | (to (copy-marker (widget-get widget :to))) |
| 1603 | (offset (if (and (<= from old-pos) (<= old-pos to)) |
| 1604 | (if (>= old-pos (1- to)) |
| 1605 | (- old-pos to 1) |
| 1606 | (- old-pos from))))) |
| 1607 | ;;??? Bug: this ought to insert the new value before deleting the old one, |
| 1608 | ;; so that markers on either side of the value automatically |
| 1609 | ;; stay on the same side. -- rms. |
| 1610 | (save-excursion |
| 1611 | (goto-char (widget-get widget :from)) |
| 1612 | (widget-apply widget :delete) |
| 1613 | (widget-put widget :value value) |
| 1614 | (widget-apply widget :create)) |
| 1615 | (if offset |
| 1616 | (if (< offset 0) |
| 1617 | (goto-char (+ (widget-get widget :to) offset 1)) |
| 1618 | (goto-char (min (+ from offset) (1- (widget-get widget :to)))))))) |
| 1619 | |
| 1620 | (defun widget-default-value-inline (widget) |
| 1621 | "Wrap value in a list unless it is inline." |
| 1622 | (if (widget-get widget :inline) |
| 1623 | (widget-value widget) |
| 1624 | (list (widget-value widget)))) |
| 1625 | |
| 1626 | (defun widget-default-default-get (widget) |
| 1627 | "Get `:value'." |
| 1628 | (widget-get widget :value)) |
| 1629 | |
| 1630 | (defun widget-default-menu-tag-get (widget) |
| 1631 | "Use tag or value for menus." |
| 1632 | (or (widget-get widget :menu-tag) |
| 1633 | (widget-get widget :tag) |
| 1634 | (widget-princ-to-string (widget-get widget :value)))) |
| 1635 | |
| 1636 | (defun widget-default-active (widget) |
| 1637 | "Return t if this widget is active (user modifiable)." |
| 1638 | (or (widget-get widget :always-active) |
| 1639 | (and (not (widget-get widget :inactive)) |
| 1640 | (let ((parent (widget-get widget :parent))) |
| 1641 | (or (null parent) |
| 1642 | (widget-apply parent :active)))))) |
| 1643 | |
| 1644 | (defun widget-default-deactivate (widget) |
| 1645 | "Make WIDGET inactive for user modifications." |
| 1646 | (widget-specify-inactive widget |
| 1647 | (widget-get widget :from) |
| 1648 | (widget-get widget :to))) |
| 1649 | |
| 1650 | (defun widget-default-action (widget &optional event) |
| 1651 | "Notify the parent when a widget changes." |
| 1652 | (let ((parent (widget-get widget :parent))) |
| 1653 | (when parent |
| 1654 | (widget-apply parent :notify widget event)))) |
| 1655 | |
| 1656 | (defun widget-default-notify (widget child &optional event) |
| 1657 | "Pass notification to parent." |
| 1658 | (widget-default-action widget event)) |
| 1659 | |
| 1660 | (defun widget-default-prompt-value (widget prompt value unbound) |
| 1661 | "Read an arbitrary value." |
| 1662 | (eval-minibuffer prompt)) |
| 1663 | |
| 1664 | (defun widget-docstring (widget) |
| 1665 | "Return the documentation string specificied by WIDGET, or nil if none. |
| 1666 | If WIDGET has a `:doc' property, that specifies the documentation string. |
| 1667 | Otherwise, try the `:documentation-property' property. If this |
| 1668 | is a function, call it with the widget's value as an argument; if |
| 1669 | it is a symbol, use this symbol together with the widget's value |
| 1670 | as the argument to `documentation-property'." |
| 1671 | (let ((doc (or (widget-get widget :doc) |
| 1672 | (let ((doc-prop (widget-get widget :documentation-property)) |
| 1673 | (value (widget-get widget :value))) |
| 1674 | (cond ((functionp doc-prop) |
| 1675 | (funcall doc-prop value)) |
| 1676 | ((symbolp doc-prop) |
| 1677 | (documentation-property value doc-prop))))))) |
| 1678 | (when (and (stringp doc) (> (length doc) 0)) |
| 1679 | ;; Remove any redundant `*' in the beginning. |
| 1680 | (when (eq (aref doc 0) ?*) |
| 1681 | (setq doc (substring doc 1))) |
| 1682 | ;; Remove trailing newlines. |
| 1683 | (when (string-match "\n+\\'" doc) |
| 1684 | (setq doc (substring doc 0 (match-beginning 0)))) |
| 1685 | doc))) |
| 1686 | |
| 1687 | ;;; The `item' Widget. |
| 1688 | |
| 1689 | (define-widget 'item 'default |
| 1690 | "Constant items for inclusion in other widgets." |
| 1691 | :convert-widget 'widget-value-convert-widget |
| 1692 | :value-create 'widget-item-value-create |
| 1693 | :value-delete 'ignore |
| 1694 | :value-get 'widget-value-value-get |
| 1695 | :match 'widget-item-match |
| 1696 | :match-inline 'widget-item-match-inline |
| 1697 | :action 'widget-item-action |
| 1698 | :format "%t\n") |
| 1699 | |
| 1700 | (defun widget-item-value-create (widget) |
| 1701 | "Insert the printed representation of the value." |
| 1702 | (princ (widget-get widget :value) (current-buffer))) |
| 1703 | |
| 1704 | (defun widget-item-match (widget value) |
| 1705 | ;; Match if the value is the same. |
| 1706 | (equal (widget-get widget :value) value)) |
| 1707 | |
| 1708 | (defun widget-item-match-inline (widget values) |
| 1709 | ;; Match if the value is the same. |
| 1710 | (let ((value (widget-get widget :value))) |
| 1711 | (and (listp value) |
| 1712 | (<= (length value) (length values)) |
| 1713 | (let ((head (widget-sublist values 0 (length value)))) |
| 1714 | (and (equal head value) |
| 1715 | (cons head (widget-sublist values (length value)))))))) |
| 1716 | |
| 1717 | (defun widget-sublist (list start &optional end) |
| 1718 | "Return the sublist of LIST from START to END. |
| 1719 | If END is omitted, it defaults to the length of LIST." |
| 1720 | (if (> start 0) (setq list (nthcdr start list))) |
| 1721 | (if end |
| 1722 | (unless (<= end start) |
| 1723 | (setq list (copy-sequence list)) |
| 1724 | (setcdr (nthcdr (- end start 1) list) nil) |
| 1725 | list) |
| 1726 | (copy-sequence list))) |
| 1727 | |
| 1728 | (defun widget-item-action (widget &optional event) |
| 1729 | ;; Just notify itself. |
| 1730 | (widget-apply widget :notify widget event)) |
| 1731 | |
| 1732 | ;;; The `push-button' Widget. |
| 1733 | |
| 1734 | ;; (defcustom widget-push-button-gui t |
| 1735 | ;; "If non-nil, use GUI push buttons when available." |
| 1736 | ;; :group 'widgets |
| 1737 | ;; :type 'boolean) |
| 1738 | |
| 1739 | ;; Cache already created GUI objects. |
| 1740 | ;; (defvar widget-push-button-cache nil) |
| 1741 | |
| 1742 | (defcustom widget-push-button-prefix "[" |
| 1743 | "String used as prefix for buttons." |
| 1744 | :type 'string |
| 1745 | :group 'widget-button) |
| 1746 | |
| 1747 | (defcustom widget-push-button-suffix "]" |
| 1748 | "String used as suffix for buttons." |
| 1749 | :type 'string |
| 1750 | :group 'widget-button) |
| 1751 | |
| 1752 | (define-widget 'push-button 'item |
| 1753 | "A pushable button." |
| 1754 | :button-prefix "" |
| 1755 | :button-suffix "" |
| 1756 | :value-create 'widget-push-button-value-create |
| 1757 | :format "%[%v%]") |
| 1758 | |
| 1759 | (defun widget-push-button-value-create (widget) |
| 1760 | "Insert text representing the `on' and `off' states." |
| 1761 | (let* ((tag (or (widget-get widget :tag) |
| 1762 | (widget-get widget :value))) |
| 1763 | (tag-glyph (widget-get widget :tag-glyph)) |
| 1764 | (text (concat widget-push-button-prefix |
| 1765 | tag widget-push-button-suffix))) |
| 1766 | (if tag-glyph |
| 1767 | (widget-image-insert widget text tag-glyph) |
| 1768 | (insert text)))) |
| 1769 | |
| 1770 | ;; (defun widget-gui-action (widget) |
| 1771 | ;; "Apply :action for WIDGET." |
| 1772 | ;; (widget-apply-action widget (this-command-keys))) |
| 1773 | |
| 1774 | ;;; The `link' Widget. |
| 1775 | |
| 1776 | (defcustom widget-link-prefix "[" |
| 1777 | "String used as prefix for links." |
| 1778 | :type 'string |
| 1779 | :group 'widget-button) |
| 1780 | |
| 1781 | (defcustom widget-link-suffix "]" |
| 1782 | "String used as suffix for links." |
| 1783 | :type 'string |
| 1784 | :group 'widget-button) |
| 1785 | |
| 1786 | (define-widget 'link 'item |
| 1787 | "An embedded link." |
| 1788 | :button-prefix 'widget-link-prefix |
| 1789 | :button-suffix 'widget-link-suffix |
| 1790 | :follow-link 'mouse-face |
| 1791 | :help-echo "Follow the link." |
| 1792 | :format "%[%t%]") |
| 1793 | |
| 1794 | ;;; The `info-link' Widget. |
| 1795 | |
| 1796 | (define-widget 'info-link 'link |
| 1797 | "A link to an info file." |
| 1798 | :action 'widget-info-link-action) |
| 1799 | |
| 1800 | (defun widget-info-link-action (widget &optional event) |
| 1801 | "Open the info node specified by WIDGET." |
| 1802 | (info (widget-value widget))) |
| 1803 | |
| 1804 | ;;; The `url-link' Widget. |
| 1805 | |
| 1806 | (define-widget 'url-link 'link |
| 1807 | "A link to an www page." |
| 1808 | :action 'widget-url-link-action) |
| 1809 | |
| 1810 | (defun widget-url-link-action (widget &optional event) |
| 1811 | "Open the URL specified by WIDGET." |
| 1812 | (browse-url (widget-value widget))) |
| 1813 | |
| 1814 | ;;; The `function-link' Widget. |
| 1815 | |
| 1816 | (define-widget 'function-link 'link |
| 1817 | "A link to an Emacs function." |
| 1818 | :action 'widget-function-link-action) |
| 1819 | |
| 1820 | (defun widget-function-link-action (widget &optional event) |
| 1821 | "Show the function specified by WIDGET." |
| 1822 | (describe-function (widget-value widget))) |
| 1823 | |
| 1824 | ;;; The `variable-link' Widget. |
| 1825 | |
| 1826 | (define-widget 'variable-link 'link |
| 1827 | "A link to an Emacs variable." |
| 1828 | :action 'widget-variable-link-action) |
| 1829 | |
| 1830 | (defun widget-variable-link-action (widget &optional event) |
| 1831 | "Show the variable specified by WIDGET." |
| 1832 | (describe-variable (widget-value widget))) |
| 1833 | |
| 1834 | ;;; The `file-link' Widget. |
| 1835 | |
| 1836 | (define-widget 'file-link 'link |
| 1837 | "A link to a file." |
| 1838 | :action 'widget-file-link-action) |
| 1839 | |
| 1840 | (defun widget-file-link-action (widget &optional event) |
| 1841 | "Find the file specified by WIDGET." |
| 1842 | (find-file (widget-value widget))) |
| 1843 | |
| 1844 | ;;; The `emacs-library-link' Widget. |
| 1845 | |
| 1846 | (define-widget 'emacs-library-link 'link |
| 1847 | "A link to an Emacs Lisp library file." |
| 1848 | :action 'widget-emacs-library-link-action) |
| 1849 | |
| 1850 | (defun widget-emacs-library-link-action (widget &optional event) |
| 1851 | "Find the Emacs library file specified by WIDGET." |
| 1852 | (find-file (locate-library (widget-value widget)))) |
| 1853 | |
| 1854 | ;;; The `emacs-commentary-link' Widget. |
| 1855 | |
| 1856 | (define-widget 'emacs-commentary-link 'link |
| 1857 | "A link to Commentary in an Emacs Lisp library file." |
| 1858 | :action 'widget-emacs-commentary-link-action) |
| 1859 | |
| 1860 | (defun widget-emacs-commentary-link-action (widget &optional event) |
| 1861 | "Find the Commentary section of the Emacs file specified by WIDGET." |
| 1862 | (finder-commentary (widget-value widget))) |
| 1863 | |
| 1864 | ;;; The `editable-field' Widget. |
| 1865 | |
| 1866 | (define-widget 'editable-field 'default |
| 1867 | "An editable text field. |
| 1868 | Note: In an `editable-field' widget, the `%v' escape must be preceded |
| 1869 | by some other text in the `:format' string (if specified)." |
| 1870 | :convert-widget 'widget-value-convert-widget |
| 1871 | :keymap widget-field-keymap |
| 1872 | :format "%v" |
| 1873 | :help-echo "M-TAB: complete field; RET: enter value" |
| 1874 | :value "" |
| 1875 | :prompt-internal 'widget-field-prompt-internal |
| 1876 | :prompt-history 'widget-field-history |
| 1877 | :prompt-value 'widget-field-prompt-value |
| 1878 | :action 'widget-field-action |
| 1879 | :validate 'widget-field-validate |
| 1880 | :valid-regexp "" |
| 1881 | :error "Field's value doesn't match allowed forms" |
| 1882 | :value-create 'widget-field-value-create |
| 1883 | :value-set 'widget-field-value-set |
| 1884 | :value-delete 'widget-field-value-delete |
| 1885 | :value-get 'widget-field-value-get |
| 1886 | :match 'widget-field-match) |
| 1887 | |
| 1888 | (defvar widget-field-history nil |
| 1889 | "History of field minibuffer edits.") |
| 1890 | |
| 1891 | (defun widget-field-prompt-internal (widget prompt initial history) |
| 1892 | "Read string for WIDGET prompting with PROMPT. |
| 1893 | INITIAL is the initial input and HISTORY is a symbol containing |
| 1894 | the earlier input." |
| 1895 | (read-string prompt initial history)) |
| 1896 | |
| 1897 | (defun widget-field-prompt-value (widget prompt value unbound) |
| 1898 | "Prompt for a string." |
| 1899 | (widget-apply widget |
| 1900 | :value-to-external |
| 1901 | (widget-apply widget |
| 1902 | :prompt-internal prompt |
| 1903 | (unless unbound |
| 1904 | (cons (widget-apply widget |
| 1905 | :value-to-internal value) |
| 1906 | 0)) |
| 1907 | (widget-get widget :prompt-history)))) |
| 1908 | |
| 1909 | (defvar widget-edit-functions nil) |
| 1910 | |
| 1911 | (defun widget-field-action (widget &optional event) |
| 1912 | "Move to next field." |
| 1913 | (widget-forward 1) |
| 1914 | (run-hook-with-args 'widget-edit-functions widget)) |
| 1915 | |
| 1916 | (defun widget-field-validate (widget) |
| 1917 | "Valid if the content matches `:valid-regexp'." |
| 1918 | (unless (string-match (widget-get widget :valid-regexp) |
| 1919 | (widget-apply widget :value-get)) |
| 1920 | widget)) |
| 1921 | |
| 1922 | (defun widget-field-value-set (widget value) |
| 1923 | "Set an editable text field WIDGET to VALUE" |
| 1924 | (let ((from (widget-field-start widget)) |
| 1925 | (to (widget-field-text-end widget)) |
| 1926 | (buffer (widget-field-buffer widget)) |
| 1927 | (size (widget-get widget :size))) |
| 1928 | (when (and from to (buffer-live-p buffer)) |
| 1929 | (with-current-buffer buffer |
| 1930 | (goto-char from) |
| 1931 | (delete-char (- to from)) |
| 1932 | (insert value))))) |
| 1933 | |
| 1934 | (defun widget-field-value-create (widget) |
| 1935 | "Create an editable text field." |
| 1936 | (let ((size (widget-get widget :size)) |
| 1937 | (value (widget-get widget :value)) |
| 1938 | (from (point)) |
| 1939 | ;; This is changed to a real overlay in `widget-setup'. We |
| 1940 | ;; need the end points to behave differently until |
| 1941 | ;; `widget-setup' is called. |
| 1942 | (overlay (cons (make-marker) (make-marker)))) |
| 1943 | (widget-put widget :field-overlay overlay) |
| 1944 | (insert value) |
| 1945 | (and size |
| 1946 | (< (length value) size) |
| 1947 | (insert-char ?\s (- size (length value)))) |
| 1948 | (unless (memq widget widget-field-list) |
| 1949 | (setq widget-field-new (cons widget widget-field-new))) |
| 1950 | (move-marker (cdr overlay) (point)) |
| 1951 | (set-marker-insertion-type (cdr overlay) nil) |
| 1952 | (when (null size) |
| 1953 | (insert ?\n)) |
| 1954 | (move-marker (car overlay) from) |
| 1955 | (set-marker-insertion-type (car overlay) t))) |
| 1956 | |
| 1957 | (defun widget-field-value-delete (widget) |
| 1958 | "Remove the widget from the list of active editing fields." |
| 1959 | (setq widget-field-list (delq widget widget-field-list)) |
| 1960 | (setq widget-field-new (delq widget widget-field-new)) |
| 1961 | ;; These are nil if the :format string doesn't contain `%v'. |
| 1962 | (let ((overlay (widget-get widget :field-overlay))) |
| 1963 | (when (overlayp overlay) |
| 1964 | (delete-overlay overlay)))) |
| 1965 | |
| 1966 | (defun widget-field-value-get (widget) |
| 1967 | "Return current text in editing field." |
| 1968 | (let ((from (widget-field-start widget)) |
| 1969 | (to (widget-field-text-end widget)) |
| 1970 | (buffer (widget-field-buffer widget)) |
| 1971 | (secret (widget-get widget :secret)) |
| 1972 | (old (current-buffer))) |
| 1973 | (if (and from to) |
| 1974 | (progn |
| 1975 | (set-buffer buffer) |
| 1976 | (let ((result (buffer-substring-no-properties from to))) |
| 1977 | (when secret |
| 1978 | (let ((index 0)) |
| 1979 | (while (< (+ from index) to) |
| 1980 | (aset result index |
| 1981 | (get-char-property (+ from index) 'secret)) |
| 1982 | (setq index (1+ index))))) |
| 1983 | (set-buffer old) |
| 1984 | result)) |
| 1985 | (widget-get widget :value)))) |
| 1986 | |
| 1987 | (defun widget-field-match (widget value) |
| 1988 | ;; Match any string. |
| 1989 | (stringp value)) |
| 1990 | |
| 1991 | ;;; The `text' Widget. |
| 1992 | |
| 1993 | (define-widget 'text 'editable-field |
| 1994 | "A multiline text area." |
| 1995 | :keymap widget-text-keymap) |
| 1996 | |
| 1997 | ;;; The `menu-choice' Widget. |
| 1998 | |
| 1999 | (define-widget 'menu-choice 'default |
| 2000 | "A menu of options." |
| 2001 | :convert-widget 'widget-types-convert-widget |
| 2002 | :copy 'widget-types-copy |
| 2003 | :format "%[%t%]: %v" |
| 2004 | :case-fold t |
| 2005 | :tag "choice" |
| 2006 | :void '(item :format "invalid (%t)\n") |
| 2007 | :value-create 'widget-choice-value-create |
| 2008 | :value-get 'widget-child-value-get |
| 2009 | :value-inline 'widget-child-value-inline |
| 2010 | :default-get 'widget-choice-default-get |
| 2011 | :mouse-down-action 'widget-choice-mouse-down-action |
| 2012 | :action 'widget-choice-action |
| 2013 | :error "Make a choice" |
| 2014 | :validate 'widget-choice-validate |
| 2015 | :match 'widget-choice-match |
| 2016 | :match-inline 'widget-choice-match-inline) |
| 2017 | |
| 2018 | (defun widget-choice-value-create (widget) |
| 2019 | "Insert the first choice that matches the value." |
| 2020 | (let ((value (widget-get widget :value)) |
| 2021 | (args (widget-get widget :args)) |
| 2022 | (explicit (widget-get widget :explicit-choice)) |
| 2023 | current) |
| 2024 | (if explicit |
| 2025 | (progn |
| 2026 | ;; If the user specified the choice for this value, |
| 2027 | ;; respect that choice. |
| 2028 | (widget-put widget :children (list (widget-create-child-value |
| 2029 | widget explicit value))) |
| 2030 | (widget-put widget :choice explicit) |
| 2031 | (widget-put widget :explicit-choice nil)) |
| 2032 | (while args |
| 2033 | (setq current (car args) |
| 2034 | args (cdr args)) |
| 2035 | (when (widget-apply current :match value) |
| 2036 | (widget-put widget :children (list (widget-create-child-value |
| 2037 | widget current value))) |
| 2038 | (widget-put widget :choice current) |
| 2039 | (setq args nil |
| 2040 | current nil))) |
| 2041 | (when current |
| 2042 | (let ((void (widget-get widget :void))) |
| 2043 | (widget-put widget :children (list (widget-create-child-and-convert |
| 2044 | widget void :value value))) |
| 2045 | (widget-put widget :choice void)))))) |
| 2046 | |
| 2047 | (defun widget-choice-default-get (widget) |
| 2048 | ;; Get default for the first choice. |
| 2049 | (widget-default-get (car (widget-get widget :args)))) |
| 2050 | |
| 2051 | (defcustom widget-choice-toggle nil |
| 2052 | "If non-nil, a binary choice will just toggle between the values. |
| 2053 | Otherwise, the user will explicitly have to choose between the values |
| 2054 | when he invoked the menu." |
| 2055 | :type 'boolean |
| 2056 | :group 'widgets) |
| 2057 | |
| 2058 | (defun widget-choice-mouse-down-action (widget &optional event) |
| 2059 | ;; Return non-nil if we need a menu. |
| 2060 | (let ((args (widget-get widget :args)) |
| 2061 | (old (widget-get widget :choice))) |
| 2062 | (cond ((not (display-popup-menus-p)) |
| 2063 | ;; No place to pop up a menu. |
| 2064 | nil) |
| 2065 | ((< (length args) 2) |
| 2066 | ;; Empty or singleton list, just return the value. |
| 2067 | nil) |
| 2068 | ((> (length args) widget-menu-max-size) |
| 2069 | ;; Too long, prompt. |
| 2070 | nil) |
| 2071 | ((> (length args) 2) |
| 2072 | ;; Reasonable sized list, use menu. |
| 2073 | t) |
| 2074 | ((and widget-choice-toggle (memq old args)) |
| 2075 | ;; We toggle. |
| 2076 | nil) |
| 2077 | (t |
| 2078 | ;; Ask which of the two. |
| 2079 | t)))) |
| 2080 | |
| 2081 | (defun widget-choice-action (widget &optional event) |
| 2082 | ;; Make a choice. |
| 2083 | (let ((args (widget-get widget :args)) |
| 2084 | (old (widget-get widget :choice)) |
| 2085 | (tag (widget-apply widget :menu-tag-get)) |
| 2086 | (completion-ignore-case (widget-get widget :case-fold)) |
| 2087 | this-explicit |
| 2088 | current choices) |
| 2089 | ;; Remember old value. |
| 2090 | (if (and old (not (widget-apply widget :validate))) |
| 2091 | (let* ((external (widget-value widget)) |
| 2092 | (internal (widget-apply old :value-to-internal external))) |
| 2093 | (widget-put old :value internal))) |
| 2094 | ;; Find new choice. |
| 2095 | (setq current |
| 2096 | (cond ((= (length args) 0) |
| 2097 | nil) |
| 2098 | ((= (length args) 1) |
| 2099 | (nth 0 args)) |
| 2100 | ((and widget-choice-toggle |
| 2101 | (= (length args) 2) |
| 2102 | (memq old args)) |
| 2103 | (if (eq old (nth 0 args)) |
| 2104 | (nth 1 args) |
| 2105 | (nth 0 args))) |
| 2106 | (t |
| 2107 | (while args |
| 2108 | (setq current (car args) |
| 2109 | args (cdr args)) |
| 2110 | (setq choices |
| 2111 | (cons (cons (widget-apply current :menu-tag-get) |
| 2112 | current) |
| 2113 | choices))) |
| 2114 | (setq this-explicit t) |
| 2115 | (widget-choose tag (reverse choices) event)))) |
| 2116 | (when current |
| 2117 | ;; If this was an explicit user choice, record the choice, |
| 2118 | ;; so that widget-choice-value-create will respect it. |
| 2119 | (when this-explicit |
| 2120 | (widget-put widget :explicit-choice current)) |
| 2121 | (widget-value-set widget (widget-default-get current)) |
| 2122 | (widget-setup) |
| 2123 | (widget-apply widget :notify widget event))) |
| 2124 | (run-hook-with-args 'widget-edit-functions widget)) |
| 2125 | |
| 2126 | (defun widget-choice-validate (widget) |
| 2127 | ;; Valid if we have made a valid choice. |
| 2128 | (if (eq (widget-get widget :void) (widget-get widget :choice)) |
| 2129 | widget |
| 2130 | (widget-apply (car (widget-get widget :children)) :validate))) |
| 2131 | |
| 2132 | (defun widget-choice-match (widget value) |
| 2133 | ;; Matches if one of the choices matches. |
| 2134 | (let ((args (widget-get widget :args)) |
| 2135 | current found) |
| 2136 | (while (and args (not found)) |
| 2137 | (setq current (car args) |
| 2138 | args (cdr args) |
| 2139 | found (widget-apply current :match value))) |
| 2140 | found)) |
| 2141 | |
| 2142 | (defun widget-choice-match-inline (widget values) |
| 2143 | ;; Matches if one of the choices matches. |
| 2144 | (let ((args (widget-get widget :args)) |
| 2145 | current found) |
| 2146 | (while (and args (null found)) |
| 2147 | (setq current (car args) |
| 2148 | args (cdr args) |
| 2149 | found (widget-match-inline current values))) |
| 2150 | found)) |
| 2151 | |
| 2152 | ;;; The `toggle' Widget. |
| 2153 | |
| 2154 | (define-widget 'toggle 'item |
| 2155 | "Toggle between two states." |
| 2156 | :format "%[%v%]\n" |
| 2157 | :value-create 'widget-toggle-value-create |
| 2158 | :action 'widget-toggle-action |
| 2159 | :match (lambda (widget value) t) |
| 2160 | :on "on" |
| 2161 | :off "off") |
| 2162 | |
| 2163 | (defun widget-toggle-value-create (widget) |
| 2164 | "Insert text representing the `on' and `off' states." |
| 2165 | (if (widget-value widget) |
| 2166 | (let ((image (widget-get widget :on-glyph))) |
| 2167 | (and (display-graphic-p) |
| 2168 | (listp image) |
| 2169 | (not (eq (car image) 'image)) |
| 2170 | (widget-put widget :on-glyph (setq image (eval image)))) |
| 2171 | (widget-image-insert widget |
| 2172 | (widget-get widget :on) |
| 2173 | image)) |
| 2174 | (let ((image (widget-get widget :off-glyph))) |
| 2175 | (and (display-graphic-p) |
| 2176 | (listp image) |
| 2177 | (not (eq (car image) 'image)) |
| 2178 | (widget-put widget :off-glyph (setq image (eval image)))) |
| 2179 | (widget-image-insert widget (widget-get widget :off) image)))) |
| 2180 | |
| 2181 | (defun widget-toggle-action (widget &optional event) |
| 2182 | ;; Toggle value. |
| 2183 | (widget-value-set widget (not (widget-value widget))) |
| 2184 | (widget-apply widget :notify widget event) |
| 2185 | (run-hook-with-args 'widget-edit-functions widget)) |
| 2186 | |
| 2187 | ;;; The `checkbox' Widget. |
| 2188 | |
| 2189 | (define-widget 'checkbox 'toggle |
| 2190 | "A checkbox toggle." |
| 2191 | :button-suffix "" |
| 2192 | :button-prefix "" |
| 2193 | :format "%[%v%]" |
| 2194 | :on "[X]" |
| 2195 | ;; We could probably do the same job as the images using single |
| 2196 | ;; space characters in a boxed face with a stretch specification to |
| 2197 | ;; make them square. |
| 2198 | :on-glyph "checked" |
| 2199 | :off "[ ]" |
| 2200 | :off-glyph "unchecked" |
| 2201 | :help-echo "Toggle this item." |
| 2202 | :action 'widget-checkbox-action) |
| 2203 | |
| 2204 | (defun widget-checkbox-action (widget &optional event) |
| 2205 | "Toggle checkbox, notify parent, and set active state of sibling." |
| 2206 | (widget-toggle-action widget event) |
| 2207 | (let ((sibling (widget-get-sibling widget))) |
| 2208 | (when sibling |
| 2209 | (if (widget-value widget) |
| 2210 | (widget-apply sibling :activate) |
| 2211 | (widget-apply sibling :deactivate)) |
| 2212 | (widget-clear-undo)))) |
| 2213 | |
| 2214 | ;;; The `checklist' Widget. |
| 2215 | |
| 2216 | (define-widget 'checklist 'default |
| 2217 | "A multiple choice widget." |
| 2218 | :convert-widget 'widget-types-convert-widget |
| 2219 | :copy 'widget-types-copy |
| 2220 | :format "%v" |
| 2221 | :offset 4 |
| 2222 | :entry-format "%b %v" |
| 2223 | :greedy nil |
| 2224 | :value-create 'widget-checklist-value-create |
| 2225 | :value-get 'widget-checklist-value-get |
| 2226 | :validate 'widget-checklist-validate |
| 2227 | :match 'widget-checklist-match |
| 2228 | :match-inline 'widget-checklist-match-inline) |
| 2229 | |
| 2230 | (defun widget-checklist-value-create (widget) |
| 2231 | ;; Insert all values |
| 2232 | (let ((alist (widget-checklist-match-find widget)) |
| 2233 | (args (widget-get widget :args))) |
| 2234 | (dolist (item args) |
| 2235 | (widget-checklist-add-item widget item (assq item alist))) |
| 2236 | (widget-put widget :children (nreverse (widget-get widget :children))))) |
| 2237 | |
| 2238 | (defun widget-checklist-add-item (widget type chosen) |
| 2239 | "Create checklist item in WIDGET of type TYPE. |
| 2240 | If the item is checked, CHOSEN is a cons whose cdr is the value." |
| 2241 | (and (eq (preceding-char) ?\n) |
| 2242 | (widget-get widget :indent) |
| 2243 | (insert-char ?\s (widget-get widget :indent))) |
| 2244 | (widget-specify-insert |
| 2245 | (let* ((children (widget-get widget :children)) |
| 2246 | (buttons (widget-get widget :buttons)) |
| 2247 | (button-args (or (widget-get type :sibling-args) |
| 2248 | (widget-get widget :button-args))) |
| 2249 | (from (point)) |
| 2250 | child button) |
| 2251 | (insert (widget-get widget :entry-format)) |
| 2252 | (goto-char from) |
| 2253 | ;; Parse % escapes in format. |
| 2254 | (while (re-search-forward "%\\([bv%]\\)" nil t) |
| 2255 | (let ((escape (char-after (match-beginning 1)))) |
| 2256 | (delete-char -2) |
| 2257 | (cond ((eq escape ?%) |
| 2258 | (insert ?%)) |
| 2259 | ((eq escape ?b) |
| 2260 | (setq button (apply 'widget-create-child-and-convert |
| 2261 | widget 'checkbox |
| 2262 | :value (not (null chosen)) |
| 2263 | button-args))) |
| 2264 | ((eq escape ?v) |
| 2265 | (setq child |
| 2266 | (cond ((not chosen) |
| 2267 | (let ((child (widget-create-child widget type))) |
| 2268 | (widget-apply child :deactivate) |
| 2269 | child)) |
| 2270 | ((widget-get type :inline) |
| 2271 | (widget-create-child-value |
| 2272 | widget type (cdr chosen))) |
| 2273 | (t |
| 2274 | (widget-create-child-value |
| 2275 | widget type (car (cdr chosen))))))) |
| 2276 | (t |
| 2277 | (error "Unknown escape `%c'" escape))))) |
| 2278 | ;; Update properties. |
| 2279 | (and button child (widget-put child :button button)) |
| 2280 | (and button (widget-put widget :buttons (cons button buttons))) |
| 2281 | (and child (widget-put widget :children (cons child children)))))) |
| 2282 | |
| 2283 | (defun widget-checklist-match (widget values) |
| 2284 | ;; All values must match a type in the checklist. |
| 2285 | (and (listp values) |
| 2286 | (null (cdr (widget-checklist-match-inline widget values))))) |
| 2287 | |
| 2288 | (defun widget-checklist-match-inline (widget values) |
| 2289 | ;; Find the values which match a type in the checklist. |
| 2290 | (let ((greedy (widget-get widget :greedy)) |
| 2291 | (args (copy-sequence (widget-get widget :args))) |
| 2292 | found rest) |
| 2293 | (while values |
| 2294 | (let ((answer (widget-checklist-match-up args values))) |
| 2295 | (cond (answer |
| 2296 | (let ((vals (widget-match-inline answer values))) |
| 2297 | (setq found (append found (car vals)) |
| 2298 | values (cdr vals) |
| 2299 | args (delq answer args)))) |
| 2300 | (greedy |
| 2301 | (setq rest (append rest (list (car values))) |
| 2302 | values (cdr values))) |
| 2303 | (t |
| 2304 | (setq rest (append rest values) |
| 2305 | values nil))))) |
| 2306 | (cons found rest))) |
| 2307 | |
| 2308 | (defun widget-checklist-match-find (widget &optional vals) |
| 2309 | "Find the vals which match a type in the checklist. |
| 2310 | Return an alist of (TYPE MATCH)." |
| 2311 | (or vals (setq vals (widget-get widget :value))) |
| 2312 | (let ((greedy (widget-get widget :greedy)) |
| 2313 | (args (copy-sequence (widget-get widget :args))) |
| 2314 | found) |
| 2315 | (while vals |
| 2316 | (let ((answer (widget-checklist-match-up args vals))) |
| 2317 | (cond (answer |
| 2318 | (let ((match (widget-match-inline answer vals))) |
| 2319 | (setq found (cons (cons answer (car match)) found) |
| 2320 | vals (cdr match) |
| 2321 | args (delq answer args)))) |
| 2322 | (greedy |
| 2323 | (setq vals (cdr vals))) |
| 2324 | (t |
| 2325 | (setq vals nil))))) |
| 2326 | found)) |
| 2327 | |
| 2328 | (defun widget-checklist-match-up (args vals) |
| 2329 | "Return the first type from ARGS that matches VALS." |
| 2330 | (let (current found) |
| 2331 | (while (and args (null found)) |
| 2332 | (setq current (car args) |
| 2333 | args (cdr args) |
| 2334 | found (widget-match-inline current vals))) |
| 2335 | (if found |
| 2336 | current))) |
| 2337 | |
| 2338 | (defun widget-checklist-value-get (widget) |
| 2339 | ;; The values of all selected items. |
| 2340 | (let ((children (widget-get widget :children)) |
| 2341 | child result) |
| 2342 | (while children |
| 2343 | (setq child (car children) |
| 2344 | children (cdr children)) |
| 2345 | (if (widget-value (widget-get child :button)) |
| 2346 | (setq result (append result (widget-apply child :value-inline))))) |
| 2347 | result)) |
| 2348 | |
| 2349 | (defun widget-checklist-validate (widget) |
| 2350 | ;; Ticked chilren must be valid. |
| 2351 | (let ((children (widget-get widget :children)) |
| 2352 | child button found) |
| 2353 | (while (and children (not found)) |
| 2354 | (setq child (car children) |
| 2355 | children (cdr children) |
| 2356 | button (widget-get child :button) |
| 2357 | found (and (widget-value button) |
| 2358 | (widget-apply child :validate)))) |
| 2359 | found)) |
| 2360 | |
| 2361 | ;;; The `option' Widget |
| 2362 | |
| 2363 | (define-widget 'option 'checklist |
| 2364 | "An widget with an optional item." |
| 2365 | :inline t) |
| 2366 | |
| 2367 | ;;; The `choice-item' Widget. |
| 2368 | |
| 2369 | (define-widget 'choice-item 'item |
| 2370 | "Button items that delegate action events to their parents." |
| 2371 | :action 'widget-parent-action |
| 2372 | :format "%[%t%] \n") |
| 2373 | |
| 2374 | ;;; The `radio-button' Widget. |
| 2375 | |
| 2376 | (define-widget 'radio-button 'toggle |
| 2377 | "A radio button for use in the `radio' widget." |
| 2378 | :notify 'widget-radio-button-notify |
| 2379 | :format "%[%v%]" |
| 2380 | :button-suffix "" |
| 2381 | :button-prefix "" |
| 2382 | :on "(*)" |
| 2383 | :on-glyph "radio1" |
| 2384 | :off "( )" |
| 2385 | :off-glyph "radio0") |
| 2386 | |
| 2387 | (defun widget-radio-button-notify (widget child &optional event) |
| 2388 | ;; Tell daddy. |
| 2389 | (widget-apply (widget-get widget :parent) :action widget event)) |
| 2390 | |
| 2391 | ;;; The `radio-button-choice' Widget. |
| 2392 | |
| 2393 | (define-widget 'radio-button-choice 'default |
| 2394 | "Select one of multiple options." |
| 2395 | :convert-widget 'widget-types-convert-widget |
| 2396 | :copy 'widget-types-copy |
| 2397 | :offset 4 |
| 2398 | :format "%v" |
| 2399 | :entry-format "%b %v" |
| 2400 | :value-create 'widget-radio-value-create |
| 2401 | :value-get 'widget-radio-value-get |
| 2402 | :value-inline 'widget-radio-value-inline |
| 2403 | :value-set 'widget-radio-value-set |
| 2404 | :error "You must push one of the buttons" |
| 2405 | :validate 'widget-radio-validate |
| 2406 | :match 'widget-choice-match |
| 2407 | :match-inline 'widget-choice-match-inline |
| 2408 | :action 'widget-radio-action) |
| 2409 | |
| 2410 | (defun widget-radio-value-create (widget) |
| 2411 | ;; Insert all values |
| 2412 | (let ((args (widget-get widget :args)) |
| 2413 | arg) |
| 2414 | (while args |
| 2415 | (setq arg (car args) |
| 2416 | args (cdr args)) |
| 2417 | (widget-radio-add-item widget arg)))) |
| 2418 | |
| 2419 | (defun widget-radio-add-item (widget type) |
| 2420 | "Add to radio widget WIDGET a new radio button item of type TYPE." |
| 2421 | ;; (setq type (widget-convert type)) |
| 2422 | (and (eq (preceding-char) ?\n) |
| 2423 | (widget-get widget :indent) |
| 2424 | (insert-char ?\s (widget-get widget :indent))) |
| 2425 | (widget-specify-insert |
| 2426 | (let* ((value (widget-get widget :value)) |
| 2427 | (children (widget-get widget :children)) |
| 2428 | (buttons (widget-get widget :buttons)) |
| 2429 | (button-args (or (widget-get type :sibling-args) |
| 2430 | (widget-get widget :button-args))) |
| 2431 | (from (point)) |
| 2432 | (chosen (and (null (widget-get widget :choice)) |
| 2433 | (widget-apply type :match value))) |
| 2434 | child button) |
| 2435 | (insert (widget-get widget :entry-format)) |
| 2436 | (goto-char from) |
| 2437 | ;; Parse % escapes in format. |
| 2438 | (while (re-search-forward "%\\([bv%]\\)" nil t) |
| 2439 | (let ((escape (char-after (match-beginning 1)))) |
| 2440 | (delete-char -2) |
| 2441 | (cond ((eq escape ?%) |
| 2442 | (insert ?%)) |
| 2443 | ((eq escape ?b) |
| 2444 | (setq button (apply 'widget-create-child-and-convert |
| 2445 | widget 'radio-button |
| 2446 | :value (not (null chosen)) |
| 2447 | button-args))) |
| 2448 | ((eq escape ?v) |
| 2449 | (setq child (if chosen |
| 2450 | (widget-create-child-value |
| 2451 | widget type value) |
| 2452 | (widget-create-child widget type))) |
| 2453 | (unless chosen |
| 2454 | (widget-apply child :deactivate))) |
| 2455 | (t |
| 2456 | (error "Unknown escape `%c'" escape))))) |
| 2457 | ;; Update properties. |
| 2458 | (when chosen |
| 2459 | (widget-put widget :choice type)) |
| 2460 | (when button |
| 2461 | (widget-put child :button button) |
| 2462 | (widget-put widget :buttons (nconc buttons (list button)))) |
| 2463 | (when child |
| 2464 | (widget-put widget :children (nconc children (list child)))) |
| 2465 | child))) |
| 2466 | |
| 2467 | (defun widget-radio-value-get (widget) |
| 2468 | ;; Get value of the child widget. |
| 2469 | (let ((chosen (widget-radio-chosen widget))) |
| 2470 | (and chosen (widget-value chosen)))) |
| 2471 | |
| 2472 | (defun widget-radio-chosen (widget) |
| 2473 | "Return the widget representing the chosen radio button." |
| 2474 | (let ((children (widget-get widget :children)) |
| 2475 | current found) |
| 2476 | (while children |
| 2477 | (setq current (car children) |
| 2478 | children (cdr children)) |
| 2479 | (when (widget-apply (widget-get current :button) :value-get) |
| 2480 | (setq found current |
| 2481 | children nil))) |
| 2482 | found)) |
| 2483 | |
| 2484 | (defun widget-radio-value-inline (widget) |
| 2485 | ;; Get value of the child widget. |
| 2486 | (let ((children (widget-get widget :children)) |
| 2487 | current found) |
| 2488 | (while children |
| 2489 | (setq current (car children) |
| 2490 | children (cdr children)) |
| 2491 | (when (widget-apply (widget-get current :button) :value-get) |
| 2492 | (setq found (widget-apply current :value-inline) |
| 2493 | children nil))) |
| 2494 | found)) |
| 2495 | |
| 2496 | (defun widget-radio-value-set (widget value) |
| 2497 | ;; We can't just delete and recreate a radio widget, since children |
| 2498 | ;; can be added after the original creation and won't be recreated |
| 2499 | ;; by `:create'. |
| 2500 | (let ((children (widget-get widget :children)) |
| 2501 | current found) |
| 2502 | (while children |
| 2503 | (setq current (car children) |
| 2504 | children (cdr children)) |
| 2505 | (let* ((button (widget-get current :button)) |
| 2506 | (match (and (not found) |
| 2507 | (widget-apply current :match value)))) |
| 2508 | (widget-value-set button match) |
| 2509 | (if match |
| 2510 | (progn |
| 2511 | (widget-value-set current value) |
| 2512 | (widget-apply current :activate)) |
| 2513 | (widget-apply current :deactivate)) |
| 2514 | (setq found (or found match)))))) |
| 2515 | |
| 2516 | (defun widget-radio-validate (widget) |
| 2517 | ;; Valid if we have made a valid choice. |
| 2518 | (let ((children (widget-get widget :children)) |
| 2519 | current found button) |
| 2520 | (while (and children (not found)) |
| 2521 | (setq current (car children) |
| 2522 | children (cdr children) |
| 2523 | button (widget-get current :button) |
| 2524 | found (widget-apply button :value-get))) |
| 2525 | (if found |
| 2526 | (widget-apply current :validate) |
| 2527 | widget))) |
| 2528 | |
| 2529 | (defun widget-radio-action (widget child event) |
| 2530 | ;; Check if a radio button was pressed. |
| 2531 | (let ((children (widget-get widget :children)) |
| 2532 | (buttons (widget-get widget :buttons)) |
| 2533 | current) |
| 2534 | (when (memq child buttons) |
| 2535 | (while children |
| 2536 | (setq current (car children) |
| 2537 | children (cdr children)) |
| 2538 | (let* ((button (widget-get current :button))) |
| 2539 | (cond ((eq child button) |
| 2540 | (widget-value-set button t) |
| 2541 | (widget-apply current :activate)) |
| 2542 | ((widget-value button) |
| 2543 | (widget-value-set button nil) |
| 2544 | (widget-apply current :deactivate))))))) |
| 2545 | ;; Pass notification to parent. |
| 2546 | (widget-apply widget :notify child event)) |
| 2547 | |
| 2548 | ;;; The `insert-button' Widget. |
| 2549 | |
| 2550 | (define-widget 'insert-button 'push-button |
| 2551 | "An insert button for the `editable-list' widget." |
| 2552 | :tag "INS" |
| 2553 | :help-echo "Insert a new item into the list at this position." |
| 2554 | :action 'widget-insert-button-action) |
| 2555 | |
| 2556 | (defun widget-insert-button-action (widget &optional event) |
| 2557 | ;; Ask the parent to insert a new item. |
| 2558 | (widget-apply (widget-get widget :parent) |
| 2559 | :insert-before (widget-get widget :widget))) |
| 2560 | |
| 2561 | ;;; The `delete-button' Widget. |
| 2562 | |
| 2563 | (define-widget 'delete-button 'push-button |
| 2564 | "A delete button for the `editable-list' widget." |
| 2565 | :tag "DEL" |
| 2566 | :help-echo "Delete this item from the list." |
| 2567 | :action 'widget-delete-button-action) |
| 2568 | |
| 2569 | (defun widget-delete-button-action (widget &optional event) |
| 2570 | ;; Ask the parent to insert a new item. |
| 2571 | (widget-apply (widget-get widget :parent) |
| 2572 | :delete-at (widget-get widget :widget))) |
| 2573 | |
| 2574 | ;;; The `editable-list' Widget. |
| 2575 | |
| 2576 | ;; (defcustom widget-editable-list-gui nil |
| 2577 | ;; "If non-nil, use GUI push-buttons in editable list when available." |
| 2578 | ;; :type 'boolean |
| 2579 | ;; :group 'widgets) |
| 2580 | |
| 2581 | (define-widget 'editable-list 'default |
| 2582 | "A variable list of widgets of the same type." |
| 2583 | :convert-widget 'widget-types-convert-widget |
| 2584 | :copy 'widget-types-copy |
| 2585 | :offset 12 |
| 2586 | :format "%v%i\n" |
| 2587 | :format-handler 'widget-editable-list-format-handler |
| 2588 | :entry-format "%i %d %v" |
| 2589 | :value-create 'widget-editable-list-value-create |
| 2590 | :value-get 'widget-editable-list-value-get |
| 2591 | :validate 'widget-children-validate |
| 2592 | :match 'widget-editable-list-match |
| 2593 | :match-inline 'widget-editable-list-match-inline |
| 2594 | :insert-before 'widget-editable-list-insert-before |
| 2595 | :delete-at 'widget-editable-list-delete-at) |
| 2596 | |
| 2597 | (defun widget-editable-list-format-handler (widget escape) |
| 2598 | ;; We recognize the insert button. |
| 2599 | ;; (let ((widget-push-button-gui widget-editable-list-gui)) |
| 2600 | (cond ((eq escape ?i) |
| 2601 | (and (widget-get widget :indent) |
| 2602 | (insert-char ?\s (widget-get widget :indent))) |
| 2603 | (apply 'widget-create-child-and-convert |
| 2604 | widget 'insert-button |
| 2605 | (widget-get widget :append-button-args))) |
| 2606 | (t |
| 2607 | (widget-default-format-handler widget escape))) |
| 2608 | ;; ) |
| 2609 | ) |
| 2610 | |
| 2611 | (defun widget-editable-list-value-create (widget) |
| 2612 | ;; Insert all values |
| 2613 | (let* ((value (widget-get widget :value)) |
| 2614 | (type (nth 0 (widget-get widget :args))) |
| 2615 | children) |
| 2616 | (widget-put widget :value-pos (copy-marker (point))) |
| 2617 | (set-marker-insertion-type (widget-get widget :value-pos) t) |
| 2618 | (while value |
| 2619 | (let ((answer (widget-match-inline type value))) |
| 2620 | (if answer |
| 2621 | (setq children (cons (widget-editable-list-entry-create |
| 2622 | widget |
| 2623 | (if (widget-get type :inline) |
| 2624 | (car answer) |
| 2625 | (car (car answer))) |
| 2626 | t) |
| 2627 | children) |
| 2628 | value (cdr answer)) |
| 2629 | (setq value nil)))) |
| 2630 | (widget-put widget :children (nreverse children)))) |
| 2631 | |
| 2632 | (defun widget-editable-list-value-get (widget) |
| 2633 | ;; Get value of the child widget. |
| 2634 | (apply 'append (mapcar (lambda (child) (widget-apply child :value-inline)) |
| 2635 | (widget-get widget :children)))) |
| 2636 | |
| 2637 | (defun widget-editable-list-match (widget value) |
| 2638 | ;; Value must be a list and all the members must match the type. |
| 2639 | (and (listp value) |
| 2640 | (null (cdr (widget-editable-list-match-inline widget value))))) |
| 2641 | |
| 2642 | (defun widget-editable-list-match-inline (widget value) |
| 2643 | (let ((type (nth 0 (widget-get widget :args))) |
| 2644 | (ok t) |
| 2645 | found) |
| 2646 | (while (and value ok) |
| 2647 | (let ((answer (widget-match-inline type value))) |
| 2648 | (if answer |
| 2649 | (setq found (append found (car answer)) |
| 2650 | value (cdr answer)) |
| 2651 | (setq ok nil)))) |
| 2652 | (cons found value))) |
| 2653 | |
| 2654 | (defun widget-editable-list-insert-before (widget before) |
| 2655 | ;; Insert a new child in the list of children. |
| 2656 | (save-excursion |
| 2657 | (let ((children (widget-get widget :children)) |
| 2658 | (inhibit-read-only t) |
| 2659 | before-change-functions |
| 2660 | after-change-functions) |
| 2661 | (cond (before |
| 2662 | (goto-char (widget-get before :entry-from))) |
| 2663 | (t |
| 2664 | (goto-char (widget-get widget :value-pos)))) |
| 2665 | (let ((child (widget-editable-list-entry-create |
| 2666 | widget nil nil))) |
| 2667 | (when (< (widget-get child :entry-from) (widget-get widget :from)) |
| 2668 | (set-marker (widget-get widget :from) |
| 2669 | (widget-get child :entry-from))) |
| 2670 | (if (eq (car children) before) |
| 2671 | (widget-put widget :children (cons child children)) |
| 2672 | (while (not (eq (car (cdr children)) before)) |
| 2673 | (setq children (cdr children))) |
| 2674 | (setcdr children (cons child (cdr children))))))) |
| 2675 | (widget-setup) |
| 2676 | (widget-apply widget :notify widget)) |
| 2677 | |
| 2678 | (defun widget-editable-list-delete-at (widget child) |
| 2679 | ;; Delete child from list of children. |
| 2680 | (save-excursion |
| 2681 | (let ((buttons (copy-sequence (widget-get widget :buttons))) |
| 2682 | button |
| 2683 | (inhibit-read-only t) |
| 2684 | before-change-functions |
| 2685 | after-change-functions) |
| 2686 | (while buttons |
| 2687 | (setq button (car buttons) |
| 2688 | buttons (cdr buttons)) |
| 2689 | (when (eq (widget-get button :widget) child) |
| 2690 | (widget-put widget |
| 2691 | :buttons (delq button (widget-get widget :buttons))) |
| 2692 | (widget-delete button)))) |
| 2693 | (let ((entry-from (widget-get child :entry-from)) |
| 2694 | (entry-to (widget-get child :entry-to)) |
| 2695 | (inhibit-read-only t) |
| 2696 | before-change-functions |
| 2697 | after-change-functions) |
| 2698 | (widget-delete child) |
| 2699 | (delete-region entry-from entry-to) |
| 2700 | (set-marker entry-from nil) |
| 2701 | (set-marker entry-to nil)) |
| 2702 | (widget-put widget :children (delq child (widget-get widget :children)))) |
| 2703 | (widget-setup) |
| 2704 | (widget-apply widget :notify widget)) |
| 2705 | |
| 2706 | (defun widget-editable-list-entry-create (widget value conv) |
| 2707 | ;; Create a new entry to the list. |
| 2708 | (let ((type (nth 0 (widget-get widget :args))) |
| 2709 | ;; (widget-push-button-gui widget-editable-list-gui) |
| 2710 | child delete insert) |
| 2711 | (widget-specify-insert |
| 2712 | (save-excursion |
| 2713 | (and (widget-get widget :indent) |
| 2714 | (insert-char ?\s (widget-get widget :indent))) |
| 2715 | (insert (widget-get widget :entry-format))) |
| 2716 | ;; Parse % escapes in format. |
| 2717 | (while (re-search-forward "%\\(.\\)" nil t) |
| 2718 | (let ((escape (char-after (match-beginning 1)))) |
| 2719 | (delete-char -2) |
| 2720 | (cond ((eq escape ?%) |
| 2721 | (insert ?%)) |
| 2722 | ((eq escape ?i) |
| 2723 | (setq insert (apply 'widget-create-child-and-convert |
| 2724 | widget 'insert-button |
| 2725 | (widget-get widget :insert-button-args)))) |
| 2726 | ((eq escape ?d) |
| 2727 | (setq delete (apply 'widget-create-child-and-convert |
| 2728 | widget 'delete-button |
| 2729 | (widget-get widget :delete-button-args)))) |
| 2730 | ((eq escape ?v) |
| 2731 | (if conv |
| 2732 | (setq child (widget-create-child-value |
| 2733 | widget type value)) |
| 2734 | (setq child (widget-create-child-value |
| 2735 | widget type (widget-default-get type))))) |
| 2736 | (t |
| 2737 | (error "Unknown escape `%c'" escape))))) |
| 2738 | (let ((buttons (widget-get widget :buttons))) |
| 2739 | (if insert (push insert buttons)) |
| 2740 | (if delete (push delete buttons)) |
| 2741 | (widget-put widget :buttons buttons)) |
| 2742 | (let ((entry-from (point-min-marker)) |
| 2743 | (entry-to (point-max-marker))) |
| 2744 | (set-marker-insertion-type entry-from t) |
| 2745 | (set-marker-insertion-type entry-to nil) |
| 2746 | (widget-put child :entry-from entry-from) |
| 2747 | (widget-put child :entry-to entry-to))) |
| 2748 | (if insert (widget-put insert :widget child)) |
| 2749 | (if delete (widget-put delete :widget child)) |
| 2750 | child)) |
| 2751 | |
| 2752 | ;;; The `group' Widget. |
| 2753 | |
| 2754 | (define-widget 'group 'default |
| 2755 | "A widget which groups other widgets inside." |
| 2756 | :convert-widget 'widget-types-convert-widget |
| 2757 | :copy 'widget-types-copy |
| 2758 | :format "%v" |
| 2759 | :value-create 'widget-group-value-create |
| 2760 | :value-get 'widget-editable-list-value-get |
| 2761 | :default-get 'widget-group-default-get |
| 2762 | :validate 'widget-children-validate |
| 2763 | :match 'widget-group-match |
| 2764 | :match-inline 'widget-group-match-inline) |
| 2765 | |
| 2766 | (defun widget-group-value-create (widget) |
| 2767 | ;; Create each component. |
| 2768 | (let ((args (widget-get widget :args)) |
| 2769 | (value (widget-get widget :value)) |
| 2770 | arg answer children) |
| 2771 | (while args |
| 2772 | (setq arg (car args) |
| 2773 | args (cdr args) |
| 2774 | answer (widget-match-inline arg value) |
| 2775 | value (cdr answer)) |
| 2776 | (and (eq (preceding-char) ?\n) |
| 2777 | (widget-get widget :indent) |
| 2778 | (insert-char ?\s (widget-get widget :indent))) |
| 2779 | (push (cond ((null answer) |
| 2780 | (widget-create-child widget arg)) |
| 2781 | ((widget-get arg :inline) |
| 2782 | (widget-create-child-value widget arg (car answer))) |
| 2783 | (t |
| 2784 | (widget-create-child-value widget arg (car (car answer))))) |
| 2785 | children)) |
| 2786 | (widget-put widget :children (nreverse children)))) |
| 2787 | |
| 2788 | (defun widget-group-default-get (widget) |
| 2789 | ;; Get the default of the components. |
| 2790 | (mapcar 'widget-default-get (widget-get widget :args))) |
| 2791 | |
| 2792 | (defun widget-group-match (widget values) |
| 2793 | ;; Match if the components match. |
| 2794 | (and (listp values) |
| 2795 | (let ((match (widget-group-match-inline widget values))) |
| 2796 | (and match (null (cdr match)))))) |
| 2797 | |
| 2798 | (defun widget-group-match-inline (widget vals) |
| 2799 | ;; Match if the components match. |
| 2800 | (let ((args (widget-get widget :args)) |
| 2801 | argument answer found) |
| 2802 | (while args |
| 2803 | (setq argument (car args) |
| 2804 | args (cdr args)) |
| 2805 | (if (setq answer (widget-match-inline argument vals)) |
| 2806 | (setq found (append found (car answer)) |
| 2807 | vals (cdr answer)) |
| 2808 | (setq vals nil |
| 2809 | args nil))) |
| 2810 | (if answer |
| 2811 | (cons found vals)))) |
| 2812 | |
| 2813 | ;;; The `visibility' Widget. |
| 2814 | |
| 2815 | (define-widget 'visibility 'item |
| 2816 | "An indicator and manipulator for hidden items. |
| 2817 | |
| 2818 | The following properties have special meanings for this widget: |
| 2819 | :on-image Image filename or spec to display when the item is visible. |
| 2820 | :on Text shown if the \"on\" image is nil or cannot be displayed. |
| 2821 | :off-image Image filename or spec to display when the item is hidden. |
| 2822 | :off Text shown if the \"off\" image is nil cannot be displayed." |
| 2823 | :format "%[%v%]" |
| 2824 | :button-prefix "" |
| 2825 | :button-suffix "" |
| 2826 | :on-image "down" |
| 2827 | :on "Hide" |
| 2828 | :off-image "right" |
| 2829 | :off "Show" |
| 2830 | :value-create 'widget-visibility-value-create |
| 2831 | :action 'widget-toggle-action |
| 2832 | :match (lambda (widget value) t)) |
| 2833 | |
| 2834 | (defun widget-visibility-value-create (widget) |
| 2835 | ;; Insert text representing the `on' and `off' states. |
| 2836 | (let* ((val (widget-value widget)) |
| 2837 | (text (widget-get widget (if val :on :off))) |
| 2838 | (img (widget-image-find |
| 2839 | (widget-get widget (if val :on-image :off-image))))) |
| 2840 | (widget-image-insert widget |
| 2841 | (if text |
| 2842 | (concat widget-push-button-prefix text |
| 2843 | widget-push-button-suffix) |
| 2844 | "") |
| 2845 | (if img |
| 2846 | (append img '(:ascent center)))))) |
| 2847 | |
| 2848 | ;;; The `documentation-link' Widget. |
| 2849 | ;; |
| 2850 | ;; This is a helper widget for `documentation-string'. |
| 2851 | |
| 2852 | (define-widget 'documentation-link 'link |
| 2853 | "Link type used in documentation strings." |
| 2854 | :tab-order -1 |
| 2855 | :help-echo "Describe this symbol" |
| 2856 | :action 'widget-documentation-link-action) |
| 2857 | |
| 2858 | (defun widget-documentation-link-action (widget &optional event) |
| 2859 | "Display documentation for WIDGET's value. Ignore optional argument EVENT." |
| 2860 | (let* ((string (widget-get widget :value)) |
| 2861 | (symbol (intern string))) |
| 2862 | (if (and (fboundp symbol) (boundp symbol)) |
| 2863 | ;; If there are two doc strings, give the user a way to pick one. |
| 2864 | (apropos (concat "\\`" (regexp-quote string) "\\'")) |
| 2865 | (if (fboundp symbol) |
| 2866 | (describe-function symbol) |
| 2867 | (describe-variable symbol))))) |
| 2868 | |
| 2869 | (defcustom widget-documentation-links t |
| 2870 | "Add hyperlinks to documentation strings when non-nil." |
| 2871 | :type 'boolean |
| 2872 | :group 'widget-documentation) |
| 2873 | |
| 2874 | (defcustom widget-documentation-link-regexp "`\\([^\n`' ]+\\)'" |
| 2875 | "Regexp for matching potential links in documentation strings. |
| 2876 | The first group should be the link itself." |
| 2877 | :type 'regexp |
| 2878 | :group 'widget-documentation) |
| 2879 | |
| 2880 | (defcustom widget-documentation-link-p 'intern-soft |
| 2881 | "Predicate used to test if a string is useful as a link. |
| 2882 | The value should be a function. The function will be called with one |
| 2883 | argument, a string, and should return non-nil if there should be a |
| 2884 | link for that string." |
| 2885 | :type 'function |
| 2886 | :options '(widget-documentation-link-p) |
| 2887 | :group 'widget-documentation) |
| 2888 | |
| 2889 | (defcustom widget-documentation-link-type 'documentation-link |
| 2890 | "Widget type used for links in documentation strings." |
| 2891 | :type 'symbol |
| 2892 | :group 'widget-documentation) |
| 2893 | |
| 2894 | (defun widget-documentation-link-add (widget from to) |
| 2895 | (widget-specify-doc widget from to) |
| 2896 | (when widget-documentation-links |
| 2897 | (let ((regexp widget-documentation-link-regexp) |
| 2898 | (buttons (widget-get widget :buttons)) |
| 2899 | (widget-mouse-face (default-value 'widget-mouse-face)) |
| 2900 | (widget-button-face widget-documentation-face) |
| 2901 | (widget-button-pressed-face widget-documentation-face)) |
| 2902 | (save-excursion |
| 2903 | (goto-char from) |
| 2904 | (while (re-search-forward regexp to t) |
| 2905 | (let ((name (match-string 1)) |
| 2906 | (begin (match-beginning 1)) |
| 2907 | (end (match-end 1))) |
| 2908 | (when (funcall widget-documentation-link-p name) |
| 2909 | (push (widget-convert-button widget-documentation-link-type |
| 2910 | begin end :value name) |
| 2911 | buttons))))) |
| 2912 | (widget-put widget :buttons buttons))) |
| 2913 | (let ((indent (widget-get widget :indent))) |
| 2914 | (when (and indent (not (zerop indent))) |
| 2915 | (save-excursion |
| 2916 | (save-restriction |
| 2917 | (narrow-to-region from to) |
| 2918 | (goto-char (point-min)) |
| 2919 | (while (search-forward "\n" nil t) |
| 2920 | (insert-char ?\s indent))))))) |
| 2921 | |
| 2922 | ;;; The `documentation-string' Widget. |
| 2923 | |
| 2924 | (define-widget 'documentation-string 'item |
| 2925 | "A documentation string." |
| 2926 | :format "%v" |
| 2927 | :action 'widget-documentation-string-action |
| 2928 | :value-create 'widget-documentation-string-value-create |
| 2929 | :visibility-widget 'visibility) |
| 2930 | |
| 2931 | (defun widget-documentation-string-value-create (widget) |
| 2932 | ;; Insert documentation string. |
| 2933 | (let ((doc (widget-value widget)) |
| 2934 | (indent (widget-get widget :indent)) |
| 2935 | (shown (widget-get (widget-get widget :parent) :documentation-shown)) |
| 2936 | (start (point))) |
| 2937 | (if (string-match "\n" doc) |
| 2938 | (let ((before (substring doc 0 (match-beginning 0))) |
| 2939 | (after (substring doc (match-beginning 0))) |
| 2940 | button) |
| 2941 | (when (and indent (not (zerop indent))) |
| 2942 | (insert-char ?\s indent)) |
| 2943 | (insert before ?\s) |
| 2944 | (widget-documentation-link-add widget start (point)) |
| 2945 | (setq button |
| 2946 | (widget-create-child-and-convert |
| 2947 | widget (widget-get widget :visibility-widget) |
| 2948 | :help-echo "Show or hide rest of the documentation." |
| 2949 | :on "Hide" |
| 2950 | :off "More" |
| 2951 | :always-active t |
| 2952 | :action 'widget-parent-action |
| 2953 | shown)) |
| 2954 | (when shown |
| 2955 | (setq start (point)) |
| 2956 | (when (and indent (not (zerop indent))) |
| 2957 | (insert-char ?\s indent)) |
| 2958 | (insert after) |
| 2959 | (widget-documentation-link-add widget start (point))) |
| 2960 | (widget-put widget :buttons (list button))) |
| 2961 | (when (and indent (not (zerop indent))) |
| 2962 | (insert-char ?\s indent)) |
| 2963 | (insert doc) |
| 2964 | (widget-documentation-link-add widget start (point)))) |
| 2965 | (insert ?\n)) |
| 2966 | |
| 2967 | (defun widget-documentation-string-action (widget &rest ignore) |
| 2968 | ;; Toggle documentation. |
| 2969 | (let ((parent (widget-get widget :parent))) |
| 2970 | (widget-put parent :documentation-shown |
| 2971 | (not (widget-get parent :documentation-shown)))) |
| 2972 | ;; Redraw. |
| 2973 | (widget-value-set widget (widget-value widget))) |
| 2974 | |
| 2975 | (defun widget-add-documentation-string-button (widget &rest args) |
| 2976 | "Insert a new `documentation-string' widget based on WIDGET. |
| 2977 | The new widget becomes a child of WIDGET, and is also added to |
| 2978 | its `:buttons' list. The documentation string is found from |
| 2979 | WIDGET using the function `widget-docstring'. |
| 2980 | Optional ARGS specifies additional keyword arguments for the |
| 2981 | `documentation-string' widget." |
| 2982 | (let ((doc (widget-docstring widget)) |
| 2983 | (indent (widget-get widget :indent)) |
| 2984 | (doc-indent (widget-get widget :documentation-indent))) |
| 2985 | (when doc |
| 2986 | (and (eq (preceding-char) ?\n) |
| 2987 | indent |
| 2988 | (insert-char ?\s indent)) |
| 2989 | (unless (or (numberp doc-indent) (null doc-indent)) |
| 2990 | (setq doc-indent 0)) |
| 2991 | (widget-put widget :buttons |
| 2992 | (cons (apply 'widget-create-child-and-convert |
| 2993 | widget 'documentation-string |
| 2994 | :indent doc-indent |
| 2995 | (nconc args (list doc))) |
| 2996 | (widget-get widget :buttons)))))) |
| 2997 | \f |
| 2998 | ;;; The Sexp Widgets. |
| 2999 | |
| 3000 | (define-widget 'const 'item |
| 3001 | "An immutable sexp." |
| 3002 | :prompt-value 'widget-const-prompt-value |
| 3003 | :format "%t\n%d") |
| 3004 | |
| 3005 | (defun widget-const-prompt-value (widget prompt value unbound) |
| 3006 | ;; Return the value of the const. |
| 3007 | (widget-value widget)) |
| 3008 | |
| 3009 | (define-widget 'function-item 'const |
| 3010 | "An immutable function name." |
| 3011 | :format "%v\n%h" |
| 3012 | :documentation-property (lambda (symbol) |
| 3013 | (condition-case nil |
| 3014 | (documentation symbol t) |
| 3015 | (error nil)))) |
| 3016 | |
| 3017 | (define-widget 'variable-item 'const |
| 3018 | "An immutable variable name." |
| 3019 | :format "%v\n%h" |
| 3020 | :documentation-property 'variable-documentation) |
| 3021 | |
| 3022 | (define-widget 'other 'sexp |
| 3023 | "Matches any value, but doesn't let the user edit the value. |
| 3024 | This is useful as last item in a `choice' widget. |
| 3025 | You should use this widget type with a default value, |
| 3026 | as in (other DEFAULT) or (other :tag \"NAME\" DEFAULT). |
| 3027 | If the user selects this alternative, that specifies DEFAULT |
| 3028 | as the value." |
| 3029 | :tag "Other" |
| 3030 | :format "%t%n" |
| 3031 | :value 'other) |
| 3032 | |
| 3033 | (defvar widget-string-prompt-value-history nil |
| 3034 | "History of input to `widget-string-prompt-value'.") |
| 3035 | |
| 3036 | (define-widget 'string 'editable-field |
| 3037 | "A string" |
| 3038 | :tag "String" |
| 3039 | :format "%{%t%}: %v" |
| 3040 | :complete-function 'ispell-complete-word |
| 3041 | :prompt-history 'widget-string-prompt-value-history) |
| 3042 | |
| 3043 | (defun widget-string-complete () |
| 3044 | "Complete contents of string field. |
| 3045 | Completions are taken from the :completion-alist property of the |
| 3046 | widget. If that isn't a list, it's evalled and expected to yield a list." |
| 3047 | (interactive) |
| 3048 | (let* ((widget widget--completing-widget) |
| 3049 | (completion-ignore-case (widget-get widget :completion-ignore-case)) |
| 3050 | (alist (widget-get widget :completion-alist)) |
| 3051 | (_ (unless (listp alist) |
| 3052 | (setq alist (eval alist))))) |
| 3053 | (completion-in-region (widget-field-start widget) |
| 3054 | (max (point) (widget-field-text-end widget)) |
| 3055 | alist))) |
| 3056 | |
| 3057 | (define-widget 'regexp 'string |
| 3058 | "A regular expression." |
| 3059 | :match 'widget-regexp-match |
| 3060 | :validate 'widget-regexp-validate |
| 3061 | ;; Doesn't work well with terminating newline. |
| 3062 | ;; :value-face 'widget-single-line-field |
| 3063 | :tag "Regexp") |
| 3064 | |
| 3065 | (defun widget-regexp-match (widget value) |
| 3066 | ;; Match valid regexps. |
| 3067 | (and (stringp value) |
| 3068 | (condition-case nil |
| 3069 | (prog1 t |
| 3070 | (string-match value "")) |
| 3071 | (error nil)))) |
| 3072 | |
| 3073 | (defun widget-regexp-validate (widget) |
| 3074 | "Check that the value of WIDGET is a valid regexp." |
| 3075 | (condition-case data |
| 3076 | (prog1 nil |
| 3077 | (string-match (widget-value widget) "")) |
| 3078 | (error (widget-put widget :error (error-message-string data)) |
| 3079 | widget))) |
| 3080 | |
| 3081 | (define-widget 'file 'string |
| 3082 | "A file widget. |
| 3083 | It reads a file name from an editable text field." |
| 3084 | :complete-function 'widget-file-complete |
| 3085 | :prompt-value 'widget-file-prompt-value |
| 3086 | :format "%{%t%}: %v" |
| 3087 | ;; Doesn't work well with terminating newline. |
| 3088 | ;; :value-face 'widget-single-line-field |
| 3089 | :tag "File") |
| 3090 | |
| 3091 | (defun widget-file-complete () |
| 3092 | "Perform completion on file name preceding point." |
| 3093 | (interactive) |
| 3094 | (let ((widget widget--completing-widget)) |
| 3095 | (completion-in-region (widget-field-start widget) |
| 3096 | (max (point) (widget-field-text-end widget)) |
| 3097 | 'completion-file-name-table))) |
| 3098 | |
| 3099 | (defun widget-file-prompt-value (widget prompt value unbound) |
| 3100 | ;; Read file from minibuffer. |
| 3101 | (abbreviate-file-name |
| 3102 | (if unbound |
| 3103 | (read-file-name prompt) |
| 3104 | (let ((prompt2 (format "%s (default %s): " prompt value)) |
| 3105 | (dir (file-name-directory value)) |
| 3106 | (file (file-name-nondirectory value)) |
| 3107 | (must-match (widget-get widget :must-match))) |
| 3108 | (read-file-name prompt2 dir nil must-match file))))) |
| 3109 | |
| 3110 | ;;;(defun widget-file-action (widget &optional event) |
| 3111 | ;;; ;; Read a file name from the minibuffer. |
| 3112 | ;;; (let* ((value (widget-value widget)) |
| 3113 | ;;; (dir (file-name-directory value)) |
| 3114 | ;;; (file (file-name-nondirectory value)) |
| 3115 | ;;; (menu-tag (widget-apply widget :menu-tag-get)) |
| 3116 | ;;; (must-match (widget-get widget :must-match)) |
| 3117 | ;;; (answer (read-file-name (concat menu-tag " (default " value "): ") |
| 3118 | ;;; dir nil must-match file))) |
| 3119 | ;;; (widget-value-set widget (abbreviate-file-name answer)) |
| 3120 | ;;; (widget-setup) |
| 3121 | ;;; (widget-apply widget :notify widget event))) |
| 3122 | |
| 3123 | ;; Fixme: use file-name-as-directory. |
| 3124 | (define-widget 'directory 'file |
| 3125 | "A directory widget. |
| 3126 | It reads a directory name from an editable text field." |
| 3127 | :tag "Directory") |
| 3128 | |
| 3129 | (defvar widget-symbol-prompt-value-history nil |
| 3130 | "History of input to `widget-symbol-prompt-value'.") |
| 3131 | |
| 3132 | (define-widget 'symbol 'editable-field |
| 3133 | "A Lisp symbol." |
| 3134 | :value nil |
| 3135 | :tag "Symbol" |
| 3136 | :format "%{%t%}: %v" |
| 3137 | :match (lambda (widget value) (symbolp value)) |
| 3138 | :complete-function 'lisp-complete-symbol |
| 3139 | :prompt-internal 'widget-symbol-prompt-internal |
| 3140 | :prompt-match 'symbolp |
| 3141 | :prompt-history 'widget-symbol-prompt-value-history |
| 3142 | :value-to-internal (lambda (widget value) |
| 3143 | (if (symbolp value) |
| 3144 | (symbol-name value) |
| 3145 | value)) |
| 3146 | :value-to-external (lambda (widget value) |
| 3147 | (if (stringp value) |
| 3148 | (intern value) |
| 3149 | value))) |
| 3150 | |
| 3151 | (defun widget-symbol-prompt-internal (widget prompt initial history) |
| 3152 | ;; Read file from minibuffer. |
| 3153 | (let ((answer (completing-read prompt obarray |
| 3154 | (widget-get widget :prompt-match) |
| 3155 | nil initial history))) |
| 3156 | (if (and (stringp answer) |
| 3157 | (not (zerop (length answer)))) |
| 3158 | answer |
| 3159 | (error "No value")))) |
| 3160 | |
| 3161 | (defvar widget-function-prompt-value-history nil |
| 3162 | "History of input to `widget-function-prompt-value'.") |
| 3163 | |
| 3164 | (define-widget 'function 'restricted-sexp |
| 3165 | "A Lisp function." |
| 3166 | :complete-function (lambda () |
| 3167 | (interactive) |
| 3168 | (lisp-complete-symbol 'fboundp)) |
| 3169 | :prompt-value 'widget-field-prompt-value |
| 3170 | :prompt-internal 'widget-symbol-prompt-internal |
| 3171 | :prompt-match 'fboundp |
| 3172 | :prompt-history 'widget-function-prompt-value-history |
| 3173 | :action 'widget-field-action |
| 3174 | :match-alternatives '(functionp) |
| 3175 | :validate (lambda (widget) |
| 3176 | (unless (functionp (widget-value widget)) |
| 3177 | (widget-put widget :error (format "Invalid function: %S" |
| 3178 | (widget-value widget))) |
| 3179 | widget)) |
| 3180 | :value 'ignore |
| 3181 | :tag "Function") |
| 3182 | |
| 3183 | (defvar widget-variable-prompt-value-history nil |
| 3184 | "History of input to `widget-variable-prompt-value'.") |
| 3185 | |
| 3186 | (define-widget 'variable 'symbol |
| 3187 | "A Lisp variable." |
| 3188 | :prompt-match 'boundp |
| 3189 | :prompt-history 'widget-variable-prompt-value-history |
| 3190 | :complete-function (lambda () |
| 3191 | (interactive) |
| 3192 | (lisp-complete-symbol 'boundp)) |
| 3193 | :tag "Variable") |
| 3194 | |
| 3195 | (define-widget 'coding-system 'symbol |
| 3196 | "A MULE coding-system." |
| 3197 | :format "%{%t%}: %v" |
| 3198 | :tag "Coding system" |
| 3199 | :base-only nil |
| 3200 | :prompt-history 'coding-system-value-history |
| 3201 | :prompt-value 'widget-coding-system-prompt-value |
| 3202 | :action 'widget-coding-system-action |
| 3203 | :complete-function (lambda () |
| 3204 | (interactive) |
| 3205 | (lisp-complete-symbol 'coding-system-p)) |
| 3206 | :validate (lambda (widget) |
| 3207 | (unless (coding-system-p (widget-value widget)) |
| 3208 | (widget-put widget :error (format "Invalid coding system: %S" |
| 3209 | (widget-value widget))) |
| 3210 | widget)) |
| 3211 | :value 'undecided |
| 3212 | :prompt-match 'coding-system-p) |
| 3213 | |
| 3214 | (defun widget-coding-system-prompt-value (widget prompt value unbound) |
| 3215 | "Read coding-system from minibuffer." |
| 3216 | (if (widget-get widget :base-only) |
| 3217 | (intern |
| 3218 | (completing-read (format "%s (default %s): " prompt value) |
| 3219 | (mapcar #'list (coding-system-list t)) nil nil nil |
| 3220 | coding-system-history)) |
| 3221 | (read-coding-system (format "%s (default %s): " prompt value) value))) |
| 3222 | |
| 3223 | (defun widget-coding-system-action (widget &optional event) |
| 3224 | (let ((answer |
| 3225 | (widget-coding-system-prompt-value |
| 3226 | widget |
| 3227 | (widget-apply widget :menu-tag-get) |
| 3228 | (widget-value widget) |
| 3229 | t))) |
| 3230 | (widget-value-set widget answer) |
| 3231 | (widget-apply widget :notify widget event) |
| 3232 | (widget-setup))) |
| 3233 | \f |
| 3234 | ;;; I'm not sure about what this is good for? KFS. |
| 3235 | (defvar widget-key-sequence-prompt-value-history nil |
| 3236 | "History of input to `widget-key-sequence-prompt-value'.") |
| 3237 | |
| 3238 | (defvar widget-key-sequence-default-value [ignore] |
| 3239 | "Default value for an empty key sequence.") |
| 3240 | |
| 3241 | (defvar widget-key-sequence-map |
| 3242 | (let ((map (make-sparse-keymap))) |
| 3243 | (set-keymap-parent map widget-field-keymap) |
| 3244 | (define-key map [(control ?q)] 'widget-key-sequence-read-event) |
| 3245 | map)) |
| 3246 | |
| 3247 | (define-widget 'key-sequence 'restricted-sexp |
| 3248 | "A key sequence." |
| 3249 | :prompt-value 'widget-field-prompt-value |
| 3250 | :prompt-internal 'widget-symbol-prompt-internal |
| 3251 | ; :prompt-match 'fboundp ;; What was this good for? KFS |
| 3252 | :prompt-history 'widget-key-sequence-prompt-value-history |
| 3253 | :action 'widget-field-action |
| 3254 | :match-alternatives '(stringp vectorp) |
| 3255 | :format "%{%t%}: %v" |
| 3256 | :validate 'widget-key-sequence-validate |
| 3257 | :value-to-internal 'widget-key-sequence-value-to-internal |
| 3258 | :value-to-external 'widget-key-sequence-value-to-external |
| 3259 | :value widget-key-sequence-default-value |
| 3260 | :keymap widget-key-sequence-map |
| 3261 | :help-echo "C-q: insert KEY, EVENT, or CODE; RET: enter value" |
| 3262 | :tag "Key sequence") |
| 3263 | |
| 3264 | (defun widget-key-sequence-read-event (ev) |
| 3265 | (interactive (list |
| 3266 | (let ((inhibit-quit t) quit-flag) |
| 3267 | (read-event "Insert KEY, EVENT, or CODE: ")))) |
| 3268 | (let ((ev2 (and (memq 'down (event-modifiers ev)) |
| 3269 | (read-event))) |
| 3270 | (tr (and (keymapp function-key-map) |
| 3271 | (lookup-key function-key-map (vector ev))))) |
| 3272 | (when (and (integerp ev) |
| 3273 | (or (and (<= ?0 ev) (< ev (+ ?0 (min 10 read-quoted-char-radix)))) |
| 3274 | (and (<= ?a (downcase ev)) |
| 3275 | (< (downcase ev) (+ ?a -10 (min 36 read-quoted-char-radix)))))) |
| 3276 | (setq unread-command-events (cons ev unread-command-events) |
| 3277 | ev (read-quoted-char (format "Enter code (radix %d)" read-quoted-char-radix)) |
| 3278 | tr nil) |
| 3279 | (if (and (integerp ev) (not (characterp ev))) |
| 3280 | (insert (char-to-string ev)))) ;; throw invalid char error |
| 3281 | (setq ev (key-description (list ev))) |
| 3282 | (when (arrayp tr) |
| 3283 | (setq tr (key-description (list (aref tr 0)))) |
| 3284 | (if (y-or-n-p (format "Key %s is translated to %s -- use %s? " ev tr tr)) |
| 3285 | (setq ev tr ev2 nil))) |
| 3286 | (insert (if (= (char-before) ?\s) "" " ") ev " ") |
| 3287 | (if ev2 |
| 3288 | (insert (key-description (list ev2)) " ")))) |
| 3289 | |
| 3290 | (defun widget-key-sequence-validate (widget) |
| 3291 | (unless (or (stringp (widget-value widget)) |
| 3292 | (vectorp (widget-value widget))) |
| 3293 | (widget-put widget :error (format "Invalid key sequence: %S" |
| 3294 | (widget-value widget))) |
| 3295 | widget)) |
| 3296 | |
| 3297 | (defun widget-key-sequence-value-to-internal (widget value) |
| 3298 | (if (widget-apply widget :match value) |
| 3299 | (if (equal value widget-key-sequence-default-value) |
| 3300 | "" |
| 3301 | (key-description value)) |
| 3302 | value)) |
| 3303 | |
| 3304 | (defun widget-key-sequence-value-to-external (widget value) |
| 3305 | (if (stringp value) |
| 3306 | (if (string-match "\\`[[:space:]]*\\'" value) |
| 3307 | widget-key-sequence-default-value |
| 3308 | (read-kbd-macro value)) |
| 3309 | value)) |
| 3310 | |
| 3311 | \f |
| 3312 | (define-widget 'sexp 'editable-field |
| 3313 | "An arbitrary Lisp expression." |
| 3314 | :tag "Lisp expression" |
| 3315 | :format "%{%t%}: %v" |
| 3316 | :value nil |
| 3317 | :validate 'widget-sexp-validate |
| 3318 | :match (lambda (widget value) t) |
| 3319 | :value-to-internal 'widget-sexp-value-to-internal |
| 3320 | :value-to-external (lambda (widget value) (read value)) |
| 3321 | :prompt-history 'widget-sexp-prompt-value-history |
| 3322 | :prompt-value 'widget-sexp-prompt-value) |
| 3323 | |
| 3324 | (defun widget-sexp-value-to-internal (widget value) |
| 3325 | ;; Use pp for printer representation. |
| 3326 | (let ((pp (if (symbolp value) |
| 3327 | (prin1-to-string value) |
| 3328 | (pp-to-string value)))) |
| 3329 | (while (string-match "\n\\'" pp) |
| 3330 | (setq pp (substring pp 0 -1))) |
| 3331 | (if (or (string-match "\n\\'" pp) |
| 3332 | (> (length pp) 40)) |
| 3333 | (concat "\n" pp) |
| 3334 | pp))) |
| 3335 | |
| 3336 | (defun widget-sexp-validate (widget) |
| 3337 | ;; Valid if we can read the string and there is no junk left after it. |
| 3338 | (with-temp-buffer |
| 3339 | (insert (widget-apply widget :value-get)) |
| 3340 | (goto-char (point-min)) |
| 3341 | (let (err) |
| 3342 | (condition-case data |
| 3343 | (progn |
| 3344 | ;; Avoid a confusing end-of-file error. |
| 3345 | (skip-syntax-forward "\\s-") |
| 3346 | (if (eobp) |
| 3347 | (setq err "Empty sexp -- use `nil'?") |
| 3348 | (unless (widget-apply widget :match (read (current-buffer))) |
| 3349 | (setq err (widget-get widget :type-error)))) |
| 3350 | ;; Allow whitespace after expression. |
| 3351 | (skip-syntax-forward "\\s-") |
| 3352 | (if (and (not (eobp)) |
| 3353 | (not err)) |
| 3354 | (setq err (format "Junk at end of expression: %s" |
| 3355 | (buffer-substring (point) |
| 3356 | (point-max)))))) |
| 3357 | (end-of-file ; Avoid confusing error message. |
| 3358 | (setq err "Unbalanced sexp")) |
| 3359 | (error (setq err (error-message-string data)))) |
| 3360 | (if (not err) |
| 3361 | nil |
| 3362 | (widget-put widget :error err) |
| 3363 | widget)))) |
| 3364 | |
| 3365 | (defvar widget-sexp-prompt-value-history nil |
| 3366 | "History of input to `widget-sexp-prompt-value'.") |
| 3367 | |
| 3368 | (defun widget-sexp-prompt-value (widget prompt value unbound) |
| 3369 | ;; Read an arbitrary sexp. |
| 3370 | (let ((found (read-string prompt |
| 3371 | (if unbound nil (cons (prin1-to-string value) 0)) |
| 3372 | (widget-get widget :prompt-history)))) |
| 3373 | (let ((answer (read-from-string found))) |
| 3374 | (unless (= (cdr answer) (length found)) |
| 3375 | (error "Junk at end of expression: %s" |
| 3376 | (substring found (cdr answer)))) |
| 3377 | (car answer)))) |
| 3378 | |
| 3379 | (define-widget 'restricted-sexp 'sexp |
| 3380 | "A Lisp expression restricted to values that match. |
| 3381 | To use this type, you must define :match or :match-alternatives." |
| 3382 | :type-error "The specified value is not valid" |
| 3383 | :match 'widget-restricted-sexp-match |
| 3384 | :value-to-internal (lambda (widget value) |
| 3385 | (if (widget-apply widget :match value) |
| 3386 | (prin1-to-string value) |
| 3387 | value))) |
| 3388 | |
| 3389 | (defun widget-restricted-sexp-match (widget value) |
| 3390 | (let ((alternatives (widget-get widget :match-alternatives)) |
| 3391 | matched) |
| 3392 | (while (and alternatives (not matched)) |
| 3393 | (if (cond ((functionp (car alternatives)) |
| 3394 | (funcall (car alternatives) value)) |
| 3395 | ((and (consp (car alternatives)) |
| 3396 | (eq (car (car alternatives)) 'quote)) |
| 3397 | (eq value (nth 1 (car alternatives))))) |
| 3398 | (setq matched t)) |
| 3399 | (setq alternatives (cdr alternatives))) |
| 3400 | matched)) |
| 3401 | \f |
| 3402 | (define-widget 'integer 'restricted-sexp |
| 3403 | "An integer." |
| 3404 | :tag "Integer" |
| 3405 | :value 0 |
| 3406 | :type-error "This field should contain an integer" |
| 3407 | :match-alternatives '(integerp)) |
| 3408 | |
| 3409 | (define-widget 'number 'restricted-sexp |
| 3410 | "A number (floating point or integer)." |
| 3411 | :tag "Number" |
| 3412 | :value 0.0 |
| 3413 | :type-error "This field should contain a number (floating point or integer)" |
| 3414 | :match-alternatives '(numberp)) |
| 3415 | |
| 3416 | (define-widget 'float 'restricted-sexp |
| 3417 | "A floating point number." |
| 3418 | :tag "Floating point number" |
| 3419 | :value 0.0 |
| 3420 | :type-error "This field should contain a floating point number" |
| 3421 | :match-alternatives '(floatp)) |
| 3422 | |
| 3423 | (define-widget 'character 'editable-field |
| 3424 | "A character." |
| 3425 | :tag "Character" |
| 3426 | :value 0 |
| 3427 | :size 1 |
| 3428 | :format "%{%t%}: %v\n" |
| 3429 | :valid-regexp "\\`.\\'" |
| 3430 | :error "This field should contain a single character" |
| 3431 | :value-to-internal (lambda (widget value) |
| 3432 | (if (stringp value) |
| 3433 | value |
| 3434 | (char-to-string value))) |
| 3435 | :value-to-external (lambda (widget value) |
| 3436 | (if (stringp value) |
| 3437 | (aref value 0) |
| 3438 | value)) |
| 3439 | :match (lambda (widget value) |
| 3440 | (characterp value))) |
| 3441 | |
| 3442 | (define-widget 'list 'group |
| 3443 | "A Lisp list." |
| 3444 | :tag "List" |
| 3445 | :format "%{%t%}:\n%v") |
| 3446 | |
| 3447 | (define-widget 'vector 'group |
| 3448 | "A Lisp vector." |
| 3449 | :tag "Vector" |
| 3450 | :format "%{%t%}:\n%v" |
| 3451 | :match 'widget-vector-match |
| 3452 | :value-to-internal (lambda (widget value) (append value nil)) |
| 3453 | :value-to-external (lambda (widget value) (apply 'vector value))) |
| 3454 | |
| 3455 | (defun widget-vector-match (widget value) |
| 3456 | (and (vectorp value) |
| 3457 | (widget-group-match widget |
| 3458 | (widget-apply widget :value-to-internal value)))) |
| 3459 | |
| 3460 | (define-widget 'cons 'group |
| 3461 | "A cons-cell." |
| 3462 | :tag "Cons-cell" |
| 3463 | :format "%{%t%}:\n%v" |
| 3464 | :match 'widget-cons-match |
| 3465 | :value-to-internal (lambda (widget value) |
| 3466 | (list (car value) (cdr value))) |
| 3467 | :value-to-external (lambda (widget value) |
| 3468 | (apply 'cons value))) |
| 3469 | |
| 3470 | (defun widget-cons-match (widget value) |
| 3471 | (and (consp value) |
| 3472 | (widget-group-match widget |
| 3473 | (widget-apply widget :value-to-internal value)))) |
| 3474 | \f |
| 3475 | ;;; The `lazy' Widget. |
| 3476 | ;; |
| 3477 | ;; Recursive datatypes. |
| 3478 | |
| 3479 | (define-widget 'lazy 'default |
| 3480 | "Base widget for recursive datastructures. |
| 3481 | |
| 3482 | The `lazy' widget will, when instantiated, contain a single inferior |
| 3483 | widget, of the widget type specified by the :type parameter. The |
| 3484 | value of the `lazy' widget is the same as the value of the inferior |
| 3485 | widget. When deriving a new widget from the 'lazy' widget, the :type |
| 3486 | parameter is allowed to refer to the widget currently being defined, |
| 3487 | thus allowing recursive datastructures to be described. |
| 3488 | |
| 3489 | The :type parameter takes the same arguments as the defcustom |
| 3490 | parameter with the same name. |
| 3491 | |
| 3492 | Most composite widgets, i.e. widgets containing other widgets, does |
| 3493 | not allow recursion. That is, when you define a new widget type, none |
| 3494 | of the inferior widgets may be of the same type you are currently |
| 3495 | defining. |
| 3496 | |
| 3497 | In Lisp, however, it is custom to define datastructures in terms of |
| 3498 | themselves. A list, for example, is defined as either nil, or a cons |
| 3499 | cell whose cdr itself is a list. The obvious way to translate this |
| 3500 | into a widget type would be |
| 3501 | |
| 3502 | (define-widget 'my-list 'choice |
| 3503 | \"A list of sexps.\" |
| 3504 | :tag \"Sexp list\" |
| 3505 | :args '((const nil) (cons :value (nil) sexp my-list))) |
| 3506 | |
| 3507 | Here we attempt to define my-list as a choice of either the constant |
| 3508 | nil, or a cons-cell containing a sexp and my-lisp. This will not work |
| 3509 | because the `choice' widget does not allow recursion. |
| 3510 | |
| 3511 | Using the `lazy' widget you can overcome this problem, as in this |
| 3512 | example: |
| 3513 | |
| 3514 | (define-widget 'sexp-list 'lazy |
| 3515 | \"A list of sexps.\" |
| 3516 | :tag \"Sexp list\" |
| 3517 | :type '(choice (const nil) (cons :value (nil) sexp sexp-list)))" |
| 3518 | :format "%{%t%}: %v" |
| 3519 | ;; We don't convert :type because we want to allow recursive |
| 3520 | ;; datastructures. This is slow, so we should not create speed |
| 3521 | ;; critical widgets by deriving from this. |
| 3522 | :convert-widget 'widget-value-convert-widget |
| 3523 | :value-create 'widget-type-value-create |
| 3524 | :value-get 'widget-child-value-get |
| 3525 | :value-inline 'widget-child-value-inline |
| 3526 | :default-get 'widget-type-default-get |
| 3527 | :match 'widget-type-match |
| 3528 | :validate 'widget-child-validate) |
| 3529 | |
| 3530 | \f |
| 3531 | ;;; The `plist' Widget. |
| 3532 | ;; |
| 3533 | ;; Property lists. |
| 3534 | |
| 3535 | (define-widget 'plist 'list |
| 3536 | "A property list." |
| 3537 | :key-type '(symbol :tag "Key") |
| 3538 | :value-type '(sexp :tag "Value") |
| 3539 | :convert-widget 'widget-plist-convert-widget |
| 3540 | :tag "Plist") |
| 3541 | |
| 3542 | (defvar widget-plist-value-type) ;Dynamic variable |
| 3543 | |
| 3544 | (defun widget-plist-convert-widget (widget) |
| 3545 | ;; Handle `:options'. |
| 3546 | (let* ((options (widget-get widget :options)) |
| 3547 | (widget-plist-value-type (widget-get widget :value-type)) |
| 3548 | (other `(editable-list :inline t |
| 3549 | (group :inline t |
| 3550 | ,(widget-get widget :key-type) |
| 3551 | ,widget-plist-value-type))) |
| 3552 | (args (if options |
| 3553 | (list `(checklist :inline t |
| 3554 | :greedy t |
| 3555 | ,@(mapcar 'widget-plist-convert-option |
| 3556 | options)) |
| 3557 | other) |
| 3558 | (list other)))) |
| 3559 | (widget-put widget :args args) |
| 3560 | widget)) |
| 3561 | |
| 3562 | (defun widget-plist-convert-option (option) |
| 3563 | ;; Convert a single plist option. |
| 3564 | (let (key-type value-type) |
| 3565 | (if (listp option) |
| 3566 | (let ((key (nth 0 option))) |
| 3567 | (setq value-type (nth 1 option)) |
| 3568 | (if (listp key) |
| 3569 | (setq key-type key) |
| 3570 | (setq key-type `(const ,key)))) |
| 3571 | (setq key-type `(const ,option) |
| 3572 | value-type widget-plist-value-type)) |
| 3573 | `(group :format "Key: %v" :inline t ,key-type ,value-type))) |
| 3574 | |
| 3575 | |
| 3576 | ;;; The `alist' Widget. |
| 3577 | ;; |
| 3578 | ;; Association lists. |
| 3579 | |
| 3580 | (define-widget 'alist 'list |
| 3581 | "An association list." |
| 3582 | :key-type '(sexp :tag "Key") |
| 3583 | :value-type '(sexp :tag "Value") |
| 3584 | :convert-widget 'widget-alist-convert-widget |
| 3585 | :tag "Alist") |
| 3586 | |
| 3587 | (defvar widget-alist-value-type) ;Dynamic variable |
| 3588 | |
| 3589 | (defun widget-alist-convert-widget (widget) |
| 3590 | ;; Handle `:options'. |
| 3591 | (let* ((options (widget-get widget :options)) |
| 3592 | (widget-alist-value-type (widget-get widget :value-type)) |
| 3593 | (other `(editable-list :inline t |
| 3594 | (cons :format "%v" |
| 3595 | ,(widget-get widget :key-type) |
| 3596 | ,widget-alist-value-type))) |
| 3597 | (args (if options |
| 3598 | (list `(checklist :inline t |
| 3599 | :greedy t |
| 3600 | ,@(mapcar 'widget-alist-convert-option |
| 3601 | options)) |
| 3602 | other) |
| 3603 | (list other)))) |
| 3604 | (widget-put widget :args args) |
| 3605 | widget)) |
| 3606 | |
| 3607 | (defun widget-alist-convert-option (option) |
| 3608 | ;; Convert a single alist option. |
| 3609 | (let (key-type value-type) |
| 3610 | (if (listp option) |
| 3611 | (let ((key (nth 0 option))) |
| 3612 | (setq value-type (nth 1 option)) |
| 3613 | (if (listp key) |
| 3614 | (setq key-type key) |
| 3615 | (setq key-type `(const ,key)))) |
| 3616 | (setq key-type `(const ,option) |
| 3617 | value-type widget-alist-value-type)) |
| 3618 | `(cons :format "Key: %v" ,key-type ,value-type))) |
| 3619 | \f |
| 3620 | (define-widget 'choice 'menu-choice |
| 3621 | "A union of several sexp types." |
| 3622 | :tag "Choice" |
| 3623 | :format "%{%t%}: %[Value Menu%] %v" |
| 3624 | :button-prefix 'widget-push-button-prefix |
| 3625 | :button-suffix 'widget-push-button-suffix |
| 3626 | :prompt-value 'widget-choice-prompt-value) |
| 3627 | |
| 3628 | (defun widget-choice-prompt-value (widget prompt value unbound) |
| 3629 | "Make a choice." |
| 3630 | (let ((args (widget-get widget :args)) |
| 3631 | (completion-ignore-case (widget-get widget :case-fold)) |
| 3632 | current choices old) |
| 3633 | ;; Find the first arg that matches VALUE. |
| 3634 | (let ((look args)) |
| 3635 | (while look |
| 3636 | (if (widget-apply (car look) :match value) |
| 3637 | (setq old (car look) |
| 3638 | look nil) |
| 3639 | (setq look (cdr look))))) |
| 3640 | ;; Find new choice. |
| 3641 | (setq current |
| 3642 | (cond ((= (length args) 0) |
| 3643 | nil) |
| 3644 | ((= (length args) 1) |
| 3645 | (nth 0 args)) |
| 3646 | ((and (= (length args) 2) |
| 3647 | (memq old args)) |
| 3648 | (if (eq old (nth 0 args)) |
| 3649 | (nth 1 args) |
| 3650 | (nth 0 args))) |
| 3651 | (t |
| 3652 | (while args |
| 3653 | (setq current (car args) |
| 3654 | args (cdr args)) |
| 3655 | (setq choices |
| 3656 | (cons (cons (widget-apply current :menu-tag-get) |
| 3657 | current) |
| 3658 | choices))) |
| 3659 | (let ((val (completing-read prompt choices nil t))) |
| 3660 | (if (stringp val) |
| 3661 | (let ((try (try-completion val choices))) |
| 3662 | (when (stringp try) |
| 3663 | (setq val try)) |
| 3664 | (cdr (assoc val choices))) |
| 3665 | nil))))) |
| 3666 | (if current |
| 3667 | (widget-prompt-value current prompt nil t) |
| 3668 | value))) |
| 3669 | \f |
| 3670 | (define-widget 'radio 'radio-button-choice |
| 3671 | "A union of several sexp types." |
| 3672 | :tag "Choice" |
| 3673 | :format "%{%t%}:\n%v" |
| 3674 | :prompt-value 'widget-choice-prompt-value) |
| 3675 | |
| 3676 | (define-widget 'repeat 'editable-list |
| 3677 | "A variable length homogeneous list." |
| 3678 | :tag "Repeat" |
| 3679 | :format "%{%t%}:\n%v%i\n") |
| 3680 | |
| 3681 | (define-widget 'set 'checklist |
| 3682 | "A list of members from a fixed set." |
| 3683 | :tag "Set" |
| 3684 | :format "%{%t%}:\n%v") |
| 3685 | |
| 3686 | (define-widget 'boolean 'toggle |
| 3687 | "To be nil or non-nil, that is the question." |
| 3688 | :tag "Boolean" |
| 3689 | :prompt-value 'widget-boolean-prompt-value |
| 3690 | :button-prefix 'widget-push-button-prefix |
| 3691 | :button-suffix 'widget-push-button-suffix |
| 3692 | :format "%{%t%}: %[Toggle%] %v\n" |
| 3693 | :on "on (non-nil)" |
| 3694 | :off "off (nil)") |
| 3695 | |
| 3696 | (defun widget-boolean-prompt-value (widget prompt value unbound) |
| 3697 | ;; Toggle a boolean. |
| 3698 | (y-or-n-p prompt)) |
| 3699 | \f |
| 3700 | ;;; The `color' Widget. |
| 3701 | |
| 3702 | ;; Fixme: match |
| 3703 | (define-widget 'color 'editable-field |
| 3704 | "Choose a color name (with sample)." |
| 3705 | :format "%{%t%}: %v (%{sample%})\n" |
| 3706 | :value-create 'widget-color-value-create |
| 3707 | :size 10 |
| 3708 | :tag "Color" |
| 3709 | :value "black" |
| 3710 | :complete 'widget-color-complete |
| 3711 | :sample-face-get 'widget-color-sample-face-get |
| 3712 | :notify 'widget-color-notify |
| 3713 | :action 'widget-color-action) |
| 3714 | |
| 3715 | (defun widget-color-value-create (widget) |
| 3716 | (widget-field-value-create widget) |
| 3717 | (widget-insert " ") |
| 3718 | (widget-create-child-and-convert |
| 3719 | widget 'push-button |
| 3720 | :tag " Choose " :action 'widget-color--choose-action) |
| 3721 | (widget-insert " ")) |
| 3722 | |
| 3723 | (defun widget-color--choose-action (widget &optional event) |
| 3724 | (list-colors-display |
| 3725 | nil nil |
| 3726 | `(lambda (color) |
| 3727 | (when (buffer-live-p ,(current-buffer)) |
| 3728 | (widget-value-set ',(widget-get widget :parent) color) |
| 3729 | (let* ((buf (get-buffer "*Colors*")) |
| 3730 | (win (get-buffer-window buf 0))) |
| 3731 | (bury-buffer buf) |
| 3732 | (and win (> (length (window-list)) 1) |
| 3733 | (delete-window win))) |
| 3734 | (pop-to-buffer ,(current-buffer)))))) |
| 3735 | |
| 3736 | (defun widget-color-complete (widget) |
| 3737 | "Complete the color in WIDGET." |
| 3738 | (require 'facemenu) ; for facemenu-color-alist |
| 3739 | (completion-in-region (widget-field-start widget) |
| 3740 | (max (point) (widget-field-text-end widget)) |
| 3741 | (or facemenu-color-alist |
| 3742 | (sort (defined-colors) 'string-lessp)))) |
| 3743 | |
| 3744 | (defun widget-color-sample-face-get (widget) |
| 3745 | (let* ((value (condition-case nil |
| 3746 | (widget-value widget) |
| 3747 | (error (widget-get widget :value))))) |
| 3748 | (if (color-defined-p value) |
| 3749 | (list (cons 'foreground-color value)) |
| 3750 | 'default))) |
| 3751 | |
| 3752 | (defun widget-color-action (widget &optional event) |
| 3753 | "Prompt for a color." |
| 3754 | (let* ((tag (widget-apply widget :menu-tag-get)) |
| 3755 | (prompt (concat tag ": ")) |
| 3756 | (value (widget-value widget)) |
| 3757 | (start (widget-field-start widget)) |
| 3758 | (answer (facemenu-read-color prompt))) |
| 3759 | (unless (zerop (length answer)) |
| 3760 | (widget-value-set widget answer) |
| 3761 | (widget-setup) |
| 3762 | (widget-apply widget :notify widget event)))) |
| 3763 | |
| 3764 | (defun widget-color-notify (widget child &optional event) |
| 3765 | "Update the sample, and notify the parent." |
| 3766 | (overlay-put (widget-get widget :sample-overlay) |
| 3767 | 'face (widget-apply widget :sample-face-get)) |
| 3768 | (widget-default-notify widget child event)) |
| 3769 | \f |
| 3770 | ;;; The Help Echo |
| 3771 | |
| 3772 | (defun widget-echo-help (pos) |
| 3773 | "Display help-echo text for widget at POS." |
| 3774 | (let* ((widget (widget-at pos)) |
| 3775 | (help-echo (and widget (widget-get widget :help-echo)))) |
| 3776 | (if (functionp help-echo) |
| 3777 | (setq help-echo (funcall help-echo widget))) |
| 3778 | (if help-echo (message "%s" (eval help-echo))))) |
| 3779 | |
| 3780 | ;;; The End: |
| 3781 | |
| 3782 | (provide 'wid-edit) |
| 3783 | |
| 3784 | ;;; wid-edit.el ends here |