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