custom.el 46.3 KB
Newer Older
1 2
;;; custom.el --- tools for declaring and initializing options
;;
3 4
;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004,
;;   2005 Free Software Foundation, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
;;
;; 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
;; the Free Software Foundation; either version 2, or (at your option)
;; 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 175 176 177
		((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))
178
			   value)
179 180 181 182 183 184 185
		   ;; 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.
186 187
    (unless custom-dont-initialize
      (funcall initialize symbol default)))
188
  (push symbol current-load-list)
189 190 191 192 193 194 195
  (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.

196
Neither SYMBOL nor VALUE need to be quoted.
197 198 199 200 201 202 203
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
204
:type	VALUE should be a widget type for editing the symbol's value.
205 206 207
:options VALUE should be a list of valid members of the widget type.
:group  VALUE should be a customization group.
        Add SYMBOL to that group.
208
:link LINK-DATA
209 210 211
        Include an external link after the documentation string for this
        item.  This is a sentence containing an active field which
        references some other documentation.
212

213
        There are several alternatives you can use for LINK-DATA:
214

215
        (custom-manual INFO-NODE)
216
             Link to an Info node; INFO-NODE is a string which specifies
217
             the node name, as in \"(emacs)Top\".
218

219
        (info-link INFO-NODE)
220 221
             Like `custom-manual' except that the link appears in the
             customization buffer with the Info node name.
222

223
        (url-link URL)
224
             Link to a web page; URL is a string which specifies the URL.
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

        (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.
243

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

249 250
        An item can have more than one external link; however, most items
        have none at all.
251 252 253 254
: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
Stefan Monnier's avatar
Stefan Monnier committed
255
	`custom-initialize-reset'.
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
: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
	give it.  The default choice of function is `custom-set-default'.
: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
	is `custom-default-value'.
: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.
:version
        VALUE should be a string specifying that the variable was
        first introduced, or its default value was changed, in Emacs
        version VERSION.
271 272
: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
273
        in customization menus and buffers.
274 275
:load FILE
        Load file FILE (a string) before displaying this customization
276
        item.  Loading is done with `load', and only if the file is
277
        not already loaded.
278 279 280
:set-after VARIABLES
	Specifies that SYMBOL should be set after the list of variables
        VARIABLES when both have been customized.
281

Luc Teirlinck's avatar
Luc Teirlinck committed
282 283 284 285 286 287 288
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.)

289 290
Read the section about customization in the Emacs Lisp manual for more
information."
291
  (declare (doc-string 3))
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
  ;; 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
309
If FACE has been set with `custom-set-faces', set the face attributes
310 311 312 313 314 315 316 317 318 319 320 321 322 323
as specified by that function, otherwise set the face attributes
according to SPEC.

The remaining arguments should have the form

   [KEYWORD VALUE]...

The following KEYWORDs are defined:

:group  VALUE should be a customization group.
        Add FACE to that group.

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

Richard M. Stallman's avatar
Richard M. Stallman committed
324 325 326 327 328 329 330 331 332 333 334 335
In the first element, DISPLAY can be :default.  The ATTS in that
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
frame if none of the previous elements (except the :default if
any) did.
336 337 338 339 340 341

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',
342
`:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'.
343

Richard M. Stallman's avatar
Richard M. Stallman committed
344 345 346 347 348 349
DISPLAY can be `:default' (only in the first element), the symbol
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:
350 351 352

`type' (the value of `window-system')
  Under X, in addition to the values `window-system' can take,
353 354
  `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.
355 356 357 358 359 360 361

`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'.

362 363 364 365
`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'.

366 367 368 369 370
`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.

371 372
Read the section about customization in the Emacs Lisp manual for more
information."
373
  (declare (doc-string 3))
374 375 376 377 378 379 380
  ;; 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.

381 382 383
(defun custom-current-group ()
  (cdr (assoc load-file-name custom-current-group-alist)))

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
(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))))))
407 408 409 410
  ;; 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)))
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
  (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]...

The following KEYWORDs are defined:

:group   VALUE should be a customization group.
         Add SYMBOL to that group.

:version VALUE should be a string specifying that the group was introduced
         in Emacs version VERSION.

Read the section about customization in the Emacs Lisp manual for more
information."
439
  (declare (doc-string 3))
440 441 442 443 444 445 446 447 448 449 450 451 452
  ;; 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))))))

453 454 455 456 457 458 459 460 461 462 463
(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)))

464 465 466 467 468
;;; 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."
469
  (unless (memq :group args)
470
    (custom-add-to-group (custom-current-group) symbol type))
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
  (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))
	((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))))
521

522 523 524
(defun custom-add-option (symbol option)
  "To the variable SYMBOL add OPTION.

525 526 527 528
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."
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  (let ((options (get symbol 'custom-options)))
    (unless (member option options)
      (put symbol 'custom-options (cons option options)))))

(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)))

(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)))))

550 551 552 553 554 555 556
(defun custom-autoload (symbol load)
  "Mark SYMBOL as autoloaded custom variable and add dependency LOAD."
  (put symbol 'custom-autoload t)
  (custom-add-load symbol load))

;; This test is also in the C code of `user-variable-p'.
(defun custom-variable-p (variable)
557 558 559
  "Return non-nil if VARIABLE is a custom variable.
This recursively follows aliases."
  (setq variable (indirect-variable variable))
560 561 562
  (or (get variable 'standard-value)
      (get variable 'custom-autoload)))

563 564 565 566 567 568 569 570 571
;;; 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
572
    (let ((custom-load-recursion t))
573 574 575 576 577 578 579 580
      ;; 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))
581 582 583
      (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.
584 585 586 587
	      ((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.
588 589 590
	      ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
				     "\\(\\'\\|\\.\\)"))
		     (found nil))
591
		 (dolist (loaded load-history)
592 593
		   (and (stringp (car loaded))
			(string-match regexp (car loaded))
594 595 596 597 598 599
			(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"))
600
	      (t (condition-case nil (load load) (error nil))))))))
601

602
(defvar custom-known-themes '(user standard)
603
   "Themes that have been defined with `deftheme'.
604
The default value is the list (user standard).  The theme `standard'
Chong Yidong's avatar
Chong Yidong committed
605
contains the settings before custom themes are applied.  The
606
theme `user' contains all the settings the user customized and saved.
607 608 609 610 611 612 613 614 615 616 617 618
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)))

619 620
;;; Initializing.

621
(defun custom-push-theme (prop symbol theme mode value)
622 623 624 625
  "Record a value for face or variable SYMBOL in custom theme THEME.
PROP is`theme-face' for a face, `theme-value' for a variable.
The value is specified by (THEME MODE VALUE), which is interpreted
by `custom-theme-value'.
626 627 628

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
629 630
`reset', then VALUE is another theme, whose value for this face or
variable should be used.
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 660 661 662

In the following example for the variable `goto-address-url-face', the
theme `subtle-hacker' uses the same value for the variable as the theme
`gnome2':

  \((standard set bold)
   \(gnome2 set info-xref)
   \(jonadab set underline)
   \(subtle-hacker reset gnome2))


If a value has been stored for themes A B and C, and a new value
is to be stored for theme C, then the old value of C is discarded.
If a new value is to be stored for theme B, however, the old value
of B is not discarded because B is not the car of the list.

For variables, list property PROP is `theme-value'.
For faces, list property PROP is `theme-face'.
This is used in `custom-do-theme-reset', for example.

The list looks the same in any case; the examples shows a possible
value of the `theme-face' property for the face `region':

  \((gnome2 set ((t (:foreground \"cyan\" :background \"dark cyan\"))))
   \(standard set ((((class color) (background dark))
		   \(:background \"blue\"))
		  \(t (:background \"gray\")))))

This records values for the `standard' and the `gnome2' themes.
The user has not customized the face; had he done that,
the list would contain an entry for the `user' theme, too.
See `custom-known-themes' for a list of known themes."
663 664 665 666 667 668 669 670
  (let* ((old (get symbol prop))
	 (setting (assq theme old)))
    ;; Alter an existing theme-setting for the symbol,
    ;; or add a new one.
    (if setting
	(progn
	  (setcar (cdr setting) mode)
	  (setcar (cddr setting) value))
671 672 673 674 675 676 677 678 679 680
      ;; If no custom theme has been applied yet, first save the
      ;; current values to the 'standard theme.
      (if (null old)
	  (if (and (eq prop 'theme-value)
		   (boundp symbol))
	      (setq old
		    (list (list 'standard 'set (symbol-value symbol))))
	    (if (facep symbol)
		(setq old (list (list 'standard 'set (list
		  (append '(t) (custom-face-attributes-get symbol nil)))))))))
681 682 683 684 685 686
      (put symbol prop (cons (list theme mode value) old)))
    ;; Record, for each theme, all its settings.
    (put theme 'theme-settings
	 (cons (list prop symbol theme mode value)
	       (get theme 'theme-settings)))))

687 688 689 690 691 692 693 694 695
(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-variables (&rest args)
696 697
  "Install user customizations of variable values specified in ARGS.
These settings are registered as theme `user'.
698
The arguments should each be a list of the form:
699

700
  (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
701

702 703 704
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.
705

706 707
REQUEST is a list of features we must require in order to
handle SYMBOL properly.
708
COMMENT is a comment string about SYMBOL."
709 710
  (apply 'custom-theme-set-variables 'user args))

711
(defun custom-reevaluate-setting (symbol)
712 713 714 715
  "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."
716 717 718 719
  (funcall (or (get symbol 'custom-set) 'set-default)
	   symbol
	   (eval (car (or (get symbol 'saved-value) (get symbol 'standard-value))))))

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

724
  (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
725

726 727 728
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.
729

730 731
REQUEST is a list of features we must require in order to
handle SYMBOL properly.
732 733 734 735
COMMENT is a comment string about SYMBOL.

Several properties of THEME and SYMBOL are used in the process:

736 737 738 739
If THEME's property `theme-immediate' is non-nil, this is equivalent of
providing the NOW argument to all symbols in the argument list:
evaluate each EXP and set the corresponding SYMBOL.  However,
there's a difference in the handling of SYMBOL's property
740 741
`force-value': if NOW is non-nil, SYMBOL's property `force-value' is set to
the symbol `rogue', else if THEME's property `theme-immediate' is non-nil,
742
SYMBOL's property `force-value' is set to the symbol `immediate'.
743

744
EXP itself is saved unevaluated as SYMBOL property `saved-value' and
745 746
in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
  (custom-check-theme theme)
747 748 749 750 751 752 753 754 755 756 757
  (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)
758 759 760 761 762 763 764
			;; 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))))))))
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
  (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
782 783 784 785 786 787 788 789 790
	    ;; 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))))
791
	      (error
792
	       (message "Error setting %s: %s" symbol data)))
793 794 795 796 797 798 799 800 801 802 803 804
	    (setq args (cdr args))
	    (and (or now (default-boundp symbol))
		 (put symbol 'variable-comment comment)))
	;; 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)))))))
805 806 807 808 809 810 811 812 813 814 815

(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)))

816 817 818 819 820 821 822 823
(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
824 825
	(funcall variable (if value 1 0)))
    (funcall variable (if value 1 0))))
826

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
(defun custom-quote (sexp)
  "Quote SEXP iff it is not self quoting."
  (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.

845
If the default value of SYMBOL is different from the standard value,
846
set the `saved-value' property to a list whose car evaluates to the
847
default value.  Otherwise, set it to nil.
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873

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

Return non-nil iff the `saved-value' property actually changed."
  (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)))
    ;; Save default value iff different from standard value.
    (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.

874
If the default value of SYMBOL is different from the saved value if any,
875
or else if it is different from the standard value, set the
876
`customized-value' property to a list whose car evaluates to the
877
default value.  Otherwise, set it to nil.
878 879 880 881 882 883 884 885

Return non-nil iff the `customized-value' property actually changed."
  (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))))
    ;; Mark default value as set iff different from old value.
    (if (or (null old)
886
	    (not (equal value (condition-case nil
887 888 889 890 891 892
				  (eval (car old))
				(error nil)))))
	(put symbol 'customized-value (list (custom-quote value)))
      (put symbol 'customized-value nil))
    ;; Changed?
    (not (equal customized (get symbol 'customized-value)))))
893 894 895 896 897 898 899 900 901 902 903

;;; Defining themes.

;; deftheme is used at the beginning of the file that records a theme.

(defmacro deftheme (theme &optional doc &rest args)
  "Declare custom theme THEME.
The optional argument DOC is a doc string describing the theme.
The remaining arguments should have the form

   [KEYWORD VALUE]...
904

905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
The following KEYWORD's are defined:

:short-description
	VALUE is a short (one line) description of the theme.  If not
	given, DOC is used.
:immediate
	If VALUE is non-nil, variables specified in this theme are set
	immediately when loading the theme.
:variable-set-string
	VALUE is a string used to indicate that a variable takes its
	setting from this theme.  It is passed to FORMAT with the name
	of the theme as an additional argument.  If not given, a
	generic description is used.
:variable-reset-string
	VALUE is a string used in the case a variable has been forced
	to its value in this theme.  It is passed to FORMAT with the
	name of the theme as an additional argument.  If not given, a
	generic description is used.
:face-set-string
	VALUE is a string used to indicate that a face takes its
	setting from this theme.  It is passed to FORMAT with the name
	of the theme as an additional argument.  If not given, a
	generic description is used.
:face-reset-string
	VALUE is a string used in the case a face has been forced to
	its value in this theme.  It is passed to FORMAT with the name
	of the theme as an additional argument.  If not given, a
	generic description is used.

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.
    (nconc (list 'custom-declare-theme
		 (list 'quote theme)
		 (list 'quote feature)
		 doc)
	   args)))

(defun custom-declare-theme (theme feature &optional doc &rest args)
  "Like `deftheme', but THEME is evaluated as a normal argument.
FEATURE is the feature this theme provides.  This symbol is created
from THEME by `custom-make-theme-feature'."
  (add-to-list 'custom-known-themes theme)
  (put theme 'theme-feature feature)
  (when doc
    (put theme 'theme-documentation 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 :short-description)
	       (put theme 'theme-short-description value))
	      ((eq keyword :immediate)
	       (put theme 'theme-immediate value))
	      ((eq keyword :variable-set-string)
	       (put theme 'theme-variable-set-string value))
	      ((eq keyword :variable-reset-string)
	       (put theme 'theme-variable-reset-string value))
	      ((eq keyword :face-set-string)
	       (put theme 'theme-face-set-string value))
	      ((eq keyword :face-reset-string)
	       (put theme 'theme-face-reset-string value)))))))

(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
985
\(load-theme X) then attempts to load the file `X-theme.el'."
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
  (intern (concat (symbol-name theme) "-theme")))

;;; Loading themes.

;; The variable and face settings of a theme are recorded in
;; the `theme-settings' property of the theme name.
;; This property's value is a list of elements, each of the form
;; (PROP SYMBOL THEME MODE VALUE), where PROP is `theme-value' or `theme-face'
;; and SYMBOL is the face or variable name.
;; THEME is the theme name itself; that's redundant, but simplifies things.
;; MODE is `set' or `reset'.
;; If MODE is `set', then VALUE is an expression that specifies the
;; theme's setting for SYMBOL.
;; If MODE is `reset', then VALUE is another theme,
;; and it means to use the value from that theme.

;; Each variable has a `theme-value' property that describes all the
;; settings of enabled themes that apply to it.
;; Each face name has a `theme-face' property that describes all the
;; settings of enabled themes that apply to it.
;; The property value is a list of settings, each with the form
;; (THEME MODE VALUE).  THEME, MODE and VALUE are as above.
Richard M. Stallman's avatar
Richard M. Stallman committed
1008 1009
;; Each of these lists is ordered by decreasing theme precedence.
;; Thus, the first element is always the one that is in effect.
1010

Richard M. Stallman's avatar
Richard M. Stallman committed
1011 1012 1013 1014 1015 1016 1017
;; Disabling a theme removes its settings from the `theme-value' and
;; `theme-face' properties, but the theme's own `theme-settings'
;; property remains unchanged.

;; Loading a theme implicitly enables it.  Enabling a theme adds its
;; settings to the symbols' `theme-value' and `theme-face' properties,
;; or moves them to the front of those lists if they're already present.
1018 1019

(defvar custom-loaded-themes nil
1020
  "Custom themes that have been loaded.")
1021

1022 1023 1024 1025 1026 1027
(defcustom custom-theme-directory
  (if (eq system-type 'ms-dos)
	 ;; MS-DOS cannot have initial dot.
	 "~/_emacs.d/"
      "~/.emacs.d/")
  "Directory in which Custom theme files should be written.
Chong Yidong's avatar
Chong Yidong committed
1028
`load-theme' searches this directory in addition to load-path.
1029 1030 1031 1032 1033 1034
The command `customize-create-theme' writes the files it produces
into this directory."
  :type 'string
  :group 'customize
  :version "22.1")

1035
(defun custom-theme-loaded-p (theme)
1036
  "Return non-nil if THEME has been loaded."
1037 1038
  (memq theme custom-loaded-themes))

1039 1040 1041 1042 1043 1044 1045 1046
(defvar custom-enabled-themes '(user)
  "Custom themes currently enabled, highest precedence first.
The first one is always `user'.")

(defun custom-theme-enabled-p (theme)
  "Return non-nil if THEME is enabled."
  (memq theme custom-enabled-themes))

1047 1048
(defun provide-theme (theme)
  "Indicate that this file provides THEME.
1049 1050
Add THEME to `custom-loaded-themes', and `provide' whatever
feature name is stored in THEME's property `theme-feature'.
1051

1052
Usually the `theme-feature' property contains a symbol created
1053 1054 1055
by `custom-make-theme-feature'."
  (custom-check-theme theme)
  (provide (get theme 'theme-feature))
1056 1057 1058 1059 1060 1061 1062
  (push theme custom-loaded-themes)
  ;; Loading a theme also installs its settings,
  ;; so mark it as "enabled".
  (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.)
Chong Yidong's avatar
Chong Yidong committed
1063
  (enable-theme 'user))
1064

Chong Yidong's avatar
Chong Yidong committed
1065
(defun load-theme (theme)
1066
  "Try to load a theme's settings from its file.
Chong Yidong's avatar
Chong Yidong committed
1067
This also enables the theme; use `disable-theme' to disable it."
1068 1069 1070 1071

  ;; THEME's feature is stored in THEME's `theme-feature' property.
  ;; Usually the `theme-feature' property contains a symbol created
  ;; by `custom-make-theme-feature'.
1072 1073 1074

  ;; 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
1075
  (interactive "SCustom theme name: ")
1076 1077 1078 1079 1080
  (let ((load-path (if (file-directory-p custom-theme-directory)
		       (cons custom-theme-directory load-path)
		     load-path)))
    (require (or (get theme 'theme-feature)
		 (custom-make-theme-feature theme)))))
1081 1082

;;; How to load and enable various themes as part of `user'.
1083 1084 1085

(defun custom-theme-load-themes (by-theme &rest body)
  "Load the themes specified by BODY.
1086 1087 1088
Record them as required by theme BY-THEME.

BODY is a sequence of either
1089 1090

THEME
1091
        Load THEME and enable it.
1092 1093 1094
\(reset THEME)
	Undo all the settings made by THEME
\(hidden THEME)
1095
	Load THEME but do not enable it.
1096 1097

All the themes loaded for BY-THEME are recorded in BY-THEME's property
1098
`theme-loads-themes'."
1099
  (custom-check-theme by-theme)
1100 1101
  (let ((themes-loaded (get by-theme 'theme-loads-themes)))
    (dolist (theme body)
1102
      (cond ((and (consp theme) (eq (car theme) 'reset))
Chong Yidong's avatar
Chong Yidong committed
1103
	     (disable-theme (cadr theme)))
1104
	    ((and (consp theme) (eq (car theme) 'hidden))
Chong Yidong's avatar
Chong Yidong committed
1105 1106
	     (load-theme (cadr theme))
	     (disable-theme (cadr theme)))
1107
	    (t
Chong Yidong's avatar
Chong Yidong committed
1108
	     (load-theme theme)))
1109
      (push theme themes-loaded))
1110 1111 1112 1113 1114 1115 1116
    (put by-theme 'theme-loads-themes themes-loaded)))

(defun custom-load-themes (&rest body)
  "Load themes for the USER theme as specified by BODY.

See `custom-theme-load-themes' for more information on BODY."
  (apply 'custom-theme-load-themes 'user body))
1117 1118 1119

;;; Enabling and disabling loaded themes.

Chong Yidong's avatar
Chong Yidong committed
1120
(defun enable-theme (theme)
1121 1122
  "Reenable all variable and face settings defined by THEME.
The newly enabled theme gets the highest precedence (after `user').
1123 1124 1125 1126
If it is already enabled, just give it highest precedence (after `user').

This signals an error if THEME does not specify any theme
settings.  Theme settings are set using `load-theme'."
Chong Yidong's avatar
Chong Yidong committed
1127
  (interactive "SEnable Custom theme: ")
1128
  (let ((settings (get theme 'theme-settings)))
1129 1130
    (if (and (not (eq theme 'user)) (null settings))
	(error "No theme settings defined in %s." (symbol-name theme)))
1131 1132 1133 1134 1135 1136 1137
    (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)
1138 1139
	  (if (facep symbol)
	      (custom-theme-recalc-face symbol))))))
1140 1141
  (setq custom-enabled-themes
        (cons theme (delq theme custom-enabled-themes)))
1142 1143
  ;; `user' must always be the highest-precedence enabled theme.
  (unless (eq theme 'user)
Chong Yidong's avatar
Chong Yidong committed
1144
    (enable-theme 'user)))
1145

Chong Yidong's avatar
Chong Yidong committed
1146
(defun disable-theme (theme)
1147 1148
  "Disable all variable and face settings defined by THEME.
See `custom-known-themes' for a list of known themes."
Chong Yidong's avatar
Chong Yidong committed
1149
  (interactive "SDisable Custom theme: ")
1150 1151 1152 1153 1154
  (let ((settings (get theme 'theme-settings)))
    (dolist (s settings)
      (let* ((prop (car s))
	     (symbol (cadr s))
	     (spec-list (get symbol prop)))
Chong Yidong's avatar
Chong Yidong committed
1155
	(put symbol prop (assq-delete-all theme spec-list))
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
	(if (eq prop 'theme-value)
	    (custom-theme-recalc-variable symbol)
	  (custom-theme-recalc-face symbol)))))
  (setq custom-enabled-themes
	(delq theme custom-enabled-themes)))

(defun custom-theme-value (theme setting-list)
  "Determine the value specified for THEME according to SETTING-LIST.
Returns a list whose car is the specified value, if we
find one; nil otherwise.

SETTING-LIST is an alist with themes as its key.
Each element has the form:
1169 1170 1171 1172 1173

  \(THEME MODE VALUE)

MODE is either the symbol `set' or the symbol `reset'.  See
`custom-push-theme' for more information on the format of
1174
SETTING-LIST."
1175 1176
  ;; Note we do _NOT_ signal an error if the theme is unknown
  ;; it might have gone away without the user knowing.
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
  (let ((elt (cdr (assoc theme setting-list))))
    (if elt
        (if (eq (car elt) 'set)
            (cdr elt)
	  ;; `reset' means refer to another theme's value in the same alist.
          (custom-theme-value (cadr elt) setting-list)))))

(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
	(custom-theme-value (car (car theme-value)) theme-value))))

(defun custom-theme-recalc-variable (variable)
  "Set VARIABLE according to currently enabled custom themes."
  (let ((valspec (custom-variable-theme-value variable)))
    (when valspec
      (put variable 'saved-value valspec))
    (unless valspec
      (setq valspec (get variable 'standard-value)))
    (when valspec
      (if (or (get 'force-value variable) (default-boundp variable))
          (funcall (or (get variable 'custom-set) 'set-default) variable
                   (eval (car valspec)))))))

(defun custom-theme-recalc-face (face)
  "Set FACE according to currently enabled custom themes."
Chong Yidong's avatar
Chong Yidong committed
1208 1209 1210
  (let ((theme-faces (reverse (get face 'theme-face))))
    (dolist (spec theme-faces)
      (face-spec-set face (car (cddr spec))))))
1211

1212
(defun custom-theme-reset-variables (theme &rest args)
1213 1214
  "Reset the specs in THEME of some variables to their values in other themes.
Each of the arguments ARGS has this form:
1215

1216
    (VARIABLE FROM-THEME)
1217

1218
This means reset VARIABLE to its value in FROM-THEME."
1219
  (custom-check-theme theme)
1220 1221
  (dolist (arg args)
    (custom-push-theme 'theme-value (car arg) theme 'reset (cadr arg))))
1222 1223

(defun custom-reset-variables (&rest args)
1224 1225
  "Reset the specs of some variables to their values in certain themes.
This creates settings in the `user' theme.
1226

1227
Each of the arguments ARGS has this form:
1228

1229
    (VARIABLE FROM-THEME)
1230

1231
This means reset VARIABLE to its value in FROM-THEME."
1232 1233
    (apply 'custom-theme-reset-variables 'user args))

1234 1235 1236 1237 1238 1239 1240 1241 1242
;;; The End.

;; Process the defcustoms for variables loaded before this file.
(while custom-declare-variable-list
  (apply 'custom-declare-variable (car custom-declare-variable-list))
  (setq custom-declare-variable-list (cdr custom-declare-variable-list)))

(provide 'custom)

1243
;; arch-tag: 041b6116-aabe-4f9a-902d-74092bc3dab2
1244
;;; custom.el ends here