custom.el 45.9 KB
Newer Older
1 2
;;; custom.el --- tools for declaring and initializing options
;;
3
;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 6 7 8 9 10 11 12 13
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Maintainer: FSF
;; Keywords: help, faces

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
14
;; the Free Software Foundation; either version 3, or (at your option)
15 16 17 18 19 20 21 22 23
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
26 27 28

;;; Commentary:
;;
Markus Rost's avatar
Markus Rost committed
29
;; This file only contains the code needed to declare and initialize
30 31 32
;; user options.  The code to customize options is autoloaded from
;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual.

Markus Rost's avatar
Markus Rost committed
33
;; The code implementing face declarations is in `cus-face.el'.
34 35 36 37 38 39 40 41 42

;;; Code:

(require 'widget)

(defvar custom-define-hook nil
  ;; Customize information for this option is in `cus-edit.el'.
  "Hook called after defining each customize option.")

43 44 45 46 47
(defvar custom-dont-initialize nil
  "Non-nil means `defcustom' should not initialize the variable.
That is used for the sake of `custom-make-dependencies'.
Users should not set it.")

48 49 50
(defvar custom-current-group-alist nil
  "Alist of (FILE . GROUP) indicating the current group to use for FILE.")

51 52 53 54 55 56
;;; The `defcustom' Macro.

(defun custom-initialize-default (symbol value)
  "Initialize SYMBOL with VALUE.
This will do nothing if symbol already has a default binding.
Otherwise, if symbol has a `saved-value' property, it will evaluate
57
the car of that and use it as the default binding for symbol.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
Otherwise, VALUE will be evaluated and used as the default binding for
symbol."
  (unless (default-boundp symbol)
    ;; Use the saved value if it exists, otherwise the standard setting.
    (set-default symbol (if (get symbol 'saved-value)
			    (eval (car (get symbol 'saved-value)))
			  (eval value)))))

(defun custom-initialize-set (symbol value)
  "Initialize SYMBOL based on VALUE.
If the symbol doesn't have a default binding already,
then set it using its `:set' function (or `set-default' if it has none).
The value is either the value in the symbol's `saved-value' property,
if any, or VALUE."
  (unless (default-boundp symbol)
    (funcall (or (get symbol 'custom-set) 'set-default)
	     symbol
	     (if (get symbol 'saved-value)
		 (eval (car (get symbol 'saved-value)))
	       (eval value)))))

79 80 81 82
(defun custom-initialize-safe-set (symbol value)
  "Like `custom-initialize-set', but catches errors.
If an error occurs during initialization, SYMBOL is set to nil
and no error is thrown.  This is meant for use in pre-loaded files
83
where some variables or functions used to compute VALUE may not yet
Luc Teirlinck's avatar
Luc Teirlinck committed
84
be defined.  You can then re-evaluate VALUE in startup.el, for instance
85
using `custom-reevaluate-setting'."
86 87 88 89 90 91 92 93
  (condition-case nil
      (custom-initialize-set symbol value)
    (error (set-default symbol nil))))

(defun custom-initialize-safe-default (symbol value)
  "Like `custom-initialize-default', but catches errors.
If an error occurs during initialization, SYMBOL is set to nil
and no error is thrown.  This is meant for use in pre-loaded files
94
where some variables or functions used to compute VALUE may not yet
Luc Teirlinck's avatar
Luc Teirlinck committed
95
be defined.  You can then re-evaluate VALUE in startup.el, for instance
96
using `custom-reevaluate-setting'."
97 98 99 100
  (condition-case nil
      (custom-initialize-default symbol value)
    (error (set-default symbol nil))))

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
(defun custom-initialize-reset (symbol value)
  "Initialize SYMBOL based on VALUE.
Set the symbol, using its `:set' function (or `set-default' if it has none).
The value is either the symbol's current value
 \(as obtained using the `:get' function), if any,
or the value in the symbol's `saved-value' property if any,
or (last of all) VALUE."
    (funcall (or (get symbol 'custom-set) 'set-default)
	     symbol
	     (cond ((default-boundp symbol)
		    (funcall (or (get symbol 'custom-get) 'default-value)
			     symbol))
		   ((get symbol 'saved-value)
		    (eval (car (get symbol 'saved-value))))
		   (t
		    (eval value)))))

(defun custom-initialize-changed (symbol value)
  "Initialize SYMBOL with VALUE.
Like `custom-initialize-reset', but only use the `:set' function if
not using the standard setting.
For the standard setting, use `set-default'."
  (cond ((default-boundp symbol)
	 (funcall (or (get symbol 'custom-set) 'set-default)
		  symbol
		  (funcall (or (get symbol 'custom-get) 'default-value)
			   symbol)))
	((get symbol 'saved-value)
	 (funcall (or (get symbol 'custom-set) 'set-default)
		  symbol
		  (eval (car (get symbol 'saved-value)))))
	(t
	 (set-default symbol (eval value)))))

(defun custom-declare-variable (symbol default doc &rest args)
  "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments.
DEFAULT should be an expression to evaluate to compute the default value,
138 139
not the default value itself.

140
DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property
141 142
`standard-value'.  At the same time, SYMBOL's property `force-value' is
set to nil, as the value is no longer rogue."
143 144 145 146 147 148 149 150
  (put symbol 'standard-value (list default))
  ;; Maybe this option was rogue in an earlier version.  It no longer is.
  (when (get symbol 'force-value)
    (put symbol 'force-value nil))
  (when doc
    (put symbol 'variable-documentation doc))
  (let ((initialize 'custom-initialize-reset)
	(requests nil))
151 152
    (unless (memq :group args)
      (custom-add-to-group (custom-current-group) symbol 'custom-variable))
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
    (while args
      (let ((arg (car args)))
	(setq args (cdr args))
	(unless (symbolp arg)
	  (error "Junk in args %S" args))
	(let ((keyword arg)
	      (value (car args)))
	  (unless args
	    (error "Keyword %s is missing an argument" keyword))
	  (setq args (cdr args))
	  (cond ((eq keyword :initialize)
		 (setq initialize value))
		((eq keyword :set)
		 (put symbol 'custom-set value))
		((eq keyword :get)
		 (put symbol 'custom-get value))
		((eq keyword :require)
170
		 (push value requests))
171 172 173 174
		((eq keyword :risky)
		 (put symbol 'risky-local-variable value))
		((eq keyword :safe)
		 (put symbol 'safe-local-variable value))
175 176 177 178 179 180 181
		((eq keyword :type)
		 (put symbol 'custom-type (purecopy value)))
		((eq keyword :options)
		 (if (get symbol 'custom-options)
		     ;; Slow safe code to avoid duplicates.
		     (mapc (lambda (option)
			     (custom-add-option symbol option))
182
			   value)
183 184 185 186 187 188 189
		   ;; Fast code for the common case.
		   (put symbol 'custom-options (copy-sequence value))))
		(t
		 (custom-handle-keyword symbol keyword value
					'custom-variable))))))
    (put symbol 'custom-requests requests)
    ;; Do the actual initialization.
190 191
    (unless custom-dont-initialize
      (funcall initialize symbol default)))
192
  (push symbol current-load-list)
193 194 195 196 197 198 199
  (run-hooks 'custom-define-hook)
  symbol)

(defmacro defcustom (symbol value doc &rest args)
  "Declare SYMBOL as a customizable variable that defaults to VALUE.
DOC is the variable documentation.

200
Neither SYMBOL nor VALUE need to be quoted.
201 202 203 204 205 206 207
If SYMBOL is not already bound, initialize it to VALUE.
The remaining arguments should have the form

   [KEYWORD VALUE]...

The following keywords are meaningful:

Richard M. Stallman's avatar
Richard M. Stallman committed
208
:type	VALUE should be a widget type for editing the symbol's value.
209
:options VALUE should be a list of valid members of the widget type.
210 211 212 213 214 215 216
:initialize
	VALUE should be a function used to initialize the
	variable.  It takes two arguments, the symbol and value
	given in the `defcustom' call.  The default is
	`custom-initialize-reset'.
:set	VALUE should be a function to set the value of the symbol.
	It takes two arguments, the symbol to set and the value to
Glenn Morris's avatar
Glenn Morris committed
217
	give it.  The default choice of function is `set-default'.
218 219 220
:get	VALUE should be a function to extract the value of symbol.
	The function takes one argument, a symbol, and should return
	the current value for that symbol.  The default choice of function
Glenn Morris's avatar
Glenn Morris committed
221
	is `default-value'.
222 223 224 225
:require
	VALUE should be a feature symbol.  If you save a value
	for this option, then when your `.emacs' file loads the value,
	it does (require VALUE) first.
226 227
:risky	Set SYMBOL's `risky-local-variable' property to VALUE.
:safe	Set SYMBOL's `safe-local-variable' property to VALUE.
228 229 230

The following common keywords are also meaningful.

231
:group  VALUE should be a customization group.
232
        Add SYMBOL (or FACE with `defface') to that group.
233
:link LINK-DATA
234 235 236
        Include an external link after the documentation string for this
        item.  This is a sentence containing an active field which
        references some other documentation.
237

238
        There are several alternatives you can use for LINK-DATA:
239

240
        (custom-manual INFO-NODE)
241
             Link to an Info node; INFO-NODE is a string which specifies
242
             the node name, as in \"(emacs)Top\".
243

244
        (info-link INFO-NODE)
245 246
             Like `custom-manual' except that the link appears in the
             customization buffer with the Info node name.
247

248
        (url-link URL)
249
             Link to a web page; URL is a string which specifies the URL.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267

        (emacs-commentary-link LIBRARY)
             Link to the commentary section of LIBRARY.

        (emacs-library-link LIBRARY)
             Link to an Emacs Lisp LIBRARY file.

        (file-link FILE)
             Link to FILE.

        (function-link FUNCTION)
             Link to the documentation of FUNCTION.

        (variable-link VARIABLE)
             Link to the documentation of VARIABLE.

        (custom-group-link GROUP)
             Link to another customization GROUP.
268

269 270
        You can specify the text to use in the customization buffer by
        adding `:tag NAME' after the first element of the LINK-DATA; for
271
        example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the
272
        Emacs manual which appears in the buffer as `foo'.
273

274 275
        An item can have more than one external link; however, most items
        have none at all.
276 277 278 279
:version
        VALUE should be a string specifying that the variable was
        first introduced, or its default value was changed, in Emacs
        version VERSION.
280
:package-version
281
        VALUE should be a list with the form (PACKAGE . VERSION)
282 283 284 285
        specifying that the variable was first introduced, or its
        default value was changed, in PACKAGE version VERSION.  This
        keyword takes priority over :version.  The PACKAGE and VERSION
        must appear in the alist `customize-package-emacs-version-alist'.
286 287 288
        Since PACKAGE must be unique and the user might see it in an
        error message, a good choice is the official name of the
        package, such as MH-E or Gnus.
289 290
:tag LABEL
        Use LABEL, a string, instead of the item's name, to label the item
Pavel Janík's avatar
Pavel Janík committed
291
        in customization menus and buffers.
292 293
:load FILE
        Load file FILE (a string) before displaying this customization
294
        item.  Loading is done with `load', and only if the file is
295
        not already loaded.
296 297 298
:set-after VARIABLES
	Specifies that SYMBOL should be set after the list of variables
        VARIABLES when both have been customized.
299

Luc Teirlinck's avatar
Luc Teirlinck committed
300 301 302 303 304 305 306
If SYMBOL has a local binding, then this form affects the local
binding.  This is normally not what you want.  Thus, if you need
to load a file defining variables with this form, or with
`defvar' or `defconst', you should always load that file
_outside_ any bindings for these variables.  \(`defvar' and
`defconst' behave similarly in this respect.)

307 308
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
309
  (declare (doc-string 3))
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
  ;; It is better not to use backquote in this file,
  ;; because that makes a bootstrapping problem
  ;; if you need to recompile all the Lisp files using interpreted code.
  (nconc (list 'custom-declare-variable
	       (list 'quote symbol)
	       (list 'quote value)
	       doc)
	 args))

;;; The `defface' Macro.

(defmacro defface (face spec doc &rest args)
  "Declare FACE as a customizable face that defaults to SPEC.
FACE does not need to be quoted.

Third argument DOC is the face documentation.

Sam Steingold's avatar
Sam Steingold committed
327
If FACE has been set with `custom-set-faces', set the face attributes
328 329 330 331 332 333 334
as specified by that function, otherwise set the face attributes
according to SPEC.

The remaining arguments should have the form

   [KEYWORD VALUE]...

335 336
For a list of valid keywords, see the common keywords listed in
`defcustom'.
337 338 339

SPEC should be an alist of the form ((DISPLAY ATTS)...).

340
In the first element, DISPLAY can be `default'.  The ATTS in that
Richard M. Stallman's avatar
Richard M. Stallman committed
341 342 343 344 345 346 347 348 349
element then act as defaults for all the following elements.

Aside from that, DISPLAY specifies conditions to match some or
all frames.  For each frame, the first element of SPEC where the
DISPLAY conditions are satisfied is the one that applies to that
frame.  The ATTRs in this element take effect, and the following
elements are ignored, on that frame.

In the last element, DISPLAY can be t.  That element applies to a
350
frame if none of the previous elements (except the `default' if
Richard M. Stallman's avatar
Richard M. Stallman committed
351
any) did.
352 353 354 355 356 357

ATTS is a list of face attributes followed by their values:
  (ATTR VALUE ATTR VALUE...)

The possible attributes are `:family', `:width', `:height', `:weight',
`:slant', `:underline', `:overline', `:strike-through', `:box',
358
`:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'.
359

360
DISPLAY can be `default' (only in the first element), the symbol
Richard M. Stallman's avatar
Richard M. Stallman committed
361 362 363 364 365
t (only in the last element) to match all frames, or an alist of
conditions of the form \(REQ ITEM...).  For such an alist to
match a frame, each of the conditions must be satisfied, meaning
that the REQ property of the frame must match one of the
corresponding ITEMs.  These are the defined REQ values:
366 367 368

`type' (the value of `window-system')
  Under X, in addition to the values `window-system' can take,
369 370
  `motif', `lucid', `gtk' and `x-toolkit' are allowed, and match when
  the Motif toolkit, Lucid toolkit, GTK toolkit or any X toolkit is in use.
371 372 373 374 375 376 377

`class' (the frame's color support)
  Should be one of `color', `grayscale', or `mono'.

`background' (what color is used for the background text)
  Should be one of `light' or `dark'.

378 379 380 381
`min-colors' (the minimum number of colors the frame should support)
  Should be an integer, it is compared with the result of
  `display-color-cells'.

382 383 384 385 386
`supports' (only match frames that support the specified face attributes)
  Should be a list of face attributes.  See the documentation for
  the function `display-supports-face-attributes-p' for more
  information on exactly how testing is done.

387 388
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
389
  (declare (doc-string 3))
390 391 392 393 394 395 396
  ;; It is better not to use backquote in this file,
  ;; because that makes a bootstrapping problem
  ;; if you need to recompile all the Lisp files using interpreted code.
  (nconc (list 'custom-declare-face (list 'quote face) spec doc) args))

;;; The `defgroup' Macro.

397 398 399
(defun custom-current-group ()
  (cdr (assoc load-file-name custom-current-group-alist)))

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
(defun custom-declare-group (symbol members doc &rest args)
  "Like `defgroup', but SYMBOL is evaluated as a normal argument."
  (while members
    (apply 'custom-add-to-group symbol (car members))
    (setq members (cdr members)))
  (when doc
    ;; This text doesn't get into DOC.
    (put symbol 'group-documentation (purecopy doc)))
  (while args
    (let ((arg (car args)))
      (setq args (cdr args))
      (unless (symbolp arg)
	(error "Junk in args %S" args))
      (let ((keyword arg)
	    (value (car args)))
	(unless args
	  (error "Keyword %s is missing an argument" keyword))
	(setq args (cdr args))
	(cond ((eq keyword :prefix)
	       (put symbol 'custom-prefix value))
	      (t
	       (custom-handle-keyword symbol keyword value
				      'custom-group))))))
423 424 425 426
  ;; Record the group on the `current' list.
  (let ((elt (assoc load-file-name custom-current-group-alist)))
    (if elt (setcdr elt symbol)
      (push (cons load-file-name symbol) custom-current-group-alist)))
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
  (run-hooks 'custom-define-hook)
  symbol)

(defmacro defgroup (symbol members doc &rest args)
  "Declare SYMBOL as a customization group containing MEMBERS.
SYMBOL does not need to be quoted.

Third arg DOC is the group documentation.

MEMBERS should be an alist of the form ((NAME WIDGET)...) where
NAME is a symbol and WIDGET is a widget for editing that symbol.
Useful widgets are `custom-variable' for editing variables,
`custom-face' for edit faces, and `custom-group' for editing groups.

The remaining arguments should have the form

   [KEYWORD VALUE]...

445 446
For a list of valid keywords, see the common keywords listed in
`defcustom'.
447

448 449
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
450
  (declare (doc-string 3))
451 452 453 454 455 456 457 458 459 460 461 462 463
  ;; It is better not to use backquote in this file,
  ;; because that makes a bootstrapping problem
  ;; if you need to recompile all the Lisp files using interpreted code.
  (nconc (list 'custom-declare-group (list 'quote symbol) members doc) args))

(defun custom-add-to-group (group option widget)
  "To existing GROUP add a new OPTION of type WIDGET.
If there already is an entry for OPTION and WIDGET, nothing is done."
  (let ((members (get group 'custom-group))
	(entry (list option widget)))
    (unless (member entry members)
      (put group 'custom-group (nconc members (list entry))))))

464 465 466 467 468 469 470 471 472 473 474
(defun custom-group-of-mode (mode)
  "Return the custom group corresponding to the major or minor MODE.
If no such group is found, return nil."
  (or (get mode 'custom-mode-group)
      (if (or (get mode 'custom-group)
	      (and (string-match "-mode\\'" (symbol-name mode))
		   (get (setq mode (intern (substring (symbol-name mode)
						      0 (match-beginning 0))))
			'custom-group)))
	  mode)))

475 476 477 478 479
;;; Properties.

(defun custom-handle-all-keywords (symbol args type)
  "For customization option SYMBOL, handle keyword arguments ARGS.
Third argument TYPE is the custom option type."
480
  (unless (memq :group args)
481
    (custom-add-to-group (custom-current-group) symbol type))
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
  (while args
    (let ((arg (car args)))
      (setq args (cdr args))
      (unless (symbolp arg)
	(error "Junk in args %S" args))
      (let ((keyword arg)
	    (value (car args)))
	(unless args
	  (error "Keyword %s is missing an argument" keyword))
	(setq args (cdr args))
	(custom-handle-keyword symbol keyword value type)))))

(defun custom-handle-keyword (symbol keyword value type)
  "For customization option SYMBOL, handle KEYWORD with VALUE.
Fourth argument TYPE is the custom option type."
  (if purify-flag
      (setq value (purecopy value)))
  (cond ((eq keyword :group)
	 (custom-add-to-group value symbol type))
	((eq keyword :version)
	 (custom-add-version symbol value))
503 504
	((eq keyword :package-version)
	 (custom-add-package-version symbol value))
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
	((eq keyword :link)
	 (custom-add-link symbol value))
	((eq keyword :load)
	 (custom-add-load symbol value))
	((eq keyword :tag)
	 (put symbol 'custom-tag value))
	((eq keyword :set-after)
	 (custom-add-dependencies symbol value))
	(t
	 (error "Unknown keyword %s" keyword))))

(defun custom-add-dependencies (symbol value)
  "To the custom option SYMBOL, add dependencies specified by VALUE.
VALUE should be a list of symbols.  For each symbol in that list,
this specifies that SYMBOL should be set after the specified symbol, if
both appear in constructs like `custom-set-variables'."
  (unless (listp value)
    (error "Invalid custom dependency `%s'" value))
  (let* ((deps (get symbol 'custom-dependencies))
	 (new-deps deps))
    (while value
      (let ((dep (car value)))
	(unless (symbolp dep)
	  (error "Invalid custom dependency `%s'" dep))
	(unless (memq dep new-deps)
	  (setq new-deps (cons dep new-deps)))
	(setq value (cdr value))))
    (unless (eq deps new-deps)
      (put symbol 'custom-dependencies new-deps))))
534

535 536 537
(defun custom-add-option (symbol option)
  "To the variable SYMBOL add OPTION.

538 539 540 541
If SYMBOL's custom type is a hook, OPTION should be a hook member.
If SYMBOL's custom type is an alist, OPTION specifies a symbol
to offer to the user as a possible key in the alist.
For other custom types, this has no effect."
542 543 544
  (let ((options (get symbol 'custom-options)))
    (unless (member option options)
      (put symbol 'custom-options (cons option options)))))
545
(defalias 'custom-add-frequent-value 'custom-add-option)
546 547 548 549 550 551 552 553 554 555 556

(defun custom-add-link (symbol widget)
  "To the custom option SYMBOL add the link WIDGET."
  (let ((links (get symbol 'custom-links)))
    (unless (member widget links)
      (put symbol 'custom-links (cons (purecopy widget) links)))))

(defun custom-add-version (symbol version)
  "To the custom option SYMBOL add the version VERSION."
  (put symbol 'custom-version (purecopy version)))

557 558 559 560
(defun custom-add-package-version (symbol version)
  "To the custom option SYMBOL add the package version VERSION."
  (put symbol 'custom-package-version (purecopy version)))

561 562 563 564 565 566 567
(defun custom-add-load (symbol load)
  "To the custom option SYMBOL add the dependency LOAD.
LOAD should be either a library file name, or a feature name."
  (let ((loads (get symbol 'custom-loads)))
    (unless (member load loads)
      (put symbol 'custom-loads (cons (purecopy load) loads)))))

568 569 570 571
(defun custom-autoload (symbol load &optional noset)
  "Mark SYMBOL as autoloaded custom variable and add dependency LOAD.
If NOSET is non-nil, don't bother autoloading LOAD when setting the variable."
  (put symbol 'custom-autoload (if noset 'noset t))
572 573 574 575
  (custom-add-load symbol load))

;; This test is also in the C code of `user-variable-p'.
(defun custom-variable-p (variable)
576 577 578
  "Return non-nil if VARIABLE is a custom variable.
This recursively follows aliases."
  (setq variable (indirect-variable variable))
579 580 581
  (or (get variable 'standard-value)
      (get variable 'custom-autoload)))

582 583 584 585 586
(defun custom-note-var-changed (variable)
  "Inform Custom that VARIABLE has been set (changed).
VARIABLE is a symbol that names a user option.
The result is that the change is treated as having been made through Custom."
  (put variable 'customized-value (list (custom-quote (eval variable)))))
587 588 589


;;; Custom Themes
590

591 592 593 594 595 596 597 598 599
;;; Loading files needed to customize a symbol.
;;; This is in custom.el because menu-bar.el needs it for toggle cmds.

(defvar custom-load-recursion nil
  "Hack to avoid recursive dependencies.")

(defun custom-load-symbol (symbol)
  "Load all dependencies for SYMBOL."
  (unless custom-load-recursion
600
    (let ((custom-load-recursion t))
601 602 603 604 605 606 607 608
      ;; Load these files if not already done,
      ;; to make sure we know all the dependencies of SYMBOL.
      (condition-case nil
	  (require 'cus-load)
	(error nil))
      (condition-case nil
	  (require 'cus-start)
	(error nil))
609 610 611
      (dolist (load (get symbol 'custom-loads))
	(cond ((symbolp load) (condition-case nil (require load) (error nil)))
	      ;; This is subsumed by the test below, but it's much faster.
612 613 614 615
	      ((assoc load load-history))
	      ;; This was just (assoc (locate-library load) load-history)
	      ;; but has been optimized not to load locate-library
	      ;; if not necessary.
616 617 618
	      ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
				     "\\(\\'\\|\\.\\)"))
		     (found nil))
619
		 (dolist (loaded load-history)
620 621
		   (and (stringp (car loaded))
			(string-match regexp (car loaded))
622 623 624 625 626 627
			(setq found t)))
		 found))
	      ;; Without this, we would load cus-edit recursively.
	      ;; We are still loading it when we call this,
	      ;; and it is not in load-history yet.
	      ((equal load "cus-edit"))
628
	      (t (condition-case nil (load load) (error nil))))))))
629

630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
(defvar custom-local-buffer nil
  "Non-nil, in a Customization buffer, means customize a specific buffer.
If this variable is non-nil, it should be a buffer,
and it means customize the local bindings of that buffer.
This variable is a permanent local, and it normally has a local binding
in every Customization buffer.")
(put 'custom-local-buffer 'permanent-local t)

(defun custom-set-default (variable value)
  "Default :set function for a customizable variable.
Normally, this sets the default value of VARIABLE to VALUE,
but if `custom-local-buffer' is non-nil,
this sets the local binding in that buffer instead."
  (if custom-local-buffer
      (with-current-buffer custom-local-buffer
	(set variable value))
    (set-default variable value)))

(defun custom-set-minor-mode (variable value)
  ":set function for minor mode variables.
Normally, this sets the default value of VARIABLE to nil if VALUE
is nil and to t otherwise,
but if `custom-local-buffer' is non-nil,
this sets the local binding in that buffer instead."
  (if custom-local-buffer
      (with-current-buffer custom-local-buffer
	(funcall variable (if value 1 0)))
    (funcall variable (if value 1 0))))

(defun custom-quote (sexp)
660
  "Quote SEXP if it is not self quoting."
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
  (if (or (memq sexp '(t nil))
	  (keywordp sexp)
	  (and (listp sexp)
	       (memq (car sexp) '(lambda)))
	  (stringp sexp)
	  (numberp sexp)
	  (vectorp sexp)
;;;  	  (and (fboundp 'characterp)
;;;  	       (characterp sexp))
	  )
      sexp
    (list 'quote sexp)))

(defun customize-mark-to-save (symbol)
  "Mark SYMBOL for later saving.

If the default value of SYMBOL is different from the standard value,
set the `saved-value' property to a list whose car evaluates to the
default value.  Otherwise, set it to nil.

To actually save the value, call `custom-save-all'.

683
Return non-nil if the `saved-value' property actually changed."
684
  (custom-load-symbol symbol)
685 686 687 688 689
  (let* ((get (or (get symbol 'custom-get) 'default-value))
	 (value (funcall get symbol))
	 (saved (get symbol 'saved-value))
	 (standard (get symbol 'standard-value))
	 (comment (get symbol 'customized-variable-comment)))
690
    ;; Save default value if different from standard value.
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
    (if (or (null standard)
	    (not (equal value (condition-case nil
				  (eval (car standard))
				(error nil)))))
	(put symbol 'saved-value (list (custom-quote value)))
      (put symbol 'saved-value nil))
    ;; Clear customized information (set, but not saved).
    (put symbol 'customized-value nil)
    ;; Save any comment that might have been set.
    (when comment
      (put symbol 'saved-variable-comment comment))
    (not (equal saved (get symbol 'saved-value)))))

(defun customize-mark-as-set (symbol)
  "Mark current value of SYMBOL as being set from customize.

If the default value of SYMBOL is different from the saved value if any,
or else if it is different from the standard value, set the
`customized-value' property to a list whose car evaluates to the
default value.  Otherwise, set it to nil.

712
Return non-nil if the `customized-value' property actually changed."
713
  (custom-load-symbol symbol)
714 715 716 717
  (let* ((get (or (get symbol 'custom-get) 'default-value))
	 (value (funcall get symbol))
	 (customized (get symbol 'customized-value))
	 (old (or (get symbol 'saved-value) (get symbol 'standard-value))))
718
    ;; Mark default value as set if different from old value.
719 720 721 722
    (if (not (and old
                  (equal value (condition-case nil
                                   (eval (car old))
                                 (error nil)))))
723 724 725
	(progn (put symbol 'customized-value (list (custom-quote value)))
	       (custom-push-theme 'theme-value symbol 'user 'set
				  (custom-quote value)))
726 727 728 729 730 731 732 733 734 735 736 737 738 739
      (put symbol 'customized-value nil))
    ;; Changed?
    (not (equal customized (get symbol 'customized-value)))))

(defun custom-reevaluate-setting (symbol)
  "Reset the value of SYMBOL by re-evaluating its saved or standard value.
Use the :set function to do so.  This is useful for customizable options
that are defined before their standard value can really be computed.
E.g. dumped variables whose default depends on run-time information."
  (funcall (or (get symbol 'custom-set) 'set-default)
	   symbol
	   (eval (car (or (get symbol 'saved-value) (get symbol 'standard-value))))))


740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
;;; Custom Themes

;; Custom themes are collections of settings that can be enabled or
;; disabled as a unit.

;; Each Custom theme is defined by a symbol, called the theme name.
;; The `theme-settings' property of the theme name records the
;; variable and face settings of the theme.  This property is a list
;; of elements, each of the form
;;
;;     (PROP SYMBOL THEME VALUE)
;;
;;  - PROP is either `theme-value' or `theme-face'
;;  - SYMBOL is the face or variable name
;;  - THEME is the theme name (redundant, but simplifies the code)
;;  - VALUE is an expression that gives the theme's setting for SYMBOL.
;;
;; The theme name also has a `theme-feature' property, whose value is
;; specified when the theme is defined (see `custom-declare-theme').
;; Usually, this is just a symbol named THEME-theme.  This lets
;; external libraries call (require 'foo-theme).

;; In addition, each symbol (either a variable or a face) affected by
;; an *enabled* theme has a `theme-value' or `theme-face' property,
;; which is a list of elements each of the form
;;
;;     (THEME VALUE)
;;
;; which have the same meanings as in `theme-settings'.
;;
;; The `theme-value' and `theme-face' lists are ordered by decreasing
;; theme precedence.  Thus, the first element is always the one that
;; is in effect.

;; Each theme is stored in a theme file, with filename THEME-theme.el.
;; Loading a theme basically involves calling (load "THEME-theme")
;; This is done by the function `load-theme'.  Loading a theme
;; automatically enables it.
;;
;; When a theme is enabled, the `theme-value' and `theme-face'
;; properties for the affected symbols are set.  When a theme is
;; disabled, its settings are removed from the `theme-value' and
;; `theme-face' properties, but the theme's own `theme-settings'
;; property remains unchanged.

(defvar custom-known-themes '(user changed)
786
   "Themes that have been defined with `deftheme'.
787
The default value is the list (user changed).  The theme `changed'
Chong Yidong's avatar
Chong Yidong committed
788
contains the settings before custom themes are applied.  The
789
theme `user' contains all the settings the user customized and saved.
790 791 792 793 794 795 796 797 798 799 800 801
Additional themes declared with the `deftheme' macro will be added to
the front of this list.")

(defsubst custom-theme-p (theme)
  "Non-nil when THEME has been defined."
  (memq theme custom-known-themes))

(defsubst custom-check-theme (theme)
  "Check whether THEME is valid, and signal an error if it is not."
  (unless (custom-theme-p theme)
    (error "Unknown theme `%s'" theme)))

802 803 804
(defun custom-push-theme (prop symbol theme mode &optional value)
  "Record VALUE for face or variable SYMBOL in custom theme THEME.
PROP is `theme-face' for a face, `theme-value' for a variable.
805 806 807

MODE can be either the symbol `set' or the symbol `reset'.  If it is the
symbol `set', then VALUE is the value to use.  If it is the symbol
808
`reset', then SYMBOL will be removed from THEME (VALUE is ignored).
809 810

See `custom-known-themes' for a list of known themes."
811
  (unless (memq prop '(theme-value theme-face))
812
    (error "Unknown theme property"))
813
  (let* ((old (get symbol prop))
814 815 816 817
	 (setting (assq theme old))  ; '(theme value)
	 (theme-settings             ; '(prop symbol theme value)
	  (get theme 'theme-settings)))
    (if (eq mode 'reset)
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
	;; Remove a setting.
	(when setting
	  (let (res)
	    (dolist (theme-setting theme-settings)
	      (if (and (eq (car  theme-setting) prop)
		       (eq (cadr theme-setting) symbol))
		  (setq res theme-setting)))
	    (put theme 'theme-settings (delq res theme-settings)))
	  (put symbol prop (delq setting old)))
      (if setting
	  ;; Alter an existing setting.
	  (let (res)
	    (dolist (theme-setting theme-settings)
	      (if (and (eq (car  theme-setting) prop)
		       (eq (cadr theme-setting) symbol))
		  (setq res theme-setting)))
	    (put theme 'theme-settings
835
		 (cons (list prop symbol theme value)
836
		       (delq res theme-settings)))
837
	    (setcar (cdr setting) value))
838 839
	;; Add a new setting.
	;; If the user changed the value outside of Customize, we
840
	;; first save the current value to a fake theme, `changed'.
841 842 843 844
	;; This ensures that the user-set value comes back if the
	;; theme is later disabled.
	(if (null old)
	    (if (and (eq prop 'theme-value)
845 846
		     (boundp symbol))
		(let ((sv (get symbol 'standard-value)))
847 848 849
		  (unless (and sv
                               (equal (eval (car sv)) (symbol-value symbol)))
                    (setq old (list (list 'changed (symbol-value symbol))))))
850 851
	      (if (and (facep symbol)
		       (not (face-spec-match-p symbol (get symbol 'face-defface-spec))))
852
		  (setq old (list (list 'changed (list
853
		    (append '(t) (custom-face-attributes-get symbol nil)))))))))
854
	(put symbol prop (cons (list theme value) old))
855
	(put theme 'theme-settings
856
	     (cons (list prop symbol theme value)
857
		   theme-settings))))))
858

859

860
(defun custom-set-variables (&rest args)
861 862
  "Install user customizations of variable values specified in ARGS.
These settings are registered as theme `user'.
863
The arguments should each be a list of the form:
864

865
  (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
866

867 868 869
This stores EXP (without evaluating it) as the saved value for SYMBOL.
If NOW is present and non-nil, then also evaluate EXP and set
the default value for the SYMBOL to the value of EXP.
870

871 872
REQUEST is a list of features we must require in order to
handle SYMBOL properly.
873
COMMENT is a comment string about SYMBOL."
874 875 876
  (apply 'custom-theme-set-variables 'user args))

(defun custom-theme-set-variables (theme &rest args)
877 878
  "Initialize variables for theme THEME according to settings in ARGS.
Each of the arguments in ARGS should be a list of this form:
879

880
  (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
881

882 883 884
This stores EXP (without evaluating it) as the saved value for SYMBOL.
If NOW is present and non-nil, then also evaluate EXP and set
the default value for the SYMBOL to the value of EXP.
885

886 887
REQUEST is a list of features we must require in order to
handle SYMBOL properly.
888 889
COMMENT is a comment string about SYMBOL.

890
EXP itself is saved unevaluated as SYMBOL property `saved-value' and
891 892
in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
  (custom-check-theme theme)
893 894 895 896 897 898 899 900 901 902 903 904
 
  ;; Process all the needed autoloads before anything else, so that the
  ;; subsequent code has all the info it needs (e.g. which var corresponds
  ;; to a minor mode), regardless of the ordering of the variables.
  (dolist (entry args)
    (let* ((symbol (indirect-variable (nth 0 entry))))
      (unless (or (get symbol 'standard-value)
                  (memq (get symbol 'custom-autoload) '(nil noset)))
        ;; This symbol needs to be autoloaded, even just for a `set'.
        (custom-load-symbol symbol))))
 
  ;; Move minor modes and variables with explicit requires to the end.
905 906 907 908 909 910 911 912 913 914 915
  (setq args
	(sort args
	      (lambda (a1 a2)
		(let* ((sym1 (car a1))
		       (sym2 (car a2))
		       (1-then-2 (memq sym1 (get sym2 'custom-dependencies)))
		       (2-then-1 (memq sym2 (get sym1 'custom-dependencies))))
		  (cond ((and 1-then-2 2-then-1)
			 (error "Circular custom dependency between `%s' and `%s'"
				sym1 sym2))
			(2-then-1 nil)
916 917
			;; 1 is a dependency of 2, so needs to be set first.
			(1-then-2)
918 919 920 921 922 923 924
			;; Put minor modes and symbols with :require last.
			;; Putting minor modes last ensures that the mode
			;; function will see other customized values rather
			;; than default values.
			(t (or (nth 3 a2)
                               (eq (get sym2 'custom-set)
                                   'custom-set-minor-mode))))))))
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
  (while args
    (let ((entry (car args)))
      (if (listp entry)
	  (let* ((symbol (indirect-variable (nth 0 entry)))
		 (value (nth 1 entry))
		 (now (nth 2 entry))
		 (requests (nth 3 entry))
		 (comment (nth 4 entry))
		 set)
	    (when requests
	      (put symbol 'custom-requests requests)
	      (mapc 'require requests))
	    (setq set (or (get symbol 'custom-set) 'custom-set-default))
	    (put symbol 'saved-value (list value))
	    (put symbol 'saved-variable-comment comment)
	    (custom-push-theme 'theme-value symbol theme 'set value)
	    ;; Allow for errors in the case where the setter has
942 943 944 945 946 947 948 949 950
	    ;; changed between versions, say, but let the user know.
	    (condition-case data
		(cond (now
		       ;; Rogue variable, set it now.
		       (put symbol 'force-value t)
		       (funcall set symbol (eval value)))
		      ((default-boundp symbol)
		       ;; Something already set this, overwrite it.
		       (funcall set symbol (eval value))))
951
	      (error
952
	       (message "Error setting %s: %s" symbol data)))
953 954 955
	    (setq args (cdr args))
	    (and (or now (default-boundp symbol))
		 (put symbol 'variable-comment comment)))
956 957
        ;; I believe this is dead-code, because the `sort' code above would
        ;; have burped before we could get here.  --Stef
958 959 960 961 962 963 964 965 966
	;; Old format, a plist of SYMBOL VALUE pairs.
	(message "Warning: old format `custom-set-variables'")
	(ding)
	(sit-for 2)
	(let ((symbol (indirect-variable (nth 0 args)))
	      (value (nth 1 args)))
	  (put symbol 'saved-value (list value))
	  (custom-push-theme 'theme-value symbol theme 'set value))
	(setq args (cdr (cdr args)))))))
967

968 969 970

;;; Defining themes.

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
;; A theme file should be named `THEME-theme.el' (where THEME is the theme
;; name), and found in either `custom-theme-directory' or the load path.
;; It has the following format:
;;
;;   (deftheme THEME
;;     DOCSTRING)
;;
;;   (custom-theme-set-variables
;;    'THEME
;;    [THEME-VARIABLES])
;;
;;   (custom-theme-set-faces
;;    'THEME
;;    [THEME-FACES])
;;
;;   (provide-theme 'THEME)
987 988


989 990 991
;; The IGNORED arguments to deftheme come from the XEmacs theme code, where
;; they were used to supply keyword-value pairs like `:immediate',
;; `:variable-reset-string', etc.  We don't use any of these, so ignore them.
992

993 994 995
(defmacro deftheme (theme &optional doc &rest ignored)
  "Declare THEME to be a Custom theme.
The optional argument DOC is a doc string describing the theme.
996 997 998 999 1000 1001 1002

Any theme `foo' should be defined in a file called `foo-theme.el';
see `custom-make-theme-feature' for more information."
  (let ((feature (custom-make-theme-feature theme)))
    ;; It is better not to use backquote in this file,
    ;; because that makes a bootstrapping problem
    ;; if you need to recompile all the Lisp files using interpreted code.
1003
    (list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc)))
1004

1005
(defun custom-declare-theme (theme feature &optional doc &rest ignored)
1006
  "Like `deftheme', but THEME is evaluated as a normal argument.
1007 1008 1009 1010
FEATURE is the feature this theme provides.  Normally, this is a symbol
created from THEME by `custom-make-theme-feature'."
  (if (memq theme '(user changed))
      (error "Custom theme cannot be named %S" theme))
1011 1012
  (add-to-list 'custom-known-themes theme)
  (put theme 'theme-feature feature)
1013
  (when doc (put theme 'theme-documentation doc)))
1014 1015 1016 1017 1018 1019 1020 1021 1022

(defun custom-make-theme-feature (theme)
  "Given a symbol THEME, create a new symbol by appending \"-theme\".
Store this symbol in the `theme-feature' property of THEME.
Calling `provide-theme' to provide THEME actually puts `THEME-theme'
into `features'.

This allows for a file-name convention for autoloading themes:
Every theme X has a property `provide-theme' whose value is \"X-theme\".
Chong Yidong's avatar
Chong Yidong committed
1023
\(load-theme X) then attempts to load the file `X-theme.el'."
1024 1025 1026 1027
  (intern (concat (symbol-name theme) "-theme")))

;;; Loading themes.

1028
(defcustom custom-theme-directory
1029
  user-emacs-directory
1030
  "Directory in which Custom theme files should be written.
Chong Yidong's avatar
Chong Yidong committed
1031
`load-theme' searches this directory in addition to load-path.
1032 1033 1034 1035 1036 1037
The command `customize-create-theme' writes the files it produces
into this directory."
  :type 'string
  :group 'customize
  :version "22.1")

1038
(defun provide-theme (theme)
1039 1040 1041 1042 1043 1044
  "Indicate that this file provides THEME.
This calls `provide' to provide the feature name stored in THEME's
property `theme-feature' (which is usually a symbol created by
`custom-make-theme-feature')."
  (if (memq theme '(user changed))
      (error "Custom theme cannot be named %S" theme))
1045 1046
  (custom-check-theme theme)
  (provide (get theme 'theme-feature))
1047
  ;; Loading a theme also enables it.
1048 1049 1050 1051
  (push theme custom-enabled-themes)
  ;; `user' must always be the highest-precedence enabled theme.
  ;; Make that remain true.  (This has the effect of making user settings
  ;; override the ones just loaded, too.)
1052 1053
  (let ((custom-enabling-themes t))
    (enable-theme 'user)))
1054

Chong Yidong's avatar
Chong Yidong committed
1055
(defun load-theme (theme)
1056
  "Load a theme's settings from its file.
Chong Yidong's avatar
Chong Yidong committed
1057
This also enables the theme; use `disable-theme' to disable it."
1058 1059
  ;; Note we do no check for validity of the theme here.
  ;; This allows to pull in themes by a file-name convention
Chong Yidong's avatar
Chong Yidong committed
1060
  (interactive "SCustom theme name: ")
1061 1062 1063 1064 1065 1066
  ;; If reloading, clear out the old theme settings.
  (when (custom-theme-p theme)
    (disable-theme theme)
    (put theme 'theme-settings nil)
    (put theme 'theme-feature nil)
    (put theme 'theme-documentation nil))
1067 1068 1069
  (let ((load-path (if (file-directory-p custom-theme-directory)
		       (cons custom-theme-directory load-path)
		     load-path)))
1070
    (load (symbol-name (custom-make-theme-feature theme)))))
1071 1072 1073

;;; Enabling and disabling loaded themes.

1074 1075
(defvar custom-enabling-themes nil)

Chong Yidong's avatar
Chong Yidong committed
1076
(defun enable-theme (theme)
1077 1078
  "Reenable all variable and face settings defined by THEME.
The newly enabled theme gets the highest precedence (after `user').
1079 1080
If it is already enabled, just give it highest precedence (after `user').

1081 1082
If THEME does not specify any theme settings, this tries to load
the theme from its theme file, by calling `load-theme'."
Chong Yidong's avatar
Chong Yidong committed
1083
  (interactive "SEnable Custom theme: ")
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
  (if (not (custom-theme-p theme))
      (load-theme theme)
    ;; This could use a bit of optimization -- cyd
    (let ((settings (get theme 'theme-settings)))
      (dolist (s settings)
	(let* ((prop (car s))
	       (symbol (cadr s))
	       (spec-list (get symbol prop)))
	  (put symbol prop (cons (cddr s) (assq-delete-all theme spec-list)))
	  (if (eq prop 'theme-value)
	      (custom-theme-recalc-variable symbol)
	    (custom-theme-recalc-face symbol)))))
    (unless (eq theme 'user)
      (setq custom-enabled-themes
	    (cons theme (delq theme custom-enabled-themes)))
      (unless custom-enabling-themes
	(enable-theme 'user)))))
1101 1102 1103 1104 1105 1106 1107 1108

(defcustom custom-enabled-themes nil
  "List of enabled Custom Themes, highest precedence first.

This does not include the `user' theme, which is set by Customize,
and always takes precedence over other Custom Themes."
  :group 'customize
  :type  '(repeat symbol)
1109
  :set-after '(custom-theme-directory)  ; so we can find the themes
1110 1111 1112 1113 1114
  :set (lambda (symbol themes)
	 ;; Avoid an infinite loop when custom-enabled-themes is
	 ;; defined in a theme (e.g. `user').  Enabling the theme sets
	 ;; custom-enabled-themes, which enables the theme...
	 (unless custom-enabling-themes
1115
	   (let ((custom-enabling-themes t) failures)
1116 1117 1118 1119 1120 1121
	     (setq themes (delq 'user (delete-dups themes)))
	     (if (boundp symbol)
		 (dolist (theme (symbol-value symbol))
		   (if (not (memq theme themes))
		       (disable-theme theme))))
	     (dolist (theme (reverse themes))
1122
	       (condition-case nil
1123
		   (enable-theme theme)
1124 1125
		 (error (progn (push theme failures)
			       (setq themes (delq theme themes))))))
1126
	     (enable-theme 'user)
1127 1128 1129 1130
	     (custom-set-default symbol themes)
	     (if failures
		 (message "Failed to enable themes: %s"
			  (mapconcat 'symbol-name failures " ")))))))
1131

1132
(defsubst custom-theme-enabled-p (theme)
1133 1134
  "Return non-nil if THEME is enabled."
  (memq theme custom-enabled-themes))
1135

Chong Yidong's avatar
Chong Yidong committed
1136
(defun disable-theme (theme)
1137
  "Disable all variable and face settings defined by THEME.
1138
See `custom-enabled-themes' for a list of enabled themes."
1139 1140 1141 1142 1143 1144
  (interactive (list (intern
		      (completing-read
		       "Disable Custom theme: "
		       (mapcar 'symbol-name custom-enabled-themes)
		       nil t))))
  (when (custom-theme-enabled-p theme)
1145 1146 1147 1148 1149 1150 1151 1152
    (let ((settings (get theme 'theme-settings)))
      (dolist (s settings)
	(let* ((prop (car s))
	       (symbol (cadr s))
	       (spec-list (get symbol prop)))
	  (put symbol prop (assq-delete-all theme spec-list))
	  (if (eq prop 'theme-value)
	      (custom-theme-recalc-variable symbol)
1153 1154 1155
	    (custom-theme-recalc-face symbol)))))
    (setq custom-enabled-themes
	  (delq theme custom-enabled-themes))))
1156 1157 1158 1159 1160 1161 1162 1163 1164

(defun custom-variable-theme-value (variable)
  "Return (list VALUE) indicating the custom theme value of VARIABLE.
That is to say, it specifies what the value should be according to
currently enabled custom themes.

This function returns nil if no custom theme specifies a value for VARIABLE."
  (let* ((theme-value (get variable 'theme-value)))
    (if theme-value
1165
	(cdr (car theme-value)))))
1166 1167 1168 1169