Merge from trunk.
[emacs.git] / lisp / custom.el
blobd3752789e2818b5231cdf5d63f5344cd1349e6b8
1 ;;; custom.el --- tools for declaring and initializing options
2 ;;
3 ;; Copyright (C) 1996-1997, 1999, 2001-2012 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Maintainer: FSF
7 ;; Keywords: help, faces
8 ;; Package: emacs
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/>.
25 ;;; Commentary:
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'.
33 ;;; Code:
35 (require 'widget)
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
57 symbol."
58 (eval `(defvar ,symbol ,(if (get symbol 'saved-value)
59 (car (get symbol 'saved-value))
60 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,
67 if any, or VALUE."
68 (unless (default-boundp symbol)
69 (funcall (or (get symbol 'custom-set) 'set-default)
70 symbol
71 (eval (if (get symbol 'saved-value)
72 (car (get symbol 'saved-value))
73 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)
83 symbol
84 (cond ((default-boundp symbol)
85 (funcall (or (get symbol 'custom-get) 'default-value)
86 symbol))
87 ((get symbol 'saved-value)
88 (eval (car (get symbol 'saved-value))))
90 (eval 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)
99 symbol
100 (funcall (or (get symbol 'custom-get) 'default-value)
101 symbol)))
102 ((get symbol 'saved-value)
103 (funcall (or (get symbol 'custom-set) 'set-default)
104 symbol
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
118 the :set function.
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."
124 ;; No longer true:
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))
145 (if (keywordp doc)
146 (error "Doc string is missing"))
147 (let ((initialize 'custom-initialize-reset)
148 (requests nil))
149 (unless (memq :group args)
150 (custom-add-to-group (custom-current-group) symbol 'custom-variable))
151 (while args
152 (let ((arg (car args)))
153 (setq args (cdr args))
154 (unless (symbolp arg)
155 (error "Junk in args %S" args))
156 (let ((keyword arg)
157 (value (car args)))
158 (unless args
159 (error "Keyword %s is missing an argument" keyword))
160 (setq args (cdr args))
161 (cond ((eq keyword :initialize)
162 (setq initialize value))
163 ((eq keyword :set)
164 (put symbol 'custom-set value))
165 ((eq keyword :get)
166 (put symbol 'custom-get value))
167 ((eq keyword :require)
168 (push value requests))
169 ((eq keyword :risky)
170 (put symbol 'risky-local-variable value))
171 ((eq keyword :safe)
172 (put symbol 'safe-local-variable value))
173 ((eq keyword :type)
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))
180 value)
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)
199 symbol)
201 (defmacro defcustom (symbol value doc &rest args)
202 "Declare SYMBOL as a customizable variable that defaults to VALUE.
203 DOC is the variable documentation.
205 Neither SYMBOL nor VALUE need to be quoted.
206 If SYMBOL is not already bound, initialize it to VALUE.
207 The remaining arguments should have the form
209 [KEYWORD VALUE]...
211 The following keywords are meaningful:
213 :type VALUE should be a widget type for editing the symbol's value.
214 :options VALUE should be a list of valid members of the widget type.
215 :initialize
216 VALUE should be a function used to initialize the
217 variable. It takes two arguments, the symbol and value
218 given in the `defcustom' call. The default is
219 `custom-initialize-reset'.
220 :set VALUE should be a function to set the value of the symbol
221 when using the Customize user interface.
222 It takes two arguments, the symbol to set and the value to
223 give it. The default choice of function is `set-default'.
224 :get VALUE should be a function to extract the value of symbol.
225 The function takes one argument, a symbol, and should return
226 the current value for that symbol. The default choice of function
227 is `default-value'.
228 :require
229 VALUE should be a feature symbol. If you save a value
230 for this option, then when your `.emacs' file loads the value,
231 it does (require VALUE) first.
232 :risky Set SYMBOL's `risky-local-variable' property to VALUE.
233 :safe Set SYMBOL's `safe-local-variable' property to VALUE.
235 The following common keywords are also meaningful.
237 :group VALUE should be a customization group.
238 Add SYMBOL (or FACE with `defface') to that group.
239 :link LINK-DATA
240 Include an external link after the documentation string for this
241 item. This is a sentence containing an active field which
242 references some other documentation.
244 There are several alternatives you can use for LINK-DATA:
246 (custom-manual INFO-NODE)
247 Link to an Info node; INFO-NODE is a string which specifies
248 the node name, as in \"(emacs)Top\".
250 (info-link INFO-NODE)
251 Like `custom-manual' except that the link appears in the
252 customization buffer with the Info node name.
254 (url-link URL)
255 Link to a web page; URL is a string which specifies the URL.
257 (emacs-commentary-link LIBRARY)
258 Link to the commentary section of LIBRARY.
260 (emacs-library-link LIBRARY)
261 Link to an Emacs Lisp LIBRARY file.
263 (file-link FILE)
264 Link to FILE.
266 (function-link FUNCTION)
267 Link to the documentation of FUNCTION.
269 (variable-link VARIABLE)
270 Link to the documentation of VARIABLE.
272 (custom-group-link GROUP)
273 Link to another customization GROUP.
275 You can specify the text to use in the customization buffer by
276 adding `:tag NAME' after the first element of the LINK-DATA; for
277 example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the
278 Emacs manual which appears in the buffer as `foo'.
280 An item can have more than one external link; however, most items
281 have none at all.
282 :version
283 VALUE should be a string specifying that the variable was
284 first introduced, or its default value was changed, in Emacs
285 version VERSION.
286 :package-version
287 VALUE should be a list with the form (PACKAGE . VERSION)
288 specifying that the variable was first introduced, or its
289 default value was changed, in PACKAGE version VERSION. This
290 keyword takes priority over :version. The PACKAGE and VERSION
291 must appear in the alist `customize-package-emacs-version-alist'.
292 Since PACKAGE must be unique and the user might see it in an
293 error message, a good choice is the official name of the
294 package, such as MH-E or Gnus.
295 :tag LABEL
296 Use LABEL, a string, instead of the item's name, to label the item
297 in customization menus and buffers.
298 :load FILE
299 Load file FILE (a string) before displaying this customization
300 item. Loading is done with `load', and only if the file is
301 not already loaded.
302 :set-after VARIABLES
303 Specifies that SYMBOL should be set after the list of variables
304 VARIABLES when both have been customized.
306 If SYMBOL has a local binding, then this form affects the local
307 binding. This is normally not what you want. Thus, if you need
308 to load a file defining variables with this form, or with
309 `defvar' or `defconst', you should always load that file
310 _outside_ any bindings for these variables. \(`defvar' and
311 `defconst' behave similarly in this respect.)
313 See Info node `(elisp) Customization' in the Emacs Lisp manual
314 for more information."
315 (declare (doc-string 3) (debug (name body)))
316 ;; It is better not to use backquote in this file,
317 ;; because that makes a bootstrapping problem
318 ;; if you need to recompile all the Lisp files using interpreted code.
319 `(custom-declare-variable
320 ',symbol
321 ,(if lexical-binding ;FIXME: This is not reliable, but is all we have.
322 ;; The `default' arg should be an expression that evaluates to
323 ;; the value to use. The use of `eval' for it is spread over
324 ;; many different places and hence difficult to eliminate, yet
325 ;; we want to make sure that the `value' expression is checked by the
326 ;; byte-compiler, and that lexical-binding is obeyed, so quote the
327 ;; expression with `lambda' rather than with `quote'.
328 `(list (lambda () ,value))
329 `',value)
330 ,doc
331 ,@args))
333 ;;; The `defface' Macro.
335 (defmacro defface (face spec doc &rest args)
336 "Declare FACE as a customizable face that defaults to SPEC.
337 FACE does not need to be quoted.
339 Third argument DOC is the face documentation.
341 If FACE has been set with `custom-set-faces', set the face attributes
342 as specified by that function, otherwise set the face attributes
343 according to SPEC.
345 The remaining arguments should have the form
347 [KEYWORD VALUE]...
349 For a list of valid keywords, see the common keywords listed in
350 `defcustom'.
352 SPEC should be an alist of the form ((DISPLAY ATTS)...).
354 In the first element, DISPLAY can be `default'. The ATTS in that
355 element then act as defaults for all the following elements.
357 Aside from that, DISPLAY specifies conditions to match some or
358 all frames. For each frame, the first element of SPEC where the
359 DISPLAY conditions are satisfied is the one that applies to that
360 frame. The ATTRs in this element take effect, and the following
361 elements are ignored, on that frame.
363 In the last element, DISPLAY can be t. That element applies to a
364 frame if none of the previous elements (except the `default' if
365 any) did.
367 ATTS is a list of face attributes followed by their values:
368 (ATTR VALUE ATTR VALUE...)
370 The possible attributes are `:family', `:width', `:height', `:weight',
371 `:slant', `:underline', `:overline', `:strike-through', `:box',
372 `:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'.
374 DISPLAY can be `default' (only in the first element), the symbol
375 t (only in the last element) to match all frames, or an alist of
376 conditions of the form \(REQ ITEM...). For such an alist to
377 match a frame, each of the conditions must be satisfied, meaning
378 that the REQ property of the frame must match one of the
379 corresponding ITEMs. These are the defined REQ values:
381 `type' (the value of `window-system')
382 Under X, in addition to the values `window-system' can take,
383 `motif', `lucid', `gtk' and `x-toolkit' are allowed, and match when
384 the Motif toolkit, Lucid toolkit, GTK toolkit or any X toolkit is in use.
386 `class' (the frame's color support)
387 Should be one of `color', `grayscale', or `mono'.
389 `background' (what color is used for the background text)
390 Should be one of `light' or `dark'.
392 `min-colors' (the minimum number of colors the frame should support)
393 Should be an integer, it is compared with the result of
394 `display-color-cells'.
396 `supports' (only match frames that support the specified face attributes)
397 Should be a list of face attributes. See the documentation for
398 the function `display-supports-face-attributes-p' for more
399 information on exactly how testing is done.
401 See Info node `(elisp) Customization' in the Emacs Lisp manual
402 for more information."
403 (declare (doc-string 3))
404 ;; It is better not to use backquote in this file,
405 ;; because that makes a bootstrapping problem
406 ;; if you need to recompile all the Lisp files using interpreted code.
407 (nconc (list 'custom-declare-face (list 'quote face) spec doc) args))
409 ;;; The `defgroup' Macro.
411 (defun custom-current-group ()
412 (cdr (assoc load-file-name custom-current-group-alist)))
414 (defun custom-declare-group (symbol members doc &rest args)
415 "Like `defgroup', but SYMBOL is evaluated as a normal argument."
416 (while members
417 (apply 'custom-add-to-group symbol (car members))
418 (setq members (cdr members)))
419 (when doc
420 ;; This text doesn't get into DOC.
421 (put symbol 'group-documentation (purecopy doc)))
422 (while args
423 (let ((arg (car args)))
424 (setq args (cdr args))
425 (unless (symbolp arg)
426 (error "Junk in args %S" args))
427 (let ((keyword arg)
428 (value (car args)))
429 (unless args
430 (error "Keyword %s is missing an argument" keyword))
431 (setq args (cdr args))
432 (cond ((eq keyword :prefix)
433 (put symbol 'custom-prefix (purecopy value)))
435 (custom-handle-keyword symbol keyword value
436 'custom-group))))))
437 ;; Record the group on the `current' list.
438 (let ((elt (assoc load-file-name custom-current-group-alist)))
439 (if elt (setcdr elt symbol)
440 (push (cons (purecopy load-file-name) symbol)
441 custom-current-group-alist)))
442 (run-hooks 'custom-define-hook)
443 symbol)
445 (defmacro defgroup (symbol members doc &rest args)
446 "Declare SYMBOL as a customization group containing MEMBERS.
447 SYMBOL does not need to be quoted.
449 Third argument DOC is the group documentation. This should be a short
450 description of the group, beginning with a capital and ending with
451 a period. Words other than the first should not be capitalized, if they
452 are not usually written so.
454 MEMBERS should be an alist of the form ((NAME WIDGET)...) where
455 NAME is a symbol and WIDGET is a widget for editing that symbol.
456 Useful widgets are `custom-variable' for editing variables,
457 `custom-face' for edit faces, and `custom-group' for editing groups.
459 The remaining arguments should have the form
461 [KEYWORD VALUE]...
463 For a list of valid keywords, see the common keywords listed in
464 `defcustom'.
466 See Info node `(elisp) Customization' in the Emacs Lisp manual
467 for more information."
468 (declare (doc-string 3))
469 ;; It is better not to use backquote in this file,
470 ;; because that makes a bootstrapping problem
471 ;; if you need to recompile all the Lisp files using interpreted code.
472 (nconc (list 'custom-declare-group (list 'quote symbol) members doc) args))
474 (defun custom-add-to-group (group option widget)
475 "To existing GROUP add a new OPTION of type WIDGET.
476 If there already is an entry for OPTION and WIDGET, nothing is done."
477 (let ((members (get group 'custom-group))
478 (entry (list option widget)))
479 (unless (member entry members)
480 (put group 'custom-group (nconc members (list entry))))))
482 (defun custom-group-of-mode (mode)
483 "Return the custom group corresponding to the major or minor MODE.
484 If no such group is found, return nil."
485 (or (get mode 'custom-mode-group)
486 (if (or (get mode 'custom-group)
487 (and (string-match "-mode\\'" (symbol-name mode))
488 (get (setq mode (intern (substring (symbol-name mode)
489 0 (match-beginning 0))))
490 'custom-group)))
491 mode)))
493 ;;; Properties.
495 (defun custom-handle-all-keywords (symbol args type)
496 "For customization option SYMBOL, handle keyword arguments ARGS.
497 Third argument TYPE is the custom option type."
498 (unless (memq :group args)
499 (custom-add-to-group (custom-current-group) symbol type))
500 (while args
501 (let ((arg (car args)))
502 (setq args (cdr args))
503 (unless (symbolp arg)
504 (error "Junk in args %S" args))
505 (let ((keyword arg)
506 (value (car args)))
507 (unless args
508 (error "Keyword %s is missing an argument" keyword))
509 (setq args (cdr args))
510 (custom-handle-keyword symbol keyword value type)))))
512 (defun custom-handle-keyword (symbol keyword value type)
513 "For customization option SYMBOL, handle KEYWORD with VALUE.
514 Fourth argument TYPE is the custom option type."
515 (if purify-flag
516 (setq value (purecopy value)))
517 (cond ((eq keyword :group)
518 (custom-add-to-group value symbol type))
519 ((eq keyword :version)
520 (custom-add-version symbol value))
521 ((eq keyword :package-version)
522 (custom-add-package-version symbol value))
523 ((eq keyword :link)
524 (custom-add-link symbol value))
525 ((eq keyword :load)
526 (custom-add-load symbol value))
527 ((eq keyword :tag)
528 (put symbol 'custom-tag value))
529 ((eq keyword :set-after)
530 (custom-add-dependencies symbol value))
532 (error "Unknown keyword %s" keyword))))
534 (defun custom-add-dependencies (symbol value)
535 "To the custom option SYMBOL, add dependencies specified by VALUE.
536 VALUE should be a list of symbols. For each symbol in that list,
537 this specifies that SYMBOL should be set after the specified symbol, if
538 both appear in constructs like `custom-set-variables'."
539 (unless (listp value)
540 (error "Invalid custom dependency `%s'" value))
541 (let* ((deps (get symbol 'custom-dependencies))
542 (new-deps deps))
543 (while value
544 (let ((dep (car value)))
545 (unless (symbolp dep)
546 (error "Invalid custom dependency `%s'" dep))
547 (unless (memq dep new-deps)
548 (setq new-deps (cons dep new-deps)))
549 (setq value (cdr value))))
550 (unless (eq deps new-deps)
551 (put symbol 'custom-dependencies new-deps))))
553 (defun custom-add-option (symbol option)
554 "To the variable SYMBOL add OPTION.
556 If SYMBOL's custom type is a hook, OPTION should be a hook member.
557 If SYMBOL's custom type is an alist, OPTION specifies a symbol
558 to offer to the user as a possible key in the alist.
559 For other custom types, this has no effect."
560 (let ((options (get symbol 'custom-options)))
561 (unless (member option options)
562 (put symbol 'custom-options (cons option options)))))
563 (defalias 'custom-add-frequent-value 'custom-add-option)
565 (defun custom-add-link (symbol widget)
566 "To the custom option SYMBOL add the link WIDGET."
567 (let ((links (get symbol 'custom-links)))
568 (unless (member widget links)
569 (put symbol 'custom-links (cons (purecopy widget) links)))))
571 (defun custom-add-version (symbol version)
572 "To the custom option SYMBOL add the version VERSION."
573 (put symbol 'custom-version (purecopy version)))
575 (defun custom-add-package-version (symbol version)
576 "To the custom option SYMBOL add the package version VERSION."
577 (put symbol 'custom-package-version (purecopy version)))
579 (defun custom-add-load (symbol load)
580 "To the custom option SYMBOL add the dependency LOAD.
581 LOAD should be either a library file name, or a feature name."
582 (let ((loads (get symbol 'custom-loads)))
583 (unless (member load loads)
584 (put symbol 'custom-loads (cons (purecopy load) loads)))))
586 (defun custom-autoload (symbol load &optional noset)
587 "Mark SYMBOL as autoloaded custom variable and add dependency LOAD.
588 If NOSET is non-nil, don't bother autoloading LOAD when setting the variable."
589 (put symbol 'custom-autoload (if noset 'noset t))
590 (custom-add-load symbol load))
592 ;; This test is also in the C code of `user-variable-p'.
593 (defun custom-variable-p (variable)
594 "Return non-nil if VARIABLE is a custom variable.
595 This recursively follows aliases."
596 (setq variable (indirect-variable variable))
597 (or (get variable 'standard-value)
598 (get variable 'custom-autoload)))
600 (defun custom-note-var-changed (variable)
601 "Inform Custom that VARIABLE has been set (changed).
602 VARIABLE is a symbol that names a user option.
603 The result is that the change is treated as having been made through Custom."
604 (put variable 'customized-value (list (custom-quote (eval variable)))))
607 ;;; Custom Themes
609 ;;; Loading files needed to customize a symbol.
610 ;;; This is in custom.el because menu-bar.el needs it for toggle cmds.
612 (defvar custom-load-recursion nil
613 "Hack to avoid recursive dependencies.")
615 (defun custom-load-symbol (symbol)
616 "Load all dependencies for SYMBOL."
617 (unless custom-load-recursion
618 (let ((custom-load-recursion t))
619 ;; Load these files if not already done,
620 ;; to make sure we know all the dependencies of SYMBOL.
621 (condition-case nil
622 (require 'cus-load)
623 (error nil))
624 (condition-case nil
625 (require 'cus-start)
626 (error nil))
627 (dolist (load (get symbol 'custom-loads))
628 (cond ((symbolp load) (condition-case nil (require load) (error nil)))
629 ;; This is subsumed by the test below, but it's much faster.
630 ((assoc load load-history))
631 ;; This was just (assoc (locate-library load) load-history)
632 ;; but has been optimized not to load locate-library
633 ;; if not necessary.
634 ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
635 "\\(\\'\\|\\.\\)"))
636 (found nil))
637 (dolist (loaded load-history)
638 (and (stringp (car loaded))
639 (string-match regexp (car loaded))
640 (setq found t)))
641 found))
642 ;; Without this, we would load cus-edit recursively.
643 ;; We are still loading it when we call this,
644 ;; and it is not in load-history yet.
645 ((equal load "cus-edit"))
646 (t (condition-case nil (load load) (error nil))))))))
648 (defvar custom-local-buffer nil
649 "Non-nil, in a Customization buffer, means customize a specific buffer.
650 If this variable is non-nil, it should be a buffer,
651 and it means customize the local bindings of that buffer.
652 This variable is a permanent local, and it normally has a local binding
653 in every Customization buffer.")
654 (put 'custom-local-buffer 'permanent-local t)
656 (defun custom-set-default (variable value)
657 "Default :set function for a customizable variable.
658 Normally, this sets the default value of VARIABLE to VALUE,
659 but if `custom-local-buffer' is non-nil,
660 this sets the local binding in that buffer instead."
661 (if custom-local-buffer
662 (with-current-buffer custom-local-buffer
663 (set variable value))
664 (set-default variable value)))
666 (defun custom-set-minor-mode (variable value)
667 ":set function for minor mode variables.
668 Normally, this sets the default value of VARIABLE to nil if VALUE
669 is nil and to t otherwise,
670 but if `custom-local-buffer' is non-nil,
671 this sets the local binding in that buffer instead."
672 (if custom-local-buffer
673 (with-current-buffer custom-local-buffer
674 (funcall variable (if value 1 0)))
675 (funcall variable (if value 1 0))))
677 (defun custom-quote (sexp)
678 "Quote SEXP if it is not self quoting."
679 (if (or (memq sexp '(t nil))
680 (keywordp sexp)
681 (and (listp sexp)
682 (memq (car sexp) '(lambda)))
683 (stringp sexp)
684 (numberp sexp)
685 (vectorp sexp)
686 ;;; (and (fboundp 'characterp)
687 ;;; (characterp sexp))
689 sexp
690 (list 'quote sexp)))
692 (defun customize-mark-to-save (symbol)
693 "Mark SYMBOL for later saving.
695 If the default value of SYMBOL is different from the standard value,
696 set the `saved-value' property to a list whose car evaluates to the
697 default value. Otherwise, set it to nil.
699 To actually save the value, call `custom-save-all'.
701 Return non-nil if the `saved-value' property actually changed."
702 (custom-load-symbol symbol)
703 (let* ((get (or (get symbol 'custom-get) 'default-value))
704 (value (funcall get symbol))
705 (saved (get symbol 'saved-value))
706 (standard (get symbol 'standard-value))
707 (comment (get symbol 'customized-variable-comment)))
708 ;; Save default value if different from standard value.
709 (if (or (null standard)
710 (not (equal value (condition-case nil
711 (eval (car standard))
712 (error nil)))))
713 (put symbol 'saved-value (list (custom-quote value)))
714 (put symbol 'saved-value nil))
715 ;; Clear customized information (set, but not saved).
716 (put symbol 'customized-value nil)
717 ;; Save any comment that might have been set.
718 (when comment
719 (put symbol 'saved-variable-comment comment))
720 (not (equal saved (get symbol 'saved-value)))))
722 (defun customize-mark-as-set (symbol)
723 "Mark current value of SYMBOL as being set from customize.
725 If the default value of SYMBOL is different from the saved value if any,
726 or else if it is different from the standard value, set the
727 `customized-value' property to a list whose car evaluates to the
728 default value. Otherwise, set it to nil.
730 Return non-nil if the `customized-value' property actually changed."
731 (custom-load-symbol symbol)
732 (let* ((get (or (get symbol 'custom-get) 'default-value))
733 (value (funcall get symbol))
734 (customized (get symbol 'customized-value))
735 (old (or (get symbol 'saved-value) (get symbol 'standard-value))))
736 ;; Mark default value as set if different from old value.
737 (if (not (and old
738 (equal value (condition-case nil
739 (eval (car old))
740 (error nil)))))
741 (progn (put symbol 'customized-value (list (custom-quote value)))
742 (custom-push-theme 'theme-value symbol 'user 'set
743 (custom-quote value)))
744 (put symbol 'customized-value nil))
745 ;; Changed?
746 (not (equal customized (get symbol 'customized-value)))))
748 (defun custom-reevaluate-setting (symbol)
749 "Reset the value of SYMBOL by re-evaluating its saved or standard value.
750 Use the :set function to do so. This is useful for customizable options
751 that are defined before their standard value can really be computed.
752 E.g. dumped variables whose default depends on run-time information."
753 (funcall (or (get symbol 'custom-set) 'set-default)
754 symbol
755 (eval (car (or (get symbol 'saved-value) (get symbol 'standard-value))))))
758 ;;; Custom Themes
760 ;; Custom themes are collections of settings that can be enabled or
761 ;; disabled as a unit.
763 ;; Each Custom theme is defined by a symbol, called the theme name.
764 ;; The `theme-settings' property of the theme name records the
765 ;; variable and face settings of the theme. This property is a list
766 ;; of elements, each of the form
768 ;; (PROP SYMBOL THEME VALUE)
770 ;; - PROP is either `theme-value' or `theme-face'
771 ;; - SYMBOL is the face or variable name
772 ;; - THEME is the theme name (redundant, but simplifies the code)
773 ;; - VALUE is an expression that gives the theme's setting for SYMBOL.
775 ;; The theme name also has a `theme-feature' property, whose value is
776 ;; specified when the theme is defined (see `custom-declare-theme').
777 ;; Usually, this is just a symbol named THEME-theme. This lets
778 ;; external libraries call (require 'foo-theme).
780 ;; In addition, each symbol (either a variable or a face) affected by
781 ;; an *enabled* theme has a `theme-value' or `theme-face' property,
782 ;; which is a list of elements each of the form
784 ;; (THEME VALUE)
786 ;; which have the same meanings as in `theme-settings'.
788 ;; The `theme-value' and `theme-face' lists are ordered by decreasing
789 ;; theme precedence. Thus, the first element is always the one that
790 ;; is in effect.
792 ;; Each theme is stored in a theme file, with filename THEME-theme.el.
793 ;; Loading a theme basically involves calling (load "THEME-theme")
794 ;; This is done by the function `load-theme'. Loading a theme
795 ;; automatically enables it.
797 ;; When a theme is enabled, the `theme-value' and `theme-face'
798 ;; properties for the affected symbols are set. When a theme is
799 ;; disabled, its settings are removed from the `theme-value' and
800 ;; `theme-face' properties, but the theme's own `theme-settings'
801 ;; property remains unchanged.
803 (defvar custom-known-themes '(user changed)
804 "Themes that have been defined with `deftheme'.
805 The default value is the list (user changed). The theme `changed'
806 contains the settings before custom themes are applied. The theme
807 `user' contains all the settings the user customized and saved.
808 Additional themes declared with the `deftheme' macro will be added
809 to the front of this list.")
811 (defsubst custom-theme-p (theme)
812 "Non-nil when THEME has been defined."
813 (memq theme custom-known-themes))
815 (defsubst custom-check-theme (theme)
816 "Check whether THEME is valid, and signal an error if it is not."
817 (unless (custom-theme-p theme)
818 (error "Unknown theme `%s'" theme)))
820 (defun custom-push-theme (prop symbol theme mode &optional value)
821 "Record VALUE for face or variable SYMBOL in custom theme THEME.
822 PROP is `theme-face' for a face, `theme-value' for a variable.
824 MODE can be either the symbol `set' or the symbol `reset'. If it is the
825 symbol `set', then VALUE is the value to use. If it is the symbol
826 `reset', then SYMBOL will be removed from THEME (VALUE is ignored).
828 See `custom-known-themes' for a list of known themes."
829 (unless (memq prop '(theme-value theme-face))
830 (error "Unknown theme property"))
831 (let* ((old (get symbol prop))
832 (setting (assq theme old)) ; '(theme value)
833 (theme-settings ; '(prop symbol theme value)
834 (get theme 'theme-settings)))
835 (cond
836 ;; Remove a setting:
837 ((eq mode 'reset)
838 (when setting
839 (let (res)
840 (dolist (theme-setting theme-settings)
841 (if (and (eq (car theme-setting) prop)
842 (eq (cadr theme-setting) symbol))
843 (setq res theme-setting)))
844 (put theme 'theme-settings (delq res theme-settings)))
845 (put symbol prop (delq setting old))))
846 ;; Alter an existing setting:
847 (setting
848 (let (res)
849 (dolist (theme-setting theme-settings)
850 (if (and (eq (car theme-setting) prop)
851 (eq (cadr theme-setting) symbol))
852 (setq res theme-setting)))
853 (put theme 'theme-settings
854 (cons (list prop symbol theme value)
855 (delq res theme-settings)))
856 (setcar (cdr setting) value)))
857 ;; Add a new setting:
859 (unless old
860 ;; If the user changed a variable outside of Customize, save
861 ;; the value to a fake theme, `changed'. If the theme is
862 ;; later disabled, we use this to bring back the old value.
864 ;; For faces, we just use `face-new-frame-defaults' to
865 ;; recompute when the theme is disabled.
866 (when (and (eq prop 'theme-value)
867 (boundp symbol))
868 (let ((sv (get symbol 'standard-value))
869 (val (symbol-value symbol)))
870 (unless (and sv (equal (eval (car sv)) val))
871 (setq old `((changed ,(custom-quote val))))))))
872 (put symbol prop (cons (list theme value) old))
873 (put theme 'theme-settings
874 (cons (list prop symbol theme value) theme-settings))))))
876 (defun custom-fix-face-spec (spec)
877 "Convert face SPEC, replacing obsolete :bold and :italic attributes.
878 Also change :reverse-video to :inverse-video."
879 (when (listp spec)
880 (if (or (memq :bold spec)
881 (memq :italic spec)
882 (memq :inverse-video spec))
883 (let (result)
884 (while spec
885 (let ((key (car spec))
886 (val (car (cdr spec))))
887 (cond ((eq key :italic)
888 (push :slant result)
889 (push (if val 'italic 'normal) result))
890 ((eq key :bold)
891 (push :weight result)
892 (push (if val 'bold 'normal) result))
893 ((eq key :reverse-video)
894 (push :inverse-video result)
895 (push val result))
897 (push key result)
898 (push val result))))
899 (setq spec (cddr spec)))
900 (nreverse result))
901 spec)))
903 (defun custom-set-variables (&rest args)
904 "Install user customizations of variable values specified in ARGS.
905 These settings are registered as theme `user'.
906 The arguments should each be a list of the form:
908 (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
910 This stores EXP (without evaluating it) as the saved value for SYMBOL.
911 If NOW is present and non-nil, then also evaluate EXP and set
912 the default value for the SYMBOL to the value of EXP.
914 REQUEST is a list of features we must require in order to
915 handle SYMBOL properly.
916 COMMENT is a comment string about SYMBOL."
917 (apply 'custom-theme-set-variables 'user args))
919 (defun custom-theme-set-variables (theme &rest args)
920 "Initialize variables for theme THEME according to settings in ARGS.
921 Each of the arguments in ARGS should be a list of this 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.
933 EXP itself is saved unevaluated as SYMBOL property `saved-value' and
934 in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
935 (custom-check-theme theme)
937 ;; Process all the needed autoloads before anything else, so that the
938 ;; subsequent code has all the info it needs (e.g. which var corresponds
939 ;; to a minor mode), regardless of the ordering of the variables.
940 (dolist (entry args)
941 (let* ((symbol (indirect-variable (nth 0 entry))))
942 (unless (or (get symbol 'standard-value)
943 (memq (get symbol 'custom-autoload) '(nil noset)))
944 ;; This symbol needs to be autoloaded, even just for a `set'.
945 (custom-load-symbol symbol))))
947 ;; Move minor modes and variables with explicit requires to the end.
948 (setq args
949 (sort args
950 (lambda (a1 a2)
951 (let* ((sym1 (car a1))
952 (sym2 (car a2))
953 (1-then-2 (memq sym1 (get sym2 'custom-dependencies)))
954 (2-then-1 (memq sym2 (get sym1 'custom-dependencies))))
955 (cond ((and 1-then-2 2-then-1)
956 (error "Circular custom dependency between `%s' and `%s'"
957 sym1 sym2))
958 (2-then-1 nil)
959 ;; 1 is a dependency of 2, so needs to be set first.
960 (1-then-2)
961 ;; Put minor modes and symbols with :require last.
962 ;; Putting minor modes last ensures that the mode
963 ;; function will see other customized values rather
964 ;; than default values.
965 (t (or (nth 3 a2)
966 (eq (get sym2 'custom-set)
967 'custom-set-minor-mode))))))))
969 (dolist (entry args)
970 (unless (listp entry)
971 (error "Incompatible Custom theme spec"))
972 (let* ((symbol (indirect-variable (nth 0 entry)))
973 (value (nth 1 entry)))
974 (custom-push-theme 'theme-value symbol theme 'set value)
975 (unless custom--inhibit-theme-enable
976 ;; Now set the variable.
977 (let* ((now (nth 2 entry))
978 (requests (nth 3 entry))
979 (comment (nth 4 entry))
980 set)
981 (when requests
982 (put symbol 'custom-requests requests)
983 (mapc 'require requests))
984 (setq set (or (get symbol 'custom-set) 'custom-set-default))
985 (put symbol 'saved-value (list value))
986 (put symbol 'saved-variable-comment comment)
987 ;; Allow for errors in the case where the setter has
988 ;; changed between versions, say, but let the user know.
989 (condition-case data
990 (cond (now
991 ;; Rogue variable, set it now.
992 (put symbol 'force-value t)
993 (funcall set symbol (eval value)))
994 ((default-boundp symbol)
995 ;; Something already set this, overwrite it.
996 (funcall set symbol (eval value))))
997 (error
998 (message "Error setting %s: %s" symbol data)))
999 (and (or now (default-boundp symbol))
1000 (put symbol 'variable-comment comment)))))))
1003 ;;; Defining themes.
1005 ;; A theme file is named `THEME-theme.el' (where THEME is the theme
1006 ;; name) found in `custom-theme-load-path'. It has this format:
1008 ;; (deftheme THEME
1009 ;; DOCSTRING)
1011 ;; (custom-theme-set-variables
1012 ;; 'THEME
1013 ;; [THEME-VARIABLES])
1015 ;; (custom-theme-set-faces
1016 ;; 'THEME
1017 ;; [THEME-FACES])
1019 ;; (provide-theme 'THEME)
1022 ;; The IGNORED arguments to deftheme come from the XEmacs theme code, where
1023 ;; they were used to supply keyword-value pairs like `:immediate',
1024 ;; `:variable-reset-string', etc. We don't use any of these, so ignore them.
1026 (defmacro deftheme (theme &optional doc &rest ignored)
1027 "Declare THEME to be a Custom theme.
1028 The optional argument DOC is a doc string describing the theme.
1030 Any theme `foo' should be defined in a file called `foo-theme.el';
1031 see `custom-make-theme-feature' for more information."
1032 (let ((feature (custom-make-theme-feature theme)))
1033 ;; It is better not to use backquote in this file,
1034 ;; because that makes a bootstrapping problem
1035 ;; if you need to recompile all the Lisp files using interpreted code.
1036 (list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc)))
1038 (defun custom-declare-theme (theme feature &optional doc &rest ignored)
1039 "Like `deftheme', but THEME is evaluated as a normal argument.
1040 FEATURE is the feature this theme provides. Normally, this is a symbol
1041 created from THEME by `custom-make-theme-feature'."
1042 (unless (custom-theme-name-valid-p theme)
1043 (error "Custom theme cannot be named %S" theme))
1044 (add-to-list 'custom-known-themes theme)
1045 (put theme 'theme-feature feature)
1046 (when doc (put theme 'theme-documentation doc)))
1048 (defun custom-make-theme-feature (theme)
1049 "Given a symbol THEME, create a new symbol by appending \"-theme\".
1050 Store this symbol in the `theme-feature' property of THEME.
1051 Calling `provide-theme' to provide THEME actually puts `THEME-theme'
1052 into `features'.
1054 This allows for a file-name convention for autoloading themes:
1055 Every theme X has a property `provide-theme' whose value is \"X-theme\".
1056 \(load-theme X) then attempts to load the file `X-theme.el'."
1057 (intern (concat (symbol-name theme) "-theme")))
1059 ;;; Loading themes.
1061 (defcustom custom-theme-directory user-emacs-directory
1062 "Default user directory for storing custom theme files.
1063 The command `customize-create-theme' writes theme files into this
1064 directory. By default, Emacs searches for custom themes in this
1065 directory first---see `custom-theme-load-path'."
1066 :type 'string
1067 :group 'customize
1068 :version "22.1")
1070 (defcustom custom-theme-load-path (list 'custom-theme-directory t)
1071 "List of directories to search for custom theme files.
1072 When loading custom themes (e.g. in `customize-themes' and
1073 `load-theme'), Emacs searches for theme files in the specified
1074 order. Each element in the list should be one of the following:
1075 - the symbol `custom-theme-directory', meaning the value of
1076 `custom-theme-directory'.
1077 - the symbol t, meaning the built-in theme directory (a directory
1078 named \"themes\" in `data-directory').
1079 - a directory name (a string).
1081 Each theme file is named THEME-theme.el, where THEME is the theme
1082 name."
1083 :type '(repeat (choice (const :tag "custom-theme-directory"
1084 custom-theme-directory)
1085 (const :tag "Built-in theme directory" t)
1086 directory))
1087 :group 'customize
1088 :version "24.1")
1090 (defvar custom--inhibit-theme-enable nil
1091 "Whether the custom-theme-set-* functions act immediately.
1092 If nil, `custom-theme-set-variables' and `custom-theme-set-faces'
1093 change the current values of the given variable or face. If
1094 non-nil, they just make a record of the theme settings.")
1096 (defun provide-theme (theme)
1097 "Indicate that this file provides THEME.
1098 This calls `provide' to provide the feature name stored in THEME's
1099 property `theme-feature' (which is usually a symbol created by
1100 `custom-make-theme-feature')."
1101 (unless (custom-theme-name-valid-p theme)
1102 (error "Custom theme cannot be named %S" theme))
1103 (custom-check-theme theme)
1104 (provide (get theme 'theme-feature)))
1106 (defcustom custom-safe-themes '(default)
1107 "Themes that are considered safe to load.
1108 If the value is a list, each element should be either the `sha1'
1109 hash of a safe theme file, or the symbol `default', which stands
1110 for any theme in the built-in Emacs theme directory (a directory
1111 named \"themes\" in `data-directory').
1113 If the value is t, Emacs treats all themes as safe.
1115 This variable cannot be set in a Custom theme."
1116 :type '(choice (repeat :tag "List of safe themes"
1117 (choice string
1118 (const :tag "Built-in themes" default)))
1119 (const :tag "All themes" t))
1120 :group 'customize
1121 :risky t
1122 :version "24.1")
1124 (defun load-theme (theme &optional no-confirm no-enable)
1125 "Load Custom theme named THEME from its file.
1126 The theme file is named THEME-theme.el, in one of the directories
1127 specified by `custom-theme-load-path'.
1129 If optional arg NO-CONFIRM is non-nil, and THEME is not
1130 considered safe according to `custom-safe-themes', prompt the
1131 user for confirmation.
1133 Normally, this function also enables THEME; if optional arg
1134 NO-ENABLE is non-nil, load the theme but don't enable it.
1136 This function is normally called through Customize when setting
1137 `custom-enabled-themes'. If used directly in your init file, it
1138 should be called with a non-nil NO-CONFIRM argument, or after
1139 `custom-safe-themes' has been loaded.
1141 Return t if THEME was successfully loaded, nil otherwise."
1142 (interactive
1143 (list
1144 (intern (completing-read "Load custom theme: "
1145 (mapcar 'symbol-name
1146 (custom-available-themes))))
1147 nil nil))
1148 (unless (custom-theme-name-valid-p theme)
1149 (error "Invalid theme name `%s'" theme))
1150 ;; If reloading, clear out the old theme settings.
1151 (when (custom-theme-p theme)
1152 (disable-theme theme)
1153 (put theme 'theme-settings nil)
1154 (put theme 'theme-feature nil)
1155 (put theme 'theme-documentation nil))
1156 (let ((fn (locate-file (concat (symbol-name theme) "-theme.el")
1157 (custom-theme--load-path)
1158 '("" "c")))
1159 hash)
1160 (unless fn
1161 (error "Unable to find theme file for `%s'" theme))
1162 (with-temp-buffer
1163 (insert-file-contents fn)
1164 (setq hash (sha1 (current-buffer)))
1165 ;; Check file safety with `custom-safe-themes', prompting the
1166 ;; user if necessary.
1167 (when (or no-confirm
1168 (eq custom-safe-themes t)
1169 (and (memq 'default custom-safe-themes)
1170 (equal (file-name-directory fn)
1171 (expand-file-name "themes/" data-directory)))
1172 (member hash custom-safe-themes)
1173 (custom-theme-load-confirm hash))
1174 (let ((custom--inhibit-theme-enable t))
1175 (eval-buffer))
1176 ;; Optimization: if the theme changes the `default' face, put that
1177 ;; entry first. This avoids some `frame-set-background-mode' rigmarole
1178 ;; by assigning the new background immediately.
1179 (let* ((settings (get theme 'theme-settings))
1180 (tail settings)
1181 found)
1182 (while (and tail (not found))
1183 (and (eq (nth 0 (car tail)) 'theme-face)
1184 (eq (nth 1 (car tail)) 'default)
1185 (setq found (car tail)))
1186 (setq tail (cdr tail)))
1187 (if found
1188 (put theme 'theme-settings (cons found (delq found settings)))))
1189 ;; Finally, enable the theme.
1190 (unless no-enable
1191 (enable-theme theme))
1192 t))))
1194 (defun custom-theme-load-confirm (hash)
1195 "Query the user about loading a Custom theme that may not be safe.
1196 The theme should be in the current buffer. If the user agrees,
1197 query also about adding HASH to `custom-safe-themes'."
1198 (if noninteractive
1200 (let ((exit-chars '(?y ?n ?\s))
1201 window prompt char)
1202 (save-window-excursion
1203 (rename-buffer "*Custom Theme*" t)
1204 (emacs-lisp-mode)
1205 (setq window (display-buffer (current-buffer)))
1206 (setq prompt
1207 (format "Loading a theme can run Lisp code. Really load?%s"
1208 (if (and window
1209 (< (line-number-at-pos (point-max))
1210 (window-body-height)))
1211 " (y or n) "
1212 (push ?\C-v exit-chars)
1213 "\nType y or n, or C-v to scroll: ")))
1214 (goto-char (point-min))
1215 (while (null char)
1216 (setq char (read-char-choice prompt exit-chars))
1217 (when (eq char ?\C-v)
1218 (if window
1219 (with-selected-window window
1220 (condition-case nil
1221 (scroll-up)
1222 (error (goto-char (point-min))))))
1223 (setq char nil)))
1224 (when (memq char '(?\s ?y))
1225 ;; Offer to save to `custom-safe-themes'.
1226 (and (or custom-file user-init-file)
1227 (y-or-n-p "Treat this theme as safe in future sessions? ")
1228 (customize-push-and-save 'custom-safe-themes (list hash)))
1229 t)))))
1231 (defun custom-theme-name-valid-p (name)
1232 "Return t if NAME is a valid name for a Custom theme, nil otherwise.
1233 NAME should be a symbol."
1234 (and (symbolp name)
1235 name
1236 (not (or (zerop (length (symbol-name name)))
1237 (eq name 'user)
1238 (eq name 'changed)))))
1240 (defun custom-available-themes ()
1241 "Return a list of available Custom themes (symbols)."
1242 (let (sym themes)
1243 (dolist (dir (custom-theme--load-path))
1244 (when (file-directory-p dir)
1245 (dolist (file (file-expand-wildcards
1246 (expand-file-name "*-theme.el" dir) t))
1247 (setq file (file-name-nondirectory file))
1248 (and (string-match "\\`\\(.+\\)-theme.el\\'" file)
1249 (setq sym (intern (match-string 1 file)))
1250 (custom-theme-name-valid-p sym)
1251 (push sym themes)))))
1252 (nreverse (delete-dups themes))))
1254 (defun custom-theme--load-path ()
1255 (let (lpath)
1256 (dolist (f custom-theme-load-path)
1257 (cond ((eq f 'custom-theme-directory)
1258 (setq f custom-theme-directory))
1259 ((eq f t)
1260 (setq f (expand-file-name "themes" data-directory))))
1261 (if (file-directory-p f)
1262 (push f lpath)))
1263 (nreverse lpath)))
1266 ;;; Enabling and disabling loaded themes.
1268 (defun enable-theme (theme)
1269 "Reenable all variable and face settings defined by THEME.
1270 THEME should be either `user', or a theme loaded via `load-theme'.
1271 After this function completes, THEME will have the highest
1272 precedence (after `user')."
1273 (interactive (list (intern
1274 (completing-read
1275 "Enable custom theme: "
1276 obarray (lambda (sym) (get sym 'theme-settings)) t))))
1277 (if (not (custom-theme-p theme))
1278 (error "Undefined Custom theme %s" theme))
1279 (let ((settings (get theme 'theme-settings)))
1280 ;; Loop through theme settings, recalculating vars/faces.
1281 (dolist (s settings)
1282 (let* ((prop (car s))
1283 (symbol (cadr s))
1284 (spec-list (get symbol prop)))
1285 (put symbol prop (cons (cddr s) (assq-delete-all theme spec-list)))
1286 (cond
1287 ((eq prop 'theme-face)
1288 (custom-theme-recalc-face symbol))
1289 ((eq prop 'theme-value)
1290 ;; Ignore `custom-enabled-themes' and `custom-safe-themes'.
1291 (unless (memq symbol '(custom-enabled-themes custom-safe-themes))
1292 (custom-theme-recalc-variable symbol)))))))
1293 (unless (eq theme 'user)
1294 (setq custom-enabled-themes
1295 (cons theme (delq theme custom-enabled-themes)))
1296 ;; Give the `user' theme the highest priority.
1297 (enable-theme 'user)))
1299 (defcustom custom-enabled-themes nil
1300 "List of enabled Custom Themes, highest precedence first.
1301 This list does not include the `user' theme, which is set by
1302 Customize and always takes precedence over other Custom Themes.
1304 This variable cannot be defined inside a Custom theme; there, it
1305 is simply ignored.
1307 Setting this variable through Customize calls `enable-theme' or
1308 `load-theme' for each theme in the list."
1309 :group 'customize
1310 :type '(repeat symbol)
1311 :set-after '(custom-theme-directory custom-theme-load-path
1312 custom-safe-themes)
1313 :risky t
1314 :set (lambda (symbol themes)
1315 (let (failures)
1316 (setq themes (delq 'user (delete-dups themes)))
1317 ;; Disable all themes not in THEMES.
1318 (if (boundp symbol)
1319 (dolist (theme (symbol-value symbol))
1320 (if (not (memq theme themes))
1321 (disable-theme theme))))
1322 ;; Call `enable-theme' or `load-theme' on each of THEMES.
1323 (dolist (theme (reverse themes))
1324 (condition-case nil
1325 (if (custom-theme-p theme)
1326 (enable-theme theme)
1327 (load-theme theme))
1328 (error (setq failures (cons theme failures)
1329 themes (delq theme themes)))))
1330 (enable-theme 'user)
1331 (custom-set-default symbol themes)
1332 (if failures
1333 (message "Failed to enable theme: %s"
1334 (mapconcat 'symbol-name failures ", "))))))
1336 (defsubst custom-theme-enabled-p (theme)
1337 "Return non-nil if THEME is enabled."
1338 (memq theme custom-enabled-themes))
1340 (defun disable-theme (theme)
1341 "Disable all variable and face settings defined by THEME.
1342 See `custom-enabled-themes' for a list of enabled themes."
1343 (interactive (list (intern
1344 (completing-read
1345 "Disable custom theme: "
1346 (mapcar 'symbol-name custom-enabled-themes)
1347 nil t))))
1348 (when (custom-theme-enabled-p theme)
1349 (let ((settings (get theme 'theme-settings)))
1350 (dolist (s settings)
1351 (let* ((prop (car s))
1352 (symbol (cadr s))
1353 (val (assq-delete-all theme (get symbol prop))))
1354 (put symbol prop val)
1355 (cond
1356 ((eq prop 'theme-value)
1357 (custom-theme-recalc-variable symbol))
1358 ((eq prop 'theme-face)
1359 ;; If the face spec specified by this theme is in the
1360 ;; saved-face property, reset that property.
1361 (when (equal (nth 3 s) (get symbol 'saved-face))
1362 (put symbol 'saved-face (and val (cadr (car val)))))))))
1363 ;; Recompute faces on all frames.
1364 (dolist (frame (frame-list))
1365 ;; We must reset the fg and bg color frame parameters, or
1366 ;; `face-set-after-frame-default' will use the existing
1367 ;; parameters, which could be from the disabled theme.
1368 (set-frame-parameter frame 'background-color
1369 (custom--frame-color-default
1370 frame :background "background" "Background"
1371 "unspecified-bg" "white"))
1372 (set-frame-parameter frame 'foreground-color
1373 (custom--frame-color-default
1374 frame :foreground "foreground" "Foreground"
1375 "unspecified-fg" "black"))
1376 (face-set-after-frame-default frame))
1377 (setq custom-enabled-themes
1378 (delq theme custom-enabled-themes)))))
1380 (defun custom--frame-color-default (frame attribute resource-attr resource-class
1381 tty-default x-default)
1382 (let ((col (face-attribute 'default attribute t)))
1383 (cond
1384 ((and col (not (eq col 'unspecified))) col)
1385 ((null (window-system frame)) tty-default)
1386 ((setq col (x-get-resource resource-attr resource-class)) col)
1387 (t x-default))))
1389 (defun custom-variable-theme-value (variable)
1390 "Return (list VALUE) indicating the custom theme value of VARIABLE.
1391 That is to say, it specifies what the value should be according to
1392 currently enabled custom themes.
1394 This function returns nil if no custom theme specifies a value for VARIABLE."
1395 (let ((theme-value (get variable 'theme-value)))
1396 (if theme-value
1397 (cdr (car theme-value)))))
1399 (defun custom-theme-recalc-variable (variable)
1400 "Set VARIABLE according to currently enabled custom themes."
1401 (let ((valspec (custom-variable-theme-value variable)))
1402 (if valspec
1403 (put variable 'saved-value valspec)
1404 (setq valspec (get variable 'standard-value)))
1405 (if (and valspec
1406 (or (get variable 'force-value)
1407 (default-boundp variable)))
1408 (funcall (or (get variable 'custom-set) 'set-default) variable
1409 (eval (car valspec))))))
1411 (defun custom-theme-recalc-face (face)
1412 "Set FACE according to currently enabled custom themes."
1413 (if (get face 'face-alias)
1414 (setq face (get face 'face-alias)))
1415 ;; Reset the faces for each frame.
1416 (dolist (frame (frame-list))
1417 (face-spec-recalc face frame)))
1420 ;;; XEmacs compatibility functions
1422 ;; In XEmacs, when you reset a Custom Theme, you have to specify the
1423 ;; theme to reset it to. We just apply the next available theme, so
1424 ;; just ignore the IGNORED arguments.
1426 (defun custom-theme-reset-variables (theme &rest args)
1427 "Reset some variable settings in THEME to their values in other themes.
1428 Each of the arguments ARGS has this form:
1430 (VARIABLE IGNORED)
1432 This means reset VARIABLE. (The argument IGNORED is ignored)."
1433 (custom-check-theme theme)
1434 (dolist (arg args)
1435 (custom-push-theme 'theme-value (car arg) theme 'reset)))
1437 (defun custom-reset-variables (&rest args)
1438 "Reset the specs of some variables to their values in other themes.
1439 This creates settings in the `user' theme.
1441 Each of the arguments ARGS has this form:
1443 (VARIABLE IGNORED)
1445 This means reset VARIABLE. (The argument IGNORED is ignored)."
1446 (apply 'custom-theme-reset-variables 'user args))
1448 ;;; The End.
1450 ;; Process the defcustoms for variables loaded before this file.
1451 (while custom-declare-variable-list
1452 (apply 'custom-declare-variable (car custom-declare-variable-list))
1453 (setq custom-declare-variable-list (cdr custom-declare-variable-list)))
1455 (provide 'custom)
1457 ;;; custom.el ends here