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