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