* lisp/emacs-lisp/package.el (package--prepare-dependencies):
[emacs.git] / lisp / custom.el
blob09431c454ec8209c8a434e4438ea528c21a2be85
1 ;;; custom.el --- tools for declaring and initializing options
2 ;;
3 ;; Copyright (C) 1996-1997, 1999, 2001-2014 Free Software Foundation,
4 ;; Inc.
5 ;;
6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: help, faces
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This file only contains the code needed to declare and initialize
29 ;; user options. The code to customize options is autoloaded from
30 ;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual.
32 ;; The code implementing face declarations is in `cus-face.el'.
34 ;;; Code:
36 (require 'widget)
38 (defvar custom-define-hook nil
39 ;; Customize information for this option is in `cus-edit.el'.
40 "Hook called after defining each customize option.")
42 (defvar custom-dont-initialize nil
43 "Non-nil means `defcustom' should not initialize the variable.
44 That is used for the sake of `custom-make-dependencies'.
45 Users should not set it.")
47 (defvar custom-current-group-alist nil
48 "Alist of (FILE . GROUP) indicating the current group to use for FILE.")
50 ;;; The `defcustom' Macro.
52 (defun custom-initialize-default (symbol exp)
53 "Initialize SYMBOL with EXP.
54 This will do nothing if symbol already has a default binding.
55 Otherwise, if symbol has a `saved-value' property, it will evaluate
56 the car of that and use it as the default binding for symbol.
57 Otherwise, EXP will be evaluated and used as the default binding for
58 symbol."
59 (eval `(defvar ,symbol ,(let ((sv (get symbol 'saved-value)))
60 (if sv (car sv) exp)))))
62 (defun custom-initialize-set (symbol exp)
63 "Initialize SYMBOL based on EXP.
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,
67 if any, or the value of EXP."
68 (condition-case nil
69 (default-toplevel-value symbol)
70 (error
71 (funcall (or (get symbol 'custom-set) #'set-default-toplevel-value)
72 symbol
73 (eval (let ((sv (get symbol 'saved-value)))
74 (if sv (car sv) exp)))))))
76 (defun custom-initialize-reset (symbol exp)
77 "Initialize SYMBOL based on EXP.
78 Set the symbol, using its `:set' function (or `set-default' if it has none).
79 The value is either the symbol's current value
80 (as obtained using the `:get' function), if any,
81 or the value in the symbol's `saved-value' property if any,
82 or (last of all) the value of EXP."
83 (funcall (or (get symbol 'custom-set) #'set-default-toplevel-value)
84 symbol
85 (condition-case nil
86 (let ((def (default-toplevel-value symbol))
87 (getter (get symbol 'custom-get)))
88 (if getter (funcall getter symbol) def))
89 (error
90 (eval (let ((sv (get symbol 'saved-value)))
91 (if sv (car sv) exp)))))))
93 (defun custom-initialize-changed (symbol exp)
94 "Initialize SYMBOL with EXP.
95 Like `custom-initialize-reset', but only use the `:set' function if
96 not using the standard setting.
97 For the standard setting, use `set-default'."
98 (condition-case nil
99 (let ((def (default-toplevel-value symbol)))
100 (funcall (or (get symbol 'custom-set) #'set-default-toplevel-value)
101 symbol
102 (let ((getter (get symbol 'custom-get)))
103 (if getter (funcall getter symbol) def))))
104 (error
105 (cond
106 ((get symbol 'saved-value)
107 (funcall (or (get symbol 'custom-set) #'set-default-toplevel-value)
108 symbol
109 (eval (car (get symbol 'saved-value)))))
111 (set-default symbol (eval exp)))))))
113 (defvar custom-delayed-init-variables nil
114 "List of variables whose initialization is pending.")
116 (defun custom-initialize-delay (symbol _value)
117 "Delay initialization of SYMBOL to the next Emacs start.
118 This is used in files that are preloaded (or for autoloaded
119 variables), so that the initialization is done in the run-time
120 context rather than the build-time context. This also has the
121 side-effect that the (delayed) initialization is performed with
122 the :set function.
124 For variables in preloaded files, you can simply use this
125 function for the :initialize property. For autoloaded variables,
126 you will also need to add an autoload stanza calling this
127 function, and another one setting the standard-value property.
128 Or you can wrap the defcustom in a progn, to force the autoloader
129 to include all of it." ; see eg vc-sccs-search-project-dir
130 ;; No longer true:
131 ;; "See `send-mail-function' in sendmail.el for an example."
133 ;; Until the var is actually initialized, it is kept unbound.
134 ;; This seemed to be at least as good as setting it to an arbitrary
135 ;; value like nil (evaluating `value' is not an option because it
136 ;; may have undesirable side-effects).
137 (push symbol custom-delayed-init-variables))
139 (defun custom-declare-variable (symbol default doc &rest args)
140 "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments.
141 DEFAULT should be an expression to evaluate to compute the default value,
142 not the default value itself.
144 DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property
145 `standard-value'. At the same time, SYMBOL's property `force-value' is
146 set to nil, as the value is no longer rogue."
147 (put symbol 'standard-value (purecopy (list default)))
148 ;; Maybe this option was rogue in an earlier version. It no longer is.
149 (when (get symbol 'force-value)
150 (put symbol 'force-value nil))
151 (if (keywordp doc)
152 (error "Doc string is missing"))
153 (let ((initialize 'custom-initialize-reset)
154 (requests nil))
155 (unless (memq :group args)
156 (custom-add-to-group (custom-current-group) symbol 'custom-variable))
157 (while args
158 (let ((arg (car args)))
159 (setq args (cdr args))
160 (unless (symbolp arg)
161 (error "Junk in args %S" args))
162 (let ((keyword arg)
163 (value (car args)))
164 (unless args
165 (error "Keyword %s is missing an argument" keyword))
166 (setq args (cdr args))
167 (cond ((eq keyword :initialize)
168 (setq initialize value))
169 ((eq keyword :set)
170 (put symbol 'custom-set value))
171 ((eq keyword :get)
172 (put symbol 'custom-get value))
173 ((eq keyword :require)
174 (push value requests))
175 ((eq keyword :risky)
176 (put symbol 'risky-local-variable value))
177 ((eq keyword :safe)
178 (put symbol 'safe-local-variable value))
179 ((eq keyword :type)
180 (put symbol 'custom-type (purecopy value)))
181 ((eq keyword :options)
182 (if (get symbol 'custom-options)
183 ;; Slow safe code to avoid duplicates.
184 (mapc (lambda (option)
185 (custom-add-option symbol option))
186 value)
187 ;; Fast code for the common case.
188 (put symbol 'custom-options (copy-sequence value))))
190 (custom-handle-keyword symbol keyword value
191 'custom-variable))))))
192 (put symbol 'custom-requests requests)
193 ;; Do the actual initialization.
194 (unless custom-dont-initialize
195 (funcall initialize symbol default)))
196 ;; Use defvar to set the docstring as well as the special-variable-p flag.
197 ;; FIXME: We should reproduce more of `defvar's behavior, such as the warning
198 ;; when the var is currently let-bound.
199 (if (not (default-boundp symbol))
200 ;; Don't use defvar to avoid setting a default-value when undesired.
201 (when doc (put symbol 'variable-documentation doc))
202 (eval `(defvar ,symbol nil ,@(when doc (list doc)))))
203 (push symbol current-load-list)
204 (run-hooks 'custom-define-hook)
205 symbol)
207 (defmacro defcustom (symbol standard doc &rest args)
208 "Declare SYMBOL as a customizable variable.
209 SYMBOL is the variable name; it should not be quoted.
210 STANDARD is an expression specifying the variable's standard
211 value. It should not be quoted. It is evaluated once by
212 `defcustom', and the value is assigned to SYMBOL if the variable
213 is unbound. The expression itself is also stored, so that
214 Customize can re-evaluate it later to get the standard value.
215 DOC is the variable documentation.
217 This macro uses `defvar' as a subroutine, which also marks the
218 variable as \"special\", so that it is always dynamically bound
219 even when `lexical-binding' is t.
221 The remaining arguments to `defcustom' should have the form
223 [KEYWORD VALUE]...
225 The following keywords are meaningful:
227 :type VALUE should be a widget type for editing the symbol's value.
228 :options VALUE should be a list of valid members of the widget type.
229 :initialize
230 VALUE should be a function used to initialize the
231 variable. It takes two arguments, the symbol and value
232 given in the `defcustom' call. The default is
233 `custom-initialize-reset'.
234 :set VALUE should be a function to set the value of the symbol
235 when using the Customize user interface.
236 It takes two arguments, the symbol to set and the value to
237 give it. The default choice of function is `set-default'.
238 :get VALUE should be a function to extract the value of symbol.
239 The function takes one argument, a symbol, and should return
240 the current value for that symbol. The default choice of function
241 is `default-value'.
242 :require
243 VALUE should be a feature symbol. If you save a value
244 for this option, then when your init file loads the value,
245 it does (require VALUE) first.
246 :set-after VARIABLES
247 Specifies that SYMBOL should be set after the list of variables
248 VARIABLES when both have been customized.
249 :risky Set SYMBOL's `risky-local-variable' property to VALUE.
250 :safe Set SYMBOL's `safe-local-variable' property to VALUE.
251 See Info node `(elisp) File Local Variables'.
253 The following common keywords are also meaningful.
255 :group VALUE should be a customization group.
256 Add SYMBOL (or FACE with `defface') to that group.
257 :link LINK-DATA
258 Include an external link after the documentation string for this
259 item. This is a sentence containing an active field which
260 references some other documentation.
262 There are several alternatives you can use for LINK-DATA:
264 (custom-manual INFO-NODE)
265 Link to an Info node; INFO-NODE is a string which specifies
266 the node name, as in \"(emacs)Top\".
268 (info-link INFO-NODE)
269 Like `custom-manual' except that the link appears in the
270 customization buffer with the Info node name.
272 (url-link URL)
273 Link to a web page; URL is a string which specifies the URL.
275 (emacs-commentary-link LIBRARY)
276 Link to the commentary section of LIBRARY.
278 (emacs-library-link LIBRARY)
279 Link to an Emacs Lisp LIBRARY file.
281 (file-link FILE)
282 Link to FILE.
284 (function-link FUNCTION)
285 Link to the documentation of FUNCTION.
287 (variable-link VARIABLE)
288 Link to the documentation of VARIABLE.
290 (custom-group-link GROUP)
291 Link to another customization GROUP.
293 You can specify the text to use in the customization buffer by
294 adding `:tag NAME' after the first element of the LINK-DATA; for
295 example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the
296 Emacs manual which appears in the buffer as `foo'.
298 An item can have more than one external link; however, most items
299 have none at all.
300 :version
301 VALUE should be a string specifying that the variable was
302 first introduced, or its default value was changed, in Emacs
303 version VERSION.
304 :package-version
305 VALUE should be a list with the form (PACKAGE . VERSION)
306 specifying that the variable was first introduced, or its
307 default value was changed, in PACKAGE version VERSION. This
308 keyword takes priority over :version. The PACKAGE and VERSION
309 must appear in the alist `customize-package-emacs-version-alist'.
310 Since PACKAGE must be unique and the user might see it in an
311 error message, a good choice is the official name of the
312 package, such as MH-E or Gnus.
313 :tag LABEL
314 Use LABEL, a string, instead of the item's name, to label the item
315 in customization menus and buffers.
316 :load FILE
317 Load file FILE (a string) before displaying this customization
318 item. Loading is done with `load', and only if the file is
319 not already loaded.
321 If SYMBOL has a local binding, then this form affects the local
322 binding. This is normally not what you want. Thus, if you need
323 to load a file defining variables with this form, or with
324 `defvar' or `defconst', you should always load that file
325 _outside_ any bindings for these variables. (`defvar' and
326 `defconst' behave similarly in this respect.)
328 See Info node `(elisp) Customization' in the Emacs Lisp manual
329 for more information."
330 (declare (doc-string 3) (debug (name body)))
331 ;; It is better not to use backquote in this file,
332 ;; because that makes a bootstrapping problem
333 ;; if you need to recompile all the Lisp files using interpreted code.
334 `(custom-declare-variable
335 ',symbol
336 ,(if lexical-binding ;FIXME: This is not reliable, but is all we have.
337 ;; The STANDARD arg should be an expression that evaluates to
338 ;; the standard value. The use of `eval' for it is spread
339 ;; over many different places and hence difficult to
340 ;; eliminate, yet we want to make sure that the `standard'
341 ;; expression is checked by the byte-compiler, and that
342 ;; lexical-binding is obeyed, so quote the expression with
343 ;; `lambda' rather than with `quote'.
344 ``(funcall #',(lambda () ,standard))
345 `',standard)
346 ,doc
347 ,@args))
349 ;;; The `defface' Macro.
351 (defmacro defface (face spec doc &rest args)
352 "Declare FACE as a customizable face that defaults to SPEC.
353 FACE does not need to be quoted.
355 Third argument DOC is the face documentation.
357 If FACE has been set with `custom-theme-set-faces', set the face
358 attributes as specified by that function, otherwise set the face
359 attributes according to SPEC.
361 The remaining arguments should have the form [KEYWORD VALUE]...
362 For a list of valid keywords, see the common keywords listed in
363 `defcustom'.
365 SPEC should be a \"face spec\", i.e., an alist of the form
367 ((DISPLAY . ATTS)...)
369 where DISPLAY is a form specifying conditions to match certain
370 terminals and ATTS is a property list (ATTR VALUE ATTR VALUE...)
371 specifying face attributes and values for frames on those
372 terminals. On each terminal, the first element with a matching
373 DISPLAY specification takes effect, and the remaining elements in
374 SPEC are disregarded.
376 As a special exception, in the first element of SPEC, DISPLAY can
377 be the special value `default'. Then the ATTS in that element
378 act as defaults for all the following elements.
380 For backward compatibility, elements of SPEC can be written
381 as (DISPLAY ATTS) instead of (DISPLAY . ATTS).
383 Each DISPLAY can have the following values:
384 - `default' (only in the first element).
385 - The symbol t, which matches all terminals.
386 - An alist of conditions. Each alist element must have the form
387 (REQ ITEM...). A matching terminal must satisfy each
388 specified condition by matching one of its ITEMs. Each REQ
389 must be one of the following:
390 - `type' (the terminal type).
391 Each ITEM must be one of the values returned by
392 `window-system'. Under X, additional allowed values are
393 `motif', `lucid', `gtk' and `x-toolkit'.
394 - `class' (the terminal's color support).
395 Each ITEM should be one of `color', `grayscale', or `mono'.
396 - `background' (what color is used for the background text)
397 Each ITEM should be one of `light' or `dark'.
398 - `min-colors' (the minimum number of supported colors)
399 Each ITEM should be an integer, which is compared with the
400 result of `display-color-cells'.
401 - `supports' (match terminals supporting certain attributes).
402 Each ITEM should be a list of face attributes. See
403 `display-supports-face-attributes-p' for more information on
404 exactly how testing is done.
406 In the ATTS property list, possible attributes are `:family',
407 `:width', `:height', `:weight', `:slant', `:underline',
408 `:overline', `:strike-through', `:box', `:foreground',
409 `:background', `:stipple', `:inverse-video', and `:inherit'.
411 See Info node `(elisp) Faces' in the Emacs Lisp manual for more
412 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."
426 (while members
427 (apply 'custom-add-to-group symbol (car members))
428 (setq members (cdr members)))
429 (when doc
430 ;; This text doesn't get into DOC.
431 (put symbol 'group-documentation (purecopy doc)))
432 (while args
433 (let ((arg (car args)))
434 (setq args (cdr args))
435 (unless (symbolp arg)
436 (error "Junk in args %S" args))
437 (let ((keyword arg)
438 (value (car args)))
439 (unless 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
446 'custom-group))))))
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)
453 symbol)
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
471 [KEYWORD VALUE]...
473 For a list of valid keywords, see the common keywords listed in
474 `defcustom'.
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))))
500 'custom-group)))
501 mode)))
503 ;;; Properties.
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))
510 (while args
511 (let ((arg (car args)))
512 (setq args (cdr args))
513 (unless (symbolp arg)
514 (error "Junk in args %S" args))
515 (let ((keyword arg)
516 (value (car args)))
517 (unless 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."
525 (if purify-flag
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))
533 ((eq keyword :link)
534 (custom-add-link symbol value))
535 ((eq keyword :load)
536 (custom-add-load symbol value))
537 ((eq keyword :tag)
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,
548 if 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))
552 (new-deps deps))
553 (while value
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 (defun custom-variable-p (variable)
603 "Return non-nil if VARIABLE is a customizable variable.
604 A customizable variable is either (i) a variable whose property
605 list contains a non-nil `standard-value' or `custom-autoload'
606 property, or (ii) an alias for another customizable variable."
607 (when (symbolp variable)
608 (setq variable (indirect-variable variable))
609 (or (get variable 'standard-value)
610 (get variable 'custom-autoload))))
612 (define-obsolete-function-alias 'user-variable-p 'custom-variable-p "24.3")
614 (defun custom-note-var-changed (variable)
615 "Inform Custom that VARIABLE has been set (changed).
616 VARIABLE is a symbol that names a user option.
617 The result is that the change is treated as having been made through Custom."
618 (put variable 'customized-value (list (custom-quote (eval variable)))))
621 ;;; Custom Themes
623 ;;; Loading files needed to customize a symbol.
624 ;;; This is in custom.el because menu-bar.el needs it for toggle cmds.
626 (defvar custom-load-recursion nil
627 "Hack to avoid recursive dependencies.")
629 (defun custom-load-symbol (symbol)
630 "Load all dependencies for SYMBOL."
631 (unless custom-load-recursion
632 (let ((custom-load-recursion t))
633 ;; Load these files if not already done,
634 ;; to make sure we know all the dependencies of SYMBOL.
635 (condition-case nil
636 (require 'cus-load)
637 (error nil))
638 (condition-case nil
639 (require 'cus-start)
640 (error nil))
641 (dolist (load (get symbol 'custom-loads))
642 (cond ((symbolp load) (condition-case nil (require load) (error nil)))
643 ;; This is subsumed by the test below, but it's much faster.
644 ((assoc load load-history))
645 ;; This was just (assoc (locate-library load) load-history)
646 ;; but has been optimized not to load locate-library
647 ;; if not necessary.
648 ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
649 "\\(\\'\\|\\.\\)"))
650 (found nil))
651 (dolist (loaded load-history)
652 (and (stringp (car loaded))
653 (string-match-p regexp (car loaded))
654 (setq found t)))
655 found))
656 ;; Without this, we would load cus-edit recursively.
657 ;; We are still loading it when we call this,
658 ;; and it is not in load-history yet.
659 ((equal load "cus-edit"))
660 (t (condition-case nil (load load) (error nil))))))))
662 (defvar custom-local-buffer nil
663 "Non-nil, in a Customization buffer, means customize a specific buffer.
664 If this variable is non-nil, it should be a buffer,
665 and it means customize the local bindings of that buffer.
666 This variable is a permanent local, and it normally has a local binding
667 in every Customization buffer.")
668 (put 'custom-local-buffer 'permanent-local t)
670 (defun custom-set-default (variable value)
671 "Default :set function for a customizable variable.
672 Normally, this sets the default value of VARIABLE to VALUE,
673 but if `custom-local-buffer' is non-nil,
674 this sets the local binding in that buffer instead."
675 (if custom-local-buffer
676 (with-current-buffer custom-local-buffer
677 (set variable value))
678 (set-default variable value)))
680 (defun custom-set-minor-mode (variable value)
681 ":set function for minor mode variables.
682 Normally, this sets the default value of VARIABLE to nil if VALUE
683 is nil and to t otherwise,
684 but if `custom-local-buffer' is non-nil,
685 this sets the local binding in that buffer instead."
686 (if custom-local-buffer
687 (with-current-buffer custom-local-buffer
688 (funcall variable (if value 1 0)))
689 (funcall variable (if value 1 0))))
691 (defun custom-quote (sexp)
692 "Quote SEXP if it is not self quoting."
693 (if (or (memq sexp '(t nil))
694 (keywordp sexp)
695 (and (listp sexp)
696 (memq (car sexp) '(lambda)))
697 (stringp sexp)
698 (numberp sexp)
699 (vectorp sexp)
700 ;;; (and (fboundp 'characterp)
701 ;;; (characterp sexp))
703 sexp
704 (list 'quote sexp)))
706 (defun customize-mark-to-save (symbol)
707 "Mark SYMBOL for later saving.
709 If the default value of SYMBOL is different from the standard value,
710 set the `saved-value' property to a list whose car evaluates to the
711 default value. Otherwise, set it to nil.
713 To actually save the value, call `custom-save-all'.
715 Return non-nil if the `saved-value' property actually changed."
716 (custom-load-symbol symbol)
717 (let* ((get (or (get symbol 'custom-get) 'default-value))
718 (value (funcall get symbol))
719 (saved (get symbol 'saved-value))
720 (standard (get symbol 'standard-value))
721 (comment (get symbol 'customized-variable-comment)))
722 ;; Save default value if different from standard value.
723 (if (or (null standard)
724 (not (equal value (condition-case nil
725 (eval (car standard))
726 (error nil)))))
727 (put symbol 'saved-value (list (custom-quote value)))
728 (put symbol 'saved-value nil))
729 ;; Clear customized information (set, but not saved).
730 (put symbol 'customized-value nil)
731 ;; Save any comment that might have been set.
732 (when comment
733 (put symbol 'saved-variable-comment comment))
734 (not (equal saved (get symbol 'saved-value)))))
736 (defun customize-mark-as-set (symbol)
737 "Mark current value of SYMBOL as being set from customize.
739 If the default value of SYMBOL is different from the saved value if any,
740 or else if it is different from the standard value, set the
741 `customized-value' property to a list whose car evaluates to the
742 default value. Otherwise, set it to nil.
744 Return non-nil if the `customized-value' property actually changed."
745 (custom-load-symbol symbol)
746 (let* ((get (or (get symbol 'custom-get) 'default-value))
747 (value (funcall get symbol))
748 (customized (get symbol 'customized-value))
749 (old (or (get symbol 'saved-value) (get symbol 'standard-value))))
750 ;; Mark default value as set if different from old value.
751 (if (not (and old
752 (equal value (condition-case nil
753 (eval (car old))
754 (error nil)))))
755 (progn (put symbol 'customized-value (list (custom-quote value)))
756 (custom-push-theme 'theme-value symbol 'user 'set
757 (custom-quote value)))
758 (put symbol 'customized-value nil))
759 ;; Changed?
760 (not (equal customized (get symbol 'customized-value)))))
762 (defun custom-reevaluate-setting (symbol)
763 "Reset the value of SYMBOL by re-evaluating its saved or standard value.
764 Use the :set function to do so. This is useful for customizable options
765 that are defined before their standard value can really be computed.
766 E.g. dumped variables whose default depends on run-time information."
767 (funcall (or (get symbol 'custom-set) 'set-default)
768 symbol
769 (eval (car (or (get symbol 'saved-value) (get symbol 'standard-value))))))
772 ;;; Custom Themes
774 ;; Custom themes are collections of settings that can be enabled or
775 ;; disabled as a unit.
777 ;; Each Custom theme is defined by a symbol, called the theme name.
778 ;; The `theme-settings' property of the theme name records the
779 ;; variable and face settings of the theme. This property is a list
780 ;; of elements, each of the form
782 ;; (PROP SYMBOL THEME VALUE)
784 ;; - PROP is either `theme-value' or `theme-face'
785 ;; - SYMBOL is the face or variable name
786 ;; - THEME is the theme name (redundant, but simplifies the code)
787 ;; - VALUE is an expression that gives the theme's setting for SYMBOL.
789 ;; The theme name also has a `theme-feature' property, whose value is
790 ;; specified when the theme is defined (see `custom-declare-theme').
791 ;; Usually, this is just a symbol named THEME-theme. This lets
792 ;; external libraries call (require 'foo-theme).
794 ;; In addition, each symbol (either a variable or a face) affected by
795 ;; an *enabled* theme has a `theme-value' or `theme-face' property,
796 ;; which is a list of elements each of the form
798 ;; (THEME VALUE)
800 ;; which have the same meanings as in `theme-settings'.
802 ;; The `theme-value' and `theme-face' lists are ordered by decreasing
803 ;; theme precedence. Thus, the first element is always the one that
804 ;; is in effect.
806 ;; Each theme is stored in a theme file, with filename THEME-theme.el.
807 ;; Loading a theme basically involves calling (load "THEME-theme")
808 ;; This is done by the function `load-theme'. Loading a theme
809 ;; automatically enables it.
811 ;; When a theme is enabled, the `theme-value' and `theme-face'
812 ;; properties for the affected symbols are set. When a theme is
813 ;; disabled, its settings are removed from the `theme-value' and
814 ;; `theme-face' properties, but the theme's own `theme-settings'
815 ;; property remains unchanged.
817 (defvar custom-known-themes '(user changed)
818 "Themes that have been defined with `deftheme'.
819 The default value is the list (user changed). The theme `changed'
820 contains the settings before custom themes are applied. The theme
821 `user' contains all the settings the user customized and saved.
822 Additional themes declared with the `deftheme' macro will be added
823 to the front of this list.")
825 (defsubst custom-theme-p (theme)
826 "Non-nil when THEME has been defined."
827 (memq theme custom-known-themes))
829 (defsubst custom-check-theme (theme)
830 "Check whether THEME is valid, and signal an error if it is not."
831 (unless (custom-theme-p theme)
832 (error "Unknown theme `%s'" theme)))
834 (defun custom-push-theme (prop symbol theme mode &optional value)
835 "Record VALUE for face or variable SYMBOL in custom theme THEME.
836 PROP is `theme-face' for a face, `theme-value' for a variable.
838 MODE can be either the symbol `set' or the symbol `reset'. If it is the
839 symbol `set', then VALUE is the value to use. If it is the symbol
840 `reset', then SYMBOL will be removed from THEME (VALUE is ignored).
842 See `custom-known-themes' for a list of known themes."
843 (unless (memq prop '(theme-value theme-face))
844 (error "Unknown theme property"))
845 (let* ((old (get symbol prop))
846 (setting (assq theme old)) ; '(theme value)
847 (theme-settings ; '(prop symbol theme value)
848 (get theme 'theme-settings)))
849 (cond
850 ;; Remove a setting:
851 ((eq mode 'reset)
852 (when setting
853 (let (res)
854 (dolist (theme-setting theme-settings)
855 (if (and (eq (car theme-setting) prop)
856 (eq (cadr theme-setting) symbol))
857 (setq res theme-setting)))
858 (put theme 'theme-settings (delq res theme-settings)))
859 (put symbol prop (delq setting old))))
860 ;; Alter an existing setting:
861 (setting
862 (let (res)
863 (dolist (theme-setting theme-settings)
864 (if (and (eq (car theme-setting) prop)
865 (eq (cadr theme-setting) symbol))
866 (setq res theme-setting)))
867 (put theme 'theme-settings
868 (cons (list prop symbol theme value)
869 (delq res theme-settings)))
870 (setcar (cdr setting) value)))
871 ;; Add a new setting:
873 (unless custom--inhibit-theme-enable
874 (unless old
875 ;; If the user changed a variable outside of Customize, save
876 ;; the value to a fake theme, `changed'. If the theme is
877 ;; later disabled, we use this to bring back the old value.
879 ;; For faces, we just use `face-new-frame-defaults' to
880 ;; recompute when the theme is disabled.
881 (when (and (eq prop 'theme-value)
882 (boundp symbol))
883 (let ((sv (get symbol 'standard-value))
884 (val (symbol-value symbol)))
885 (unless (and sv (equal (eval (car sv)) val))
886 (setq old `((changed ,(custom-quote val))))))))
887 (put symbol prop (cons (list theme value) old)))
888 (put theme 'theme-settings
889 (cons (list prop symbol theme value) theme-settings))))))
891 (defun custom-fix-face-spec (spec)
892 "Convert face SPEC, replacing obsolete :bold and :italic attributes.
893 Also change :reverse-video to :inverse-video."
894 (when (listp spec)
895 (if (or (memq :bold spec)
896 (memq :italic spec)
897 (memq :inverse-video spec))
898 (let (result)
899 (while spec
900 (let ((key (car spec))
901 (val (car (cdr spec))))
902 (cond ((eq key :italic)
903 (push :slant result)
904 (push (if val 'italic 'normal) result))
905 ((eq key :bold)
906 (push :weight result)
907 (push (if val 'bold 'normal) result))
908 ((eq key :reverse-video)
909 (push :inverse-video result)
910 (push val result))
912 (push key result)
913 (push val result))))
914 (setq spec (cddr spec)))
915 (nreverse result))
916 spec)))
918 (defun custom-set-variables (&rest args)
919 "Install user customizations of variable values specified in ARGS.
920 These settings are registered as theme `user'.
921 The arguments should each be a list of the form:
923 (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
925 This stores EXP (without evaluating it) as the saved value for SYMBOL.
926 If NOW is present and non-nil, then also evaluate EXP and set
927 the default value for the SYMBOL to the value of EXP.
929 REQUEST is a list of features we must require in order to
930 handle SYMBOL properly.
931 COMMENT is a comment string about SYMBOL."
932 (apply 'custom-theme-set-variables 'user args))
934 (defun custom-theme-set-variables (theme &rest args)
935 "Initialize variables for theme THEME according to settings in ARGS.
936 Each of the arguments in ARGS should be a list of this form:
938 (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
940 SYMBOL is the variable name, and EXP is an expression which
941 evaluates to the customized value. EXP will also be stored,
942 without evaluating it, in SYMBOL's `saved-value' property, so
943 that it can be restored via the Customize interface. It is also
944 added to the alist in SYMBOL's `theme-value' property (by
945 calling `custom-push-theme').
947 NOW, if present and non-nil, means to install the variable's
948 value directly now, even if its `defcustom' declaration has not
949 been executed. This is for internal use only.
951 REQUEST is a list of features to `require' (which are loaded
952 prior to evaluating EXP).
954 COMMENT is a comment string about SYMBOL."
955 (custom-check-theme theme)
956 ;; Process all the needed autoloads before anything else, so that the
957 ;; subsequent code has all the info it needs (e.g. which var corresponds
958 ;; to a minor mode), regardless of the ordering of the variables.
959 (dolist (entry args)
960 (let* ((symbol (indirect-variable (nth 0 entry))))
961 (unless (or (get symbol 'standard-value)
962 (memq (get symbol 'custom-autoload) '(nil noset)))
963 ;; This symbol needs to be autoloaded, even just for a `set'.
964 (custom-load-symbol symbol))))
965 (setq args (custom--sort-vars args))
966 (dolist (entry args)
967 (unless (listp entry)
968 (error "Incompatible Custom theme spec"))
969 (let* ((symbol (indirect-variable (nth 0 entry)))
970 (value (nth 1 entry)))
971 (custom-push-theme 'theme-value symbol theme 'set value)
972 (unless custom--inhibit-theme-enable
973 ;; Now set the variable.
974 (let* ((now (nth 2 entry))
975 (requests (nth 3 entry))
976 (comment (nth 4 entry))
977 set)
978 (when requests
979 (put symbol 'custom-requests requests)
980 (mapc 'require requests))
981 (setq set (or (get symbol 'custom-set) 'custom-set-default))
982 (put symbol 'saved-value (list value))
983 (put symbol 'saved-variable-comment comment)
984 ;; Allow for errors in the case where the setter has
985 ;; changed between versions, say, but let the user know.
986 (condition-case data
987 (cond (now
988 ;; Rogue variable, set it now.
989 (put symbol 'force-value t)
990 (funcall set symbol (eval value)))
991 ((default-boundp symbol)
992 ;; Something already set this, overwrite it.
993 (funcall set symbol (eval value))))
994 (error
995 (message "Error setting %s: %s" symbol data)))
996 (and (or now (default-boundp symbol))
997 (put symbol 'variable-comment comment)))))))
999 (defvar custom--sort-vars-table)
1000 (defvar custom--sort-vars-result)
1002 (defun custom--sort-vars (vars)
1003 "Sort VARS based on custom dependencies.
1004 VARS is a list whose elements have the same form as the ARGS
1005 arguments to `custom-theme-set-variables'. Return the sorted
1006 list, in which A occurs before B if B was defined with a
1007 `:set-after' keyword specifying A (see `defcustom')."
1008 (let ((custom--sort-vars-table (make-hash-table))
1009 (dependants (make-hash-table))
1010 (custom--sort-vars-result nil)
1011 last)
1012 ;; Construct a pair of tables keyed with the symbols of VARS.
1013 (dolist (var vars)
1014 (puthash (car var) (cons t var) custom--sort-vars-table)
1015 (puthash (car var) var dependants))
1016 ;; From the second table, remove symbols that are depended-on.
1017 (dolist (var vars)
1018 (dolist (dep (get (car var) 'custom-dependencies))
1019 (remhash dep dependants)))
1020 ;; If a variable is "stand-alone", put it last if it's a minor
1021 ;; mode or has a :require flag. This is not really necessary, but
1022 ;; putting minor modes last helps ensure that the mode function
1023 ;; sees other customized values rather than default values.
1024 (maphash (lambda (sym var)
1025 (when (and (null (get sym 'custom-dependencies))
1026 (or (nth 3 var)
1027 (eq (get sym 'custom-set)
1028 'custom-set-minor-mode)))
1029 (remhash sym dependants)
1030 (push var last)))
1031 dependants)
1032 ;; The remaining symbols depend on others but are not
1033 ;; depended-upon. Do a depth-first topological sort.
1034 (maphash #'custom--sort-vars-1 dependants)
1035 (nreverse (append last custom--sort-vars-result))))
1037 (defun custom--sort-vars-1 (sym &optional _ignored)
1038 (let ((elt (gethash sym custom--sort-vars-table)))
1039 ;; The car of the hash table value is nil if the variable has
1040 ;; already been processed, `dependant' if it is a dependant in the
1041 ;; current graph descent, and t otherwise.
1042 (when elt
1043 (cond
1044 ((eq (car elt) 'dependant)
1045 (error "Circular custom dependency on `%s'" sym))
1046 ((car elt)
1047 (setcar elt 'dependant)
1048 (dolist (dep (get sym 'custom-dependencies))
1049 (custom--sort-vars-1 dep))
1050 (setcar elt nil)
1051 (push (cdr elt) custom--sort-vars-result))))))
1054 ;;; Defining themes.
1056 ;; A theme file is named `THEME-theme.el' (where THEME is the theme
1057 ;; name) found in `custom-theme-load-path'. It has this format:
1059 ;; (deftheme THEME
1060 ;; DOCSTRING)
1062 ;; (custom-theme-set-variables
1063 ;; 'THEME
1064 ;; [THEME-VARIABLES])
1066 ;; (custom-theme-set-faces
1067 ;; 'THEME
1068 ;; [THEME-FACES])
1070 ;; (provide-theme 'THEME)
1073 ;; The IGNORED arguments to deftheme come from the XEmacs theme code, where
1074 ;; they were used to supply keyword-value pairs like `:immediate',
1075 ;; `:variable-reset-string', etc. We don't use any of these, so ignore them.
1077 (defmacro deftheme (theme &optional doc &rest ignored)
1078 "Declare THEME to be a Custom theme.
1079 The optional argument DOC is a doc string describing the theme.
1081 Any theme `foo' should be defined in a file called `foo-theme.el';
1082 see `custom-make-theme-feature' for more information."
1083 (declare (doc-string 2))
1084 (let ((feature (custom-make-theme-feature theme)))
1085 ;; It is better not to use backquote in this file,
1086 ;; because that makes a bootstrapping problem
1087 ;; if you need to recompile all the Lisp files using interpreted code.
1088 (list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc)))
1090 (defun custom-declare-theme (theme feature &optional doc &rest ignored)
1091 "Like `deftheme', but THEME is evaluated as a normal argument.
1092 FEATURE is the feature this theme provides. Normally, this is a symbol
1093 created from THEME by `custom-make-theme-feature'."
1094 (unless (custom-theme-name-valid-p theme)
1095 (error "Custom theme cannot be named %S" theme))
1096 (add-to-list 'custom-known-themes theme)
1097 (put theme 'theme-feature feature)
1098 (when doc (put theme 'theme-documentation doc)))
1100 (defun custom-make-theme-feature (theme)
1101 "Given a symbol THEME, create a new symbol by appending \"-theme\".
1102 Store this symbol in the `theme-feature' property of THEME.
1103 Calling `provide-theme' to provide THEME actually puts `THEME-theme'
1104 into `features'.
1106 This allows for a file-name convention for autoloading themes:
1107 Every theme X has a property `provide-theme' whose value is \"X-theme\".
1108 \(load-theme X) then attempts to load the file `X-theme.el'."
1109 (intern (concat (symbol-name theme) "-theme")))
1111 ;;; Loading themes.
1113 (defcustom custom-theme-directory user-emacs-directory
1114 "Default user directory for storing custom theme files.
1115 The command `customize-create-theme' writes theme files into this
1116 directory. By default, Emacs searches for custom themes in this
1117 directory first---see `custom-theme-load-path'."
1118 :type 'string
1119 :group 'customize
1120 :version "22.1")
1122 (defcustom custom-theme-load-path (list 'custom-theme-directory t)
1123 "List of directories to search for custom theme files.
1124 When loading custom themes (e.g. in `customize-themes' and
1125 `load-theme'), Emacs searches for theme files in the specified
1126 order. Each element in the list should be one of the following:
1127 - the symbol `custom-theme-directory', meaning the value of
1128 `custom-theme-directory'.
1129 - the symbol t, meaning the built-in theme directory (a directory
1130 named \"themes\" in `data-directory').
1131 - a directory name (a string).
1133 Each theme file is named THEME-theme.el, where THEME is the theme
1134 name."
1135 :type '(repeat (choice (const :tag "custom-theme-directory"
1136 custom-theme-directory)
1137 (const :tag "Built-in theme directory" t)
1138 directory))
1139 :group 'customize
1140 :version "24.1")
1142 (defvar custom--inhibit-theme-enable nil
1143 "Whether the custom-theme-set-* functions act immediately.
1144 If nil, `custom-theme-set-variables' and `custom-theme-set-faces'
1145 change the current values of the given variable or face. If
1146 non-nil, they just make a record of the theme settings.")
1148 (defun provide-theme (theme)
1149 "Indicate that this file provides THEME.
1150 This calls `provide' to provide the feature name stored in THEME's
1151 property `theme-feature' (which is usually a symbol created by
1152 `custom-make-theme-feature')."
1153 (unless (custom-theme-name-valid-p theme)
1154 (error "Custom theme cannot be named %S" theme))
1155 (custom-check-theme theme)
1156 (provide (get theme 'theme-feature)))
1158 (defcustom custom-safe-themes '(default)
1159 "Themes that are considered safe to load.
1160 If the value is a list, each element should be either the SHA-256
1161 hash of a safe theme file, or the symbol `default', which stands
1162 for any theme in the built-in Emacs theme directory (a directory
1163 named \"themes\" in `data-directory').
1165 If the value is t, Emacs treats all themes as safe.
1167 This variable cannot be set in a Custom theme."
1168 :type '(choice (repeat :tag "List of safe themes"
1169 (choice string
1170 (const :tag "Built-in themes" default)))
1171 (const :tag "All themes" t))
1172 :group 'customize
1173 :risky t
1174 :version "24.1")
1176 (defun load-theme (theme &optional no-confirm no-enable)
1177 "Load Custom theme named THEME from its file.
1178 The theme file is named THEME-theme.el, in one of the directories
1179 specified by `custom-theme-load-path'.
1181 If the theme is not considered safe by `custom-safe-themes',
1182 prompt the user for confirmation before loading it. But if
1183 optional arg NO-CONFIRM is non-nil, load the theme without
1184 prompting.
1186 Normally, this function also enables THEME. If optional arg
1187 NO-ENABLE is non-nil, load the theme but don't enable it, unless
1188 the theme was already enabled.
1190 This function is normally called through Customize when setting
1191 `custom-enabled-themes'. If used directly in your init file, it
1192 should be called with a non-nil NO-CONFIRM argument, or after
1193 `custom-safe-themes' has been loaded.
1195 Return t if THEME was successfully loaded, nil otherwise."
1196 (interactive
1197 (list
1198 (intern (completing-read "Load custom theme: "
1199 (mapcar 'symbol-name
1200 (custom-available-themes))))
1201 nil nil))
1202 (unless (custom-theme-name-valid-p theme)
1203 (error "Invalid theme name `%s'" theme))
1204 ;; If THEME is already enabled, re-enable it after loading, even if
1205 ;; NO-ENABLE is t.
1206 (if no-enable
1207 (setq no-enable (not (custom-theme-enabled-p theme))))
1208 ;; If reloading, clear out the old theme settings.
1209 (when (custom-theme-p theme)
1210 (disable-theme theme)
1211 (put theme 'theme-settings nil)
1212 (put theme 'theme-feature nil)
1213 (put theme 'theme-documentation nil))
1214 (let ((fn (locate-file (concat (symbol-name theme) "-theme.el")
1215 (custom-theme--load-path)
1216 '("" "c")))
1217 hash)
1218 (unless fn
1219 (error "Unable to find theme file for `%s'" theme))
1220 (with-temp-buffer
1221 (insert-file-contents fn)
1222 (setq hash (secure-hash 'sha256 (current-buffer)))
1223 ;; Check file safety with `custom-safe-themes', prompting the
1224 ;; user if necessary.
1225 (when (or no-confirm
1226 (eq custom-safe-themes t)
1227 (and (memq 'default custom-safe-themes)
1228 (equal (file-name-directory fn)
1229 (expand-file-name "themes/" data-directory)))
1230 (member hash custom-safe-themes)
1231 (custom-theme-load-confirm hash))
1232 (let ((custom--inhibit-theme-enable t)
1233 (buffer-file-name fn)) ;For load-history.
1234 (eval-buffer))
1235 ;; Optimization: if the theme changes the `default' face, put that
1236 ;; entry first. This avoids some `frame-set-background-mode' rigmarole
1237 ;; by assigning the new background immediately.
1238 (let* ((settings (get theme 'theme-settings))
1239 (tail settings)
1240 found)
1241 (while (and tail (not found))
1242 (and (eq (nth 0 (car tail)) 'theme-face)
1243 (eq (nth 1 (car tail)) 'default)
1244 (setq found (car tail)))
1245 (setq tail (cdr tail)))
1246 (if found
1247 (put theme 'theme-settings (cons found (delq found settings)))))
1248 ;; Finally, enable the theme.
1249 (unless no-enable
1250 (enable-theme theme))
1251 t))))
1253 (defun custom-theme-load-confirm (hash)
1254 "Query the user about loading a Custom theme that may not be safe.
1255 The theme should be in the current buffer. If the user agrees,
1256 query also about adding HASH to `custom-safe-themes'."
1257 (unless noninteractive
1258 (save-window-excursion
1259 (rename-buffer "*Custom Theme*" t)
1260 (emacs-lisp-mode)
1261 (pop-to-buffer (current-buffer))
1262 (goto-char (point-min))
1263 (prog1 (when (y-or-n-p "Loading a theme can run Lisp code. Really load? ")
1264 ;; Offer to save to `custom-safe-themes'.
1265 (and (or custom-file user-init-file)
1266 (y-or-n-p "Treat this theme as safe in future sessions? ")
1267 (customize-push-and-save 'custom-safe-themes (list hash)))
1269 (quit-window)))))
1271 (defun custom-theme-name-valid-p (name)
1272 "Return t if NAME is a valid name for a Custom theme, nil otherwise.
1273 NAME should be a symbol."
1274 (and (symbolp name)
1275 name
1276 (not (or (zerop (length (symbol-name name)))
1277 (eq name 'user)
1278 (eq name 'changed)))))
1280 (defun custom-available-themes ()
1281 "Return a list of Custom themes available for loading.
1282 Search the directories specified by `custom-theme-load-path' for
1283 files named FOO-theme.el, and return a list of FOO symbols.
1285 The returned symbols may not correspond to themes that have been
1286 loaded, and no effort is made to check that the files contain
1287 valid Custom themes. For a list of loaded themes, check the
1288 variable `custom-known-themes'."
1289 (let (sym themes)
1290 (dolist (dir (custom-theme--load-path))
1291 (when (file-directory-p dir)
1292 (dolist (file (file-expand-wildcards
1293 (expand-file-name "*-theme.el" dir) t))
1294 (setq file (file-name-nondirectory file))
1295 (and (string-match "\\`\\(.+\\)-theme.el\\'" file)
1296 (setq sym (intern (match-string 1 file)))
1297 (custom-theme-name-valid-p sym)
1298 (push sym themes)))))
1299 (nreverse (delete-dups themes))))
1301 (defun custom-theme--load-path ()
1302 (let (lpath)
1303 (dolist (f custom-theme-load-path)
1304 (cond ((eq f 'custom-theme-directory)
1305 (setq f custom-theme-directory))
1306 ((eq f t)
1307 (setq f (expand-file-name "themes" data-directory))))
1308 (if (file-directory-p f)
1309 (push f lpath)))
1310 (nreverse lpath)))
1313 ;;; Enabling and disabling loaded themes.
1315 (defun enable-theme (theme)
1316 "Reenable all variable and face settings defined by THEME.
1317 THEME should be either `user', or a theme loaded via `load-theme'.
1318 After this function completes, THEME will have the highest
1319 precedence (after `user')."
1320 (interactive (list (intern
1321 (completing-read
1322 "Enable custom theme: "
1323 obarray (lambda (sym) (get sym 'theme-settings)) t))))
1324 (if (not (custom-theme-p theme))
1325 (error "Undefined Custom theme %s" theme))
1326 (let ((settings (get theme 'theme-settings)))
1327 ;; Loop through theme settings, recalculating vars/faces.
1328 (dolist (s settings)
1329 (let* ((prop (car s))
1330 (symbol (cadr s))
1331 (spec-list (get symbol prop)))
1332 (put symbol prop (cons (cddr s) (assq-delete-all theme spec-list)))
1333 (cond
1334 ((eq prop 'theme-face)
1335 (custom-theme-recalc-face symbol))
1336 ((eq prop 'theme-value)
1337 ;; Ignore `custom-enabled-themes' and `custom-safe-themes'.
1338 (unless (memq symbol '(custom-enabled-themes custom-safe-themes))
1339 (custom-theme-recalc-variable symbol)))))))
1340 (unless (eq theme 'user)
1341 (setq custom-enabled-themes
1342 (cons theme (delq theme custom-enabled-themes)))
1343 ;; Give the `user' theme the highest priority.
1344 (enable-theme 'user)))
1346 (defcustom custom-enabled-themes nil
1347 "List of enabled Custom Themes, highest precedence first.
1348 This list does not include the `user' theme, which is set by
1349 Customize and always takes precedence over other Custom Themes.
1351 This variable cannot be defined inside a Custom theme; there, it
1352 is simply ignored.
1354 Setting this variable through Customize calls `enable-theme' or
1355 `load-theme' for each theme in the list."
1356 :group 'customize
1357 :type '(repeat symbol)
1358 :set-after '(custom-theme-directory custom-theme-load-path
1359 custom-safe-themes)
1360 :risky t
1361 :set (lambda (symbol themes)
1362 (let (failures)
1363 (setq themes (delq 'user (delete-dups themes)))
1364 ;; Disable all themes not in THEMES.
1365 (if (boundp symbol)
1366 (dolist (theme (symbol-value symbol))
1367 (if (not (memq theme themes))
1368 (disable-theme theme))))
1369 ;; Call `enable-theme' or `load-theme' on each of THEMES.
1370 (dolist (theme (reverse themes))
1371 (condition-case nil
1372 (if (custom-theme-p theme)
1373 (enable-theme theme)
1374 (load-theme theme))
1375 (error (setq failures (cons theme failures)
1376 themes (delq theme themes)))))
1377 (enable-theme 'user)
1378 (custom-set-default symbol themes)
1379 (if failures
1380 (message "Failed to enable theme: %s"
1381 (mapconcat 'symbol-name failures ", "))))))
1383 (defsubst custom-theme-enabled-p (theme)
1384 "Return non-nil if THEME is enabled."
1385 (memq theme custom-enabled-themes))
1387 (defun disable-theme (theme)
1388 "Disable all variable and face settings defined by THEME.
1389 See `custom-enabled-themes' for a list of enabled themes."
1390 (interactive (list (intern
1391 (completing-read
1392 "Disable custom theme: "
1393 (mapcar 'symbol-name custom-enabled-themes)
1394 nil t))))
1395 (when (custom-theme-enabled-p theme)
1396 (let ((settings (get theme 'theme-settings)))
1397 (dolist (s settings)
1398 (let* ((prop (car s))
1399 (symbol (cadr s))
1400 (val (assq-delete-all theme (get symbol prop))))
1401 (put symbol prop val)
1402 (cond
1403 ((eq prop 'theme-value)
1404 (custom-theme-recalc-variable symbol))
1405 ((eq prop 'theme-face)
1406 ;; If the face spec specified by this theme is in the
1407 ;; saved-face property, reset that property.
1408 (when (equal (nth 3 s) (get symbol 'saved-face))
1409 (put symbol 'saved-face (and val (cadr (car val)))))))))
1410 ;; Recompute faces on all frames.
1411 (dolist (frame (frame-list))
1412 ;; We must reset the fg and bg color frame parameters, or
1413 ;; `face-set-after-frame-default' will use the existing
1414 ;; parameters, which could be from the disabled theme.
1415 (set-frame-parameter frame 'background-color
1416 (custom--frame-color-default
1417 frame :background "background" "Background"
1418 "unspecified-bg" "white"))
1419 (set-frame-parameter frame 'foreground-color
1420 (custom--frame-color-default
1421 frame :foreground "foreground" "Foreground"
1422 "unspecified-fg" "black"))
1423 (face-set-after-frame-default frame))
1424 (setq custom-enabled-themes
1425 (delq theme custom-enabled-themes)))))
1427 ;; Only used if window-system not null.
1428 (declare-function x-get-resource "frame.c"
1429 (attribute class &optional component subclass))
1431 (defun custom--frame-color-default (frame attribute resource-attr resource-class
1432 tty-default x-default)
1433 (let ((col (face-attribute 'default attribute t)))
1434 (cond
1435 ((and col (not (eq col 'unspecified))) col)
1436 ((null (window-system frame)) tty-default)
1437 ((setq col (x-get-resource resource-attr resource-class)) col)
1438 (t x-default))))
1440 (defun custom-variable-theme-value (variable)
1441 "Return (list VALUE) indicating the custom theme value of VARIABLE.
1442 That is to say, it specifies what the value should be according to
1443 currently enabled custom themes.
1445 This function returns nil if no custom theme specifies a value for VARIABLE."
1446 (let ((theme-value (get variable 'theme-value)))
1447 (if theme-value
1448 (cdr (car theme-value)))))
1450 (defun custom-theme-recalc-variable (variable)
1451 "Set VARIABLE according to currently enabled custom themes."
1452 (let ((valspec (custom-variable-theme-value variable)))
1453 (if valspec
1454 (put variable 'saved-value valspec)
1455 (setq valspec (get variable 'standard-value)))
1456 (if (and valspec
1457 (or (get variable 'force-value)
1458 (default-boundp variable)))
1459 (funcall (or (get variable 'custom-set) 'set-default) variable
1460 (eval (car valspec))))))
1462 (defun custom-theme-recalc-face (face)
1463 "Set FACE according to currently enabled custom themes.
1464 If FACE is not initialized as a face, do nothing; otherwise call
1465 `face-spec-recalc' to recalculate the face on all frames."
1466 (if (get face 'face-alias)
1467 (setq face (get face 'face-alias)))
1468 (if (facep face)
1469 ;; Reset the faces for each frame.
1470 (dolist (frame (frame-list))
1471 (face-spec-recalc face frame))))
1474 ;;; XEmacs compatibility functions
1476 ;; In XEmacs, when you reset a Custom Theme, you have to specify the
1477 ;; theme to reset it to. We just apply the next available theme, so
1478 ;; just ignore the IGNORED arguments.
1480 (defun custom-theme-reset-variables (theme &rest args)
1481 "Reset some variable settings in THEME to their values in other themes.
1482 Each of the arguments ARGS has this form:
1484 (VARIABLE IGNORED)
1486 This means reset VARIABLE. (The argument IGNORED is ignored)."
1487 (custom-check-theme theme)
1488 (dolist (arg args)
1489 (custom-push-theme 'theme-value (car arg) theme 'reset)))
1491 (defun custom-reset-variables (&rest args)
1492 "Reset the specs of some variables to their values in other themes.
1493 This creates settings in the `user' theme.
1495 Each of the arguments ARGS has this form:
1497 (VARIABLE IGNORED)
1499 This means reset VARIABLE. (The argument IGNORED is ignored)."
1500 (apply 'custom-theme-reset-variables 'user args))
1502 ;;; The End.
1504 (provide 'custom)
1506 ;;; custom.el ends here