1 ;;; cus-edit.el --- tools for customizing Emacs and Lisp packages
3 ;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
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)
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.
27 ;; This file implements the code to create and edit customize buffers.
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.
40 (defvar custom-versions-load-alist)) ; from cus-load
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.
57 "Customization of the One True Editor."
58 :link '(custom-manual "(emacs)Top"))
60 ;; Most of these groups are stolen from `finder.el',
62 "Basic text editing facilities."
66 "Abbreviation handling, typing shortcuts, macros."
70 (defgroup matching nil
71 "Various sorts of searching and matching."
74 (defgroup emulations nil
75 "Emulations of other editors."
82 (defgroup outlines nil
83 "Support for hierarchical outlining."
86 (defgroup external nil
87 "Interfacing to external utilities."
91 "Code related to the `bib' bibliography processor."
95 (defgroup processes nil
96 "Process, subshell, compilation, and job control support."
100 (defgroup convenience nil
101 "Convenience features for faster editing."
104 (defgroup programming nil
105 "Support for programming in other languages."
108 (defgroup languages nil
109 "Specialized modes for editing programming languages."
113 "Lisp support, including Emacs Lisp."
118 "Support for the C language and related languages."
126 "Support for object-oriented programming."
129 (defgroup applications nil
130 "Applications written in Emacs."
133 (defgroup calendar nil
134 "Calendar and time management support."
135 :group 'applications)
138 "Modes for electronic-mail handling."
139 :group 'applications)
142 "Support for netnews reading and posting."
143 :group 'applications)
146 "Games, jokes and amusements."
147 :group 'applications)
149 (defgroup development nil
150 "Support for further development of Emacs."
154 "Support for Emacs documentation."
157 (defgroup extensions nil
158 "Emacs Lisp language extensions."
161 (defgroup internal nil
162 "Code for Emacs internals, build process, defaults."
166 "Maintenance aids for the Emacs development group."
170 (defgroup environment nil
171 "Fitting Emacs with its environment."
175 "Communications, networking, remote access to files."
179 (defgroup hardware nil
180 "Support for interfacing with exotic hardware."
183 (defgroup terminals nil
184 "Support for terminal types."
188 "Front-ends/assistants for, or emulators of, UNIX features."
192 "Support code for vms."
196 "Internationalization and alternate character-set support."
201 "The X Window system."
205 "Support for Emacs frames and window systems."
209 "Support editing files of data."
213 "Support editing files."
221 "Code related to the TeX formatter."
225 "Support for multiple fonts."
228 (defgroup hypermedia nil
229 "Support for links between text or other media types."
233 "Support for on-line help systems."
236 (defgroup multimedia nil
237 "Non-textual support, specifically images and sound."
241 "Code local to your site."
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/")
252 (defgroup custom-faces nil
253 "Faces used by customize."
257 (defgroup custom-browse nil
258 "Control customize browser."
262 (defgroup custom-buffer nil
263 "Control customize buffers."
267 (defgroup custom-menu nil
268 "Control customize menus."
272 (defgroup abbrev-mode nil
273 "Word abbreviations mode."
277 "Storage allocation and gc for GNU Emacs Lisp interpreter."
278 :tag "Storage Allocation"
282 "Undoing changes in buffers."
285 (defgroup modeline nil
286 "Content of the modeline."
290 "Indenting and filling text."
293 (defgroup editing-basics nil
294 "Most basic editing facilities."
297 (defgroup display nil
298 "How characters are displayed in buffers."
301 (defgroup execute nil
302 "Executing external commands."
305 (defgroup installation nil
306 "The Emacs installation."
314 "Internal Emacs limits."
318 "Debugging Emacs itself."
321 (defgroup minibuffer nil
322 "Controling the behaviour of the minibuffer."
325 (defgroup keyboard nil
326 "Input from the keyboard."
330 "Input from the mouse."
334 "Input from the menus."
337 (defgroup auto-save nil
338 "Preventing accidential loss of data."
341 (defgroup processes-basics nil
342 "Basic stuff dealing with processes."
346 "MULE Emacs internationalization."
349 (defgroup windows nil
350 "Windows within a frame."
355 (defun custom-quote (sexp)
356 "Quote SEXP iff it is not self quoting."
357 (if (or (memq sexp '(t nil))
360 (memq (car sexp) '(lambda)))
364 ;;; (and (fboundp 'characterp)
365 ;;; (characterp 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."
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)))
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)
391 (setq val (completing-read
393 (format "Customize option: (default %s) " v)
394 "Customize variable: ")
395 obarray (lambda (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)
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."
409 current name action filter)
411 (setq current (car menu)
413 action (nth 1 current)
414 filter (nth 2 current)
416 (if (or (null filter) (funcall filter widget))
417 (push (cons name action) result)
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."
431 (defcustom custom-unlispify-remove-prefixes nil
432 "Non-nil means remove group prefixes from option names in buffer."
434 :group 'custom-buffer
437 (defun custom-unlispify-menu-entry (symbol &optional no-suffix)
438 "Convert SYMBOL into a menu entry."
439 (cond ((not custom-unlispify-menu-entries)
440 (symbol-name symbol))
441 ((get symbol 'custom-tag)
443 (get symbol 'custom-tag)
444 (concat (get symbol 'custom-tag) "...")))
447 (set-buffer (get-buffer-create " *Custom-Work*"))
449 (princ symbol (current-buffer))
450 (goto-char (point-min))
451 (when (and (eq (get symbol 'custom-type) 'boolean)
452 (re-search-forward "-p\\'" nil t))
453 (replace-match "" t t)
454 (goto-char (point-min)))
455 (if custom-unlispify-remove-prefixes
456 (let ((prefixes custom-prefix-list)
459 (setq prefix (car prefixes))
460 (if (search-forward prefix (+ (point) (length prefix)) t)
463 (delete-region (point-min) (point)))
464 (setq prefixes (cdr prefixes))))))
465 (subst-char-in-region (point-min) (point-max) ?- ?\ t)
466 (capitalize-region (point-min) (point-max))
468 (goto-char (point-max))
472 (defcustom custom-unlispify-tag-names t
473 "Display tag names as words instead of symbols if non nil."
474 :group 'custom-buffer
477 (defun custom-unlispify-tag-name (symbol)
478 "Convert SYMBOL into a menu entry."
479 (let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
480 (custom-unlispify-menu-entry symbol t)))
482 (defun custom-prefix-add (symbol prefixes)
483 "Add SYMBOL to list of ignored PREFIXES."
484 (cons (or (get symbol 'custom-prefix)
485 (concat (symbol-name symbol) "-"))
490 (defcustom custom-guess-name-alist
495 ("-function\\'" function)
496 ("-functions\\'" (repeat function))
497 ("-list\\'" (repeat sexp))
498 ("-alist\\'" (repeat (cons sexp sexp))))
499 "Alist of (MATCH TYPE).
501 MATCH should be a regexp matching the name of a symbol, and TYPE should
502 be a widget suitable for editing the value of that symbol. The TYPE
503 of the first entry where MATCH matches the name of the symbol will be
506 This is used for guessing the type of variables not declared with
508 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
511 (defcustom custom-guess-doc-alist
512 '(("\\`\\*?Non-nil " boolean))
513 "Alist of (MATCH TYPE).
515 MATCH should be a regexp matching a documentation string, and TYPE
516 should be a widget suitable for editing the value of a variable with
517 that documentation string. The TYPE of the first entry where MATCH
518 matches the name of the symbol will be used.
520 This is used for guessing the type of variables not declared with
522 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
525 (defun custom-guess-type (symbol)
526 "Guess a widget suitable for editing the value of SYMBOL.
527 This is done by matching SYMBOL with `custom-guess-name-alist' and
528 if that fails, the doc string with `custom-guess-doc-alist'."
529 (let ((name (symbol-name symbol))
530 (names custom-guess-name-alist)
533 (setq current (car names)
535 (when (string-match (nth 0 current) name)
536 (setq found (nth 1 current)
539 (let ((doc (documentation-property symbol 'variable-documentation))
540 (docs custom-guess-doc-alist))
543 (setq current (car docs)
545 (when (string-match (nth 0 current) doc)
546 (setq found (nth 1 current)
552 (defcustom custom-browse-sort-alphabetically nil
553 "If non-nil, sort members of each customization group alphabetically."
555 :group 'custom-browse)
557 (defcustom custom-browse-order-groups nil
558 "If non-nil, order group members within each customization group.
559 If `first', order groups before non-groups.
560 If `last', order groups after non-groups."
561 :type '(choice (const first)
563 (const :tag "none" nil))
564 :group 'custom-browse)
566 (defcustom custom-browse-only-groups nil
567 "If non-nil, show group members only within each customization group."
569 :group 'custom-browse)
571 (defcustom custom-buffer-sort-alphabetically nil
572 "If non-nil, sort members of each customization group alphabetically."
574 :group 'custom-buffer)
576 (defcustom custom-buffer-order-groups 'last
577 "If non-nil, order group members within each customization group.
578 If `first', order groups before non-groups.
579 If `last', order groups after non-groups."
580 :type '(choice (const first)
582 (const :tag "none" nil))
583 :group 'custom-buffer)
585 (defcustom custom-menu-sort-alphabetically nil
586 "If non-nil, sort members of each customization group alphabetically."
590 (defcustom custom-menu-order-groups 'first
591 "If non-nil, order group members within each customization group.
592 If `first', order groups before non-groups.
593 If `last', order groups after non-groups."
594 :type '(choice (const first)
596 (const :tag "none" nil))
599 ;;;###autoload (add-hook 'same-window-regexps "\\`\\*Customiz.*\\*\\'")
601 (defun custom-sort-items (items sort-alphabetically order-groups)
602 "Return a sorted copy of ITEMS.
603 ITEMS should be a `custom-group' property.
604 If SORT-ALPHABETICALLY non-nil, sort alphabetically.
605 If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
606 groups after non-groups, if nil do not order groups at all."
607 (sort (copy-sequence items)
609 (let ((typea (nth 1 a)) (typeb (nth 1 b))
610 (namea (nth 0 a)) (nameb (nth 0 b)))
611 (cond ((not order-groups)
612 ;; Since we don't care about A and B order, maybe sort.
613 (when sort-alphabetically
614 (string-lessp namea nameb)))
615 ((eq typea 'custom-group)
616 ;; If B is also a group, maybe sort. Otherwise, order A and B.
617 (if (eq typeb 'custom-group)
618 (when sort-alphabetically
619 (string-lessp namea nameb))
620 (eq order-groups 'first)))
621 ((eq typeb 'custom-group)
622 ;; Since A cannot be a group, order A and B.
623 (eq order-groups 'last))
625 ;; Since A and B cannot be groups, sort.
626 (string-lessp namea nameb)))))))
628 ;;; Custom Mode Commands.
630 (defvar custom-options nil
631 "Customization widgets in the current buffer.")
634 "Set changes in all modified options."
636 (let ((children custom-options))
637 (mapc (lambda (child)
638 (when (eq (widget-get child :custom-state) 'modified)
639 (widget-apply child :custom-set)))
642 (defun Custom-save ()
643 "Set all modified group members and save them."
645 (let ((children custom-options))
646 (mapc (lambda (child)
647 (when (memq (widget-get child :custom-state)
648 '(modified set changed rogue))
649 (widget-apply child :custom-save)))
653 (defvar custom-reset-menu
654 '(("Current" . Custom-reset-current)
655 ("Saved" . Custom-reset-saved)
656 ("Erase Customization (use standard settings)" . Custom-reset-standard))
657 "Alist of actions for the `Reset' button.
658 The key is a string containing the name of the action, the value is a
659 Lisp function taking the widget as an element which will be called
660 when the action is chosen.")
662 (defun custom-reset (event)
663 "Select item from reset menu."
664 (let* ((completion-ignore-case t)
665 (answer (widget-choose "Reset to"
671 (defun Custom-reset-current (&rest ignore)
672 "Reset all modified group members to their current value."
674 (let ((children custom-options))
675 (mapc (lambda (widget)
676 (and (default-boundp (widget-value widget))
677 (if (memq (widget-get widget :custom-state)
679 (widget-apply widget :custom-reset-current))))
682 (defun Custom-reset-saved (&rest ignore)
683 "Reset all modified or set group members to their saved value."
685 (let ((children custom-options))
686 (mapc (lambda (widget)
687 (and (get (widget-value widget) 'saved-value)
688 (if (memq (widget-get widget :custom-state)
689 '(modified set changed rogue))
690 (widget-apply widget :custom-reset-saved))))
693 (defun Custom-reset-standard (&rest ignore)
694 "Erase all customization (either current or saved) for the group members.
695 The immediate result is to restore them to their standard settings.
696 This operation eliminates any saved settings for the group members,
697 making them as if they had never been customized at all."
699 (let ((children custom-options))
700 (mapc (lambda (widget)
701 (and (get (widget-value widget) 'standard-value)
702 (if (memq (widget-get widget :custom-state)
703 '(modified set changed saved rogue))
704 (widget-apply widget :custom-reset-standard))))
707 ;;; The Customize Commands
709 (defun custom-prompt-variable (prompt-var prompt-val &optional comment)
710 "Prompt for a variable and a value and return them as a list.
711 PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
712 prompt for the value. The %s escape in PROMPT-VAL is replaced with
713 the name of the variable.
715 If the variable has a `variable-interactive' property, that is used as if
716 it were the arg to `interactive' (which see) to interactively read the value.
718 If the variable has a `custom-type' property, it must be a widget and the
719 `:prompt-value' property of that widget will be used for reading the value.
721 If optional COMMENT argument is non nil, also prompt for a comment and return
722 it as the third element in the list."
723 (let* ((var (read-variable prompt-var))
724 (minibuffer-help-form '(describe-variable var))
726 (let ((prop (get var 'variable-interactive))
727 (type (get var 'custom-type))
728 (prompt (format prompt-val var)))
730 (setq type (list type)))
732 ;; Use VAR's `variable-interactive' property
733 ;; as an interactive spec for prompting.
734 (call-interactively (list 'lambda '(arg)
735 (list 'interactive prop)
738 (widget-prompt-value type
744 (eval-minibuffer prompt))))))
747 (read-string "Comment: " (get var 'variable-comment)))
751 (defun customize-set-value (variable value &optional comment)
752 "Set VARIABLE to VALUE, and return VALUE. VALUE is a Lisp object.
754 If VARIABLE has a `variable-interactive' property, that is used as if
755 it were the arg to `interactive' (which see) to interactively read the value.
757 If VARIABLE has a `custom-type' property, it must be a widget and the
758 `:prompt-value' property of that widget will be used for reading the value.
760 If given a prefix (or a COMMENT argument), also prompt for a comment."
761 (interactive (custom-prompt-variable "Set variable: "
765 (cond ((string= comment "")
766 (put variable 'variable-comment nil))
768 (put variable 'variable-comment comment)))
769 (set variable value))
772 (defun customize-set-variable (variable value &optional comment)
773 "Set the default for VARIABLE to VALUE, and return VALUE.
774 VALUE is a Lisp object.
776 If VARIABLE has a `custom-set' property, that is used for setting
777 VARIABLE, otherwise `set-default' is used.
779 The `customized-value' property of the VARIABLE will be set to a list
780 with a quoted VALUE as its sole list member.
782 If VARIABLE has a `variable-interactive' property, that is used as if
783 it were the arg to `interactive' (which see) to interactively read the value.
785 If VARIABLE has a `custom-type' property, it must be a widget and the
786 `:prompt-value' property of that widget will be used for reading the value.
788 If given a prefix (or a COMMENT argument), also prompt for a comment."
789 (interactive (custom-prompt-variable "Set variable: "
790 "Set customized value for %s to: "
792 (custom-load-symbol variable)
793 (funcall (or (get variable 'custom-set) 'set-default) variable value)
794 (put variable 'customized-value (list (custom-quote value)))
795 (cond ((string= comment "")
796 (put variable 'variable-comment nil)
797 (put variable 'customized-variable-comment nil))
799 (put variable 'variable-comment comment)
800 (put variable 'customized-variable-comment comment)))
804 (defun customize-save-variable (variable value &optional comment)
805 "Set the default for VARIABLE to VALUE, and save it for future sessions.
808 If VARIABLE has a `custom-set' property, that is used for setting
809 VARIABLE, otherwise `set-default' is used.
811 The `customized-value' property of the VARIABLE will be set to a list
812 with a quoted VALUE as its sole list member.
814 If VARIABLE has a `variable-interactive' property, that is used as if
815 it were the arg to `interactive' (which see) to interactively read the value.
817 If VARIABLE has a `custom-type' property, it must be a widget and the
818 `:prompt-value' property of that widget will be used for reading the value.
820 If given a prefix (or a COMMENT argument), also prompt for a comment."
821 (interactive (custom-prompt-variable "Set and save variable: "
822 "Set and save value for %s as: "
824 (funcall (or (get variable 'custom-set) 'set-default) variable value)
825 (put variable 'saved-value (list (custom-quote value)))
826 (cond ((string= comment "")
827 (put variable 'variable-comment nil)
828 (put variable 'saved-variable-comment nil))
830 (put variable 'variable-comment comment)
831 (put variable 'saved-variable-comment comment)))
837 "Select a customization buffer which you can use to set user options.
838 User options are structured into \"groups\".
839 Initially the top-level group `Emacs' and its immediate subgroups
840 are shown; the contents of those subgroups are initially hidden."
842 (customize-group 'emacs))
845 (defun customize-group (group)
846 "Customize GROUP, which must be a customization group."
847 (interactive (list (let ((completion-ignore-case t))
848 (completing-read "Customize group: (default emacs) "
851 (or (get symbol 'custom-loads)
852 (get symbol 'custom-group)))
854 (when (stringp group)
855 (if (string-equal "" group)
857 (setq group (intern group))))
858 (or (get group 'custom-group)
859 (custom-load-symbol group))
860 (let ((name (format "*Customize Group: %s*"
861 (custom-unlispify-tag-name group))))
862 (if (get-buffer name)
864 (custom-buffer-create (list (list group 'custom-group))
866 (concat " for group "
867 (custom-unlispify-tag-name group))))))
870 (defun customize-group-other-window (group)
871 "Customize GROUP, which must be a customization group."
872 (interactive (list (let ((completion-ignore-case t))
873 (completing-read "Customize group: (default emacs) "
876 (or (get symbol 'custom-loads)
877 (get symbol 'custom-group)))
879 (when (stringp group)
880 (if (string-equal "" group)
882 (setq group (intern group))))
883 (or (get group 'custom-group)
884 (custom-load-symbol group))
885 (let ((name (format "*Customize Group: %s*"
886 (custom-unlispify-tag-name group))))
887 (if (get-buffer name)
888 (let ((window (selected-window)))
890 (select-window window))
891 (custom-buffer-create-other-window
892 (list (list group 'custom-group))
894 (concat " for group "
895 (custom-unlispify-tag-name group))))))
898 (defalias 'customize-variable 'customize-option)
901 (defun customize-option (symbol)
902 "Customize SYMBOL, which must be a user option variable."
903 (interactive (custom-variable-prompt))
904 ;; If we don't have SYMBOL's real definition loaded,
906 (unless (get symbol 'custom-type)
907 (let ((loaddefs-file (locate-library "loaddefs.el" t))
909 ;; See if it is autoloaded from some library.
912 (insert-file-contents loaddefs-file)
913 (when (re-search-forward (concat "^(defvar " (symbol-name symbol))
915 (search-backward "\n;;; Generated autoloads from ")
916 (goto-char (match-end 0))
917 (setq file (buffer-substring (point)
918 (progn (end-of-line) (point)))))))
919 ;; If it is, load that library.
921 (when (string-match "\\.el\\'" file)
922 (setq file (substring file 0 (match-beginning 0))))
924 (unless (get symbol 'custom-type)
925 (error "Variable %s cannot be customized" symbol))
926 (custom-buffer-create (list (list symbol 'custom-variable))
927 (format "*Customize Option: %s*"
928 (custom-unlispify-tag-name symbol))))
930 (defvar customize-changed-options-previous-release "20.2"
931 "Version for `customize-changed-options' to refer back to by default.")
934 (defun customize-changed-options (since-version)
935 "Customize all user option variables changed in Emacs itself.
936 This includes new user option variables and faces, and new
937 customization groups, as well as older options and faces whose default
938 values have changed since the previous major Emacs release.
940 With argument SINCE-VERSION (a string), customize all user option
941 variables that were added (or their meanings were changed) since that
944 (interactive "sCustomize options changed, since version (default all versions): ")
945 (if (equal since-version "")
946 (setq since-version nil)
947 (unless (condition-case nil
948 (numberp (read since-version))
950 (signal 'wrong-type-argument (list 'numberp since-version))))
951 (unless since-version
952 (setq since-version customize-changed-options-previous-release))
955 (mapatoms (lambda (symbol)
956 (and (or (boundp symbol)
957 ;; For variables not yet loaded.
958 (get symbol 'standard-value)
959 ;; For groups the previous test fails, this one
960 ;; could be used to determine if symbol is a
961 ;; group. Is there a better way for this?
962 (get symbol 'group-documentation))
963 (let ((version (get symbol 'custom-version)))
965 (or (null since-version)
966 (customize-version-lessp since-version version))
967 (if (member version versions)
969 ;;; Collect all versions that we use.
970 (push version versions))))
972 ;; We have to set the right thing here,
973 ;; depending if we have a group or a
975 (if (get symbol 'group-documentation)
976 (cons (list symbol 'custom-group) found)
977 (cons (list symbol 'custom-variable) found))))))
979 (error "No user option defaults have been changed since Emacs %s"
984 (cdr (assoc (car versions) custom-versions-load-alist)))
986 (setq versions (cdr versions)))
987 (put 'custom-versions-load-alist 'custom-loads
988 ;; Get all the files that correspond to element from the
989 ;; VERSIONS list. This could use some simplification.
990 (apply 'nconc flist)))
991 ;; Because we set all the files needed to be loaded as a
992 ;; `custom-loads' property to `custom-versions-load-alist' this
993 ;; call will actually load them.
994 (custom-load-symbol 'custom-versions-load-alist)
996 (put 'custom-versions-load-alist 'custom-loads nil)
997 (custom-buffer-create (custom-sort-items found t 'first)
998 "*Customize Changed Options*"))))
1000 (defun customize-version-lessp (version1 version2)
1001 ;; Why are the versions strings, and given that they are, why aren't
1002 ;; they converted to numbers and compared as such here? -- fx
1004 ;; In case someone made a mistake and left out the quotes
1005 ;; in the :version value.
1006 (if (numberp version2)
1007 (setq version2 (prin1-to-string version2)))
1008 (let (major1 major2 minor1 minor2)
1009 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version1)
1010 (setq major1 (read (or (match-string 1 version1)
1012 (setq minor1 (read (or (match-string 3 version1)
1014 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version2)
1015 (setq major2 (read (or (match-string 1 version2)
1017 (setq minor2 (read (or (match-string 3 version2)
1019 (or (< major1 major2)
1020 (and (= major1 major2)
1021 (< minor1 minor2)))))
1024 (defalias 'customize-variable-other-window 'customize-option-other-window)
1027 (defun customize-option-other-window (symbol)
1028 "Customize SYMBOL, which must be a user option variable.
1029 Show the buffer in another window, but don't select it."
1030 (interactive (custom-variable-prompt))
1031 (custom-buffer-create-other-window
1032 (list (list symbol 'custom-variable))
1033 (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
1036 (defun customize-face (&optional face)
1037 "Customize SYMBOL, which should be a face name or nil.
1038 If SYMBOL is nil, customize all faces.
1040 Interactively, when point is on text which has a face specified,
1041 suggest to customized that face, if it's customizable."
1043 (list (read-face-name "Customize face" "all faces" t)))
1044 (if (member face '(nil ""))
1045 (setq face (face-list)))
1046 (if (and (listp face) (null (cdr face)))
1047 (setq face (car face)))
1049 (custom-buffer-create (custom-sort-items
1051 (list s 'custom-face))
1054 "*Customize Faces*")
1055 (unless (facep face)
1056 (error "Invalid face %S"))
1057 (custom-buffer-create (list (list face 'custom-face))
1058 (format "*Customize Face: %s*"
1059 (custom-unlispify-tag-name face)))))
1062 (defun customize-face-other-window (&optional face)
1063 "Show customization buffer for face SYMBOL in other window.
1065 Interactively, when point is on text which has a face specified,
1066 suggest to customized that face, if it's customizable."
1068 (list (read-face-name "Customize face" "all faces" t)))
1069 (if (member face '(nil ""))
1070 (setq face (face-list)))
1071 (if (and (listp face) (null (cdr face)))
1072 (setq face (car face)))
1074 (custom-buffer-create-other-window
1077 (list s 'custom-face))
1080 "*Customize Faces*")
1081 (unless (facep face)
1082 (error "Invalid face %S"))
1083 (custom-buffer-create-other-window
1084 (list (list face 'custom-face))
1085 (format "*Customize Face: %s*"
1086 (custom-unlispify-tag-name face)))))
1089 (defun customize-customized ()
1090 "Customize all user options set since the last save in this session."
1093 (mapatoms (lambda (symbol)
1094 (and (or (get symbol 'customized-face)
1095 (get symbol 'customized-face-comment))
1096 (custom-facep symbol)
1097 (push (list symbol 'custom-face) found))
1098 (and (or (get symbol 'customized-value)
1099 (get symbol 'customized-variable-comment))
1101 (push (list symbol 'custom-variable) found))))
1103 (error "No customized user options")
1104 (custom-buffer-create (custom-sort-items found t nil)
1105 "*Customize Customized*"))))
1108 (defun customize-saved ()
1109 "Customize all already saved user options."
1112 (mapatoms (lambda (symbol)
1113 (and (or (get symbol 'saved-face)
1114 (get symbol 'saved-face-comment))
1115 (custom-facep symbol)
1116 (push (list symbol 'custom-face) found))
1117 (and (or (get symbol 'saved-value)
1118 (get symbol 'saved-variable-comment))
1120 (push (list symbol 'custom-variable) found))))
1122 (error "No saved user options")
1123 (custom-buffer-create (custom-sort-items found t nil)
1124 "*Customize Saved*"))))
1127 (defun customize-apropos (regexp &optional all)
1128 "Customize all user options matching REGEXP.
1129 If ALL is `options', include only options.
1130 If ALL is `faces', include only faces.
1131 If ALL is `groups', include only groups.
1132 If ALL is t (interactively, with prefix arg), include options which are not
1133 user-settable, as well as faces and groups."
1134 (interactive "sCustomize regexp: \nP")
1136 (mapatoms (lambda (symbol)
1137 (when (string-match regexp (symbol-name symbol))
1138 (when (and (not (memq all '(faces options)))
1139 (get symbol 'custom-group))
1140 (push (list symbol 'custom-group) found))
1141 (when (and (not (memq all '(options groups)))
1142 (custom-facep symbol))
1143 (push (list symbol 'custom-face) found))
1144 (when (and (not (memq all '(groups faces)))
1146 (or (get symbol 'saved-value)
1147 (get symbol 'standard-value)
1148 (if (memq all '(nil options))
1149 (user-variable-p symbol)
1150 (get symbol 'variable-documentation))))
1151 (push (list symbol 'custom-variable) found)))))
1153 (error "No matches")
1154 (custom-buffer-create (custom-sort-items found t
1155 custom-buffer-order-groups)
1156 "*Customize Apropos*"))))
1159 (defun customize-apropos-options (regexp &optional arg)
1160 "Customize all user options matching REGEXP.
1161 With prefix arg, include options which are not user-settable."
1162 (interactive "sCustomize regexp: \nP")
1163 (customize-apropos regexp (or arg 'options)))
1166 (defun customize-apropos-faces (regexp)
1167 "Customize all user faces matching REGEXP."
1168 (interactive "sCustomize regexp: \n")
1169 (customize-apropos regexp 'faces))
1172 (defun customize-apropos-groups (regexp)
1173 "Customize all user groups matching REGEXP."
1174 (interactive "sCustomize regexp: \n")
1175 (customize-apropos regexp 'groups))
1179 (defcustom custom-buffer-style 'links
1180 "Control the presentation style for customization buffers.
1181 The value should be a symbol, one of:
1183 brackets: groups nest within each other with big horizontal brackets.
1184 links: groups have links to subgroups."
1185 :type '(radio (const brackets)
1187 :group 'custom-buffer)
1189 ;; If we pass BUFFER to `bury-buffer', the buffer isn't removed from
1191 (defun custom-bury-buffer (buffer)
1194 (defcustom custom-buffer-done-function 'custom-bury-buffer
1195 "*Function called to remove a Custom buffer when the user is done with it.
1196 Called with one argument, the buffer to remove."
1197 :type '(choice (function-item :tag "Bury buffer" custom-bury-buffer)
1198 (function-item :tag "Kill buffer" kill-buffer)
1199 (function :tag "Other"))
1201 :group 'custom-buffer)
1203 (defcustom custom-buffer-indent 3
1204 "Number of spaces to indent nested groups."
1206 :group 'custom-buffer)
1209 (defun custom-buffer-create (options &optional name description)
1210 "Create a buffer containing OPTIONS.
1211 Optional NAME is the name of the buffer.
1212 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1213 SYMBOL is a customization option, and WIDGET is a widget for editing
1215 (unless name (setq name "*Customization*"))
1216 (kill-buffer (get-buffer-create name))
1217 (pop-to-buffer (get-buffer-create name))
1218 (custom-buffer-create-internal options description))
1221 (defun custom-buffer-create-other-window (options &optional name description)
1222 "Create a buffer containing OPTIONS.
1223 Optional NAME is the name of the buffer.
1224 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1225 SYMBOL is a customization option, and WIDGET is a widget for editing
1227 (unless name (setq name "*Customization*"))
1228 (kill-buffer (get-buffer-create name))
1229 (let ((window (selected-window))
1231 (special-display-buffer-names nil)
1232 (special-display-regexps nil)
1233 (same-window-buffer-names nil)
1234 (same-window-regexps nil))
1235 (pop-to-buffer (get-buffer-create name))
1236 (custom-buffer-create-internal options description)
1237 (select-window window)))
1239 (defcustom custom-reset-button-menu nil
1240 "If non-nil, only show a single reset button in customize buffers.
1241 This button will have a menu with all three reset operations."
1243 :group 'custom-buffer)
1245 (defcustom custom-buffer-verbose-help t
1246 "If non-nil, include explanatory text in the customization buffer."
1248 :group 'custom-buffer)
1250 (defun Custom-buffer-done (&rest ignore)
1251 "Remove current buffer by calling `custom-buffer-done-function'."
1253 (funcall custom-buffer-done-function (current-buffer)))
1255 (defcustom custom-raised-buttons (not (equal (face-valid-attribute-values :box)
1256 '(("unspecified" . unspecified))))
1257 "If non-nil, indicate active buttons in a `raised-button' style.
1258 Otherwise use brackets."
1261 :group 'custom-buffer)
1263 (defun custom-buffer-create-internal (options &optional description)
1264 (message "Creating customization buffer...")
1266 (if custom-buffer-verbose-help
1268 (widget-insert "This is a customization buffer")
1270 (widget-insert description))
1271 (widget-insert (format ".
1272 %s show active fields; type RET or click mouse-1
1273 on an active field to invoke its action. Editing an option value
1274 changes the text in the buffer; invoke the State button and
1275 choose the Set operation to set the option value.
1276 Invoke " (if custom-raised-buttons
1278 "Square brackets")))
1279 (widget-create 'info-link
1281 :help-echo "Read the online help."
1282 "(emacs)Easy Customization")
1283 (widget-insert " for more information.\n\n")
1284 (message "Creating customization buttons...")
1285 (widget-insert "Operate on everything in this buffer:\n "))
1286 (widget-insert " "))
1287 (widget-create 'push-button
1288 :tag "Set for Current Session"
1290 Make your editing in this buffer take effect for this session."
1291 :action (lambda (widget &optional event)
1294 (widget-create 'push-button
1295 :tag "Save for Future Sessions"
1297 Make your editing in this buffer take effect for future Emacs sessions."
1298 :action (lambda (widget &optional event)
1300 (if custom-reset-button-menu
1303 (widget-create 'push-button
1305 :help-echo "Show a menu with reset operations."
1306 :mouse-down-action (lambda (&rest junk) t)
1307 :action (lambda (widget &optional event)
1308 (custom-reset event))))
1309 (widget-insert "\n ")
1310 (widget-create 'push-button
1313 Reset all edited text in this buffer to reflect current values."
1314 :action 'Custom-reset-current)
1316 (widget-create 'push-button
1317 :tag "Reset to Saved"
1319 Reset all values in this buffer to their saved settings."
1320 :action 'Custom-reset-saved)
1322 (widget-create 'push-button
1323 :tag "Erase Customization"
1325 Un-customize all values in this buffer. They get their standard settings."
1326 :action 'Custom-reset-standard))
1327 (if (not custom-buffer-verbose-help)
1330 (widget-create 'info-link
1332 :help-echo "Read the online help."
1333 "(emacs)Easy Customization")))
1335 (widget-create 'push-button
1338 (lambda (&rest ignore)
1340 ((eq custom-buffer-done-function
1341 'custom-bury-buffer)
1343 ((eq custom-buffer-done-function 'kill-buffer)
1345 (t "Finish with this buffer")))
1346 :action #'Custom-buffer-done)
1347 (widget-insert "\n\n")
1348 (message "Creating customization items...")
1349 (buffer-disable-undo)
1350 (setq custom-options
1351 (if (= (length options) 1)
1352 (mapcar (lambda (entry)
1353 (widget-create (nth 1 entry)
1354 :documentation-shown t
1355 :custom-state 'unknown
1356 :tag (custom-unlispify-tag-name
1358 :value (nth 0 entry)))
1361 (length (length options)))
1362 (mapcar (lambda (entry)
1364 (message "Creating customization items ...%2d%%"
1365 (/ (* 100.0 count) length))
1366 (widget-create (nth 1 entry)
1367 :tag (custom-unlispify-tag-name
1369 :value (nth 0 entry))
1370 (setq count (1+ count))
1371 (unless (eq (preceding-char) ?\n)
1372 (widget-insert "\n"))
1373 (widget-insert "\n")))
1375 (unless (eq (preceding-char) ?\n)
1376 (widget-insert "\n"))
1377 (message "Creating customization items ...done")
1378 (unless (eq custom-buffer-style 'tree)
1379 (mapc 'custom-magic-reset custom-options))
1380 (message "Creating customization setup...")
1382 (buffer-enable-undo)
1383 (goto-char (point-min))
1384 (message "Creating customization buffer...done"))
1386 ;;; The Tree Browser.
1389 (defun customize-browse (&optional group)
1390 "Create a tree browser for the customize hierarchy."
1393 (setq group 'emacs))
1394 (let ((name "*Customize Browser*"))
1395 (kill-buffer (get-buffer-create name))
1396 (pop-to-buffer (get-buffer-create name)))
1399 Square brackets show active fields; type RET or click mouse-1
1400 on an active field to invoke its action.
1401 Invoke [+] below to expand a group, and [-] to collapse an expanded group.\n")
1402 (if custom-browse-only-groups
1404 Invoke the [Group] button below to edit that item in another window.\n\n")
1405 (widget-insert "Invoke the ")
1406 (widget-create 'item
1409 :tag-glyph "folder")
1410 (widget-insert ", ")
1411 (widget-create 'item
1415 (widget-insert ", and ")
1416 (widget-create 'item
1419 :tag-glyph "option")
1420 (widget-insert " buttons below to edit that
1421 item in another window.\n\n"))
1422 (let ((custom-buffer-style 'tree))
1423 (widget-create 'custom-group
1425 :custom-state 'unknown
1426 :tag (custom-unlispify-tag-name group)
1428 (goto-char (point-min)))
1430 (define-widget 'custom-browse-visibility 'item
1431 "Control visibility of items in the customize tree browser."
1433 :action 'custom-browse-visibility-action)
1435 (defun custom-browse-visibility-action (widget &rest ignore)
1436 (let ((custom-buffer-style 'tree))
1437 (custom-toggle-parent widget)))
1439 (define-widget 'custom-browse-group-tag 'push-button
1440 "Show parent in other window when activated."
1443 :action 'custom-browse-group-tag-action)
1445 (defun custom-browse-group-tag-action (widget &rest ignore)
1446 (let ((parent (widget-get widget :parent)))
1447 (customize-group-other-window (widget-value parent))))
1449 (define-widget 'custom-browse-variable-tag 'push-button
1450 "Show parent in other window when activated."
1453 :action 'custom-browse-variable-tag-action)
1455 (defun custom-browse-variable-tag-action (widget &rest ignore)
1456 (let ((parent (widget-get widget :parent)))
1457 (customize-variable-other-window (widget-value parent))))
1459 (define-widget 'custom-browse-face-tag 'push-button
1460 "Show parent in other window when activated."
1463 :action 'custom-browse-face-tag-action)
1465 (defun custom-browse-face-tag-action (widget &rest ignore)
1466 (let ((parent (widget-get widget :parent)))
1467 (customize-face-other-window (widget-value parent))))
1469 (defconst custom-browse-alist '((" " "space")
1475 (defun custom-browse-insert-prefix (prefix)
1476 "Insert PREFIX. On XEmacs convert it to line graphics."
1477 ;; Fixme: do graphics.
1478 (if nil ; (string-match "XEmacs" emacs-version)
1481 (while (not (string-equal prefix ""))
1482 (let ((entry (substring prefix 0 3)))
1483 (setq prefix (substring prefix 3))
1484 (let ((overlay (make-overlay (1- (point)) (point) nil t nil))
1485 (name (nth 1 (assoc entry custom-browse-alist))))
1486 (overlay-put overlay 'end-glyph (widget-glyph-find name entry))
1487 (overlay-put overlay 'start-open t)
1488 (overlay-put overlay 'end-open t)))))
1491 ;;; Modification of Basic Widgets.
1493 ;; We add extra properties to the basic widgets needed here. This is
1494 ;; fine, as long as we are careful to stay within out own namespace.
1496 ;; We want simple widgets to be displayed by default, but complex
1497 ;; widgets to be hidden.
1499 (widget-put (get 'item 'widget-type) :custom-show t)
1500 (widget-put (get 'editable-field 'widget-type)
1501 :custom-show (lambda (widget value)
1502 (let ((pp (pp-to-string value)))
1503 (cond ((string-match "\n" pp)
1508 (widget-put (get 'menu-choice 'widget-type) :custom-show t)
1510 ;;; The `custom-manual' Widget.
1512 (define-widget 'custom-manual 'info-link
1513 "Link to the manual entry for this customization option."
1514 :help-echo "Read the manual entry for this option."
1517 ;;; The `custom-magic' Widget.
1519 (defgroup custom-magic-faces nil
1520 "Faces used by the magic button."
1521 :group 'custom-faces
1522 :group 'custom-buffer)
1524 (defface custom-invalid-face '((((class color))
1525 (:foreground "yellow" :background "red"))
1527 (:weight bold :slant italic :underline t)))
1528 "Face used when the customize item is invalid."
1529 :group 'custom-magic-faces)
1531 (defface custom-rogue-face '((((class color))
1532 (:foreground "pink" :background "black"))
1535 "Face used when the customize item is not defined for customization."
1536 :group 'custom-magic-faces)
1538 (defface custom-modified-face '((((class color))
1539 (:foreground "white" :background "blue"))
1541 (:slant italic :bold)))
1542 "Face used when the customize item has been modified."
1543 :group 'custom-magic-faces)
1545 (defface custom-set-face '((((class color))
1546 (:foreground "blue" :background "white"))
1549 "Face used when the customize item has been set."
1550 :group 'custom-magic-faces)
1552 (defface custom-changed-face '((((class color))
1553 (:foreground "white" :background "blue"))
1556 "Face used when the customize item has been changed."
1557 :group 'custom-magic-faces)
1559 (defface custom-saved-face '((t (:underline t)))
1560 "Face used when the customize item has been saved."
1561 :group 'custom-magic-faces)
1563 (defconst custom-magic-alist '((nil "#" underline "\
1564 uninitialized, you should not see this.")
1565 (unknown "?" italic "\
1566 unknown, you should not see this.")
1567 (hidden "-" default "\
1568 hidden, invoke \"Show\" in the previous line to show." "\
1569 group now hidden, invoke \"Show\", above, to show contents.")
1570 (invalid "x" custom-invalid-face "\
1571 the value displayed for this %c is invalid and cannot be set.")
1572 (modified "*" custom-modified-face "\
1573 you have edited the value as text, but you have not set the %c." "\
1574 you have edited something in this group, but not set it.")
1575 (set "+" custom-set-face "\
1576 you have set this %c, but not saved it for future sessions." "\
1577 something in this group has been set, but not saved.")
1578 (changed ":" custom-changed-face "\
1579 this %c has been changed outside the customize buffer." "\
1580 something in this group has been changed outside customize.")
1581 (saved "!" custom-saved-face "\
1582 this %c has been set and saved." "\
1583 something in this group has been set and saved.")
1584 (rogue "@" custom-rogue-face "\
1585 this %c has not been changed with customize." "\
1586 something in this group is not prepared for customization.")
1587 (standard " " nil "\
1588 this %c is unchanged from its standard setting." "\
1589 visible group members are all at standard settings."))
1590 "Alist of customize option states.
1591 Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where
1593 STATE is one of the following symbols:
1596 For internal use, should never occur.
1598 For internal use, should never occur.
1600 This item is not being displayed.
1602 This item is modified, but has an invalid form.
1604 This item is modified, and has a valid form.
1606 This item has been set but not saved.
1608 The current value of this item has been changed temporarily.
1610 This item is marked for saving.
1612 This item has no customization information.
1614 This item is unchanged from the standard setting.
1616 MAGIC is a string used to present that state.
1618 FACE is a face used to present the state.
1620 ITEM-DESC is a string describing the state for options.
1622 GROUP-DESC is a string describing the state for groups. If this is
1623 left out, ITEM-DESC will be used.
1625 The string %c in either description will be replaced with the
1626 category of the item. These are `group'. `option', and `face'.
1628 The list should be sorted most significant first.")
1630 (defcustom custom-magic-show 'long
1631 "If non-nil, show textual description of the state.
1632 If `long', show a full-line description, not just one word."
1633 :type '(choice (const :tag "no" nil)
1635 (other :tag "short" short))
1636 :group 'custom-buffer)
1638 (defcustom custom-magic-show-hidden '(option face)
1639 "Control whether the State button is shown for hidden items.
1640 The value should be a list with the custom categories where the State
1641 button should be visible. Possible categories are `group', `option',
1643 :type '(set (const group) (const option) (const face))
1644 :group 'custom-buffer)
1646 (defcustom custom-magic-show-button nil
1647 "Show a \"magic\" button indicating the state of each customization option."
1649 :group 'custom-buffer)
1651 (define-widget 'custom-magic 'default
1652 "Show and manipulate state for a customization option."
1654 :action 'widget-parent-action
1657 :value-create 'custom-magic-value-create
1658 :value-delete 'widget-children-value-delete)
1660 (defun widget-magic-mouse-down-action (widget &optional event)
1661 ;; Non-nil unless hidden.
1662 (not (eq (widget-get (widget-get (widget-get widget :parent) :parent)
1666 (defun custom-magic-value-create (widget)
1667 "Create compact status report for WIDGET."
1668 (let* ((parent (widget-get widget :parent))
1669 (state (widget-get parent :custom-state))
1670 (hidden (eq state 'hidden))
1671 (entry (assq state custom-magic-alist))
1672 (magic (nth 1 entry))
1673 (face (nth 2 entry))
1674 (category (widget-get parent :custom-category))
1675 (text (or (and (eq category 'group)
1678 (form (widget-get parent :custom-form))
1680 (while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text)
1681 (setq text (concat (match-string 1 text)
1682 (symbol-name category)
1683 (match-string 2 text))))
1684 (when (and custom-magic-show
1686 (memq category custom-magic-show-hidden)))
1688 (when (and (eq category 'group)
1689 (not (and (eq custom-buffer-style 'links)
1690 (> (widget-get parent :custom-level) 1))))
1691 (insert-char ?\ (* custom-buffer-indent
1692 (widget-get parent :custom-level))))
1693 (push (widget-create-child-and-convert
1695 :help-echo "Change the state of this item."
1696 :format (if hidden "%t" "%[%t%]")
1697 :button-prefix 'widget-push-button-prefix
1698 :button-suffix 'widget-push-button-suffix
1699 :mouse-down-action 'widget-magic-mouse-down-action
1703 (let ((start (point)))
1704 (if (eq custom-magic-show 'long)
1706 (insert (symbol-name state)))
1707 (cond ((eq form 'lisp)
1709 ((eq form 'mismatch)
1710 (insert " (mismatch)")))
1711 (put-text-property start (point) 'face 'custom-state-face))
1713 (when (and (eq category 'group)
1714 (not (and (eq custom-buffer-style 'links)
1715 (> (widget-get parent :custom-level) 1))))
1716 (insert-char ?\ (* custom-buffer-indent
1717 (widget-get parent :custom-level))))
1718 (when custom-magic-show-button
1719 (when custom-magic-show
1720 (let ((indent (widget-get parent :indent)))
1722 (insert-char ? indent))))
1723 (push (widget-create-child-and-convert
1725 :mouse-down-action 'widget-magic-mouse-down-action
1729 :help-echo "Change the state."
1730 :format (if hidden "%t" "%[%t%]")
1731 :tag (if (memq form '(lisp mismatch))
1732 (concat "(" magic ")")
1733 (concat "[" magic "]")))
1736 (widget-put widget :children children)))
1738 (defun custom-magic-reset (widget)
1739 "Redraw the :custom-magic property of WIDGET."
1740 (let ((magic (widget-get widget :custom-magic)))
1741 (widget-value-set magic (widget-value magic))))
1743 ;;; The `custom' Widget.
1745 (defface custom-button-face
1746 '((((type x w32 mac) (class color)) ; Like default modeline
1747 (:box (:line-width 2 :style released-button)
1748 :background "lightgrey" :foreground "black"))
1751 "Face used for buttons in customization buffers."
1753 :group 'custom-faces)
1755 (defface custom-button-pressed-face
1756 '((((type x w32 mac) (class color))
1757 (:box (:line-width 2 :style pressed-button)
1758 :background "lightgrey" :foreground "black"))
1760 (:inverse-video t)))
1761 "Face used for buttons in customization buffers."
1763 :group 'custom-faces)
1765 (defface custom-documentation-face nil
1766 "Face used for documentation strings in customization buffers."
1767 :group 'custom-faces)
1769 (defface custom-state-face '((((class color)
1771 (:foreground "lime green"))
1774 (:foreground "dark green"))
1776 "Face used for State descriptions in the customize buffer."
1777 :group 'custom-faces)
1779 (define-widget 'custom 'default
1780 "Customize a user option."
1782 :convert-widget 'custom-convert-widget
1783 :notify 'custom-notify
1786 :custom-state 'hidden
1787 :documentation-property 'widget-subclass-responsibility
1788 :value-create 'widget-subclass-responsibility
1789 :value-delete 'widget-children-value-delete
1790 :value-get 'widget-value-value-get
1791 :validate 'widget-children-validate
1792 :match (lambda (widget value) (symbolp value)))
1794 (defun custom-convert-widget (widget)
1795 "Initialize :value and :tag from :args in WIDGET."
1796 (let ((args (widget-get widget :args)))
1798 (widget-put widget :value (widget-apply widget
1799 :value-to-internal (car args)))
1800 (widget-put widget :tag (custom-unlispify-tag-name (car args)))
1801 (widget-put widget :args nil)))
1804 (defun custom-notify (widget &rest args)
1805 "Keep track of changes."
1806 (let ((state (widget-get widget :custom-state)))
1807 (unless (eq state 'modified)
1808 (unless (memq state '(nil unknown hidden))
1809 (widget-put widget :custom-state 'modified))
1810 (custom-magic-reset widget)
1811 (apply 'widget-default-notify widget args))))
1813 (defun custom-redraw (widget)
1814 "Redraw WIDGET with current settings."
1815 (let ((line (count-lines (point-min) (point)))
1816 (column (current-column))
1818 (from (marker-position (widget-get widget :from)))
1819 (to (marker-position (widget-get widget :to))))
1821 (widget-value-set widget (widget-value widget))
1822 (custom-redraw-magic widget))
1823 (when (and (>= pos from) (<= pos to))
1828 (goto-line (1+ line)))
1829 (move-to-column column))
1832 (defun custom-redraw-magic (widget)
1833 "Redraw WIDGET state with current settings."
1835 (let ((magic (widget-get widget :custom-magic)))
1837 (widget-value-set magic (widget-value magic))
1838 (when (setq widget (widget-get widget :group))
1839 (custom-group-state-update widget)))
1841 (setq widget nil)))))
1844 (defun custom-show (widget value)
1845 "Non-nil if WIDGET should be shown with VALUE by default."
1846 (let ((show (widget-get widget :custom-show)))
1852 (funcall show widget value)))))
1854 (defun custom-load-widget (widget)
1855 "Load all dependencies for WIDGET."
1856 (custom-load-symbol (widget-value widget)))
1858 (defun custom-unloaded-symbol-p (symbol)
1859 "Return non-nil if the dependencies of SYMBOL has not yet been loaded."
1861 (loads (get symbol 'custom-loads))
1864 (setq load (car loads)
1866 (cond ((symbolp load)
1867 (unless (featurep load)
1869 ((assoc load load-history))
1870 ((assoc (locate-library load) load-history)
1876 (defun custom-unloaded-widget-p (widget)
1877 "Return non-nil if the dependencies of WIDGET has not yet been loaded."
1878 (custom-unloaded-symbol-p (widget-value widget)))
1880 (defun custom-toggle-hide (widget)
1881 "Toggle visibility of WIDGET."
1882 (custom-load-widget widget)
1883 (let ((state (widget-get widget :custom-state)))
1884 (cond ((memq state '(invalid modified))
1885 (error "There are unset changes"))
1887 (widget-put widget :custom-state 'unknown))
1889 (widget-put widget :documentation-shown nil)
1890 (widget-put widget :custom-state 'hidden)))
1891 (custom-redraw widget)
1894 (defun custom-toggle-parent (widget &rest ignore)
1895 "Toggle visibility of parent of WIDGET."
1896 (custom-toggle-hide (widget-get widget :parent)))
1898 (defun custom-add-see-also (widget &optional prefix)
1899 "Add `See also ...' to WIDGET if there are any links.
1900 Insert PREFIX first if non-nil."
1901 (let* ((symbol (widget-get widget :value))
1902 (links (get symbol 'custom-links))
1903 (many (> (length links) 2))
1904 (buttons (widget-get widget :buttons))
1905 (indent (widget-get widget :indent)))
1908 (insert-char ?\ indent))
1911 (insert "See also ")
1913 (push (widget-create-child-and-convert widget (car links))
1915 (setq links (cdr links))
1924 (widget-put widget :buttons buttons))))
1926 (defun custom-add-parent-links (widget &optional initial-string)
1927 "Add \"Parent groups: ...\" to WIDGET if the group has parents.
1928 The value if non-nil if any parents were found.
1929 If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
1930 (let ((name (widget-value widget))
1931 (type (widget-type widget))
1932 (buttons (widget-get widget :buttons))
1935 (insert (or initial-string "Parent groups:"))
1936 (mapatoms (lambda (symbol)
1937 (let ((entry (assq name (get symbol 'custom-group))))
1938 (when (eq (nth 1 entry) type)
1940 (push (widget-create-child-and-convert
1941 widget 'custom-group-link
1942 :tag (custom-unlispify-tag-name symbol)
1946 (widget-put widget :buttons buttons)
1949 (delete-region start (point)))
1952 ;;; The `custom-comment' Widget.
1954 ;; like the editable field
1955 (defface custom-comment-face '((((class grayscale color)
1957 (:background "gray85"))
1958 (((class grayscale color)
1960 (:background "dim gray"))
1963 "Face used for comments on variables or faces"
1965 :group 'custom-faces)
1967 ;; like font-lock-comment-face
1968 (defface custom-comment-tag-face
1969 '((((class color) (background dark)) (:foreground "gray80"))
1970 (((class color) (background light)) (:foreground "blue4"))
1971 (((class grayscale) (background light))
1972 (:foreground "DimGray" :weight bold :slant italic))
1973 (((class grayscale) (background dark))
1974 (:foreground "LightGray" :weight bold :slant italic))
1976 "Face used for variables or faces comment tags"
1977 :group 'custom-faces)
1979 (define-widget 'custom-comment 'string
1982 :help-echo "Edit a comment here."
1983 :sample-face 'custom-comment-tag-face
1984 :value-face 'custom-comment-face
1986 :create 'custom-comment-create)
1988 (defun custom-comment-create (widget)
1989 (let* ((null-comment (equal "" (widget-value widget))))
1990 (if (or (widget-get (widget-get widget :parent) :comment-shown)
1992 (widget-default-create widget)
1993 ;; `widget-default-delete' expects markers in these slots --
1994 ;; maybe it shouldn't.
1995 (widget-put widget :from (point-marker))
1996 (widget-put widget :to (point-marker)))))
1998 (defun custom-comment-hide (widget)
1999 (widget-put (widget-get widget :parent) :comment-shown nil))
2001 ;; Those functions are for the menu. WIDGET is NOT the comment widget. It's
2002 ;; the global custom one
2003 (defun custom-comment-show (widget)
2004 (widget-put widget :comment-shown t)
2005 (custom-redraw widget)
2008 (defun custom-comment-invisible-p (widget)
2009 (let ((val (widget-value (widget-get widget :comment-widget))))
2011 (not (widget-get widget :comment-shown)))))
2013 ;;; The `custom-variable' Widget.
2015 ;; When this was underlined blue, users confused it with a
2016 ;; Mosaic-style hyperlink...
2017 (defface custom-variable-tag-face
2020 (:foreground "light blue" :weight bold :height 1.2 :inherit variable-pitch))
2023 (:foreground "blue" :weight bold :height 1.2 :inherit variable-pitch))
2025 "Face used for unpushable variable tags."
2026 :group 'custom-faces)
2028 (defface custom-variable-button-face '((t (:underline t :weight bold)))
2029 "Face used for pushable variable tags."
2030 :group 'custom-faces)
2032 (defcustom custom-variable-default-form 'edit
2033 "Default form of displaying variable values."
2034 :type '(choice (const edit)
2036 :group 'custom-buffer
2039 (define-widget 'custom-variable 'custom
2040 "Customize variable."
2042 :help-echo "Set or reset this variable."
2043 :documentation-property 'variable-documentation
2044 :custom-category 'option
2046 :custom-menu 'custom-variable-menu-create
2047 :custom-form nil ; defaults to value of `custom-variable-default-form'
2048 :value-create 'custom-variable-value-create
2049 :action 'custom-variable-action
2050 :custom-set 'custom-variable-set
2051 :custom-save 'custom-variable-save
2052 :custom-reset-current 'custom-redraw
2053 :custom-reset-saved 'custom-variable-reset-saved
2054 :custom-reset-standard 'custom-variable-reset-standard)
2056 (defun custom-variable-type (symbol)
2057 "Return a widget suitable for editing the value of SYMBOL.
2058 If SYMBOL has a `custom-type' property, use that.
2059 Otherwise, look up symbol in `custom-guess-type-alist'."
2060 (let* ((type (or (get symbol 'custom-type)
2061 (and (not (get symbol 'standard-value))
2062 (custom-guess-type symbol))
2064 (options (get symbol 'custom-options))
2065 (tmp (if (listp type)
2066 (copy-sequence type)
2069 (widget-put tmp :options options))
2072 (defun custom-variable-value-create (widget)
2073 "Here is where you edit the variable's value."
2074 (custom-load-widget widget)
2075 (unless (widget-get widget :custom-form)
2076 (widget-put widget :custom-form custom-variable-default-form))
2077 (let* ((buttons (widget-get widget :buttons))
2078 (children (widget-get widget :children))
2079 (form (widget-get widget :custom-form))
2080 (state (widget-get widget :custom-state))
2081 (symbol (widget-get widget :value))
2082 (tag (widget-get widget :tag))
2083 (type (custom-variable-type symbol))
2084 (conv (widget-convert type))
2085 (get (or (get symbol 'custom-get) 'default-value))
2086 (prefix (widget-get widget :custom-prefix))
2087 (last (widget-get widget :custom-last))
2088 (value (if (default-boundp symbol)
2089 (funcall get symbol)
2090 (widget-get conv :value))))
2091 ;; If the widget is new, the child determines whether it is hidden.
2093 ((custom-show type value)
2094 (setq state 'unknown))
2096 (setq state 'hidden)))
2097 ;; If we don't know the state, see if we need to edit it in lisp form.
2098 (when (eq state 'unknown)
2099 (unless (widget-apply conv :match value)
2100 ;; (widget-apply (widget-convert type) :match value)
2101 (setq form 'mismatch)))
2102 ;; Now we can create the child widget.
2103 (cond ((eq custom-buffer-style 'tree)
2104 (insert prefix (if last " `--- " " |--- "))
2105 (push (widget-create-child-and-convert
2106 widget 'custom-browse-variable-tag)
2108 (insert " " tag "\n")
2109 (widget-put widget :buttons buttons))
2111 ;; Indicate hidden value.
2112 (push (widget-create-child-and-convert
2115 :sample-face 'custom-variable-tag-face
2119 (push (widget-create-child-and-convert
2121 :help-echo "Show the value of this option."
2122 :action 'custom-toggle-parent
2125 ((memq form '(lisp mismatch))
2126 ;; In lisp mode edit the saved value when possible.
2127 (let* ((value (cond ((get symbol 'saved-value)
2128 (car (get symbol 'saved-value)))
2129 ((get symbol 'standard-value)
2130 (car (get symbol 'standard-value)))
2131 ((default-boundp symbol)
2132 (custom-quote (funcall get symbol)))
2134 (custom-quote (widget-get conv :value))))))
2135 (insert (symbol-name symbol) ": ")
2136 (push (widget-create-child-and-convert
2138 :help-echo "Hide the value of this option."
2139 :action 'custom-toggle-parent
2143 (push (widget-create-child-and-convert
2145 :button-face 'custom-variable-button-face
2147 :tag (symbol-name symbol)
2153 (let* ((format (widget-get type :format))
2154 tag-format value-format)
2155 (unless (string-match ":" format)
2156 (error "Bad format"))
2157 (setq tag-format (substring format 0 (match-end 0)))
2158 (setq value-format (substring format (match-end 0)))
2159 (push (widget-create-child-and-convert
2162 :action 'custom-tag-action
2163 :help-echo "Change value of this option."
2164 :mouse-down-action 'custom-tag-mouse-down-action
2165 :button-face 'custom-variable-button-face
2166 :sample-face 'custom-variable-tag-face
2170 (push (widget-create-child-and-convert
2172 :help-echo "Hide the value of this option."
2173 :action 'custom-toggle-parent
2176 (push (widget-create-child-and-convert
2178 :format value-format
2181 (unless (eq custom-buffer-style 'tree)
2182 (unless (eq (preceding-char) ?\n)
2183 (widget-insert "\n"))
2184 ;; Create the magic button.
2185 (let ((magic (widget-create-child-and-convert
2186 widget 'custom-magic nil)))
2187 (widget-put widget :custom-magic magic)
2188 (push magic buttons))
2189 ;; ### NOTE: this is ugly!!!! I need to update the :buttons property
2190 ;; before the call to `widget-default-format-handler'. Otherwise, I
2191 ;; loose my current `buttons'. This function shouldn't be called like
2192 ;; this anyway. The doc string widget should be added like the others.
2194 (widget-put widget :buttons buttons)
2195 ;; Insert documentation.
2196 (widget-default-format-handler widget ?h)
2198 ;; The comment field
2199 (unless (eq state 'hidden)
2200 (let* ((comment (get symbol 'variable-comment))
2202 (widget-create-child-and-convert
2203 widget 'custom-comment
2205 :value (or comment ""))))
2206 (widget-put widget :comment-widget comment-widget)
2207 ;; Don't push it !!! Custom assumes that the first child is the
2209 (setq children (append children (list comment-widget)))))
2210 ;; Update the rest of the properties properties.
2211 (widget-put widget :custom-form form)
2212 (widget-put widget :children children)
2213 ;; Now update the state.
2214 (if (eq state 'hidden)
2215 (widget-put widget :custom-state state)
2216 (custom-variable-state-set widget))
2218 (unless (eq state 'hidden)
2219 (when (eq (widget-get widget :custom-level) 1)
2220 (custom-add-parent-links widget))
2221 (custom-add-see-also widget)))))
2223 (defun custom-tag-action (widget &rest args)
2224 "Pass :action to first child of WIDGET's parent."
2225 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2228 (defun custom-tag-mouse-down-action (widget &rest args)
2229 "Pass :mouse-down-action to first child of WIDGET's parent."
2230 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2231 :mouse-down-action args))
2233 (defun custom-variable-state-set (widget)
2234 "Set the state of WIDGET."
2235 (let* ((symbol (widget-value widget))
2236 (get (or (get symbol 'custom-get) 'default-value))
2237 (value (if (default-boundp symbol)
2238 (funcall get symbol)
2239 (widget-get widget :value)))
2240 (comment (get symbol 'variable-comment))
2243 (state (cond ((progn (setq tmp (get symbol 'customized-value))
2245 (get symbol 'customized-variable-comment))
2247 (if (condition-case nil
2248 (and (equal value (eval (car tmp)))
2249 (equal comment temp))
2253 ((progn (setq tmp (get symbol 'saved-value))
2254 (setq temp (get symbol 'saved-variable-comment))
2256 (if (condition-case nil
2257 (and (equal value (eval (car tmp)))
2258 (equal comment temp))
2262 ((setq tmp (get symbol 'standard-value))
2263 (if (condition-case nil
2264 (and (equal value (eval (car tmp)))
2265 (equal comment nil))
2270 (widget-put widget :custom-state state)))
2272 (defvar custom-variable-menu
2273 '(("Set for Current Session" custom-variable-set
2275 (eq (widget-get widget :custom-state) 'modified)))
2276 ("Save for Future Sessions" custom-variable-save
2278 (memq (widget-get widget :custom-state) '(modified set changed rogue))))
2279 ("Reset to Current" custom-redraw
2281 (and (default-boundp (widget-value widget))
2282 (memq (widget-get widget :custom-state) '(modified changed)))))
2283 ("Reset to Saved" custom-variable-reset-saved
2285 (and (or (get (widget-value widget) 'saved-value)
2286 (get (widget-value widget) 'saved-variable-comment))
2287 (memq (widget-get widget :custom-state)
2288 '(modified set changed rogue)))))
2289 ("Erase Customization" custom-variable-reset-standard
2291 (and (get (widget-value widget) 'standard-value)
2292 (memq (widget-get widget :custom-state)
2293 '(modified set changed saved rogue)))))
2294 ("---" ignore ignore)
2295 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2296 ("---" ignore ignore)
2297 ("Don't show as Lisp expression" custom-variable-edit
2299 (eq (widget-get widget :custom-form) 'lisp)))
2300 ("Show initial Lisp expression" custom-variable-edit-lisp
2302 (eq (widget-get widget :custom-form) 'edit))))
2303 "Alist of actions for the `custom-variable' widget.
2304 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2305 the menu entry, ACTION is the function to call on the widget when the
2306 menu is selected, and FILTER is a predicate which takes a `custom-variable'
2307 widget as an argument, and returns non-nil if ACTION is valid on that
2308 widget. If FILTER is nil, ACTION is always valid.")
2310 (defun custom-variable-action (widget &optional event)
2311 "Show the menu for `custom-variable' WIDGET.
2312 Optional EVENT is the location for the menu."
2313 (if (eq (widget-get widget :custom-state) 'hidden)
2314 (custom-toggle-hide widget)
2315 (unless (eq (widget-get widget :custom-state) 'modified)
2316 (custom-variable-state-set widget))
2317 (custom-redraw-magic widget)
2318 (let* ((completion-ignore-case t)
2319 (answer (widget-choose (concat "Operation on "
2320 (custom-unlispify-tag-name
2321 (widget-get widget :value)))
2322 (custom-menu-filter custom-variable-menu
2326 (funcall answer widget)))))
2328 (defun custom-variable-edit (widget)
2329 "Edit value of WIDGET."
2330 (widget-put widget :custom-state 'unknown)
2331 (widget-put widget :custom-form 'edit)
2332 (custom-redraw widget))
2334 (defun custom-variable-edit-lisp (widget)
2335 "Edit the Lisp representation of the value of WIDGET."
2336 (widget-put widget :custom-state 'unknown)
2337 (widget-put widget :custom-form 'lisp)
2338 (custom-redraw widget))
2340 (defun custom-variable-set (widget)
2341 "Set the current value for the variable being edited by WIDGET."
2342 (let* ((form (widget-get widget :custom-form))
2343 (state (widget-get widget :custom-state))
2344 (child (car (widget-get widget :children)))
2345 (symbol (widget-value widget))
2346 (set (or (get symbol 'custom-set) 'set-default))
2347 (comment-widget (widget-get widget :comment-widget))
2348 (comment (widget-value comment-widget))
2350 (cond ((eq state 'hidden)
2351 (error "Cannot set hidden variable"))
2352 ((setq val (widget-apply child :validate))
2353 (goto-char (widget-get val :from))
2354 (error "%s" (widget-get val :error)))
2355 ((memq form '(lisp mismatch))
2356 (when (equal comment "")
2358 ;; Make the comment invisible by hand if it's empty
2359 (custom-comment-hide comment-widget))
2360 (funcall set symbol (eval (setq val (widget-value child))))
2361 (put symbol 'customized-value (list val))
2362 (put symbol 'variable-comment comment)
2363 (put symbol 'customized-variable-comment comment))
2365 (when (equal comment "")
2367 ;; Make the comment invisible by hand if it's empty
2368 (custom-comment-hide comment-widget))
2369 (funcall set symbol (setq val (widget-value child)))
2370 (put symbol 'customized-value (list (custom-quote val)))
2371 (put symbol 'variable-comment comment)
2372 (put symbol 'customized-variable-comment comment)))
2373 (custom-variable-state-set widget)
2374 (custom-redraw-magic widget)))
2376 (defun custom-variable-save (widget)
2377 "Set and save the value for the variable being edited by WIDGET."
2378 (let* ((form (widget-get widget :custom-form))
2379 (state (widget-get widget :custom-state))
2380 (child (car (widget-get widget :children)))
2381 (symbol (widget-value widget))
2382 (set (or (get symbol 'custom-set) 'set-default))
2383 (comment-widget (widget-get widget :comment-widget))
2384 (comment (widget-value comment-widget))
2386 (cond ((eq state 'hidden)
2387 (error "Cannot set hidden variable"))
2388 ((setq val (widget-apply child :validate))
2389 (goto-char (widget-get val :from))
2390 (error "Saving %s: %s" symbol (widget-get val :error)))
2391 ((memq form '(lisp mismatch))
2392 (when (equal comment "")
2394 ;; Make the comment invisible by hand if it's empty
2395 (custom-comment-hide comment-widget))
2396 (put symbol 'saved-value (list (widget-value child)))
2397 (funcall set symbol (eval (widget-value child)))
2398 (put symbol 'variable-comment comment)
2399 (put symbol 'saved-variable-comment comment))
2401 (when (equal comment "")
2403 ;; Make the comment invisible by hand if it's empty
2404 (custom-comment-hide comment-widget))
2405 (put symbol 'saved-value
2406 (list (custom-quote (widget-value child))))
2407 (funcall set symbol (widget-value child))
2408 (put symbol 'variable-comment comment)
2409 (put symbol 'saved-variable-comment comment)))
2410 (put symbol 'customized-value nil)
2411 (put symbol 'customized-variable-comment nil)
2413 (custom-variable-state-set widget)
2414 (custom-redraw-magic widget)))
2416 (defun custom-variable-reset-saved (widget)
2417 "Restore the saved value for the variable being edited by WIDGET."
2418 (let* ((symbol (widget-value widget))
2419 (set (or (get symbol 'custom-set) 'set-default))
2420 (value (get symbol 'saved-value))
2421 (comment (get symbol 'saved-variable-comment)))
2422 (cond ((or value comment)
2423 (put symbol 'variable-comment comment)
2425 (funcall set symbol (eval (car value)))
2428 (error "No saved value for %s" symbol)))
2429 (put symbol 'customized-value nil)
2430 (put symbol 'customized-variable-comment nil)
2431 (widget-put widget :custom-state 'unknown)
2432 ;; This call will possibly make the comment invisible
2433 (custom-redraw widget)))
2435 (defun custom-variable-reset-standard (widget)
2436 "Restore the standard setting for the variable being edited by WIDGET.
2437 This operation eliminates any saved setting for the variable,
2438 restoring it to the state of a variable that has never been customized."
2439 (let* ((symbol (widget-value widget))
2440 (set (or (get symbol 'custom-set) 'set-default)))
2441 (if (get symbol 'standard-value)
2442 (funcall set symbol (eval (car (get symbol 'standard-value))))
2443 (error "No standard setting known for %S" symbol))
2444 (put symbol 'variable-comment nil)
2445 (put symbol 'customized-value nil)
2446 (put symbol 'customized-variable-comment nil)
2447 (when (or (get symbol 'saved-value) (get symbol 'saved-variable-comment))
2448 (put symbol 'saved-value nil)
2449 (put symbol 'saved-variable-comment nil)
2451 (widget-put widget :custom-state 'unknown)
2452 ;; This call will possibly make the comment invisible
2453 (custom-redraw widget)))
2455 ;;; The `custom-face-edit' Widget.
2457 (define-widget 'custom-face-edit 'checklist
2458 "Edit face attributes."
2462 :button-args '(:help-echo "Control whether this attribute has any effect.")
2463 :value-to-internal 'custom-face-edit-fix-value
2464 :match (lambda (widget value)
2465 (widget-checklist-match widget
2466 (custom-face-edit-fix-value widget value)))
2467 :convert-widget 'custom-face-edit-convert-widget
2468 :args (mapcar (lambda (att)
2471 :sibling-args (widget-get (nth 1 att) :sibling-args)
2472 (list 'const :format "" :value (nth 0 att))
2474 custom-face-attributes))
2476 (defun custom-face-edit-fix-value (widget value)
2477 "Ignoring WIDGET, convert :bold and :italic in VALUE to new form."
2480 (let ((key (car value))
2481 (val (car (cdr value))))
2482 (cond ((eq key :italic)
2483 (push :slant result)
2484 (push (if val 'italic 'normal) result))
2486 (push :weight result)
2487 (push (if val 'bold 'normal) result))
2490 (push val result))))
2491 (setq value (cdr (cdr value))))
2492 (setq result (nreverse result))
2495 (defun custom-face-edit-convert-widget (widget)
2496 "Convert :args as widget types in WIDGET."
2499 :args (mapcar (lambda (arg)
2501 :deactivate 'custom-face-edit-deactivate
2502 :activate 'custom-face-edit-activate
2503 :delete 'custom-face-edit-delete))
2504 (widget-get widget :args)))
2507 (defun custom-face-edit-deactivate (widget)
2508 "Make face widget WIDGET inactive for user modifications."
2509 (unless (widget-get widget :inactive)
2510 (let ((tag (custom-face-edit-attribute-tag widget))
2511 (from (copy-marker (widget-get widget :from)))
2512 (to (widget-get widget :to))
2513 (value (widget-value widget))
2514 (inhibit-read-only t)
2515 (inhibit-modification-hooks t))
2518 (widget-default-delete widget)
2519 (insert tag ": *\n")
2520 (widget-put widget :inactive
2521 (cons value (cons from (- (point) from))))))))
2523 (defun custom-face-edit-activate (widget)
2524 "Make face widget WIDGET inactive for user modifications."
2525 (let ((inactive (widget-get widget :inactive))
2526 (inhibit-read-only t)
2527 (inhibit-modification-hooks t))
2528 (when (consp inactive)
2530 (goto-char (car (cdr inactive)))
2531 (delete-region (point) (+ (point) (cdr (cdr inactive))))
2532 (widget-put widget :inactive nil)
2533 (widget-apply widget :create)
2534 (widget-value-set widget (car inactive))
2537 (defun custom-face-edit-delete (widget)
2538 "Remove widget from the buffer."
2539 (let ((inactive (widget-get widget :inactive))
2540 (inhibit-read-only t)
2541 (inhibit-modification-hooks t))
2543 ;; Widget is alive, we don't have to do anything special
2544 (widget-default-delete widget)
2545 ;; WIDGET is already deleted because we did so to inactivate it;
2546 ;; now just get rid of the label we put in its place.
2547 (delete-region (car (cdr inactive))
2548 (+ (car (cdr inactive)) (cdr (cdr inactive))))
2549 (widget-put widget :inactive nil))))
2552 (defun custom-face-edit-attribute-tag (widget)
2553 "Returns the first :tag property in WIDGET or one of its children."
2554 (let ((tag (widget-get widget :tag)))
2555 (or (and (not (equal tag "")) tag)
2556 (let ((children (widget-get widget :children)))
2557 (while (and (null tag) children)
2558 (setq tag (custom-face-edit-attribute-tag (pop children))))
2561 ;;; The `custom-display' Widget.
2563 (define-widget 'custom-display 'menu-choice
2564 "Select a display type."
2567 :help-echo "Specify frames where the face attributes should be used."
2568 :args '((const :tag "all" t)
2572 :args ((group :sibling-args (:help-echo "\
2573 Only match the specified window systems.")
2574 (const :format "Type: "
2576 (checklist :inline t
2579 :sibling-args (:help-echo "\
2580 The X11 Window System.")
2582 (const :format "PM "
2583 :sibling-args (:help-echo "\
2584 OS/2 Presentation Manager.")
2586 (const :format "W32 "
2587 :sibling-args (:help-echo "\
2590 (const :format "DOS "
2591 :sibling-args (:help-echo "\
2594 (const :format "TTY%n"
2595 :sibling-args (:help-echo "\
2596 Plain text terminals.")
2598 (group :sibling-args (:help-echo "\
2599 Only match the frames with the specified color support.")
2600 (const :format "Class: "
2602 (checklist :inline t
2604 (const :format "Color "
2605 :sibling-args (:help-echo "\
2606 Match color frames.")
2608 (const :format "Grayscale "
2609 :sibling-args (:help-echo "\
2610 Match grayscale frames.")
2612 (const :format "Monochrome%n"
2613 :sibling-args (:help-echo "\
2614 Match frames with no color support.")
2616 (group :sibling-args (:help-echo "\
2617 Only match frames with the specified intensity.")
2619 Background brightness: "
2621 (checklist :inline t
2623 (const :format "Light "
2624 :sibling-args (:help-echo "\
2625 Match frames with light backgrounds.")
2627 (const :format "Dark\n"
2628 :sibling-args (:help-echo "\
2629 Match frames with dark backgrounds.")
2631 (group :sibling-args (:help-echo "\
2632 Only match frames that support the specified face attributes.")
2633 (const :format "Supports attributes:" supports)
2634 (custom-face-edit :inline t :format "%n%v"))))))
2636 ;;; The `custom-face' Widget.
2638 (defface custom-face-tag-face
2639 `((t (:weight bold :height 1.2 :inherit variable-pitch)))
2640 "Face used for face tags."
2641 :group 'custom-faces)
2643 (defcustom custom-face-default-form 'selected
2644 "Default form of displaying face definition."
2645 :type '(choice (const all)
2648 :group 'custom-buffer
2651 (define-widget 'custom-face 'custom
2653 :sample-face 'custom-face-tag-face
2654 :help-echo "Set or reset this face."
2655 :documentation-property #'face-doc-string
2656 :value-create 'custom-face-value-create
2657 :action 'custom-face-action
2658 :custom-category 'face
2659 :custom-form nil ; defaults to value of `custom-face-default-form'
2660 :custom-set 'custom-face-set
2661 :custom-save 'custom-face-save
2662 :custom-reset-current 'custom-redraw
2663 :custom-reset-saved 'custom-face-reset-saved
2664 :custom-reset-standard 'custom-face-reset-standard
2665 :custom-menu 'custom-face-menu-create)
2667 (define-widget 'custom-face-all 'editable-list
2668 "An editable list of display specifications and attributes."
2669 :entry-format "%i %d %v"
2670 :insert-button-args '(:help-echo "Insert new display specification here.")
2671 :append-button-args '(:help-echo "Append new display specification here.")
2672 :delete-button-args '(:help-echo "Delete this display specification.")
2673 :args '((group :format "%v" custom-display custom-face-edit)))
2675 (defconst custom-face-all (widget-convert 'custom-face-all)
2676 "Converted version of the `custom-face-all' widget.")
2678 (define-widget 'custom-display-unselected 'item
2679 "A display specification that doesn't match the selected display."
2680 :match 'custom-display-unselected-match)
2682 (defun custom-display-unselected-match (widget value)
2683 "Non-nil if VALUE is an unselected display specification."
2684 (not (face-spec-set-match-display value (selected-frame))))
2686 (define-widget 'custom-face-selected 'group
2687 "Edit the attributes of the selected display in a face specification."
2688 :args '((repeat :format ""
2690 (group custom-display-unselected sexp))
2691 (group (sexp :format "") custom-face-edit)
2696 (defconst custom-face-selected (widget-convert 'custom-face-selected)
2697 "Converted version of the `custom-face-selected' widget.")
2699 (defun custom-filter-face-spec (spec filter-index &optional default-filter)
2700 "Return a canonicalized version of SPEC using.
2701 FILTER-INDEX is the index in the entry for each attribute in
2702 `custom-face-attributes' at which the appropriate filter function can be
2703 found, and DEFAULT-FILTER is the filter to apply for attributes that
2705 (mapcar (lambda (entry)
2706 ;; Filter a single face-spec entry
2707 (let ((tests (car entry))
2709 ;; Handle both old- and new-style attribute syntax
2710 (if (listp (car (cdr entry)))
2713 (filtered-attrs nil))
2714 ;; Filter each face attribute
2715 (while unfiltered-attrs
2716 (let* ((attr (pop unfiltered-attrs))
2717 (pre-filtered-value (pop unfiltered-attrs))
2719 (or (nth filter-index (assq attr custom-face-attributes))
2723 (funcall filter pre-filtered-value)
2724 pre-filtered-value)))
2725 (push filtered-value filtered-attrs)
2726 (push attr filtered-attrs)))
2728 (list tests filtered-attrs)))
2731 (defun custom-pre-filter-face-spec (spec)
2732 "Return SPEC changed as necessary for editing by the face customization widget.
2733 SPEC must be a full face spec."
2734 (custom-filter-face-spec spec 2))
2736 (defun custom-post-filter-face-spec (spec)
2737 "Return the customized SPEC in a form suitable for setting the face."
2738 (custom-filter-face-spec spec 3))
2740 (defun custom-face-value-create (widget)
2741 "Create a list of the display specifications for WIDGET."
2742 (let ((buttons (widget-get widget :buttons))
2744 (symbol (widget-get widget :value))
2745 (tag (widget-get widget :tag))
2746 (state (widget-get widget :custom-state))
2748 (is-last (widget-get widget :custom-last))
2749 (prefix (widget-get widget :custom-prefix)))
2751 (setq tag (prin1-to-string symbol)))
2752 (cond ((eq custom-buffer-style 'tree)
2753 (insert prefix (if is-last " `--- " " |--- "))
2754 (push (widget-create-child-and-convert
2755 widget 'custom-browse-face-tag)
2757 (insert " " tag "\n")
2758 (widget-put widget :buttons buttons))
2762 (widget-specify-sample widget begin (point))
2763 (if (eq custom-buffer-style 'face)
2765 (if (string-match "face\\'" tag)
2767 (insert " face: ")))
2769 (push (widget-create-child-and-convert widget 'item
2776 (push (widget-create-child-and-convert
2778 :help-echo "Hide or show this face."
2779 :action 'custom-toggle-parent
2780 (not (eq state 'hidden)))
2784 (let ((magic (widget-create-child-and-convert
2785 widget 'custom-magic nil)))
2786 (widget-put widget :custom-magic magic)
2787 (push magic buttons))
2789 (widget-put widget :buttons buttons)
2790 ;; Insert documentation.
2791 (widget-default-format-handler widget ?h)
2792 ;; The comment field
2793 (unless (eq state 'hidden)
2794 (let* ((comment (get symbol 'face-comment))
2796 (widget-create-child-and-convert
2797 widget 'custom-comment
2799 :value (or comment ""))))
2800 (widget-put widget :comment-widget comment-widget)
2801 (push comment-widget children)))
2803 (unless (eq state 'hidden)
2804 (when (eq (widget-get widget :custom-level) 1)
2805 (custom-add-parent-links widget))
2806 (custom-add-see-also widget))
2808 (unless (eq (preceding-char) ?\n)
2810 (unless (eq state 'hidden)
2811 (message "Creating face editor...")
2812 (custom-load-widget widget)
2813 (unless (widget-get widget :custom-form)
2814 (widget-put widget :custom-form custom-face-default-form))
2815 (let* ((symbol (widget-value widget))
2816 (spec (or (get symbol 'customized-face)
2817 (get symbol 'saved-face)
2818 (get symbol 'face-defface-spec)
2819 ;; Attempt to construct it.
2820 (list (list t (custom-face-attributes-get
2821 symbol (selected-frame))))))
2822 (form (widget-get widget :custom-form))
2823 (indent (widget-get widget :indent))
2825 ;; If the user has changed this face in some other way,
2826 ;; edit it as the user has specified it.
2827 (if (not (face-spec-match-p symbol spec (selected-frame)))
2828 (setq spec (list (list t (face-attr-construct symbol (selected-frame))))))
2829 (setq spec (custom-pre-filter-face-spec spec))
2830 (setq edit (widget-create-child-and-convert
2832 (cond ((and (eq form 'selected)
2833 (widget-apply custom-face-selected
2835 (when indent (insert-char ?\ indent))
2836 'custom-face-selected)
2837 ((and (not (eq form 'lisp))
2838 (widget-apply custom-face-all
2842 (when indent (insert-char ?\ indent))
2845 (custom-face-state-set widget)
2846 (push edit children)
2847 (widget-put widget :children children))
2848 (message "Creating face editor...done"))))))
2850 (defvar custom-face-menu
2851 '(("Set for Current Session" custom-face-set)
2852 ("Save for Future Sessions" custom-face-save-command)
2853 ("Reset to Saved" custom-face-reset-saved
2855 (or (get (widget-value widget) 'saved-face)
2856 (get (widget-value widget) 'saved-face-comment))))
2857 ("Erase Customization" custom-face-reset-standard
2859 (get (widget-value widget) 'face-defface-spec)))
2860 ("---" ignore ignore)
2861 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2862 ("---" ignore ignore)
2863 ("Show all display specs" custom-face-edit-all
2865 (not (eq (widget-get widget :custom-form) 'all))))
2866 ("Just current attributes" custom-face-edit-selected
2868 (not (eq (widget-get widget :custom-form) 'selected))))
2869 ("Show as Lisp expression" custom-face-edit-lisp
2871 (not (eq (widget-get widget :custom-form) 'lisp)))))
2872 "Alist of actions for the `custom-face' widget.
2873 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2874 the menu entry, ACTION is the function to call on the widget when the
2875 menu is selected, and FILTER is a predicate which takes a `custom-face'
2876 widget as an argument, and returns non-nil if ACTION is valid on that
2877 widget. If FILTER is nil, ACTION is always valid.")
2879 (defun custom-face-edit-selected (widget)
2880 "Edit selected attributes of the value of WIDGET."
2881 (widget-put widget :custom-state 'unknown)
2882 (widget-put widget :custom-form 'selected)
2883 (custom-redraw widget))
2885 (defun custom-face-edit-all (widget)
2886 "Edit all attributes of the value of WIDGET."
2887 (widget-put widget :custom-state 'unknown)
2888 (widget-put widget :custom-form 'all)
2889 (custom-redraw widget))
2891 (defun custom-face-edit-lisp (widget)
2892 "Edit the Lisp representation of the value of WIDGET."
2893 (widget-put widget :custom-state 'unknown)
2894 (widget-put widget :custom-form 'lisp)
2895 (custom-redraw widget))
2897 (defun custom-face-state-set (widget)
2898 "Set the state of WIDGET."
2899 (let* ((symbol (widget-value widget))
2900 (comment (get symbol 'face-comment))
2902 (widget-put widget :custom-state
2904 (setq tmp (get symbol 'customized-face))
2905 (setq temp (get symbol 'customized-face-comment))
2907 (if (equal temp comment)
2911 (setq tmp (get symbol 'saved-face))
2912 (setq temp (get symbol 'saved-face-comment))
2914 (if (equal temp comment)
2917 ((get symbol 'face-defface-spec)
2918 (if (equal comment nil)
2924 (defun custom-face-action (widget &optional event)
2925 "Show the menu for `custom-face' WIDGET.
2926 Optional EVENT is the location for the menu."
2927 (if (eq (widget-get widget :custom-state) 'hidden)
2928 (custom-toggle-hide widget)
2929 (let* ((completion-ignore-case t)
2930 (symbol (widget-get widget :value))
2931 (answer (widget-choose (concat "Operation on "
2932 (custom-unlispify-tag-name symbol))
2933 (custom-menu-filter custom-face-menu
2937 (funcall answer widget)))))
2939 (defun custom-face-set (widget)
2940 "Make the face attributes in WIDGET take effect."
2941 (let* ((symbol (widget-value widget))
2942 (child (car (widget-get widget :children)))
2943 (value (custom-post-filter-face-spec (widget-value child)))
2944 (comment-widget (widget-get widget :comment-widget))
2945 (comment (widget-value comment-widget)))
2946 (when (equal comment "")
2948 ;; Make the comment invisible by hand if it's empty
2949 (custom-comment-hide comment-widget))
2950 (put symbol 'customized-face value)
2951 (if (face-spec-choose value)
2952 (face-spec-set symbol value)
2953 ;; face-set-spec ignores empty attribute lists, so just give it
2954 ;; something harmless instead.
2955 (face-spec-set symbol '((t :foreground unspecified))))
2956 (put symbol 'customized-face-comment comment)
2957 (put symbol 'face-comment comment)
2958 (custom-face-state-set widget)
2959 (custom-redraw-magic widget)))
2961 (defun custom-face-save-command (widget)
2962 "Save in `.emacs' the face attributes in WIDGET."
2963 (custom-face-save widget)
2966 (defun custom-face-save (widget)
2967 "Prepare for saving WIDGET's face attributes, but don't write `.emacs'."
2968 (let* ((symbol (widget-value widget))
2969 (child (car (widget-get widget :children)))
2970 (value (custom-post-filter-face-spec (widget-value child)))
2971 (comment-widget (widget-get widget :comment-widget))
2972 (comment (widget-value comment-widget)))
2973 (when (equal comment "")
2975 ;; Make the comment invisible by hand if it's empty
2976 (custom-comment-hide comment-widget))
2977 (if (face-spec-choose value)
2978 (face-spec-set symbol value)
2979 ;; face-set-spec ignores empty attribute lists, so just give it
2980 ;; something harmless instead.
2981 (face-spec-set symbol '((t :foreground unspecified))))
2982 (put symbol 'saved-face value)
2983 (put symbol 'customized-face nil)
2984 (put symbol 'face-comment comment)
2985 (put symbol 'customized-face-comment nil)
2986 (put symbol 'saved-face-comment comment)
2988 (custom-face-state-set widget)
2989 (custom-redraw-magic widget)))
2991 (defun custom-face-reset-saved (widget)
2992 "Restore WIDGET to the face's default attributes."
2993 (let* ((symbol (widget-value widget))
2994 (child (car (widget-get widget :children)))
2995 (value (get symbol 'saved-face))
2996 (comment (get symbol 'saved-face-comment))
2997 (comment-widget (widget-get widget :comment-widget)))
2998 (unless (or value comment)
2999 (error "No saved value for this face"))
3000 (put symbol 'customized-face nil)
3001 (put symbol 'customized-face-comment nil)
3002 (face-spec-set symbol value)
3003 (put symbol 'face-comment comment)
3004 (widget-value-set child value)
3005 ;; This call manages the comment visibility
3006 (widget-value-set comment-widget (or comment ""))
3007 (custom-face-state-set widget)
3008 (custom-redraw-magic widget)))
3010 (defun custom-face-reset-standard (widget)
3011 "Restore WIDGET to the face's standard settings.
3012 This operation eliminates any saved setting for the face,
3013 restoring it to the state of a face that has never been customized."
3014 (let* ((symbol (widget-value widget))
3015 (child (car (widget-get widget :children)))
3016 (value (get symbol 'face-defface-spec))
3017 (comment-widget (widget-get widget :comment-widget)))
3019 (error "No standard setting for this face"))
3020 (put symbol 'customized-face nil)
3021 (put symbol 'customized-face-comment nil)
3022 (when (or (get symbol 'saved-face) (get symbol 'saved-face-comment))
3023 (put symbol 'saved-face nil)
3024 (put symbol 'saved-face-comment nil)
3026 (face-spec-set symbol value)
3027 (put symbol 'face-comment nil)
3028 (widget-value-set child value)
3029 ;; This call manages the comment visibility
3030 (widget-value-set comment-widget "")
3031 (custom-face-state-set widget)
3032 (custom-redraw-magic widget)))
3034 ;;; The `face' Widget.
3036 (define-widget 'face 'default
3037 "Select and customize a face."
3038 :convert-widget 'widget-value-convert-widget
3039 :button-prefix 'widget-push-button-prefix
3040 :button-suffix 'widget-push-button-suffix
3041 :format "%{%t%}: %[select face%] %v"
3044 :value-create 'widget-face-value-create
3045 :value-delete 'widget-face-value-delete
3046 :value-get 'widget-value-value-get
3047 :validate 'widget-children-validate
3048 :action 'widget-face-action
3049 :match (lambda (widget value) (symbolp value)))
3051 (defun widget-face-value-create (widget)
3052 "Create a `custom-face' child."
3053 (let* ((symbol (widget-value widget))
3054 (custom-buffer-style 'face)
3055 (child (widget-create-child-and-convert
3059 (custom-magic-reset child)
3060 (setq custom-options (cons child custom-options))
3061 (widget-put widget :children (list child))))
3063 (defun widget-face-value-delete (widget)
3064 "Remove the child from the options."
3065 (let ((child (car (widget-get widget :children))))
3066 (setq custom-options (delq child custom-options))
3067 (widget-children-value-delete widget)))
3069 (defvar face-history nil
3070 "History of entered face names.")
3072 (defun widget-face-action (widget &optional event)
3073 "Prompt for a face."
3074 (let ((answer (completing-read "Face: "
3075 (mapcar (lambda (face)
3076 (list (symbol-name face)))
3080 (unless (zerop (length answer))
3081 (widget-value-set widget (intern answer))
3082 (widget-apply widget :notify widget event)
3085 ;;; The `hook' Widget.
3087 (define-widget 'hook 'list
3089 :value-to-internal (lambda (widget value)
3090 (if (and value (symbolp value))
3093 :match (lambda (widget value)
3095 (widget-group-match widget value)))
3096 ;; Avoid adding undefined functions to the hook, especially for
3097 ;; things like `find-file-hook' or even more basic ones, to avoid
3099 :set (lambda (symbol value)
3102 (add-hook symbol elt))))
3103 :convert-widget 'custom-hook-convert-widget
3106 (defun custom-hook-convert-widget (widget)
3107 ;; Handle `:options'.
3108 (let* ((options (widget-get widget :options))
3109 (other `(editable-list :inline t
3110 :entry-format "%i %d%v"
3111 (function :format " %v")))
3113 (list `(checklist :inline t
3114 ,@(mapcar (lambda (entry)
3115 `(function-item ,entry))
3119 (widget-put widget :args args)
3122 ;;; The `custom-group-link' Widget.
3124 (define-widget 'custom-group-link 'link
3125 "Show parent in other window when activated."
3126 :help-echo "Create customization buffer for this group."
3127 :action 'custom-group-link-action)
3129 (defun custom-group-link-action (widget &rest ignore)
3130 (customize-group (widget-value widget)))
3132 ;;; The `custom-group' Widget.
3134 (defcustom custom-group-tag-faces nil
3135 ;; In XEmacs, this ought to play games with font size.
3136 ;; Fixme: make it do so in Emacs.
3137 "Face used for group tags.
3138 The first member is used for level 1 groups, the second for level 2,
3139 and so forth. The remaining group tags are shown with
3140 `custom-group-tag-face'."
3141 :type '(repeat face)
3142 :group 'custom-faces)
3144 (defface custom-group-tag-face-1
3147 (:foreground "pink" :weight bold :height 1.2 :inherit variable-pitch))
3150 (:foreground "red" :weight bold :height 1.2 :inherit variable-pitch))
3152 "Face used for group tags."
3153 :group 'custom-faces)
3155 (defface custom-group-tag-face
3158 (:foreground "light blue" :weight bold :height 1.2))
3161 (:foreground "blue" :weight bold :height 1.2))
3163 "Face used for low level group tags."
3164 :group 'custom-faces)
3166 (define-widget 'custom-group 'custom
3169 :sample-face-get 'custom-group-sample-face-get
3170 :documentation-property 'group-documentation
3171 :help-echo "Set or reset all members of this group."
3172 :value-create 'custom-group-value-create
3173 :action 'custom-group-action
3174 :custom-category 'group
3175 :custom-set 'custom-group-set
3176 :custom-save 'custom-group-save
3177 :custom-reset-current 'custom-group-reset-current
3178 :custom-reset-saved 'custom-group-reset-saved
3179 :custom-reset-standard 'custom-group-reset-standard
3180 :custom-menu 'custom-group-menu-create)
3182 (defun custom-group-sample-face-get (widget)
3183 ;; Use :sample-face.
3184 (or (nth (1- (widget-get widget :custom-level)) custom-group-tag-faces)
3185 'custom-group-tag-face))
3187 (define-widget 'custom-group-visibility 'visibility
3188 "An indicator and manipulator for hidden group contents."
3189 :create 'custom-group-visibility-create)
3191 (defun custom-group-visibility-create (widget)
3192 (let ((visible (widget-value widget)))
3194 (insert "--------")))
3195 (widget-default-create widget))
3197 (defun custom-group-members (symbol groups-only)
3198 "Return SYMBOL's custom group members.
3199 If GROUPS-ONLY non-nil, return only those members that are groups."
3200 (if (not groups-only)
3201 (get symbol 'custom-group)
3203 (dolist (entry (get symbol 'custom-group))
3204 (when (eq (nth 1 entry) 'custom-group)
3205 (push entry members)))
3206 (nreverse members))))
3208 (defun custom-group-value-create (widget)
3209 "Insert a customize group for WIDGET in the current buffer."
3210 (let* ((state (widget-get widget :custom-state))
3211 (level (widget-get widget :custom-level))
3212 ;; (indent (widget-get widget :indent))
3213 (prefix (widget-get widget :custom-prefix))
3214 (buttons (widget-get widget :buttons))
3215 (tag (widget-get widget :tag))
3216 (symbol (widget-value widget))
3217 (members (custom-group-members symbol
3218 (and (eq custom-buffer-style 'tree)
3219 custom-browse-only-groups))))
3220 (cond ((and (eq custom-buffer-style 'tree)
3222 (or members (custom-unloaded-widget-p widget)))
3223 (custom-browse-insert-prefix prefix)
3224 (push (widget-create-child-and-convert
3225 widget 'custom-browse-visibility
3226 ;; :tag-glyph "plus"
3230 ;; (widget-glyph-insert nil "-- " "horizontal")
3231 (push (widget-create-child-and-convert
3232 widget 'custom-browse-group-tag)
3234 (insert " " tag "\n")
3235 (widget-put widget :buttons buttons))
3236 ((and (eq custom-buffer-style 'tree)
3237 (zerop (length members)))
3238 (custom-browse-insert-prefix prefix)
3240 ;; (widget-glyph-insert nil "[ ]" "empty")
3241 ;; (widget-glyph-insert nil "-- " "horizontal")
3242 (push (widget-create-child-and-convert
3243 widget 'custom-browse-group-tag)
3245 (insert " " tag "\n")
3246 (widget-put widget :buttons buttons))
3247 ((eq custom-buffer-style 'tree)
3248 (custom-browse-insert-prefix prefix)
3249 (custom-load-widget widget)
3250 (if (zerop (length members))
3252 (custom-browse-insert-prefix prefix)
3254 ;; (widget-glyph-insert nil "[ ]" "empty")
3255 ;; (widget-glyph-insert nil "-- " "horizontal")
3256 (push (widget-create-child-and-convert
3257 widget 'custom-browse-group-tag)
3259 (insert " " tag "\n")
3260 (widget-put widget :buttons buttons))
3261 (push (widget-create-child-and-convert
3262 widget 'custom-browse-visibility
3263 ;; :tag-glyph "minus"
3267 ;; (widget-glyph-insert nil "-\\ " "top")
3268 (push (widget-create-child-and-convert
3269 widget 'custom-browse-group-tag)
3271 (insert " " tag "\n")
3272 (widget-put widget :buttons buttons)
3273 (message "Creating group...")
3274 (let* ((members (custom-sort-items members
3275 custom-browse-sort-alphabetically
3276 custom-browse-order-groups))
3277 (prefixes (widget-get widget :custom-prefixes))
3278 (custom-prefix-list (custom-prefix-add symbol prefixes))
3279 (extra-prefix (if (widget-get widget :custom-last)
3282 (prefix (concat prefix extra-prefix))
3285 (setq entry (car members)
3286 members (cdr members))
3287 (push (widget-create-child-and-convert
3288 widget (nth 1 entry)
3290 :tag (custom-unlispify-tag-name (nth 0 entry))
3291 :custom-prefixes custom-prefix-list
3292 :custom-level (1+ level)
3293 :custom-last (null members)
3294 :value (nth 0 entry)
3295 :custom-prefix prefix)
3297 (widget-put widget :children (reverse children)))
3298 (message "Creating group...done")))
3301 ;; Create level indicator.
3302 (unless (eq custom-buffer-style 'links)
3303 (insert-char ?\ (* custom-buffer-indent (1- level)))
3306 (let ((begin (point)))
3308 (widget-specify-sample widget begin (point)))
3310 ;; Create link/visibility indicator.
3311 (if (eq custom-buffer-style 'links)
3312 (push (widget-create-child-and-convert
3313 widget 'custom-group-link
3317 (push (widget-create-child-and-convert
3318 widget 'custom-group-visibility
3319 :help-echo "Show members of this group."
3320 :action 'custom-toggle-parent
3321 (not (eq state 'hidden)))
3324 ;; Create magic button.
3325 (let ((magic (widget-create-child-and-convert
3326 widget 'custom-magic nil)))
3327 (widget-put widget :custom-magic magic)
3328 (push magic buttons))
3330 (widget-put widget :buttons buttons)
3331 ;; Insert documentation.
3332 (if (and (eq custom-buffer-style 'links) (> level 1))
3333 (widget-put widget :documentation-indent 0))
3334 (widget-default-format-handler widget ?h))
3337 ;; Add parent groups references above the group.
3338 (if t ;;; This should test that the buffer
3339 ;;; was made to display a group.
3341 (if (custom-add-parent-links widget
3342 "Go to parent group:")
3344 ;; Create level indicator.
3345 (insert-char ?\ (* custom-buffer-indent (1- level)))
3348 (let ((start (point)))
3350 (widget-specify-sample widget start (point)))
3352 ;; Create visibility indicator.
3353 (unless (eq custom-buffer-style 'links)
3355 (push (widget-create-child-and-convert
3357 :help-echo "Hide members of this group."
3358 :action 'custom-toggle-parent
3359 (not (eq state 'hidden)))
3362 ;; Create more dashes.
3363 ;; Use 76 instead of 75 to compensate for the temporary "<"
3364 ;; added by `widget-insert'.
3365 (insert-char ?- (- 76 (current-column)
3366 (* custom-buffer-indent level)))
3368 ;; Create magic button.
3369 (let ((magic (widget-create-child-and-convert
3370 widget 'custom-magic
3373 (widget-put widget :custom-magic magic)
3374 (push magic buttons))
3376 (widget-put widget :buttons buttons)
3377 ;; Insert documentation.
3378 (widget-default-format-handler widget ?h)
3380 (if nil ;;; This should test that the buffer
3381 ;;; was not made to display a group.
3383 (insert-char ?\ custom-buffer-indent)
3384 (custom-add-parent-links widget)))
3385 (custom-add-see-also widget
3386 (make-string (* custom-buffer-indent level)
3389 (message "Creating group...")
3390 (custom-load-widget widget)
3391 (let* ((members (custom-sort-items members
3392 custom-buffer-sort-alphabetically
3393 custom-buffer-order-groups))
3394 (prefixes (widget-get widget :custom-prefixes))
3395 (custom-prefix-list (custom-prefix-add symbol prefixes))
3396 (length (length members))
3398 (children (mapcar (lambda (entry)
3399 (widget-insert "\n")
3401 Creating group members... %2d%%"
3402 (/ (* 100.0 count) length))
3403 (setq count (1+ count))
3405 (widget-create-child-and-convert
3406 widget (nth 1 entry)
3408 :tag (custom-unlispify-tag-name
3410 :custom-prefixes custom-prefix-list
3411 :custom-level (1+ level)
3412 :value (nth 0 entry))
3413 (unless (eq (preceding-char) ?\n)
3414 (widget-insert "\n"))))
3416 (message "Creating group magic...")
3417 (mapc 'custom-magic-reset children)
3418 (message "Creating group state...")
3419 (widget-put widget :children children)
3420 (custom-group-state-update widget)
3421 (message "Creating group... done"))
3424 (insert-char ?\ (* custom-buffer-indent (1- level)))
3425 (insert "\\- " (widget-get widget :tag) " group end ")
3426 (insert-char ?- (- 75 (current-column) (* custom-buffer-indent level)))
3429 (defvar custom-group-menu
3430 '(("Set for Current Session" custom-group-set
3432 (eq (widget-get widget :custom-state) 'modified)))
3433 ("Save for Future Sessions" custom-group-save
3435 (memq (widget-get widget :custom-state) '(modified set))))
3436 ("Reset to Current" custom-group-reset-current
3438 (memq (widget-get widget :custom-state) '(modified))))
3439 ("Reset to Saved" custom-group-reset-saved
3441 (memq (widget-get widget :custom-state) '(modified set))))
3442 ("Reset to standard setting" custom-group-reset-standard
3444 (memq (widget-get widget :custom-state) '(modified set saved)))))
3445 "Alist of actions for the `custom-group' widget.
3446 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
3447 the menu entry, ACTION is the function to call on the widget when the
3448 menu is selected, and FILTER is a predicate which takes a `custom-group'
3449 widget as an argument, and returns non-nil if ACTION is valid on that
3450 widget. If FILTER is nil, ACTION is always valid.")
3452 (defun custom-group-action (widget &optional event)
3453 "Show the menu for `custom-group' WIDGET.
3454 Optional EVENT is the location for the menu."
3455 (if (eq (widget-get widget :custom-state) 'hidden)
3456 (custom-toggle-hide widget)
3457 (let* ((completion-ignore-case t)
3458 (answer (widget-choose (concat "Operation on "
3459 (custom-unlispify-tag-name
3460 (widget-get widget :value)))
3461 (custom-menu-filter custom-group-menu
3465 (funcall answer widget)))))
3467 (defun custom-group-set (widget)
3468 "Set changes in all modified group members."
3469 (let ((children (widget-get widget :children)))
3470 (mapc (lambda (child)
3471 (when (eq (widget-get child :custom-state) 'modified)
3472 (widget-apply child :custom-set)))
3475 (defun custom-group-save (widget)
3476 "Save all modified group members."
3477 (let ((children (widget-get widget :children)))
3478 (mapc (lambda (child)
3479 (when (memq (widget-get child :custom-state) '(modified set))
3480 (widget-apply child :custom-save)))
3483 (defun custom-group-reset-current (widget)
3484 "Reset all modified group members."
3485 (let ((children (widget-get widget :children)))
3486 (mapc (lambda (child)
3487 (when (eq (widget-get child :custom-state) 'modified)
3488 (widget-apply child :custom-reset-current)))
3491 (defun custom-group-reset-saved (widget)
3492 "Reset all modified or set group members."
3493 (let ((children (widget-get widget :children)))
3494 (mapc (lambda (child)
3495 (when (memq (widget-get child :custom-state) '(modified set))
3496 (widget-apply child :custom-reset-saved)))
3499 (defun custom-group-reset-standard (widget)
3500 "Reset all modified, set, or saved group members."
3501 (let ((children (widget-get widget :children)))
3502 (mapc (lambda (child)
3503 (when (memq (widget-get child :custom-state)
3504 '(modified set saved))
3505 (widget-apply child :custom-reset-standard)))
3508 (defun custom-group-state-update (widget)
3510 (unless (eq (widget-get widget :custom-state) 'hidden)
3511 (let* ((children (widget-get widget :children))
3512 (states (mapcar (lambda (child)
3513 (widget-get child :custom-state))
3515 (magics custom-magic-alist)
3518 (let ((magic (car (car magics))))
3519 (if (and (not (eq magic 'hidden))
3520 (memq magic states))
3523 (setq magics (cdr magics)))))
3524 (widget-put widget :custom-state found)))
3525 (custom-magic-reset widget))
3527 ;;; The `custom-save-all' Function.
3529 (defcustom custom-file nil
3530 "File used for storing customization information.
3531 The default is nil, which means to use your init file
3532 as specified by `user-init-file'. If you specify some other file,
3533 you need to explicitly load that file for the settings to take effect.
3535 When you change this variable, look in the previous custom file
3536 \(usually your init file) for the forms `(custom-set-variables ...)'
3537 and `(custom-set-faces ...)', and copy them (whichever ones you find)
3538 to the new custom file. This will preserve your existing customizations."
3539 :type '(choice (const :tag "Your Emacs init file" nil) file)
3542 (defun custom-file ()
3543 "Return the file name for saving customizations."
3546 (let ((user-init-file user-init-file)
3548 (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs")))
3549 (when (null user-init-file)
3550 (if (or (file-exists-p default-init-file)
3551 (and (eq system-type 'windows-nt)
3552 (file-exists-p "~/_emacs")))
3553 ;; Started with -q, i.e. the file containing
3554 ;; Custom settings hasn't been read. Saving
3555 ;; settings there would overwrite other settings.
3556 (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
3557 (setq user-init-file default-init-file))
3560 (defun custom-save-delete (symbol)
3561 "Visit `custom-file' and delete all calls to SYMBOL from it.
3562 Leave point at the old location of the first such call,
3563 or (if there were none) at the end of the buffer."
3564 (let ((default-major-mode))
3565 (set-buffer (find-file-noselect (custom-file))))
3566 (goto-char (point-min))
3567 ;; Skip all whitespace and comments.
3568 (while (forward-comment 1))
3570 (save-excursion (forward-sexp (buffer-size)))) ; Test for scan errors.
3573 (while t ;; We exit this loop only via throw.
3574 ;; Skip all whitespace and comments.
3575 (while (forward-comment 1))
3576 (let ((start (point))
3577 (sexp (condition-case nil
3578 (read (current-buffer))
3579 (end-of-file (throw 'found nil)))))
3580 (when (and (listp sexp)
3581 (eq (car sexp) symbol))
3582 (delete-region start (point))
3584 (setq first (point)))))))
3587 ;; Move in front of local variables, otherwise long Custom
3588 ;; entries would make them ineffective.
3589 (let ((pos (point-max))
3590 (case-fold-search t))
3592 (goto-char (point-max))
3593 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3595 (when (search-forward "Local Variables:" nil t)
3596 (setq pos (line-beginning-position))))
3599 (defun custom-save-variables ()
3600 "Save all customized variables in `custom-file'."
3602 (custom-save-delete 'custom-set-variables)
3603 (let ((standard-output (current-buffer))
3604 (saved-list (make-list 1 0))
3606 ;; First create a sorted list of saved variables.
3609 (if (get symbol 'saved-value)
3610 (nconc saved-list (list symbol)))))
3611 (setq saved-list (sort (cdr saved-list) 'string<))
3614 (princ "(custom-set-variables
3615 ;; custom-set-variables was added by Custom -- don't edit or cut/paste it!
3616 ;; Your init file should contain only one such instance.\n")
3619 (let ((value (get symbol 'saved-value))
3620 (requests (get symbol 'custom-requests))
3621 (now (not (or (get symbol 'standard-value)
3622 (and (not (boundp symbol))
3623 (not (get symbol 'force-value))))))
3624 (comment (get symbol 'saved-variable-comment))
3626 (when (or value comment)
3633 (cond ((or now requests comment)
3638 (cond ((or requests comment)
3657 (unless (looking-at "\n")
3660 (defun custom-save-faces ()
3661 "Save all customized faces in `custom-file'."
3663 (custom-save-delete 'custom-set-faces)
3664 (let ((standard-output (current-buffer))
3665 (saved-list (make-list 1 0))
3667 ;; First create a sorted list of saved faces.
3670 (if (get symbol 'saved-face)
3671 (nconc saved-list (list symbol)))))
3672 (setq saved-list (sort (cdr saved-list) 'string<))
3673 ;; The default face must be first, since it affects the others.
3674 (if (memq 'default saved-list)
3675 (setq saved-list (cons 'default (delq 'default saved-list))))
3678 (princ "(custom-set-faces
3679 ;; custom-set-faces was added by Custom -- don't edit or cut/paste it!
3680 ;; Your init file should contain only one such instance.\n")
3683 (let ((value (get symbol 'saved-face))
3684 (now (not (or (get 'default 'face-defface-spec)
3685 (and (not (custom-facep 'default))
3686 (not (get 'default 'force-face))))))
3687 (comment (get 'default 'saved-face-comment)))
3688 (unless (eq symbol 'default))
3689 ;; Don't print default face here.
3696 (cond ((or now comment)
3713 (unless (looking-at "\n")
3717 (defun customize-save-customized ()
3718 "Save all user options which have been set in this session."
3720 (mapatoms (lambda (symbol)
3721 (let ((face (get symbol 'customized-face))
3722 (value (get symbol 'customized-value))
3723 (face-comment (get symbol 'customized-face-comment))
3725 (get symbol 'customized-variable-comment)))
3727 (put symbol 'saved-face face)
3728 (put symbol 'customized-face nil))
3730 (put symbol 'saved-value value)
3731 (put symbol 'customized-value nil))
3732 (when variable-comment
3733 (put symbol 'saved-variable-comment variable-comment)
3734 (put symbol 'customized-variable-comment nil))
3736 (put symbol 'saved-face-comment face-comment)
3737 (put symbol 'customized-face-comment nil)))))
3738 ;; We really should update all custom buffers here.
3742 (defun custom-save-all ()
3743 "Save all customizations in `custom-file'."
3744 (let ((inhibit-read-only t))
3745 (custom-save-variables)
3748 (let ((default-major-mode nil))
3749 (set-buffer (find-file-noselect (custom-file))))
3750 (let ((file-precious-flag t))
3753 ;;; The Customize Menu.
3757 (defcustom custom-menu-nesting 2
3758 "Maximum nesting in custom menus."
3760 :group 'custom-menu)
3762 (defun custom-face-menu-create (widget symbol)
3763 "Ignoring WIDGET, create a menu entry for customization face SYMBOL."
3764 (vector (custom-unlispify-menu-entry symbol)
3765 `(customize-face ',symbol)
3768 (defun custom-variable-menu-create (widget symbol)
3769 "Ignoring WIDGET, create a menu entry for customization variable SYMBOL."
3770 (let ((type (get symbol 'custom-type)))
3771 (unless (listp type)
3772 (setq type (list type)))
3773 (if (and type (widget-get type :custom-menu))
3774 (widget-apply type :custom-menu symbol)
3775 (vector (custom-unlispify-menu-entry symbol)
3776 `(customize-variable ',symbol)
3779 ;; Add checkboxes to boolean variable entries.
3780 (widget-put (get 'boolean 'widget-type)
3781 :custom-menu (lambda (widget symbol)
3782 (vector (custom-unlispify-menu-entry symbol)
3783 `(customize-variable ',symbol)
3785 ':selected symbol)))
3787 (defun custom-group-menu-create (widget symbol)
3788 "Ignoring WIDGET, create a menu entry for customization group SYMBOL."
3789 `( ,(custom-unlispify-menu-entry symbol t)
3790 :filter (lambda (&rest junk)
3791 (cdr (custom-menu-create ',symbol)))))
3794 (defun custom-menu-create (symbol)
3795 "Create menu for customization group SYMBOL.
3796 The menu is in a format applicable to `easy-menu-define'."
3797 (let* ((item (vector (custom-unlispify-menu-entry symbol)
3798 `(customize-group ',symbol)
3800 (if (and (or (not (boundp 'custom-menu-nesting))
3801 (>= custom-menu-nesting 0))
3802 (< (length (get symbol 'custom-group)) widget-menu-max-size))
3803 (let ((custom-prefix-list (custom-prefix-add symbol
3804 custom-prefix-list))
3805 (members (custom-sort-items (get symbol 'custom-group)
3806 custom-menu-sort-alphabetically
3807 custom-menu-order-groups)))
3808 (custom-load-symbol symbol)
3809 `(,(custom-unlispify-menu-entry symbol t)
3812 ,@(mapcar (lambda (entry)
3813 (widget-apply (if (listp (nth 1 entry))
3815 (list (nth 1 entry)))
3816 :custom-menu (nth 0 entry)))
3821 (defun customize-menu-create (symbol &optional name)
3822 "Return a customize menu for customization group SYMBOL.
3823 If optional NAME is given, use that as the name of the menu.
3824 Otherwise the menu will be named `Customize'.
3825 The format is suitable for use with `easy-menu-define'."
3827 (setq name "Customize"))
3829 :filter (lambda (&rest junk)
3830 (custom-menu-create ',symbol))))
3832 ;;; The Custom Mode.
3834 (defvar custom-mode-map nil
3835 "Keymap for `custom-mode'.")
3837 (unless custom-mode-map
3838 ;; This keymap should be dense, but a dense keymap would prevent inheriting
3839 ;; "\r" bindings from the parent map.
3840 (setq custom-mode-map (make-sparse-keymap))
3841 (set-keymap-parent custom-mode-map widget-keymap)
3842 (suppress-keymap custom-mode-map)
3843 (define-key custom-mode-map " " 'scroll-up)
3844 (define-key custom-mode-map "\177" 'scroll-down)
3845 (define-key custom-mode-map "q" 'Custom-buffer-done)
3846 (define-key custom-mode-map "u" 'Custom-goto-parent)
3847 (define-key custom-mode-map "n" 'widget-forward)
3848 (define-key custom-mode-map "p" 'widget-backward)
3849 (define-key custom-mode-map [mouse-1] 'Custom-move-and-invoke))
3851 (defun Custom-move-and-invoke (event)
3852 "Move to where you click, and if it is an active field, invoke it."
3854 (mouse-set-point event)
3855 (if (widget-event-point event)
3856 (let* ((pos (widget-event-point event))
3857 (button (get-char-property pos 'button)))
3859 (widget-button-click event)))))
3861 (easy-menu-define Custom-mode-menu
3863 "Menu used in customization buffers."
3865 ,(customize-menu-create 'customize)
3866 ["Set" Custom-set t]
3867 ["Save" Custom-save t]
3868 ["Reset to Current" Custom-reset-current t]
3869 ["Reset to Saved" Custom-reset-saved t]
3870 ["Reset to Standard Settings" Custom-reset-standard t]
3871 ["Info" (Info-goto-node "(emacs)Easy Customization") t]))
3873 (defun Custom-goto-parent ()
3874 "Go to the parent group listed at the top of this buffer.
3875 If several parents are listed, go to the first of them."
3878 (goto-char (point-min))
3879 (if (search-forward "\nGo to parent group: " nil t)
3880 (let* ((button (get-char-property (point) 'button))
3881 (parent (downcase (widget-get button :tag))))
3882 (customize-group parent)))))
3884 (defcustom custom-mode-hook nil
3885 "Hook called when entering Custom mode."
3887 :group 'custom-buffer )
3889 (defun custom-state-buffer-message (widget)
3890 (if (eq (widget-get (widget-get widget :parent) :custom-state) 'modified)
3891 (message "To install your edits, invoke [State] and choose the Set operation")))
3893 (defun custom-mode ()
3894 "Major mode for editing customization buffers.
3896 The following commands are available:
3898 Move to next button or editable field. \\[widget-forward]
3899 Move to previous button or editable field. \\[widget-backward]
3900 \\<widget-field-keymap>\
3901 Complete content of editable text field. \\[widget-complete]
3902 \\<custom-mode-map>\
3903 Invoke button under the mouse pointer. \\[Custom-move-and-invoke]
3904 Invoke button under point. \\[widget-button-press]
3905 Set all modifications. \\[Custom-set]
3906 Make all modifications default. \\[Custom-save]
3907 Reset all modified options. \\[Custom-reset-current]
3908 Reset all modified or set options. \\[Custom-reset-saved]
3909 Reset all options. \\[Custom-reset-standard]
3911 Entry to this mode calls the value of `custom-mode-hook'
3912 if that value is non-nil."
3913 (kill-all-local-variables)
3914 (setq major-mode 'custom-mode
3916 (use-local-map custom-mode-map)
3917 (easy-menu-add Custom-mode-menu)
3918 (make-local-variable 'custom-options)
3919 (make-local-variable 'widget-documentation-face)
3920 (setq widget-documentation-face 'custom-documentation-face)
3921 (make-local-variable 'widget-button-face)
3922 (setq widget-button-face 'custom-button-face)
3923 (set (make-local-variable 'widget-button-pressed-face)
3924 'custom-button-pressed-face)
3925 (set (make-local-variable 'widget-mouse-face)
3926 'custom-button-pressed-face) ; buttons `depress' when moused
3927 ;; When possible, use relief for buttons, not bracketing. This test
3928 ;; may not be optimal.
3929 (when custom-raised-buttons
3930 (set (make-local-variable 'widget-push-button-prefix) "")
3931 (set (make-local-variable 'widget-push-button-suffix) "")
3932 (set (make-local-variable 'widget-link-prefix) "")
3933 (set (make-local-variable 'widget-link-suffix) ""))
3934 (add-hook 'widget-edit-functions 'custom-state-buffer-message nil t)
3935 (run-hooks 'custom-mode-hook))
3937 (put 'custom-mode 'mode-class 'special)
3940 'debug-ignored-errors
3941 "^No user options have changed defaults in recent Emacs versions$")
3947 ;;; cus-edit.el ends here