1 ;;; custom.el --- tools for declaring and initializing options
3 ;; Copyright (C) 1996-1997, 1999, 2001-2012 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 only contains the code needed to declare and initialize
28 ;; user options. The code to customize options is autoloaded from
29 ;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual.
31 ;; The code implementing face declarations is in `cus-face.el'.
37 (defvar custom-define-hook nil
38 ;; Customize information for this option is in `cus-edit.el'.
39 "Hook called after defining each customize option.")
41 (defvar custom-dont-initialize nil
42 "Non-nil means `defcustom' should not initialize the variable.
43 That is used for the sake of `custom-make-dependencies'.
44 Users should not set it.")
46 (defvar custom-current-group-alist nil
47 "Alist of (FILE . GROUP) indicating the current group to use for FILE.")
49 ;;; The `defcustom' Macro.
51 (defun custom-initialize-default (symbol value
)
52 "Initialize SYMBOL with VALUE.
53 This will do nothing if symbol already has a default binding.
54 Otherwise, if symbol has a `saved-value' property, it will evaluate
55 the car of that and use it as the default binding for symbol.
56 Otherwise, VALUE will be evaluated and used as the default binding for
58 (eval `(defvar ,symbol
,(if (get symbol
'saved-value
)
59 (car (get symbol
'saved-value
))
62 (defun custom-initialize-set (symbol value
)
63 "Initialize SYMBOL based on VALUE.
64 If the symbol doesn't have a default binding already,
65 then set it using its `:set' function (or `set-default' if it has none).
66 The value is either the value in the symbol's `saved-value' property,
68 (unless (default-boundp symbol
)
69 (funcall (or (get symbol
'custom-set
) 'set-default
)
71 (eval (if (get symbol
'saved-value
)
72 (car (get symbol
'saved-value
))
75 (defun custom-initialize-reset (symbol value
)
76 "Initialize SYMBOL based on VALUE.
77 Set the symbol, using its `:set' function (or `set-default' if it has none).
78 The value is either the symbol's current value
79 \(as obtained using the `:get' function), if any,
80 or the value in the symbol's `saved-value' property if any,
81 or (last of all) VALUE."
82 (funcall (or (get symbol
'custom-set
) 'set-default
)
84 (cond ((default-boundp symbol
)
85 (funcall (or (get symbol
'custom-get
) 'default-value
)
87 ((get symbol
'saved-value
)
88 (eval (car (get symbol
'saved-value
))))
92 (defun custom-initialize-changed (symbol value
)
93 "Initialize SYMBOL with VALUE.
94 Like `custom-initialize-reset', but only use the `:set' function if
95 not using the standard setting.
96 For the standard setting, use `set-default'."
97 (cond ((default-boundp symbol
)
98 (funcall (or (get symbol
'custom-set
) 'set-default
)
100 (funcall (or (get symbol
'custom-get
) 'default-value
)
102 ((get symbol
'saved-value
)
103 (funcall (or (get symbol
'custom-set
) 'set-default
)
105 (eval (car (get symbol
'saved-value
)))))
107 (set-default symbol
(eval value
)))))
109 (defvar custom-delayed-init-variables nil
110 "List of variables whose initialization is pending.")
112 (defun custom-initialize-delay (symbol _value
)
113 "Delay initialization of SYMBOL to the next Emacs start.
114 This is used in files that are preloaded (or for autoloaded
115 variables), so that the initialization is done in the run-time
116 context rather than the build-time context. This also has the
117 side-effect that the (delayed) initialization is performed with
120 For variables in preloaded files, you can simply use this
121 function for the :initialize property. For autoloaded variables,
122 you will also need to add an autoload stanza calling this
123 function, and another one setting the standard-value property."
125 ;; "See `send-mail-function' in sendmail.el for an example."
127 ;; Until the var is actually initialized, it is kept unbound.
128 ;; This seemed to be at least as good as setting it to an arbitrary
129 ;; value like nil (evaluating `value' is not an option because it
130 ;; may have undesirable side-effects).
131 (push symbol custom-delayed-init-variables
))
133 (defun custom-declare-variable (symbol default doc
&rest args
)
134 "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments.
135 DEFAULT should be an expression to evaluate to compute the default value,
136 not the default value itself.
138 DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property
139 `standard-value'. At the same time, SYMBOL's property `force-value' is
140 set to nil, as the value is no longer rogue."
141 (put symbol
'standard-value
(purecopy (list default
)))
142 ;; Maybe this option was rogue in an earlier version. It no longer is.
143 (when (get symbol
'force-value
)
144 (put symbol
'force-value nil
))
146 (error "Doc string is missing"))
147 (let ((initialize 'custom-initialize-reset
)
149 (unless (memq :group args
)
150 (custom-add-to-group (custom-current-group) symbol
'custom-variable
))
152 (let ((arg (car args
)))
153 (setq args
(cdr args
))
154 (unless (symbolp arg
)
155 (error "Junk in args %S" args
))
159 (error "Keyword %s is missing an argument" keyword
))
160 (setq args
(cdr args
))
161 (cond ((eq keyword
:initialize
)
162 (setq initialize value
))
164 (put symbol
'custom-set value
))
166 (put symbol
'custom-get value
))
167 ((eq keyword
:require
)
168 (push value requests
))
170 (put symbol
'risky-local-variable value
))
172 (put symbol
'safe-local-variable value
))
174 (put symbol
'custom-type
(purecopy value
)))
175 ((eq keyword
:options
)
176 (if (get symbol
'custom-options
)
177 ;; Slow safe code to avoid duplicates.
178 (mapc (lambda (option)
179 (custom-add-option symbol option
))
181 ;; Fast code for the common case.
182 (put symbol
'custom-options
(copy-sequence value
))))
184 (custom-handle-keyword symbol keyword value
185 'custom-variable
))))))
186 (put symbol
'custom-requests requests
)
187 ;; Do the actual initialization.
188 (unless custom-dont-initialize
189 (funcall initialize symbol default
)))
190 ;; Use defvar to set the docstring as well as the special-variable-p flag.
191 ;; FIXME: We should reproduce more of `defvar's behavior, such as the warning
192 ;; when the var is currently let-bound.
193 (if (not (default-boundp symbol
))
194 ;; Don't use defvar to avoid setting a default-value when undesired.
195 (when doc
(put symbol
'variable-documentation doc
))
196 (eval `(defvar ,symbol nil
,@(when doc
(list doc
)))))
197 (push symbol current-load-list
)
198 (run-hooks 'custom-define-hook
)
201 (defmacro defcustom
(symbol standard doc
&rest args
)
202 "Declare SYMBOL as a customizable variable.
203 SYMBOL is the variable name; it should not be quoted.
204 STANDARD is an expression specifying the variable's standard
205 value. It should not be quoted. It is evaluated once by
206 `defcustom', and the value is assigned to SYMBOL if the variable
207 is unbound. The expression itself is also stored, so that
208 Customize can re-evaluate it later to get the standard value.
209 DOC is the variable documentation.
211 This macro uses `defvar' as a subroutine, which also marks the
212 variable as \"special\", so that it is always dynamically bound
213 even when `lexical-binding' is t.
215 The remaining arguments to `defcustom' should have the form
219 The following keywords are meaningful:
221 :type VALUE should be a widget type for editing the symbol's value.
222 :options VALUE should be a list of valid members of the widget type.
224 VALUE should be a function used to initialize the
225 variable. It takes two arguments, the symbol and value
226 given in the `defcustom' call. The default is
227 `custom-initialize-reset'.
228 :set VALUE should be a function to set the value of the symbol
229 when using the Customize user interface.
230 It takes two arguments, the symbol to set and the value to
231 give it. The default choice of function is `set-default'.
232 :get VALUE should be a function to extract the value of symbol.
233 The function takes one argument, a symbol, and should return
234 the current value for that symbol. The default choice of function
237 VALUE should be a feature symbol. If you save a value
238 for this option, then when your `.emacs' file loads the value,
239 it does (require VALUE) first.
241 Specifies that SYMBOL should be set after the list of variables
242 VARIABLES when both have been customized.
243 :risky Set SYMBOL's `risky-local-variable' property to VALUE.
244 :safe Set SYMBOL's `safe-local-variable' property to VALUE.
245 See Info node `(elisp) File Local Variables'.
247 The following common keywords are also meaningful.
249 :group VALUE should be a customization group.
250 Add SYMBOL (or FACE with `defface') to that group.
252 Include an external link after the documentation string for this
253 item. This is a sentence containing an active field which
254 references some other documentation.
256 There are several alternatives you can use for LINK-DATA:
258 (custom-manual INFO-NODE)
259 Link to an Info node; INFO-NODE is a string which specifies
260 the node name, as in \"(emacs)Top\".
262 (info-link INFO-NODE)
263 Like `custom-manual' except that the link appears in the
264 customization buffer with the Info node name.
267 Link to a web page; URL is a string which specifies the URL.
269 (emacs-commentary-link LIBRARY)
270 Link to the commentary section of LIBRARY.
272 (emacs-library-link LIBRARY)
273 Link to an Emacs Lisp LIBRARY file.
278 (function-link FUNCTION)
279 Link to the documentation of FUNCTION.
281 (variable-link VARIABLE)
282 Link to the documentation of VARIABLE.
284 (custom-group-link GROUP)
285 Link to another customization GROUP.
287 You can specify the text to use in the customization buffer by
288 adding `:tag NAME' after the first element of the LINK-DATA; for
289 example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the
290 Emacs manual which appears in the buffer as `foo'.
292 An item can have more than one external link; however, most items
295 VALUE should be a string specifying that the variable was
296 first introduced, or its default value was changed, in Emacs
299 VALUE should be a list with the form (PACKAGE . VERSION)
300 specifying that the variable was first introduced, or its
301 default value was changed, in PACKAGE version VERSION. This
302 keyword takes priority over :version. The PACKAGE and VERSION
303 must appear in the alist `customize-package-emacs-version-alist'.
304 Since PACKAGE must be unique and the user might see it in an
305 error message, a good choice is the official name of the
306 package, such as MH-E or Gnus.
308 Use LABEL, a string, instead of the item's name, to label the item
309 in customization menus and buffers.
311 Load file FILE (a string) before displaying this customization
312 item. Loading is done with `load', and only if the file is
315 If SYMBOL has a local binding, then this form affects the local
316 binding. This is normally not what you want. Thus, if you need
317 to load a file defining variables with this form, or with
318 `defvar' or `defconst', you should always load that file
319 _outside_ any bindings for these variables. \(`defvar' and
320 `defconst' behave similarly in this respect.)
322 See Info node `(elisp) Customization' in the Emacs Lisp manual
323 for more information."
324 (declare (doc-string 3) (debug (name body
)))
325 ;; It is better not to use backquote in this file,
326 ;; because that makes a bootstrapping problem
327 ;; if you need to recompile all the Lisp files using interpreted code.
328 `(custom-declare-variable
330 ,(if lexical-binding
;FIXME: This is not reliable, but is all we have.
331 ;; The STANDARD arg should be an expression that evaluates to
332 ;; the standard value. The use of `eval' for it is spread
333 ;; over many different places and hence difficult to
334 ;; eliminate, yet we want to make sure that the `standard'
335 ;; expression is checked by the byte-compiler, and that
336 ;; lexical-binding is obeyed, so quote the expression with
337 ;; `lambda' rather than with `quote'.
338 `(list (lambda () ,standard
))
343 ;;; The `defface' Macro.
345 (defmacro defface
(face spec doc
&rest args
)
346 "Declare FACE as a customizable face that defaults to SPEC.
347 FACE does not need to be quoted.
349 Third argument DOC is the face documentation.
351 If FACE has been set with `custom-set-faces', set the face attributes
352 as specified by that function, otherwise set the face attributes
355 The remaining arguments should have the form
359 For a list of valid keywords, see the common keywords listed in
362 SPEC should be an alist of the form ((DISPLAY ATTS)...).
364 In the first element, DISPLAY can be `default'. The ATTS in that
365 element then act as defaults for all the following elements.
367 Aside from that, DISPLAY specifies conditions to match some or
368 all frames. For each frame, the first element of SPEC where the
369 DISPLAY conditions are satisfied is the one that applies to that
370 frame. The ATTRs in this element take effect, and the following
371 elements are ignored, on that frame.
373 In the last element, DISPLAY can be t. That element applies to a
374 frame if none of the previous elements (except the `default' if
377 ATTS is a list of face attributes followed by their values:
378 (ATTR VALUE ATTR VALUE...)
380 The possible attributes are `:family', `:width', `:height', `:weight',
381 `:slant', `:underline', `:overline', `:strike-through', `:box',
382 `:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'.
384 DISPLAY can be `default' (only in the first element), the symbol
385 t (only in the last element) to match all frames, or an alist of
386 conditions of the form \(REQ ITEM...). For such an alist to
387 match a frame, each of the conditions must be satisfied, meaning
388 that the REQ property of the frame must match one of the
389 corresponding ITEMs. These are the defined REQ values:
391 `type' (the value of `window-system')
392 Under X, in addition to the values `window-system' can take,
393 `motif', `lucid', `gtk' and `x-toolkit' are allowed, and match when
394 the Motif toolkit, Lucid toolkit, GTK toolkit or any X toolkit is in use.
396 `class' (the frame's color support)
397 Should be one of `color', `grayscale', or `mono'.
399 `background' (what color is used for the background text)
400 Should be one of `light' or `dark'.
402 `min-colors' (the minimum number of colors the frame should support)
403 Should be an integer, it is compared with the result of
404 `display-color-cells'.
406 `supports' (only match frames that support the specified face attributes)
407 Should be a list of face attributes. See the documentation for
408 the function `display-supports-face-attributes-p' for more
409 information on exactly how testing is done.
411 See Info node `(elisp) Customization' in the Emacs Lisp manual
412 for more information."
413 (declare (doc-string 3))
414 ;; It is better not to use backquote in this file,
415 ;; because that makes a bootstrapping problem
416 ;; if you need to recompile all the Lisp files using interpreted code.
417 (nconc (list 'custom-declare-face
(list 'quote face
) spec doc
) args
))
419 ;;; The `defgroup' Macro.
421 (defun custom-current-group ()
422 (cdr (assoc load-file-name custom-current-group-alist
)))
424 (defun custom-declare-group (symbol members doc
&rest args
)
425 "Like `defgroup', but SYMBOL is evaluated as a normal argument."
427 (apply 'custom-add-to-group symbol
(car members
))
428 (setq members
(cdr members
)))
430 ;; This text doesn't get into DOC.
431 (put symbol
'group-documentation
(purecopy doc
)))
433 (let ((arg (car args
)))
434 (setq args
(cdr args
))
435 (unless (symbolp arg
)
436 (error "Junk in args %S" args
))
440 (error "Keyword %s is missing an argument" keyword
))
441 (setq args
(cdr args
))
442 (cond ((eq keyword
:prefix
)
443 (put symbol
'custom-prefix
(purecopy value
)))
445 (custom-handle-keyword symbol keyword value
447 ;; Record the group on the `current' list.
448 (let ((elt (assoc load-file-name custom-current-group-alist
)))
449 (if elt
(setcdr elt symbol
)
450 (push (cons (purecopy load-file-name
) symbol
)
451 custom-current-group-alist
)))
452 (run-hooks 'custom-define-hook
)
455 (defmacro defgroup
(symbol members doc
&rest args
)
456 "Declare SYMBOL as a customization group containing MEMBERS.
457 SYMBOL does not need to be quoted.
459 Third argument DOC is the group documentation. This should be a short
460 description of the group, beginning with a capital and ending with
461 a period. Words other than the first should not be capitalized, if they
462 are not usually written so.
464 MEMBERS should be an alist of the form ((NAME WIDGET)...) where
465 NAME is a symbol and WIDGET is a widget for editing that symbol.
466 Useful widgets are `custom-variable' for editing variables,
467 `custom-face' for edit faces, and `custom-group' for editing groups.
469 The remaining arguments should have the form
473 For a list of valid keywords, see the common keywords listed in
476 See Info node `(elisp) Customization' in the Emacs Lisp manual
477 for more information."
478 (declare (doc-string 3))
479 ;; It is better not to use backquote in this file,
480 ;; because that makes a bootstrapping problem
481 ;; if you need to recompile all the Lisp files using interpreted code.
482 (nconc (list 'custom-declare-group
(list 'quote symbol
) members doc
) args
))
484 (defun custom-add-to-group (group option widget
)
485 "To existing GROUP add a new OPTION of type WIDGET.
486 If there already is an entry for OPTION and WIDGET, nothing is done."
487 (let ((members (get group
'custom-group
))
488 (entry (list option widget
)))
489 (unless (member entry members
)
490 (put group
'custom-group
(nconc members
(list entry
))))))
492 (defun custom-group-of-mode (mode)
493 "Return the custom group corresponding to the major or minor MODE.
494 If no such group is found, return nil."
495 (or (get mode
'custom-mode-group
)
496 (if (or (get mode
'custom-group
)
497 (and (string-match "-mode\\'" (symbol-name mode
))
498 (get (setq mode
(intern (substring (symbol-name mode
)
499 0 (match-beginning 0))))
505 (defun custom-handle-all-keywords (symbol args type
)
506 "For customization option SYMBOL, handle keyword arguments ARGS.
507 Third argument TYPE is the custom option type."
508 (unless (memq :group args
)
509 (custom-add-to-group (custom-current-group) symbol type
))
511 (let ((arg (car args
)))
512 (setq args
(cdr args
))
513 (unless (symbolp arg
)
514 (error "Junk in args %S" args
))
518 (error "Keyword %s is missing an argument" keyword
))
519 (setq args
(cdr args
))
520 (custom-handle-keyword symbol keyword value type
)))))
522 (defun custom-handle-keyword (symbol keyword value type
)
523 "For customization option SYMBOL, handle KEYWORD with VALUE.
524 Fourth argument TYPE is the custom option type."
526 (setq value
(purecopy value
)))
527 (cond ((eq keyword
:group
)
528 (custom-add-to-group value symbol type
))
529 ((eq keyword
:version
)
530 (custom-add-version symbol value
))
531 ((eq keyword
:package-version
)
532 (custom-add-package-version symbol value
))
534 (custom-add-link symbol value
))
536 (custom-add-load symbol value
))
538 (put symbol
'custom-tag value
))
539 ((eq keyword
:set-after
)
540 (custom-add-dependencies symbol value
))
542 (error "Unknown keyword %s" keyword
))))
544 (defun custom-add-dependencies (symbol value
)
545 "To the custom option SYMBOL, add dependencies specified by VALUE.
546 VALUE should be a list of symbols. For each symbol in that list,
547 this specifies that SYMBOL should be set after the specified symbol, if
548 both appear in constructs like `custom-set-variables'."
549 (unless (listp value
)
550 (error "Invalid custom dependency `%s'" value
))
551 (let* ((deps (get symbol
'custom-dependencies
))
554 (let ((dep (car value
)))
555 (unless (symbolp dep
)
556 (error "Invalid custom dependency `%s'" dep
))
557 (unless (memq dep new-deps
)
558 (setq new-deps
(cons dep new-deps
)))
559 (setq value
(cdr value
))))
560 (unless (eq deps new-deps
)
561 (put symbol
'custom-dependencies new-deps
))))
563 (defun custom-add-option (symbol option
)
564 "To the variable SYMBOL add OPTION.
566 If SYMBOL's custom type is a hook, OPTION should be a hook member.
567 If SYMBOL's custom type is an alist, OPTION specifies a symbol
568 to offer to the user as a possible key in the alist.
569 For other custom types, this has no effect."
570 (let ((options (get symbol
'custom-options
)))
571 (unless (member option options
)
572 (put symbol
'custom-options
(cons option options
)))))
573 (defalias 'custom-add-frequent-value
'custom-add-option
)
575 (defun custom-add-link (symbol widget
)
576 "To the custom option SYMBOL add the link WIDGET."
577 (let ((links (get symbol
'custom-links
)))
578 (unless (member widget links
)
579 (put symbol
'custom-links
(cons (purecopy widget
) links
)))))
581 (defun custom-add-version (symbol version
)
582 "To the custom option SYMBOL add the version VERSION."
583 (put symbol
'custom-version
(purecopy version
)))
585 (defun custom-add-package-version (symbol version
)
586 "To the custom option SYMBOL add the package version VERSION."
587 (put symbol
'custom-package-version
(purecopy version
)))
589 (defun custom-add-load (symbol load
)
590 "To the custom option SYMBOL add the dependency LOAD.
591 LOAD should be either a library file name, or a feature name."
592 (let ((loads (get symbol
'custom-loads
)))
593 (unless (member load loads
)
594 (put symbol
'custom-loads
(cons (purecopy load
) loads
)))))
596 (defun custom-autoload (symbol load
&optional noset
)
597 "Mark SYMBOL as autoloaded custom variable and add dependency LOAD.
598 If NOSET is non-nil, don't bother autoloading LOAD when setting the variable."
599 (put symbol
'custom-autoload
(if noset
'noset t
))
600 (custom-add-load symbol load
))
602 ;; This test is also in the C code of `user-variable-p'.
603 (defun custom-variable-p (variable)
604 "Return non-nil if VARIABLE is a customizable variable.
605 A customizable variable is either (i) a variable whose property
606 list contains a non-nil `standard-value' or `custom-autoload'
607 property, or (ii) an alias for another customizable variable."
608 (setq variable
(indirect-variable variable
))
609 (or (get variable
'standard-value
)
610 (get variable
'custom-autoload
)))
612 (defun custom-note-var-changed (variable)
613 "Inform Custom that VARIABLE has been set (changed).
614 VARIABLE is a symbol that names a user option.
615 The result is that the change is treated as having been made through Custom."
616 (put variable
'customized-value
(list (custom-quote (eval variable
)))))
621 ;;; Loading files needed to customize a symbol.
622 ;;; This is in custom.el because menu-bar.el needs it for toggle cmds.
624 (defvar custom-load-recursion nil
625 "Hack to avoid recursive dependencies.")
627 (defun custom-load-symbol (symbol)
628 "Load all dependencies for SYMBOL."
629 (unless custom-load-recursion
630 (let ((custom-load-recursion t
))
631 ;; Load these files if not already done,
632 ;; to make sure we know all the dependencies of SYMBOL.
639 (dolist (load (get symbol
'custom-loads
))
640 (cond ((symbolp load
) (condition-case nil
(require load
) (error nil
)))
641 ;; This is subsumed by the test below, but it's much faster.
642 ((assoc load load-history
))
643 ;; This was just (assoc (locate-library load) load-history)
644 ;; but has been optimized not to load locate-library
646 ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load
)
649 (dolist (loaded load-history
)
650 (and (stringp (car loaded
))
651 (string-match regexp
(car loaded
))
654 ;; Without this, we would load cus-edit recursively.
655 ;; We are still loading it when we call this,
656 ;; and it is not in load-history yet.
657 ((equal load
"cus-edit"))
658 (t (condition-case nil
(load load
) (error nil
))))))))
660 (defvar custom-local-buffer nil
661 "Non-nil, in a Customization buffer, means customize a specific buffer.
662 If this variable is non-nil, it should be a buffer,
663 and it means customize the local bindings of that buffer.
664 This variable is a permanent local, and it normally has a local binding
665 in every Customization buffer.")
666 (put 'custom-local-buffer
'permanent-local t
)
668 (defun custom-set-default (variable value
)
669 "Default :set function for a customizable variable.
670 Normally, this sets the default value of VARIABLE to VALUE,
671 but if `custom-local-buffer' is non-nil,
672 this sets the local binding in that buffer instead."
673 (if custom-local-buffer
674 (with-current-buffer custom-local-buffer
675 (set variable value
))
676 (set-default variable value
)))
678 (defun custom-set-minor-mode (variable value
)
679 ":set function for minor mode variables.
680 Normally, this sets the default value of VARIABLE to nil if VALUE
681 is nil and to t otherwise,
682 but if `custom-local-buffer' is non-nil,
683 this sets the local binding in that buffer instead."
684 (if custom-local-buffer
685 (with-current-buffer custom-local-buffer
686 (funcall variable
(if value
1 0)))
687 (funcall variable
(if value
1 0))))
689 (defun custom-quote (sexp)
690 "Quote SEXP if it is not self quoting."
691 (if (or (memq sexp
'(t nil
))
694 (memq (car sexp
) '(lambda)))
698 ;;; (and (fboundp 'characterp)
699 ;;; (characterp sexp))
704 (defun customize-mark-to-save (symbol)
705 "Mark SYMBOL for later saving.
707 If the default value of SYMBOL is different from the standard value,
708 set the `saved-value' property to a list whose car evaluates to the
709 default value. Otherwise, set it to nil.
711 To actually save the value, call `custom-save-all'.
713 Return non-nil if the `saved-value' property actually changed."
714 (custom-load-symbol symbol
)
715 (let* ((get (or (get symbol
'custom-get
) 'default-value
))
716 (value (funcall get symbol
))
717 (saved (get symbol
'saved-value
))
718 (standard (get symbol
'standard-value
))
719 (comment (get symbol
'customized-variable-comment
)))
720 ;; Save default value if different from standard value.
721 (if (or (null standard
)
722 (not (equal value
(condition-case nil
723 (eval (car standard
))
725 (put symbol
'saved-value
(list (custom-quote value
)))
726 (put symbol
'saved-value nil
))
727 ;; Clear customized information (set, but not saved).
728 (put symbol
'customized-value nil
)
729 ;; Save any comment that might have been set.
731 (put symbol
'saved-variable-comment comment
))
732 (not (equal saved
(get symbol
'saved-value
)))))
734 (defun customize-mark-as-set (symbol)
735 "Mark current value of SYMBOL as being set from customize.
737 If the default value of SYMBOL is different from the saved value if any,
738 or else if it is different from the standard value, set the
739 `customized-value' property to a list whose car evaluates to the
740 default value. Otherwise, set it to nil.
742 Return non-nil if the `customized-value' property actually changed."
743 (custom-load-symbol symbol
)
744 (let* ((get (or (get symbol
'custom-get
) 'default-value
))
745 (value (funcall get symbol
))
746 (customized (get symbol
'customized-value
))
747 (old (or (get symbol
'saved-value
) (get symbol
'standard-value
))))
748 ;; Mark default value as set if different from old value.
750 (equal value
(condition-case nil
753 (progn (put symbol
'customized-value
(list (custom-quote value
)))
754 (custom-push-theme 'theme-value symbol
'user
'set
755 (custom-quote value
)))
756 (put symbol
'customized-value nil
))
758 (not (equal customized
(get symbol
'customized-value
)))))
760 (defun custom-reevaluate-setting (symbol)
761 "Reset the value of SYMBOL by re-evaluating its saved or standard value.
762 Use the :set function to do so. This is useful for customizable options
763 that are defined before their standard value can really be computed.
764 E.g. dumped variables whose default depends on run-time information."
765 (funcall (or (get symbol
'custom-set
) 'set-default
)
767 (eval (car (or (get symbol
'saved-value
) (get symbol
'standard-value
))))))
772 ;; Custom themes are collections of settings that can be enabled or
773 ;; disabled as a unit.
775 ;; Each Custom theme is defined by a symbol, called the theme name.
776 ;; The `theme-settings' property of the theme name records the
777 ;; variable and face settings of the theme. This property is a list
778 ;; of elements, each of the form
780 ;; (PROP SYMBOL THEME VALUE)
782 ;; - PROP is either `theme-value' or `theme-face'
783 ;; - SYMBOL is the face or variable name
784 ;; - THEME is the theme name (redundant, but simplifies the code)
785 ;; - VALUE is an expression that gives the theme's setting for SYMBOL.
787 ;; The theme name also has a `theme-feature' property, whose value is
788 ;; specified when the theme is defined (see `custom-declare-theme').
789 ;; Usually, this is just a symbol named THEME-theme. This lets
790 ;; external libraries call (require 'foo-theme).
792 ;; In addition, each symbol (either a variable or a face) affected by
793 ;; an *enabled* theme has a `theme-value' or `theme-face' property,
794 ;; which is a list of elements each of the form
798 ;; which have the same meanings as in `theme-settings'.
800 ;; The `theme-value' and `theme-face' lists are ordered by decreasing
801 ;; theme precedence. Thus, the first element is always the one that
804 ;; Each theme is stored in a theme file, with filename THEME-theme.el.
805 ;; Loading a theme basically involves calling (load "THEME-theme")
806 ;; This is done by the function `load-theme'. Loading a theme
807 ;; automatically enables it.
809 ;; When a theme is enabled, the `theme-value' and `theme-face'
810 ;; properties for the affected symbols are set. When a theme is
811 ;; disabled, its settings are removed from the `theme-value' and
812 ;; `theme-face' properties, but the theme's own `theme-settings'
813 ;; property remains unchanged.
815 (defvar custom-known-themes
'(user changed
)
816 "Themes that have been defined with `deftheme'.
817 The default value is the list (user changed). The theme `changed'
818 contains the settings before custom themes are applied. The theme
819 `user' contains all the settings the user customized and saved.
820 Additional themes declared with the `deftheme' macro will be added
821 to the front of this list.")
823 (defsubst custom-theme-p
(theme)
824 "Non-nil when THEME has been defined."
825 (memq theme custom-known-themes
))
827 (defsubst custom-check-theme
(theme)
828 "Check whether THEME is valid, and signal an error if it is not."
829 (unless (custom-theme-p theme
)
830 (error "Unknown theme `%s'" theme
)))
832 (defun custom-push-theme (prop symbol theme mode
&optional value
)
833 "Record VALUE for face or variable SYMBOL in custom theme THEME.
834 PROP is `theme-face' for a face, `theme-value' for a variable.
836 MODE can be either the symbol `set' or the symbol `reset'. If it is the
837 symbol `set', then VALUE is the value to use. If it is the symbol
838 `reset', then SYMBOL will be removed from THEME (VALUE is ignored).
840 See `custom-known-themes' for a list of known themes."
841 (unless (memq prop
'(theme-value theme-face
))
842 (error "Unknown theme property"))
843 (let* ((old (get symbol prop
))
844 (setting (assq theme old
)) ; '(theme value)
845 (theme-settings ; '(prop symbol theme value)
846 (get theme
'theme-settings
)))
852 (dolist (theme-setting theme-settings
)
853 (if (and (eq (car theme-setting
) prop
)
854 (eq (cadr theme-setting
) symbol
))
855 (setq res theme-setting
)))
856 (put theme
'theme-settings
(delq res theme-settings
)))
857 (put symbol prop
(delq setting old
))))
858 ;; Alter an existing setting:
861 (dolist (theme-setting theme-settings
)
862 (if (and (eq (car theme-setting
) prop
)
863 (eq (cadr theme-setting
) symbol
))
864 (setq res theme-setting
)))
865 (put theme
'theme-settings
866 (cons (list prop symbol theme value
)
867 (delq res theme-settings
)))
868 (setcar (cdr setting
) value
)))
869 ;; Add a new setting:
872 ;; If the user changed a variable outside of Customize, save
873 ;; the value to a fake theme, `changed'. If the theme is
874 ;; later disabled, we use this to bring back the old value.
876 ;; For faces, we just use `face-new-frame-defaults' to
877 ;; recompute when the theme is disabled.
878 (when (and (eq prop
'theme-value
)
880 (let ((sv (get symbol
'standard-value
))
881 (val (symbol-value symbol
)))
882 (unless (and sv
(equal (eval (car sv
)) val
))
883 (setq old
`((changed ,(custom-quote val
))))))))
884 (put symbol prop
(cons (list theme value
) old
))
885 (put theme
'theme-settings
886 (cons (list prop symbol theme value
) theme-settings
))))))
888 (defun custom-fix-face-spec (spec)
889 "Convert face SPEC, replacing obsolete :bold and :italic attributes.
890 Also change :reverse-video to :inverse-video."
892 (if (or (memq :bold spec
)
894 (memq :inverse-video spec
))
897 (let ((key (car spec
))
898 (val (car (cdr spec
))))
899 (cond ((eq key
:italic
)
901 (push (if val
'italic
'normal
) result
))
903 (push :weight result
)
904 (push (if val
'bold
'normal
) result
))
905 ((eq key
:reverse-video
)
906 (push :inverse-video result
)
911 (setq spec
(cddr spec
)))
915 (defun custom-set-variables (&rest args
)
916 "Install user customizations of variable values specified in ARGS.
917 These settings are registered as theme `user'.
918 The arguments should each be a list of the form:
920 (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
922 This stores EXP (without evaluating it) as the saved value for SYMBOL.
923 If NOW is present and non-nil, then also evaluate EXP and set
924 the default value for the SYMBOL to the value of EXP.
926 REQUEST is a list of features we must require in order to
927 handle SYMBOL properly.
928 COMMENT is a comment string about SYMBOL."
929 (apply 'custom-theme-set-variables
'user args
))
931 (defun custom-theme-set-variables (theme &rest args
)
932 "Initialize variables for theme THEME according to settings in ARGS.
933 Each of the arguments in ARGS should be a list of this form:
935 (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
937 This stores EXP (without evaluating it) as the saved value for SYMBOL.
938 If NOW is present and non-nil, then also evaluate EXP and set
939 the default value for the SYMBOL to the value of EXP.
941 REQUEST is a list of features we must require in order to
942 handle SYMBOL properly.
943 COMMENT is a comment string about SYMBOL.
945 EXP itself is saved unevaluated as SYMBOL property `saved-value' and
946 in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
947 (custom-check-theme theme
)
949 ;; Process all the needed autoloads before anything else, so that the
950 ;; subsequent code has all the info it needs (e.g. which var corresponds
951 ;; to a minor mode), regardless of the ordering of the variables.
953 (let* ((symbol (indirect-variable (nth 0 entry
))))
954 (unless (or (get symbol
'standard-value
)
955 (memq (get symbol
'custom-autoload
) '(nil noset
)))
956 ;; This symbol needs to be autoloaded, even just for a `set'.
957 (custom-load-symbol symbol
))))
959 ;; Move minor modes and variables with explicit requires to the end.
963 (let* ((sym1 (car a1
))
965 (1-then-2 (memq sym1
(get sym2
'custom-dependencies
)))
966 (2-then-1 (memq sym2
(get sym1
'custom-dependencies
))))
967 (cond ((and 1-then-2
2-then-1
)
968 (error "Circular custom dependency between `%s' and `%s'"
971 ;; 1 is a dependency of 2, so needs to be set first.
973 ;; Put minor modes and symbols with :require last.
974 ;; Putting minor modes last ensures that the mode
975 ;; function will see other customized values rather
976 ;; than default values.
978 (eq (get sym2
'custom-set
)
979 'custom-set-minor-mode
))))))))
982 (unless (listp entry
)
983 (error "Incompatible Custom theme spec"))
984 (let* ((symbol (indirect-variable (nth 0 entry
)))
985 (value (nth 1 entry
)))
986 (custom-push-theme 'theme-value symbol theme
'set value
)
987 (unless custom--inhibit-theme-enable
988 ;; Now set the variable.
989 (let* ((now (nth 2 entry
))
990 (requests (nth 3 entry
))
991 (comment (nth 4 entry
))
994 (put symbol
'custom-requests requests
)
995 (mapc 'require requests
))
996 (setq set
(or (get symbol
'custom-set
) 'custom-set-default
))
997 (put symbol
'saved-value
(list value
))
998 (put symbol
'saved-variable-comment comment
)
999 ;; Allow for errors in the case where the setter has
1000 ;; changed between versions, say, but let the user know.
1001 (condition-case data
1003 ;; Rogue variable, set it now.
1004 (put symbol
'force-value t
)
1005 (funcall set symbol
(eval value
)))
1006 ((default-boundp symbol
)
1007 ;; Something already set this, overwrite it.
1008 (funcall set symbol
(eval value
))))
1010 (message "Error setting %s: %s" symbol data
)))
1011 (and (or now
(default-boundp symbol
))
1012 (put symbol
'variable-comment comment
)))))))
1015 ;;; Defining themes.
1017 ;; A theme file is named `THEME-theme.el' (where THEME is the theme
1018 ;; name) found in `custom-theme-load-path'. It has this format:
1023 ;; (custom-theme-set-variables
1025 ;; [THEME-VARIABLES])
1027 ;; (custom-theme-set-faces
1031 ;; (provide-theme 'THEME)
1034 ;; The IGNORED arguments to deftheme come from the XEmacs theme code, where
1035 ;; they were used to supply keyword-value pairs like `:immediate',
1036 ;; `:variable-reset-string', etc. We don't use any of these, so ignore them.
1038 (defmacro deftheme
(theme &optional doc
&rest ignored
)
1039 "Declare THEME to be a Custom theme.
1040 The optional argument DOC is a doc string describing the theme.
1042 Any theme `foo' should be defined in a file called `foo-theme.el';
1043 see `custom-make-theme-feature' for more information."
1044 (let ((feature (custom-make-theme-feature theme
)))
1045 ;; It is better not to use backquote in this file,
1046 ;; because that makes a bootstrapping problem
1047 ;; if you need to recompile all the Lisp files using interpreted code.
1048 (list 'custom-declare-theme
(list 'quote theme
) (list 'quote feature
) doc
)))
1050 (defun custom-declare-theme (theme feature
&optional doc
&rest ignored
)
1051 "Like `deftheme', but THEME is evaluated as a normal argument.
1052 FEATURE is the feature this theme provides. Normally, this is a symbol
1053 created from THEME by `custom-make-theme-feature'."
1054 (unless (custom-theme-name-valid-p theme
)
1055 (error "Custom theme cannot be named %S" theme
))
1056 (add-to-list 'custom-known-themes theme
)
1057 (put theme
'theme-feature feature
)
1058 (when doc
(put theme
'theme-documentation doc
)))
1060 (defun custom-make-theme-feature (theme)
1061 "Given a symbol THEME, create a new symbol by appending \"-theme\".
1062 Store this symbol in the `theme-feature' property of THEME.
1063 Calling `provide-theme' to provide THEME actually puts `THEME-theme'
1066 This allows for a file-name convention for autoloading themes:
1067 Every theme X has a property `provide-theme' whose value is \"X-theme\".
1068 \(load-theme X) then attempts to load the file `X-theme.el'."
1069 (intern (concat (symbol-name theme
) "-theme")))
1073 (defcustom custom-theme-directory user-emacs-directory
1074 "Default user directory for storing custom theme files.
1075 The command `customize-create-theme' writes theme files into this
1076 directory. By default, Emacs searches for custom themes in this
1077 directory first---see `custom-theme-load-path'."
1082 (defcustom custom-theme-load-path
(list 'custom-theme-directory t
)
1083 "List of directories to search for custom theme files.
1084 When loading custom themes (e.g. in `customize-themes' and
1085 `load-theme'), Emacs searches for theme files in the specified
1086 order. Each element in the list should be one of the following:
1087 - the symbol `custom-theme-directory', meaning the value of
1088 `custom-theme-directory'.
1089 - the symbol t, meaning the built-in theme directory (a directory
1090 named \"themes\" in `data-directory').
1091 - a directory name (a string).
1093 Each theme file is named THEME-theme.el, where THEME is the theme
1095 :type
'(repeat (choice (const :tag
"custom-theme-directory"
1096 custom-theme-directory
)
1097 (const :tag
"Built-in theme directory" t
)
1102 (defvar custom--inhibit-theme-enable nil
1103 "Whether the custom-theme-set-* functions act immediately.
1104 If nil, `custom-theme-set-variables' and `custom-theme-set-faces'
1105 change the current values of the given variable or face. If
1106 non-nil, they just make a record of the theme settings.")
1108 (defun provide-theme (theme)
1109 "Indicate that this file provides THEME.
1110 This calls `provide' to provide the feature name stored in THEME's
1111 property `theme-feature' (which is usually a symbol created by
1112 `custom-make-theme-feature')."
1113 (unless (custom-theme-name-valid-p theme
)
1114 (error "Custom theme cannot be named %S" theme
))
1115 (custom-check-theme theme
)
1116 (provide (get theme
'theme-feature
)))
1118 (defcustom custom-safe-themes
'(default)
1119 "Themes that are considered safe to load.
1120 If the value is a list, each element should be either the SHA-256
1121 hash of a safe theme file, or the symbol `default', which stands
1122 for any theme in the built-in Emacs theme directory (a directory
1123 named \"themes\" in `data-directory').
1125 If the value is t, Emacs treats all themes as safe.
1127 This variable cannot be set in a Custom theme."
1128 :type
'(choice (repeat :tag
"List of safe themes"
1130 (const :tag
"Built-in themes" default
)))
1131 (const :tag
"All themes" t
))
1136 (defun load-theme (theme &optional no-confirm no-enable
)
1137 "Load Custom theme named THEME from its file.
1138 The theme file is named THEME-theme.el, in one of the directories
1139 specified by `custom-theme-load-path'.
1141 If optional arg NO-CONFIRM is non-nil, and THEME is not
1142 considered safe according to `custom-safe-themes', prompt the
1143 user for confirmation.
1145 Normally, this function also enables THEME; if optional arg
1146 NO-ENABLE is non-nil, load the theme but don't enable it.
1148 This function is normally called through Customize when setting
1149 `custom-enabled-themes'. If used directly in your init file, it
1150 should be called with a non-nil NO-CONFIRM argument, or after
1151 `custom-safe-themes' has been loaded.
1153 Return t if THEME was successfully loaded, nil otherwise."
1156 (intern (completing-read "Load custom theme: "
1157 (mapcar 'symbol-name
1158 (custom-available-themes))))
1160 (unless (custom-theme-name-valid-p theme
)
1161 (error "Invalid theme name `%s'" theme
))
1162 ;; If reloading, clear out the old theme settings.
1163 (when (custom-theme-p theme
)
1164 (disable-theme theme
)
1165 (put theme
'theme-settings nil
)
1166 (put theme
'theme-feature nil
)
1167 (put theme
'theme-documentation nil
))
1168 (let ((fn (locate-file (concat (symbol-name theme
) "-theme.el")
1169 (custom-theme--load-path)
1173 (error "Unable to find theme file for `%s'" theme
))
1175 (insert-file-contents fn
)
1176 (setq hash
(secure-hash 'sha256
(current-buffer)))
1177 ;; Check file safety with `custom-safe-themes', prompting the
1178 ;; user if necessary.
1179 (when (or no-confirm
1180 (eq custom-safe-themes t
)
1181 (and (memq 'default custom-safe-themes
)
1182 (equal (file-name-directory fn
)
1183 (expand-file-name "themes/" data-directory
)))
1184 (member hash custom-safe-themes
)
1185 (custom-theme-load-confirm hash
))
1186 (let ((custom--inhibit-theme-enable t
))
1188 ;; Optimization: if the theme changes the `default' face, put that
1189 ;; entry first. This avoids some `frame-set-background-mode' rigmarole
1190 ;; by assigning the new background immediately.
1191 (let* ((settings (get theme
'theme-settings
))
1194 (while (and tail
(not found
))
1195 (and (eq (nth 0 (car tail
)) 'theme-face
)
1196 (eq (nth 1 (car tail
)) 'default
)
1197 (setq found
(car tail
)))
1198 (setq tail
(cdr tail
)))
1200 (put theme
'theme-settings
(cons found
(delq found settings
)))))
1201 ;; Finally, enable the theme.
1203 (enable-theme theme
))
1206 (defun custom-theme-load-confirm (hash)
1207 "Query the user about loading a Custom theme that may not be safe.
1208 The theme should be in the current buffer. If the user agrees,
1209 query also about adding HASH to `custom-safe-themes'."
1212 (let ((exit-chars '(?y ?n ?\s
))
1214 (save-window-excursion
1215 (rename-buffer "*Custom Theme*" t
)
1217 (setq window
(display-buffer (current-buffer)))
1219 (format "Loading a theme can run Lisp code. Really load?%s"
1221 (< (line-number-at-pos (point-max))
1222 (window-body-height)))
1224 (push ?\C-v exit-chars
)
1225 "\nType y or n, or C-v to scroll: ")))
1226 (goto-char (point-min))
1228 (setq char
(read-char-choice prompt exit-chars
))
1229 (when (eq char ?\C-v
)
1231 (with-selected-window window
1234 (error (goto-char (point-min))))))
1236 (when (memq char
'(?\s ?y
))
1237 ;; Offer to save to `custom-safe-themes'.
1238 (and (or custom-file user-init-file
)
1239 (y-or-n-p "Treat this theme as safe in future sessions? ")
1240 (customize-push-and-save 'custom-safe-themes
(list hash
)))
1243 (defun custom-theme-name-valid-p (name)
1244 "Return t if NAME is a valid name for a Custom theme, nil otherwise.
1245 NAME should be a symbol."
1248 (not (or (zerop (length (symbol-name name
)))
1250 (eq name
'changed
)))))
1252 (defun custom-available-themes ()
1253 "Return a list of available Custom themes (symbols)."
1255 (dolist (dir (custom-theme--load-path))
1256 (when (file-directory-p dir
)
1257 (dolist (file (file-expand-wildcards
1258 (expand-file-name "*-theme.el" dir
) t
))
1259 (setq file
(file-name-nondirectory file
))
1260 (and (string-match "\\`\\(.+\\)-theme.el\\'" file
)
1261 (setq sym
(intern (match-string 1 file
)))
1262 (custom-theme-name-valid-p sym
)
1263 (push sym themes
)))))
1264 (nreverse (delete-dups themes
))))
1266 (defun custom-theme--load-path ()
1268 (dolist (f custom-theme-load-path
)
1269 (cond ((eq f
'custom-theme-directory
)
1270 (setq f custom-theme-directory
))
1272 (setq f
(expand-file-name "themes" data-directory
))))
1273 (if (file-directory-p f
)
1278 ;;; Enabling and disabling loaded themes.
1280 (defun enable-theme (theme)
1281 "Reenable all variable and face settings defined by THEME.
1282 THEME should be either `user', or a theme loaded via `load-theme'.
1283 After this function completes, THEME will have the highest
1284 precedence (after `user')."
1285 (interactive (list (intern
1287 "Enable custom theme: "
1288 obarray
(lambda (sym) (get sym
'theme-settings
)) t
))))
1289 (if (not (custom-theme-p theme
))
1290 (error "Undefined Custom theme %s" theme
))
1291 (let ((settings (get theme
'theme-settings
)))
1292 ;; Loop through theme settings, recalculating vars/faces.
1293 (dolist (s settings
)
1294 (let* ((prop (car s
))
1296 (spec-list (get symbol prop
)))
1297 (put symbol prop
(cons (cddr s
) (assq-delete-all theme spec-list
)))
1299 ((eq prop
'theme-face
)
1300 (custom-theme-recalc-face symbol
))
1301 ((eq prop
'theme-value
)
1302 ;; Ignore `custom-enabled-themes' and `custom-safe-themes'.
1303 (unless (memq symbol
'(custom-enabled-themes custom-safe-themes
))
1304 (custom-theme-recalc-variable symbol
)))))))
1305 (unless (eq theme
'user
)
1306 (setq custom-enabled-themes
1307 (cons theme
(delq theme custom-enabled-themes
)))
1308 ;; Give the `user' theme the highest priority.
1309 (enable-theme 'user
)))
1311 (defcustom custom-enabled-themes nil
1312 "List of enabled Custom Themes, highest precedence first.
1313 This list does not include the `user' theme, which is set by
1314 Customize and always takes precedence over other Custom Themes.
1316 This variable cannot be defined inside a Custom theme; there, it
1319 Setting this variable through Customize calls `enable-theme' or
1320 `load-theme' for each theme in the list."
1322 :type
'(repeat symbol
)
1323 :set-after
'(custom-theme-directory custom-theme-load-path
1326 :set
(lambda (symbol themes
)
1328 (setq themes
(delq 'user
(delete-dups themes
)))
1329 ;; Disable all themes not in THEMES.
1331 (dolist (theme (symbol-value symbol
))
1332 (if (not (memq theme themes
))
1333 (disable-theme theme
))))
1334 ;; Call `enable-theme' or `load-theme' on each of THEMES.
1335 (dolist (theme (reverse themes
))
1337 (if (custom-theme-p theme
)
1338 (enable-theme theme
)
1340 (error (setq failures
(cons theme failures
)
1341 themes
(delq theme themes
)))))
1342 (enable-theme 'user
)
1343 (custom-set-default symbol themes
)
1345 (message "Failed to enable theme: %s"
1346 (mapconcat 'symbol-name failures
", "))))))
1348 (defsubst custom-theme-enabled-p
(theme)
1349 "Return non-nil if THEME is enabled."
1350 (memq theme custom-enabled-themes
))
1352 (defun disable-theme (theme)
1353 "Disable all variable and face settings defined by THEME.
1354 See `custom-enabled-themes' for a list of enabled themes."
1355 (interactive (list (intern
1357 "Disable custom theme: "
1358 (mapcar 'symbol-name custom-enabled-themes
)
1360 (when (custom-theme-enabled-p theme
)
1361 (let ((settings (get theme
'theme-settings
)))
1362 (dolist (s settings
)
1363 (let* ((prop (car s
))
1365 (val (assq-delete-all theme
(get symbol prop
))))
1366 (put symbol prop val
)
1368 ((eq prop
'theme-value
)
1369 (custom-theme-recalc-variable symbol
))
1370 ((eq prop
'theme-face
)
1371 ;; If the face spec specified by this theme is in the
1372 ;; saved-face property, reset that property.
1373 (when (equal (nth 3 s
) (get symbol
'saved-face
))
1374 (put symbol
'saved-face
(and val
(cadr (car val
)))))))))
1375 ;; Recompute faces on all frames.
1376 (dolist (frame (frame-list))
1377 ;; We must reset the fg and bg color frame parameters, or
1378 ;; `face-set-after-frame-default' will use the existing
1379 ;; parameters, which could be from the disabled theme.
1380 (set-frame-parameter frame
'background-color
1381 (custom--frame-color-default
1382 frame
:background
"background" "Background"
1383 "unspecified-bg" "white"))
1384 (set-frame-parameter frame
'foreground-color
1385 (custom--frame-color-default
1386 frame
:foreground
"foreground" "Foreground"
1387 "unspecified-fg" "black"))
1388 (face-set-after-frame-default frame
))
1389 (setq custom-enabled-themes
1390 (delq theme custom-enabled-themes
)))))
1392 (defun custom--frame-color-default (frame attribute resource-attr resource-class
1393 tty-default x-default
)
1394 (let ((col (face-attribute 'default attribute t
)))
1396 ((and col
(not (eq col
'unspecified
))) col
)
1397 ((null (window-system frame
)) tty-default
)
1398 ((setq col
(x-get-resource resource-attr resource-class
)) col
)
1401 (defun custom-variable-theme-value (variable)
1402 "Return (list VALUE) indicating the custom theme value of VARIABLE.
1403 That is to say, it specifies what the value should be according to
1404 currently enabled custom themes.
1406 This function returns nil if no custom theme specifies a value for VARIABLE."
1407 (let ((theme-value (get variable
'theme-value
)))
1409 (cdr (car theme-value
)))))
1411 (defun custom-theme-recalc-variable (variable)
1412 "Set VARIABLE according to currently enabled custom themes."
1413 (let ((valspec (custom-variable-theme-value variable
)))
1415 (put variable
'saved-value valspec
)
1416 (setq valspec
(get variable
'standard-value
)))
1418 (or (get variable
'force-value
)
1419 (default-boundp variable
)))
1420 (funcall (or (get variable
'custom-set
) 'set-default
) variable
1421 (eval (car valspec
))))))
1423 (defun custom-theme-recalc-face (face)
1424 "Set FACE according to currently enabled custom themes."
1425 (if (get face
'face-alias
)
1426 (setq face
(get face
'face-alias
)))
1427 ;; Reset the faces for each frame.
1428 (dolist (frame (frame-list))
1429 (face-spec-recalc face frame
)))
1432 ;;; XEmacs compatibility functions
1434 ;; In XEmacs, when you reset a Custom Theme, you have to specify the
1435 ;; theme to reset it to. We just apply the next available theme, so
1436 ;; just ignore the IGNORED arguments.
1438 (defun custom-theme-reset-variables (theme &rest args
)
1439 "Reset some variable settings in THEME to their values in other themes.
1440 Each of the arguments ARGS has this form:
1444 This means reset VARIABLE. (The argument IGNORED is ignored)."
1445 (custom-check-theme theme
)
1447 (custom-push-theme 'theme-value
(car arg
) theme
'reset
)))
1449 (defun custom-reset-variables (&rest args
)
1450 "Reset the specs of some variables to their values in other themes.
1451 This creates settings in the `user' theme.
1453 Each of the arguments ARGS has this form:
1457 This means reset VARIABLE. (The argument IGNORED is ignored)."
1458 (apply 'custom-theme-reset-variables
'user args
))
1462 ;; Process the defcustoms for variables loaded before this file.
1463 (while custom-declare-variable-list
1464 (apply 'custom-declare-variable
(car custom-declare-variable-list
))
1465 (setq custom-declare-variable-list
(cdr custom-declare-variable-list
)))
1469 ;;; custom.el ends here