custom.el 54 KB
Newer Older
1 2
;;; custom.el --- tools for declaring and initializing options
;;
3
;; Copyright (C) 1996-1997, 1999, 2001-2011 Free Software Foundation, Inc.
4 5 6 7
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Maintainer: FSF
;; Keywords: help, faces
8
;; Package: emacs
9 10 11

;; This file is part of GNU Emacs.

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

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
24 25 26

;;; Commentary:
;;
Markus Rost's avatar
Markus Rost committed
27
;; This file only contains the code needed to declare and initialize
28 29 30
;; 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
31
;; The code implementing face declarations is in `cus-face.el'.
32 33 34 35 36 37 38 39 40

;;; 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.")

41 42 43 44 45
(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.")

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

49 50 51 52 53 54
;;; 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
55
the car of that and use it as the default binding for symbol.
56 57
Otherwise, VALUE will be evaluated and used as the default binding for
symbol."
58 59 60
  (eval `(defvar ,symbol ,(if (get symbol 'saved-value)
                              (car (get symbol 'saved-value))
                            value))))
61 62 63 64 65 66 67 68 69 70

(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
71 72 73
	     (eval (if (get symbol 'saved-value)
                       (car (get symbol 'saved-value))
                     value)))))
74 75 76 77 78 79 80 81

(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."
82 83 84 85 86 87 88 89 90
  (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)))))
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

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

109 110 111
(defvar custom-delayed-init-variables nil
  "List of variables whose initialization is pending.")

112
(defun custom-initialize-delay (symbol _value)
113
  "Delay initialization of SYMBOL to the next Emacs start.
114 115 116 117 118 119 120 121 122
This is used in files that are preloaded (or for autoloaded
variables), so that the initialization is done in the run-time
context rather than the build-time context.  This also has the
side-effect that the (delayed) initialization is performed with
the :set function.

For variables in preloaded files, you can simply use this
function for the :initialize property.  For autoloaded variables,
you will also need to add an autoload stanza calling this
123 124 125 126
function, and another one setting the standard-value property."
  ;; No longer true:
  ;; "See `send-mail-function' in sendmail.el for an example."

127 128 129 130
  ;; Until the var is actually initialized, it is kept unbound.
  ;; This seemed to be at least as good as setting it to an arbitrary
  ;; value like nil (evaluating `value' is not an option because it
  ;; may have undesirable side-effects).
131 132
  (push symbol custom-delayed-init-variables))

133 134 135
(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,
136 137
not the default value itself.

138
DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property
139 140
`standard-value'.  At the same time, SYMBOL's property `force-value' is
set to nil, as the value is no longer rogue."
141
  (put symbol 'standard-value (purecopy (list default)))
142 143 144
  ;; Maybe this option was rogue in an earlier version.  It no longer is.
  (when (get symbol 'force-value)
    (put symbol 'force-value nil))
145 146
  (if (keywordp doc)
      (error "Doc string is missing"))
147 148
  (let ((initialize 'custom-initialize-reset)
	(requests nil))
149 150
    (unless (memq :group args)
      (custom-add-to-group (custom-current-group) symbol 'custom-variable))
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
    (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)
168
		 (push value requests))
169 170 171 172
		((eq keyword :risky)
		 (put symbol 'risky-local-variable value))
		((eq keyword :safe)
		 (put symbol 'safe-local-variable value))
173 174 175 176 177 178 179
		((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))
180
			   value)
181 182 183 184 185 186 187
		   ;; 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.
188 189
    (unless custom-dont-initialize
      (funcall initialize symbol default)))
190 191 192 193 194 195 196
  ;; Use defvar to set the docstring as well as the special-variable-p flag.
  ;; FIXME: We should reproduce more of `defvar's behavior, such as the warning
  ;; when the var is currently let-bound.
  (if (not (default-boundp symbol))
      ;; Don't use defvar to avoid setting a default-value when undesired.
      (when doc (put symbol 'variable-documentation doc))
    (eval `(defvar ,symbol nil ,@(when doc (list doc)))))
197
  (push symbol current-load-list)
198 199 200 201 202 203 204
  (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.

205
Neither SYMBOL nor VALUE need to be quoted.
206 207 208 209 210 211 212
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
213
:type	VALUE should be a widget type for editing the symbol's value.
214
:options VALUE should be a list of valid members of the widget type.
215 216 217 218 219
: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'.
220 221
:set	VALUE should be a function to set the value of the symbol
        when using the Customize user interface.
222
	It takes two arguments, the symbol to set and the value to
Glenn Morris's avatar
Glenn Morris committed
223
	give it.  The default choice of function is `set-default'.
224 225 226
: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
227
	is `default-value'.
228 229 230 231
: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.
232 233
:risky	Set SYMBOL's `risky-local-variable' property to VALUE.
:safe	Set SYMBOL's `safe-local-variable' property to VALUE.
234 235 236

The following common keywords are also meaningful.

237
:group  VALUE should be a customization group.
238
        Add SYMBOL (or FACE with `defface') to that group.
239
:link LINK-DATA
240 241 242
        Include an external link after the documentation string for this
        item.  This is a sentence containing an active field which
        references some other documentation.
243

244
        There are several alternatives you can use for LINK-DATA:
245

246
        (custom-manual INFO-NODE)
247
             Link to an Info node; INFO-NODE is a string which specifies
248
             the node name, as in \"(emacs)Top\".
249

250
        (info-link INFO-NODE)
251 252
             Like `custom-manual' except that the link appears in the
             customization buffer with the Info node name.
253

254
        (url-link URL)
255
             Link to a web page; URL is a string which specifies the URL.
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

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

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

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

Luc Teirlinck's avatar
Luc Teirlinck committed
306 307 308 309 310 311 312
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.)

313 314
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
315
  (declare (doc-string 3) (debug (name body)))
316 317 318
  ;; 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.
319 320 321 322 323 324 325 326 327 328 329 330 331
  `(custom-declare-variable
    ',symbol
    ,(if lexical-binding    ;FIXME: This is not reliable, but is all we have.
         ;; The `default' arg should be an expression that evaluates to
         ;; the value to use.  The use of `eval' for it is spread over
         ;; many different places and hence difficult to eliminate, yet
         ;; we want to make sure that the `value' expression is checked by the
         ;; byte-compiler, and that lexical-binding is obeyed, so quote the
         ;; expression with `lambda' rather than with `quote'.
         `(list (lambda () ,value))
       `',value)
    ,doc
    ,@args))
332 333 334 335 336 337 338 339 340

;;; 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
341
If FACE has been set with `custom-set-faces', set the face attributes
342 343 344 345 346 347 348
as specified by that function, otherwise set the face attributes
according to SPEC.

The remaining arguments should have the form

   [KEYWORD VALUE]...

349 350
For a list of valid keywords, see the common keywords listed in
`defcustom'.
351 352 353

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

354
In the first element, DISPLAY can be `default'.  The ATTS in that
Richard M. Stallman's avatar
Richard M. Stallman committed
355 356 357 358 359 360 361 362 363
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
364
frame if none of the previous elements (except the `default' if
Richard M. Stallman's avatar
Richard M. Stallman committed
365
any) did.
366 367 368 369 370 371

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

374
DISPLAY can be `default' (only in the first element), the symbol
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376 377 378 379
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:
380 381 382

`type' (the value of `window-system')
  Under X, in addition to the values `window-system' can take,
383 384
  `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.
385 386 387 388 389 390 391

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

392 393 394 395
`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'.

396 397 398 399 400
`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.

401 402
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
403
  (declare (doc-string 3))
404 405 406 407 408 409 410
  ;; 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.

411 412 413
(defun custom-current-group ()
  (cdr (assoc load-file-name custom-current-group-alist)))

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
(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)
433
	       (put symbol 'custom-prefix (purecopy value)))
434 435 436
	      (t
	       (custom-handle-keyword symbol keyword value
				      'custom-group))))))
437 438 439
  ;; Record the group on the `current' list.
  (let ((elt (assoc load-file-name custom-current-group-alist)))
    (if elt (setcdr elt symbol)
440 441
      (push (cons (purecopy load-file-name) symbol)
	    custom-current-group-alist)))
442 443 444 445 446 447 448
  (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.

Glenn Morris's avatar
Glenn Morris committed
449 450 451 452
Third argument DOC is the group documentation.  This should be a short
description of the group, beginning with a capital and ending with
a period.  Words other than the first should not be capitalized, if they
are not usually written so.
453 454 455 456 457 458 459 460 461 462

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

463 464
For a list of valid keywords, see the common keywords listed in
`defcustom'.
465

466 467
See Info node `(elisp) Customization' in the Emacs Lisp manual
for more information."
468
  (declare (doc-string 3))
469 470 471 472 473 474 475 476 477 478 479 480 481
  ;; 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))))))

482 483 484 485 486 487 488 489 490 491 492
(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)))

493 494 495 496 497
;;; 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."
498
  (unless (memq :group args)
499
    (custom-add-to-group (custom-current-group) symbol type))
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))
521 522
	((eq keyword :package-version)
	 (custom-add-package-version symbol value))
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
	((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))))
552

553 554 555
(defun custom-add-option (symbol option)
  "To the variable SYMBOL add OPTION.

556 557 558 559
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."
560 561 562
  (let ((options (get symbol 'custom-options)))
    (unless (member option options)
      (put symbol 'custom-options (cons option options)))))
563
(defalias 'custom-add-frequent-value 'custom-add-option)
564 565 566 567 568 569 570 571 572 573 574

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

575 576 577 578
(defun custom-add-package-version (symbol version)
  "To the custom option SYMBOL add the package version VERSION."
  (put symbol 'custom-package-version (purecopy version)))

579 580 581 582 583 584 585
(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)))))

586 587 588 589
(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))
590 591 592 593
  (custom-add-load symbol load))

;; This test is also in the C code of `user-variable-p'.
(defun custom-variable-p (variable)
594 595 596
  "Return non-nil if VARIABLE is a custom variable.
This recursively follows aliases."
  (setq variable (indirect-variable variable))
597 598 599
  (or (get variable 'standard-value)
      (get variable 'custom-autoload)))

600 601 602 603 604
(defun custom-note-var-changed (variable)
  "Inform Custom that VARIABLE has been set (changed).
VARIABLE is a symbol that names a user option.
The result is that the change is treated as having been made through Custom."
  (put variable 'customized-value (list (custom-quote (eval variable)))))
605 606 607


;;; Custom Themes
608

609 610 611 612 613 614 615 616 617
;;; 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
618
    (let ((custom-load-recursion t))
619 620 621 622 623 624 625 626
      ;; 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))
627 628 629
      (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.
630 631 632 633
	      ((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.
634 635 636
	      ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
				     "\\(\\'\\|\\.\\)"))
		     (found nil))
637
		 (dolist (loaded load-history)
638 639
		   (and (stringp (car loaded))
			(string-match regexp (car loaded))
640 641 642 643 644 645
			(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"))
646
	      (t (condition-case nil (load load) (error nil))))))))
647

648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
(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)
678
  "Quote SEXP if it is not self quoting."
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
  (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'.

701
Return non-nil if the `saved-value' property actually changed."
702
  (custom-load-symbol symbol)
703 704 705 706 707
  (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)))
708
    ;; Save default value if different from standard value.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
    (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.

730
Return non-nil if the `customized-value' property actually changed."
731
  (custom-load-symbol symbol)
732 733 734 735
  (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))))
736
    ;; Mark default value as set if different from old value.
737 738 739 740
    (if (not (and old
                  (equal value (condition-case nil
                                   (eval (car old))
                                 (error nil)))))
741 742 743
	(progn (put symbol 'customized-value (list (custom-quote value)))
	       (custom-push-theme 'theme-value symbol 'user 'set
				  (custom-quote value)))
744 745 746 747 748 749 750 751 752 753 754 755 756 757
      (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))))))


758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
;;; 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)
804
   "Themes that have been defined with `deftheme'.
805
The default value is the list (user changed).  The theme `changed'
806 807 808 809
contains the settings before custom themes are applied.  The theme
`user' contains all the settings the user customized and saved.
Additional themes declared with the `deftheme' macro will be added
to the front of this list.")
810 811 812 813 814 815 816 817 818 819

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

820 821 822
(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.
823 824 825

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

See `custom-known-themes' for a list of known themes."
829
  (unless (memq prop '(theme-value theme-face))
830
    (error "Unknown theme property"))
831
  (let* ((old (get symbol prop))
832 833 834
	 (setting (assq theme old))  ; '(theme value)
	 (theme-settings             ; '(prop symbol theme value)
	  (get theme 'theme-settings)))
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
    (cond
     ;; Remove a setting:
     ((eq mode 'reset)
      (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))))
     ;; Alter an existing setting:
     (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
	     (cons (list prop symbol theme value)
		   (delq res theme-settings)))
	(setcar (cdr setting) value)))
     ;; Add a new setting:
     (t
      (unless old
860 861 862 863 864 865 866 867 868 869 870 871
	;; If the user changed a variable outside of Customize, save
	;; the value to a fake theme, `changed'.  If the theme is
	;; later disabled, we use this to bring back the old value.
	;;
	;; For faces, we just use `face-new-frame-defaults' to
	;; recompute when the theme is disabled.
	(when (and (eq prop 'theme-value)
		   (boundp symbol))
	  (let ((sv  (get symbol 'standard-value))
		(val (symbol-value symbol)))
	    (unless (and sv (equal (eval (car sv)) val))
	      (setq old `((changed ,(custom-quote val))))))))
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
      (put symbol prop (cons (list theme value) old))
      (put theme 'theme-settings
	   (cons (list prop symbol theme value) theme-settings))))))

(defun custom-fix-face-spec (spec)
  "Convert face SPEC, replacing obsolete :bold and :italic attributes.
Also change :reverse-video to :inverse-video."
  (when (listp spec)
    (if (or (memq :bold spec)
	    (memq :italic spec)
	    (memq :inverse-video spec))
	(let (result)
	  (while spec
	    (let ((key (car spec))
		  (val (car (cdr spec))))
	      (cond ((eq key :italic)
		     (push :slant result)
		     (push (if val 'italic 'normal) result))
		    ((eq key :bold)
		     (push :weight result)
		     (push (if val 'bold 'normal) result))
		    ((eq key :reverse-video)
		     (push :inverse-video result)
		     (push val result))
		    (t
		     (push key result)
		     (push val result))))
	    (setq spec (cddr spec)))
	  (nreverse result))
      spec)))
902

903
(defun custom-set-variables (&rest args)
904 905
  "Install user customizations of variable values specified in ARGS.
These settings are registered as theme `user'.
906
The arguments should each be a list of the form:
907

908
  (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
909

910 911 912
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.
913

914 915
REQUEST is a list of features we must require in order to
handle SYMBOL properly.
916
COMMENT is a comment string about SYMBOL."
917 918 919
  (apply 'custom-theme-set-variables 'user args))

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

923
  (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
924

925 926 927
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.
928

929 930
REQUEST is a list of features we must require in order to
handle SYMBOL properly.
931 932
COMMENT is a comment string about SYMBOL.

933
EXP itself is saved unevaluated as SYMBOL property `saved-value' and
934 935
in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
  (custom-check-theme theme)
936

937 938 939 940 941 942 943 944 945
  ;; 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))))
946

947
  ;; Move minor modes and variables with explicit requires to the end.
948 949 950 951 952 953 954 955 956 957 958
  (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)
959 960
			;; 1 is a dependency of 2, so needs to be set first.
			(1-then-2)
961 962 963 964 965 966 967
			;; 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))))))))
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984

  (dolist (entry args)
    (unless (listp entry)
      (error "Incompatible Custom theme spec"))
    (let* ((symbol (indirect-variable (nth 0 entry)))
	   (value (nth 1 entry)))
      (custom-push-theme 'theme-value symbol theme 'set value)
      (unless custom--inhibit-theme-enable
	;; Now set the variable.
	(let* ((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))
985
	  (put symbol 'saved-value (list value))
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
	  (put symbol 'saved-variable-comment comment)
	  ;; Allow for errors in the case where the setter has
	  ;; 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))))
	    (error
	     (message "Error setting %s: %s" symbol data)))
	  (and (or now (default-boundp symbol))
	       (put symbol 'variable-comment comment)))))))
1001

1002 1003 1004

;;; Defining themes.

1005 1006
;; A theme file is named `THEME-theme.el' (where THEME is the theme
;; name) found in `custom-theme-load-path'.  It has this format:
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
;;
;;   (deftheme THEME
;;     DOCSTRING)
;;
;;   (custom-theme-set-variables
;;    'THEME
;;    [THEME-VARIABLES])
;;
;;   (custom-theme-set-faces
;;    'THEME
;;    [THEME-FACES])
;;
;;   (provide-theme 'THEME)
1020 1021


1022 1023 1024
;; 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.
1025

1026 1027 1028
(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.
1029 1030 1031 1032 1033 1034 1035

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

1038
(defun custom-declare-theme (theme feature &optional doc &rest ignored)
1039
  "Like `deftheme', but THEME is evaluated as a normal argument.
1040 1041
FEATURE is the feature this theme provides.  Normally, this is a symbol
created from THEME by `custom-make-theme-feature'."
1042 1043
  (unless (custom-theme-name-valid-p theme)
    (error "Custom theme cannot be named %S" theme))
1044 1045
  (add-to-list 'custom-known-themes theme)
  (put theme 'theme-feature feature)
1046
  (when doc (put theme 'theme-documentation doc)))
1047 1048 1049 1050 1051 1052 1053 1054 1055

(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
1056
\(load-theme X) then attempts to load the file `X-theme.el'."
1057 1058 1059 1060
  (intern (concat (symbol-name theme) "-theme")))

;;; Loading themes.

1061 1062 1063 1064 1065
(defcustom custom-theme-directory user-emacs-directory
  "Default user directory for storing custom theme files.
The command `customize-create-theme' writes theme files into this
directory.  By default, Emacs searches for custom themes in this
directory first---see `custom-theme-load-path'."
1066 1067 1068 1069
  :type 'string
  :group 'customize
  :version "22.1")

1070 1071
(defcustom custom-theme-load-path (list 'custom-theme-directory t)
  "List of directories to search for custom theme files.
1072 1073
When loading custom themes (e.g. in `customize-themes' and
`load-theme'), Emacs searches for theme files in the specified
1074
order.  Each element in the list should be one of the following:
1075 1076 1077 1078
- the symbol `custom-theme-directory', meaning the value of
  `custom-theme-directory'.
- the symbol t, meaning the built-in theme directory (a directory
  named \"themes\" in `data-directory').
1079 1080
- a directory name (a string).

1081
Each theme file is named THEME-theme.el, where THEME is the theme
1082
name."
1083 1084 1085 1086 1087 1088 1089
  :type '(repeat (choice (const :tag "custom-theme-directory"
				custom-theme-directory)
			 (const :tag "Built-in theme directory" t)
			 directory))
  :group 'customize
  :version "24.1")

1090
(defvar custom--inhibit-theme-enable nil
1091 1092 1093 1094
  "Whether the custom-theme-set-* functions act immediately.
If nil, `custom-theme-set-variables' and `custom-theme-set-faces'
change the current values of the given variable or face.  If
non-nil, they just make a record of the theme settings.")
1095

1096
(defun provide-theme (theme)
1097 1098 1099 1100
  "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')."
1101 1102
  (unless (custom-theme-name-valid-p theme)
    (error "Custom theme cannot be named %S" theme))
1103
  (custom-check-theme theme)
1104
  (provide (get theme 'theme-feature)))
1105

1106 1107 1108 1109 1110 1111
(defcustom custom-safe-themes '(default)
  "List of themes that are considered safe to load.
Each list element should be the `sha1' hash of a theme file, or
the symbol `default', which stands for any theme in the built-in
Emacs theme directory (a directory named \"themes\" in
`data-directory')."
1112
  :type '(repeat
1113
	  (choice string (const :tag "Built-in themes" default)))
1114
  :group 'customize
1115
  :risky t
1116 1117
  :version "24.1")

1118
(defun load-theme (theme &optional no-confirm no-enable)
1119 1120 1121
  "Load Custom theme named THEME from its file.
The theme file is named THEME-theme.el, in one of the directories
specified by `custom-theme-load-path'.
1122

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
If THEME is not in `custom-safe-themes', prompt the user for
confirmation, unless optional arg NO-CONFIRM is non-nil.

Normally, this function also enables THEME; if optional arg
NO-ENABLE is non-nil, load the theme but don't enable it.

This function is normally called through Customize when setting
`custom-enabled-themes'.  If used directly in your init file, it
should be called with a non-nil NO-CONFIRM argument, or after
`custom-safe-themes' has been loaded.

1134
Return t if THEME was successfully loaded, nil otherwise."
1135 1136 1137
  (interactive
   (list
    (intern (completing-read "Load custom theme: "
1138
			     (mapcar 'symbol-name
1139 1140
				     (custom-available-themes))))
    nil nil))
1141 1142
  (unless (custom-theme-name-valid-p theme)
    (error "Invalid theme name `%s'" theme))
1143 1144 1145 1146 1147 1148
  ;; 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))
1149
  (let ((fn (locate-file (concat (symbol-name theme) "-theme.el")
1150
			 (custom-theme--load-path)
1151 1152
			 '("" "c")))
	hash)
1153
    (unless fn
1154
      (error "Unable to find theme file for `%s'" theme))
1155 1156 1157
    (with-temp-buffer
      (insert-file-contents fn)
      (setq hash (sha1 (current-buffer)))
1158 1159
      ;; Check file safety with `custom-safe-themes', prompting the
      ;; user if necessary.
1160 1161
      (when (or no-confirm
		(and (memq 'default custom-safe-themes)
1162 1163 1164
		     (equal (file-name-directory fn)
			    (expand-file-name "themes/" data-directory)))
		(member hash custom-safe-themes)
1165
		(custom-theme-load-confirm hash))
1166 1167
	(let ((custom--inhibit-theme-enable t))
	  (eval-buffer))
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
	;; Optimization: if the theme changes the `default' face, put that
	;; entry first.  This avoids some `frame-set-background-mode' rigmarole
	;; by assigning the new background immediately.
	(let* ((settings (get theme 'theme-settings))
	       (tail settings)
	       found)
	  (while (and tail (not found))
	    (and (eq (nth 0 (car tail)) 'theme-face)
		 (eq (nth 1 (car tail)) 'default)
		 (setq found (car tail)))
	    (setq tail (cdr tail)))
	  (if found
	      (put theme 'theme-settings (cons found (delq found settings)))))
	;; Finally, enable the theme.
1182 1183 1184
	(unless no-enable
	  (enable-theme theme))
	t))))
1185 1186 1187 1188 1189

(defun custom-theme-load-confirm (hash)
  "Query the user about loading a Custom theme that may not be safe.
The theme should be in the current buffer.  If the user agrees,
query also about adding HASH to `custom-safe-themes'."
1190 1191
  (if noninteractive
      nil
1192
    (let ((exit-chars '(?y ?n ?\s))
1193
	  window prompt char)
1194
      (save-window-excursion
1195 1196
	(rename-buffer "*Custom Theme*" t)
	(emacs-lisp-mode)
1197
	(setq window (display-buffer (current-buffer)))
1198
	(setq prompt
1199 1200 1201 1202 1203
	      (format "Loading a theme can run Lisp code.  Really load?%s"
		      (if (and window
			       (< (line-number-at-pos (point-max))
				  (window-body-height)))
			  " (y or n) "
1204
			(push ?\C-v exit-chars)
1205
			"\nType y or n, or C-v to scroll: ")))
1206 1207 1208 1209
	(goto-char (point-min))
	(while (null char)
	  (setq char (read-char-choice prompt exit-chars))
	  (when (eq char ?\C-v)
1210 1211 1212 1213 1214
	    (if window
		(with-selected-window window
		  (condition-case nil
		      (scroll-up)
		    (error (goto-char (point-min))))))
1215 1216 1217 1218
	    (setq char nil)))
	(when (memq char '(?\s ?y))
	  ;; Offer to save to `custom-safe-themes'.
	  (and (or custom-file user-init-file)
1219
	       (y-or-n-p "Treat this theme as safe in future sessions? ")