custom.el 45.3 KB
Newer Older
1 2
;;; custom.el --- tools for declaring and initializing options
;;
3
;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004,
4
;;   2005, 2006 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
:options VALUE should be a list of valid members of the widget type.
206 207 208 209 210 211 212
: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
213
	give it.  The default choice of function is `set-default'.
214 215 216
: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
217
	is `default-value'.
218 219 220 221 222 223 224
: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.

The following common keywords are also meaningful.

225
:group  VALUE should be a customization group.
226
        Add SYMBOL (or FACE with `defface') to that group.
227
:link LINK-DATA
228 229 230
        Include an external link after the documentation string for this
        item.  This is a sentence containing an active field which
        references some other documentation.
231

232
        There are several alternatives you can use for LINK-DATA:
233

234
        (custom-manual INFO-NODE)
235
             Link to an Info node; INFO-NODE is a string which specifies
236
             the node name, as in \"(emacs)Top\".
237

238
        (info-link INFO-NODE)
239 240
             Like `custom-manual' except that the link appears in the
             customization buffer with the Info node name.
241

242
        (url-link URL)
243
             Link to a web page; URL is a string which specifies the URL.
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

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

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

268 269
        An item can have more than one external link; however, most items
        have none at all.
270 271 272 273
:version
        VALUE should be a string specifying that the variable was
        first introduced, or its default value was changed, in Emacs
        version VERSION.
274
:package-version
275
        VALUE should be a list with the form (PACKAGE . VERSION)
276 277 278 279
        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'.
280 281 282
        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.
283 284
: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
285
        in customization menus and buffers.
286 287
:load FILE
        Load file FILE (a string) before displaying this customization
288
        item.  Loading is done with `load', and only if the file is
289
        not already loaded.
290 291 292
:set-after VARIABLES
	Specifies that SYMBOL should be set after the list of variables
        VARIABLES when both have been customized.
293

Luc Teirlinck's avatar
Luc Teirlinck committed
294 295 296 297 298 299 300
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.)

301 302
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
303
  (declare (doc-string 3))
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
  ;; 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
321
If FACE has been set with `custom-set-faces', set the face attributes
322 323 324 325 326 327 328
as specified by that function, otherwise set the face attributes
according to SPEC.

The remaining arguments should have the form

   [KEYWORD VALUE]...

329 330
For a list of valid keywords, see the common keywords listed in
`defcustom'.
331 332 333

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

Richard M. Stallman's avatar
Richard M. Stallman committed
334 335 336 337 338 339 340 341 342 343 344 345
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.
346 347 348 349 350 351

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

Richard M. Stallman's avatar
Richard M. Stallman committed
354 355 356 357 358 359
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:
360 361 362

`type' (the value of `window-system')
  Under X, in addition to the values `window-system' can take,
363 364
  `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.
365 366 367 368 369 370 371

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

372 373 374 375
`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'.

376 377 378 379 380
`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.

381 382
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
383
  (declare (doc-string 3))
384 385 386 387 388 389 390
  ;; 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.

391 392 393
(defun custom-current-group ()
  (cdr (assoc load-file-name custom-current-group-alist)))

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
(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))))))
417 418 419 420
  ;; 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)))
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]...

439 440
For a list of valid keywords, see the common keywords listed in
`defcustom'.
441

442 443
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
444
  (declare (doc-string 3))
445 446 447 448 449 450 451 452 453 454 455 456 457
  ;; 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))))))

458 459 460 461 462 463 464 465 466 467 468
(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)))

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

529 530 531
(defun custom-add-option (symbol option)
  "To the variable SYMBOL add OPTION.

532 533 534 535
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."
536 537 538
  (let ((options (get symbol 'custom-options)))
    (unless (member option options)
      (put symbol 'custom-options (cons option options)))))
539
(defalias 'custom-add-frequent-value 'custom-add-option)
540 541 542 543 544 545 546 547 548 549 550

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

551 552 553 554
(defun custom-add-package-version (symbol version)
  "To the custom option SYMBOL add the package version VERSION."
  (put symbol 'custom-package-version (purecopy version)))

555 556 557 558 559 560 561
(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)))))

562 563 564 565
(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))
566 567 568 569
  (custom-add-load symbol load))

;; This test is also in the C code of `user-variable-p'.
(defun custom-variable-p (variable)
570 571 572
  "Return non-nil if VARIABLE is a custom variable.
This recursively follows aliases."
  (setq variable (indirect-variable variable))
573 574 575
  (or (get variable 'standard-value)
      (get variable 'custom-autoload)))

576 577 578 579 580 581 582 583 584
;;; 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
585
    (let ((custom-load-recursion t))
586 587 588 589 590 591 592 593
      ;; 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))
594 595 596
      (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.
597 598 599 600
	      ((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.
601 602 603
	      ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
				     "\\(\\'\\|\\.\\)"))
		     (found nil))
604
		 (dolist (loaded load-history)
605 606
		   (and (stringp (car loaded))
			(string-match regexp (car loaded))
607 608 609 610 611 612
			(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"))
613
	      (t (condition-case nil (load load) (error nil))))))))
614

615 616 617 618 619 620 621 622 623 624 625 626 627 628 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 660 661 662 663 664 665 666 667 668
(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)
  "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.

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

Return non-nil iff the `saved-value' property actually changed."
669
  (custom-load-symbol symbol)
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
  (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.

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.

Return non-nil iff the `customized-value' property actually changed."
698
  (custom-load-symbol symbol)
699 700 701 702 703
  (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.
704 705 706 707
    (if (not (and old
                  (equal value (condition-case nil
                                   (eval (car old))
                                 (error nil)))))
708 709 710
	(progn (put symbol 'customized-value (list (custom-quote value)))
	       (custom-push-theme 'theme-value symbol 'user 'set
				  (custom-quote value)))
711 712 713 714 715 716 717 718 719 720 721 722 723 724
      (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))))))


725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 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
;;; 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)
771
   "Themes that have been defined with `deftheme'.
772
The default value is the list (user changed).  The theme `changed'
Chong Yidong's avatar
Chong Yidong committed
773
contains the settings before custom themes are applied.  The
774
theme `user' contains all the settings the user customized and saved.
775 776 777 778 779 780 781 782 783 784 785 786
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)))

787 788 789
(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.
790 791 792

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
793
`reset', then SYMBOL will be removed from THEME (VALUE is ignored).
794 795

See `custom-known-themes' for a list of known themes."
796
  (unless (memq prop '(theme-value theme-face))
797
    (error "Unknown theme property"))
798
  (let* ((old (get symbol prop))
799 800 801 802
	 (setting (assq theme old))  ; '(theme value)
	 (theme-settings             ; '(prop symbol theme value)
	  (get theme 'theme-settings)))
    (if (eq mode 'reset)
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
	;; 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
820
		 (cons (list prop symbol theme value)
821
		       (delq res theme-settings)))
822
	    (setcar (cdr setting) value))
823 824
	;; Add a new setting.
	;; If the user changed the value outside of Customize, we
825
	;; first save the current value to a fake theme, `changed'.
826 827 828 829
	;; This ensures that the user-set value comes back if the
	;; theme is later disabled.
	(if (null old)
	    (if (and (eq prop 'theme-value)
830 831
		     (boundp symbol))
		(let ((sv (get symbol 'standard-value)))
832 833 834
		  (unless (and sv
                               (equal (eval (car sv)) (symbol-value symbol)))
                    (setq old (list (list 'changed (symbol-value symbol))))))
835 836
	      (if (and (facep symbol)
		       (not (face-spec-match-p symbol (get symbol 'face-defface-spec))))
837
		  (setq old (list (list 'changed (list
838
		    (append '(t) (custom-face-attributes-get symbol nil)))))))))
839
	(put symbol prop (cons (list theme value) old))
840
	(put theme 'theme-settings
841
	     (cons (list prop symbol theme value)
842
		   theme-settings))))))
843

844

845
(defun custom-set-variables (&rest args)
846 847
  "Install user customizations of variable values specified in ARGS.
These settings are registered as theme `user'.
848
The arguments should each be a list of the form:
849

850
  (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
851

852 853 854
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.
855

856 857
REQUEST is a list of features we must require in order to
handle SYMBOL properly.
858
COMMENT is a comment string about SYMBOL."
859 860 861
  (apply 'custom-theme-set-variables 'user args))

(defun custom-theme-set-variables (theme &rest args)
862 863
  "Initialize variables for theme THEME according to settings in ARGS.
Each of the arguments in ARGS should be a list of this 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 874
COMMENT is a comment string about SYMBOL.

875
EXP itself is saved unevaluated as SYMBOL property `saved-value' and
876 877
in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
  (custom-check-theme theme)
878 879 880 881 882 883 884 885 886 887 888 889
 
  ;; 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.
890 891 892 893 894 895 896 897 898 899 900
  (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)
901 902 903 904 905 906 907
			;; 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))))))))
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
  (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
925 926 927 928 929 930 931 932 933
	    ;; 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))))
934
	      (error
935
	       (message "Error setting %s: %s" symbol data)))
936 937 938
	    (setq args (cdr args))
	    (and (or now (default-boundp symbol))
		 (put symbol 'variable-comment comment)))
939 940
        ;; I believe this is dead-code, because the `sort' code above would
        ;; have burped before we could get here.  --Stef
941 942 943 944 945 946 947 948 949
	;; 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)))))))
950

951 952 953

;;; Defining themes.

954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
;; 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)
970 971


972 973 974
;; 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.
975

976 977 978
(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.
979 980 981 982 983 984 985

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

988
(defun custom-declare-theme (theme feature &optional doc &rest ignored)
989
  "Like `deftheme', but THEME is evaluated as a normal argument.
990 991 992 993
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))
994 995
  (add-to-list 'custom-known-themes theme)
  (put theme 'theme-feature feature)
996
  (when doc (put theme 'theme-documentation doc)))
997 998 999 1000 1001 1002 1003 1004 1005

(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
1006
\(load-theme X) then attempts to load the file `X-theme.el'."
1007 1008 1009 1010
  (intern (concat (symbol-name theme) "-theme")))

;;; Loading themes.

1011 1012 1013 1014 1015 1016
(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
1017
`load-theme' searches this directory in addition to load-path.
1018 1019 1020 1021 1022 1023
The command `customize-create-theme' writes the files it produces
into this directory."
  :type 'string
  :group 'customize
  :version "22.1")

1024
(defun provide-theme (theme)
1025 1026 1027 1028 1029 1030
  "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))
1031 1032
  (custom-check-theme theme)
  (provide (get theme 'theme-feature))
1033
  ;; Loading a theme also enables it.
1034 1035 1036 1037
  (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.)
1038 1039
  (let ((custom-enabling-themes t))
    (enable-theme 'user)))
1040

Chong Yidong's avatar
Chong Yidong committed
1041
(defun load-theme (theme)
1042
  "Load a theme's settings from its file.
Chong Yidong's avatar
Chong Yidong committed
1043
This also enables the theme; use `disable-theme' to disable it."
1044 1045
  ;; 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
1046
  (interactive "SCustom theme name: ")
1047 1048 1049 1050 1051 1052
  ;; 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))
1053 1054 1055
  (let ((load-path (if (file-directory-p custom-theme-directory)
		       (cons custom-theme-directory load-path)
		     load-path)))
1056
    (load (symbol-name (custom-make-theme-feature theme)))))
1057 1058 1059

;;; Enabling and disabling loaded themes.

1060 1061
(defvar custom-enabling-themes nil)

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

1067 1068
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
1069
  (interactive "SEnable Custom theme: ")
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
  (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)))))
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099

(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)
  :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
1100
	   (let ((custom-enabling-themes t) failures)
1101 1102 1103 1104 1105 1106
	     (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))
1107
	       (condition-case nil
1108
		   (enable-theme theme)
1109 1110
		 (error (progn (push theme failures)
			       (setq themes (delq theme themes))))))
1111
	     (enable-theme 'user)
1112 1113 1114 1115
	     (custom-set-default symbol themes)
	     (if failures
		 (message "Failed to enable themes: %s"
			  (mapconcat 'symbol-name failures " ")))))))
1116

1117
(defsubst custom-theme-enabled-p (theme)
1118 1119
  "Return non-nil if THEME is enabled."
  (memq theme custom-enabled-themes))
1120

Chong Yidong's avatar
Chong Yidong committed
1121
(defun disable-theme (theme)
1122
  "Disable all variable and face settings defined by THEME.
1123
See `custom-enabled-themes' for a list of enabled themes."
1124 1125 1126 1127 1128 1129
  (interactive (list (intern
		      (completing-read
		       "Disable Custom theme: "
		       (mapcar 'symbol-name custom-enabled-themes)
		       nil t))))
  (when (custom-theme-enabled-p theme)
1130 1131 1132 1133 1134 1135 1136 1137
    (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)
1138 1139 1140
	    (custom-theme-recalc-face symbol)))))
    (setq custom-enabled-themes
	  (delq theme custom-enabled-themes))))
1141 1142 1143 1144 1145 1146 1147 1148 1149

(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
1150
	(cdr (car theme-value)))))
1151 1152 1153 1154

(defun custom-theme-recalc-variable (variable)
  "Set VARIABLE according to currently enabled custom themes."
  (let ((valspec (custom-variable-theme-value variable)))
1155 1156
    (if valspec
	(put variable 'saved-value valspec)
1157
      (setq valspec (get variable 'standard-value)))
1158 1159 1160 1161 1162
    (if (and valspec
	     (or (get variable 'force-value)
		 (default-boundp variable)))
	(funcall (or (get variable 'custom-set) 'set-default) variable
		 (eval (car valspec))))))
1163 1164 1165

(defun custom-theme-recalc-face (face)
  "Set FACE according to currently enabled custom themes."
1166 1167 1168
  (if (facep face)
      (let ((theme-faces (reverse (get face 'theme-face))))
	(dolist (spec theme-faces)
1169
	  (face-spec-set face (cadr spec))))))
1170

1171 1172 1173 1174 1175 1176
;;; XEmacs compability functions

;; In XEmacs, when you reset a Custom Theme, you have to specify the
;; theme to reset it to.  We just apply the next available theme, so
;; just ignore the IGNORED arguments.

1177
(defun custom-theme-reset-variables (theme &rest args)
1178
  "Reset some variable settings in THEME to their values in other themes.
1179
Each of the arguments ARGS has this form:
1180

1181
    (VARIABLE IGNORED)
1182

Chong Yidong's avatar
Chong Yidong committed
1183
This means reset VARIABLE.  (The argument IGNORED is ignored)."
1184
  (custom-check-theme theme)
1185
  (dolist (arg args)