1 ;;; cus-edit.el --- tools for customizing Emacs and Lisp packages
3 ;; Copyright (C) 1996-1997, 1999-2011 Free Software Foundation, Inc.
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7 ;; Keywords: help, faces
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
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.
35 ;; The identity of a customize option is represented by a Lisp symbol.
36 ;; The following values are associated with an option.
38 ;; 0. The current value.
40 ;; This is the value of the option as seen by "the rest of Emacs".
42 ;; Usually extracted by 'default-value', but can be extracted with
43 ;; different means if the option symbol has the 'custom-get'
44 ;; property. Similarly, set-default (or the 'custom-set' property)
47 ;; 1. The widget value.
49 ;; This is the value shown in the widget in a customize buffer.
51 ;; 2. The customized value.
53 ;; This is the last value given to the option through customize.
55 ;; It is stored in the 'customized-value' property of the option, in a
56 ;; cons-cell whose car evaluates to the customized value.
58 ;; 3. The saved value.
60 ;; This is last value saved from customize.
62 ;; It is stored in the 'saved-value' property of the option, in a
63 ;; cons-cell whose car evaluates to the saved value.
65 ;; 4. The standard value.
67 ;; This is the value given in the 'defcustom' declaration.
69 ;; It is stored in the 'standard-value' property of the option, in a
70 ;; cons-cell whose car evaluates to the standard value.
72 ;; 5. The "think" value.
74 ;; This is what customize thinks the current value should be.
76 ;; This is the customized value, if any such value exists, otherwise
77 ;; the saved value, if that exists, and as a last resort the standard
80 ;; The reason for storing values unevaluated: This is so you can have
81 ;; values that depend on the environment. For example, you can have a
82 ;; variable that has one value when Emacs is running under a window
83 ;; system, and another value on a tty. Since the evaluation is only done
84 ;; when the variable is first initialized, this is only relevant for the
85 ;; saved (and standard) values, but affect others values for
88 ;; You can see (and modify and save) this unevaluated value by selecting
89 ;; "Show Saved Lisp Expression" from the Lisp interface. This will
90 ;; give you the unevaluated saved value, if any, otherwise the
91 ;; unevaluated standard value.
93 ;; The possible states for a customize widget are:
97 ;; The state has not been determined yet.
101 ;; The widget value is different from the current value.
105 ;; The current value is different from the "think" value.
109 ;; The "think" value is the customized value.
113 ;; The "think" value is the saved value.
117 ;; The "think" value is the standard value.
121 ;; There is no standard value. This means that the variable was
122 ;; not defined with defcustom, nor handled in cus-start.el. Most
123 ;; standard interactive Custom commands do not let you create a
124 ;; Custom buffer containing such variables. However, such Custom
125 ;; buffers can be created, for instance, by calling
126 ;; `customize-apropos' with a prefix arg or by calling
127 ;; `customize-option' non-interactively.
131 ;; There is no widget value.
135 ;; The widget value is not valid member of the :type specified for the
143 (defvar custom-versions-load-alist
) ; from cus-load
144 (defvar recentf-exclude
) ; from recentf.el
154 (put 'custom-define-hook
'custom-type
'hook
)
155 (put 'custom-define-hook
'standard-value
'(nil))
156 (custom-add-to-group 'customize
'custom-define-hook
'custom-variable
)
158 ;;; Customization Groups.
161 "Customization of the One True Editor."
162 :link
'(custom-manual "(emacs)Top"))
164 ;; Most of these groups are stolen from `finder.el',
165 (defgroup editing nil
166 "Basic text editing facilities."
169 (defgroup convenience nil
170 "Convenience features for faster editing."
174 "Support for editing files."
178 "Support for editing text files."
183 "Support for editing binary data files."
187 "Abbreviation handling, typing shortcuts, macros."
191 (defgroup matching nil
192 "Various sorts of searching and matching."
195 (defgroup emulations nil
196 "Emulations of other editors."
197 :link
'(custom-manual "(emacs)Emulation")
204 (defgroup outlines nil
205 "Support for hierarchical outlining."
208 (defgroup external nil
209 "Interfacing to external utilities."
213 "Communications, networking, and remote access to files."
217 (defgroup processes nil
218 "Process, subshell, compilation, and job control support."
221 (defgroup programming nil
222 "Support for programming in other languages."
225 (defgroup languages nil
226 "Specialized modes for editing programming languages."
230 "Lisp support, including Emacs Lisp."
231 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
236 "Support for the C language and related languages."
237 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
238 :link
'(custom-manual "(ccmode)")
245 (defgroup applications nil
246 "Applications written in Emacs."
249 (defgroup calendar nil
250 "Calendar and time management support."
251 :group
'applications
)
254 "Modes for electronic-mail handling."
255 :group
'applications
)
258 "Support for netnews reading and posting."
259 :link
'(custom-manual "(gnus)")
260 :group
'applications
)
263 "Games, jokes and amusements."
264 :group
'applications
)
266 (defgroup development nil
267 "Support for further development of Emacs."
271 "Support for Emacs documentation."
274 (defgroup extensions nil
275 "Emacs Lisp language extensions."
278 (defgroup internal nil
279 "Code for Emacs internals, build process, defaults."
283 "Maintenance aids for the Emacs development group."
287 (defgroup environment nil
288 "Fitting Emacs with its environment."
291 (defgroup hardware nil
292 "Support for interfacing with miscellaneous hardware."
295 (defgroup terminals nil
296 "Support for terminal types."
300 "Front-ends/assistants for, or emulators of, UNIX features."
304 "Internationalization and alternate character-set support."
305 :link
'(custom-manual "(emacs)International")
310 "The X Window system."
314 "Support for Emacs frames and window systems."
318 "Code related to the TeX formatter."
319 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
323 "Support for multiple fonts."
327 "Support for on-line help systems."
330 (defgroup multimedia nil
331 "Non-textual support, specifically images and sound."
335 "Code local to your site."
338 (defgroup customize
'((widgets custom-group
))
339 "Customization of the Customization support."
343 (defgroup custom-faces nil
344 "Faces used by customize."
348 (defgroup custom-browse nil
349 "Control customize browser."
353 (defgroup custom-buffer nil
354 "Control customize buffers."
358 (defgroup custom-menu nil
359 "Control customize menus."
364 "Storage allocation and gc for GNU Emacs Lisp interpreter."
365 :tag
"Storage Allocation"
369 "Undoing changes in buffers."
370 :link
'(custom-manual "(emacs)Undo")
373 (defgroup mode-line nil
374 "Content of the modeline."
377 (defgroup editing-basics nil
378 "Most basic editing facilities."
381 (defgroup display nil
382 "How characters are displayed in buffers."
385 (defgroup execute nil
386 "Executing external commands."
389 (defgroup installation nil
390 "The Emacs installation."
398 "Internal Emacs limits."
402 "Debugging Emacs itself."
405 (defgroup keyboard nil
406 "Input from the keyboard."
410 "Input from the mouse."
414 "Input from the menus."
418 "Handling data from drag and drop."
421 (defgroup auto-save nil
422 "Preventing accidental loss of data."
425 (defgroup processes-basics nil
426 "Basic stuff dealing with processes."
430 "MULE Emacs internationalization."
433 (defgroup windows nil
434 "Windows within a frame."
435 :link
'(custom-manual "(emacs)Windows")
438 ;;; Custom mode keymaps
440 (defvar custom-mode-map
441 (let ((map (make-keymap)))
442 (set-keymap-parent map widget-keymap
)
443 (define-key map
[remap self-insert-command
] 'Custom-no-edit
)
444 (define-key map
"\^m" 'Custom-newline
)
445 (define-key map
" " 'scroll-up
)
446 (define-key map
"\177" 'scroll-down
)
447 (define-key map
"\C-c\C-c" 'Custom-set
)
448 (define-key map
"\C-x\C-s" 'Custom-save
)
449 (define-key map
"q" 'Custom-buffer-done
)
450 (define-key map
"u" 'Custom-goto-parent
)
451 (define-key map
"n" 'widget-forward
)
452 (define-key map
"p" 'widget-backward
)
454 "Keymap for `Custom-mode'.")
456 (defvar custom-mode-link-map
457 (let ((map (make-keymap)))
458 (set-keymap-parent map custom-mode-map
)
459 (define-key map
[down-mouse-2
] nil
)
460 (define-key map
[down-mouse-1
] 'mouse-drag-region
)
461 (define-key map
[mouse-2
] 'widget-move-and-invoke
)
463 "Local keymap for links in `Custom-mode'.")
465 (defvar custom-field-keymap
466 (let ((map (copy-keymap widget-field-keymap
)))
467 (define-key map
"\C-c\C-c" 'Custom-set
)
468 (define-key map
"\C-x\C-s" 'Custom-save
)
470 "Keymap used inside editable fields in customization buffers.")
472 (widget-put (get 'editable-field
'widget-type
) :keymap custom-field-keymap
)
476 (defun custom-split-regexp-maybe (regexp)
477 "If REGEXP is a string, split it to a list at `\\|'.
478 You can get the original back from the result with:
479 (mapconcat 'identity result \"\\|\")
481 IF REGEXP is not a string, return it unchanged."
483 (split-string regexp
"\\\\|")
486 (defun custom-variable-prompt ()
487 "Prompt for a custom variable, defaulting to the variable at point.
488 Return a list suitable for use in `interactive'."
489 (let* ((v (variable-at-point))
490 (default (and (symbolp v
) (custom-variable-p v
) (symbol-name v
)))
491 (enable-recursive-minibuffers t
)
493 (setq val
(completing-read
494 (if default
(format "Customize variable (default %s): " default
)
495 "Customize variable: ")
496 obarray
'custom-variable-p t nil nil default
))
497 (list (if (equal val
"")
498 (if (symbolp v
) v nil
)
501 (defun custom-menu-filter (menu widget
)
502 "Convert MENU to the form used by `widget-choose'.
503 MENU should be in the same format as `custom-variable-menu'.
504 WIDGET is the widget to apply the filter entries of MENU on."
506 current name action filter
)
508 (setq current
(car menu
)
510 action
(nth 1 current
)
511 filter
(nth 2 current
)
513 (if (or (null filter
) (funcall filter widget
))
514 (push (cons name action
) result
)
520 (defvar custom-prefix-list nil
521 "List of prefixes that should be ignored by `custom-unlispify'.")
523 (defcustom custom-unlispify-menu-entries t
524 "Display menu entries as words instead of symbols if non-nil."
528 (defcustom custom-unlispify-remove-prefixes nil
529 "Non-nil means remove group prefixes from option names in buffer."
531 :group
'custom-buffer
534 (defun custom-unlispify-menu-entry (symbol &optional no-suffix
)
535 "Convert SYMBOL into a menu entry."
536 (cond ((not custom-unlispify-menu-entries
)
537 (symbol-name symbol
))
538 ((get symbol
'custom-tag
)
540 (get symbol
'custom-tag
)
541 (concat (get symbol
'custom-tag
) "...")))
543 (with-current-buffer (get-buffer-create " *Custom-Work*")
545 (princ symbol
(current-buffer))
546 (goto-char (point-min))
547 ;; FIXME: Boolean variables are not predicates, so they shouldn't
548 ;; end with `-p'. -stef
549 ;; (when (and (eq (get symbol 'custom-type) 'boolean)
550 ;; (re-search-forward "-p\\'" nil t))
551 ;; (replace-match "" t t)
552 ;; (goto-char (point-min)))
553 (if custom-unlispify-remove-prefixes
554 (let ((prefixes custom-prefix-list
)
557 (setq prefix
(car prefixes
))
558 (if (search-forward prefix
(+ (point) (length prefix
)) t
)
561 (delete-region (point-min) (point)))
562 (setq prefixes
(cdr prefixes
))))))
563 (subst-char-in-region (point-min) (point-max) ?- ?\ t
)
564 (capitalize-region (point-min) (point-max))
566 (goto-char (point-max))
570 (defcustom custom-unlispify-tag-names t
571 "Display tag names as words instead of symbols if non-nil."
572 :group
'custom-buffer
575 (defun custom-unlispify-tag-name (symbol)
576 "Convert SYMBOL into a menu entry."
577 (let ((custom-unlispify-menu-entries custom-unlispify-tag-names
))
578 (custom-unlispify-menu-entry symbol t
)))
580 (defun custom-prefix-add (symbol prefixes
)
581 "Add SYMBOL to list of ignored PREFIXES."
582 (cons (or (get symbol
'custom-prefix
)
583 (concat (symbol-name symbol
) "-"))
588 (defcustom custom-guess-name-alist
594 ("-function\\'" function
)
595 ("-functions\\'" (repeat function
))
596 ("-list\\'" (repeat sexp
))
597 ("-alist\\'" (repeat (cons sexp sexp
))))
598 "Alist of (MATCH TYPE).
600 MATCH should be a regexp matching the name of a symbol, and TYPE should
601 be a widget suitable for editing the value of that symbol. The TYPE
602 of the first entry where MATCH matches the name of the symbol will be
605 This is used for guessing the type of variables not declared with
607 :type
'(repeat (group (regexp :tag
"Match") (sexp :tag
"Type")))
608 :group
'custom-buffer
)
610 (defcustom custom-guess-doc-alist
611 '(("\\`\\*?Non-nil " boolean
))
612 "Alist of (MATCH TYPE).
614 MATCH should be a regexp matching a documentation string, and TYPE
615 should be a widget suitable for editing the value of a variable with
616 that documentation string. The TYPE of the first entry where MATCH
617 matches the name of the symbol will be used.
619 This is used for guessing the type of variables not declared with
621 :type
'(repeat (group (regexp :tag
"Match") (sexp :tag
"Type")))
622 :group
'custom-buffer
)
624 (defun custom-guess-type (symbol)
625 "Guess a widget suitable for editing the value of SYMBOL.
626 This is done by matching SYMBOL with `custom-guess-name-alist' and
627 if that fails, the doc string with `custom-guess-doc-alist'."
628 (let ((name (symbol-name symbol
))
629 (names custom-guess-name-alist
)
632 (setq current
(car names
)
634 (when (string-match (nth 0 current
) name
)
635 (setq found
(nth 1 current
)
638 (let ((doc (documentation-property symbol
'variable-documentation
))
639 (docs custom-guess-doc-alist
))
642 (setq current
(car docs
)
644 (when (string-match (nth 0 current
) doc
)
645 (setq found
(nth 1 current
)
652 (defcustom custom-browse-sort-alphabetically nil
653 "If non-nil, sort customization group alphabetically in `custom-browse'."
655 :group
'custom-browse
)
657 (defcustom custom-browse-order-groups nil
658 "If non-nil, order group members within each customization group.
659 If `first', order groups before non-groups.
660 If `last', order groups after non-groups."
661 :type
'(choice (const first
)
663 (const :tag
"none" nil
))
664 :group
'custom-browse
)
666 (defcustom custom-browse-only-groups nil
667 "If non-nil, show group members only within each customization group."
669 :group
'custom-browse
)
672 (defcustom custom-buffer-sort-alphabetically t
673 "Whether to sort customization groups alphabetically in Custom buffer."
675 :group
'custom-buffer
678 (defcustom custom-buffer-order-groups
'last
679 "If non-nil, order group members within each customization group.
680 If `first', order groups before non-groups.
681 If `last', order groups after non-groups."
682 :type
'(choice (const first
)
684 (const :tag
"none" nil
))
685 :group
'custom-buffer
)
688 (defcustom custom-menu-sort-alphabetically nil
689 "If non-nil, sort each customization group alphabetically in menus."
693 (defcustom custom-menu-order-groups
'first
694 "If non-nil, order group members within each customization group.
695 If `first', order groups before non-groups.
696 If `last', order groups after non-groups."
697 :type
'(choice (const first
)
699 (const :tag
"none" nil
))
702 ;;;###autoload (add-hook 'same-window-regexps (purecopy "\\`\\*Customiz.*\\*\\'"))
704 (defun custom-sort-items (items sort-alphabetically order-groups
)
705 "Return a sorted copy of ITEMS.
706 ITEMS should be a `custom-group' property.
707 If SORT-ALPHABETICALLY non-nil, sort alphabetically.
708 If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
709 groups after non-groups, if nil do not order groups at all."
710 (sort (copy-sequence items
)
712 (let ((typea (nth 1 a
)) (typeb (nth 1 b
))
713 (namea (nth 0 a
)) (nameb (nth 0 b
)))
714 (cond ((not order-groups
)
715 ;; Since we don't care about A and B order, maybe sort.
716 (when sort-alphabetically
717 (string-lessp namea nameb
)))
718 ((eq typea
'custom-group
)
719 ;; If B is also a group, maybe sort. Otherwise, order A and B.
720 (if (eq typeb
'custom-group
)
721 (when sort-alphabetically
722 (string-lessp namea nameb
))
723 (eq order-groups
'first
)))
724 ((eq typeb
'custom-group
)
725 ;; Since A cannot be a group, order A and B.
726 (eq order-groups
'last
))
728 ;; Since A and B cannot be groups, sort.
729 (string-lessp namea nameb
)))))))
731 ;;; Custom Mode Commands.
733 ;; This variable is used by `custom-tool-bar-map', or directly by
734 ;; `custom-buffer-create-internal' if `custom-buffer-verbose-help' is non-nil.
736 (defvar custom-commands
737 '((" Set for current session " Custom-set t
738 "Apply all settings in this buffer to the current session"
741 (" Save for future sessions " Custom-save
742 (or custom-file user-init-file
)
743 "Apply all settings in this buffer and save them for future Emacs sessions."
746 (" Undo edits " Custom-reset-current t
747 "Restore all settings in this buffer to reflect their current values."
750 (" Reset to saved " Custom-reset-saved t
751 "Restore all settings in this buffer to their saved values (if any)."
754 (" Erase customizations " Custom-reset-standard
755 (or custom-file user-init-file
)
756 "Un-customize all settings in this buffer and save them with standard values."
759 (" Help for Customize " Custom-help t
760 "Get help for using Customize."
763 (" Exit " Custom-buffer-done t
"Exit Customize." "exit" "Exit")))
765 (defun Custom-help ()
766 "Read the node on Easy Customization in the Emacs manual."
768 (info "(emacs)Easy Customization"))
770 (defvar custom-reset-menu
771 '(("Undo Edits" . Custom-reset-current
)
772 ("Reset to Saved" . Custom-reset-saved
)
773 ("Erase Customizations (use standard values)" . Custom-reset-standard
))
774 "Alist of actions for the `Reset' button.
775 The key is a string containing the name of the action, the value is a
776 Lisp function taking the widget as an element which will be called
777 when the action is chosen.")
779 (defvar custom-options nil
780 "Customization widgets in the current buffer.")
782 (defun custom-command-apply (fun query
&optional strong-query
)
783 "Call function FUN on all widgets in `custom-options'.
784 If there is more than one widget, ask user for confirmation using
785 the query string QUERY, using `y-or-n-p' if STRONG-QUERY is nil,
786 and `yes-or-no-p' otherwise."
787 (if (or (and (= 1 (length custom-options
))
788 (memq (widget-type (car custom-options
))
789 '(custom-variable custom-face
)))
790 (funcall (if strong-query
'yes-or-no-p
'y-or-n-p
) query
))
791 (progn (mapc fun custom-options
) t
)
795 (defun Custom-set (&rest ignore
)
796 "Set the current value of all edited settings in the buffer."
798 (custom-command-apply
800 (when (eq (widget-get child
:custom-state
) 'modified
)
801 (widget-apply child
:custom-set
)))
802 "Set all values according to this buffer? "))
804 (defun Custom-save (&rest ignore
)
805 "Set all edited settings, then save all settings that have been set.
806 If a setting was edited and set before, this saves it. If a
807 setting was merely edited before, this sets it then saves it."
809 (when (custom-command-apply
811 (when (memq (widget-get child
:custom-state
)
812 '(modified set changed rogue
))
813 (widget-apply child
:custom-mark-to-save
)))
814 "Save all settings in this buffer? " t
)
815 ;; Save changes to buffer and redraw.
817 (dolist (child custom-options
)
818 (widget-apply child
:custom-state-set-and-redraw
))))
820 (defun custom-reset (widget &optional event
)
821 "Select item from reset menu."
822 (let* ((completion-ignore-case t
)
823 (answer (widget-choose "Reset settings"
829 (defun Custom-reset-current (&rest ignore
)
830 "Reset all edited settings in the buffer to show their current values."
832 (custom-command-apply
834 (if (memq (widget-get widget
:custom-state
) '(modified changed
))
835 (widget-apply widget
:custom-reset-current
)))
836 "Reset all settings' buffer text to show current values? "))
838 (defun Custom-reset-saved (&rest ignore
)
839 "Reset all edited or set settings in the buffer to their saved value.
840 This also shows the saved values in the buffer."
842 (custom-command-apply
844 (if (memq (widget-get widget
:custom-state
) '(modified set changed rogue
))
845 (widget-apply widget
:custom-reset-saved
)))
846 "Reset all settings (current values and buffer text) to saved values? "))
848 ;; The next two variables are bound to '(t) by `Custom-reset-standard'
849 ;; and `custom-group-reset-standard'. If these variables are nil, both
850 ;; `custom-variable-reset-standard' and `custom-face-reset-standard'
851 ;; save, reset and redraw the handled widget immediately. Otherwise,
852 ;; they add the widget to the corresponding list and leave it to
853 ;; `custom-reset-standard-save-and-update' to save, reset and redraw it.
854 (defvar custom-reset-standard-variables-list nil
)
855 (defvar custom-reset-standard-faces-list nil
)
857 ;; The next function was excerpted from `custom-variable-reset-standard'
858 ;; and `custom-face-reset-standard' and is used to avoid calling
859 ;; `custom-save-all' repeatedly (and thus saving settings to file one by
860 ;; one) when erasing all customizations.
861 (defun custom-reset-standard-save-and-update ()
862 "Save settings and redraw after erasing customizations."
863 (when (or (and custom-reset-standard-variables-list
864 (not (eq custom-reset-standard-variables-list
'(t))))
865 (and custom-reset-standard-faces-list
866 (not (eq custom-reset-standard-faces-list
'(t)))))
867 ;; Save settings to file.
869 ;; Set state of and redraw variables.
870 (dolist (widget custom-reset-standard-variables-list
)
871 (unless (eq widget t
)
872 (widget-put widget
:custom-state
'unknown
)
873 (custom-redraw widget
)))
874 ;; Set state of and redraw faces.
875 (dolist (widget custom-reset-standard-faces-list
)
876 (unless (eq widget t
)
877 (let* ((symbol (widget-value widget
))
878 (child (car (widget-get widget
:children
)))
879 (value (get symbol
'face-defface-spec
))
880 (comment-widget (widget-get widget
:comment-widget
)))
881 (put symbol
'face-comment nil
)
882 (widget-value-set child
883 (custom-pre-filter-face-spec
884 (list (list t
(custom-face-attributes-get
886 ;; This call manages the comment visibility
887 (widget-value-set comment-widget
"")
888 (custom-face-state-set widget
)
889 (custom-redraw-magic widget
))))))
891 (defun Custom-reset-standard (&rest ignore
)
892 "Erase all customizations (either current or saved) in current buffer.
893 The immediate result is to restore them to their standard values.
894 This operation eliminates any saved values for the group members,
895 making them as if they had never been customized at all."
897 ;; Bind these temporarily.
898 (let ((custom-reset-standard-variables-list '(t))
899 (custom-reset-standard-faces-list '(t)))
900 (custom-command-apply
902 (and (or (null (widget-get widget
:custom-standard-value
))
903 (widget-apply widget
:custom-standard-value
))
904 (memq (widget-get widget
:custom-state
)
905 '(modified set changed saved rogue
))
906 (widget-apply widget
:custom-mark-to-reset-standard
)))
907 "Erase all customizations for settings in this buffer? " t
)
908 (custom-reset-standard-save-and-update)))
910 ;;; The Customize Commands
912 (defun custom-prompt-variable (prompt-var prompt-val
&optional comment
)
913 "Prompt for a variable and a value and return them as a list.
914 PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
915 prompt for the value. The %s escape in PROMPT-VAL is replaced with
916 the name of the variable.
918 If the variable has a `variable-interactive' property, that is used as if
919 it were the arg to `interactive' (which see) to interactively read the value.
921 If the variable has a `custom-type' property, it must be a widget and the
922 `:prompt-value' property of that widget will be used for reading the value.
923 If the variable also has a `custom-get' property, that is used for finding
924 the current value of the variable, otherwise `symbol-value' is used.
926 If optional COMMENT argument is non-nil, also prompt for a comment and return
927 it as the third element in the list."
928 (let* ((var (read-variable prompt-var
))
929 (minibuffer-help-form '(describe-variable var
))
931 (let ((prop (get var
'variable-interactive
))
932 (type (get var
'custom-type
))
933 (prompt (format prompt-val var
)))
935 (setq type
(list type
)))
937 ;; Use VAR's `variable-interactive' property
938 ;; as an interactive spec for prompting.
939 (call-interactively `(lambda (arg)
943 (widget-prompt-value type
947 (or (get var
'custom-get
) 'symbol-value
)
951 (eval-minibuffer prompt
))))))
954 (read-string "Comment: " (get var
'variable-comment
)))
958 (defun customize-set-value (variable value
&optional comment
)
959 "Set VARIABLE to VALUE, and return VALUE. VALUE is a Lisp object.
961 If VARIABLE has a `variable-interactive' property, that is used as if
962 it were the arg to `interactive' (which see) to interactively read the value.
964 If VARIABLE has a `custom-type' property, it must be a widget and the
965 `:prompt-value' property of that widget will be used for reading the value.
967 If given a prefix (or a COMMENT argument), also prompt for a comment."
968 (interactive (custom-prompt-variable "Set variable: "
972 (cond ((string= comment
"")
973 (put variable
'variable-comment nil
))
975 (put variable
'variable-comment comment
)))
976 (set variable value
))
979 (defun customize-set-variable (variable value
&optional comment
)
980 "Set the default for VARIABLE to VALUE, and return VALUE.
981 VALUE is a Lisp object.
983 If VARIABLE has a `custom-set' property, that is used for setting
984 VARIABLE, otherwise `set-default' is used.
986 If VARIABLE has a `variable-interactive' property, that is used as if
987 it were the arg to `interactive' (which see) to interactively read the value.
989 If VARIABLE has a `custom-type' property, it must be a widget and the
990 `:prompt-value' property of that widget will be used for reading the value.
992 If given a prefix (or a COMMENT argument), also prompt for a comment."
993 (interactive (custom-prompt-variable "Set variable: "
994 "Set customized value for %s to: "
996 (custom-load-symbol variable
)
997 (custom-push-theme 'theme-value variable
'user
'set
(custom-quote value
))
998 (funcall (or (get variable
'custom-set
) 'set-default
) variable value
)
999 (put variable
'customized-value
(list (custom-quote value
)))
1000 (cond ((string= comment
"")
1001 (put variable
'variable-comment nil
)
1002 (put variable
'customized-variable-comment nil
))
1004 (put variable
'variable-comment comment
)
1005 (put variable
'customized-variable-comment comment
)))
1009 (defun customize-save-variable (variable value
&optional comment
)
1010 "Set the default for VARIABLE to VALUE, and save it for future sessions.
1013 If VARIABLE has a `custom-set' property, that is used for setting
1014 VARIABLE, otherwise `set-default' is used.
1016 If VARIABLE has a `variable-interactive' property, that is used as if
1017 it were the arg to `interactive' (which see) to interactively read the value.
1019 If VARIABLE has a `custom-type' property, it must be a widget and the
1020 `:prompt-value' property of that widget will be used for reading the value.
1022 If given a prefix (or a COMMENT argument), also prompt for a comment."
1023 (interactive (custom-prompt-variable "Set and save variable: "
1024 "Set and save value for %s as: "
1025 current-prefix-arg
))
1026 (funcall (or (get variable
'custom-set
) 'set-default
) variable value
)
1027 (put variable
'saved-value
(list (custom-quote value
)))
1028 (custom-push-theme 'theme-value variable
'user
'set
(custom-quote value
))
1029 (cond ((string= comment
"")
1030 (put variable
'variable-comment nil
)
1031 (put variable
'saved-variable-comment nil
))
1033 (put variable
'variable-comment comment
)
1034 (put variable
'saved-variable-comment comment
)))
1035 (put variable
'customized-value nil
)
1036 (put variable
'customized-variable-comment nil
)
1042 "Select a customization buffer which you can use to set user options.
1043 User options are structured into \"groups\".
1044 Initially the top-level group `Emacs' and its immediate subgroups
1045 are shown; the contents of those subgroups are initially hidden."
1047 (customize-group 'emacs
))
1050 (defun customize-mode (mode)
1051 "Customize options related to the current major mode.
1052 If a prefix \\[universal-argument] was given (or if the current major mode has no known group),
1053 then prompt for the MODE to customize."
1056 (let ((completion-regexp-list '("-mode\\'"))
1057 (group (custom-group-of-mode major-mode
)))
1058 (if (and group
(not current-prefix-arg
))
1061 (completing-read (if group
1062 (format "Major mode (default %s): " major-mode
)
1065 'custom-group-of-mode
1066 t nil nil
(if group
(symbol-name major-mode
))))))))
1067 (customize-group (custom-group-of-mode mode
)))
1069 (defun customize-read-group ()
1070 (let ((completion-ignore-case t
))
1071 (completing-read "Customize group (default emacs): "
1074 (or (and (get symbol
'custom-loads
)
1075 (not (get symbol
'custom-autoload
)))
1076 (get symbol
'custom-group
)))
1080 (defun customize-group (&optional group
)
1081 "Customize GROUP, which must be a customization group."
1082 (interactive (list (customize-read-group)))
1083 (when (stringp group
)
1084 (if (string-equal "" group
)
1086 (setq group
(intern group
))))
1087 (let ((name (format "*Customize Group: %s*"
1088 (custom-unlispify-tag-name group
))))
1089 (if (get-buffer name
)
1090 (pop-to-buffer name
)
1091 (custom-buffer-create
1092 (list (list group
'custom-group
))
1094 (concat " for group "
1095 (custom-unlispify-tag-name group
))))))
1098 (defun customize-group-other-window (&optional group
)
1099 "Customize GROUP, which must be a customization group, in another window."
1100 (interactive (list (customize-read-group)))
1101 (let ((pop-up-windows t
)
1102 (same-window-buffer-names nil
)
1103 (same-window-regexps nil
))
1104 (customize-group group
)))
1107 (defalias 'customize-variable
'customize-option
)
1110 (defun customize-option (symbol)
1111 "Customize SYMBOL, which must be a user option variable."
1112 (interactive (custom-variable-prompt))
1114 (error "No variable specified"))
1115 (let ((basevar (indirect-variable symbol
)))
1116 (custom-buffer-create (list (list basevar
'custom-variable
))
1117 (format "*Customize Option: %s*"
1118 (custom-unlispify-tag-name basevar
)))
1119 (unless (eq symbol basevar
)
1120 (message "`%s' is an alias for `%s'" symbol basevar
))))
1123 (defalias 'customize-variable-other-window
'customize-option-other-window
)
1126 (defun customize-option-other-window (symbol)
1127 "Customize SYMBOL, which must be a user option variable.
1128 Show the buffer in another window, but don't select it."
1129 (interactive (custom-variable-prompt))
1131 (error "No variable specified"))
1132 (let ((basevar (indirect-variable symbol
)))
1133 (custom-buffer-create-other-window
1134 (list (list basevar
'custom-variable
))
1135 (format "*Customize Option: %s*" (custom-unlispify-tag-name basevar
)))
1136 (unless (eq symbol basevar
)
1137 (message "`%s' is an alias for `%s'" symbol basevar
))))
1139 (defvar customize-changed-options-previous-release
"23.1"
1140 "Version for `customize-changed-options' to refer back to by default.")
1142 ;; Packages will update this variable, so make it available.
1144 (defvar customize-package-emacs-version-alist nil
1145 "Alist mapping versions of a package to Emacs versions.
1146 We use this for packages that have their own names, but are released
1147 as part of Emacs itself.
1149 Each elements looks like this:
1151 (PACKAGE (PVERSION . EVERSION)...)
1153 Here PACKAGE is the name of a package, as a symbol. After
1154 PACKAGE come one or more elements, each associating a
1155 package version PVERSION with the first Emacs version
1156 EVERSION in which it (or a subsequent version of PACKAGE)
1157 was first released. Both PVERSION and EVERSION are strings.
1158 PVERSION should be a string that this package used in
1159 the :package-version keyword for `defcustom', `defgroup',
1162 For example, the MH-E package updates this alist as follows:
1164 (add-to-list 'customize-package-emacs-version-alist
1165 '(MH-E (\"6.0\" . \"22.1\") (\"6.1\" . \"22.1\")
1166 (\"7.0\" . \"22.1\") (\"7.1\" . \"22.1\")
1167 (\"7.2\" . \"22.1\") (\"7.3\" . \"22.1\")
1168 (\"7.4\" . \"22.1\") (\"8.0\" . \"22.1\")))
1170 The value of PACKAGE needs to be unique and it needs to match the
1171 PACKAGE value appearing in the :package-version keyword. Since
1172 the user might see the value in a error message, a good choice is
1173 the official name of the package, such as MH-E or Gnus.")
1176 (defalias 'customize-changed
'customize-changed-options
)
1179 (defun customize-changed-options (&optional since-version
)
1180 "Customize all settings whose meanings have changed in Emacs itself.
1181 This includes new user option variables and faces, and new
1182 customization groups, as well as older options and faces whose meanings
1183 or default values have changed since the previous major Emacs release.
1185 With argument SINCE-VERSION (a string), customize all settings
1186 that were added or redefined since that version."
1190 (read-from-minibuffer
1191 (format "Customize options changed, since version (default %s): "
1192 customize-changed-options-previous-release
))))
1193 (if (equal since-version
"")
1194 (setq since-version nil
)
1195 (unless (condition-case nil
1196 (numberp (read since-version
))
1198 (signal 'wrong-type-argument
(list 'numberp since-version
))))
1199 (unless since-version
1200 (setq since-version customize-changed-options-previous-release
))
1202 ;; Load the information for versions since since-version. We use
1203 ;; custom-load-symbol for this.
1204 (put 'custom-versions-load-alist
'custom-loads nil
)
1205 (dolist (elt custom-versions-load-alist
)
1206 (if (customize-version-lessp since-version
(car elt
))
1207 (dolist (load (cdr elt
))
1208 (custom-add-load 'custom-versions-load-alist load
))))
1209 (custom-load-symbol 'custom-versions-load-alist
)
1210 (put 'custom-versions-load-alist
'custom-loads nil
)
1215 (let* ((package-version (get symbol
'custom-package-version
))
1217 (or (and package-version
1218 (customize-package-emacs-version symbol
1220 (get symbol
'custom-version
))))
1222 (when (customize-version-lessp since-version version
)
1223 (if (or (get symbol
'custom-group
)
1224 (get symbol
'group-documentation
))
1225 (push (list symbol
'custom-group
) found
))
1226 (if (custom-variable-p symbol
)
1227 (push (list symbol
'custom-variable
) found
))
1228 (if (custom-facep symbol
)
1229 (push (list symbol
'custom-face
) found
)))))))
1231 (custom-buffer-create (custom-sort-items found t
'first
)
1232 "*Customize Changed Options*")
1233 (error "No user option defaults have been changed since Emacs %s"
1236 (defun customize-package-emacs-version (symbol package-version
)
1237 "Return the Emacs version in which SYMBOL's meaning last changed.
1238 PACKAGE-VERSION has the form (PACKAGE . VERSION). We use
1239 `customize-package-emacs-version-alist' to find the version of
1240 Emacs that is associated with version VERSION of PACKAGE."
1241 (let (package-versions emacs-version
)
1242 ;; Use message instead of error since we want user to be able to
1243 ;; see the rest of the symbols even if a package author has
1244 ;; botched things up.
1245 (cond ((not (listp package-version
))
1246 (message "Invalid package-version value for %s" symbol
))
1247 ((setq package-versions
(assq (car package-version
)
1248 customize-package-emacs-version-alist
))
1250 (cdr (assoc (cdr package-version
) package-versions
)))
1251 (unless emacs-version
1252 (message "%s version %s not found in %s" symbol
1253 (cdr package-version
)
1254 "customize-package-emacs-version-alist")))
1256 (message "Package %s version %s lists no corresponding Emacs version"
1257 (car package-version
)
1258 (cdr package-version
))))
1261 (defun customize-version-lessp (version1 version2
)
1262 ;; Why are the versions strings, and given that they are, why aren't
1263 ;; they converted to numbers and compared as such here? -- fx
1265 ;; In case someone made a mistake and left out the quotes
1266 ;; in the :version value.
1267 (if (numberp version2
)
1268 (setq version2
(prin1-to-string version2
)))
1269 (let (major1 major2 minor1 minor2
)
1270 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version1
)
1271 (setq major1
(read (or (match-string 1 version1
)
1273 (setq minor1
(read (or (match-string 3 version1
)
1275 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version2
)
1276 (setq major2
(read (or (match-string 1 version2
)
1278 (setq minor2
(read (or (match-string 3 version2
)
1280 (or (< major1 major2
)
1281 (and (= major1 major2
)
1282 (< minor1 minor2
)))))
1285 (defun customize-face (&optional face
)
1286 "Customize FACE, which should be a face name or nil.
1287 If FACE is nil, customize all faces. If FACE is actually a
1288 face-alias, customize the face it is aliased to.
1290 Interactively, when point is on text which has a face specified,
1291 suggest to customize that face, if it's customizable."
1292 (interactive (list (read-face-name "Customize face" "all faces" t
)))
1293 (if (member face
'(nil ""))
1294 (setq face
(face-list)))
1295 (if (and (listp face
) (null (cdr face
)))
1296 (setq face
(car face
)))
1298 (custom-buffer-create
1300 (mapcar (lambda (s) (list s
'custom-face
)) face
)
1302 "*Customize Faces*")
1303 ;; If FACE is actually an alias, customize the face it is aliased to.
1304 (if (get face
'face-alias
)
1305 (setq face
(get face
'face-alias
)))
1306 (unless (facep face
)
1307 (error "Invalid face %S" face
))
1308 (custom-buffer-create
1309 (list (list face
'custom-face
))
1310 (format "*Customize Face: %s*"
1311 (custom-unlispify-tag-name face
)))))
1314 (defun customize-face-other-window (&optional face
)
1315 "Show customization buffer for face FACE in other window.
1316 If FACE is actually a face-alias, customize the face it is aliased to.
1318 Interactively, when point is on text which has a face specified,
1319 suggest to customize that face, if it's customizable."
1320 (interactive (list (read-face-name "Customize face" "all faces" t
)))
1321 (let ((pop-up-windows t
)
1322 (same-window-buffer-names nil
)
1323 (same-window-regexps nil
))
1324 (customize-face face
)))
1326 (defalias 'customize-customized
'customize-unsaved
)
1329 (defun customize-unsaved ()
1330 "Customize all user options set in this session but not saved."
1333 (mapatoms (lambda (symbol)
1334 (and (or (get symbol
'customized-face
)
1335 (get symbol
'customized-face-comment
))
1336 (custom-facep symbol
)
1337 (push (list symbol
'custom-face
) found
))
1338 (and (or (get symbol
'customized-value
)
1339 (get symbol
'customized-variable-comment
))
1341 (push (list symbol
'custom-variable
) found
))))
1343 (error "No user options are set but unsaved")
1344 (custom-buffer-create (custom-sort-items found t nil
)
1345 "*Customize Unsaved*"))))
1348 (defun customize-rogue ()
1349 "Customize all user variables modified outside customize."
1352 (mapatoms (lambda (symbol)
1353 (let ((cval (or (get symbol
'customized-value
)
1354 (get symbol
'saved-value
)
1355 (get symbol
'standard-value
))))
1356 (when (and cval
;Declared with defcustom.
1357 (default-boundp symbol
) ;Has a value.
1358 (not (equal (eval (car cval
))
1359 ;; Which does not match customize.
1360 (default-value symbol
))))
1361 (push (list symbol
'custom-variable
) found
)))))
1363 (error "No rogue user options")
1364 (custom-buffer-create (custom-sort-items found t nil
)
1365 "*Customize Rogue*"))))
1367 (defun customize-saved ()
1368 "Customize all already saved user options."
1371 (mapatoms (lambda (symbol)
1372 (and (or (get symbol
'saved-face
)
1373 (get symbol
'saved-face-comment
))
1374 (custom-facep symbol
)
1375 (push (list symbol
'custom-face
) found
))
1376 (and (or (get symbol
'saved-value
)
1377 (get symbol
'saved-variable-comment
))
1379 (push (list symbol
'custom-variable
) found
))))
1381 (error "No saved user options")
1382 (custom-buffer-create (custom-sort-items found t nil
)
1383 "*Customize Saved*"))))
1385 (declare-function apropos-parse-pattern
"apropos" (pattern))
1388 (defun customize-apropos (pattern &optional type
)
1389 "Customize all loaded options, faces and groups matching PATTERN.
1390 PATTERN can be a word, a list of words (separated by spaces),
1391 or a regexp (using some regexp special characters). If it is a word,
1392 search for matches for that word as a substring. If it is a list of words,
1393 search for matches for any two (or more) of those words.
1395 If TYPE is `options', include only options.
1396 If TYPE is `faces', include only faces.
1397 If TYPE is `groups', include only groups.
1398 If TYPE is t (interactively, with prefix arg), include variables
1399 that are not customizable options, as well as faces and groups
1400 \(but we recommend using `apropos-variable' instead)."
1401 (interactive (list (apropos-read-pattern "symbol") current-prefix-arg
))
1403 (apropos-parse-pattern pattern
)
1407 (when (string-match apropos-regexp
(symbol-name symbol
))
1408 ,(if (not (memq type
'(faces options
)))
1409 '(if (get symbol
'custom-group
)
1410 (push (list symbol
'custom-group
) found
)))
1411 ,(if (not (memq type
'(options groups
)))
1412 '(if (custom-facep symbol
)
1413 (push (list symbol
'custom-face
) found
)))
1414 ,(if (not (memq type
'(groups faces
)))
1415 `(if (and (boundp symbol
)
1416 (eq (indirect-variable symbol
) symbol
)
1417 (or (get symbol
'saved-value
)
1418 (custom-variable-p symbol
)
1419 ,(if (not (memq type
'(nil options
)))
1420 '(get symbol
'variable-documentation
))))
1421 (push (list symbol
'custom-variable
) found
))))))
1423 (error "No %s matching %s"
1426 (format "customizable %s"
1427 (if (memq type
'(options faces groups
))
1431 (custom-buffer-create
1432 (custom-sort-items found t custom-buffer-order-groups
)
1433 "*Customize Apropos*"))))
1436 (defun customize-apropos-options (regexp &optional arg
)
1437 "Customize all loaded customizable options matching REGEXP.
1438 With prefix ARG, include variables that are not customizable options
1439 \(but it is better to use `apropos-variable' if you want to find those)."
1440 (interactive "sCustomize options (regexp): \nP")
1441 (customize-apropos regexp
(or arg
'options
)))
1444 (defun customize-apropos-faces (regexp)
1445 "Customize all loaded faces matching REGEXP."
1446 (interactive "sCustomize faces (regexp): \n")
1447 (customize-apropos regexp
'faces
))
1450 (defun customize-apropos-groups (regexp)
1451 "Customize all loaded groups matching REGEXP."
1452 (interactive "sCustomize groups (regexp): \n")
1453 (customize-apropos regexp
'groups
))
1457 (defcustom custom-buffer-style
'links
1458 "Control the presentation style for customization buffers.
1459 The value should be a symbol, one of:
1461 brackets: groups nest within each other with big horizontal brackets.
1462 links: groups have links to subgroups."
1463 :type
'(radio (const brackets
)
1465 :group
'custom-buffer
)
1467 (defcustom custom-buffer-done-kill nil
1468 "Non-nil means exiting a Custom buffer should kill it."
1471 :group
'custom-buffer
)
1473 (defcustom custom-buffer-indent
3
1474 "Number of spaces to indent nested groups."
1476 :group
'custom-buffer
)
1478 (defun custom-get-fresh-buffer (name)
1479 "Get a fresh new buffer with name NAME.
1480 If the buffer already exist, clean it up to be like new.
1481 Beware: it's not quite like new. Good enough for custom, but maybe
1483 ;; To be more complete, we should also kill all permanent-local variables,
1484 ;; but it's not needed for custom.
1485 (let ((buf (get-buffer name
)))
1486 (when (and buf
(buffer-local-value 'buffer-file-name buf
))
1487 ;; This will check if the file is not saved.
1491 (get-buffer-create name
)
1492 (with-current-buffer buf
1493 (kill-all-local-variables)
1494 (run-hooks 'kill-buffer-hook
)
1495 ;; Delete overlays before erasing the buffer so the overlay hooks
1496 ;; don't get run spuriously when we erase the buffer.
1497 (let ((ols (overlay-lists)))
1498 (dolist (ol (nconc (car ols
) (cdr ols
)))
1499 (delete-overlay ol
)))
1504 (defun custom-buffer-create (options &optional name description
)
1505 "Create a buffer containing OPTIONS.
1506 Optional NAME is the name of the buffer.
1507 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1508 SYMBOL is a customization option, and WIDGET is a widget for editing
1510 (pop-to-buffer (custom-get-fresh-buffer (or name
"*Customization*")))
1511 (custom-buffer-create-internal options description
))
1514 (defun custom-buffer-create-other-window (options &optional name description
)
1515 "Create a buffer containing OPTIONS, and display it in another window.
1516 The result includes selecting that window.
1517 Optional NAME is the name of the buffer.
1518 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1519 SYMBOL is a customization option, and WIDGET is a widget for editing
1521 (unless name
(setq name
"*Customization*"))
1522 (let ((pop-up-windows t
)
1523 (same-window-buffer-names nil
)
1524 (same-window-regexps nil
))
1525 (pop-to-buffer (custom-get-fresh-buffer name
))
1526 (custom-buffer-create-internal options description
)))
1528 (defcustom custom-reset-button-menu nil
1529 "If non-nil, only show a single reset button in customize buffers.
1530 This button will have a menu with all three reset operations."
1532 :group
'custom-buffer
)
1534 (defcustom custom-buffer-verbose-help t
1535 "If non-nil, include explanatory text in the customization buffer."
1537 :group
'custom-buffer
)
1539 (defun Custom-buffer-done (&rest ignore
)
1540 "Exit current Custom buffer according to `custom-buffer-done-kill'."
1542 (quit-window custom-buffer-done-kill
))
1544 (defvar custom-button nil
1545 "Face used for buttons in customization buffers.")
1547 (defvar custom-button-mouse nil
1548 "Mouse face used for buttons in customization buffers.")
1550 (defvar custom-button-pressed nil
1551 "Face used for pressed buttons in customization buffers.")
1553 (defcustom custom-search-field t
1554 "If non-nil, show a search field in Custom buffers."
1557 :group
'custom-buffer
)
1559 (defcustom custom-raised-buttons
(not (equal (face-valid-attribute-values :box
)
1560 '(("unspecified" . unspecified
))))
1561 "If non-nil, indicate active buttons in a `raised-button' style.
1562 Otherwise use brackets."
1565 :group
'custom-buffer
1566 :set
(lambda (variable value
)
1567 (custom-set-default variable value
)
1569 (if value
'custom-button
'custom-button-unraised
))
1570 (setq custom-button-mouse
1571 (if value
'custom-button-mouse
'highlight
))
1572 (setq custom-button-pressed
1574 'custom-button-pressed
1575 'custom-button-pressed-unraised
))))
1577 (defun custom-buffer-create-internal (options &optional description
)
1579 (let ((init-file (or custom-file user-init-file
)))
1580 ;; Insert verbose help at the top of the custom buffer.
1581 (when custom-buffer-verbose-help
1582 (widget-insert (if init-file
1583 "To apply changes, use the Save or Set buttons."
1584 "Custom settings cannot be saved; maybe you started Emacs with `-q'.")
1585 "\nFor details, see ")
1586 (widget-create 'custom-manual
1587 :tag
"Saving Customizations"
1588 "(emacs)Saving Customizations")
1589 (widget-insert " in the ")
1590 (widget-create 'custom-manual
1592 :help-echo
"Read the Emacs manual."
1594 (widget-insert "."))
1595 (widget-insert "\n")
1597 ;; Insert the search field.
1598 (when custom-search-field
1599 (widget-insert "\n")
1600 (let* ((echo "Search for custom items")
1604 :size
40 :help-echo echo
1605 :action
`(lambda (widget &optional event
)
1606 (customize-apropos (split-string (widget-value widget
)))))))
1608 (widget-create-child-and-convert
1609 search-widget
'push-button
1611 :help-echo echo
:action
1612 (lambda (widget &optional event
)
1613 (customize-apropos (widget-value (widget-get widget
:parent
)))))
1614 (widget-insert "\n")))
1616 ;; The custom command buttons are also in the toolbar, so for a
1617 ;; time they were not inserted in the buffer if the toolbar was in use.
1618 ;; But it can be a little confusing for the buffer layout to
1619 ;; change according to whether or nor the toolbar is on, not to
1620 ;; mention that a custom buffer can in theory be created in a
1621 ;; frame with a toolbar, then later viewed in one without.
1622 ;; So now the buttons are always inserted in the buffer. (Bug#1326)
1623 (if custom-buffer-verbose-help
1625 Operate on all settings in this buffer:\n"))
1626 (let ((button (lambda (tag action active help icon label
)
1629 (widget-create 'push-button
:tag tag
1630 :help-echo help
:action action
))))
1631 (commands custom-commands
))
1632 (apply button
(pop commands
)) ; Set for current session
1633 (apply button
(pop commands
)) ; Save for future sessions
1634 (if custom-reset-button-menu
1637 (widget-create 'push-button
1639 :help-echo
"Show a menu with reset operations."
1640 :mouse-down-action
'ignore
1641 :action
'custom-reset
))
1642 (widget-insert "\n")
1643 (apply button
(pop commands
)) ; Undo edits
1644 (apply button
(pop commands
)) ; Reset to saved
1645 (apply button
(pop commands
)) ; Erase customization
1647 (pop commands
) ; Help (omitted)
1648 (apply button
(pop commands
)))) ; Exit
1649 (widget-insert "\n\n"))
1651 ;; Now populate the custom buffer.
1652 (message "Creating customization items...")
1653 (buffer-disable-undo)
1654 (setq custom-options
1655 (if (= (length options
) 1)
1656 (mapcar (lambda (entry)
1657 (widget-create (nth 1 entry
)
1658 :documentation-shown t
1659 :custom-state
'unknown
1660 :tag
(custom-unlispify-tag-name
1662 :value
(nth 0 entry
)))
1665 (length (length options
)))
1666 (mapcar (lambda (entry)
1668 (message "Creating customization items ...%2d%%"
1669 (/ (* 100.0 count
) length
))
1670 (widget-create (nth 1 entry
)
1671 :tag
(custom-unlispify-tag-name
1673 :value
(nth 0 entry
))
1674 (setq count
(1+ count
))
1675 (unless (eq (preceding-char) ?
\n)
1676 (widget-insert "\n"))
1677 (widget-insert "\n")))
1679 (unless (eq (preceding-char) ?
\n)
1680 (widget-insert "\n"))
1681 (message "Creating customization items ...done")
1682 (message "Resetting customization items...")
1683 (unless (eq custom-buffer-style
'tree
)
1684 (mapc 'custom-magic-reset custom-options
))
1685 (message "Resetting customization items...done")
1686 (message "Creating customization setup...")
1688 (buffer-enable-undo)
1689 (goto-char (point-min))
1690 (message "Creating customization setup...done"))
1692 ;;; The Tree Browser.
1695 (defun customize-browse (&optional group
)
1696 "Create a tree browser for the customize hierarchy."
1699 (setq group
'emacs
))
1700 (let ((name "*Customize Browser*"))
1701 (pop-to-buffer (custom-get-fresh-buffer name
)))
1703 (widget-insert (format "\
1704 %s buttons; type RET or click mouse-1
1705 on a button to invoke its action.
1706 Invoke [+] to expand a group, and [-] to collapse an expanded group.\n"
1707 (if custom-raised-buttons
1708 "`Raised' text indicates"
1709 "Square brackets indicate")))
1712 (if custom-browse-only-groups
1714 Invoke the [Group] button below to edit that item in another window.\n\n")
1715 (widget-insert "Invoke the ")
1716 (widget-create 'item
1719 :tag-glyph
"folder")
1720 (widget-insert ", ")
1721 (widget-create 'item
1725 (widget-insert ", and ")
1726 (widget-create 'item
1729 :tag-glyph
"option")
1730 (widget-insert " buttons below to edit that
1731 item in another window.\n\n"))
1732 (let ((custom-buffer-style 'tree
))
1733 (widget-create 'custom-group
1735 :custom-state
'unknown
1736 :tag
(custom-unlispify-tag-name group
)
1739 (goto-char (point-min)))
1741 (define-widget 'custom-browse-visibility
'item
1742 "Control visibility of items in the customize tree browser."
1744 :action
'custom-browse-visibility-action
)
1746 (defun custom-browse-visibility-action (widget &rest ignore
)
1747 (let ((custom-buffer-style 'tree
))
1748 (custom-toggle-parent widget
)))
1750 (define-widget 'custom-browse-group-tag
'custom-group-link
1751 "Show parent in other window when activated."
1754 :action
'custom-browse-group-tag-action
)
1756 (defun custom-browse-group-tag-action (widget &rest ignore
)
1757 (let ((parent (widget-get widget
:parent
)))
1758 (customize-group-other-window (widget-value parent
))))
1760 (define-widget 'custom-browse-variable-tag
'custom-group-link
1761 "Show parent in other window when activated."
1764 :action
'custom-browse-variable-tag-action
)
1766 (defun custom-browse-variable-tag-action (widget &rest ignore
)
1767 (let ((parent (widget-get widget
:parent
)))
1768 (customize-variable-other-window (widget-value parent
))))
1770 (define-widget 'custom-browse-face-tag
'custom-group-link
1771 "Show parent in other window when activated."
1774 :action
'custom-browse-face-tag-action
)
1776 (defun custom-browse-face-tag-action (widget &rest ignore
)
1777 (let ((parent (widget-get widget
:parent
)))
1778 (customize-face-other-window (widget-value parent
))))
1780 (defconst custom-browse-alist
'((" " "space")
1786 (defun custom-browse-insert-prefix (prefix)
1787 "Insert PREFIX. On XEmacs convert it to line graphics."
1788 ;; Fixme: do graphics.
1789 (if nil
; (featurep 'xemacs)
1792 (while (not (string-equal prefix
""))
1793 (let ((entry (substring prefix
0 3)))
1794 (setq prefix
(substring prefix
3))
1795 (let ((overlay (make-overlay (1- (point)) (point) nil t nil
))
1796 (name (nth 1 (assoc entry custom-browse-alist
))))
1797 (overlay-put overlay
'end-glyph
(widget-glyph-find name entry
))
1798 (overlay-put overlay
'start-open t
)
1799 (overlay-put overlay
'end-open t
)))))
1802 ;;; Modification of Basic Widgets.
1804 ;; We add extra properties to the basic widgets needed here. This is
1805 ;; fine, as long as we are careful to stay within our own namespace.
1807 ;; We want simple widgets to be displayed by default, but complex
1808 ;; widgets to be hidden.
1810 (widget-put (get 'item
'widget-type
) :custom-show t
)
1811 (widget-put (get 'editable-field
'widget-type
)
1812 :custom-show
(lambda (widget value
)
1813 (let ((pp (pp-to-string value
)))
1814 (cond ((string-match "\n" pp
)
1819 (widget-put (get 'menu-choice
'widget-type
) :custom-show t
)
1821 ;;; The `custom-manual' Widget.
1823 (define-widget 'custom-manual
'info-link
1824 "Link to the manual entry for this customization option."
1825 :help-echo
"Read the manual entry for this option."
1826 :keymap custom-mode-link-map
1827 :follow-link
'mouse-face
1828 :button-face
'custom-link
1829 :mouse-face
'highlight
1830 :pressed-face
'highlight
1833 ;;; The `custom-magic' Widget.
1835 (defgroup custom-magic-faces nil
1836 "Faces used by the magic button."
1837 :group
'custom-faces
1838 :group
'custom-buffer
)
1840 (defface custom-invalid
'((((class color
))
1841 (:foreground
"yellow1" :background
"red1"))
1843 (:weight bold
:slant italic
:underline t
)))
1844 "Face used when the customize item is invalid."
1845 :group
'custom-magic-faces
)
1846 (define-obsolete-face-alias 'custom-invalid-face
'custom-invalid
"22.1")
1848 (defface custom-rogue
'((((class color
))
1849 (:foreground
"pink" :background
"black"))
1852 "Face used when the customize item is not defined for customization."
1853 :group
'custom-magic-faces
)
1854 (define-obsolete-face-alias 'custom-rogue-face
'custom-rogue
"22.1")
1856 (defface custom-modified
'((((min-colors 88) (class color
))
1857 (:foreground
"white" :background
"blue1"))
1859 (:foreground
"white" :background
"blue"))
1861 (:slant italic
:bold
)))
1862 "Face used when the customize item has been modified."
1863 :group
'custom-magic-faces
)
1864 (define-obsolete-face-alias 'custom-modified-face
'custom-modified
"22.1")
1866 (defface custom-set
'((((min-colors 88) (class color
))
1867 (:foreground
"blue1" :background
"white"))
1869 (:foreground
"blue" :background
"white"))
1872 "Face used when the customize item has been set."
1873 :group
'custom-magic-faces
)
1874 (define-obsolete-face-alias 'custom-set-face
'custom-set
"22.1")
1876 (defface custom-changed
'((((min-colors 88) (class color
))
1877 (:foreground
"white" :background
"blue1"))
1879 (:foreground
"white" :background
"blue"))
1882 "Face used when the customize item has been changed."
1883 :group
'custom-magic-faces
)
1884 (define-obsolete-face-alias 'custom-changed-face
'custom-changed
"22.1")
1886 (defface custom-themed
'((((min-colors 88) (class color
))
1887 (:foreground
"white" :background
"blue1"))
1889 (:foreground
"white" :background
"blue"))
1892 "Face used when the customize item has been set by a theme."
1893 :group
'custom-magic-faces
)
1895 (defface custom-saved
'((t (:underline t
)))
1896 "Face used when the customize item has been saved."
1897 :group
'custom-magic-faces
)
1898 (define-obsolete-face-alias 'custom-saved-face
'custom-saved
"22.1")
1900 (defconst custom-magic-alist
1901 '((nil "#" underline
"\
1902 UNINITIALIZED, you should not see this.")
1903 (unknown "?" italic
"\
1904 UNKNOWN, you should not see this.")
1905 (hidden "-" default
"\
1906 HIDDEN, invoke \"Show\" in the previous line to show." "\
1907 group now hidden, invoke \"Show\", above, to show contents.")
1908 (invalid "x" custom-invalid
"\
1909 INVALID, the displayed value cannot be set.")
1910 (modified "*" custom-modified
"\
1911 EDITED, shown value does not take effect until you set or save it." "\
1912 something in this group has been edited but not set.")
1913 (set "+" custom-set
"\
1914 SET for current session only." "\
1915 something in this group has been set but not saved.")
1916 (changed ":" custom-changed
"\
1917 CHANGED outside Customize." "\
1918 something in this group has been changed outside customize.")
1919 (saved "!" custom-saved
"\
1921 something in this group has been set and saved.")
1922 (themed "o" custom-themed
"\
1924 visible group members are all at standard values.")
1925 (rogue "@" custom-rogue
"\
1926 NO CUSTOMIZATION DATA; not intended to be customized." "\
1927 something in this group is not prepared for customization.")
1928 (standard " " nil
"\
1930 visible group members are all at standard values."))
1931 "Alist of customize option states.
1932 Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where
1934 STATE is one of the following symbols:
1937 For internal use, should never occur.
1939 For internal use, should never occur.
1941 This item is not being displayed.
1943 This item is modified, but has an invalid form.
1945 This item is modified, and has a valid form.
1947 This item has been set but not saved.
1949 The current value of this item has been changed outside Customize.
1951 This item is marked for saving.
1953 This item has no customization information.
1955 This item is unchanged from the standard setting.
1957 MAGIC is a string used to present that state.
1959 FACE is a face used to present the state.
1961 ITEM-DESC is a string describing the state for options.
1963 GROUP-DESC is a string describing the state for groups. If this is
1964 left out, ITEM-DESC will be used.
1966 The string %c in either description will be replaced with the
1967 category of the item. These are `group'. `option', and `face'.
1969 The list should be sorted most significant first.")
1971 (defcustom custom-magic-show
'long
1972 "If non-nil, show textual description of the state.
1973 If `long', show a full-line description, not just one word."
1974 :type
'(choice (const :tag
"no" nil
)
1976 (other :tag
"short" short
))
1977 :group
'custom-buffer
)
1979 (defcustom custom-magic-show-hidden
'(option face
)
1980 "Control whether the State button is shown for hidden items.
1981 The value should be a list with the custom categories where the State
1982 button should be visible. Possible categories are `group', `option',
1984 :type
'(set (const group
) (const option
) (const face
))
1985 :group
'custom-buffer
)
1987 (defcustom custom-magic-show-button nil
1988 "Show a \"magic\" button indicating the state of each customization option."
1990 :group
'custom-buffer
)
1992 (define-widget 'custom-magic
'default
1993 "Show and manipulate state for a customization option."
1995 :action
'widget-parent-action
1998 :value-create
'custom-magic-value-create
1999 :value-delete
'widget-children-value-delete
)
2001 (defun widget-magic-mouse-down-action (widget &optional event
)
2002 ;; Non-nil unless hidden.
2003 (not (eq (widget-get (widget-get (widget-get widget
:parent
) :parent
)
2007 (defun custom-magic-value-create (widget)
2008 "Create compact status report for WIDGET."
2009 (let* ((parent (widget-get widget
:parent
))
2010 (state (widget-get parent
:custom-state
))
2011 (hidden (eq state
'hidden
))
2012 (entry (assq state custom-magic-alist
))
2013 (magic (nth 1 entry
))
2014 (face (nth 2 entry
))
2015 (category (widget-get parent
:custom-category
))
2016 (text (or (and (eq category
'group
)
2019 (form (widget-get parent
:custom-form
))
2021 (unless (eq state
'hidden
)
2022 (while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text
)
2023 (setq text
(concat (match-string 1 text
)
2024 (symbol-name category
)
2025 (match-string 2 text
))))
2026 (when (and custom-magic-show
2028 (memq category custom-magic-show-hidden
)))
2030 (when (and (eq category
'group
)
2031 (not (and (eq custom-buffer-style
'links
)
2032 (> (widget-get parent
:custom-level
) 1))))
2033 (insert-char ?\
(* custom-buffer-indent
2034 (widget-get parent
:custom-level
))))
2035 (push (widget-create-child-and-convert
2037 :help-echo
"Change the state of this item."
2038 :format
(if hidden
"%t" "%[%t%]")
2039 :button-prefix
'widget-push-button-prefix
2040 :button-suffix
'widget-push-button-suffix
2041 :mouse-down-action
'widget-magic-mouse-down-action
2045 (let ((start (point)))
2046 (if (eq custom-magic-show
'long
)
2048 (insert (symbol-name state
)))
2049 (cond ((eq form
'lisp
)
2051 ((eq form
'mismatch
)
2052 (insert " (mismatch)")))
2053 (put-text-property start
(point) 'face
'custom-state
))
2055 (when (and (eq category
'group
)
2056 (not (and (eq custom-buffer-style
'links
)
2057 (> (widget-get parent
:custom-level
) 1))))
2058 (insert-char ?\
(* custom-buffer-indent
2059 (widget-get parent
:custom-level
))))
2060 (when custom-magic-show-button
2061 (when custom-magic-show
2062 (let ((indent (widget-get parent
:indent
)))
2064 (insert-char ? indent
))))
2065 (push (widget-create-child-and-convert
2067 :mouse-down-action
'widget-magic-mouse-down-action
2071 :help-echo
"Change the state."
2072 :format
(if hidden
"%t" "%[%t%]")
2073 :tag
(if (memq form
'(lisp mismatch
))
2074 (concat "(" magic
")")
2075 (concat "[" magic
"]")))
2078 (widget-put widget
:children children
))))
2080 (defun custom-magic-reset (widget)
2081 "Redraw the :custom-magic property of WIDGET."
2082 (let ((magic (widget-get widget
:custom-magic
)))
2084 (widget-value-set magic
(widget-value magic
)))))
2086 ;;; The `custom' Widget.
2088 (defface custom-button
2089 '((((type x w32 ns
) (class color
)) ; Like default modeline
2090 (:box
(:line-width
2 :style released-button
)
2091 :background
"lightgrey" :foreground
"black"))
2094 "Face for custom buffer buttons if `custom-raised-buttons' is non-nil."
2096 :group
'custom-faces
)
2097 (define-obsolete-face-alias 'custom-button-face
'custom-button
"22.1")
2099 (defface custom-button-mouse
2100 '((((type x w32 ns
) (class color
))
2101 (:box
(:line-width
2 :style released-button
)
2102 :background
"grey90" :foreground
"black"))
2104 ;; This is for text terminals that support mouse, like GPM mouse
2105 ;; or the MS-DOS terminal: inverse-video makes the button stand
2106 ;; out on mouse-over.
2107 (:inverse-video t
)))
2108 "Mouse face for custom buffer buttons if `custom-raised-buttons' is non-nil."
2110 :group
'custom-faces
)
2112 (defface custom-button-unraised
2113 '((t :inherit underline
))
2114 "Face for custom buffer buttons if `custom-raised-buttons' is nil."
2116 :group
'custom-faces
)
2119 (if custom-raised-buttons
'custom-button
'custom-button-unraised
))
2121 (setq custom-button-mouse
2122 (if custom-raised-buttons
'custom-button-mouse
'highlight
))
2124 (defface custom-button-pressed
2125 '((((type x w32 ns
) (class color
))
2126 (:box
(:line-width
2 :style pressed-button
)
2127 :background
"lightgrey" :foreground
"black"))
2129 (:inverse-video t
)))
2130 "Face for pressed custom buttons if `custom-raised-buttons' is non-nil."
2132 :group
'custom-faces
)
2133 (define-obsolete-face-alias 'custom-button-pressed-face
2134 'custom-button-pressed
"22.1")
2136 (defface custom-button-pressed-unraised
2137 '((default :inherit custom-button-unraised
)
2138 (((class color
) (background light
)) :foreground
"magenta4")
2139 (((class color
) (background dark
)) :foreground
"violet"))
2140 "Face for pressed custom buttons if `custom-raised-buttons' is nil."
2142 :group
'custom-faces
)
2144 (setq custom-button-pressed
2145 (if custom-raised-buttons
2146 'custom-button-pressed
2147 'custom-button-pressed-unraised
))
2149 (defface custom-documentation
'((t nil
))
2150 "Face used for documentation strings in customization buffers."
2151 :group
'custom-faces
)
2152 (define-obsolete-face-alias 'custom-documentation-face
2153 'custom-documentation
"22.1")
2155 (defface custom-state
'((((class color
)
2157 (:foreground
"lime green"))
2160 (:foreground
"dark green"))
2162 "Face used for State descriptions in the customize buffer."
2163 :group
'custom-faces
)
2164 (define-obsolete-face-alias 'custom-state-face
'custom-state
"22.1")
2166 (defface custom-link
2167 '((t :inherit link
))
2168 "Face for links in customization buffers."
2170 :group
'custom-faces
)
2172 (define-widget 'custom
'default
2173 "Customize a user option."
2175 :convert-widget
'custom-convert-widget
2176 :notify
'custom-notify
2179 :custom-state
'hidden
2180 :documentation-property
'widget-subclass-responsibility
2181 :value-create
'widget-subclass-responsibility
2182 :value-delete
'widget-children-value-delete
2183 :value-get
'widget-value-value-get
2184 :validate
'widget-children-validate
2185 :match
(lambda (widget value
) (symbolp value
)))
2187 (defun custom-convert-widget (widget)
2188 "Initialize :value and :tag from :args in WIDGET."
2189 (let ((args (widget-get widget
:args
)))
2191 (widget-put widget
:value
(widget-apply widget
2192 :value-to-internal
(car args
)))
2193 (widget-put widget
:tag
(custom-unlispify-tag-name (car args
)))
2194 (widget-put widget
:args nil
)))
2197 (defun custom-notify (widget &rest args
)
2198 "Keep track of changes."
2199 (let ((state (widget-get widget
:custom-state
)))
2200 (unless (eq state
'modified
)
2201 (unless (memq state
'(nil unknown hidden
))
2202 (widget-put widget
:custom-state
'modified
))
2203 (custom-magic-reset widget
)
2204 (apply 'widget-default-notify widget args
))))
2206 (defun custom-redraw (widget)
2207 "Redraw WIDGET with current settings."
2208 (let ((line (count-lines (point-min) (point)))
2209 (column (current-column))
2211 (from (marker-position (widget-get widget
:from
)))
2212 (to (marker-position (widget-get widget
:to
))))
2214 (widget-value-set widget
(widget-value widget
))
2215 (custom-redraw-magic widget
))
2216 (when (and (>= pos from
) (<= pos to
))
2219 (goto-char (point-min))
2220 (forward-line (if (> column
0)
2223 (move-to-column column
))
2226 (defun custom-redraw-magic (widget)
2227 "Redraw WIDGET state with current settings."
2229 (let ((magic (widget-get widget
:custom-magic
)))
2231 (widget-value-set magic
(widget-value magic
))
2232 (when (setq widget
(widget-get widget
:group
))
2233 (custom-group-state-update widget
)))
2235 (setq widget nil
)))))
2238 (defun custom-show (widget value
)
2239 "Non-nil if WIDGET should be shown with VALUE by default."
2240 (let ((show (widget-get widget
:custom-show
)))
2241 (if (functionp show
)
2242 (funcall show widget value
)
2245 (defun custom-load-widget (widget)
2246 "Load all dependencies for WIDGET."
2247 (custom-load-symbol (widget-value widget
)))
2249 (defun custom-unloaded-symbol-p (symbol)
2250 "Return non-nil if the dependencies of SYMBOL have not yet been loaded."
2252 (loads (get symbol
'custom-loads
))
2255 (setq load
(car loads
)
2257 (cond ((symbolp load
)
2258 (unless (featurep load
)
2260 ((assoc load load-history
))
2261 ((assoc (locate-library load
) load-history
)
2267 (defun custom-unloaded-widget-p (widget)
2268 "Return non-nil if the dependencies of WIDGET have not yet been loaded."
2269 (custom-unloaded-symbol-p (widget-value widget
)))
2271 (defun custom-toggle-hide (widget)
2272 "Toggle visibility of WIDGET."
2273 (custom-load-widget widget
)
2274 (let ((state (widget-get widget
:custom-state
)))
2275 (cond ((memq state
'(invalid modified set
))
2276 (error "There are unsaved changes"))
2278 (widget-put widget
:custom-state
'unknown
))
2280 (widget-put widget
:documentation-shown nil
)
2281 (widget-put widget
:custom-state
'hidden
)))
2282 (custom-redraw widget
)
2285 (defun custom-toggle-parent (widget &rest ignore
)
2286 "Toggle visibility of parent of WIDGET."
2287 (custom-toggle-hide (widget-get widget
:parent
)))
2289 (defun custom-add-see-also (widget &optional prefix
)
2290 "Add `See also ...' to WIDGET if there are any links.
2291 Insert PREFIX first if non-nil."
2292 (let* ((symbol (widget-get widget
:value
))
2293 (links (get symbol
'custom-links
))
2294 (many (> (length links
) 2))
2295 (buttons (widget-get widget
:buttons
))
2296 (indent (widget-get widget
:indent
)))
2299 (insert-char ?\ indent
))
2302 (insert "See also ")
2304 (push (widget-create-child-and-convert
2306 :button-face
'custom-link
2307 :mouse-face
'highlight
2308 :pressed-face
'highlight
)
2310 (setq links
(cdr links
))
2319 (widget-put widget
:buttons buttons
))))
2321 (defun custom-add-parent-links (widget &optional initial-string doc-initial-string
)
2322 "Add \"Parent groups: ...\" to WIDGET if the group has parents.
2323 The value is non-nil if any parents were found.
2324 If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
2325 (let ((name (widget-value widget
))
2326 (type (widget-type widget
))
2327 (buttons (widget-get widget
:buttons
))
2330 (insert (or initial-string
"Groups:"))
2331 (mapatoms (lambda (symbol)
2332 (when (member (list name type
) (get symbol
'custom-group
))
2334 (push (widget-create-child-and-convert
2335 widget
'custom-group-link
2336 :tag
(custom-unlispify-tag-name symbol
)
2339 (setq parents
(cons symbol parents
)))))
2342 (delete-region start
(point)))
2343 (widget-put widget
:buttons buttons
)
2346 ;;; The `custom-comment' Widget.
2348 ;; like the editable field
2349 (defface custom-comment
'((((type tty
))
2350 :background
"yellow3"
2351 :foreground
"black")
2352 (((class grayscale color
)
2354 :background
"gray85")
2355 (((class grayscale color
)
2357 :background
"dim gray")
2360 "Face used for comments on variables or faces."
2362 :group
'custom-faces
)
2363 (define-obsolete-face-alias 'custom-comment-face
'custom-comment
"22.1")
2365 ;; like font-lock-comment-face
2366 (defface custom-comment-tag
2367 '((((class color
) (background dark
)) (:foreground
"gray80"))
2368 (((class color
) (background light
)) (:foreground
"blue4"))
2369 (((class grayscale
) (background light
))
2370 (:foreground
"DimGray" :weight bold
:slant italic
))
2371 (((class grayscale
) (background dark
))
2372 (:foreground
"LightGray" :weight bold
:slant italic
))
2374 "Face used for the comment tag on variables or faces."
2375 :group
'custom-faces
)
2376 (define-obsolete-face-alias 'custom-comment-tag-face
'custom-comment-tag
"22.1")
2378 (define-widget 'custom-comment
'string
2381 :help-echo
"Edit a comment here."
2382 :sample-face
'custom-comment-tag
2383 :value-face
'custom-comment
2385 :create
'custom-comment-create
)
2387 (defun custom-comment-create (widget)
2388 (let* ((null-comment (equal "" (widget-value widget
))))
2389 (if (or (widget-get (widget-get widget
:parent
) :comment-shown
)
2391 (widget-default-create widget
)
2392 ;; `widget-default-delete' expects markers in these slots --
2393 ;; maybe it shouldn't.
2394 (widget-put widget
:from
(point-marker))
2395 (widget-put widget
:to
(point-marker)))))
2397 (defun custom-comment-hide (widget)
2398 (widget-put (widget-get widget
:parent
) :comment-shown nil
))
2400 ;; Those functions are for the menu. WIDGET is NOT the comment widget. It's
2401 ;; the global custom one
2402 (defun custom-comment-show (widget)
2403 (widget-put widget
:comment-shown t
)
2404 (custom-redraw widget
)
2407 (defun custom-comment-invisible-p (widget)
2408 (let ((val (widget-value (widget-get widget
:comment-widget
))))
2410 (not (widget-get widget
:comment-shown
)))))
2412 ;;; The `custom-variable' Widget.
2414 (defface custom-variable-tag
2417 (:foreground
"light blue" :weight bold
))
2418 (((min-colors 88) (class color
)
2420 (:foreground
"blue1" :weight bold
))
2423 (:foreground
"blue" :weight bold
))
2425 "Face used for unpushable variable tags."
2426 :group
'custom-faces
)
2427 (define-obsolete-face-alias 'custom-variable-tag-face
2428 'custom-variable-tag
"22.1")
2430 (defface custom-variable-button
'((t (:underline t
:weight bold
)))
2431 "Face used for pushable variable tags."
2432 :group
'custom-faces
)
2433 (define-obsolete-face-alias 'custom-variable-button-face
2434 'custom-variable-button
"22.1")
2436 (defcustom custom-variable-default-form
'edit
2437 "Default form of displaying variable values."
2438 :type
'(choice (const edit
)
2440 :group
'custom-buffer
2443 (defun custom-variable-documentation (variable)
2444 "Return documentation of VARIABLE for use in Custom buffer.
2445 Normally just return the docstring. But if VARIABLE automatically
2446 becomes buffer local when set, append a message to that effect."
2447 (if (and (local-variable-if-set-p variable
)
2448 (or (not (local-variable-p variable
))
2450 (local-variable-if-set-p variable
))))
2451 (concat (documentation-property variable
'variable-documentation
)
2453 This variable automatically becomes buffer-local when set outside Custom.
2454 However, setting it through Custom sets the default value.")
2455 (documentation-property variable
'variable-documentation
)))
2457 (define-widget 'custom-variable
'custom
2458 "A widget for displaying a Custom variable.
2459 The following properties have special meanings for this widget:
2461 :hidden-states should be a list of widget states for which the
2462 widget's initial contents are to be hidden.
2464 :custom-form should be a symbol describing how to display and
2465 edit the variable---either `edit' (using edit widgets),
2466 `lisp' (as a Lisp sexp), or `mismatch' (should not happen);
2467 if nil, use the return value of `custom-variable-default-form'.
2469 :shown-value, if non-nil, should be a list whose `car' is the
2470 variable value to display in place of the current value.
2472 :custom-style describes the widget interface style; nil is the
2473 default style, while `simple' means a simpler interface that
2474 inhibits the magic custom-state widget."
2476 :help-echo
"Set or reset this variable."
2477 :documentation-property
#'custom-variable-documentation
2478 :custom-category
'option
2480 :custom-menu
'custom-variable-menu-create
2482 :value-create
'custom-variable-value-create
2483 :action
'custom-variable-action
2484 :hidden-states
'(standard)
2485 :custom-set
'custom-variable-set
2486 :custom-mark-to-save
'custom-variable-mark-to-save
2487 :custom-reset-current
'custom-redraw
2488 :custom-reset-saved
'custom-variable-reset-saved
2489 :custom-reset-standard
'custom-variable-reset-standard
2490 :custom-mark-to-reset-standard
'custom-variable-mark-to-reset-standard
2491 :custom-standard-value
'custom-variable-standard-value
2492 :custom-state-set-and-redraw
'custom-variable-state-set-and-redraw
)
2494 (defun custom-variable-type (symbol)
2495 "Return a widget suitable for editing the value of SYMBOL.
2496 If SYMBOL has a `custom-type' property, use that.
2497 Otherwise, try matching SYMBOL against `custom-guess-name-alist' and
2498 try matching its doc string against `custom-guess-doc-alist'."
2499 (let* ((type (or (get symbol
'custom-type
)
2500 (and (not (get symbol
'standard-value
))
2501 (custom-guess-type symbol
))
2503 (options (get symbol
'custom-options
))
2504 (tmp (if (listp type
)
2505 (copy-sequence type
)
2508 (widget-put tmp
:options options
))
2511 (defun custom-variable-value-create (widget)
2512 "Here is where you edit the variable's value."
2513 (custom-load-widget widget
)
2514 (unless (widget-get widget
:custom-form
)
2515 (widget-put widget
:custom-form custom-variable-default-form
))
2516 (let* ((buttons (widget-get widget
:buttons
))
2517 (children (widget-get widget
:children
))
2518 (form (widget-get widget
:custom-form
))
2519 (symbol (widget-get widget
:value
))
2520 (tag (widget-get widget
:tag
))
2521 (type (custom-variable-type symbol
))
2522 (conv (widget-convert type
))
2523 (get (or (get symbol
'custom-get
) 'default-value
))
2524 (prefix (widget-get widget
:custom-prefix
))
2525 (last (widget-get widget
:custom-last
))
2526 (style (widget-get widget
:custom-style
))
2527 (value (let ((shown-value (widget-get widget
:shown-value
)))
2530 ((default-boundp symbol
)
2531 (funcall get symbol
))
2532 (t (widget-get conv
:value
)))))
2533 (state (or (widget-get widget
:custom-state
)
2534 (if (memq (custom-variable-state symbol value
)
2535 (widget-get widget
:hidden-states
))
2538 ;; If we don't know the state, see if we need to edit it in lisp form.
2540 (setq state
(if (custom-show type value
) 'unknown
'hidden
)))
2541 (when (eq state
'unknown
)
2542 (unless (widget-apply conv
:match value
)
2543 (setq form
'mismatch
)))
2544 ;; Now we can create the child widget.
2545 (cond ((eq custom-buffer-style
'tree
)
2546 (insert prefix
(if last
" `--- " " |--- "))
2547 (push (widget-create-child-and-convert
2548 widget
'custom-browse-variable-tag
)
2550 (insert " " tag
"\n")
2551 (widget-put widget
:buttons buttons
))
2553 ;; Indicate hidden value.
2554 (push (widget-create-child-and-convert
2555 widget
'custom-visibility
2556 :help-echo
"Show the value of this option."
2561 :action
'custom-toggle-hide-variable
2565 (push (widget-create-child-and-convert
2568 :sample-face
'custom-variable-tag
2572 ((memq form
'(lisp mismatch
))
2573 ;; In lisp mode edit the saved value when possible.
2574 (push (widget-create-child-and-convert
2575 widget
'custom-visibility
2576 :help-echo
"Hide the value of this option."
2581 :action
'custom-toggle-hide-variable
2585 (let* ((value (cond ((get symbol
'saved-value
)
2586 (car (get symbol
'saved-value
)))
2587 ((get symbol
'standard-value
)
2588 (car (get symbol
'standard-value
)))
2589 ((default-boundp symbol
)
2590 (custom-quote (funcall get symbol
)))
2592 (custom-quote (widget-get conv
:value
))))))
2593 (insert (symbol-name symbol
) ": ")
2594 (push (widget-create-child-and-convert
2596 :button-face
'custom-variable-button-face
2598 :tag
(symbol-name symbol
)
2604 (push (widget-create-child-and-convert
2605 widget
'custom-visibility
2606 :help-echo
"Hide or show this option."
2611 :action
'custom-toggle-hide-variable
2615 (let* ((format (widget-get type
:format
))
2616 tag-format value-format
)
2617 (unless (string-match ":" format
)
2618 (error "Bad format"))
2619 (setq tag-format
(substring format
0 (match-end 0)))
2620 (setq value-format
(substring format
(match-end 0)))
2621 (push (widget-create-child-and-convert
2624 :action
'custom-tag-action
2625 :help-echo
"Change value of this option."
2626 :mouse-down-action
'custom-tag-mouse-down-action
2627 :button-face
'custom-variable-button
2628 :sample-face
'custom-variable-tag
2631 (push (widget-create-child-and-convert
2633 :format value-format
2636 (unless (eq custom-buffer-style
'tree
)
2637 (unless (eq (preceding-char) ?
\n)
2638 (widget-insert "\n"))
2639 ;; Create the magic button.
2640 (unless (eq style
'simple
)
2641 (let ((magic (widget-create-child-and-convert
2642 widget
'custom-magic nil
)))
2643 (widget-put widget
:custom-magic magic
)
2644 (push magic buttons
)))
2645 (widget-put widget
:buttons buttons
)
2646 ;; Insert documentation.
2647 (widget-put widget
:documentation-indent
3)
2648 (unless (and (eq style
'simple
)
2650 (widget-add-documentation-string-button
2651 widget
:visibility-widget
'custom-visibility
))
2653 ;; The comment field
2654 (unless (eq state
'hidden
)
2655 (let* ((comment (get symbol
'variable-comment
))
2657 (widget-create-child-and-convert
2658 widget
'custom-comment
2660 :value
(or comment
""))))
2661 (widget-put widget
:comment-widget comment-widget
)
2662 ;; Don't push it !!! Custom assumes that the first child is the
2664 (setq children
(append children
(list comment-widget
)))))
2665 ;; Update the rest of the properties.
2666 (widget-put widget
:custom-form form
)
2667 (widget-put widget
:children children
)
2668 ;; Now update the state.
2669 (if (eq state
'hidden
)
2670 (widget-put widget
:custom-state state
)
2671 (custom-variable-state-set widget
))
2673 (unless (eq state
'hidden
)
2674 (when (eq (widget-get widget
:custom-level
) 1)
2675 (custom-add-parent-links widget
))
2676 (custom-add-see-also widget
)))))
2678 (defun custom-toggle-hide-variable (visibility-widget &rest ignore
)
2679 "Toggle the visibility of a `custom-variable' parent widget.
2680 By default, this signals an error if the parent has unsaved
2681 changes. If the parent has a `simple' :custom-style property,
2682 the present value is saved to its :shown-value property instead."
2683 (let ((widget (widget-get visibility-widget
:parent
)))
2684 (unless (eq (widget-type widget
) 'custom-variable
)
2685 (error "Invalid widget type"))
2686 (custom-load-widget widget
)
2687 (let ((state (widget-get widget
:custom-state
)))
2688 (if (eq state
'hidden
)
2689 (widget-put widget
:custom-state
'unknown
)
2690 ;; In normal interface, widget can't be hidden if modified.
2691 (when (memq state
'(invalid modified set
))
2692 (if (eq (widget-get widget
:custom-style
) 'simple
)
2693 (widget-put widget
:shown-value
2696 (widget-get widget
:children
)))))
2697 (error "There are unsaved changes")))
2698 (widget-put widget
:documentation-shown nil
)
2699 (widget-put widget
:custom-state
'hidden
))
2700 (custom-redraw widget
)
2703 (defun custom-tag-action (widget &rest args
)
2704 "Pass :action to first child of WIDGET's parent."
2705 (apply 'widget-apply
(car (widget-get (widget-get widget
:parent
) :children
))
2708 (defun custom-tag-mouse-down-action (widget &rest args
)
2709 "Pass :mouse-down-action to first child of WIDGET's parent."
2710 (apply 'widget-apply
(car (widget-get (widget-get widget
:parent
) :children
))
2711 :mouse-down-action args
))
2713 (defun custom-variable-state (symbol val
)
2714 "Return the state of SYMBOL if its value is VAL.
2715 If SYMBOL has a non-nil `custom-get' property, it overrides VAL.
2716 Possible return values are `standard', `saved', `set', `themed',
2717 `changed', and `rogue'."
2718 (let* ((get (or (get symbol
'custom-get
) 'default-value
))
2719 (value (if (default-boundp symbol
)
2720 (funcall get symbol
)
2722 (comment (get symbol
'variable-comment
))
2725 (cond ((progn (setq tmp
(get symbol
'customized-value
))
2727 (get symbol
'customized-variable-comment
))
2729 (if (condition-case nil
2730 (and (equal value
(eval (car tmp
)))
2731 (equal comment temp
))
2735 ((progn (setq tmp
(get symbol
'theme-value
))
2736 (setq temp
(get symbol
'saved-variable-comment
))
2738 (if (condition-case nil
2739 (and (equal comment temp
)
2742 (car (custom-variable-theme-value
2746 ((eq (caar tmp
) 'user
) 'saved
)
2747 ((eq (caar tmp
) 'changed
)
2748 (if (condition-case nil
2752 (car (get symbol
'standard-value
)))))
2754 ;; The value was originally set outside
2755 ;; custom, but it was set to the standard
2756 ;; value (probably an autoloaded defcustom).
2761 ((setq tmp
(get symbol
'standard-value
))
2762 (if (condition-case nil
2763 (and (equal value
(eval (car tmp
)))
2764 (equal comment nil
))
2770 (defun custom-variable-state-set (widget &optional state
)
2771 "Set the state of WIDGET to STATE.
2772 If STATE is nil, the value is computed by `custom-variable-state'."
2773 (widget-put widget
:custom-state
2774 (or state
(custom-variable-state (widget-value widget
)
2775 (widget-get widget
:value
)))))
2777 (defun custom-variable-standard-value (widget)
2778 (get (widget-value widget
) 'standard-value
))
2780 (defvar custom-variable-menu
2781 `(("Set for Current Session" custom-variable-set
2783 (eq (widget-get widget
:custom-state
) 'modified
)))
2784 ;; Note that in all the backquoted code in this file, we test
2785 ;; init-file-user rather than user-init-file. This is in case
2786 ;; cus-edit is loaded by something in site-start.el, because
2787 ;; user-init-file is not set at that stage.
2788 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00310.html
2789 ,@(when (or custom-file init-file-user
)
2790 '(("Save for Future Sessions" custom-variable-save
2792 (memq (widget-get widget
:custom-state
)
2793 '(modified set changed rogue
))))))
2794 ("Undo Edits" custom-redraw
2796 (and (default-boundp (widget-value widget
))
2797 (memq (widget-get widget
:custom-state
) '(modified changed
)))))
2798 ("Reset to Saved" custom-variable-reset-saved
2800 (and (or (get (widget-value widget
) 'saved-value
)
2801 (get (widget-value widget
) 'saved-variable-comment
))
2802 (memq (widget-get widget
:custom-state
)
2803 '(modified set changed rogue
)))))
2804 ,@(when (or custom-file init-file-user
)
2805 '(("Erase Customization" custom-variable-reset-standard
2807 (and (get (widget-value widget
) 'standard-value
)
2808 (memq (widget-get widget
:custom-state
)
2809 '(modified set changed saved rogue
)))))))
2810 ("Set to Backup Value" custom-variable-reset-backup
2812 (get (widget-value widget
) 'backup-value
)))
2813 ("---" ignore ignore
)
2814 ("Add Comment" custom-comment-show custom-comment-invisible-p
)
2815 ("---" ignore ignore
)
2816 ("Show Current Value" custom-variable-edit
2818 (eq (widget-get widget
:custom-form
) 'lisp
)))
2819 ("Show Saved Lisp Expression" custom-variable-edit-lisp
2821 (eq (widget-get widget
:custom-form
) 'edit
))))
2822 "Alist of actions for the `custom-variable' widget.
2823 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2824 the menu entry, ACTION is the function to call on the widget when the
2825 menu is selected, and FILTER is a predicate which takes a `custom-variable'
2826 widget as an argument, and returns non-nil if ACTION is valid on that
2827 widget. If FILTER is nil, ACTION is always valid.")
2829 (defun custom-variable-action (widget &optional event
)
2830 "Show the menu for `custom-variable' WIDGET.
2831 Optional EVENT is the location for the menu."
2832 (if (eq (widget-get widget
:custom-state
) 'hidden
)
2833 (custom-toggle-hide widget
)
2834 (unless (eq (widget-get widget
:custom-state
) 'modified
)
2835 (custom-variable-state-set widget
))
2836 (custom-redraw-magic widget
)
2837 (let* ((completion-ignore-case t
)
2838 (answer (widget-choose (concat "Operation on "
2839 (custom-unlispify-tag-name
2840 (widget-get widget
:value
)))
2841 (custom-menu-filter custom-variable-menu
2845 (funcall answer widget
)))))
2847 (defun custom-variable-edit (widget)
2848 "Edit value of WIDGET."
2849 (widget-put widget
:custom-state
'unknown
)
2850 (widget-put widget
:custom-form
'edit
)
2851 (custom-redraw widget
))
2853 (defun custom-variable-edit-lisp (widget)
2854 "Edit the Lisp representation of the value of WIDGET."
2855 (widget-put widget
:custom-state
'unknown
)
2856 (widget-put widget
:custom-form
'lisp
)
2857 (custom-redraw widget
))
2859 (defun custom-variable-set (widget)
2860 "Set the current value for the variable being edited by WIDGET."
2861 (let* ((form (widget-get widget
:custom-form
))
2862 (state (widget-get widget
:custom-state
))
2863 (child (car (widget-get widget
:children
)))
2864 (symbol (widget-value widget
))
2865 (set (or (get symbol
'custom-set
) 'set-default
))
2866 (comment-widget (widget-get widget
:comment-widget
))
2867 (comment (widget-value comment-widget
))
2869 (cond ((eq state
'hidden
)
2870 (error "Cannot set hidden variable"))
2871 ((setq val
(widget-apply child
:validate
))
2872 (goto-char (widget-get val
:from
))
2873 (error "%s" (widget-get val
:error
)))
2874 ((memq form
'(lisp mismatch
))
2875 (when (equal comment
"")
2877 ;; Make the comment invisible by hand if it's empty
2878 (custom-comment-hide comment-widget
))
2879 (custom-variable-backup-value widget
)
2880 (custom-push-theme 'theme-value symbol
'user
2881 'set
(custom-quote (widget-value child
)))
2882 (funcall set symbol
(eval (setq val
(widget-value child
))))
2883 (put symbol
'customized-value
(list val
))
2884 (put symbol
'variable-comment comment
)
2885 (put symbol
'customized-variable-comment comment
))
2887 (when (equal comment
"")
2889 ;; Make the comment invisible by hand if it's empty
2890 (custom-comment-hide comment-widget
))
2891 (custom-variable-backup-value widget
)
2892 (custom-push-theme 'theme-value symbol
'user
2893 'set
(custom-quote (widget-value child
)))
2894 (funcall set symbol
(setq val
(widget-value child
)))
2895 (put symbol
'customized-value
(list (custom-quote val
)))
2896 (put symbol
'variable-comment comment
)
2897 (put symbol
'customized-variable-comment comment
)))
2898 (custom-variable-state-set widget
)
2899 (custom-redraw-magic widget
)))
2901 (defun custom-variable-mark-to-save (widget)
2902 "Set value and mark for saving the variable edited by WIDGET."
2903 (let* ((form (widget-get widget
:custom-form
))
2904 (state (widget-get widget
:custom-state
))
2905 (child (car (widget-get widget
:children
)))
2906 (symbol (widget-value widget
))
2907 (set (or (get symbol
'custom-set
) 'set-default
))
2908 (comment-widget (widget-get widget
:comment-widget
))
2909 (comment (widget-value comment-widget
))
2911 (cond ((eq state
'hidden
)
2912 (error "Cannot set hidden variable"))
2913 ((setq val
(widget-apply child
:validate
))
2914 (goto-char (widget-get val
:from
))
2915 (error "Saving %s: %s" symbol
(widget-get val
:error
)))
2916 ((memq form
'(lisp mismatch
))
2917 (when (equal comment
"")
2919 ;; Make the comment invisible by hand if it's empty
2920 (custom-comment-hide comment-widget
))
2921 (put symbol
'saved-value
(list (widget-value child
)))
2922 (custom-push-theme 'theme-value symbol
'user
2923 'set
(custom-quote (widget-value child
)))
2924 (funcall set symbol
(eval (widget-value child
)))
2925 (put symbol
'variable-comment comment
)
2926 (put symbol
'saved-variable-comment comment
))
2928 (when (equal comment
"")
2930 ;; Make the comment invisible by hand if it's empty
2931 (custom-comment-hide comment-widget
))
2932 (put symbol
'saved-value
2933 (list (custom-quote (widget-value child
))))
2934 (custom-push-theme 'theme-value symbol
'user
2935 'set
(custom-quote (widget-value child
)))
2936 (funcall set symbol
(widget-value child
))
2937 (put symbol
'variable-comment comment
)
2938 (put symbol
'saved-variable-comment comment
)))
2939 (put symbol
'customized-value nil
)
2940 (put symbol
'customized-variable-comment nil
)))
2942 (defsubst custom-variable-state-set-and-redraw
(widget)
2943 "Set state of variable widget WIDGET and redraw with current settings."
2944 (custom-variable-state-set widget
)
2945 (custom-redraw-magic widget
))
2947 (defun custom-variable-save (widget)
2948 "Save value of variable edited by widget WIDGET."
2949 (custom-variable-mark-to-save widget
)
2951 (custom-variable-state-set-and-redraw widget
))
2953 (defun custom-variable-reset-saved (widget)
2954 "Restore the saved value for the variable being edited by WIDGET.
2955 This also updates the buffer to show that value.
2956 The value that was current before this operation
2957 becomes the backup value, so you can get it again."
2958 (let* ((symbol (widget-value widget
))
2959 (set (or (get symbol
'custom-set
) 'set-default
))
2960 (value (get symbol
'saved-value
))
2961 (comment (get symbol
'saved-variable-comment
)))
2962 (cond ((or value comment
)
2963 (put symbol
'variable-comment comment
)
2964 (custom-variable-backup-value widget
)
2965 (custom-push-theme 'theme-value symbol
'user
'set
(car-safe value
))
2967 (funcall set symbol
(eval (car value
)))
2970 (error "No saved value for %s" symbol
)))
2971 (put symbol
'customized-value nil
)
2972 (put symbol
'customized-variable-comment nil
)
2973 (widget-put widget
:custom-state
'unknown
)
2974 ;; This call will possibly make the comment invisible
2975 (custom-redraw widget
)))
2977 (defun custom-variable-mark-to-reset-standard (widget)
2978 "Mark to restore standard setting for the variable edited by widget WIDGET.
2979 If `custom-reset-standard-variables-list' is nil, save, reset and
2980 redraw the widget immediately."
2981 (let* ((symbol (widget-value widget
)))
2982 (if (get symbol
'standard-value
)
2983 (custom-variable-backup-value widget
)
2984 (error "No standard setting known for %S" symbol
))
2985 (put symbol
'variable-comment nil
)
2986 (put symbol
'customized-value nil
)
2987 (put symbol
'customized-variable-comment nil
)
2988 (custom-push-theme 'theme-value symbol
'user
'reset
)
2989 (custom-theme-recalc-variable symbol
)
2990 (if (and custom-reset-standard-variables-list
2991 (or (get symbol
'saved-value
) (get symbol
'saved-variable-comment
)))
2993 (put symbol
'saved-value nil
)
2994 (put symbol
'saved-variable-comment nil
)
2995 ;; Append this to `custom-reset-standard-variables-list' to
2996 ;; have `custom-reset-standard-save-and-update' save setting
2997 ;; to the file, update the widget's state, and redraw it.
2998 (setq custom-reset-standard-variables-list
2999 (cons widget custom-reset-standard-variables-list
)))
3000 (when (or (get symbol
'saved-value
) (get symbol
'saved-variable-comment
))
3001 (put symbol
'saved-value nil
)
3002 (put symbol
'saved-variable-comment nil
)
3004 (widget-put widget
:custom-state
'unknown
)
3005 ;; This call will possibly make the comment invisible
3006 (custom-redraw widget
))))
3008 (defun custom-variable-reset-standard (widget)
3009 "Restore standard setting for the variable edited by WIDGET.
3010 This operation eliminates any saved setting for the variable,
3011 restoring it to the state of a variable that has never been customized.
3012 The value that was current before this operation
3013 becomes the backup value, so you can get it again."
3014 (let (custom-reset-standard-variables-list)
3015 (custom-variable-mark-to-reset-standard widget
)))
3017 (defun custom-variable-backup-value (widget)
3018 "Back up the current value for WIDGET's variable.
3019 The backup value is kept in the car of the `backup-value' property."
3020 (let* ((symbol (widget-value widget
))
3021 (get (or (get symbol
'custom-get
) 'default-value
))
3022 (type (custom-variable-type symbol
))
3023 (conv (widget-convert type
))
3024 (value (if (default-boundp symbol
)
3025 (funcall get symbol
)
3026 (widget-get conv
:value
))))
3027 (put symbol
'backup-value
(list value
))))
3029 (defun custom-variable-reset-backup (widget)
3030 "Restore the backup value for the variable being edited by WIDGET.
3031 The value that was current before this operation
3032 becomes the backup value, so you can use this operation repeatedly
3033 to switch between two values."
3034 (let* ((symbol (widget-value widget
))
3035 (set (or (get symbol
'custom-set
) 'set-default
))
3036 (value (get symbol
'backup-value
))
3037 (comment-widget (widget-get widget
:comment-widget
))
3038 (comment (widget-value comment-widget
)))
3041 (custom-variable-backup-value widget
)
3042 (custom-push-theme 'theme-value symbol
'user
'set value
)
3044 (funcall set symbol
(car value
))
3046 (error "No backup value for %s" symbol
))
3047 (put symbol
'customized-value
(list (car value
)))
3048 (put symbol
'variable-comment comment
)
3049 (put symbol
'customized-variable-comment comment
)
3050 (custom-variable-state-set widget
)
3051 ;; This call will possibly make the comment invisible
3052 (custom-redraw widget
)))
3054 ;;; The `custom-visibility' Widget
3056 (define-widget 'custom-visibility
'visibility
3057 "Show or hide a documentation string."
3058 :button-face
'custom-visibility
3059 :pressed-face
'custom-visibility
3060 :mouse-face
'highlight
3061 :pressed-face
'highlight
3065 (defface custom-visibility
3066 '((t :height
0.8 :inherit link
))
3067 "Face for the `custom-visibility' widget."
3069 :group
'custom-faces
)
3071 ;;; The `custom-face-edit' Widget.
3073 (define-widget 'custom-face-edit
'checklist
3074 "Widget for editing face attributes.
3075 The following properties have special meanings for this widget:
3077 :value is a plist of face attributes.
3079 :default-face-attributes, if non-nil, is a plist of defaults for
3080 face attributes (as specified by a `default' defface entry)."
3083 :button-args
'(:help-echo
"Control whether this attribute has any effect.")
3084 :value-to-internal
'custom-face-edit-fix-value
3085 :match
(lambda (widget value
)
3086 (widget-checklist-match widget
3087 (custom-face-edit-fix-value widget value
)))
3088 :value-create
'custom-face-edit-value-create
3089 :convert-widget
'custom-face-edit-convert-widget
3090 :args
(mapcar (lambda (att)
3091 (list 'group
:inline t
3092 :sibling-args
(widget-get (nth 1 att
) :sibling-args
)
3093 (list 'const
:format
"" :value
(nth 0 att
))
3095 custom-face-attributes
))
3097 (defun custom-face-edit-value-create (widget)
3098 (let* ((alist (widget-checklist-match-find
3099 widget
(widget-get widget
:value
)))
3100 (args (widget-get widget
:args
))
3101 (show-all (widget-get widget
:show-all-attributes
))
3102 (buttons (widget-get widget
:buttons
))
3103 (defaults (widget-checklist-match-find
3105 (widget-get widget
:default-face-attributes
)))
3107 (unless (looking-back "^ *")
3109 (insert-char ?\s
(widget-get widget
:extra-offset
))
3110 (if (or alist defaults show-all
)
3112 (setq entry
(or (assq prop alist
)
3113 (assq prop defaults
)))
3114 (if (or entry show-all
)
3115 (widget-checklist-add-item widget prop entry
)))
3116 (insert (propertize "-- Empty face --" 'face
'shadow
) ?
\n))
3117 (let ((indent (widget-get widget
:indent
)))
3118 (if indent
(insert-char ?\s
(widget-get widget
:indent
))))
3119 (push (widget-create-child-and-convert
3121 :help-echo
"Show or hide all face attributes."
3122 :button-face
'custom-visibility
3123 :pressed-face
'custom-visibility
3124 :mouse-face
'highlight
3125 :on
"Hide Unused Attributes" :off
"Show All Attributes"
3126 :on-glyph nil
:off-glyph nil
3128 :action
'custom-face-edit-value-visibility-action
3132 (widget-put widget
:buttons buttons
)
3133 (widget-put widget
:children
(nreverse (widget-get widget
:children
)))))
3135 (defun custom-face-edit-value-visibility-action (widget &rest ignore
)
3136 ;; Toggle hiding of face attributes.
3137 (let ((parent (widget-get widget
:parent
)))
3138 (widget-put parent
:show-all-attributes
3139 (not (widget-get parent
:show-all-attributes
)))
3140 (custom-redraw parent
)))
3142 (defun custom-face-edit-fix-value (widget value
)
3143 "Ignoring WIDGET, convert :bold and :italic in VALUE to new form.
3144 Also change :reverse-video to :inverse-video."
3145 (custom-fix-face-spec value
))
3147 (defun custom-face-edit-convert-widget (widget)
3148 "Convert :args as widget types in WIDGET."
3151 :args
(mapcar (lambda (arg)
3153 :deactivate
'custom-face-edit-deactivate
3154 :activate
'custom-face-edit-activate
3155 :delete
'custom-face-edit-delete
))
3156 (widget-get widget
:args
)))
3159 (defconst custom-face-edit
(widget-convert 'custom-face-edit
)
3160 "Converted version of the `custom-face-edit' widget.")
3162 (defun custom-face-edit-deactivate (widget)
3163 "Make face widget WIDGET inactive for user modifications."
3164 (unless (widget-get widget
:inactive
)
3165 (let ((tag (custom-face-edit-attribute-tag widget
))
3166 (from (copy-marker (widget-get widget
:from
)))
3167 (value (widget-value widget
))
3168 (inhibit-read-only t
)
3169 (inhibit-modification-hooks t
))
3172 (widget-default-delete widget
)
3173 (insert tag
": " (propertize "--" 'face
'shadow
) "\n")
3174 (widget-put widget
:inactive
3175 (cons value
(cons from
(- (point) from
))))))))
3177 (defun custom-face-edit-activate (widget)
3178 "Make face widget WIDGET active for user modifications."
3179 (let ((inactive (widget-get widget
:inactive
))
3180 (inhibit-read-only t
)
3181 (inhibit-modification-hooks t
))
3182 (when (consp inactive
)
3184 (goto-char (car (cdr inactive
)))
3185 (delete-region (point) (+ (point) (cdr (cdr inactive
))))
3186 (widget-put widget
:inactive nil
)
3187 (widget-apply widget
:create
)
3188 (widget-value-set widget
(car inactive
))
3191 (defun custom-face-edit-delete (widget)
3192 "Remove WIDGET from the buffer."
3193 (let ((inactive (widget-get widget
:inactive
))
3194 (inhibit-read-only t
)
3195 (inhibit-modification-hooks t
))
3197 ;; Widget is alive, we don't have to do anything special
3198 (widget-default-delete widget
)
3199 ;; WIDGET is already deleted because we did so to inactivate it;
3200 ;; now just get rid of the label we put in its place.
3201 (delete-region (car (cdr inactive
))
3202 (+ (car (cdr inactive
)) (cdr (cdr inactive
))))
3203 (widget-put widget
:inactive nil
))))
3206 (defun custom-face-edit-attribute-tag (widget)
3207 "Return the first :tag property in WIDGET or one of its children."
3208 (let ((tag (widget-get widget
:tag
)))
3209 (or (and (not (equal tag
"")) tag
)
3210 (let ((children (widget-get widget
:children
)))
3211 (while (and (null tag
) children
)
3212 (setq tag
(custom-face-edit-attribute-tag (pop children
))))
3215 ;;; The `custom-display' Widget.
3217 (define-widget 'custom-display
'menu-choice
3218 "Select a display type."
3221 :help-echo
"Specify frames where the face attributes should be used."
3222 :args
'((const :tag
"all" t
)
3223 (const :tag
"defaults" default
)
3227 :args
((group :sibling-args
(:help-echo
"\
3228 Only match the specified window systems.")
3229 (const :format
"Type: "
3231 (checklist :inline t
3234 :sibling-args
(:help-echo
"\
3235 The X11 Window System.")
3237 (const :format
"PM "
3238 :sibling-args
(:help-echo
"\
3239 OS/2 Presentation Manager.")
3241 (const :format
"W32 "
3242 :sibling-args
(:help-echo
"\
3245 (const :format
"NS "
3246 :sibling-args
(:help-echo
"\
3247 GNUstep or Macintosh OS Cocoa interface.")
3249 (const :format
"DOS "
3250 :sibling-args
(:help-echo
"\
3253 (const :format
"TTY%n"
3254 :sibling-args
(:help-echo
"\
3255 Plain text terminals.")
3257 (group :sibling-args
(:help-echo
"\
3258 Only match the frames with the specified color support.")
3259 (const :format
"Class: "
3261 (checklist :inline t
3263 (const :format
"Color "
3264 :sibling-args
(:help-echo
"\
3265 Match color frames.")
3267 (const :format
"Grayscale "
3268 :sibling-args
(:help-echo
"\
3269 Match grayscale frames.")
3271 (const :format
"Monochrome%n"
3272 :sibling-args
(:help-echo
"\
3273 Match frames with no color support.")
3275 (group :sibling-args
(:help-echo
"\
3276 The minimum number of colors the frame should support.")
3277 (const :format
"" min-colors
)
3278 (integer :tag
"Minimum number of colors" ))
3279 (group :sibling-args
(:help-echo
"\
3280 Only match frames with the specified intensity.")
3282 Background brightness: "
3284 (checklist :inline t
3286 (const :format
"Light "
3287 :sibling-args
(:help-echo
"\
3288 Match frames with light backgrounds.")
3290 (const :format
"Dark\n"
3291 :sibling-args
(:help-echo
"\
3292 Match frames with dark backgrounds.")
3294 (group :sibling-args
(:help-echo
"\
3295 Only match frames that support the specified face attributes.")
3296 (const :format
"Supports attributes:" supports
)
3297 (custom-face-edit :inline t
:format
"%n%v"))))))
3299 ;;; The `custom-face' Widget.
3301 (defface custom-face-tag
3302 `((t :inherit custom-variable-tag
))
3303 "Face used for face tags."
3304 :group
'custom-faces
)
3305 (define-obsolete-face-alias 'custom-face-tag-face
'custom-face-tag
"22.1")
3307 (defcustom custom-face-default-form
'selected
3308 "Default form of displaying face definition."
3309 :type
'(choice (const all
)
3312 :group
'custom-buffer
3315 (define-widget 'custom-face
'custom
3316 "Widget for customizing a face.
3317 The following properties have special meanings for this widget:
3319 :value is the face name (a symbol).
3321 :custom-form should be a symbol describing how to display and
3322 edit the face attributes---either `selected' (attributes for
3323 selected display only), `all' (all attributes), `lisp' (as a
3324 Lisp sexp), or `mismatch' (should not happen); if nil, use
3325 the return value of `custom-face-default-form'.
3327 :custom-style describes the widget interface style; nil is the
3328 default style, while `simple' means a simpler interface that
3329 inhibits the magic custom-state widget.
3331 :sample-indent, if non-nil, is the number of columns to which to
3332 indent the face sample (an integer).
3334 :shown-value, if non-nil, is the face spec to display as the value
3335 of the widget, instead of the current face spec."
3336 :sample-face
'custom-face-tag
3337 :help-echo
"Set or reset this face."
3338 :documentation-property
#'face-doc-string
3339 :value-create
'custom-face-value-create
3340 :action
'custom-face-action
3341 :custom-category
'face
3343 :custom-set
'custom-face-set
3344 :custom-mark-to-save
'custom-face-mark-to-save
3345 :custom-reset-current
'custom-redraw
3346 :custom-reset-saved
'custom-face-reset-saved
3347 :custom-reset-standard
'custom-face-reset-standard
3348 :custom-mark-to-reset-standard
'custom-face-mark-to-reset-standard
3349 :custom-standard-value
'custom-face-standard-value
3350 :custom-state-set-and-redraw
'custom-face-state-set-and-redraw
3351 :custom-menu
'custom-face-menu-create
)
3353 (define-widget 'custom-face-all
'editable-list
3354 "An editable list of display specifications and attributes."
3355 :entry-format
"%i %d %v"
3356 :insert-button-args
'(:help-echo
"Insert new display specification here.")
3357 :append-button-args
'(:help-echo
"Append new display specification here.")
3358 :delete-button-args
'(:help-echo
"Delete this display specification.")
3359 :args
'((group :format
"%v" custom-display custom-face-edit
)))
3361 (defconst custom-face-all
(widget-convert 'custom-face-all
)
3362 "Converted version of the `custom-face-all' widget.")
3364 (defun custom-filter-face-spec (spec filter-index
&optional default-filter
)
3365 "Return a canonicalized version of SPEC using.
3366 FILTER-INDEX is the index in the entry for each attribute in
3367 `custom-face-attributes' at which the appropriate filter function can be
3368 found, and DEFAULT-FILTER is the filter to apply for attributes that
3370 (mapcar (lambda (entry)
3371 ;; Filter a single face-spec entry
3372 (let ((tests (car entry
))
3374 ;; Handle both old- and new-style attribute syntax
3375 (if (listp (car (cdr entry
)))
3378 (filtered-attrs nil
))
3379 ;; Filter each face attribute
3380 (while unfiltered-attrs
3381 (let* ((attr (pop unfiltered-attrs
))
3382 (pre-filtered-value (pop unfiltered-attrs
))
3384 (or (nth filter-index
(assq attr custom-face-attributes
))
3388 (funcall filter pre-filtered-value
)
3389 pre-filtered-value
)))
3390 (push filtered-value filtered-attrs
)
3391 (push attr filtered-attrs
)))
3393 (list tests filtered-attrs
)))
3396 (defun custom-pre-filter-face-spec (spec)
3397 "Return SPEC changed as necessary for editing by the face customization widget.
3398 SPEC must be a full face spec."
3399 (custom-filter-face-spec spec
2))
3401 (defun custom-post-filter-face-spec (spec)
3402 "Return the customized SPEC in a form suitable for setting the face."
3403 (custom-filter-face-spec spec
3))
3405 (defun custom-face-widget-to-spec (widget)
3406 "Return a face spec corresponding to WIDGET.
3407 WIDGET should be a `custom-face' widget."
3408 (unless (eq (widget-type widget
) 'custom-face
)
3409 (error "Invalid widget"))
3410 (let ((child (car (widget-get widget
:children
))))
3411 (custom-post-filter-face-spec
3412 (if (eq (widget-type child
) 'custom-face-edit
)
3413 `((t ,(widget-value child
)))
3414 (widget-value child
)))))
3416 (defun custom-face-get-current-spec (face)
3417 (let ((spec (or (get face
'customized-face
)
3418 (get face
'saved-face
)
3419 (get face
'face-defface-spec
)
3420 ;; Attempt to construct it.
3421 `((t ,(custom-face-attributes-get
3422 face
(selected-frame)))))))
3423 ;; If the user has changed this face in some other way,
3424 ;; edit it as the user has specified it.
3425 (if (not (face-spec-match-p face spec
(selected-frame)))
3426 (setq spec
`((t ,(face-attr-construct face
(selected-frame))))))
3427 (custom-pre-filter-face-spec spec
)))
3429 (defun custom-toggle-hide-face (visibility-widget &rest ignore
)
3430 "Toggle the visibility of a `custom-face' parent widget.
3431 By default, this signals an error if the parent has unsaved
3432 changes. If the parent has a `simple' :custom-style property,
3433 the present value is saved to its :shown-value property instead."
3434 (let ((widget (widget-get visibility-widget
:parent
)))
3435 (unless (eq (widget-type widget
) 'custom-face
)
3436 (error "Invalid widget type"))
3437 (custom-load-widget widget
)
3438 (let ((state (widget-get widget
:custom-state
)))
3439 (if (eq state
'hidden
)
3440 (widget-put widget
:custom-state
'unknown
)
3441 ;; In normal interface, widget can't be hidden if modified.
3442 (when (memq state
'(invalid modified set
))
3443 (if (eq (widget-get widget
:custom-style
) 'simple
)
3444 (widget-put widget
:shown-value
3445 (custom-face-widget-to-spec widget
))
3446 (error "There are unsaved changes")))
3447 (widget-put widget
:documentation-shown nil
)
3448 (widget-put widget
:custom-state
'hidden
))
3449 (custom-redraw widget
)
3452 (defun custom-face-value-create (widget)
3453 "Create a list of the display specifications for WIDGET."
3454 (let* ((buttons (widget-get widget
:buttons
))
3455 (symbol (widget-get widget
:value
))
3456 (tag (or (widget-get widget
:tag
)
3457 (prin1-to-string symbol
)))
3458 (hiddenp (eq (widget-get widget
:custom-state
) 'hidden
))
3459 (style (widget-get widget
:custom-style
))
3462 (if (eq custom-buffer-style
'tree
)
3464 ;; Draw a tree-style `custom-face' widget
3466 (insert (widget-get widget
:custom-prefix
)
3467 (if (widget-get widget
:custom-last
) " `--- " " |--- "))
3468 (push (widget-create-child-and-convert
3469 widget
'custom-browse-face-tag
)
3471 (insert " " tag
"\n")
3472 (widget-put widget
:buttons buttons
))
3474 ;; Draw an ordinary `custom-face' widget
3475 (let ((opoint (point)))
3476 ;; Visibility indicator.
3477 (push (widget-create-child-and-convert
3478 widget
'custom-visibility
3479 :help-echo
"Hide or show this face."
3480 :on
"Hide" :off
"Show"
3481 :on-glyph
"down" :off-glyph
"right"
3482 :action
'custom-toggle-hide-face
3487 (widget-specify-sample widget opoint
(point)))
3489 (cond ((eq custom-buffer-style
'face
) " ")
3490 ((string-match "face\\'" tag
) ":")
3494 (let ((sample-indent (widget-get widget
:sample-indent
))
3495 (indent-tabs-mode nil
))
3497 (<= (current-column) sample-indent
)
3498 (indent-to-column sample-indent
)))
3499 (push (widget-create-child-and-convert
3502 :sample-face
(let ((spec (widget-get widget
:shown-value
)))
3503 (if spec
(face-spec-choose spec
) symbol
))
3509 (unless (eq (widget-get widget
:custom-style
) 'simple
)
3510 (let ((magic (widget-create-child-and-convert
3511 widget
'custom-magic nil
)))
3512 (widget-put widget
:custom-magic magic
)
3513 (push magic buttons
)))
3516 (widget-put widget
:buttons buttons
)
3518 ;; Insert documentation.
3519 (unless (and hiddenp
(eq style
'simple
))
3520 (widget-put widget
:documentation-indent
3)
3521 (widget-add-documentation-string-button
3522 widget
:visibility-widget
'custom-visibility
)
3523 ;; The comment field
3525 (let* ((comment (get symbol
'face-comment
))
3527 (widget-create-child-and-convert
3528 widget
'custom-comment
3530 :value
(or comment
""))))
3531 (widget-put widget
:comment-widget comment-widget
)
3532 (push comment-widget children
))))
3535 (unless (eq (preceding-char) ?
\n)
3538 (custom-load-widget widget
)
3539 (unless (widget-get widget
:custom-form
)
3540 (widget-put widget
:custom-form custom-face-default-form
))
3542 (let* ((spec (or (widget-get widget
:shown-value
)
3543 (custom-face-get-current-spec symbol
)))
3544 (form (widget-get widget
:custom-form
))
3545 (indent (widget-get widget
:indent
))
3546 face-alist face-entry spec-default spec-match editor
)
3548 ;; Find a display in SPEC matching the selected display.
3549 ;; This will use the usual face customization interface.
3550 (setq face-alist spec
)
3551 (when (eq (car-safe (car-safe face-alist
)) 'default
)
3552 (setq spec-default
(pop face-alist
)))
3554 (while (and face-alist
(listp face-alist
) (null spec-match
))
3555 (setq face-entry
(car face-alist
))
3556 (and (listp face-entry
)
3557 (face-spec-set-match-display (car face-entry
)
3559 (widget-apply custom-face-edit
:match
(cadr face-entry
))
3560 (setq spec-match face-entry
))
3561 (setq face-alist
(cdr face-alist
)))
3563 ;; Insert the appropriate editing widget.
3566 ((and (eq form
'selected
)
3567 (or spec-match spec-default
))
3568 (when indent
(insert-char ?\s indent
))
3569 (widget-create-child-and-convert
3570 widget
'custom-face-edit
3571 :value
(cadr spec-match
)
3572 :default-face-attributes
(cadr spec-default
)))
3573 ((and (not (eq form
'lisp
))
3574 (widget-apply custom-face-all
:match spec
))
3575 (widget-create-child-and-convert
3576 widget
'custom-face-all
:value spec
))
3579 (insert-char ?\s indent
))
3580 (widget-create-child-and-convert
3581 widget
'sexp
:value spec
))))
3582 (custom-face-state-set widget
)
3583 (push editor children
)
3584 (widget-put widget
:children children
))))))
3586 (defvar custom-face-menu
3587 `(("Set for Current Session" custom-face-set
)
3588 ,@(when (or custom-file init-file-user
)
3589 '(("Save for Future Sessions" custom-face-save
)))
3590 ("Undo Edits" custom-redraw
3592 (memq (widget-get widget
:custom-state
) '(modified changed
))))
3593 ("Reset to Saved" custom-face-reset-saved
3595 (or (get (widget-value widget
) 'saved-face
)
3596 (get (widget-value widget
) 'saved-face-comment
))))
3597 ,@(when (or custom-file init-file-user
)
3598 '(("Erase Customization" custom-face-reset-standard
3600 (get (widget-value widget
) 'face-defface-spec
)))))
3601 ("---" ignore ignore
)
3602 ("Add Comment" custom-comment-show custom-comment-invisible-p
)
3603 ("---" ignore ignore
)
3604 ("For Current Display" custom-face-edit-selected
3606 (not (eq (widget-get widget
:custom-form
) 'selected
))))
3607 ("For All Kinds of Displays" custom-face-edit-all
3609 (not (eq (widget-get widget
:custom-form
) 'all
))))
3610 ("Show Lisp Expression" custom-face-edit-lisp
3612 (not (eq (widget-get widget
:custom-form
) 'lisp
)))))
3613 "Alist of actions for the `custom-face' widget.
3614 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
3615 the menu entry, ACTION is the function to call on the widget when the
3616 menu is selected, and FILTER is a predicate which takes a `custom-face'
3617 widget as an argument, and returns non-nil if ACTION is valid on that
3618 widget. If FILTER is nil, ACTION is always valid.")
3620 (defun custom-face-edit-selected (widget)
3621 "Edit selected attributes of the value of WIDGET."
3622 (widget-put widget
:custom-state
'unknown
)
3623 (widget-put widget
:custom-form
'selected
)
3624 (custom-redraw widget
))
3626 (defun custom-face-edit-all (widget)
3627 "Edit all attributes of the value of WIDGET."
3628 (widget-put widget
:custom-state
'unknown
)
3629 (widget-put widget
:custom-form
'all
)
3630 (custom-redraw widget
))
3632 (defun custom-face-edit-lisp (widget)
3633 "Edit the Lisp representation of the value of WIDGET."
3634 (widget-put widget
:custom-state
'unknown
)
3635 (widget-put widget
:custom-form
'lisp
)
3636 (custom-redraw widget
))
3638 (defun custom-face-state (face)
3639 "Return the current state of the face FACE.
3640 This is one of `set', `saved', `changed', `themed', or `rogue'."
3641 (let* ((comment (get face
'face-comment
))
3644 ((or (get face
'customized-face
)
3645 (get face
'customized-face-comment
))
3646 (if (equal (get face
'customized-face-comment
) comment
)
3649 ((or (get face
'saved-face
)
3650 (get face
'saved-face-comment
))
3651 (if (equal (get face
'saved-face-comment
) comment
)
3653 ((eq 'user
(caar (get face
'theme-face
)))
3655 ((eq 'changed
(caar (get face
'theme-face
)))
3659 ((get face
'face-defface-spec
)
3660 (if (equal comment nil
)
3664 ;; If the user called set-face-attribute to change the default for
3665 ;; new frames, this face is "set outside of Customize".
3666 (if (and (not (eq state
'rogue
))
3667 (get face
'face-modified
))
3671 (defun custom-face-state-set (widget)
3672 "Set the state of WIDGET."
3673 (widget-put widget
:custom-state
3674 (custom-face-state (widget-value widget
))))
3676 (defun custom-face-action (widget &optional event
)
3677 "Show the menu for `custom-face' WIDGET.
3678 Optional EVENT is the location for the menu."
3679 (if (eq (widget-get widget
:custom-state
) 'hidden
)
3680 (custom-toggle-hide widget
)
3681 (let* ((completion-ignore-case t
)
3682 (symbol (widget-get widget
:value
))
3683 (answer (widget-choose (concat "Operation on "
3684 (custom-unlispify-tag-name symbol
))
3685 (custom-menu-filter custom-face-menu
3689 (funcall answer widget
)))))
3691 (defun custom-face-set (widget)
3692 "Make the face attributes in WIDGET take effect."
3693 (let* ((symbol (widget-value widget
))
3694 (value (custom-face-widget-to-spec widget
))
3695 (comment-widget (widget-get widget
:comment-widget
))
3696 (comment (widget-value comment-widget
)))
3697 (when (equal comment
"")
3699 ;; Make the comment invisible by hand if it's empty
3700 (custom-comment-hide comment-widget
))
3701 (put symbol
'customized-face value
)
3702 (custom-push-theme 'theme-face symbol
'user
'set value
)
3703 (if (face-spec-choose value
)
3704 (face-spec-set symbol value t
)
3705 ;; face-set-spec ignores empty attribute lists, so just give it
3706 ;; something harmless instead.
3707 (face-spec-set symbol
'((t :foreground unspecified
)) t
))
3708 (put symbol
'customized-face-comment comment
)
3709 (put symbol
'face-comment comment
)
3710 (custom-face-state-set widget
)
3711 (custom-redraw-magic widget
)))
3713 (defun custom-face-mark-to-save (widget)
3714 "Mark for saving the face edited by WIDGET."
3715 (let* ((symbol (widget-value widget
))
3716 (value (custom-face-widget-to-spec widget
))
3717 (comment-widget (widget-get widget
:comment-widget
))
3718 (comment (widget-value comment-widget
)))
3719 (when (equal comment
"")
3721 ;; Make the comment invisible by hand if it's empty
3722 (custom-comment-hide comment-widget
))
3723 (custom-push-theme 'theme-face symbol
'user
'set value
)
3724 (if (face-spec-choose value
)
3725 (face-spec-set symbol value t
)
3726 ;; face-set-spec ignores empty attribute lists, so just give it
3727 ;; something harmless instead.
3728 (face-spec-set symbol
'((t :foreground unspecified
)) t
))
3729 (unless (eq (widget-get widget
:custom-state
) 'standard
)
3730 (put symbol
'saved-face value
))
3731 (put symbol
'customized-face nil
)
3732 (put symbol
'face-comment comment
)
3733 (put symbol
'customized-face-comment nil
)
3734 (put symbol
'saved-face-comment comment
)))
3736 (defsubst custom-face-state-set-and-redraw
(widget)
3737 "Set state of face widget WIDGET and redraw with current settings."
3738 (custom-face-state-set widget
)
3739 (custom-redraw-magic widget
))
3741 (defun custom-face-save (widget)
3742 "Save the face edited by WIDGET."
3743 (custom-face-mark-to-save widget
)
3745 (custom-face-state-set-and-redraw widget
))
3747 ;; For backward compatibility.
3748 (define-obsolete-function-alias 'custom-face-save-command
'custom-face-save
3751 (defun custom-face-reset-saved (widget)
3752 "Restore WIDGET to the face's default attributes."
3753 (let* ((symbol (widget-value widget
))
3754 (child (car (widget-get widget
:children
)))
3755 (value (get symbol
'saved-face
))
3756 (comment (get symbol
'saved-face-comment
))
3757 (comment-widget (widget-get widget
:comment-widget
)))
3758 (unless (or value comment
)
3759 (error "No saved value for this face"))
3760 (put symbol
'customized-face nil
)
3761 (put symbol
'customized-face-comment nil
)
3762 (custom-push-theme 'theme-face symbol
'user
'set value
)
3763 (face-spec-set symbol value t
)
3764 (put symbol
'face-comment comment
)
3765 (widget-value-set child value
)
3766 ;; This call manages the comment visibility
3767 (widget-value-set comment-widget
(or comment
""))
3768 (custom-face-state-set widget
)
3769 (custom-redraw-magic widget
)))
3771 (defun custom-face-standard-value (widget)
3772 (get (widget-value widget
) 'face-defface-spec
))
3774 (defun custom-face-mark-to-reset-standard (widget)
3775 "Restore widget WIDGET to the face's standard attribute values.
3776 If `custom-reset-standard-faces-list' is nil, save, reset and
3777 redraw the widget immediately."
3778 (let* ((symbol (widget-value widget
))
3779 (child (car (widget-get widget
:children
)))
3780 (value (get symbol
'face-defface-spec
))
3781 (comment-widget (widget-get widget
:comment-widget
)))
3783 (error "No standard setting for this face"))
3784 (put symbol
'customized-face nil
)
3785 (put symbol
'customized-face-comment nil
)
3786 (custom-push-theme 'theme-face symbol
'user
'reset
)
3787 (face-spec-set symbol value t
)
3788 (custom-theme-recalc-face symbol
)
3789 (if (and custom-reset-standard-faces-list
3790 (or (get symbol
'saved-face
) (get symbol
'saved-face-comment
)))
3793 (put symbol
'saved-face nil
)
3794 (put symbol
'saved-face-comment nil
)
3795 ;; Append this to `custom-reset-standard-faces-list' and have
3796 ;; `custom-reset-standard-save-and-update' save setting to the
3797 ;; file, update the widget's state, and redraw it.
3798 (setq custom-reset-standard-faces-list
3799 (cons widget custom-reset-standard-faces-list
)))
3800 (when (or (get symbol
'saved-face
) (get symbol
'saved-face-comment
))
3801 (put symbol
'saved-face nil
)
3802 (put symbol
'saved-face-comment nil
)
3804 (put symbol
'face-comment nil
)
3805 (widget-value-set child
3806 (custom-pre-filter-face-spec
3807 (list (list t
(custom-face-attributes-get
3809 ;; This call manages the comment visibility
3810 (widget-value-set comment-widget
"")
3811 (custom-face-state-set widget
)
3812 (custom-redraw-magic widget
))))
3814 (defun custom-face-reset-standard (widget)
3815 "Restore WIDGET to the face's standard attribute values.
3816 This operation eliminates any saved attributes for the face,
3817 restoring it to the state of a face that has never been customized."
3818 (let (custom-reset-standard-faces-list)
3819 (custom-face-mark-to-reset-standard widget
)))
3821 ;;; The `face' Widget.
3823 (defvar widget-face-prompt-value-history nil
3824 "History of input to `widget-face-prompt-value'.")
3826 (define-widget 'face
'symbol
3827 "A Lisp face name (with sample)."
3828 :format
"%{%t%}: (%{sample%}) %v"
3831 :sample-face-get
'widget-face-sample-face-get
3832 :notify
'widget-face-notify
3833 :match
(lambda (widget value
) (facep value
))
3834 :complete-function
(lambda ()
3836 (lisp-complete-symbol 'facep
))
3837 :prompt-match
'facep
3838 :prompt-history
'widget-face-prompt-value-history
3839 :validate
(lambda (widget)
3840 (unless (facep (widget-value widget
))
3842 :error
(format "Invalid face: %S"
3843 (widget-value widget
)))
3846 (defun widget-face-sample-face-get (widget)
3847 (let ((value (widget-value widget
)))
3852 (defun widget-face-notify (widget child
&optional event
)
3853 "Update the sample, and notify the parent."
3854 (overlay-put (widget-get widget
:sample-overlay
)
3855 'face
(widget-apply widget
:sample-face-get
))
3856 (widget-default-notify widget child event
))
3859 ;;; The `hook' Widget.
3861 (define-widget 'hook
'list
3862 "An Emacs Lisp hook."
3863 :value-to-internal
(lambda (widget value
)
3864 (if (and value
(symbolp value
))
3867 :match
(lambda (widget value
)
3869 (widget-group-match widget value
)))
3870 ;; Avoid adding undefined functions to the hook, especially for
3871 ;; things like `find-file-hook' or even more basic ones, to avoid
3873 :set
(lambda (symbol value
)
3876 (add-hook symbol elt
))))
3877 :convert-widget
'custom-hook-convert-widget
3880 (defun custom-hook-convert-widget (widget)
3881 ;; Handle `:options'.
3882 (let* ((options (widget-get widget
:options
))
3883 (other `(editable-list :inline t
3884 :entry-format
"%i %d%v"
3885 (function :format
" %v")))
3887 (list `(checklist :inline t
3888 ,@(mapcar (lambda (entry)
3889 `(function-item ,entry
))
3893 (widget-put widget
:args args
)
3896 ;;; The `custom-group-link' Widget.
3898 (define-widget 'custom-group-link
'link
3899 "Show parent in other window when activated."
3900 :button-face
'custom-link
3901 :mouse-face
'highlight
3902 :pressed-face
'highlight
3903 :help-echo
"Create customization buffer for this group."
3904 :keymap custom-mode-link-map
3905 :follow-link
'mouse-face
3906 :action
'custom-group-link-action
)
3908 (defun custom-group-link-action (widget &rest ignore
)
3909 (customize-group (widget-value widget
)))
3911 ;;; The `custom-group' Widget.
3913 (defcustom custom-group-tag-faces nil
3914 ;; In XEmacs, this ought to play games with font size.
3915 ;; Fixme: make it do so in Emacs.
3916 "Face used for group tags.
3917 The first member is used for level 1 groups, the second for level 2,
3918 and so forth. The remaining group tags are shown with `custom-group-tag'."
3919 :type
'(repeat face
)
3920 :group
'custom-faces
)
3922 (defface custom-group-tag-1
3925 (:foreground
"pink" :weight bold
:height
1.2 :inherit variable-pitch
))
3926 (((min-colors 88) (class color
)
3928 (:foreground
"red1" :weight bold
:height
1.2 :inherit variable-pitch
))
3931 (:foreground
"red" :weight bold
:height
1.2 :inherit variable-pitch
))
3933 "Face used for group tags."
3934 :group
'custom-faces
)
3935 (define-obsolete-face-alias 'custom-group-tag-face-1
'custom-group-tag-1
"22.1")
3937 (defface custom-group-tag
3940 (:foreground
"light blue" :weight bold
:height
1.2 :inherit variable-pitch
))
3941 (((min-colors 88) (class color
)
3943 (:foreground
"blue1" :weight bold
:height
1.2 :inherit variable-pitch
))
3946 (:foreground
"blue" :weight bold
:height
1.2 :inherit variable-pitch
))
3948 "Face used for low level group tags."
3949 :group
'custom-faces
)
3950 (define-obsolete-face-alias 'custom-group-tag-face
'custom-group-tag
"22.1")
3952 (define-widget 'custom-group
'custom
3955 :sample-face-get
'custom-group-sample-face-get
3956 :documentation-property
'group-documentation
3957 :help-echo
"Set or reset all members of this group."
3958 :value-create
'custom-group-value-create
3959 :action
'custom-group-action
3960 :custom-category
'group
3961 :custom-set
'custom-group-set
3962 :custom-mark-to-save
'custom-group-mark-to-save
3963 :custom-reset-current
'custom-group-reset-current
3964 :custom-reset-saved
'custom-group-reset-saved
3965 :custom-reset-standard
'custom-group-reset-standard
3966 :custom-mark-to-reset-standard
'custom-group-mark-to-reset-standard
3967 :custom-state-set-and-redraw
'custom-group-state-set-and-redraw
3968 :custom-menu
'custom-group-menu-create
)
3970 (defun custom-group-sample-face-get (widget)
3971 ;; Use :sample-face.
3972 (or (nth (1- (widget-get widget
:custom-level
)) custom-group-tag-faces
)
3975 (define-widget 'custom-group-visibility
'visibility
3976 "An indicator and manipulator for hidden group contents."
3977 :create
'custom-group-visibility-create
)
3979 (defun custom-group-visibility-create (widget)
3980 (let ((visible (widget-value widget
)))
3982 (insert "--------")))
3983 (widget-default-create widget
))
3985 (defun custom-group-members (symbol groups-only
)
3986 "Return SYMBOL's custom group members.
3987 If GROUPS-ONLY non-nil, return only those members that are groups."
3988 (if (not groups-only
)
3989 (get symbol
'custom-group
)
3991 (dolist (entry (get symbol
'custom-group
))
3992 (when (eq (nth 1 entry
) 'custom-group
)
3993 (push entry members
)))
3994 (nreverse members
))))
3996 (defun custom-group-value-create (widget)
3997 "Insert a customize group for WIDGET in the current buffer."
3998 (unless (eq (widget-get widget
:custom-state
) 'hidden
)
3999 (custom-load-widget widget
))
4000 (let* ((state (widget-get widget
:custom-state
))
4001 (level (widget-get widget
:custom-level
))
4002 ;; (indent (widget-get widget :indent))
4003 (prefix (widget-get widget
:custom-prefix
))
4004 (buttons (widget-get widget
:buttons
))
4005 (tag (widget-get widget
:tag
))
4006 (symbol (widget-value widget
))
4007 (members (custom-group-members symbol
4008 (and (eq custom-buffer-style
'tree
)
4009 custom-browse-only-groups
)))
4010 (doc (widget-docstring widget
)))
4011 (cond ((and (eq custom-buffer-style
'tree
)
4013 (or members
(custom-unloaded-widget-p widget
)))
4014 (custom-browse-insert-prefix prefix
)
4015 (push (widget-create-child-and-convert
4016 widget
'custom-browse-visibility
4017 ;; :tag-glyph "plus"
4021 ;; (widget-glyph-insert nil "-- " "horizontal")
4022 (push (widget-create-child-and-convert
4023 widget
'custom-browse-group-tag
)
4025 (insert " " tag
"\n")
4026 (widget-put widget
:buttons buttons
))
4027 ((and (eq custom-buffer-style
'tree
)
4028 (zerop (length members
)))
4029 (custom-browse-insert-prefix prefix
)
4031 ;; (widget-glyph-insert nil "[ ]" "empty")
4032 ;; (widget-glyph-insert nil "-- " "horizontal")
4033 (push (widget-create-child-and-convert
4034 widget
'custom-browse-group-tag
)
4036 (insert " " tag
"\n")
4037 (widget-put widget
:buttons buttons
))
4038 ((eq custom-buffer-style
'tree
)
4039 (custom-browse-insert-prefix prefix
)
4040 (if (zerop (length members
))
4042 (custom-browse-insert-prefix prefix
)
4044 ;; (widget-glyph-insert nil "[ ]" "empty")
4045 ;; (widget-glyph-insert nil "-- " "horizontal")
4046 (push (widget-create-child-and-convert
4047 widget
'custom-browse-group-tag
)
4049 (insert " " tag
"\n")
4050 (widget-put widget
:buttons buttons
))
4051 (push (widget-create-child-and-convert
4052 widget
'custom-browse-visibility
4053 ;; :tag-glyph "minus"
4057 ;; (widget-glyph-insert nil "-\\ " "top")
4058 (push (widget-create-child-and-convert
4059 widget
'custom-browse-group-tag
)
4061 (insert " " tag
"\n")
4062 (widget-put widget
:buttons buttons
)
4063 (message "Creating group...")
4064 (let* ((members (custom-sort-items
4066 ;; Never sort the top-level custom group.
4067 (unless (eq symbol
'emacs
)
4068 custom-browse-sort-alphabetically
)
4069 custom-browse-order-groups
))
4070 (prefixes (widget-get widget
:custom-prefixes
))
4071 (custom-prefix-list (custom-prefix-add symbol prefixes
))
4072 (extra-prefix (if (widget-get widget
:custom-last
)
4075 (prefix (concat prefix extra-prefix
))
4078 (setq entry
(car members
)
4079 members
(cdr members
))
4080 (push (widget-create-child-and-convert
4081 widget
(nth 1 entry
)
4083 :tag
(custom-unlispify-tag-name (nth 0 entry
))
4084 :custom-prefixes custom-prefix-list
4085 :custom-level
(1+ level
)
4086 :custom-last
(null members
)
4087 :value
(nth 0 entry
)
4088 :custom-prefix prefix
)
4090 (widget-put widget
:children
(reverse children
)))
4091 (message "Creating group...done")))
4094 ;; Create level indicator.
4096 (if (eq custom-buffer-style
'links
)
4097 (push (widget-create-child-and-convert
4098 widget
'custom-group-link
4102 (insert-char ?\
(* custom-buffer-indent
(1- level
)))
4104 (push (widget-create-child-and-convert
4105 widget
'custom-group-visibility
4106 :help-echo
"Show members of this group."
4107 :action
'custom-toggle-parent
4108 (not (eq state
'hidden
)))
4111 ;; Create magic button.
4112 (let ((magic (widget-create-child-and-convert
4113 widget
'custom-magic nil
)))
4114 (widget-put widget
:custom-magic magic
)
4115 (push magic buttons
))
4117 (widget-put widget
:buttons buttons
)
4118 ;; Insert documentation.
4119 (if (and (eq custom-buffer-style
'links
) (> level
1))
4120 (widget-put widget
:documentation-indent
0))
4121 (widget-add-documentation-string-button
4122 widget
:visibility-widget
'custom-visibility
))
4126 ;; Draw a horizontal line (this works for both graphical
4127 ;; and text displays):
4130 (put-text-property p
(1+ p
) 'face
'(:underline t
))
4131 (overlay-put (make-overlay p
(1+ p
))
4133 (propertize "\n" 'face
'(:underline t
)
4134 'display
'(space :align-to
999))))
4136 ;; Add parent groups references above the group.
4138 (if (custom-add-parent-links widget
"Parent groups:")
4140 (insert-char ?\
(* custom-buffer-indent
(1- level
)))
4142 (let ((start (point)))
4143 (insert tag
" group: ")
4144 (widget-specify-sample widget start
(point)))
4147 (insert " Group definition missing. "))
4148 ((< (length doc
) 50)
4150 ;; Create visibility indicator.
4151 (unless (eq custom-buffer-style
'links
)
4153 (push (widget-create-child-and-convert
4155 :help-echo
"Hide members of this group."
4156 :action
'custom-toggle-parent
4157 (not (eq state
'hidden
)))
4161 ;; Create magic button.
4162 (let ((magic (widget-create-child-and-convert
4163 widget
'custom-magic
4166 (widget-put widget
:custom-magic magic
)
4167 (push magic buttons
))
4169 (widget-put widget
:buttons buttons
)
4170 ;; Insert documentation.
4171 (when (and doc
(>= (length doc
) 50))
4172 (widget-add-documentation-string-button
4173 widget
:visibility-widget
'custom-visibility
))
4176 (if nil
;;; This should test that the buffer
4177 ;;; was not made to display a group.
4179 (insert-char ?\ custom-buffer-indent
)
4180 (custom-add-parent-links widget
)))
4181 (custom-add-see-also widget
4182 (make-string (* custom-buffer-indent level
)
4185 (message "Creating group...")
4186 (let* ((members (custom-sort-items
4188 ;; Never sort the top-level custom group.
4189 (unless (eq symbol
'emacs
)
4190 custom-buffer-sort-alphabetically
)
4191 custom-buffer-order-groups
))
4192 (prefixes (widget-get widget
:custom-prefixes
))
4193 (custom-prefix-list (custom-prefix-add symbol prefixes
))
4194 (len (length members
))
4196 (reporter (make-progress-reporter
4197 "Creating group entries..." 0 len
))
4202 (widget-insert "\n")
4203 (progress-reporter-update reporter
(setq count
(1+ count
)))
4204 (let ((sym (nth 0 entry
))
4205 (type (nth 1 entry
))
4208 (widget-create-child-and-convert
4211 :tag
(custom-unlispify-tag-name sym
)
4212 :custom-prefixes custom-prefix-list
4213 :custom-level
(1+ level
)
4215 (unless (eq (preceding-char) ?
\n)
4216 (widget-insert "\n")))))
4218 (mapc 'custom-magic-reset children
)
4219 (widget-put widget
:children children
)
4220 (custom-group-state-update widget
)
4221 (progress-reporter-done reporter
))
4223 (let ((p (1+ (point))))
4225 (put-text-property p
(1+ p
) 'face
'(:underline t
))
4226 (overlay-put (make-overlay p
(1+ p
))
4228 (propertize "\n" 'face
'(:underline t
)
4229 'display
'(space :align-to
999))))))))
4231 (defvar custom-group-menu
4232 `(("Set for Current Session" custom-group-set
4234 (eq (widget-get widget
:custom-state
) 'modified
)))
4235 ,@(when (or custom-file init-file-user
)
4236 '(("Save for Future Sessions" custom-group-save
4238 (memq (widget-get widget
:custom-state
) '(modified set
))))))
4239 ("Undo Edits" custom-group-reset-current
4241 (memq (widget-get widget
:custom-state
) '(modified))))
4242 ("Reset to Saved" custom-group-reset-saved
4244 (memq (widget-get widget
:custom-state
) '(modified set
))))
4245 ,@(when (or custom-file init-file-user
)
4246 '(("Erase Customization" custom-group-reset-standard
4248 (memq (widget-get widget
:custom-state
) '(modified set saved
)))))))
4249 "Alist of actions for the `custom-group' widget.
4250 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
4251 the menu entry, ACTION is the function to call on the widget when the
4252 menu is selected, and FILTER is a predicate which takes a `custom-group'
4253 widget as an argument, and returns non-nil if ACTION is valid on that
4254 widget. If FILTER is nil, ACTION is always valid.")
4256 (defun custom-group-action (widget &optional event
)
4257 "Show the menu for `custom-group' WIDGET.
4258 Optional EVENT is the location for the menu."
4259 (if (eq (widget-get widget
:custom-state
) 'hidden
)
4260 (custom-toggle-hide widget
)
4261 (let* ((completion-ignore-case t
)
4262 (answer (widget-choose (concat "Operation on "
4263 (custom-unlispify-tag-name
4264 (widget-get widget
:value
)))
4265 (custom-menu-filter custom-group-menu
4269 (funcall answer widget
)))))
4271 (defun custom-group-set (widget)
4272 "Set changes in all modified group members."
4273 (dolist (child (widget-get widget
:children
))
4274 (when (eq (widget-get child
:custom-state
) 'modified
)
4275 (widget-apply child
:custom-set
))))
4277 (defun custom-group-mark-to-save (widget)
4278 "Mark all modified group members for saving."
4279 (dolist (child (widget-get widget
:children
))
4280 (when (memq (widget-get child
:custom-state
) '(modified set
))
4281 (widget-apply child
:custom-mark-to-save
))))
4283 (defsubst custom-group-state-set-and-redraw
(widget)
4284 "Set state of group widget WIDGET and redraw with current settings."
4285 (dolist (child (widget-get widget
:children
))
4286 (when (memq (widget-get child
:custom-state
) '(modified set
))
4287 (widget-apply child
:custom-state-set-and-redraw
))))
4289 (defun custom-group-save (widget)
4290 "Save all modified group members."
4291 (custom-group-mark-to-save widget
)
4293 (custom-group-state-set-and-redraw widget
))
4295 (defun custom-group-reset-current (widget)
4296 "Reset all modified group members."
4297 (dolist (child (widget-get widget
:children
))
4298 (when (eq (widget-get child
:custom-state
) 'modified
)
4299 (widget-apply child
:custom-reset-current
))))
4301 (defun custom-group-reset-saved (widget)
4302 "Reset all modified or set group members."
4303 (dolist (child (widget-get widget
:children
))
4304 (when (memq (widget-get child
:custom-state
) '(modified set
))
4305 (widget-apply child
:custom-reset-saved
))))
4307 (defun custom-group-reset-standard (widget)
4308 "Reset all modified, set, or saved group members."
4309 (let ((custom-reset-standard-variables-list '(t))
4310 (custom-reset-standard-faces-list '(t)))
4311 (custom-group-mark-to-reset-standard widget
)
4312 (custom-reset-standard-save-and-update)))
4314 (defun custom-group-mark-to-reset-standard (widget)
4315 "Mark to reset all modified, set, or saved group members."
4316 (dolist (child (widget-get widget
:children
))
4317 (when (memq (widget-get child
:custom-state
)
4318 '(modified set saved
))
4319 (widget-apply child
:custom-mark-to-reset-standard
))))
4321 (defun custom-group-state-update (widget)
4323 (unless (eq (widget-get widget
:custom-state
) 'hidden
)
4324 (let* ((children (widget-get widget
:children
))
4325 (states (mapcar (lambda (child)
4326 (widget-get child
:custom-state
))
4328 (magics custom-magic-alist
)
4331 (let ((magic (car (car magics
))))
4332 (if (and (not (eq magic
'hidden
))
4333 (memq magic states
))
4336 (setq magics
(cdr magics
)))))
4337 (widget-put widget
:custom-state found
)))
4338 (custom-magic-reset widget
))
4340 ;;; Reading and writing the custom file.
4343 (defcustom custom-file nil
4344 "File used for storing customization information.
4345 The default is nil, which means to use your init file
4346 as specified by `user-init-file'. If the value is not nil,
4347 it should be an absolute file name.
4349 You can set this option through Custom, if you carefully read the
4350 last paragraph below. However, usually it is simpler to write
4351 something like the following in your init file:
4353 \(setq custom-file \"~/.emacs-custom.el\")
4356 Note that both lines are necessary: the first line tells Custom to
4357 save all customizations in this file, but does not load it.
4359 When you change this variable outside Custom, look in the
4360 previous custom file \(usually your init file) for the
4361 forms `(custom-set-variables ...)' and `(custom-set-faces ...)',
4362 and copy them (whichever ones you find) to the new custom file.
4363 This will preserve your existing customizations.
4365 If you save this option using Custom, Custom will write all
4366 currently saved customizations, including the new one for this
4367 option itself, into the file you specify, overwriting any
4368 `custom-set-variables' and `custom-set-faces' forms already
4369 present in that file. It will not delete any customizations from
4370 the old custom file. You should do that manually if that is what you
4371 want. You also have to put something like `\(load \"CUSTOM-FILE\")
4372 in your init file, where CUSTOM-FILE is the actual name of the
4373 file. Otherwise, Emacs will not load the file when it starts up,
4374 and hence will not set `custom-file' to that file either."
4375 :type
'(choice (const :tag
"Your Emacs init file" nil
)
4376 (file :format
"%t:%v%d"
4378 "Please read entire docstring below before setting \
4379 this through Custom.
4380 Click on \"More\" \(or position point there and press RETURN)
4381 if only the first line of the docstring is shown."))
4384 (defun custom-file ()
4385 "Return the file name for saving customizations."
4388 (let ((user-init-file user-init-file
)
4390 (if (eq system-type
'ms-dos
) "~/_emacs" "~/.emacs")))
4391 (when (null user-init-file
)
4392 (if (or (file-exists-p default-init-file
)
4393 (and (eq system-type
'windows-nt
)
4394 (file-exists-p "~/_emacs")))
4395 ;; Started with -q, i.e. the file containing
4396 ;; Custom settings hasn't been read. Saving
4397 ;; settings there would overwrite other settings.
4398 (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
4399 (setq user-init-file default-init-file
))
4402 ;; If recentf-mode is non-nil, this is defined.
4403 (declare-function recentf-expand-file-name
"recentf" (name))
4406 (defun custom-save-all ()
4407 "Save all customizations in `custom-file'."
4408 (when (and (null custom-file
) init-file-had-error
)
4409 (error "Cannot save customizations; init file was not fully loaded"))
4410 (let* ((filename (custom-file))
4415 (recentf-expand-file-name (custom-file)))
4418 (old-buffer (find-buffer-visiting filename
))
4421 (with-current-buffer (let ((find-file-visit-truename t
))
4422 (or old-buffer
(find-file-noselect filename
)))
4423 ;; We'll save using file-precious-flag, so avoid destroying
4424 ;; symlinks. (If we're not already visiting the buffer, this is
4425 ;; handled by find-file-visit-truename, above.)
4427 (setq old-buffer-name
(buffer-file-name))
4428 (set-visited-file-name (file-chase-links filename
)))
4430 (unless (eq major-mode
'emacs-lisp-mode
)
4432 (let ((inhibit-read-only t
)
4435 (custom-save-variables)
4436 (custom-save-faces))
4437 (let ((file-precious-flag t
))
4441 (set-visited-file-name old-buffer-name
)
4442 (set-buffer-modified-p nil
))
4443 (kill-buffer (current-buffer))))))
4446 (defun customize-save-customized ()
4447 "Save all user options which have been set in this session."
4449 (mapatoms (lambda (symbol)
4450 (let ((face (get symbol
'customized-face
))
4451 (value (get symbol
'customized-value
))
4452 (face-comment (get symbol
'customized-face-comment
))
4454 (get symbol
'customized-variable-comment
)))
4456 (put symbol
'saved-face face
)
4457 (custom-push-theme 'theme-face symbol
'user
'set value
)
4458 (put symbol
'customized-face nil
))
4460 (put symbol
'saved-value value
)
4461 (custom-push-theme 'theme-value symbol
'user
'set value
)
4462 (put symbol
'customized-value nil
))
4463 (when variable-comment
4464 (put symbol
'saved-variable-comment variable-comment
)
4465 (put symbol
'customized-variable-comment nil
))
4467 (put symbol
'saved-face-comment face-comment
)
4468 (put symbol
'customized-face-comment nil
)))))
4469 ;; We really should update all custom buffers here.
4472 ;; Editing the custom file contents in a buffer.
4474 (defun custom-save-delete (symbol)
4475 "Delete all calls to SYMBOL from the contents of the current buffer.
4476 Leave point at the old location of the first such call,
4477 or (if there were none) at the end of the buffer.
4479 This function does not save the buffer."
4480 (goto-char (point-min))
4481 ;; Skip all whitespace and comments.
4482 (while (forward-comment 1))
4484 (save-excursion (forward-sexp (buffer-size)))) ; Test for scan errors.
4487 (while t
;; We exit this loop only via throw.
4488 ;; Skip all whitespace and comments.
4489 (while (forward-comment 1))
4490 (let ((start (point))
4491 (sexp (condition-case nil
4492 (read (current-buffer))
4493 (end-of-file (throw 'found nil
)))))
4494 (when (and (listp sexp
)
4495 (eq (car sexp
) symbol
))
4496 (delete-region start
(point))
4498 (setq first
(point)))))))
4501 ;; Move in front of local variables, otherwise long Custom
4502 ;; entries would make them ineffective.
4503 (let ((pos (point-max))
4504 (case-fold-search t
))
4506 (goto-char (point-max))
4507 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
4509 (when (search-forward "Local Variables:" nil t
)
4510 (setq pos
(line-beginning-position))))
4513 (defun custom-save-variables ()
4514 "Save all customized variables in `custom-file'."
4516 (custom-save-delete 'custom-set-variables
)
4517 (let ((standard-output (current-buffer))
4518 (saved-list (make-list 1 0))
4520 ;; First create a sorted list of saved variables.
4523 (if (and (get symbol
'saved-value
)
4524 ;; ignore theme values
4525 (or (null (get symbol
'theme-value
))
4526 (eq 'user
(caar (get symbol
'theme-value
)))))
4527 (nconc saved-list
(list symbol
)))))
4528 (setq saved-list
(sort (cdr saved-list
) 'string
<))
4531 (princ "(custom-set-variables
4532 ;; custom-set-variables was added by Custom.
4533 ;; If you edit it by hand, you could mess it up, so be careful.
4534 ;; Your init file should contain only one such instance.
4535 ;; If there is more than one, they won't work right.\n")
4536 (dolist (symbol saved-list
)
4537 (let ((spec (car-safe (get symbol
'theme-value
)))
4538 (value (get symbol
'saved-value
))
4539 (requests (get symbol
'custom-requests
))
4540 (now (and (not (custom-variable-p symbol
))
4542 (eq (get symbol
'force-value
)
4544 (comment (get symbol
'saved-variable-comment
)))
4545 ;; Check REQUESTS for validity.
4546 (dolist (request requests
)
4547 (when (and (symbolp request
) (not (featurep request
)))
4548 (message "Unknown requested feature: %s" request
)
4549 (setq requests
(delq request requests
))))
4550 ;; Is there anything customized about this variable?
4551 (when (or (and spec
(eq (car spec
) 'user
))
4553 (and (null spec
) (get symbol
'saved-value
)))
4554 ;; Output an element for this variable.
4555 ;; It has the form (SYMBOL VALUE-FORM NOW REQUESTS COMMENT).
4556 ;; SYMBOL is the variable name.
4557 ;; VALUE-FORM is an expression to return the customized value.
4558 ;; NOW if non-nil means always set the variable immediately
4559 ;; when the customizations are reloaded. This is used
4560 ;; for rogue variables
4561 ;; REQUESTS is a list of packages to load before setting the
4562 ;; variable. Each element of it will be passed to `require'.
4563 ;; COMMENT is whatever comment the user has specified
4564 ;; with the customize facility.
4571 (when (or now requests comment
)
4574 (when (or requests comment
)
4584 (unless (looking-at "\n")
4587 (defun custom-save-faces ()
4588 "Save all customized faces in `custom-file'."
4590 (custom-save-delete 'custom-reset-faces
)
4591 (custom-save-delete 'custom-set-faces
)
4592 (let ((standard-output (current-buffer))
4593 (saved-list (make-list 1 0))
4595 ;; First create a sorted list of saved faces.
4598 (if (and (get symbol
'saved-face
)
4599 (eq 'user
(car (car-safe (get symbol
'theme-face
)))))
4600 (nconc saved-list
(list symbol
)))))
4601 (setq saved-list
(sort (cdr saved-list
) 'string
<))
4602 ;; The default face must be first, since it affects the others.
4603 (if (memq 'default saved-list
)
4604 (setq saved-list
(cons 'default
(delq 'default saved-list
))))
4607 (princ "(custom-set-faces
4608 ;; custom-set-faces was added by Custom.
4609 ;; If you edit it by hand, you could mess it up, so be careful.
4610 ;; Your init file should contain only one such instance.
4611 ;; If there is more than one, they won't work right.\n")
4612 (dolist (symbol saved-list
)
4613 (let ((spec (car-safe (get symbol
'theme-face
)))
4614 (value (get symbol
'saved-face
))
4615 (now (not (or (get symbol
'face-defface-spec
)
4616 (and (not (custom-facep symbol
))
4617 (not (get symbol
'force-face
))))))
4618 (comment (get symbol
'saved-face-comment
)))
4619 (when (or (and spec
(eq (nth 0 spec
) 'user
))
4621 (and (null spec
) (get symbol
'saved-face
)))
4622 ;; Don't print default face here.
4629 (when (or now comment
)
4639 (unless (looking-at "\n")
4642 ;;; The Customize Menu.
4646 (defcustom custom-menu-nesting
2
4647 "Maximum nesting in custom menus."
4649 :group
'custom-menu
)
4651 (defun custom-face-menu-create (widget symbol
)
4652 "Ignoring WIDGET, create a menu entry for customization face SYMBOL."
4653 (vector (custom-unlispify-menu-entry symbol
)
4654 `(customize-face ',symbol
)
4657 (defun custom-variable-menu-create (widget symbol
)
4658 "Ignoring WIDGET, create a menu entry for customization variable SYMBOL."
4659 (let ((type (get symbol
'custom-type
)))
4660 (unless (listp type
)
4661 (setq type
(list type
)))
4662 (if (and type
(widget-get type
:custom-menu
))
4663 (widget-apply type
:custom-menu symbol
)
4664 (vector (custom-unlispify-menu-entry symbol
)
4665 `(customize-variable ',symbol
)
4668 ;; Add checkboxes to boolean variable entries.
4669 (widget-put (get 'boolean
'widget-type
)
4670 :custom-menu
(lambda (widget symbol
)
4671 (vector (custom-unlispify-menu-entry symbol
)
4672 `(customize-variable ',symbol
)
4674 ':selected symbol
)))
4676 (defun custom-group-menu-create (widget symbol
)
4677 "Ignoring WIDGET, create a menu entry for customization group SYMBOL."
4678 `( ,(custom-unlispify-menu-entry symbol t
)
4679 :filter
(lambda (&rest junk
)
4680 (let* ((menu (custom-menu-create ',symbol
)))
4681 (if (consp menu
) (cdr menu
) menu
)))))
4684 (defun custom-menu-create (symbol)
4685 "Create menu for customization group SYMBOL.
4686 The menu is in a format applicable to `easy-menu-define'."
4687 (let* ((deactivate-mark nil
)
4688 (item (vector (custom-unlispify-menu-entry symbol
)
4689 `(customize-group ',symbol
)
4691 (if (and (or (not (boundp 'custom-menu-nesting
))
4692 (>= custom-menu-nesting
0))
4694 (custom-load-symbol symbol
)
4695 (< (length (get symbol
'custom-group
)) widget-menu-max-size
)))
4696 (let ((custom-prefix-list (custom-prefix-add symbol
4697 custom-prefix-list
))
4698 (members (custom-sort-items (get symbol
'custom-group
)
4699 custom-menu-sort-alphabetically
4700 custom-menu-order-groups
)))
4701 `(,(custom-unlispify-menu-entry symbol t
)
4704 ,@(mapcar (lambda (entry)
4705 (widget-apply (if (listp (nth 1 entry
))
4707 (list (nth 1 entry
)))
4708 :custom-menu
(nth 0 entry
)))
4713 (defun customize-menu-create (symbol &optional name
)
4714 "Return a customize menu for customization group SYMBOL.
4715 If optional NAME is given, use that as the name of the menu.
4716 Otherwise the menu will be named `Customize'.
4717 The format is suitable for use with `easy-menu-define'."
4719 (setq name
"Customize"))
4721 :filter
(lambda (&rest junk
)
4722 (let ((menu (custom-menu-create ',symbol
)))
4723 (if (consp menu
) (cdr menu
) menu
)))))
4725 ;;; Toolbar and menubar support
4728 Custom-mode-menu
(list custom-mode-map custom-field-keymap
)
4729 "Menu used in customization buffers."
4730 (nconc (list "Custom"
4731 (customize-menu-create 'customize
))
4732 (mapcar (lambda (arg)
4733 (let ((tag (nth 0 arg
))
4734 (command (nth 1 arg
))
4735 (active (nth 2 arg
))
4737 (vector tag command
:active
(eval active
) :help help
)))
4740 (defvar tool-bar-map
)
4742 ;;; `custom-tool-bar-map' used to be set up here. This will fail to
4743 ;;; DTRT when `display-graphic-p' returns nil during compilation. Hence
4744 ;;; we set this up lazily in `Custom-mode'.
4745 (defvar custom-tool-bar-map nil
4746 "Keymap for toolbar in Custom mode.")
4748 ;;; The Custom Mode.
4750 (defun Custom-no-edit (pos &optional event
)
4751 "Invoke button at POS, or refuse to allow editing of Custom buffer."
4753 (error "You can't edit this part of the Custom buffer"))
4755 (defun Custom-newline (pos &optional event
)
4756 "Invoke button at POS, or refuse to allow editing of Custom buffer."
4758 (let ((button (get-char-property pos
'button
)))
4759 ;; If there is no button at point, then use the one at the start
4760 ;; of the line, if it is a custom-group-link (bug#2298).
4762 (if (setq button
(get-char-property (line-beginning-position) 'button
))
4763 (or (eq (widget-type button
) 'custom-group-link
)
4764 (setq button nil
))))
4766 (widget-apply-action button event
)
4767 (error "You can't edit this part of the Custom buffer"))))
4769 (defun Custom-goto-parent ()
4770 "Go to the parent group listed at the top of this buffer.
4771 If several parents are listed, go to the first of them."
4774 (goto-char (point-min))
4775 (if (search-forward "\nParent groups: " nil t
)
4776 (let* ((button (get-char-property (point) 'button
))
4777 (parent (downcase (widget-get button
:tag
))))
4778 (customize-group parent
)))))
4780 (defcustom Custom-mode-hook nil
4781 "Hook called when entering Custom mode."
4783 :group
'custom-buffer
)
4785 (defun custom-state-buffer-message (widget)
4786 (if (eq (widget-get (widget-get widget
:parent
) :custom-state
) 'modified
)
4787 (message "To install your edits, invoke [State] and choose the Set operation")))
4789 (defun custom--initialize-widget-variables ()
4790 (set (make-local-variable 'widget-documentation-face
) 'custom-documentation
)
4791 (set (make-local-variable 'widget-button-face
) custom-button
)
4792 (set (make-local-variable 'widget-button-pressed-face
) custom-button-pressed
)
4793 (set (make-local-variable 'widget-mouse-face
) custom-button-mouse
)
4794 ;; We need this because of the "More" button on docstrings.
4795 ;; Otherwise clicking on "More" can push point offscreen, which
4796 ;; causes the window to recenter on point, which pushes the
4797 ;; newly-revealed docstring offscreen; which is annoying. -- cyd.
4798 (set (make-local-variable 'widget-button-click-moves-point
) t
)
4799 ;; When possible, use relief for buttons, not bracketing. This test
4800 ;; may not be optimal.
4801 (when custom-raised-buttons
4802 (set (make-local-variable 'widget-push-button-prefix
) "")
4803 (set (make-local-variable 'widget-push-button-suffix
) "")
4804 (set (make-local-variable 'widget-link-prefix
) "")
4805 (set (make-local-variable 'widget-link-suffix
) ""))
4806 (setq show-trailing-whitespace nil
))
4808 (define-derived-mode Custom-mode nil
"Custom"
4809 "Major mode for editing customization buffers.
4811 The following commands are available:
4814 Move to next button, link or editable field. \\[widget-forward]
4815 Move to previous button, link or editable field. \\[widget-backward]
4816 \\<custom-field-keymap>\
4817 Complete content of editable text field. \\[widget-complete]
4818 \\<custom-mode-map>\
4819 Invoke button under the mouse pointer. \\[widget-button-click]
4820 Invoke button under point. \\[widget-button-press]
4821 Set all options from current text. \\[Custom-set]
4822 Make values in current text permanent. \\[Custom-save]
4823 Make text match actual option values. \\[Custom-reset-current]
4824 Reset options to permanent settings. \\[Custom-reset-saved]
4825 Erase customizations; set options
4826 and buffer text to the standard values. \\[Custom-reset-standard]
4828 Entry to this mode calls the value of `Custom-mode-hook'
4829 if that value is non-nil."
4830 (use-local-map custom-mode-map
)
4831 (easy-menu-add Custom-mode-menu
)
4832 (set (make-local-variable 'tool-bar-map
)
4833 (or custom-tool-bar-map
4834 ;; Set up `custom-tool-bar-map'.
4835 (let ((map (make-sparse-keymap)))
4838 (tool-bar-local-item-from-menu
4839 (nth 1 arg
) (nth 4 arg
) map custom-mode-map
4840 :label
(nth 5 arg
)))
4842 (setq custom-tool-bar-map map
))))
4843 (make-local-variable 'custom-options
)
4844 (make-local-variable 'custom-local-buffer
)
4845 (custom--initialize-widget-variables)
4846 (add-hook 'widget-edit-functions
'custom-state-buffer-message nil t
))
4848 (put 'Custom-mode
'mode-class
'special
)
4850 ;; backward-compatibility
4851 (defun custom-mode ()
4852 "Non-interactive variant of `Custom-mode'."
4854 (make-obsolete 'custom-mode
'Custom-mode
"23.1")
4855 (put 'custom-mode
'mode-class
'special
)
4856 (define-obsolete-variable-alias 'custom-mode-hook
'Custom-mode-hook
"23.1")
4859 '("^No user option defaults have been changed since Emacs "
4861 "^No \\(?:customized\\|rogue\\|saved\\) user options"
4862 "^No customizable items matching "
4863 "^There are unset changes"
4864 "^Cannot set hidden variable"
4865 "^No \\(?:saved\\|backup\\) value for "
4866 "^No standard setting known for "
4867 "^No standard setting for this face"
4868 "^Saving settings from \"emacs -q\" would overwrite existing customizations"))
4869 (add-to-list 'debug-ignored-errors regexp
))
4875 ;;; cus-edit.el ends here