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