]> code.delx.au - gnu-emacs/blob - lisp/cus-edit.el
(f90-mode-abbrev-table): Mark all the predefined abbrevs as "system"
[gnu-emacs] / lisp / cus-edit.el
1 ;;; cus-edit.el --- tools for customizing Emacs and Lisp packages
2 ;;
3 ;; Copyright (C) 1996, 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Keywords: help, faces
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26 ;;
27 ;; This file implements the code to create and edit customize buffers.
28 ;;
29 ;; See `custom.el'.
30
31 ;; No commands should have names starting with `custom-' because
32 ;; that interferes with completion. Use `customize-' for commands
33 ;; that the user will run with M-x, and `Custom-' for interactive commands.
34
35 ;;; Code:
36
37 (require 'cus-face)
38 (require 'wid-edit)
39 (eval-when-compile
40 (defvar custom-versions-load-alist)) ; from cus-load
41
42 (condition-case nil
43 (require 'cus-load)
44 (error nil))
45
46 (condition-case nil
47 (require 'cus-start)
48 (error nil))
49
50 (put 'custom-define-hook 'custom-type 'hook)
51 (put 'custom-define-hook 'standard-value '(nil))
52 (custom-add-to-group 'customize 'custom-define-hook 'custom-variable)
53
54 ;;; Customization Groups.
55
56 (defgroup emacs nil
57 "Customization of the One True Editor."
58 :link '(custom-manual "(emacs)Top"))
59
60 ;; Most of these groups are stolen from `finder.el',
61 (defgroup editing nil
62 "Basic text editing facilities."
63 :group 'emacs)
64
65 (defgroup abbrev nil
66 "Abbreviation handling, typing shortcuts, macros."
67 :tag "Abbreviations"
68 :group 'editing)
69
70 (defgroup matching nil
71 "Various sorts of searching and matching."
72 :group 'editing)
73
74 (defgroup emulations nil
75 "Emulations of other editors."
76 :group 'editing)
77
78 (defgroup mouse nil
79 "Mouse support."
80 :group 'editing)
81
82 (defgroup outlines nil
83 "Support for hierarchical outlining."
84 :group 'editing)
85
86 (defgroup external nil
87 "Interfacing to external utilities."
88 :group 'emacs)
89
90 (defgroup bib nil
91 "Code related to the `bib' bibliography processor."
92 :tag "Bibliography"
93 :group 'external)
94
95 (defgroup processes nil
96 "Process, subshell, compilation, and job control support."
97 :group 'external
98 :group 'development)
99
100 (defgroup convenience nil
101 "Convenience features for faster editing."
102 :group 'emacs)
103
104 (defgroup programming nil
105 "Support for programming in other languages."
106 :group 'emacs)
107
108 (defgroup languages nil
109 "Specialized modes for editing programming languages."
110 :group 'programming)
111
112 (defgroup lisp nil
113 "Lisp support, including Emacs Lisp."
114 :group 'languages
115 :group 'development)
116
117 (defgroup c nil
118 "Support for the C language and related languages."
119 :group 'languages)
120
121 (defgroup tools nil
122 "Programming tools."
123 :group 'programming)
124
125 (defgroup oop nil
126 "Support for object-oriented programming."
127 :group 'programming)
128
129 (defgroup applications nil
130 "Applications written in Emacs."
131 :group 'emacs)
132
133 (defgroup calendar nil
134 "Calendar and time management support."
135 :group 'applications)
136
137 (defgroup mail nil
138 "Modes for electronic-mail handling."
139 :group 'applications)
140
141 (defgroup news nil
142 "Support for netnews reading and posting."
143 :group 'applications)
144
145 (defgroup games nil
146 "Games, jokes and amusements."
147 :group 'applications)
148
149 (defgroup development nil
150 "Support for further development of Emacs."
151 :group 'emacs)
152
153 (defgroup docs nil
154 "Support for Emacs documentation."
155 :group 'development)
156
157 (defgroup extensions nil
158 "Emacs Lisp language extensions."
159 :group 'development)
160
161 (defgroup internal nil
162 "Code for Emacs internals, build process, defaults."
163 :group 'development)
164
165 (defgroup maint nil
166 "Maintenance aids for the Emacs development group."
167 :tag "Maintenance"
168 :group 'development)
169
170 (defgroup environment nil
171 "Fitting Emacs with its environment."
172 :group 'emacs)
173
174 (defgroup comm nil
175 "Communications, networking, remote access to files."
176 :tag "Communication"
177 :group 'environment)
178
179 (defgroup hardware nil
180 "Support for interfacing with exotic hardware."
181 :group 'environment)
182
183 (defgroup terminals nil
184 "Support for terminal types."
185 :group 'environment)
186
187 (defgroup unix nil
188 "Front-ends/assistants for, or emulators of, UNIX features."
189 :group 'environment)
190
191 (defgroup vms nil
192 "Support code for vms."
193 :group 'environment)
194
195 (defgroup i18n nil
196 "Internationalization and alternate character-set support."
197 :group 'environment
198 :group 'editing)
199
200 (defgroup x nil
201 "The X Window system."
202 :group 'environment)
203
204 (defgroup frames nil
205 "Support for Emacs frames and window systems."
206 :group 'environment)
207
208 (defgroup data nil
209 "Support editing files of data."
210 :group 'emacs)
211
212 (defgroup files nil
213 "Support editing files."
214 :group 'emacs)
215
216 (defgroup wp nil
217 "Word processing."
218 :group 'emacs)
219
220 (defgroup tex nil
221 "Code related to the TeX formatter."
222 :group 'wp)
223
224 (defgroup faces nil
225 "Support for multiple fonts."
226 :group 'emacs)
227
228 (defgroup hypermedia nil
229 "Support for links between text or other media types."
230 :group 'emacs)
231
232 (defgroup help nil
233 "Support for on-line help systems."
234 :group 'emacs)
235
236 (defgroup multimedia nil
237 "Non-textual support, specifically images and sound."
238 :group 'emacs)
239
240 (defgroup local nil
241 "Code local to your site."
242 :group 'emacs)
243
244 (defgroup customize '((widgets custom-group))
245 "Customization of the Customization support."
246 :link '(custom-manual "(elisp)Customization")
247 :link '(url-link :tag "(Old?) Development Page"
248 "http://www.dina.kvl.dk/~abraham/custom/")
249 :prefix "custom-"
250 :group 'help)
251
252 (defgroup custom-faces nil
253 "Faces used by customize."
254 :group 'customize
255 :group 'faces)
256
257 (defgroup custom-browse nil
258 "Control customize browser."
259 :prefix "custom-"
260 :group 'customize)
261
262 (defgroup custom-buffer nil
263 "Control customize buffers."
264 :prefix "custom-"
265 :group 'customize)
266
267 (defgroup custom-menu nil
268 "Control customize menus."
269 :prefix "custom-"
270 :group 'customize)
271
272 (defgroup abbrev-mode nil
273 "Word abbreviations mode."
274 :group 'abbrev)
275
276 (defgroup alloc nil
277 "Storage allocation and gc for GNU Emacs Lisp interpreter."
278 :tag "Storage Allocation"
279 :group 'internal)
280
281 (defgroup undo nil
282 "Undoing changes in buffers."
283 :group 'editing)
284
285 (defgroup modeline nil
286 "Content of the modeline."
287 :group 'environment)
288
289 (defgroup fill nil
290 "Indenting and filling text."
291 :group 'editing)
292
293 (defgroup editing-basics nil
294 "Most basic editing facilities."
295 :group 'editing)
296
297 (defgroup display nil
298 "How characters are displayed in buffers."
299 :group 'environment)
300
301 (defgroup execute nil
302 "Executing external commands."
303 :group 'processes)
304
305 (defgroup installation nil
306 "The Emacs installation."
307 :group 'environment)
308
309 (defgroup dired nil
310 "Directory editing."
311 :group 'environment)
312
313 (defgroup limits nil
314 "Internal Emacs limits."
315 :group 'internal)
316
317 (defgroup debug nil
318 "Debugging Emacs itself."
319 :group 'development)
320
321 (defgroup minibuffer nil
322 "Controling the behaviour of the minibuffer."
323 :group 'environment)
324
325 (defgroup keyboard nil
326 "Input from the keyboard."
327 :group 'environment)
328
329 (defgroup mouse nil
330 "Input from the mouse."
331 :group 'environment)
332
333 (defgroup menu nil
334 "Input from the menus."
335 :group 'environment)
336
337 (defgroup auto-save nil
338 "Preventing accidential loss of data."
339 :group 'files)
340
341 (defgroup processes-basics nil
342 "Basic stuff dealing with processes."
343 :group 'processes)
344
345 (defgroup mule nil
346 "MULE Emacs internationalization."
347 :group 'i18n)
348
349 (defgroup windows nil
350 "Windows within a frame."
351 :group 'environment)
352
353 ;;; Utilities.
354
355 (defun custom-quote (sexp)
356 "Quote SEXP iff it is not self quoting."
357 (if (or (memq sexp '(t nil))
358 (keywordp sexp)
359 (and (listp sexp)
360 (memq (car sexp) '(lambda)))
361 (stringp sexp)
362 (numberp sexp)
363 (vectorp sexp)
364 ;;; (and (fboundp 'characterp)
365 ;;; (characterp sexp))
366 )
367 sexp
368 (list 'quote sexp)))
369
370 (defun custom-split-regexp-maybe (regexp)
371 "If REGEXP is a string, split it to a list at `\\|'.
372 You can get the original back with from the result with:
373 (mapconcat 'identity result \"\\|\")
374
375 IF REGEXP is not a string, return it unchanged."
376 (if (stringp regexp)
377 (let ((start 0)
378 all)
379 (while (string-match "\\\\|" regexp start)
380 (setq all (cons (substring regexp start (match-beginning 0)) all)
381 start (match-end 0)))
382 (nreverse (cons (substring regexp start) all)))
383 regexp))
384
385 (defun custom-variable-prompt ()
386 "Prompt for a variable, defaulting to the variable at point.
387 Return a list suitable for use in `interactive'."
388 (let ((v (variable-at-point))
389 (enable-recursive-minibuffers t)
390 val)
391 (setq val (completing-read
392 (if (symbolp v)
393 (format "Customize option: (default %s) " v)
394 "Customize variable: ")
395 obarray (lambda (symbol)
396 (and (boundp symbol)
397 (or (get symbol 'custom-type)
398 (get symbol 'custom-loads)
399 (get symbol 'standard-value)))) t))
400 (list (if (equal val "")
401 (if (symbolp v) v nil)
402 (intern val)))))
403
404 (defun custom-menu-filter (menu widget)
405 "Convert MENU to the form used by `widget-choose'.
406 MENU should be in the same format as `custom-variable-menu'.
407 WIDGET is the widget to apply the filter entries of MENU on."
408 (let ((result nil)
409 current name action filter)
410 (while menu
411 (setq current (car menu)
412 name (nth 0 current)
413 action (nth 1 current)
414 filter (nth 2 current)
415 menu (cdr menu))
416 (if (or (null filter) (funcall filter widget))
417 (push (cons name action) result)
418 (push name result)))
419 (nreverse result)))
420
421 ;;; Unlispify.
422
423 (defvar custom-prefix-list nil
424 "List of prefixes that should be ignored by `custom-unlispify'.")
425
426 (defcustom custom-unlispify-menu-entries t
427 "Display menu entries as words instead of symbols if non nil."
428 :group 'custom-menu
429 :type 'boolean)
430
431 (defcustom custom-unlispify-remove-prefixes nil
432 "Non-nil means remove group prefixes from option names in buffer."
433 :group 'custom-menu
434 :type 'boolean)
435
436 (defun custom-unlispify-menu-entry (symbol &optional no-suffix)
437 "Convert SYMBOL into a menu entry."
438 (cond ((not custom-unlispify-menu-entries)
439 (symbol-name symbol))
440 ((get symbol 'custom-tag)
441 (if no-suffix
442 (get symbol 'custom-tag)
443 (concat (get symbol 'custom-tag) "...")))
444 (t
445 (save-excursion
446 (set-buffer (get-buffer-create " *Custom-Work*"))
447 (erase-buffer)
448 (princ symbol (current-buffer))
449 (goto-char (point-min))
450 (when (and (eq (get symbol 'custom-type) 'boolean)
451 (re-search-forward "-p\\'" nil t))
452 (replace-match "" t t)
453 (goto-char (point-min)))
454 (if custom-unlispify-remove-prefixes
455 (let ((prefixes custom-prefix-list)
456 prefix)
457 (while prefixes
458 (setq prefix (car prefixes))
459 (if (search-forward prefix (+ (point) (length prefix)) t)
460 (progn
461 (setq prefixes nil)
462 (delete-region (point-min) (point)))
463 (setq prefixes (cdr prefixes))))))
464 (subst-char-in-region (point-min) (point-max) ?- ?\ t)
465 (capitalize-region (point-min) (point-max))
466 (unless no-suffix
467 (goto-char (point-max))
468 (insert "..."))
469 (buffer-string)))))
470
471 (defcustom custom-unlispify-tag-names t
472 "Display tag names as words instead of symbols if non nil."
473 :group 'custom-buffer
474 :type 'boolean)
475
476 (defun custom-unlispify-tag-name (symbol)
477 "Convert SYMBOL into a menu entry."
478 (let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
479 (custom-unlispify-menu-entry symbol t)))
480
481 (defun custom-prefix-add (symbol prefixes)
482 "Add SYMBOL to list of ignored PREFIXES."
483 (cons (or (get symbol 'custom-prefix)
484 (concat (symbol-name symbol) "-"))
485 prefixes))
486
487 ;;; Guess.
488
489 (defcustom custom-guess-name-alist
490 '(("-p\\'" boolean)
491 ("-hook\\'" hook)
492 ("-face\\'" face)
493 ("-file\\'" file)
494 ("-function\\'" function)
495 ("-functions\\'" (repeat function))
496 ("-list\\'" (repeat sexp))
497 ("-alist\\'" (repeat (cons sexp sexp))))
498 "Alist of (MATCH TYPE).
499
500 MATCH should be a regexp matching the name of a symbol, and TYPE should
501 be a widget suitable for editing the value of that symbol. The TYPE
502 of the first entry where MATCH matches the name of the symbol will be
503 used.
504
505 This is used for guessing the type of variables not declared with
506 customize."
507 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
508 :group 'customize)
509
510 (defcustom custom-guess-doc-alist
511 '(("\\`\\*?Non-nil " boolean))
512 "Alist of (MATCH TYPE).
513
514 MATCH should be a regexp matching a documentation string, and TYPE
515 should be a widget suitable for editing the value of a variable with
516 that documentation string. The TYPE of the first entry where MATCH
517 matches the name of the symbol will be used.
518
519 This is used for guessing the type of variables not declared with
520 customize."
521 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
522 :group 'customize)
523
524 (defun custom-guess-type (symbol)
525 "Guess a widget suitable for editing the value of SYMBOL.
526 This is done by matching SYMBOL with `custom-guess-name-alist' and
527 if that fails, the doc string with `custom-guess-doc-alist'."
528 (let ((name (symbol-name symbol))
529 (names custom-guess-name-alist)
530 current found)
531 (while names
532 (setq current (car names)
533 names (cdr names))
534 (when (string-match (nth 0 current) name)
535 (setq found (nth 1 current)
536 names nil)))
537 (unless found
538 (let ((doc (documentation-property symbol 'variable-documentation))
539 (docs custom-guess-doc-alist))
540 (when doc
541 (while docs
542 (setq current (car docs)
543 docs (cdr docs))
544 (when (string-match (nth 0 current) doc)
545 (setq found (nth 1 current)
546 docs nil))))))
547 found))
548
549 ;;; Sorting.
550
551 (defcustom custom-browse-sort-alphabetically nil
552 "If non-nil, sort members of each customization group alphabetically."
553 :type 'boolean
554 :group 'custom-browse)
555
556 (defcustom custom-browse-order-groups nil
557 "If non-nil, order group members within each customization group.
558 If `first', order groups before non-groups.
559 If `last', order groups after non-groups."
560 :type '(choice (const first)
561 (const last)
562 (const :tag "none" nil))
563 :group 'custom-browse)
564
565 (defcustom custom-browse-only-groups nil
566 "If non-nil, show group members only within each customization group."
567 :type 'boolean
568 :group 'custom-browse)
569
570 (defcustom custom-buffer-sort-alphabetically nil
571 "If non-nil, sort members of each customization group alphabetically."
572 :type 'boolean
573 :group 'custom-buffer)
574
575 (defcustom custom-buffer-order-groups 'last
576 "If non-nil, order group members within each customization group.
577 If `first', order groups before non-groups.
578 If `last', order groups after non-groups."
579 :type '(choice (const first)
580 (const last)
581 (const :tag "none" nil))
582 :group 'custom-buffer)
583
584 (defcustom custom-menu-sort-alphabetically nil
585 "If non-nil, sort members of each customization group alphabetically."
586 :type 'boolean
587 :group 'custom-menu)
588
589 (defcustom custom-menu-order-groups 'first
590 "If non-nil, order group members within each customization group.
591 If `first', order groups before non-groups.
592 If `last', order groups after non-groups."
593 :type '(choice (const first)
594 (const last)
595 (const :tag "none" nil))
596 :group 'custom-menu)
597
598 ;;;###autoload (add-hook 'same-window-regexps "\\`\\*Customiz.*\\*\\'")
599
600 (defun custom-sort-items (items sort-alphabetically order-groups)
601 "Return a sorted copy of ITEMS.
602 ITEMS should be a `custom-group' property.
603 If SORT-ALPHABETICALLY non-nil, sort alphabetically.
604 If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
605 groups after non-groups, if nil do not order groups at all."
606 (sort (copy-sequence items)
607 (lambda (a b)
608 (let ((typea (nth 1 a)) (typeb (nth 1 b))
609 (namea (nth 0 a)) (nameb (nth 0 b)))
610 (cond ((not order-groups)
611 ;; Since we don't care about A and B order, maybe sort.
612 (when sort-alphabetically
613 (string-lessp namea nameb)))
614 ((eq typea 'custom-group)
615 ;; If B is also a group, maybe sort. Otherwise, order A and B.
616 (if (eq typeb 'custom-group)
617 (when sort-alphabetically
618 (string-lessp namea nameb))
619 (eq order-groups 'first)))
620 ((eq typeb 'custom-group)
621 ;; Since A cannot be a group, order A and B.
622 (eq order-groups 'last))
623 (sort-alphabetically
624 ;; Since A and B cannot be groups, sort.
625 (string-lessp namea nameb)))))))
626
627 ;;; Custom Mode Commands.
628
629 (defvar custom-options nil
630 "Customization widgets in the current buffer.")
631
632 (defun Custom-set ()
633 "Set changes in all modified options."
634 (interactive)
635 (let ((children custom-options))
636 (mapc (lambda (child)
637 (when (eq (widget-get child :custom-state) 'modified)
638 (widget-apply child :custom-set)))
639 children)))
640
641 (defun Custom-save ()
642 "Set all modified group members and save them."
643 (interactive)
644 (let ((children custom-options))
645 (mapc (lambda (child)
646 (when (memq (widget-get child :custom-state)
647 '(modified set changed rogue))
648 (widget-apply child :custom-save)))
649 children))
650 (custom-save-all))
651
652 (defvar custom-reset-menu
653 '(("Current" . Custom-reset-current)
654 ("Saved" . Custom-reset-saved)
655 ("Erase Customization (use standard settings)" . Custom-reset-standard))
656 "Alist of actions for the `Reset' button.
657 The key is a string containing the name of the action, the value is a
658 Lisp function taking the widget as an element which will be called
659 when the action is chosen.")
660
661 (defun custom-reset (event)
662 "Select item from reset menu."
663 (let* ((completion-ignore-case t)
664 (answer (widget-choose "Reset to"
665 custom-reset-menu
666 event)))
667 (if answer
668 (funcall answer))))
669
670 (defun Custom-reset-current (&rest ignore)
671 "Reset all modified group members to their current value."
672 (interactive)
673 (let ((children custom-options))
674 (mapc (lambda (widget)
675 (and (default-boundp (widget-value widget))
676 (if (memq (widget-get widget :custom-state)
677 '(modified changed))
678 (widget-apply widget :custom-reset-current))))
679 children)))
680
681 (defun Custom-reset-saved (&rest ignore)
682 "Reset all modified or set group members to their saved value."
683 (interactive)
684 (let ((children custom-options))
685 (mapc (lambda (widget)
686 (and (get (widget-value widget) 'saved-value)
687 (if (memq (widget-get widget :custom-state)
688 '(modified set changed rogue))
689 (widget-apply widget :custom-reset-saved))))
690 children)))
691
692 (defun Custom-reset-standard (&rest ignore)
693 "Erase all customization (either current or saved) for the group members.
694 The immediate result is to restore them to their standard settings.
695 This operation eliminates any saved settings for the group members,
696 making them as if they had never been customized at all."
697 (interactive)
698 (let ((children custom-options))
699 (mapc (lambda (widget)
700 (and (get (widget-value widget) 'standard-value)
701 (if (memq (widget-get widget :custom-state)
702 '(modified set changed saved rogue))
703 (widget-apply widget :custom-reset-standard))))
704 children)))
705
706 ;;; The Customize Commands
707
708 (defun custom-prompt-variable (prompt-var prompt-val &optional comment)
709 "Prompt for a variable and a value and return them as a list.
710 PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
711 prompt for the value. The %s escape in PROMPT-VAL is replaced with
712 the name of the variable.
713
714 If the variable has a `variable-interactive' property, that is used as if
715 it were the arg to `interactive' (which see) to interactively read the value.
716
717 If the variable has a `custom-type' property, it must be a widget and the
718 `:prompt-value' property of that widget will be used for reading the value.
719
720 If optional COMMENT argument is non nil, also prompt for a comment and return
721 it as the third element in the list."
722 (let* ((var (read-variable prompt-var))
723 (minibuffer-help-form '(describe-variable var))
724 (val
725 (let ((prop (get var 'variable-interactive))
726 (type (get var 'custom-type))
727 (prompt (format prompt-val var)))
728 (unless (listp type)
729 (setq type (list type)))
730 (cond (prop
731 ;; Use VAR's `variable-interactive' property
732 ;; as an interactive spec for prompting.
733 (call-interactively (list 'lambda '(arg)
734 (list 'interactive prop)
735 'arg)))
736 (type
737 (widget-prompt-value type
738 prompt
739 (if (boundp var)
740 (symbol-value var))
741 (not (boundp var))))
742 (t
743 (eval-minibuffer prompt))))))
744 (if comment
745 (list var val
746 (read-string "Comment: " (get var 'variable-comment)))
747 (list var val))))
748
749 ;;;###autoload
750 (defun customize-set-value (var val &optional comment)
751 "Set VARIABLE to VALUE. VALUE is a Lisp object.
752
753 If VARIABLE has a `variable-interactive' property, that is used as if
754 it were the arg to `interactive' (which see) to interactively read the value.
755
756 If VARIABLE has a `custom-type' property, it must be a widget and the
757 `:prompt-value' property of that widget will be used for reading the value.
758
759 If given a prefix (or a COMMENT argument), also prompt for a comment."
760 (interactive (custom-prompt-variable "Set variable: "
761 "Set %s to value: "
762 current-prefix-arg))
763
764 (set var val)
765 (cond ((string= comment "")
766 (put var 'variable-comment nil))
767 (comment
768 (put var 'variable-comment comment))))
769
770 ;;;###autoload
771 (defun customize-set-variable (variable value &optional comment)
772 "Set the default for VARIABLE to VALUE. VALUE is a Lisp object.
773
774 If VARIABLE has a `custom-set' property, that is used for setting
775 VARIABLE, otherwise `set-default' is used.
776
777 The `customized-value' property of the VARIABLE will be set to a list
778 with a quoted VALUE as its sole list member.
779
780 If VARIABLE has a `variable-interactive' property, that is used as if
781 it were the arg to `interactive' (which see) to interactively read the value.
782
783 If VARIABLE has a `custom-type' property, it must be a widget and the
784 `:prompt-value' property of that widget will be used for reading the value.
785
786 If given a prefix (or a COMMENT argument), also prompt for a comment."
787 (interactive (custom-prompt-variable "Set variable: "
788 "Set customized value for %s to: "
789 current-prefix-arg))
790 (funcall (or (get variable 'custom-set) 'set-default) variable value)
791 (put variable 'customized-value (list (custom-quote value)))
792 (cond ((string= comment "")
793 (put variable 'variable-comment nil)
794 (put variable 'customized-variable-comment nil))
795 (comment
796 (put variable 'variable-comment comment)
797 (put variable 'customized-variable-comment comment))))
798
799 ;;;###autoload
800 (defun customize-save-variable (var value &optional comment)
801 "Set the default for VARIABLE to VALUE, and save it for future sessions.
802 If VARIABLE has a `custom-set' property, that is used for setting
803 VARIABLE, otherwise `set-default' is used.
804
805 The `customized-value' property of the VARIABLE will be set to a list
806 with a quoted VALUE as its sole list member.
807
808 If VARIABLE has a `variable-interactive' property, that is used as if
809 it were the arg to `interactive' (which see) to interactively read the value.
810
811 If VARIABLE has a `custom-type' property, it must be a widget and the
812 `:prompt-value' property of that widget will be used for reading the value.
813
814 If given a prefix (or a COMMENT argument), also prompt for a comment."
815 (interactive (custom-prompt-variable "Set and ave variable: "
816 "Set and save value for %s as: "
817 current-prefix-arg))
818 (funcall (or (get var 'custom-set) 'set-default) var value)
819 (put var 'saved-value (list (custom-quote value)))
820 (cond ((string= comment "")
821 (put var 'variable-comment nil)
822 (put var 'saved-variable-comment nil))
823 (comment
824 (put var 'variable-comment comment)
825 (put var 'saved-variable-comment comment)))
826 (custom-save-all))
827
828 ;;;###autoload
829 (defun customize ()
830 "Select a customization buffer which you can use to set user options.
831 User options are structured into \"groups\".
832 Initially the top-level group `Emacs' and its immediate subgroups
833 are shown; the contents of those subgroups are initially hidden."
834 (interactive)
835 (customize-group 'emacs))
836
837 ;;;###autoload
838 (defun customize-group (group)
839 "Customize GROUP, which must be a customization group."
840 (interactive (list (let ((completion-ignore-case t))
841 (completing-read "Customize group: (default emacs) "
842 obarray
843 (lambda (symbol)
844 (or (get symbol 'custom-loads)
845 (get symbol 'custom-group)))
846 t))))
847 (when (stringp group)
848 (if (string-equal "" group)
849 (setq group 'emacs)
850 (setq group (intern group))))
851 (or (get group 'custom-group)
852 (custom-load-symbol group))
853 (let ((name (format "*Customize Group: %s*"
854 (custom-unlispify-tag-name group))))
855 (if (get-buffer name)
856 (pop-to-buffer name)
857 (custom-buffer-create (list (list group 'custom-group))
858 name
859 (concat " for group "
860 (custom-unlispify-tag-name group))))))
861
862 ;;;###autoload
863 (defun customize-group-other-window (group)
864 "Customize GROUP, which must be a customization group."
865 (interactive (list (let ((completion-ignore-case t))
866 (completing-read "Customize group: (default emacs) "
867 obarray
868 (lambda (symbol)
869 (or (get symbol 'custom-loads)
870 (get symbol 'custom-group)))
871 t))))
872 (when (stringp group)
873 (if (string-equal "" group)
874 (setq group 'emacs)
875 (setq group (intern group))))
876 (or (get group 'custom-group)
877 (custom-load-symbol group))
878 (let ((name (format "*Customize Group: %s*"
879 (custom-unlispify-tag-name group))))
880 (if (get-buffer name)
881 (let ((window (selected-window)))
882 (pop-to-buffer name)
883 (select-window window))
884 (custom-buffer-create-other-window
885 (list (list group 'custom-group))
886 name
887 (concat " for group "
888 (custom-unlispify-tag-name group))))))
889
890 ;;;###autoload
891 (defalias 'customize-variable 'customize-option)
892
893 ;;;###autoload
894 (defun customize-option (symbol)
895 "Customize SYMBOL, which must be a user option variable."
896 (interactive (custom-variable-prompt))
897 ;; If we don't have SYMBOL's real definition loaded,
898 ;; try to load it.
899 (unless (get symbol 'custom-type)
900 (let ((loaddefs-file (locate-library "loaddefs.el" t))
901 file)
902 ;; See if it is autoloaded from some library.
903 (when loaddefs-file
904 (with-temp-buffer
905 (insert-file-contents loaddefs-file)
906 (when (re-search-forward (concat "^(defvar " (symbol-name symbol))
907 nil t)
908 (search-backward "\n;;; Generated autoloads from ")
909 (goto-char (match-end 0))
910 (setq file (buffer-substring (point)
911 (progn (end-of-line) (point)))))))
912 ;; If it is, load that library.
913 (when file
914 (when (string-match "\\.el\\'" file)
915 (setq file (substring file 0 (match-beginning 0))))
916 (load file))))
917 (unless (get symbol 'custom-type)
918 (error "Variable %s cannot be customized" symbol))
919 (custom-buffer-create (list (list symbol 'custom-variable))
920 (format "*Customize Option: %s*"
921 (custom-unlispify-tag-name symbol))))
922
923 (defvar customize-changed-options-previous-release "20.2"
924 "Version for `customize-changed-options' to refer back to by default.")
925
926 ;;;###autoload
927 (defun customize-changed-options (since-version)
928 "Customize all user option variables changed in Emacs itself.
929 This includes new user option variables and faces, and new
930 customization groups, as well as older options and faces whose default
931 values have changed since the previous major Emacs release.
932
933 With argument SINCE-VERSION (a string), customize all user option
934 variables that were added (or their meanings were changed) since that
935 version."
936
937 (interactive "sCustomize options changed, since version (default all versions): ")
938 (if (equal since-version "")
939 (setq since-version nil)
940 (unless (condition-case nil
941 (numberp (read since-version))
942 (error nil))
943 (signal 'wrong-type-argument (list 'numberp since-version))))
944 (unless since-version
945 (setq since-version customize-changed-options-previous-release))
946 (let ((found nil)
947 (versions nil))
948 (mapatoms (lambda (symbol)
949 (and (or (boundp symbol)
950 ;; For variables not yet loaded.
951 (get symbol 'standard-value)
952 ;; For groups the previous test fails, this one
953 ;; could be used to determine if symbol is a
954 ;; group. Is there a better way for this?
955 (get symbol 'group-documentation))
956 (let ((version (get symbol 'custom-version)))
957 (and version
958 (or (null since-version)
959 (customize-version-lessp since-version version))
960 (if (member version versions)
961 t
962 ;;; Collect all versions that we use.
963 (push version versions))))
964 (setq found
965 ;; We have to set the right thing here,
966 ;; depending if we have a group or a
967 ;; variable.
968 (if (get symbol 'group-documentation)
969 (cons (list symbol 'custom-group) found)
970 (cons (list symbol 'custom-variable) found))))))
971 (if (not found)
972 (error "No user option defaults have been changed since Emacs %s"
973 since-version)
974 (let ((flist nil))
975 (while versions
976 (push (copy-sequence
977 (cdr (assoc (car versions) custom-versions-load-alist)))
978 flist)
979 (setq versions (cdr versions)))
980 (put 'custom-versions-load-alist 'custom-loads
981 ;; Get all the files that correspond to element from the
982 ;; VERSIONS list. This could use some simplification.
983 (apply 'nconc flist)))
984 ;; Because we set all the files needed to be loaded as a
985 ;; `custom-loads' property to `custom-versions-load-alist' this
986 ;; call will actually load them.
987 (custom-load-symbol 'custom-versions-load-alist)
988 ;; Clean up
989 (put 'custom-versions-load-alist 'custom-loads nil)
990 (custom-buffer-create (custom-sort-items found t 'first)
991 "*Customize Changed Options*"))))
992
993 (defun customize-version-lessp (version1 version2)
994 ;; Why are the versions strings, and given that they are, why aren't
995 ;; they converted to numbers and compared as such here? -- fx
996
997 ;; In case someone made a mistake and left out the quotes
998 ;; in the :version value.
999 (if (numberp version2)
1000 (setq version2 (prin1-to-string version2)))
1001 (let (major1 major2 minor1 minor2)
1002 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version1)
1003 (setq major1 (read (or (match-string 1 version1)
1004 "0")))
1005 (setq minor1 (read (or (match-string 3 version1)
1006 "0")))
1007 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version2)
1008 (setq major2 (read (or (match-string 1 version2)
1009 "0")))
1010 (setq minor2 (read (or (match-string 3 version2)
1011 "0")))
1012 (or (< major1 major2)
1013 (and (= major1 major2)
1014 (< minor1 minor2)))))
1015
1016 ;;;###autoload
1017 (defalias 'customize-variable-other-window 'customize-option-other-window)
1018
1019 ;;;###autoload
1020 (defun customize-option-other-window (symbol)
1021 "Customize SYMBOL, which must be a user option variable.
1022 Show the buffer in another window, but don't select it."
1023 (interactive (custom-variable-prompt))
1024 (custom-buffer-create-other-window
1025 (list (list symbol 'custom-variable))
1026 (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
1027
1028 ;;;###autoload
1029 (defun customize-face (&optional symbol)
1030 "Customize SYMBOL, which should be a face name or nil.
1031 If SYMBOL is nil, customize all faces."
1032 (interactive (list (completing-read "Customize face: (default all) "
1033 obarray 'custom-facep t)))
1034 (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
1035 (custom-buffer-create (custom-sort-items
1036 (mapcar (lambda (symbol)
1037 (list symbol 'custom-face))
1038 (face-list))
1039 t nil)
1040 "*Customize Faces*")
1041 (when (stringp symbol)
1042 (setq symbol (intern symbol)))
1043 (unless (symbolp symbol)
1044 (error "Should be a symbol %S" symbol))
1045 (custom-buffer-create (list (list symbol 'custom-face))
1046 (format "*Customize Face: %s*"
1047 (custom-unlispify-tag-name symbol)))))
1048
1049 ;;;###autoload
1050 (defun customize-face-other-window (&optional symbol)
1051 "Show customization buffer for face SYMBOL in other window."
1052 (interactive (list (completing-read "Customize face: "
1053 obarray 'custom-facep t)))
1054 (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
1055 ()
1056 (if (stringp symbol)
1057 (setq symbol (intern symbol)))
1058 (unless (symbolp symbol)
1059 (error "Should be a symbol %S" symbol))
1060 (custom-buffer-create-other-window
1061 (list (list symbol 'custom-face))
1062 (format "*Customize Face: %s*" (custom-unlispify-tag-name symbol)))))
1063
1064 ;;;###autoload
1065 (defun customize-customized ()
1066 "Customize all user options set since the last save in this session."
1067 (interactive)
1068 (let ((found nil))
1069 (mapatoms (lambda (symbol)
1070 (and (or (get symbol 'customized-face)
1071 (get symbol 'customized-face-comment))
1072 (custom-facep symbol)
1073 (push (list symbol 'custom-face) found))
1074 (and (or (get symbol 'customized-value)
1075 (get symbol 'customized-variable-comment))
1076 (boundp symbol)
1077 (push (list symbol 'custom-variable) found))))
1078 (if (not found)
1079 (error "No customized user options")
1080 (custom-buffer-create (custom-sort-items found t nil)
1081 "*Customize Customized*"))))
1082
1083 ;;;###autoload
1084 (defun customize-saved ()
1085 "Customize all already saved user options."
1086 (interactive)
1087 (let ((found nil))
1088 (mapatoms (lambda (symbol)
1089 (and (or (get symbol 'saved-face)
1090 (get symbol 'saved-face-comment))
1091 (custom-facep symbol)
1092 (push (list symbol 'custom-face) found))
1093 (and (or (get symbol 'saved-value)
1094 (get symbol 'saved-variable-comment))
1095 (boundp symbol)
1096 (push (list symbol 'custom-variable) found))))
1097 (if (not found )
1098 (error "No saved user options")
1099 (custom-buffer-create (custom-sort-items found t nil)
1100 "*Customize Saved*"))))
1101
1102 ;;;###autoload
1103 (defun customize-apropos (regexp &optional all)
1104 "Customize all user options matching REGEXP.
1105 If ALL is `options', include only options.
1106 If ALL is `faces', include only faces.
1107 If ALL is `groups', include only groups.
1108 If ALL is t (interactively, with prefix arg), include options which are not
1109 user-settable, as well as faces and groups."
1110 (interactive "sCustomize regexp: \nP")
1111 (let ((found nil))
1112 (mapatoms (lambda (symbol)
1113 (when (string-match regexp (symbol-name symbol))
1114 (when (and (not (memq all '(faces options)))
1115 (get symbol 'custom-group))
1116 (push (list symbol 'custom-group) found))
1117 (when (and (not (memq all '(options groups)))
1118 (custom-facep symbol))
1119 (push (list symbol 'custom-face) found))
1120 (when (and (not (memq all '(groups faces)))
1121 (boundp symbol)
1122 (or (get symbol 'saved-value)
1123 (get symbol 'standard-value)
1124 (if (memq all '(nil options))
1125 (user-variable-p symbol)
1126 (get symbol 'variable-documentation))))
1127 (push (list symbol 'custom-variable) found)))))
1128 (if (not found)
1129 (error "No matches")
1130 (custom-buffer-create (custom-sort-items found t
1131 custom-buffer-order-groups)
1132 "*Customize Apropos*"))))
1133
1134 ;;;###autoload
1135 (defun customize-apropos-options (regexp &optional arg)
1136 "Customize all user options matching REGEXP.
1137 With prefix arg, include options which are not user-settable."
1138 (interactive "sCustomize regexp: \nP")
1139 (customize-apropos regexp (or arg 'options)))
1140
1141 ;;;###autoload
1142 (defun customize-apropos-faces (regexp)
1143 "Customize all user faces matching REGEXP."
1144 (interactive "sCustomize regexp: \n")
1145 (customize-apropos regexp 'faces))
1146
1147 ;;;###autoload
1148 (defun customize-apropos-groups (regexp)
1149 "Customize all user groups matching REGEXP."
1150 (interactive "sCustomize regexp: \n")
1151 (customize-apropos regexp 'groups))
1152
1153 ;;; Buffer.
1154
1155 (defcustom custom-buffer-style 'links
1156 "Control the presentation style for customization buffers.
1157 The value should be a symbol, one of:
1158
1159 brackets: groups nest within each other with big horizontal brackets.
1160 links: groups have links to subgroups."
1161 :type '(radio (const brackets)
1162 (const links))
1163 :group 'custom-buffer)
1164
1165 ;; If we pass BUFFER to `bury-buffer', the buffer isn't removed from
1166 ;; the window.
1167 (defun custom-bury-buffer (buffer)
1168 (bury-buffer))
1169
1170 (defcustom custom-buffer-done-function 'custom-bury-buffer
1171 "*Function called to remove a Custom buffer when the user is done with it.
1172 Called with one argument, the buffer to remove."
1173 :type '(choice (function-item :tag "Bury buffer" custom-bury-buffer)
1174 (function-item :tag "Kill buffer" kill-buffer)
1175 (function :tag "Other"))
1176 :version "21.1"
1177 :group 'custom-buffer)
1178
1179 (defcustom custom-buffer-indent 3
1180 "Number of spaces to indent nested groups."
1181 :type 'integer
1182 :group 'custom-buffer)
1183
1184 ;;;###autoload
1185 (defun custom-buffer-create (options &optional name description)
1186 "Create a buffer containing OPTIONS.
1187 Optional NAME is the name of the buffer.
1188 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1189 SYMBOL is a customization option, and WIDGET is a widget for editing
1190 that option."
1191 (unless name (setq name "*Customization*"))
1192 (kill-buffer (get-buffer-create name))
1193 (pop-to-buffer (get-buffer-create name))
1194 (custom-buffer-create-internal options description))
1195
1196 ;;;###autoload
1197 (defun custom-buffer-create-other-window (options &optional name description)
1198 "Create a buffer containing OPTIONS.
1199 Optional NAME is the name of the buffer.
1200 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1201 SYMBOL is a customization option, and WIDGET is a widget for editing
1202 that option."
1203 (unless name (setq name "*Customization*"))
1204 (kill-buffer (get-buffer-create name))
1205 (let ((window (selected-window))
1206 (pop-up-windows t)
1207 (special-display-buffer-names nil)
1208 (special-display-regexps nil)
1209 (same-window-buffer-names nil)
1210 (same-window-regexps nil))
1211 (pop-to-buffer (get-buffer-create name))
1212 (custom-buffer-create-internal options description)
1213 (select-window window)))
1214
1215 (defcustom custom-reset-button-menu nil
1216 "If non-nil, only show a single reset button in customize buffers.
1217 This button will have a menu with all three reset operations."
1218 :type 'boolean
1219 :group 'custom-buffer)
1220
1221 (defun Custom-buffer-done (&rest ignore)
1222 "Remove current buffer by calling `custom-buffer-done-function'."
1223 (interactive)
1224 (funcall custom-buffer-done-function (current-buffer)))
1225
1226 (defcustom custom-raised-buttons (not (equal (face-valid-attribute-values :box)
1227 '(("unspecified" . unspecified))))
1228 "If non-nil, indicate active buttons in a `raised-button' style.
1229 Otherwise use brackets."
1230 :type 'boolean
1231 :version "21.1"
1232 :group 'custom-buffer)
1233
1234 (defun custom-buffer-create-internal (options &optional description)
1235 (message "Creating customization buffer...")
1236 (custom-mode)
1237 (widget-insert "This is a customization buffer")
1238 (if description
1239 (widget-insert description))
1240 (widget-insert (format ".
1241 %s show active fields; type RET or click mouse-1
1242 on an active field to invoke its action. Editing an option value
1243 changes the text in the buffer; invoke the State button and
1244 choose the Set operation to set the option value.
1245 Invoke " (if custom-raised-buttons
1246 "`Raised' buttons"
1247 "Square brackets")))
1248 (widget-create 'info-link
1249 :tag "Help"
1250 :help-echo "Read the online help."
1251 "(emacs)Easy Customization")
1252 (widget-insert " for more information.\n\n")
1253 (message "Creating customization buttons...")
1254 (widget-insert "Operate on everything in this buffer:\n ")
1255 (widget-create 'push-button
1256 :tag "Set for Current Session"
1257 :help-echo "\
1258 Make your editing in this buffer take effect for this session."
1259 :action (lambda (widget &optional event)
1260 (Custom-set)))
1261 (widget-insert " ")
1262 (widget-create 'push-button
1263 :tag "Save for Future Sessions"
1264 :help-echo "\
1265 Make your editing in this buffer take effect for future Emacs sessions."
1266 :action (lambda (widget &optional event)
1267 (Custom-save)))
1268 (if custom-reset-button-menu
1269 (progn
1270 (widget-insert " ")
1271 (widget-create 'push-button
1272 :tag "Reset"
1273 :help-echo "Show a menu with reset operations."
1274 :mouse-down-action (lambda (&rest junk) t)
1275 :action (lambda (widget &optional event)
1276 (custom-reset event))))
1277 (widget-insert "\n ")
1278 (widget-create 'push-button
1279 :tag "Reset"
1280 :help-echo "\
1281 Reset all edited text in this buffer to reflect current values."
1282 :action 'Custom-reset-current)
1283 (widget-insert " ")
1284 (widget-create 'push-button
1285 :tag "Reset to Saved"
1286 :help-echo "\
1287 Reset all values in this buffer to their saved settings."
1288 :action 'Custom-reset-saved)
1289 (widget-insert " ")
1290 (widget-create 'push-button
1291 :tag "Erase Customization"
1292 :help-echo "\
1293 Un-customize all values in this buffer. They get their standard settings."
1294 :action 'Custom-reset-standard))
1295 (widget-insert " ")
1296 (widget-create 'push-button
1297 :tag "Finish"
1298 :help-echo
1299 (lambda (&rest ignore)
1300 (cond
1301 ((eq custom-buffer-done-function
1302 'custom-bury-buffer)
1303 "Bury this buffer")
1304 ((eq custom-buffer-done-function 'kill-buffer)
1305 "Kill this buffer")
1306 (t "Finish with this buffer")))
1307 :action #'Custom-buffer-done)
1308 (widget-insert "\n\n")
1309 (message "Creating customization items...")
1310 (buffer-disable-undo)
1311 (setq custom-options
1312 (if (= (length options) 1)
1313 (mapcar (lambda (entry)
1314 (widget-create (nth 1 entry)
1315 :documentation-shown t
1316 :custom-state 'unknown
1317 :tag (custom-unlispify-tag-name
1318 (nth 0 entry))
1319 :value (nth 0 entry)))
1320 options)
1321 (let ((count 0)
1322 (length (length options)))
1323 (mapcar (lambda (entry)
1324 (prog2
1325 (message "Creating customization items ...%2d%%"
1326 (/ (* 100.0 count) length))
1327 (widget-create (nth 1 entry)
1328 :tag (custom-unlispify-tag-name
1329 (nth 0 entry))
1330 :value (nth 0 entry))
1331 (setq count (1+ count))
1332 (unless (eq (preceding-char) ?\n)
1333 (widget-insert "\n"))
1334 (widget-insert "\n")))
1335 options))))
1336 (unless (eq (preceding-char) ?\n)
1337 (widget-insert "\n"))
1338 (message "Creating customization items ...done")
1339 (unless (eq custom-buffer-style 'tree)
1340 (mapc 'custom-magic-reset custom-options))
1341 (message "Creating customization setup...")
1342 (widget-setup)
1343 (buffer-enable-undo)
1344 (goto-char (point-min))
1345 (message "Creating customization buffer...done"))
1346
1347 ;;; The Tree Browser.
1348
1349 ;;;###autoload
1350 (defun customize-browse (&optional group)
1351 "Create a tree browser for the customize hierarchy."
1352 (interactive)
1353 (unless group
1354 (setq group 'emacs))
1355 (let ((name "*Customize Browser*"))
1356 (kill-buffer (get-buffer-create name))
1357 (pop-to-buffer (get-buffer-create name)))
1358 (custom-mode)
1359 (widget-insert "\
1360 Square brackets show active fields; type RET or click mouse-1
1361 on an active field to invoke its action.
1362 Invoke [+] below to expand a group, and [-] to collapse an expanded group.\n")
1363 (if custom-browse-only-groups
1364 (widget-insert "\
1365 Invoke the [Group] button below to edit that item in another window.\n\n")
1366 (widget-insert "Invoke the ")
1367 (widget-create 'item
1368 :format "%t"
1369 :tag "[Group]"
1370 :tag-glyph "folder")
1371 (widget-insert ", ")
1372 (widget-create 'item
1373 :format "%t"
1374 :tag "[Face]"
1375 :tag-glyph "face")
1376 (widget-insert ", and ")
1377 (widget-create 'item
1378 :format "%t"
1379 :tag "[Option]"
1380 :tag-glyph "option")
1381 (widget-insert " buttons below to edit that
1382 item in another window.\n\n"))
1383 (let ((custom-buffer-style 'tree))
1384 (widget-create 'custom-group
1385 :custom-last t
1386 :custom-state 'unknown
1387 :tag (custom-unlispify-tag-name group)
1388 :value group))
1389 (goto-char (point-min)))
1390
1391 (define-widget 'custom-browse-visibility 'item
1392 "Control visibility of items in the customize tree browser."
1393 :format "%[[%t]%]"
1394 :action 'custom-browse-visibility-action)
1395
1396 (defun custom-browse-visibility-action (widget &rest ignore)
1397 (let ((custom-buffer-style 'tree))
1398 (custom-toggle-parent widget)))
1399
1400 (define-widget 'custom-browse-group-tag 'push-button
1401 "Show parent in other window when activated."
1402 :tag "Group"
1403 :tag-glyph "folder"
1404 :action 'custom-browse-group-tag-action)
1405
1406 (defun custom-browse-group-tag-action (widget &rest ignore)
1407 (let ((parent (widget-get widget :parent)))
1408 (customize-group-other-window (widget-value parent))))
1409
1410 (define-widget 'custom-browse-variable-tag 'push-button
1411 "Show parent in other window when activated."
1412 :tag "Option"
1413 :tag-glyph "option"
1414 :action 'custom-browse-variable-tag-action)
1415
1416 (defun custom-browse-variable-tag-action (widget &rest ignore)
1417 (let ((parent (widget-get widget :parent)))
1418 (customize-variable-other-window (widget-value parent))))
1419
1420 (define-widget 'custom-browse-face-tag 'push-button
1421 "Show parent in other window when activated."
1422 :tag "Face"
1423 :tag-glyph "face"
1424 :action 'custom-browse-face-tag-action)
1425
1426 (defun custom-browse-face-tag-action (widget &rest ignore)
1427 (let ((parent (widget-get widget :parent)))
1428 (customize-face-other-window (widget-value parent))))
1429
1430 (defconst custom-browse-alist '((" " "space")
1431 (" | " "vertical")
1432 ("-\\ " "top")
1433 (" |-" "middle")
1434 (" `-" "bottom")))
1435
1436 (defun custom-browse-insert-prefix (prefix)
1437 "Insert PREFIX. On XEmacs convert it to line graphics."
1438 ;; Fixme: do graphics.
1439 (if nil ; (string-match "XEmacs" emacs-version)
1440 (progn
1441 (insert "*")
1442 (while (not (string-equal prefix ""))
1443 (let ((entry (substring prefix 0 3)))
1444 (setq prefix (substring prefix 3))
1445 (let ((overlay (make-overlay (1- (point)) (point) nil t nil))
1446 (name (nth 1 (assoc entry custom-browse-alist))))
1447 (overlay-put overlay 'end-glyph (widget-glyph-find name entry))
1448 (overlay-put overlay 'start-open t)
1449 (overlay-put overlay 'end-open t)))))
1450 (insert prefix)))
1451
1452 ;;; Modification of Basic Widgets.
1453 ;;
1454 ;; We add extra properties to the basic widgets needed here. This is
1455 ;; fine, as long as we are careful to stay within out own namespace.
1456 ;;
1457 ;; We want simple widgets to be displayed by default, but complex
1458 ;; widgets to be hidden.
1459
1460 (widget-put (get 'item 'widget-type) :custom-show t)
1461 (widget-put (get 'editable-field 'widget-type)
1462 :custom-show (lambda (widget value)
1463 (let ((pp (pp-to-string value)))
1464 (cond ((string-match "\n" pp)
1465 nil)
1466 ((> (length pp) 40)
1467 nil)
1468 (t t)))))
1469 (widget-put (get 'menu-choice 'widget-type) :custom-show t)
1470
1471 ;;; The `custom-manual' Widget.
1472
1473 (define-widget 'custom-manual 'info-link
1474 "Link to the manual entry for this customization option."
1475 :help-echo "Read the manual entry for this option."
1476 :tag "Manual")
1477
1478 ;;; The `custom-magic' Widget.
1479
1480 (defgroup custom-magic-faces nil
1481 "Faces used by the magic button."
1482 :group 'custom-faces
1483 :group 'custom-buffer)
1484
1485 (defface custom-invalid-face '((((class color))
1486 (:foreground "yellow" :background "red"))
1487 (t
1488 (:bold t :italic t :underline t)))
1489 "Face used when the customize item is invalid."
1490 :group 'custom-magic-faces)
1491
1492 (defface custom-rogue-face '((((class color))
1493 (:foreground "pink" :background "black"))
1494 (t
1495 (:underline t)))
1496 "Face used when the customize item is not defined for customization."
1497 :group 'custom-magic-faces)
1498
1499 (defface custom-modified-face '((((class color))
1500 (:foreground "white" :background "blue"))
1501 (t
1502 (:italic t :bold)))
1503 "Face used when the customize item has been modified."
1504 :group 'custom-magic-faces)
1505
1506 (defface custom-set-face '((((class color))
1507 (:foreground "blue" :background "white"))
1508 (t
1509 (:italic t)))
1510 "Face used when the customize item has been set."
1511 :group 'custom-magic-faces)
1512
1513 (defface custom-changed-face '((((class color))
1514 (:foreground "white" :background "blue"))
1515 (t
1516 (:italic t)))
1517 "Face used when the customize item has been changed."
1518 :group 'custom-magic-faces)
1519
1520 (defface custom-saved-face '((t (:underline t)))
1521 "Face used when the customize item has been saved."
1522 :group 'custom-magic-faces)
1523
1524 (defconst custom-magic-alist '((nil "#" underline "\
1525 uninitialized, you should not see this.")
1526 (unknown "?" italic "\
1527 unknown, you should not see this.")
1528 (hidden "-" default "\
1529 hidden, invoke \"Show\" in the previous line to show." "\
1530 group now hidden, invoke \"Show\", above, to show contents.")
1531 (invalid "x" custom-invalid-face "\
1532 the value displayed for this %c is invalid and cannot be set.")
1533 (modified "*" custom-modified-face "\
1534 you have edited the value as text, but you have not set the %c." "\
1535 you have edited something in this group, but not set it.")
1536 (set "+" custom-set-face "\
1537 you have set this %c, but not saved it for future sessions." "\
1538 something in this group has been set, but not saved.")
1539 (changed ":" custom-changed-face "\
1540 this %c has been changed outside the customize buffer." "\
1541 something in this group has been changed outside customize.")
1542 (saved "!" custom-saved-face "\
1543 this %c has been set and saved." "\
1544 something in this group has been set and saved.")
1545 (rogue "@" custom-rogue-face "\
1546 this %c has not been changed with customize." "\
1547 something in this group is not prepared for customization.")
1548 (standard " " nil "\
1549 this %c is unchanged from its standard setting." "\
1550 visible group members are all at standard settings."))
1551 "Alist of customize option states.
1552 Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where
1553
1554 STATE is one of the following symbols:
1555
1556 `nil'
1557 For internal use, should never occur.
1558 `unknown'
1559 For internal use, should never occur.
1560 `hidden'
1561 This item is not being displayed.
1562 `invalid'
1563 This item is modified, but has an invalid form.
1564 `modified'
1565 This item is modified, and has a valid form.
1566 `set'
1567 This item has been set but not saved.
1568 `changed'
1569 The current value of this item has been changed temporarily.
1570 `saved'
1571 This item is marked for saving.
1572 `rogue'
1573 This item has no customization information.
1574 `standard'
1575 This item is unchanged from the standard setting.
1576
1577 MAGIC is a string used to present that state.
1578
1579 FACE is a face used to present the state.
1580
1581 ITEM-DESC is a string describing the state for options.
1582
1583 GROUP-DESC is a string describing the state for groups. If this is
1584 left out, ITEM-DESC will be used.
1585
1586 The string %c in either description will be replaced with the
1587 category of the item. These are `group'. `option', and `face'.
1588
1589 The list should be sorted most significant first.")
1590
1591 (defcustom custom-magic-show 'long
1592 "If non-nil, show textual description of the state.
1593 If `long', show a full-line description, not just one word."
1594 :type '(choice (const :tag "no" nil)
1595 (const long)
1596 (other :tag "short" short))
1597 :group 'custom-buffer)
1598
1599 (defcustom custom-magic-show-hidden '(option face)
1600 "Control whether the State button is shown for hidden items.
1601 The value should be a list with the custom categories where the State
1602 button should be visible. Possible categories are `group', `option',
1603 and `face'."
1604 :type '(set (const group) (const option) (const face))
1605 :group 'custom-buffer)
1606
1607 (defcustom custom-magic-show-button nil
1608 "Show a \"magic\" button indicating the state of each customization option."
1609 :type 'boolean
1610 :group 'custom-buffer)
1611
1612 (define-widget 'custom-magic 'default
1613 "Show and manipulate state for a customization option."
1614 :format "%v"
1615 :action 'widget-parent-action
1616 :notify 'ignore
1617 :value-get 'ignore
1618 :value-create 'custom-magic-value-create
1619 :value-delete 'widget-children-value-delete)
1620
1621 (defun widget-magic-mouse-down-action (widget &optional event)
1622 ;; Non-nil unless hidden.
1623 (not (eq (widget-get (widget-get (widget-get widget :parent) :parent)
1624 :custom-state)
1625 'hidden)))
1626
1627 (defun custom-magic-value-create (widget)
1628 "Create compact status report for WIDGET."
1629 (let* ((parent (widget-get widget :parent))
1630 (state (widget-get parent :custom-state))
1631 (hidden (eq state 'hidden))
1632 (entry (assq state custom-magic-alist))
1633 (magic (nth 1 entry))
1634 (face (nth 2 entry))
1635 (category (widget-get parent :custom-category))
1636 (text (or (and (eq category 'group)
1637 (nth 4 entry))
1638 (nth 3 entry)))
1639 (form (widget-get parent :custom-form))
1640 children)
1641 (while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text)
1642 (setq text (concat (match-string 1 text)
1643 (symbol-name category)
1644 (match-string 2 text))))
1645 (when (and custom-magic-show
1646 (or (not hidden)
1647 (memq category custom-magic-show-hidden)))
1648 (insert " ")
1649 (when (and (eq category 'group)
1650 (not (and (eq custom-buffer-style 'links)
1651 (> (widget-get parent :custom-level) 1))))
1652 (insert-char ?\ (* custom-buffer-indent
1653 (widget-get parent :custom-level))))
1654 (push (widget-create-child-and-convert
1655 widget 'choice-item
1656 :help-echo "Change the state of this item."
1657 :format (if hidden "%t" "%[%t%]")
1658 :button-prefix 'widget-push-button-prefix
1659 :button-suffix 'widget-push-button-suffix
1660 :mouse-down-action 'widget-magic-mouse-down-action
1661 :tag "State")
1662 children)
1663 (insert ": ")
1664 (let ((start (point)))
1665 (if (eq custom-magic-show 'long)
1666 (insert text)
1667 (insert (symbol-name state)))
1668 (cond ((eq form 'lisp)
1669 (insert " (lisp)"))
1670 ((eq form 'mismatch)
1671 (insert " (mismatch)")))
1672 (put-text-property start (point) 'face 'custom-state-face))
1673 (insert "\n"))
1674 (when (and (eq category 'group)
1675 (not (and (eq custom-buffer-style 'links)
1676 (> (widget-get parent :custom-level) 1))))
1677 (insert-char ?\ (* custom-buffer-indent
1678 (widget-get parent :custom-level))))
1679 (when custom-magic-show-button
1680 (when custom-magic-show
1681 (let ((indent (widget-get parent :indent)))
1682 (when indent
1683 (insert-char ? indent))))
1684 (push (widget-create-child-and-convert
1685 widget 'choice-item
1686 :mouse-down-action 'widget-magic-mouse-down-action
1687 :button-face face
1688 :button-prefix ""
1689 :button-suffix ""
1690 :help-echo "Change the state."
1691 :format (if hidden "%t" "%[%t%]")
1692 :tag (if (memq form '(lisp mismatch))
1693 (concat "(" magic ")")
1694 (concat "[" magic "]")))
1695 children)
1696 (insert " "))
1697 (widget-put widget :children children)))
1698
1699 (defun custom-magic-reset (widget)
1700 "Redraw the :custom-magic property of WIDGET."
1701 (let ((magic (widget-get widget :custom-magic)))
1702 (widget-value-set magic (widget-value magic))))
1703
1704 ;;; The `custom' Widget.
1705
1706 (defface custom-button-face
1707 '((((type x w32 mac) (class color)) ; Like default modeline
1708 (:box (:line-width 2 :style released-button)
1709 :background "lightgrey" :foreground "black"))
1710 (t
1711 nil))
1712 "Face used for buttons in customization buffers."
1713 :version "21.1"
1714 :group 'custom-faces)
1715
1716 (defface custom-button-pressed-face
1717 '((((type x w32 mac) (class color))
1718 (:box (:line-width 2 :style pressed-button)
1719 :background "lightgrey" :foreground "black"))
1720 (t
1721 (:inverse-video t)))
1722 "Face used for buttons in customization buffers."
1723 :version "21.1"
1724 :group 'custom-faces)
1725
1726 (defface custom-documentation-face nil
1727 "Face used for documentation strings in customization buffers."
1728 :group 'custom-faces)
1729
1730 (defface custom-state-face '((((class color)
1731 (background dark))
1732 (:foreground "lime green"))
1733 (((class color)
1734 (background light))
1735 (:foreground "dark green"))
1736 (t nil))
1737 "Face used for State descriptions in the customize buffer."
1738 :group 'custom-faces)
1739
1740 (define-widget 'custom 'default
1741 "Customize a user option."
1742 :format "%v"
1743 :convert-widget 'custom-convert-widget
1744 :notify 'custom-notify
1745 :custom-prefix ""
1746 :custom-level 1
1747 :custom-state 'hidden
1748 :documentation-property 'widget-subclass-responsibility
1749 :value-create 'widget-subclass-responsibility
1750 :value-delete 'widget-children-value-delete
1751 :value-get 'widget-value-value-get
1752 :validate 'widget-children-validate
1753 :match (lambda (widget value) (symbolp value)))
1754
1755 (defun custom-convert-widget (widget)
1756 "Initialize :value and :tag from :args in WIDGET."
1757 (let ((args (widget-get widget :args)))
1758 (when args
1759 (widget-put widget :value (widget-apply widget
1760 :value-to-internal (car args)))
1761 (widget-put widget :tag (custom-unlispify-tag-name (car args)))
1762 (widget-put widget :args nil)))
1763 widget)
1764
1765 (defun custom-notify (widget &rest args)
1766 "Keep track of changes."
1767 (let ((state (widget-get widget :custom-state)))
1768 (unless (eq state 'modified)
1769 (unless (memq state '(nil unknown hidden))
1770 (widget-put widget :custom-state 'modified))
1771 (custom-magic-reset widget)
1772 (apply 'widget-default-notify widget args))))
1773
1774 (defun custom-redraw (widget)
1775 "Redraw WIDGET with current settings."
1776 (let ((line (count-lines (point-min) (point)))
1777 (column (current-column))
1778 (pos (point))
1779 (from (marker-position (widget-get widget :from)))
1780 (to (marker-position (widget-get widget :to))))
1781 (save-excursion
1782 (widget-value-set widget (widget-value widget))
1783 (custom-redraw-magic widget))
1784 (when (and (>= pos from) (<= pos to))
1785 (condition-case nil
1786 (progn
1787 (if (> column 0)
1788 (goto-line line)
1789 (goto-line (1+ line)))
1790 (move-to-column column))
1791 (error nil)))))
1792
1793 (defun custom-redraw-magic (widget)
1794 "Redraw WIDGET state with current settings."
1795 (while widget
1796 (let ((magic (widget-get widget :custom-magic)))
1797 (cond (magic
1798 (widget-value-set magic (widget-value magic))
1799 (when (setq widget (widget-get widget :group))
1800 (custom-group-state-update widget)))
1801 (t
1802 (setq widget nil)))))
1803 (widget-setup))
1804
1805 (defun custom-show (widget value)
1806 "Non-nil if WIDGET should be shown with VALUE by default."
1807 (let ((show (widget-get widget :custom-show)))
1808 (cond ((null show)
1809 nil)
1810 ((eq t show)
1811 t)
1812 (t
1813 (funcall show widget value)))))
1814
1815 (defvar custom-load-recursion nil
1816 "Hack to avoid recursive dependencies.")
1817
1818 (defun custom-load-symbol (symbol)
1819 "Load all dependencies for SYMBOL."
1820 (unless custom-load-recursion
1821 (let ((custom-load-recursion t)
1822 (loads (get symbol 'custom-loads))
1823 load)
1824 (while loads
1825 (setq load (car loads)
1826 loads (cdr loads))
1827 (cond ((symbolp load)
1828 (condition-case nil
1829 (require load)
1830 (error nil)))
1831 ;; Don't reload a file already loaded.
1832 ((and (boundp 'preloaded-file-list)
1833 (member load preloaded-file-list)))
1834 ((assoc load load-history))
1835 ;; This was just (assoc (locate-library load) load-history)
1836 ;; but has been optimized not to load locate-library
1837 ;; if not necessary.
1838 ((let (found (regexp (regexp-quote load)))
1839 (dolist (loaded load-history)
1840 (and (string-match regexp (car loaded))
1841 (eq (locate-library load) (car loaded))
1842 (setq found t)))
1843 found))
1844 ;; Without this, we would load cus-edit recursively.
1845 ;; We are still loading it when we call this,
1846 ;; and it is not in load-history yet.
1847 ((equal load "cus-edit"))
1848 (t
1849 (condition-case nil
1850 (load-library load)
1851 (error nil))))))))
1852
1853 (defun custom-load-widget (widget)
1854 "Load all dependencies for WIDGET."
1855 (custom-load-symbol (widget-value widget)))
1856
1857 (defun custom-unloaded-symbol-p (symbol)
1858 "Return non-nil if the dependencies of SYMBOL has not yet been loaded."
1859 (let ((found nil)
1860 (loads (get symbol 'custom-loads))
1861 load)
1862 (while loads
1863 (setq load (car loads)
1864 loads (cdr loads))
1865 (cond ((symbolp load)
1866 (unless (featurep load)
1867 (setq found t)))
1868 ((assoc load load-history))
1869 ((assoc (locate-library load) load-history)
1870 (message nil))
1871 (t
1872 (setq found t))))
1873 found))
1874
1875 (defun custom-unloaded-widget-p (widget)
1876 "Return non-nil if the dependencies of WIDGET has not yet been loaded."
1877 (custom-unloaded-symbol-p (widget-value widget)))
1878
1879 (defun custom-toggle-hide (widget)
1880 "Toggle visibility of WIDGET."
1881 (custom-load-widget widget)
1882 (let ((state (widget-get widget :custom-state)))
1883 (cond ((memq state '(invalid modified))
1884 (error "There are unset changes"))
1885 ((eq state 'hidden)
1886 (widget-put widget :custom-state 'unknown))
1887 (t
1888 (widget-put widget :documentation-shown nil)
1889 (widget-put widget :custom-state 'hidden)))
1890 (custom-redraw widget)
1891 (widget-setup)))
1892
1893 (defun custom-toggle-parent (widget &rest ignore)
1894 "Toggle visibility of parent of WIDGET."
1895 (custom-toggle-hide (widget-get widget :parent)))
1896
1897 (defun custom-add-see-also (widget &optional prefix)
1898 "Add `See also ...' to WIDGET if there are any links.
1899 Insert PREFIX first if non-nil."
1900 (let* ((symbol (widget-get widget :value))
1901 (links (get symbol 'custom-links))
1902 (many (> (length links) 2))
1903 (buttons (widget-get widget :buttons))
1904 (indent (widget-get widget :indent)))
1905 (when links
1906 (when indent
1907 (insert-char ?\ indent))
1908 (when prefix
1909 (insert prefix))
1910 (insert "See also ")
1911 (while links
1912 (push (widget-create-child-and-convert widget (car links))
1913 buttons)
1914 (setq links (cdr links))
1915 (cond ((null links)
1916 (insert ".\n"))
1917 ((null (cdr links))
1918 (if many
1919 (insert ", and ")
1920 (insert " and ")))
1921 (t
1922 (insert ", "))))
1923 (widget-put widget :buttons buttons))))
1924
1925 (defun custom-add-parent-links (widget &optional initial-string)
1926 "Add \"Parent groups: ...\" to WIDGET if the group has parents.
1927 The value if non-nil if any parents were found.
1928 If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
1929 (let ((name (widget-value widget))
1930 (type (widget-type widget))
1931 (buttons (widget-get widget :buttons))
1932 (start (point))
1933 found)
1934 (insert (or initial-string "Parent groups:"))
1935 (mapatoms (lambda (symbol)
1936 (let ((entry (assq name (get symbol 'custom-group))))
1937 (when (eq (nth 1 entry) type)
1938 (insert " ")
1939 (push (widget-create-child-and-convert
1940 widget 'custom-group-link
1941 :tag (custom-unlispify-tag-name symbol)
1942 symbol)
1943 buttons)
1944 (setq found t)))))
1945 (widget-put widget :buttons buttons)
1946 (if found
1947 (insert "\n")
1948 (delete-region start (point)))
1949 found))
1950
1951 ;;; The `custom-comment' Widget.
1952
1953 ;; like the editable field
1954 (defface custom-comment-face '((((class grayscale color)
1955 (background light))
1956 (:background "gray85"))
1957 (((class grayscale color)
1958 (background dark))
1959 (:background "dim gray"))
1960 (t
1961 (:italic t)))
1962 "Face used for comments on variables or faces"
1963 :version "21.1"
1964 :group 'custom-faces)
1965
1966 ;; like font-lock-comment-face
1967 (defface custom-comment-tag-face
1968 '((((class color) (background dark)) (:foreground "gray80"))
1969 (((class color) (background light)) (:foreground "blue4"))
1970 (((class grayscale) (background light))
1971 (:foreground "DimGray" :bold t :italic t))
1972 (((class grayscale) (background dark))
1973 (:foreground "LightGray" :bold t :italic t))
1974 (t (:bold t)))
1975 "Face used for variables or faces comment tags"
1976 :group 'custom-faces)
1977
1978 (define-widget 'custom-comment 'string
1979 "User comment."
1980 :tag "Comment"
1981 :help-echo "Edit a comment here."
1982 :sample-face 'custom-comment-tag-face
1983 :value-face 'custom-comment-face
1984 :shown nil
1985 :create 'custom-comment-create)
1986
1987 (defun custom-comment-create (widget)
1988 (let* ((null-comment (equal "" (widget-value widget))))
1989 (if (or (widget-get (widget-get widget :parent) :comment-shown)
1990 (not null-comment))
1991 (widget-default-create widget)
1992 ;; `widget-default-delete' expects markers in these slots --
1993 ;; maybe it shouldn't.
1994 (widget-put widget :from (point-marker))
1995 (widget-put widget :to (point-marker)))))
1996
1997 (defun custom-comment-hide (widget)
1998 (widget-put (widget-get widget :parent) :comment-shown nil))
1999
2000 ;; Those functions are for the menu. WIDGET is NOT the comment widget. It's
2001 ;; the global custom one
2002 (defun custom-comment-show (widget)
2003 (widget-put widget :comment-shown t)
2004 (custom-redraw widget)
2005 (widget-setup))
2006
2007 (defun custom-comment-invisible-p (widget)
2008 (let ((val (widget-value (widget-get widget :comment-widget))))
2009 (and (equal "" val)
2010 (not (widget-get widget :comment-shown)))))
2011
2012 ;;; The `custom-variable' Widget.
2013
2014 ;; When this was underlined blue, users confused it with a
2015 ;; Mosaic-style hyperlink...
2016 (defface custom-variable-tag-face
2017 `((((class color)
2018 (background dark))
2019 (:foreground "light blue" :bold t :height 1.2 :inherit variable-pitch))
2020 (((class color)
2021 (background light))
2022 (:foreground "blue" :bold t :height 1.2 :inherit variable-pitch))
2023 (t (:bold t)))
2024 "Face used for unpushable variable tags."
2025 :group 'custom-faces)
2026
2027 (defface custom-variable-button-face '((t (:underline t :bold t)))
2028 "Face used for pushable variable tags."
2029 :group 'custom-faces)
2030
2031 (defcustom custom-variable-default-form 'edit
2032 "Default form of displaying variable values."
2033 :type '(choice (const edit)
2034 (const lisp))
2035 :group 'custom-buffer
2036 :version "20.3")
2037
2038 (define-widget 'custom-variable 'custom
2039 "Customize variable."
2040 :format "%v"
2041 :help-echo "Set or reset this variable."
2042 :documentation-property 'variable-documentation
2043 :custom-category 'option
2044 :custom-state nil
2045 :custom-menu 'custom-variable-menu-create
2046 :custom-form nil ; defaults to value of `custom-variable-default-form'
2047 :value-create 'custom-variable-value-create
2048 :action 'custom-variable-action
2049 :custom-set 'custom-variable-set
2050 :custom-save 'custom-variable-save
2051 :custom-reset-current 'custom-redraw
2052 :custom-reset-saved 'custom-variable-reset-saved
2053 :custom-reset-standard 'custom-variable-reset-standard)
2054
2055 (defun custom-variable-type (symbol)
2056 "Return a widget suitable for editing the value of SYMBOL.
2057 If SYMBOL has a `custom-type' property, use that.
2058 Otherwise, look up symbol in `custom-guess-type-alist'."
2059 (let* ((type (or (get symbol 'custom-type)
2060 (and (not (get symbol 'standard-value))
2061 (custom-guess-type symbol))
2062 'sexp))
2063 (options (get symbol 'custom-options))
2064 (tmp (if (listp type)
2065 (copy-sequence type)
2066 (list type))))
2067 (when options
2068 (widget-put tmp :options options))
2069 tmp))
2070
2071 (defun custom-variable-value-create (widget)
2072 "Here is where you edit the variable's value."
2073 (custom-load-widget widget)
2074 (unless (widget-get widget :custom-form)
2075 (widget-put widget :custom-form custom-variable-default-form))
2076 (let* ((buttons (widget-get widget :buttons))
2077 (children (widget-get widget :children))
2078 (form (widget-get widget :custom-form))
2079 (state (widget-get widget :custom-state))
2080 (symbol (widget-get widget :value))
2081 (tag (widget-get widget :tag))
2082 (type (custom-variable-type symbol))
2083 (conv (widget-convert type))
2084 (get (or (get symbol 'custom-get) 'default-value))
2085 (prefix (widget-get widget :custom-prefix))
2086 (last (widget-get widget :custom-last))
2087 (value (if (default-boundp symbol)
2088 (funcall get symbol)
2089 (widget-get conv :value))))
2090 ;; If the widget is new, the child determines whether it is hidden.
2091 (cond (state)
2092 ((custom-show type value)
2093 (setq state 'unknown))
2094 (t
2095 (setq state 'hidden)))
2096 ;; If we don't know the state, see if we need to edit it in lisp form.
2097 (when (eq state 'unknown)
2098 (unless (widget-apply conv :match value)
2099 ;; (widget-apply (widget-convert type) :match value)
2100 (setq form 'mismatch)))
2101 ;; Now we can create the child widget.
2102 (cond ((eq custom-buffer-style 'tree)
2103 (insert prefix (if last " `--- " " |--- "))
2104 (push (widget-create-child-and-convert
2105 widget 'custom-browse-variable-tag)
2106 buttons)
2107 (insert " " tag "\n")
2108 (widget-put widget :buttons buttons))
2109 ((eq state 'hidden)
2110 ;; Indicate hidden value.
2111 (push (widget-create-child-and-convert
2112 widget 'item
2113 :format "%{%t%}: "
2114 :sample-face 'custom-variable-tag-face
2115 :tag tag
2116 :parent widget)
2117 buttons)
2118 (push (widget-create-child-and-convert
2119 widget 'visibility
2120 :help-echo "Show the value of this option."
2121 :action 'custom-toggle-parent
2122 nil)
2123 buttons))
2124 ((memq form '(lisp mismatch))
2125 ;; In lisp mode edit the saved value when possible.
2126 (let* ((value (cond ((get symbol 'saved-value)
2127 (car (get symbol 'saved-value)))
2128 ((get symbol 'standard-value)
2129 (car (get symbol 'standard-value)))
2130 ((default-boundp symbol)
2131 (custom-quote (funcall get symbol)))
2132 (t
2133 (custom-quote (widget-get conv :value))))))
2134 (insert (symbol-name symbol) ": ")
2135 (push (widget-create-child-and-convert
2136 widget 'visibility
2137 :help-echo "Hide the value of this option."
2138 :action 'custom-toggle-parent
2139 t)
2140 buttons)
2141 (insert " ")
2142 (push (widget-create-child-and-convert
2143 widget 'sexp
2144 :button-face 'custom-variable-button-face
2145 :format "%v"
2146 :tag (symbol-name symbol)
2147 :parent widget
2148 :value value)
2149 children)))
2150 (t
2151 ;; Edit mode.
2152 (let* ((format (widget-get type :format))
2153 tag-format value-format)
2154 (unless (string-match ":" format)
2155 (error "Bad format"))
2156 (setq tag-format (substring format 0 (match-end 0)))
2157 (setq value-format (substring format (match-end 0)))
2158 (push (widget-create-child-and-convert
2159 widget 'item
2160 :format tag-format
2161 :action 'custom-tag-action
2162 :help-echo "Change value of this option."
2163 :mouse-down-action 'custom-tag-mouse-down-action
2164 :button-face 'custom-variable-button-face
2165 :sample-face 'custom-variable-tag-face
2166 tag)
2167 buttons)
2168 (insert " ")
2169 (push (widget-create-child-and-convert
2170 widget 'visibility
2171 :help-echo "Hide the value of this option."
2172 :action 'custom-toggle-parent
2173 t)
2174 buttons)
2175 (push (widget-create-child-and-convert
2176 widget type
2177 :format value-format
2178 :value value)
2179 children))))
2180 (unless (eq custom-buffer-style 'tree)
2181 (unless (eq (preceding-char) ?\n)
2182 (widget-insert "\n"))
2183 ;; Create the magic button.
2184 (let ((magic (widget-create-child-and-convert
2185 widget 'custom-magic nil)))
2186 (widget-put widget :custom-magic magic)
2187 (push magic buttons))
2188 ;; ### NOTE: this is ugly!!!! I need to update the :buttons property
2189 ;; before the call to `widget-default-format-handler'. Otherwise, I
2190 ;; loose my current `buttons'. This function shouldn't be called like
2191 ;; this anyway. The doc string widget should be added like the others.
2192 ;; --dv
2193 (widget-put widget :buttons buttons)
2194 ;; Insert documentation.
2195 (widget-default-format-handler widget ?h)
2196
2197 ;; The comment field
2198 (unless (eq state 'hidden)
2199 (let* ((comment (get symbol 'variable-comment))
2200 (comment-widget
2201 (widget-create-child-and-convert
2202 widget 'custom-comment
2203 :parent widget
2204 :value (or comment ""))))
2205 (widget-put widget :comment-widget comment-widget)
2206 ;; Don't push it !!! Custom assumes that the first child is the
2207 ;; value one.
2208 (setq children (append children (list comment-widget)))))
2209 ;; Update the rest of the properties properties.
2210 (widget-put widget :custom-form form)
2211 (widget-put widget :children children)
2212 ;; Now update the state.
2213 (if (eq state 'hidden)
2214 (widget-put widget :custom-state state)
2215 (custom-variable-state-set widget))
2216 ;; See also.
2217 (unless (eq state 'hidden)
2218 (when (eq (widget-get widget :custom-level) 1)
2219 (custom-add-parent-links widget))
2220 (custom-add-see-also widget)))))
2221
2222 (defun custom-tag-action (widget &rest args)
2223 "Pass :action to first child of WIDGET's parent."
2224 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2225 :action args))
2226
2227 (defun custom-tag-mouse-down-action (widget &rest args)
2228 "Pass :mouse-down-action to first child of WIDGET's parent."
2229 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2230 :mouse-down-action args))
2231
2232 (defun custom-variable-state-set (widget)
2233 "Set the state of WIDGET."
2234 (let* ((symbol (widget-value widget))
2235 (get (or (get symbol 'custom-get) 'default-value))
2236 (value (if (default-boundp symbol)
2237 (funcall get symbol)
2238 (widget-get widget :value)))
2239 (comment (get symbol 'variable-comment))
2240 tmp
2241 temp
2242 (state (cond ((progn (setq tmp (get symbol 'customized-value))
2243 (setq temp
2244 (get symbol 'customized-variable-comment))
2245 (or tmp temp))
2246 (if (condition-case nil
2247 (and (equal value (eval (car tmp)))
2248 (equal comment temp))
2249 (error nil))
2250 'set
2251 'changed))
2252 ((progn (setq tmp (get symbol 'saved-value))
2253 (setq temp (get symbol 'saved-variable-comment))
2254 (or tmp temp))
2255 (if (condition-case nil
2256 (and (equal value (eval (car tmp)))
2257 (equal comment temp))
2258 (error nil))
2259 'saved
2260 'changed))
2261 ((setq tmp (get symbol 'standard-value))
2262 (if (condition-case nil
2263 (and (equal value (eval (car tmp)))
2264 (equal comment nil))
2265 (error nil))
2266 'standard
2267 'changed))
2268 (t 'rogue))))
2269 (widget-put widget :custom-state state)))
2270
2271 (defvar custom-variable-menu
2272 '(("Set for Current Session" custom-variable-set
2273 (lambda (widget)
2274 (eq (widget-get widget :custom-state) 'modified)))
2275 ("Save for Future Sessions" custom-variable-save
2276 (lambda (widget)
2277 (memq (widget-get widget :custom-state) '(modified set changed rogue))))
2278 ("Reset to Current" custom-redraw
2279 (lambda (widget)
2280 (and (default-boundp (widget-value widget))
2281 (memq (widget-get widget :custom-state) '(modified changed)))))
2282 ("Reset to Saved" custom-variable-reset-saved
2283 (lambda (widget)
2284 (and (or (get (widget-value widget) 'saved-value)
2285 (get (widget-value widget) 'saved-variable-comment))
2286 (memq (widget-get widget :custom-state)
2287 '(modified set changed rogue)))))
2288 ("Erase Customization" custom-variable-reset-standard
2289 (lambda (widget)
2290 (and (get (widget-value widget) 'standard-value)
2291 (memq (widget-get widget :custom-state)
2292 '(modified set changed saved rogue)))))
2293 ("---" ignore ignore)
2294 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2295 ("---" ignore ignore)
2296 ("Don't show as Lisp expression" custom-variable-edit
2297 (lambda (widget)
2298 (eq (widget-get widget :custom-form) 'lisp)))
2299 ("Show initial Lisp expression" custom-variable-edit-lisp
2300 (lambda (widget)
2301 (eq (widget-get widget :custom-form) 'edit))))
2302 "Alist of actions for the `custom-variable' widget.
2303 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2304 the menu entry, ACTION is the function to call on the widget when the
2305 menu is selected, and FILTER is a predicate which takes a `custom-variable'
2306 widget as an argument, and returns non-nil if ACTION is valid on that
2307 widget. If FILTER is nil, ACTION is always valid.")
2308
2309 (defun custom-variable-action (widget &optional event)
2310 "Show the menu for `custom-variable' WIDGET.
2311 Optional EVENT is the location for the menu."
2312 (if (eq (widget-get widget :custom-state) 'hidden)
2313 (custom-toggle-hide widget)
2314 (unless (eq (widget-get widget :custom-state) 'modified)
2315 (custom-variable-state-set widget))
2316 (custom-redraw-magic widget)
2317 (let* ((completion-ignore-case t)
2318 (answer (widget-choose (concat "Operation on "
2319 (custom-unlispify-tag-name
2320 (widget-get widget :value)))
2321 (custom-menu-filter custom-variable-menu
2322 widget)
2323 event)))
2324 (if answer
2325 (funcall answer widget)))))
2326
2327 (defun custom-variable-edit (widget)
2328 "Edit value of WIDGET."
2329 (widget-put widget :custom-state 'unknown)
2330 (widget-put widget :custom-form 'edit)
2331 (custom-redraw widget))
2332
2333 (defun custom-variable-edit-lisp (widget)
2334 "Edit the Lisp representation of the value of WIDGET."
2335 (widget-put widget :custom-state 'unknown)
2336 (widget-put widget :custom-form 'lisp)
2337 (custom-redraw widget))
2338
2339 (defun custom-variable-set (widget)
2340 "Set the current value for the variable being edited by WIDGET."
2341 (let* ((form (widget-get widget :custom-form))
2342 (state (widget-get widget :custom-state))
2343 (child (car (widget-get widget :children)))
2344 (symbol (widget-value widget))
2345 (set (or (get symbol 'custom-set) 'set-default))
2346 (comment-widget (widget-get widget :comment-widget))
2347 (comment (widget-value comment-widget))
2348 val)
2349 (cond ((eq state 'hidden)
2350 (error "Cannot set hidden variable"))
2351 ((setq val (widget-apply child :validate))
2352 (goto-char (widget-get val :from))
2353 (error "%s" (widget-get val :error)))
2354 ((memq form '(lisp mismatch))
2355 (when (equal comment "")
2356 (setq comment nil)
2357 ;; Make the comment invisible by hand if it's empty
2358 (custom-comment-hide comment-widget))
2359 (funcall set symbol (eval (setq val (widget-value child))))
2360 (put symbol 'customized-value (list val))
2361 (put symbol 'variable-comment comment)
2362 (put symbol 'customized-variable-comment comment))
2363 (t
2364 (when (equal comment "")
2365 (setq comment nil)
2366 ;; Make the comment invisible by hand if it's empty
2367 (custom-comment-hide comment-widget))
2368 (funcall set symbol (setq val (widget-value child)))
2369 (put symbol 'customized-value (list (custom-quote val)))
2370 (put symbol 'variable-comment comment)
2371 (put symbol 'customized-variable-comment comment)))
2372 (custom-variable-state-set widget)
2373 (custom-redraw-magic widget)))
2374
2375 (defun custom-variable-save (widget)
2376 "Set and save the value for the variable being edited by WIDGET."
2377 (let* ((form (widget-get widget :custom-form))
2378 (state (widget-get widget :custom-state))
2379 (child (car (widget-get widget :children)))
2380 (symbol (widget-value widget))
2381 (set (or (get symbol 'custom-set) 'set-default))
2382 (comment-widget (widget-get widget :comment-widget))
2383 (comment (widget-value comment-widget))
2384 val)
2385 (cond ((eq state 'hidden)
2386 (error "Cannot set hidden variable"))
2387 ((setq val (widget-apply child :validate))
2388 (goto-char (widget-get val :from))
2389 (error "Saving %s: %s" symbol (widget-get val :error)))
2390 ((memq form '(lisp mismatch))
2391 (when (equal comment "")
2392 (setq comment nil)
2393 ;; Make the comment invisible by hand if it's empty
2394 (custom-comment-hide comment-widget))
2395 (put symbol 'saved-value (list (widget-value child)))
2396 (funcall set symbol (eval (widget-value child)))
2397 (put symbol 'variable-comment comment)
2398 (put symbol 'saved-variable-comment comment))
2399 (t
2400 (when (equal comment "")
2401 (setq comment nil)
2402 ;; Make the comment invisible by hand if it's empty
2403 (custom-comment-hide comment-widget))
2404 (put symbol 'saved-value
2405 (list (custom-quote (widget-value child))))
2406 (funcall set symbol (widget-value child))
2407 (put symbol 'variable-comment comment)
2408 (put symbol 'saved-variable-comment comment)))
2409 (put symbol 'customized-value nil)
2410 (put symbol 'customized-variable-comment nil)
2411 (custom-save-all)
2412 (custom-variable-state-set widget)
2413 (custom-redraw-magic widget)))
2414
2415 (defun custom-variable-reset-saved (widget)
2416 "Restore the saved value for the variable being edited by WIDGET."
2417 (let* ((symbol (widget-value widget))
2418 (set (or (get symbol 'custom-set) 'set-default))
2419 (value (get symbol 'saved-value))
2420 (comment (get symbol 'saved-variable-comment)))
2421 (cond ((or value comment)
2422 (put symbol 'variable-comment comment)
2423 (condition-case nil
2424 (funcall set symbol (eval (car value)))
2425 (error nil)))
2426 (t
2427 (error "No saved value for %s" symbol)))
2428 (put symbol 'customized-value nil)
2429 (put symbol 'customized-variable-comment nil)
2430 (widget-put widget :custom-state 'unknown)
2431 ;; This call will possibly make the comment invisible
2432 (custom-redraw widget)))
2433
2434 (defun custom-variable-reset-standard (widget)
2435 "Restore the standard setting for the variable being edited by WIDGET.
2436 This operation eliminates any saved setting for the variable,
2437 restoring it to the state of a variable that has never been customized."
2438 (let* ((symbol (widget-value widget))
2439 (set (or (get symbol 'custom-set) 'set-default)))
2440 (if (get symbol 'standard-value)
2441 (funcall set symbol (eval (car (get symbol 'standard-value))))
2442 (error "No standard setting known for %S" symbol))
2443 (put symbol 'variable-comment nil)
2444 (put symbol 'customized-value nil)
2445 (put symbol 'customized-variable-comment nil)
2446 (when (or (get symbol 'saved-value) (get symbol 'saved-variable-comment))
2447 (put symbol 'saved-value nil)
2448 (put symbol 'saved-variable-comment nil)
2449 (custom-save-all))
2450 (widget-put widget :custom-state 'unknown)
2451 ;; This call will possibly make the comment invisible
2452 (custom-redraw widget)))
2453
2454 ;;; The `custom-face-edit' Widget.
2455
2456 (define-widget 'custom-face-edit 'checklist
2457 "Edit face attributes."
2458 :format "%t: %v"
2459 :tag "Attributes"
2460 :extra-offset 12
2461 :button-args '(:help-echo "Control whether this attribute has any effect.")
2462 :convert-widget 'custom-face-edit-convert-widget
2463 :args (mapcar (lambda (att)
2464 (list 'group
2465 :inline t
2466 :sibling-args (widget-get (nth 1 att) :sibling-args)
2467 (list 'const :format "" :value (nth 0 att))
2468 (nth 1 att)))
2469 custom-face-attributes))
2470
2471 (defun custom-face-edit-convert-widget (widget)
2472 "Convert :args as widget types in WIDGET."
2473 (widget-put
2474 widget
2475 :args (mapcar (lambda (arg)
2476 (widget-convert arg
2477 :deactivate 'custom-face-edit-deactivate
2478 :activate 'custom-face-edit-activate
2479 :delete 'custom-face-edit-delete))
2480 (widget-get widget :args)))
2481 widget)
2482
2483 (defun custom-face-edit-deactivate (widget)
2484 "Make face widget WIDGET inactive for user modifications."
2485 (unless (widget-get widget :inactive)
2486 (let ((tag (custom-face-edit-attribute-tag widget))
2487 (from (copy-marker (widget-get widget :from)))
2488 (to (widget-get widget :to))
2489 (value (widget-value widget))
2490 (inhibit-read-only t)
2491 (inhibit-modification-hooks t))
2492 (save-excursion
2493 (goto-char from)
2494 (widget-default-delete widget)
2495 (insert tag ": *\n")
2496 (widget-put widget :inactive
2497 (cons value (cons from (- (point) from))))))))
2498
2499 (defun custom-face-edit-activate (widget)
2500 "Make face widget WIDGET inactive for user modifications."
2501 (let ((inactive (widget-get widget :inactive))
2502 (inhibit-read-only t)
2503 (inhibit-modification-hooks t))
2504 (when (consp inactive)
2505 (save-excursion
2506 (goto-char (car (cdr inactive)))
2507 (delete-region (point) (+ (point) (cdr (cdr inactive))))
2508 (widget-put widget :inactive nil)
2509 (widget-apply widget :create)
2510 (widget-value-set widget (car inactive))
2511 (widget-setup)))))
2512
2513 (defun custom-face-edit-delete (widget)
2514 "Remove widget from the buffer."
2515 (let ((inactive (widget-get widget :inactive))
2516 (inhibit-read-only t)
2517 (inhibit-modification-hooks t))
2518 (if (not inactive)
2519 ;; Widget is alive, we don't have to do anything special
2520 (widget-default-delete widget)
2521 ;; WIDGET is already deleted because we did so to inactivate it;
2522 ;; now just get rid of the label we put in its place.
2523 (delete-region (car (cdr inactive))
2524 (+ (car (cdr inactive)) (cdr (cdr inactive))))
2525 (widget-put widget :inactive nil))))
2526
2527
2528 (defun custom-face-edit-attribute-tag (widget)
2529 "Returns the first :tag property in WIDGET or one of its children."
2530 (let ((tag (widget-get widget :tag)))
2531 (or (and (not (equal tag "")) tag)
2532 (let ((children (widget-get widget :children)))
2533 (while (and (null tag) children)
2534 (setq tag (custom-face-edit-attribute-tag (pop children))))
2535 tag))))
2536
2537 ;;; The `custom-display' Widget.
2538
2539 (define-widget 'custom-display 'menu-choice
2540 "Select a display type."
2541 :tag "Display"
2542 :value t
2543 :help-echo "Specify frames where the face attributes should be used."
2544 :args '((const :tag "all" t)
2545 (checklist
2546 :offset 0
2547 :extra-offset 9
2548 :args ((group :sibling-args (:help-echo "\
2549 Only match the specified window systems.")
2550 (const :format "Type: "
2551 type)
2552 (checklist :inline t
2553 :offset 0
2554 (const :format "X "
2555 :sibling-args (:help-echo "\
2556 The X11 Window System.")
2557 x)
2558 (const :format "PM "
2559 :sibling-args (:help-echo "\
2560 OS/2 Presentation Manager.")
2561 pm)
2562 (const :format "W32 "
2563 :sibling-args (:help-echo "\
2564 Windows NT/9X.")
2565 w32)
2566 (const :format "DOS "
2567 :sibling-args (:help-echo "\
2568 Plain MS-DOS.")
2569 pc)
2570 (const :format "TTY%n"
2571 :sibling-args (:help-echo "\
2572 Plain text terminals.")
2573 tty)))
2574 (group :sibling-args (:help-echo "\
2575 Only match the frames with the specified color support.")
2576 (const :format "Class: "
2577 class)
2578 (checklist :inline t
2579 :offset 0
2580 (const :format "Color "
2581 :sibling-args (:help-echo "\
2582 Match color frames.")
2583 color)
2584 (const :format "Grayscale "
2585 :sibling-args (:help-echo "\
2586 Match grayscale frames.")
2587 grayscale)
2588 (const :format "Monochrome%n"
2589 :sibling-args (:help-echo "\
2590 Match frames with no color support.")
2591 mono)))
2592 (group :sibling-args (:help-echo "\
2593 Only match frames with the specified intensity.")
2594 (const :format "\
2595 Background brightness: "
2596 background)
2597 (checklist :inline t
2598 :offset 0
2599 (const :format "Light "
2600 :sibling-args (:help-echo "\
2601 Match frames with light backgrounds.")
2602 light)
2603 (const :format "Dark\n"
2604 :sibling-args (:help-echo "\
2605 Match frames with dark backgrounds.")
2606 dark)))))))
2607
2608 ;;; The `custom-face' Widget.
2609
2610 (defface custom-face-tag-face
2611 `((t (:bold t :height 1.2 :inherit variable-pitch)))
2612 "Face used for face tags."
2613 :group 'custom-faces)
2614
2615 (defcustom custom-face-default-form 'selected
2616 "Default form of displaying face definition."
2617 :type '(choice (const all)
2618 (const selected)
2619 (const lisp))
2620 :group 'custom-buffer
2621 :version "20.3")
2622
2623 (define-widget 'custom-face 'custom
2624 "Customize face."
2625 :sample-face 'custom-face-tag-face
2626 :help-echo "Set or reset this face."
2627 :documentation-property #'face-doc-string
2628 :value-create 'custom-face-value-create
2629 :action 'custom-face-action
2630 :custom-category 'face
2631 :custom-form nil ; defaults to value of `custom-face-default-form'
2632 :custom-set 'custom-face-set
2633 :custom-save 'custom-face-save
2634 :custom-reset-current 'custom-redraw
2635 :custom-reset-saved 'custom-face-reset-saved
2636 :custom-reset-standard 'custom-face-reset-standard
2637 :custom-menu 'custom-face-menu-create)
2638
2639 (define-widget 'custom-face-all 'editable-list
2640 "An editable list of display specifications and attributes."
2641 :entry-format "%i %d %v"
2642 :insert-button-args '(:help-echo "Insert new display specification here.")
2643 :append-button-args '(:help-echo "Append new display specification here.")
2644 :delete-button-args '(:help-echo "Delete this display specification.")
2645 :args '((group :format "%v" custom-display custom-face-edit)))
2646
2647 (defconst custom-face-all (widget-convert 'custom-face-all)
2648 "Converted version of the `custom-face-all' widget.")
2649
2650 (define-widget 'custom-display-unselected 'item
2651 "A display specification that doesn't match the selected display."
2652 :match 'custom-display-unselected-match)
2653
2654 (defun custom-display-unselected-match (widget value)
2655 "Non-nil if VALUE is an unselected display specification."
2656 (not (face-spec-set-match-display value (selected-frame))))
2657
2658 (define-widget 'custom-face-selected 'group
2659 "Edit the attributes of the selected display in a face specification."
2660 :args '((repeat :format ""
2661 :inline t
2662 (group custom-display-unselected sexp))
2663 (group (sexp :format "") custom-face-edit)
2664 (repeat :format ""
2665 :inline t
2666 sexp)))
2667
2668 (defconst custom-face-selected (widget-convert 'custom-face-selected)
2669 "Converted version of the `custom-face-selected' widget.")
2670
2671 (defun custom-filter-face-spec (spec filter-index &optional default-filter)
2672 "Return a canonicalized version of SPEC using.
2673 FILTER-INDEX is the index in the entry for each attribute in
2674 `custom-face-attributes' at which the appropriate filter function can be
2675 found, and DEFAULT-FILTER is the filter to apply for attributes that
2676 don't specify one."
2677 (mapcar (lambda (entry)
2678 ;; Filter a single face-spec entry
2679 (let ((tests (car entry))
2680 (unfiltered-attrs
2681 ;; Handle both old- and new-style attribute syntax
2682 (if (listp (car (cdr entry)))
2683 (car (cdr entry))
2684 (cdr entry)))
2685 (filtered-attrs nil))
2686 ;; Filter each face attribute
2687 (while unfiltered-attrs
2688 (let* ((attr (pop unfiltered-attrs))
2689 (pre-filtered-value (pop unfiltered-attrs))
2690 (filter
2691 (or (nth filter-index (assq attr custom-face-attributes))
2692 default-filter))
2693 (filtered-value
2694 (if filter
2695 (funcall filter pre-filtered-value)
2696 pre-filtered-value)))
2697 (push filtered-value filtered-attrs)
2698 (push attr filtered-attrs)))
2699 ;;
2700 (list tests filtered-attrs)))
2701 spec))
2702
2703 (defun custom-pre-filter-face-spec (spec)
2704 "Return SPEC changed as necessary for editing by the face customization widget.
2705 SPEC must be a full face spec."
2706 (custom-filter-face-spec spec 2))
2707
2708 (defun custom-post-filter-face-spec (spec)
2709 "Return the customized SPEC in a form suitable for setting the face."
2710 (custom-filter-face-spec spec 3))
2711
2712 (defun custom-face-value-create (widget)
2713 "Create a list of the display specifications for WIDGET."
2714 (let ((buttons (widget-get widget :buttons))
2715 children
2716 (symbol (widget-get widget :value))
2717 (tag (widget-get widget :tag))
2718 (state (widget-get widget :custom-state))
2719 (begin (point))
2720 (is-last (widget-get widget :custom-last))
2721 (prefix (widget-get widget :custom-prefix)))
2722 (unless tag
2723 (setq tag (prin1-to-string symbol)))
2724 (cond ((eq custom-buffer-style 'tree)
2725 (insert prefix (if is-last " `--- " " |--- "))
2726 (push (widget-create-child-and-convert
2727 widget 'custom-browse-face-tag)
2728 buttons)
2729 (insert " " tag "\n")
2730 (widget-put widget :buttons buttons))
2731 (t
2732 ;; Create tag.
2733 (insert tag)
2734 (widget-specify-sample widget begin (point))
2735 (if (eq custom-buffer-style 'face)
2736 (insert " ")
2737 (if (string-match "face\\'" tag)
2738 (insert ":")
2739 (insert " face: ")))
2740 ;; Sample.
2741 (push (widget-create-child-and-convert widget 'item
2742 :format "(%{%t%})"
2743 :sample-face symbol
2744 :tag "sample")
2745 buttons)
2746 ;; Visibility.
2747 (insert " ")
2748 (push (widget-create-child-and-convert
2749 widget 'visibility
2750 :help-echo "Hide or show this face."
2751 :action 'custom-toggle-parent
2752 (not (eq state 'hidden)))
2753 buttons)
2754 ;; Magic.
2755 (insert "\n")
2756 (let ((magic (widget-create-child-and-convert
2757 widget 'custom-magic nil)))
2758 (widget-put widget :custom-magic magic)
2759 (push magic buttons))
2760 ;; Update buttons.
2761 (widget-put widget :buttons buttons)
2762 ;; Insert documentation.
2763 (widget-default-format-handler widget ?h)
2764 ;; The comment field
2765 (unless (eq state 'hidden)
2766 (let* ((comment (get symbol 'face-comment))
2767 (comment-widget
2768 (widget-create-child-and-convert
2769 widget 'custom-comment
2770 :parent widget
2771 :value (or comment ""))))
2772 (widget-put widget :comment-widget comment-widget)
2773 (push comment-widget children)))
2774 ;; See also.
2775 (unless (eq state 'hidden)
2776 (when (eq (widget-get widget :custom-level) 1)
2777 (custom-add-parent-links widget))
2778 (custom-add-see-also widget))
2779 ;; Editor.
2780 (unless (eq (preceding-char) ?\n)
2781 (insert "\n"))
2782 (unless (eq state 'hidden)
2783 (message "Creating face editor...")
2784 (custom-load-widget widget)
2785 (unless (widget-get widget :custom-form)
2786 (widget-put widget :custom-form custom-face-default-form))
2787 (let* ((symbol (widget-value widget))
2788 (spec (or (get symbol 'customized-face)
2789 (get symbol 'saved-face)
2790 (get symbol 'face-defface-spec)
2791 ;; Attempt to construct it.
2792 (list (list t (custom-face-attributes-get
2793 symbol (selected-frame))))))
2794 (form (widget-get widget :custom-form))
2795 (indent (widget-get widget :indent))
2796 edit)
2797 ;; If the user has changed this face in some other way,
2798 ;; edit it as the user has specified it.
2799 (if (not (face-spec-match-p symbol spec (selected-frame)))
2800 (setq spec (list (list t (face-attr-construct symbol (selected-frame))))))
2801 (setq spec (custom-pre-filter-face-spec spec))
2802 (setq edit (widget-create-child-and-convert
2803 widget
2804 (cond ((and (eq form 'selected)
2805 (widget-apply custom-face-selected
2806 :match spec))
2807 (when indent (insert-char ?\ indent))
2808 'custom-face-selected)
2809 ((and (not (eq form 'lisp))
2810 (widget-apply custom-face-all
2811 :match spec))
2812 'custom-face-all)
2813 (t
2814 (when indent (insert-char ?\ indent))
2815 'sexp))
2816 :value spec))
2817 (custom-face-state-set widget)
2818 (push edit children)
2819 (widget-put widget :children children))
2820 (message "Creating face editor...done"))))))
2821
2822 (defvar custom-face-menu
2823 '(("Set for Current Session" custom-face-set)
2824 ("Save for Future Sessions" custom-face-save-command)
2825 ("Reset to Saved" custom-face-reset-saved
2826 (lambda (widget)
2827 (or (get (widget-value widget) 'saved-face)
2828 (get (widget-value widget) 'saved-face-comment))))
2829 ("Erase Customization" custom-face-reset-standard
2830 (lambda (widget)
2831 (get (widget-value widget) 'face-defface-spec)))
2832 ("---" ignore ignore)
2833 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2834 ("---" ignore ignore)
2835 ("Show all display specs" custom-face-edit-all
2836 (lambda (widget)
2837 (not (eq (widget-get widget :custom-form) 'all))))
2838 ("Just current attributes" custom-face-edit-selected
2839 (lambda (widget)
2840 (not (eq (widget-get widget :custom-form) 'selected))))
2841 ("Show as Lisp expression" custom-face-edit-lisp
2842 (lambda (widget)
2843 (not (eq (widget-get widget :custom-form) 'lisp)))))
2844 "Alist of actions for the `custom-face' widget.
2845 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2846 the menu entry, ACTION is the function to call on the widget when the
2847 menu is selected, and FILTER is a predicate which takes a `custom-face'
2848 widget as an argument, and returns non-nil if ACTION is valid on that
2849 widget. If FILTER is nil, ACTION is always valid.")
2850
2851 (defun custom-face-edit-selected (widget)
2852 "Edit selected attributes of the value of WIDGET."
2853 (widget-put widget :custom-state 'unknown)
2854 (widget-put widget :custom-form 'selected)
2855 (custom-redraw widget))
2856
2857 (defun custom-face-edit-all (widget)
2858 "Edit all attributes of the value of WIDGET."
2859 (widget-put widget :custom-state 'unknown)
2860 (widget-put widget :custom-form 'all)
2861 (custom-redraw widget))
2862
2863 (defun custom-face-edit-lisp (widget)
2864 "Edit the Lisp representation of the value of WIDGET."
2865 (widget-put widget :custom-state 'unknown)
2866 (widget-put widget :custom-form 'lisp)
2867 (custom-redraw widget))
2868
2869 (defun custom-face-state-set (widget)
2870 "Set the state of WIDGET."
2871 (let* ((symbol (widget-value widget))
2872 (comment (get symbol 'face-comment))
2873 tmp temp)
2874 (widget-put widget :custom-state
2875 (cond ((progn
2876 (setq tmp (get symbol 'customized-face))
2877 (setq temp (get symbol 'customized-face-comment))
2878 (or tmp temp))
2879 (if (equal temp comment)
2880 'set
2881 'changed))
2882 ((progn
2883 (setq tmp (get symbol 'saved-face))
2884 (setq temp (get symbol 'saved-face-comment))
2885 (or tmp temp))
2886 (if (equal temp comment)
2887 'saved
2888 'changed))
2889 ((get symbol 'face-defface-spec)
2890 (if (equal comment nil)
2891 'standard
2892 'changed))
2893 (t
2894 'rogue)))))
2895
2896 (defun custom-face-action (widget &optional event)
2897 "Show the menu for `custom-face' WIDGET.
2898 Optional EVENT is the location for the menu."
2899 (if (eq (widget-get widget :custom-state) 'hidden)
2900 (custom-toggle-hide widget)
2901 (let* ((completion-ignore-case t)
2902 (symbol (widget-get widget :value))
2903 (answer (widget-choose (concat "Operation on "
2904 (custom-unlispify-tag-name symbol))
2905 (custom-menu-filter custom-face-menu
2906 widget)
2907 event)))
2908 (if answer
2909 (funcall answer widget)))))
2910
2911 (defun custom-face-set (widget)
2912 "Make the face attributes in WIDGET take effect."
2913 (let* ((symbol (widget-value widget))
2914 (child (car (widget-get widget :children)))
2915 (value (custom-post-filter-face-spec (widget-value child)))
2916 (comment-widget (widget-get widget :comment-widget))
2917 (comment (widget-value comment-widget)))
2918 (when (equal comment "")
2919 (setq comment nil)
2920 ;; Make the comment invisible by hand if it's empty
2921 (custom-comment-hide comment-widget))
2922 (put symbol 'customized-face value)
2923 (if (face-spec-choose value)
2924 (face-spec-set symbol value)
2925 ;; face-set-spec ignores empty attribute lists, so just give it
2926 ;; something harmless instead.
2927 (face-spec-set symbol '((t :foreground unspecified))))
2928 (put symbol 'customized-face-comment comment)
2929 (put symbol 'face-comment comment)
2930 (custom-face-state-set widget)
2931 (custom-redraw-magic widget)))
2932
2933 (defun custom-face-save-command (widget)
2934 "Save in `.emacs' the face attributes in WIDGET."
2935 (custom-face-save widget)
2936 (custom-save-all))
2937
2938 (defun custom-face-save (widget)
2939 "Prepare for saving WIDGET's face attributes, but don't write `.emacs'."
2940 (let* ((symbol (widget-value widget))
2941 (child (car (widget-get widget :children)))
2942 (value (custom-post-filter-face-spec (widget-value child)))
2943 (comment-widget (widget-get widget :comment-widget))
2944 (comment (widget-value comment-widget)))
2945 (when (equal comment "")
2946 (setq comment nil)
2947 ;; Make the comment invisible by hand if it's empty
2948 (custom-comment-hide comment-widget))
2949 (if (face-spec-choose value)
2950 (face-spec-set symbol value)
2951 ;; face-set-spec ignores empty attribute lists, so just give it
2952 ;; something harmless instead.
2953 (face-spec-set symbol '((t :foreground unspecified))))
2954 (put symbol 'saved-face value)
2955 (put symbol 'customized-face nil)
2956 (put symbol 'face-comment comment)
2957 (put symbol 'customized-face-comment nil)
2958 (put symbol 'saved-face-comment comment)
2959 (custom-save-all)
2960 (custom-face-state-set widget)
2961 (custom-redraw-magic widget)))
2962
2963 (defun custom-face-reset-saved (widget)
2964 "Restore WIDGET to the face's default attributes."
2965 (let* ((symbol (widget-value widget))
2966 (child (car (widget-get widget :children)))
2967 (value (get symbol 'saved-face))
2968 (comment (get symbol 'saved-face-comment))
2969 (comment-widget (widget-get widget :comment-widget)))
2970 (unless (or value comment)
2971 (error "No saved value for this face"))
2972 (put symbol 'customized-face nil)
2973 (put symbol 'customized-face-comment nil)
2974 (face-spec-set symbol value)
2975 (put symbol 'face-comment comment)
2976 (widget-value-set child value)
2977 ;; This call manages the comment visibility
2978 (widget-value-set comment-widget (or comment ""))
2979 (custom-face-state-set widget)
2980 (custom-redraw-magic widget)))
2981
2982 (defun custom-face-reset-standard (widget)
2983 "Restore WIDGET to the face's standard settings.
2984 This operation eliminates any saved setting for the face,
2985 restoring it to the state of a face that has never been customized."
2986 (let* ((symbol (widget-value widget))
2987 (child (car (widget-get widget :children)))
2988 (value (get symbol 'face-defface-spec))
2989 (comment-widget (widget-get widget :comment-widget)))
2990 (unless value
2991 (error "No standard setting for this face"))
2992 (put symbol 'customized-face nil)
2993 (put symbol 'customized-face-comment nil)
2994 (when (or (get symbol 'saved-face) (get symbol 'saved-face-comment))
2995 (put symbol 'saved-face nil)
2996 (put symbol 'saved-face-comment nil)
2997 (custom-save-all))
2998 (face-spec-set symbol value)
2999 (put symbol 'face-comment nil)
3000 (widget-value-set child value)
3001 ;; This call manages the comment visibility
3002 (widget-value-set comment-widget "")
3003 (custom-face-state-set widget)
3004 (custom-redraw-magic widget)))
3005
3006 ;;; The `face' Widget.
3007
3008 (define-widget 'face 'default
3009 "Select and customize a face."
3010 :convert-widget 'widget-value-convert-widget
3011 :button-prefix 'widget-push-button-prefix
3012 :button-suffix 'widget-push-button-suffix
3013 :format "%{%t%}: %[select face%] %v"
3014 :tag "Face"
3015 :value 'default
3016 :value-create 'widget-face-value-create
3017 :value-delete 'widget-face-value-delete
3018 :value-get 'widget-value-value-get
3019 :validate 'widget-children-validate
3020 :action 'widget-face-action
3021 :match (lambda (widget value) (symbolp value)))
3022
3023 (defun widget-face-value-create (widget)
3024 "Create a `custom-face' child."
3025 (let* ((symbol (widget-value widget))
3026 (custom-buffer-style 'face)
3027 (child (widget-create-child-and-convert
3028 widget 'custom-face
3029 :custom-level nil
3030 :value symbol)))
3031 (custom-magic-reset child)
3032 (setq custom-options (cons child custom-options))
3033 (widget-put widget :children (list child))))
3034
3035 (defun widget-face-value-delete (widget)
3036 "Remove the child from the options."
3037 (let ((child (car (widget-get widget :children))))
3038 (setq custom-options (delq child custom-options))
3039 (widget-children-value-delete widget)))
3040
3041 (defvar face-history nil
3042 "History of entered face names.")
3043
3044 (defun widget-face-action (widget &optional event)
3045 "Prompt for a face."
3046 (let ((answer (completing-read "Face: "
3047 (mapcar (lambda (face)
3048 (list (symbol-name face)))
3049 (face-list))
3050 nil nil nil
3051 'face-history)))
3052 (unless (zerop (length answer))
3053 (widget-value-set widget (intern answer))
3054 (widget-apply widget :notify widget event)
3055 (widget-setup))))
3056
3057 ;;; The `hook' Widget.
3058
3059 (define-widget 'hook 'list
3060 "A emacs lisp hook"
3061 :value-to-internal (lambda (widget value)
3062 (if (and value (symbolp value))
3063 (list value)
3064 value))
3065 :match (lambda (widget value)
3066 (or (symbolp value)
3067 (widget-group-match widget value)))
3068 ;; Avoid adding undefined functions to the hook, especially for
3069 ;; things like `find-file-hook' or even more basic ones, to avoid
3070 ;; chaos.
3071 :set (lambda (symbol value)
3072 (dolist (elt value)
3073 (if (fboundp elt)
3074 (add-hook symbol elt))))
3075 :convert-widget 'custom-hook-convert-widget
3076 :tag "Hook")
3077
3078 (defun custom-hook-convert-widget (widget)
3079 ;; Handle `:options'.
3080 (let* ((options (widget-get widget :options))
3081 (other `(editable-list :inline t
3082 :entry-format "%i %d%v"
3083 (function :format " %v")))
3084 (args (if options
3085 (list `(checklist :inline t
3086 ,@(mapcar (lambda (entry)
3087 `(function-item ,entry))
3088 options))
3089 other)
3090 (list other))))
3091 (widget-put widget :args args)
3092 widget))
3093
3094 ;;; The `custom-group-link' Widget.
3095
3096 (define-widget 'custom-group-link 'link
3097 "Show parent in other window when activated."
3098 :help-echo "Create customization buffer for this group."
3099 :action 'custom-group-link-action)
3100
3101 (defun custom-group-link-action (widget &rest ignore)
3102 (customize-group (widget-value widget)))
3103
3104 ;;; The `custom-group' Widget.
3105
3106 (defcustom custom-group-tag-faces nil
3107 ;; In XEmacs, this ought to play games with font size.
3108 ;; Fixme: make it do so in Emacs.
3109 "Face used for group tags.
3110 The first member is used for level 1 groups, the second for level 2,
3111 and so forth. The remaining group tags are shown with
3112 `custom-group-tag-face'."
3113 :type '(repeat face)
3114 :group 'custom-faces)
3115
3116 (defface custom-group-tag-face-1
3117 `((((class color)
3118 (background dark))
3119 (:foreground "pink" :bold t :height 1.2 :inherit variable-pitch))
3120 (((class color)
3121 (background light))
3122 (:foreground "red" :bold t :height 1.2 :inherit variable-pitch))
3123 (t (:bold t)))
3124 "Face used for group tags."
3125 :group 'custom-faces)
3126
3127 (defface custom-group-tag-face
3128 `((((class color)
3129 (background dark))
3130 (:foreground "light blue" :bold t :height 1.2))
3131 (((class color)
3132 (background light))
3133 (:foreground "blue" :bold t :height 1.2))
3134 (t (:bold t)))
3135 "Face used for low level group tags."
3136 :group 'custom-faces)
3137
3138 (define-widget 'custom-group 'custom
3139 "Customize group."
3140 :format "%v"
3141 :sample-face-get 'custom-group-sample-face-get
3142 :documentation-property 'group-documentation
3143 :help-echo "Set or reset all members of this group."
3144 :value-create 'custom-group-value-create
3145 :action 'custom-group-action
3146 :custom-category 'group
3147 :custom-set 'custom-group-set
3148 :custom-save 'custom-group-save
3149 :custom-reset-current 'custom-group-reset-current
3150 :custom-reset-saved 'custom-group-reset-saved
3151 :custom-reset-standard 'custom-group-reset-standard
3152 :custom-menu 'custom-group-menu-create)
3153
3154 (defun custom-group-sample-face-get (widget)
3155 ;; Use :sample-face.
3156 (or (nth (1- (widget-get widget :custom-level)) custom-group-tag-faces)
3157 'custom-group-tag-face))
3158
3159 (define-widget 'custom-group-visibility 'visibility
3160 "An indicator and manipulator for hidden group contents."
3161 :create 'custom-group-visibility-create)
3162
3163 (defun custom-group-visibility-create (widget)
3164 (let ((visible (widget-value widget)))
3165 (if visible
3166 (insert "--------")))
3167 (widget-default-create widget))
3168
3169 (defun custom-group-members (symbol groups-only)
3170 "Return SYMBOL's custom group members.
3171 If GROUPS-ONLY non-nil, return only those members that are groups."
3172 (if (not groups-only)
3173 (get symbol 'custom-group)
3174 (let (members)
3175 (dolist (entry (get symbol 'custom-group))
3176 (when (eq (nth 1 entry) 'custom-group)
3177 (push entry members)))
3178 (nreverse members))))
3179
3180 (defun custom-group-value-create (widget)
3181 "Insert a customize group for WIDGET in the current buffer."
3182 (let* ((state (widget-get widget :custom-state))
3183 (level (widget-get widget :custom-level))
3184 ;; (indent (widget-get widget :indent))
3185 (prefix (widget-get widget :custom-prefix))
3186 (buttons (widget-get widget :buttons))
3187 (tag (widget-get widget :tag))
3188 (symbol (widget-value widget))
3189 (members (custom-group-members symbol
3190 (and (eq custom-buffer-style 'tree)
3191 custom-browse-only-groups))))
3192 (cond ((and (eq custom-buffer-style 'tree)
3193 (eq state 'hidden)
3194 (or members (custom-unloaded-widget-p widget)))
3195 (custom-browse-insert-prefix prefix)
3196 (push (widget-create-child-and-convert
3197 widget 'custom-browse-visibility
3198 ;; :tag-glyph "plus"
3199 :tag "+")
3200 buttons)
3201 (insert "-- ")
3202 ;; (widget-glyph-insert nil "-- " "horizontal")
3203 (push (widget-create-child-and-convert
3204 widget 'custom-browse-group-tag)
3205 buttons)
3206 (insert " " tag "\n")
3207 (widget-put widget :buttons buttons))
3208 ((and (eq custom-buffer-style 'tree)
3209 (zerop (length members)))
3210 (custom-browse-insert-prefix prefix)
3211 (insert "[ ]-- ")
3212 ;; (widget-glyph-insert nil "[ ]" "empty")
3213 ;; (widget-glyph-insert nil "-- " "horizontal")
3214 (push (widget-create-child-and-convert
3215 widget 'custom-browse-group-tag)
3216 buttons)
3217 (insert " " tag "\n")
3218 (widget-put widget :buttons buttons))
3219 ((eq custom-buffer-style 'tree)
3220 (custom-browse-insert-prefix prefix)
3221 (custom-load-widget widget)
3222 (if (zerop (length members))
3223 (progn
3224 (custom-browse-insert-prefix prefix)
3225 (insert "[ ]-- ")
3226 ;; (widget-glyph-insert nil "[ ]" "empty")
3227 ;; (widget-glyph-insert nil "-- " "horizontal")
3228 (push (widget-create-child-and-convert
3229 widget 'custom-browse-group-tag)
3230 buttons)
3231 (insert " " tag "\n")
3232 (widget-put widget :buttons buttons))
3233 (push (widget-create-child-and-convert
3234 widget 'custom-browse-visibility
3235 ;; :tag-glyph "minus"
3236 :tag "-")
3237 buttons)
3238 (insert "-\\ ")
3239 ;; (widget-glyph-insert nil "-\\ " "top")
3240 (push (widget-create-child-and-convert
3241 widget 'custom-browse-group-tag)
3242 buttons)
3243 (insert " " tag "\n")
3244 (widget-put widget :buttons buttons)
3245 (message "Creating group...")
3246 (let* ((members (custom-sort-items members
3247 custom-browse-sort-alphabetically
3248 custom-browse-order-groups))
3249 (prefixes (widget-get widget :custom-prefixes))
3250 (custom-prefix-list (custom-prefix-add symbol prefixes))
3251 (extra-prefix (if (widget-get widget :custom-last)
3252 " "
3253 " | "))
3254 (prefix (concat prefix extra-prefix))
3255 children entry)
3256 (while members
3257 (setq entry (car members)
3258 members (cdr members))
3259 (push (widget-create-child-and-convert
3260 widget (nth 1 entry)
3261 :group widget
3262 :tag (custom-unlispify-tag-name (nth 0 entry))
3263 :custom-prefixes custom-prefix-list
3264 :custom-level (1+ level)
3265 :custom-last (null members)
3266 :value (nth 0 entry)
3267 :custom-prefix prefix)
3268 children))
3269 (widget-put widget :children (reverse children)))
3270 (message "Creating group...done")))
3271 ;; Nested style.
3272 ((eq state 'hidden)
3273 ;; Create level indicator.
3274 (unless (eq custom-buffer-style 'links)
3275 (insert-char ?\ (* custom-buffer-indent (1- level)))
3276 (insert "-- "))
3277 ;; Create tag.
3278 (let ((begin (point)))
3279 (insert tag)
3280 (widget-specify-sample widget begin (point)))
3281 (insert " group: ")
3282 ;; Create link/visibility indicator.
3283 (if (eq custom-buffer-style 'links)
3284 (push (widget-create-child-and-convert
3285 widget 'custom-group-link
3286 :tag "Go to Group"
3287 symbol)
3288 buttons)
3289 (push (widget-create-child-and-convert
3290 widget 'custom-group-visibility
3291 :help-echo "Show members of this group."
3292 :action 'custom-toggle-parent
3293 (not (eq state 'hidden)))
3294 buttons))
3295 (insert " \n")
3296 ;; Create magic button.
3297 (let ((magic (widget-create-child-and-convert
3298 widget 'custom-magic nil)))
3299 (widget-put widget :custom-magic magic)
3300 (push magic buttons))
3301 ;; Update buttons.
3302 (widget-put widget :buttons buttons)
3303 ;; Insert documentation.
3304 (if (and (eq custom-buffer-style 'links) (> level 1))
3305 (widget-put widget :documentation-indent 0))
3306 (widget-default-format-handler widget ?h))
3307 ;; Nested style.
3308 (t ;Visible.
3309 ;; Add parent groups references above the group.
3310 (if t ;;; This should test that the buffer
3311 ;;; was made to display a group.
3312 (when (eq level 1)
3313 (if (custom-add-parent-links widget
3314 "Go to parent group:")
3315 (insert "\n"))))
3316 ;; Create level indicator.
3317 (insert-char ?\ (* custom-buffer-indent (1- level)))
3318 (insert "/- ")
3319 ;; Create tag.
3320 (let ((start (point)))
3321 (insert tag)
3322 (widget-specify-sample widget start (point)))
3323 (insert " group: ")
3324 ;; Create visibility indicator.
3325 (unless (eq custom-buffer-style 'links)
3326 (insert "--------")
3327 (push (widget-create-child-and-convert
3328 widget 'visibility
3329 :help-echo "Hide members of this group."
3330 :action 'custom-toggle-parent
3331 (not (eq state 'hidden)))
3332 buttons)
3333 (insert " "))
3334 ;; Create more dashes.
3335 ;; Use 76 instead of 75 to compensate for the temporary "<"
3336 ;; added by `widget-insert'.
3337 (insert-char ?- (- 76 (current-column)
3338 (* custom-buffer-indent level)))
3339 (insert "\\\n")
3340 ;; Create magic button.
3341 (let ((magic (widget-create-child-and-convert
3342 widget 'custom-magic
3343 :indent 0
3344 nil)))
3345 (widget-put widget :custom-magic magic)
3346 (push magic buttons))
3347 ;; Update buttons.
3348 (widget-put widget :buttons buttons)
3349 ;; Insert documentation.
3350 (widget-default-format-handler widget ?h)
3351 ;; Parent groups.
3352 (if nil ;;; This should test that the buffer
3353 ;;; was not made to display a group.
3354 (when (eq level 1)
3355 (insert-char ?\ custom-buffer-indent)
3356 (custom-add-parent-links widget)))
3357 (custom-add-see-also widget
3358 (make-string (* custom-buffer-indent level)
3359 ?\ ))
3360 ;; Members.
3361 (message "Creating group...")
3362 (custom-load-widget widget)
3363 (let* ((members (custom-sort-items members
3364 custom-buffer-sort-alphabetically
3365 custom-buffer-order-groups))
3366 (prefixes (widget-get widget :custom-prefixes))
3367 (custom-prefix-list (custom-prefix-add symbol prefixes))
3368 (length (length members))
3369 (count 0)
3370 (children (mapcar (lambda (entry)
3371 (widget-insert "\n")
3372 (message "\
3373 Creating group members... %2d%%"
3374 (/ (* 100.0 count) length))
3375 (setq count (1+ count))
3376 (prog1
3377 (widget-create-child-and-convert
3378 widget (nth 1 entry)
3379 :group widget
3380 :tag (custom-unlispify-tag-name
3381 (nth 0 entry))
3382 :custom-prefixes custom-prefix-list
3383 :custom-level (1+ level)
3384 :value (nth 0 entry))
3385 (unless (eq (preceding-char) ?\n)
3386 (widget-insert "\n"))))
3387 members)))
3388 (message "Creating group magic...")
3389 (mapc 'custom-magic-reset children)
3390 (message "Creating group state...")
3391 (widget-put widget :children children)
3392 (custom-group-state-update widget)
3393 (message "Creating group... done"))
3394 ;; End line
3395 (insert "\n")
3396 (insert-char ?\ (* custom-buffer-indent (1- level)))
3397 (insert "\\- " (widget-get widget :tag) " group end ")
3398 (insert-char ?- (- 75 (current-column) (* custom-buffer-indent level)))
3399 (insert "/\n")))))
3400
3401 (defvar custom-group-menu
3402 '(("Set for Current Session" custom-group-set
3403 (lambda (widget)
3404 (eq (widget-get widget :custom-state) 'modified)))
3405 ("Save for Future Sessions" custom-group-save
3406 (lambda (widget)
3407 (memq (widget-get widget :custom-state) '(modified set))))
3408 ("Reset to Current" custom-group-reset-current
3409 (lambda (widget)
3410 (memq (widget-get widget :custom-state) '(modified))))
3411 ("Reset to Saved" custom-group-reset-saved
3412 (lambda (widget)
3413 (memq (widget-get widget :custom-state) '(modified set))))
3414 ("Reset to standard setting" custom-group-reset-standard
3415 (lambda (widget)
3416 (memq (widget-get widget :custom-state) '(modified set saved)))))
3417 "Alist of actions for the `custom-group' widget.
3418 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
3419 the menu entry, ACTION is the function to call on the widget when the
3420 menu is selected, and FILTER is a predicate which takes a `custom-group'
3421 widget as an argument, and returns non-nil if ACTION is valid on that
3422 widget. If FILTER is nil, ACTION is always valid.")
3423
3424 (defun custom-group-action (widget &optional event)
3425 "Show the menu for `custom-group' WIDGET.
3426 Optional EVENT is the location for the menu."
3427 (if (eq (widget-get widget :custom-state) 'hidden)
3428 (custom-toggle-hide widget)
3429 (let* ((completion-ignore-case t)
3430 (answer (widget-choose (concat "Operation on "
3431 (custom-unlispify-tag-name
3432 (widget-get widget :value)))
3433 (custom-menu-filter custom-group-menu
3434 widget)
3435 event)))
3436 (if answer
3437 (funcall answer widget)))))
3438
3439 (defun custom-group-set (widget)
3440 "Set changes in all modified group members."
3441 (let ((children (widget-get widget :children)))
3442 (mapc (lambda (child)
3443 (when (eq (widget-get child :custom-state) 'modified)
3444 (widget-apply child :custom-set)))
3445 children )))
3446
3447 (defun custom-group-save (widget)
3448 "Save all modified group members."
3449 (let ((children (widget-get widget :children)))
3450 (mapc (lambda (child)
3451 (when (memq (widget-get child :custom-state) '(modified set))
3452 (widget-apply child :custom-save)))
3453 children )))
3454
3455 (defun custom-group-reset-current (widget)
3456 "Reset all modified group members."
3457 (let ((children (widget-get widget :children)))
3458 (mapc (lambda (child)
3459 (when (eq (widget-get child :custom-state) 'modified)
3460 (widget-apply child :custom-reset-current)))
3461 children )))
3462
3463 (defun custom-group-reset-saved (widget)
3464 "Reset all modified or set group members."
3465 (let ((children (widget-get widget :children)))
3466 (mapc (lambda (child)
3467 (when (memq (widget-get child :custom-state) '(modified set))
3468 (widget-apply child :custom-reset-saved)))
3469 children )))
3470
3471 (defun custom-group-reset-standard (widget)
3472 "Reset all modified, set, or saved group members."
3473 (let ((children (widget-get widget :children)))
3474 (mapc (lambda (child)
3475 (when (memq (widget-get child :custom-state)
3476 '(modified set saved))
3477 (widget-apply child :custom-reset-standard)))
3478 children )))
3479
3480 (defun custom-group-state-update (widget)
3481 "Update magic."
3482 (unless (eq (widget-get widget :custom-state) 'hidden)
3483 (let* ((children (widget-get widget :children))
3484 (states (mapcar (lambda (child)
3485 (widget-get child :custom-state))
3486 children))
3487 (magics custom-magic-alist)
3488 (found 'standard))
3489 (while magics
3490 (let ((magic (car (car magics))))
3491 (if (and (not (eq magic 'hidden))
3492 (memq magic states))
3493 (setq found magic
3494 magics nil)
3495 (setq magics (cdr magics)))))
3496 (widget-put widget :custom-state found)))
3497 (custom-magic-reset widget))
3498
3499 ;;; The `custom-save-all' Function.
3500 ;;;###autoload
3501 (defcustom custom-file nil
3502 "File used for storing customization information.
3503 The default is nil, which means to use your init file
3504 as specified by `user-init-file'. If you specify some other file,
3505 you need to explicitly load that file for the settings to take effect.
3506
3507 When you change this variable, look in the previous custom file
3508 \(usually your init file) for the forms `(custom-set-variables ...)'
3509 and `(custom-set-faces ...)', and copy them (whichever ones you find)
3510 to the new custom file. This will preserve your existing customizations."
3511 :type '(choice (const :tag "Your Emacs init file" nil) file)
3512 :group 'customize)
3513
3514 (defun custom-file ()
3515 "Return the file name for saving customizations."
3516 (setq custom-file
3517 (or custom-file
3518 (let ((user-init-file user-init-file)
3519 (default-init-file
3520 (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs")))
3521 (when (null user-init-file)
3522 (if (or (file-exists-p default-init-file)
3523 (and (eq system-type 'windows-nt)
3524 (file-exists-p "~/_emacs")))
3525 ;; Started with -q, i.e. the file containing
3526 ;; Custom settings hasn't been read. Saving
3527 ;; settings there would overwrite other settings.
3528 (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
3529 (setq user-init-file default-init-file))
3530 user-init-file))))
3531
3532 (defun custom-save-delete (symbol)
3533 "Visit `custom-file' and delete all calls to SYMBOL from it.
3534 Leave point at the old location of the first such call,
3535 or (if there were none) at the end of the buffer."
3536 (let ((default-major-mode))
3537 (set-buffer (find-file-noselect (custom-file))))
3538 (goto-char (point-min))
3539 ;; Skip all whitespace and comments.
3540 (while (forward-comment 1))
3541 (or (eobp)
3542 (save-excursion (forward-sexp (buffer-size)))) ; Test for scan errors.
3543 (let (first)
3544 (catch 'found
3545 (while t ;; We exit this loop only via throw.
3546 ;; Skip all whitespace and comments.
3547 (while (forward-comment 1))
3548 (let ((start (point))
3549 (sexp (condition-case nil
3550 (read (current-buffer))
3551 (end-of-file (throw 'found nil)))))
3552 (when (and (listp sexp)
3553 (eq (car sexp) symbol))
3554 (delete-region start (point))
3555 (unless first
3556 (setq first (point)))))))
3557 (if first
3558 (goto-char first)
3559 ;; Move in front of local variables, otherwise long Custom
3560 ;; entries would make them ineffective.
3561 (let ((pos (point-max))
3562 (case-fold-search t))
3563 (save-excursion
3564 (goto-char (point-max))
3565 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3566 'move)
3567 (when (search-forward "Local Variables:" nil t)
3568 (setq pos (line-beginning-position))))
3569 (goto-char pos)))))
3570
3571 (defun custom-save-variables ()
3572 "Save all customized variables in `custom-file'."
3573 (save-excursion
3574 (custom-save-delete 'custom-set-variables)
3575 (let ((standard-output (current-buffer))
3576 (saved-list (make-list 1 0))
3577 sort-fold-case)
3578 ;; First create a sorted list of saved variables.
3579 (mapatoms
3580 (lambda (symbol)
3581 (if (get symbol 'saved-value)
3582 (nconc saved-list (list symbol)))))
3583 (setq saved-list (sort (cdr saved-list) 'string<))
3584 (unless (bolp)
3585 (princ "\n"))
3586 (princ "(custom-set-variables
3587 ;; custom-set-variables was added by Custom -- don't edit or cut/paste it!
3588 ;; Your init file should contain only one such instance.\n")
3589 (mapcar
3590 (lambda (symbol)
3591 (let ((value (get symbol 'saved-value))
3592 (requests (get symbol 'custom-requests))
3593 (now (not (or (get symbol 'standard-value)
3594 (and (not (boundp symbol))
3595 (not (get symbol 'force-value))))))
3596 (comment (get symbol 'saved-variable-comment))
3597 sep)
3598 (when (or value comment)
3599 (unless (bolp)
3600 (princ "\n"))
3601 (princ " '(")
3602 (prin1 symbol)
3603 (princ " ")
3604 (prin1 (car value))
3605 (cond ((or now requests comment)
3606 (princ " ")
3607 (if now
3608 (princ "t")
3609 (princ "nil"))
3610 (cond ((or requests comment)
3611 (princ " ")
3612 (if requests
3613 (prin1 requests)
3614 (princ "nil"))
3615 (cond (comment
3616 (princ " ")
3617 (prin1 comment)
3618 (princ ")"))
3619 (t
3620 (princ ")"))))
3621 (t
3622 (princ ")"))))
3623 (t
3624 (princ ")"))))))
3625 saved-list)
3626 (if (bolp)
3627 (princ " "))
3628 (princ ")")
3629 (unless (looking-at "\n")
3630 (princ "\n")))))
3631
3632 (defun custom-save-faces ()
3633 "Save all customized faces in `custom-file'."
3634 (save-excursion
3635 (custom-save-delete 'custom-set-faces)
3636 (let ((standard-output (current-buffer))
3637 (saved-list (make-list 1 0))
3638 sort-fold-case)
3639 ;; First create a sorted list of saved faces.
3640 (mapatoms
3641 (lambda (symbol)
3642 (if (get symbol 'saved-face)
3643 (nconc saved-list (list symbol)))))
3644 (setq saved-list (sort (cdr saved-list) 'string<))
3645 ;; The default face must be first, since it affects the others.
3646 (if (memq 'default saved-list)
3647 (setq saved-list (cons 'default (delq 'default saved-list))))
3648 (unless (bolp)
3649 (princ "\n"))
3650 (princ "(custom-set-faces
3651 ;; custom-set-faces was added by Custom -- don't edit or cut/paste it!
3652 ;; Your init file should contain only one such instance.\n")
3653 (mapcar
3654 (lambda (symbol)
3655 (let ((value (get symbol 'saved-face))
3656 (now (not (or (get 'default 'face-defface-spec)
3657 (and (not (custom-facep 'default))
3658 (not (get 'default 'force-face))))))
3659 (comment (get 'default 'saved-face-comment)))
3660 (unless (eq symbol 'default))
3661 ;; Don't print default face here.
3662 (unless (bolp)
3663 (princ "\n"))
3664 (princ " '(")
3665 (prin1 symbol)
3666 (princ " ")
3667 (prin1 value)
3668 (cond ((or now comment)
3669 (princ " ")
3670 (if now
3671 (princ "t")
3672 (princ "nil"))
3673 (cond (comment
3674 (princ " ")
3675 (prin1 comment)
3676 (princ ")"))
3677 (t
3678 (princ ")"))))
3679 (t
3680 (princ ")")))))
3681 saved-list)
3682 (if (bolp)
3683 (princ " "))
3684 (princ ")")
3685 (unless (looking-at "\n")
3686 (princ "\n")))))
3687
3688 ;;;###autoload
3689 (defun customize-save-customized ()
3690 "Save all user options which have been set in this session."
3691 (interactive)
3692 (mapatoms (lambda (symbol)
3693 (let ((face (get symbol 'customized-face))
3694 (value (get symbol 'customized-value))
3695 (face-comment (get symbol 'customized-face-comment))
3696 (variable-comment
3697 (get symbol 'customized-variable-comment)))
3698 (when face
3699 (put symbol 'saved-face face)
3700 (put symbol 'customized-face nil))
3701 (when value
3702 (put symbol 'saved-value value)
3703 (put symbol 'customized-value nil))
3704 (when variable-comment
3705 (put symbol 'saved-variable-comment variable-comment)
3706 (put symbol 'customized-variable-comment nil))
3707 (when face-comment
3708 (put symbol 'saved-face-comment face-comment)
3709 (put symbol 'customized-face-comment nil)))))
3710 ;; We really should update all custom buffers here.
3711 (custom-save-all))
3712
3713 ;;;###autoload
3714 (defun custom-save-all ()
3715 "Save all customizations in `custom-file'."
3716 (let ((inhibit-read-only t))
3717 (custom-save-variables)
3718 (custom-save-faces)
3719 (save-excursion
3720 (let ((default-major-mode nil))
3721 (set-buffer (find-file-noselect (custom-file))))
3722 (save-buffer))))
3723
3724 ;;; The Customize Menu.
3725
3726 ;;; Menu support
3727
3728 (defcustom custom-menu-nesting 2
3729 "Maximum nesting in custom menus."
3730 :type 'integer
3731 :group 'custom-menu)
3732
3733 (defun custom-face-menu-create (widget symbol)
3734 "Ignoring WIDGET, create a menu entry for customization face SYMBOL."
3735 (vector (custom-unlispify-menu-entry symbol)
3736 `(customize-face ',symbol)
3737 t))
3738
3739 (defun custom-variable-menu-create (widget symbol)
3740 "Ignoring WIDGET, create a menu entry for customization variable SYMBOL."
3741 (let ((type (get symbol 'custom-type)))
3742 (unless (listp type)
3743 (setq type (list type)))
3744 (if (and type (widget-get type :custom-menu))
3745 (widget-apply type :custom-menu symbol)
3746 (vector (custom-unlispify-menu-entry symbol)
3747 `(customize-variable ',symbol)
3748 t))))
3749
3750 ;; Add checkboxes to boolean variable entries.
3751 (widget-put (get 'boolean 'widget-type)
3752 :custom-menu (lambda (widget symbol)
3753 (vector (custom-unlispify-menu-entry symbol)
3754 `(customize-variable ',symbol)
3755 ':style 'toggle
3756 ':selected symbol)))
3757
3758 (defun custom-group-menu-create (widget symbol)
3759 "Ignoring WIDGET, create a menu entry for customization group SYMBOL."
3760 `( ,(custom-unlispify-menu-entry symbol t)
3761 :filter (lambda (&rest junk)
3762 (cdr (custom-menu-create ',symbol)))))
3763
3764 ;;;###autoload
3765 (defun custom-menu-create (symbol)
3766 "Create menu for customization group SYMBOL.
3767 The menu is in a format applicable to `easy-menu-define'."
3768 (let* ((item (vector (custom-unlispify-menu-entry symbol)
3769 `(customize-group ',symbol)
3770 t)))
3771 (if (and (or (not (boundp 'custom-menu-nesting))
3772 (>= custom-menu-nesting 0))
3773 (< (length (get symbol 'custom-group)) widget-menu-max-size))
3774 (let ((custom-prefix-list (custom-prefix-add symbol
3775 custom-prefix-list))
3776 (members (custom-sort-items (get symbol 'custom-group)
3777 custom-menu-sort-alphabetically
3778 custom-menu-order-groups)))
3779 (custom-load-symbol symbol)
3780 `(,(custom-unlispify-menu-entry symbol t)
3781 ,item
3782 "--"
3783 ,@(mapcar (lambda (entry)
3784 (widget-apply (if (listp (nth 1 entry))
3785 (nth 1 entry)
3786 (list (nth 1 entry)))
3787 :custom-menu (nth 0 entry)))
3788 members)))
3789 item)))
3790
3791 ;;;###autoload
3792 (defun customize-menu-create (symbol &optional name)
3793 "Return a customize menu for customization group SYMBOL.
3794 If optional NAME is given, use that as the name of the menu.
3795 Otherwise the menu will be named `Customize'.
3796 The format is suitable for use with `easy-menu-define'."
3797 (unless name
3798 (setq name "Customize"))
3799 `(,name
3800 :filter (lambda (&rest junk)
3801 (custom-menu-create ',symbol))))
3802
3803 ;;; The Custom Mode.
3804
3805 (defvar custom-mode-map nil
3806 "Keymap for `custom-mode'.")
3807
3808 (unless custom-mode-map
3809 ;; This keymap should be dense, but a dense keymap would prevent inheriting
3810 ;; "\r" bindings from the parent map.
3811 (setq custom-mode-map (make-sparse-keymap))
3812 (set-keymap-parent custom-mode-map widget-keymap)
3813 (suppress-keymap custom-mode-map)
3814 (define-key custom-mode-map " " 'scroll-up)
3815 (define-key custom-mode-map "\177" 'scroll-down)
3816 (define-key custom-mode-map "q" 'Custom-buffer-done)
3817 (define-key custom-mode-map "u" 'Custom-goto-parent)
3818 (define-key custom-mode-map "n" 'widget-forward)
3819 (define-key custom-mode-map "p" 'widget-backward)
3820 (define-key custom-mode-map [mouse-1] 'Custom-move-and-invoke))
3821
3822 (defun Custom-move-and-invoke (event)
3823 "Move to where you click, and if it is an active field, invoke it."
3824 (interactive "e")
3825 (mouse-set-point event)
3826 (if (widget-event-point event)
3827 (let* ((pos (widget-event-point event))
3828 (button (get-char-property pos 'button)))
3829 (if button
3830 (widget-button-click event)))))
3831
3832 (easy-menu-define Custom-mode-menu
3833 custom-mode-map
3834 "Menu used in customization buffers."
3835 `("Custom"
3836 ,(customize-menu-create 'customize)
3837 ["Set" Custom-set t]
3838 ["Save" Custom-save t]
3839 ["Reset to Current" Custom-reset-current t]
3840 ["Reset to Saved" Custom-reset-saved t]
3841 ["Reset to Standard Settings" Custom-reset-standard t]
3842 ["Info" (Info-goto-node "(emacs)Easy Customization") t]))
3843
3844 (defun Custom-goto-parent ()
3845 "Go to the parent group listed at the top of this buffer.
3846 If several parents are listed, go to the first of them."
3847 (interactive)
3848 (save-excursion
3849 (goto-char (point-min))
3850 (if (search-forward "\nGo to parent group: " nil t)
3851 (let* ((button (get-char-property (point) 'button))
3852 (parent (downcase (widget-get button :tag))))
3853 (customize-group parent)))))
3854
3855 (defcustom custom-mode-hook nil
3856 "Hook called when entering Custom mode."
3857 :type 'hook
3858 :group 'custom-buffer )
3859
3860 (defun custom-state-buffer-message (widget)
3861 (if (eq (widget-get (widget-get widget :parent) :custom-state) 'modified)
3862 (message "To install your edits, invoke [State] and choose the Set operation")))
3863
3864 (defun custom-mode ()
3865 "Major mode for editing customization buffers.
3866
3867 The following commands are available:
3868
3869 Move to next button or editable field. \\[widget-forward]
3870 Move to previous button or editable field. \\[widget-backward]
3871 \\<widget-field-keymap>\
3872 Complete content of editable text field. \\[widget-complete]
3873 \\<custom-mode-map>\
3874 Invoke button under the mouse pointer. \\[Custom-move-and-invoke]
3875 Invoke button under point. \\[widget-button-press]
3876 Set all modifications. \\[Custom-set]
3877 Make all modifications default. \\[Custom-save]
3878 Reset all modified options. \\[Custom-reset-current]
3879 Reset all modified or set options. \\[Custom-reset-saved]
3880 Reset all options. \\[Custom-reset-standard]
3881
3882 Entry to this mode calls the value of `custom-mode-hook'
3883 if that value is non-nil."
3884 (kill-all-local-variables)
3885 (setq major-mode 'custom-mode
3886 mode-name "Custom")
3887 (use-local-map custom-mode-map)
3888 (easy-menu-add Custom-mode-menu)
3889 (make-local-variable 'custom-options)
3890 (make-local-variable 'widget-documentation-face)
3891 (setq widget-documentation-face 'custom-documentation-face)
3892 (make-local-variable 'widget-button-face)
3893 (setq widget-button-face 'custom-button-face)
3894 (set (make-local-variable 'widget-button-pressed-face)
3895 'custom-button-pressed-face)
3896 (set (make-local-variable 'widget-mouse-face)
3897 'custom-button-pressed-face) ; buttons `depress' when moused
3898 ;; When possible, use relief for buttons, not bracketing. This test
3899 ;; may not be optimal.
3900 (when custom-raised-buttons
3901 (set (make-local-variable 'widget-push-button-prefix) "")
3902 (set (make-local-variable 'widget-push-button-suffix) "")
3903 (set (make-local-variable 'widget-link-prefix) "")
3904 (set (make-local-variable 'widget-link-suffix) ""))
3905 (add-hook 'widget-edit-functions 'custom-state-buffer-message nil t)
3906 (run-hooks 'custom-mode-hook))
3907
3908 (put 'custom-mode 'mode-class 'special)
3909
3910 (add-to-list
3911 'debug-ignored-errors
3912 "^No user options have changed defaults in recent Emacs versions$")
3913
3914 ;;; The End.
3915
3916 (provide 'cus-edit)
3917
3918 ;;; cus-edit.el ends here