1 ;;; custom.el --- tools for declaring and initializing options
3 ;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004,
4 ;; 2005 Free Software Foundation, Inc.
6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
8 ;; Keywords: help, faces
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; This file only contains the code needed to declare and initialize
30 ;; user options. The code to customize options is autoloaded from
31 ;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual.
33 ;; The code implementing face declarations is in `cus-face.el'.
39 (defvar custom-define-hook nil
40 ;; Customize information for this option is in `cus-edit.el'.
41 "Hook called after defining each customize option.")
43 (defvar custom-dont-initialize nil
44 "Non-nil means `defcustom' should not initialize the variable.
45 That is used for the sake of `custom-make-dependencies'.
46 Users should not set it.")
48 (defvar custom-current-group-alist nil
49 "Alist of (FILE . GROUP) indicating the current group to use for FILE.")
51 ;;; The `defcustom' Macro.
53 (defun custom-initialize-default (symbol value
)
54 "Initialize SYMBOL with VALUE.
55 This will do nothing if symbol already has a default binding.
56 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 Otherwise, VALUE will be evaluated and used as the default binding for
60 (unless (default-boundp symbol
)
61 ;; Use the saved value if it exists, otherwise the standard setting.
62 (set-default symbol
(if (get symbol
'saved-value
)
63 (eval (car (get symbol
'saved-value
)))
66 (defun custom-initialize-set (symbol value
)
67 "Initialize SYMBOL based on VALUE.
68 If the symbol doesn't have a default binding already,
69 then set it using its `:set' function (or `set-default' if it has none).
70 The value is either the value in the symbol's `saved-value' property,
72 (unless (default-boundp symbol
)
73 (funcall (or (get symbol
'custom-set
) 'set-default
)
75 (if (get symbol
'saved-value
)
76 (eval (car (get symbol
'saved-value
)))
79 (defun custom-initialize-safe-set (symbol value
)
80 "Like `custom-initialize-set', but catches errors.
81 If an error occurs during initialization, SYMBOL is set to nil
82 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
84 be defined. You can then re-evaluate VALUE in startup.el, for instance
85 using `custom-reevaluate-setting'."
87 (custom-initialize-set symbol value
)
88 (error (set-default symbol nil
))))
90 (defun custom-initialize-safe-default (symbol value
)
91 "Like `custom-initialize-default', but catches errors.
92 If an error occurs during initialization, SYMBOL is set to nil
93 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
95 be defined. You can then re-evaluate VALUE in startup.el, for instance
96 using `custom-reevaluate-setting'."
98 (custom-initialize-default symbol value
)
99 (error (set-default symbol nil
))))
101 (defun custom-initialize-reset (symbol value
)
102 "Initialize SYMBOL based on VALUE.
103 Set the symbol, using its `:set' function (or `set-default' if it has none).
104 The value is either the symbol's current value
105 \(as obtained using the `:get' function), if any,
106 or the value in the symbol's `saved-value' property if any,
107 or (last of all) VALUE."
108 (funcall (or (get symbol
'custom-set
) 'set-default
)
110 (cond ((default-boundp symbol
)
111 (funcall (or (get symbol
'custom-get
) 'default-value
)
113 ((get symbol
'saved-value
)
114 (eval (car (get symbol
'saved-value
))))
118 (defun custom-initialize-changed (symbol value
)
119 "Initialize SYMBOL with VALUE.
120 Like `custom-initialize-reset', but only use the `:set' function if
121 not using the standard setting.
122 For the standard setting, use `set-default'."
123 (cond ((default-boundp symbol
)
124 (funcall (or (get symbol
'custom-set
) 'set-default
)
126 (funcall (or (get symbol
'custom-get
) 'default-value
)
128 ((get symbol
'saved-value
)
129 (funcall (or (get symbol
'custom-set
) 'set-default
)
131 (eval (car (get symbol
'saved-value
)))))
133 (set-default symbol
(eval value
)))))
135 (defun custom-declare-variable (symbol default doc
&rest args
)
136 "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments.
137 DEFAULT should be an expression to evaluate to compute the default value,
138 not the default value itself.
140 DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property
141 `standard-value'. At the same time, SYMBOL's property `force-value' is
142 set to nil, as the value is no longer rogue."
143 (put symbol
'standard-value
(list default
))
144 ;; Maybe this option was rogue in an earlier version. It no longer is.
145 (when (get symbol
'force-value
)
146 (put symbol
'force-value nil
))
148 (put symbol
'variable-documentation doc
))
149 (let ((initialize 'custom-initialize-reset
)
151 (unless (memq :group args
)
152 (custom-add-to-group (custom-current-group) symbol
'custom-variable
))
154 (let ((arg (car args
)))
155 (setq args
(cdr args
))
156 (unless (symbolp arg
)
157 (error "Junk in args %S" args
))
161 (error "Keyword %s is missing an argument" keyword
))
162 (setq args
(cdr args
))
163 (cond ((eq keyword
:initialize
)
164 (setq initialize value
))
166 (put symbol
'custom-set value
))
168 (put symbol
'custom-get value
))
169 ((eq keyword
:require
)
170 (push value requests
))
172 (put symbol
'custom-type
(purecopy value
)))
173 ((eq keyword
:options
)
174 (if (get symbol
'custom-options
)
175 ;; Slow safe code to avoid duplicates.
176 (mapc (lambda (option)
177 (custom-add-option symbol option
))
179 ;; Fast code for the common case.
180 (put symbol
'custom-options
(copy-sequence value
))))
182 (custom-handle-keyword symbol keyword value
183 'custom-variable
))))))
184 (put symbol
'custom-requests requests
)
185 ;; Do the actual initialization.
186 (unless custom-dont-initialize
187 (funcall initialize symbol default
)))
188 (push symbol current-load-list
)
189 (run-hooks 'custom-define-hook
)
192 (defmacro defcustom
(symbol value doc
&rest args
)
193 "Declare SYMBOL as a customizable variable that defaults to VALUE.
194 DOC is the variable documentation.
196 Neither SYMBOL nor VALUE need to be quoted.
197 If SYMBOL is not already bound, initialize it to VALUE.
198 The remaining arguments should have the form
202 The following keywords are meaningful:
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 :group VALUE should be a customization group.
207 Add SYMBOL to that group.
209 Include an external link after the documentation string for this
210 item. This is a sentence containing an active field which
211 references some other documentation.
213 There are several alternatives you can use for LINK-DATA:
215 (custom-manual INFO-NODE)
216 Link to an Info node; INFO-NODE is a string which specifies
217 the node name, as in \"(emacs)Top\".
219 (info-link INFO-NODE)
220 Like `custom-manual' except that the link appears in the
221 customization buffer with the Info node name.
224 Link to a web page; URL is a string which specifies the URL.
226 (emacs-commentary-link LIBRARY)
227 Link to the commentary section of LIBRARY.
229 (emacs-library-link LIBRARY)
230 Link to an Emacs Lisp LIBRARY file.
235 (function-link FUNCTION)
236 Link to the documentation of FUNCTION.
238 (variable-link VARIABLE)
239 Link to the documentation of VARIABLE.
241 (custom-group-link GROUP)
242 Link to another customization GROUP.
244 You can specify the text to use in the customization buffer by
245 adding `:tag NAME' after the first element of the LINK-DATA; for
246 example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the
247 Emacs manual which appears in the buffer as `foo'.
249 An item can have more than one external link; however, most items
252 VALUE should be a function used to initialize the
253 variable. It takes two arguments, the symbol and value
254 given in the `defcustom' call. The default is
255 `custom-initialize-reset'.
256 :set VALUE should be a function to set the value of the symbol.
257 It takes two arguments, the symbol to set and the value to
258 give it. The default choice of function is `custom-set-default'.
259 :get VALUE should be a function to extract the value of symbol.
260 The function takes one argument, a symbol, and should return
261 the current value for that symbol. The default choice of function
262 is `custom-default-value'.
264 VALUE should be a feature symbol. If you save a value
265 for this option, then when your `.emacs' file loads the value,
266 it does (require VALUE) first.
268 VALUE should be a string specifying that the variable was
269 first introduced, or its default value was changed, in Emacs
272 Use LABEL, a string, instead of the item's name, to label the item
273 in customization menus and buffers.
275 Load file FILE (a string) before displaying this customization
276 item. Loading is done with `load', and only if the file is
279 Specifies that SYMBOL should be set after the list of variables
280 VARIABLES when both have been customized.
282 If SYMBOL has a local binding, then this form affects the local
283 binding. This is normally not what you want. Thus, if you need
284 to load a file defining variables with this form, or with
285 `defvar' or `defconst', you should always load that file
286 _outside_ any bindings for these variables. \(`defvar' and
287 `defconst' behave similarly in this respect.)
289 Read the section about customization in the Emacs Lisp manual for more
291 (declare (doc-string 3))
292 ;; It is better not to use backquote in this file,
293 ;; because that makes a bootstrapping problem
294 ;; if you need to recompile all the Lisp files using interpreted code.
295 (nconc (list 'custom-declare-variable
301 ;;; The `defface' Macro.
303 (defmacro defface
(face spec doc
&rest args
)
304 "Declare FACE as a customizable face that defaults to SPEC.
305 FACE does not need to be quoted.
307 Third argument DOC is the face documentation.
309 If FACE has been set with `custom-set-faces', set the face attributes
310 as specified by that function, otherwise set the face attributes
313 The remaining arguments should have the form
317 The following KEYWORDs are defined:
319 :group VALUE should be a customization group.
320 Add FACE to that group.
322 SPEC should be an alist of the form ((DISPLAY ATTS)...).
324 In the first element, DISPLAY can be :default. The ATTS in that
325 element then act as defaults for all the following elements.
327 Aside from that, DISPLAY specifies conditions to match some or
328 all frames. For each frame, the first element of SPEC where the
329 DISPLAY conditions are satisfied is the one that applies to that
330 frame. The ATTRs in this element take effect, and the following
331 elements are ignored, on that frame.
333 In the last element, DISPLAY can be t. That element applies to a
334 frame if none of the previous elements (except the :default if
337 ATTS is a list of face attributes followed by their values:
338 (ATTR VALUE ATTR VALUE...)
340 The possible attributes are `:family', `:width', `:height', `:weight',
341 `:slant', `:underline', `:overline', `:strike-through', `:box',
342 `:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'.
344 DISPLAY can be `:default' (only in the first element), the symbol
345 t (only in the last element) to match all frames, or an alist of
346 conditions of the form \(REQ ITEM...). For such an alist to
347 match a frame, each of the conditions must be satisfied, meaning
348 that the REQ property of the frame must match one of the
349 corresponding ITEMs. These are the defined REQ values:
351 `type' (the value of `window-system')
352 Under X, in addition to the values `window-system' can take,
353 `motif', `lucid', `gtk' and `x-toolkit' are allowed, and match when
354 the Motif toolkit, Lucid toolkit, GTK toolkit or any X toolkit is in use.
356 `class' (the frame's color support)
357 Should be one of `color', `grayscale', or `mono'.
359 `background' (what color is used for the background text)
360 Should be one of `light' or `dark'.
362 `min-colors' (the minimum number of colors the frame should support)
363 Should be an integer, it is compared with the result of
364 `display-color-cells'.
366 `supports' (only match frames that support the specified face attributes)
367 Should be a list of face attributes. See the documentation for
368 the function `display-supports-face-attributes-p' for more
369 information on exactly how testing is done.
371 Read the section about customization in the Emacs Lisp manual for more
373 (declare (doc-string 3))
374 ;; It is better not to use backquote in this file,
375 ;; because that makes a bootstrapping problem
376 ;; if you need to recompile all the Lisp files using interpreted code.
377 (nconc (list 'custom-declare-face
(list 'quote face
) spec doc
) args
))
379 ;;; The `defgroup' Macro.
381 (defun custom-current-group ()
382 (cdr (assoc load-file-name custom-current-group-alist
)))
384 (defun custom-declare-group (symbol members doc
&rest args
)
385 "Like `defgroup', but SYMBOL is evaluated as a normal argument."
387 (apply 'custom-add-to-group symbol
(car members
))
388 (setq members
(cdr members
)))
390 ;; This text doesn't get into DOC.
391 (put symbol
'group-documentation
(purecopy doc
)))
393 (let ((arg (car args
)))
394 (setq args
(cdr args
))
395 (unless (symbolp arg
)
396 (error "Junk in args %S" args
))
400 (error "Keyword %s is missing an argument" keyword
))
401 (setq args
(cdr args
))
402 (cond ((eq keyword
:prefix
)
403 (put symbol
'custom-prefix value
))
405 (custom-handle-keyword symbol keyword value
407 ;; Record the group on the `current' list.
408 (let ((elt (assoc load-file-name custom-current-group-alist
)))
409 (if elt
(setcdr elt symbol
)
410 (push (cons load-file-name symbol
) custom-current-group-alist
)))
411 (run-hooks 'custom-define-hook
)
414 (defmacro defgroup
(symbol members doc
&rest args
)
415 "Declare SYMBOL as a customization group containing MEMBERS.
416 SYMBOL does not need to be quoted.
418 Third arg DOC is the group documentation.
420 MEMBERS should be an alist of the form ((NAME WIDGET)...) where
421 NAME is a symbol and WIDGET is a widget for editing that symbol.
422 Useful widgets are `custom-variable' for editing variables,
423 `custom-face' for edit faces, and `custom-group' for editing groups.
425 The remaining arguments should have the form
429 The following KEYWORDs are defined:
431 :group VALUE should be a customization group.
432 Add SYMBOL to that group.
434 :version VALUE should be a string specifying that the group was introduced
435 in Emacs version VERSION.
437 Read the section about customization in the Emacs Lisp manual for more
439 (declare (doc-string 3))
440 ;; It is better not to use backquote in this file,
441 ;; because that makes a bootstrapping problem
442 ;; if you need to recompile all the Lisp files using interpreted code.
443 (nconc (list 'custom-declare-group
(list 'quote symbol
) members doc
) args
))
445 (defun custom-add-to-group (group option widget
)
446 "To existing GROUP add a new OPTION of type WIDGET.
447 If there already is an entry for OPTION and WIDGET, nothing is done."
448 (let ((members (get group
'custom-group
))
449 (entry (list option widget
)))
450 (unless (member entry members
)
451 (put group
'custom-group
(nconc members
(list entry
))))))
453 (defun custom-group-of-mode (mode)
454 "Return the custom group corresponding to the major or minor MODE.
455 If no such group is found, return nil."
456 (or (get mode
'custom-mode-group
)
457 (if (or (get mode
'custom-group
)
458 (and (string-match "-mode\\'" (symbol-name mode
))
459 (get (setq mode
(intern (substring (symbol-name mode
)
460 0 (match-beginning 0))))
466 (defun custom-handle-all-keywords (symbol args type
)
467 "For customization option SYMBOL, handle keyword arguments ARGS.
468 Third argument TYPE is the custom option type."
469 (unless (memq :group args
)
470 (custom-add-to-group (custom-current-group) symbol type
))
472 (let ((arg (car args
)))
473 (setq args
(cdr args
))
474 (unless (symbolp arg
)
475 (error "Junk in args %S" args
))
479 (error "Keyword %s is missing an argument" keyword
))
480 (setq args
(cdr args
))
481 (custom-handle-keyword symbol keyword value type
)))))
483 (defun custom-handle-keyword (symbol keyword value type
)
484 "For customization option SYMBOL, handle KEYWORD with VALUE.
485 Fourth argument TYPE is the custom option type."
487 (setq value
(purecopy value
)))
488 (cond ((eq keyword
:group
)
489 (custom-add-to-group value symbol type
))
490 ((eq keyword
:version
)
491 (custom-add-version symbol value
))
493 (custom-add-link symbol value
))
495 (custom-add-load symbol value
))
497 (put symbol
'custom-tag value
))
498 ((eq keyword
:set-after
)
499 (custom-add-dependencies symbol value
))
501 (error "Unknown keyword %s" keyword
))))
503 (defun custom-add-dependencies (symbol value
)
504 "To the custom option SYMBOL, add dependencies specified by VALUE.
505 VALUE should be a list of symbols. For each symbol in that list,
506 this specifies that SYMBOL should be set after the specified symbol, if
507 both appear in constructs like `custom-set-variables'."
508 (unless (listp value
)
509 (error "Invalid custom dependency `%s'" value
))
510 (let* ((deps (get symbol
'custom-dependencies
))
513 (let ((dep (car value
)))
514 (unless (symbolp dep
)
515 (error "Invalid custom dependency `%s'" dep
))
516 (unless (memq dep new-deps
)
517 (setq new-deps
(cons dep new-deps
)))
518 (setq value
(cdr value
))))
519 (unless (eq deps new-deps
)
520 (put symbol
'custom-dependencies new-deps
))))
522 (defun custom-add-option (symbol option
)
523 "To the variable SYMBOL add OPTION.
525 If SYMBOL's custom type is a hook, OPTION should be a hook member.
526 If SYMBOL's custom type is an alist, OPTION specifies a symbol
527 to offer to the user as a possible key in the alist.
528 For other custom types, this has no effect."
529 (let ((options (get symbol
'custom-options
)))
530 (unless (member option options
)
531 (put symbol
'custom-options
(cons option options
)))))
533 (defun custom-add-link (symbol widget
)
534 "To the custom option SYMBOL add the link WIDGET."
535 (let ((links (get symbol
'custom-links
)))
536 (unless (member widget links
)
537 (put symbol
'custom-links
(cons (purecopy widget
) links
)))))
539 (defun custom-add-version (symbol version
)
540 "To the custom option SYMBOL add the version VERSION."
541 (put symbol
'custom-version
(purecopy version
)))
543 (defun custom-add-load (symbol load
)
544 "To the custom option SYMBOL add the dependency LOAD.
545 LOAD should be either a library file name, or a feature name."
546 (let ((loads (get symbol
'custom-loads
)))
547 (unless (member load loads
)
548 (put symbol
'custom-loads
(cons (purecopy load
) loads
)))))
550 (defun custom-autoload (symbol load
)
551 "Mark SYMBOL as autoloaded custom variable and add dependency LOAD."
552 (put symbol
'custom-autoload t
)
553 (custom-add-load symbol load
))
555 ;; This test is also in the C code of `user-variable-p'.
556 (defun custom-variable-p (variable)
557 "Return non-nil if VARIABLE is a custom variable.
558 This recursively follows aliases."
559 (setq variable
(indirect-variable variable
))
560 (or (get variable
'standard-value
)
561 (get variable
'custom-autoload
)))
563 ;;; Loading files needed to customize a symbol.
564 ;;; This is in custom.el because menu-bar.el needs it for toggle cmds.
566 (defvar custom-load-recursion nil
567 "Hack to avoid recursive dependencies.")
569 (defun custom-load-symbol (symbol)
570 "Load all dependencies for SYMBOL."
571 (unless custom-load-recursion
572 (let ((custom-load-recursion t
))
573 ;; Load these files if not already done,
574 ;; to make sure we know all the dependencies of SYMBOL.
581 (dolist (load (get symbol
'custom-loads
))
582 (cond ((symbolp load
) (condition-case nil
(require load
) (error nil
)))
583 ;; This is subsumed by the test below, but it's much faster.
584 ((assoc load load-history
))
585 ;; This was just (assoc (locate-library load) load-history)
586 ;; but has been optimized not to load locate-library
588 ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load
)
591 (dolist (loaded load-history
)
592 (and (stringp (car loaded
))
593 (string-match regexp
(car loaded
))
596 ;; Without this, we would load cus-edit recursively.
597 ;; We are still loading it when we call this,
598 ;; and it is not in load-history yet.
599 ((equal load
"cus-edit"))
600 (t (condition-case nil
(load load
) (error nil
))))))))
602 (defvar custom-known-themes
'(user standard
)
603 "Themes that have been defined with `deftheme'.
604 The default value is the list (user standard). The theme `standard'
605 contains the settings before custom themes are applied. The
606 theme `user' contains all the settings the user customized and saved.
607 Additional themes declared with the `deftheme' macro will be added to
608 the front of this list.")
610 (defsubst custom-theme-p
(theme)
611 "Non-nil when THEME has been defined."
612 (memq theme custom-known-themes
))
614 (defsubst custom-check-theme
(theme)
615 "Check whether THEME is valid, and signal an error if it is not."
616 (unless (custom-theme-p theme
)
617 (error "Unknown theme `%s'" theme
)))
621 (defun custom-push-theme (prop symbol theme mode value
)
622 "Record a value for face or variable SYMBOL in custom theme THEME.
623 PROP is`theme-face' for a face, `theme-value' for a variable.
624 The value is specified by (THEME MODE VALUE), which is interpreted
625 by `custom-theme-value'.
627 MODE can be either the symbol `set' or the symbol `reset'. If it is the
628 symbol `set', then VALUE is the value to use. If it is the symbol
629 `reset', then VALUE is either another theme, which means to use the
630 value defined by that theme; or nil, which means to remove SYMBOL from
633 In the following example, the variable `goto-address-url-face' has been
634 set by three different themes. Its `theme-value' property is:
636 \((subtle-hacker reset gnome2)
637 \(jonadab set underline)
638 \(gnome2 set info-xref)
640 The theme value defined by `subtle-hacker' is in effect, because
641 that theme currently has the highest precedence. The theme
642 `subtle-hacker' says to use the same value for the variable as
643 the theme `gnome2'. Therefore, the theme value of the variable
644 is `info-xref'. To change the precedence of the themes, use
647 The user has not customized the variable; had he done that, the
648 list would contain an entry for the `user' theme, too.
650 See `custom-known-themes' for a list of known themes."
651 (unless (or (eq prop
'theme-value
)
652 (eq prop
'theme-face
))
653 (error "Unknown theme property"))
654 (let* ((old (get symbol prop
))
655 (setting (assq theme old
))
656 (theme-settings (get theme
'theme-settings
)))
657 (if (and (eq mode
'reset
) (null value
))
661 (dolist (theme-setting theme-settings
)
662 (if (and (eq (car theme-setting
) prop
)
663 (eq (cadr theme-setting
) symbol
))
664 (setq res theme-setting
)))
665 (put theme
'theme-settings
(delq res theme-settings
)))
666 (put symbol prop
(delq setting old
)))
668 ;; Alter an existing setting.
670 (dolist (theme-setting theme-settings
)
671 (if (and (eq (car theme-setting
) prop
)
672 (eq (cadr theme-setting
) symbol
))
673 (setq res theme-setting
)))
674 (put theme
'theme-settings
675 (cons (list prop symbol theme mode value
)
676 (delq res theme-settings
)))
677 (setcar (cdr setting
) mode
)
678 (setcar (cddr setting
) value
))
679 ;; Add a new setting.
680 ;; If the user changed the value outside of Customize, we
681 ;; first save the current value to a fake theme, `standard'.
682 ;; This ensures that the user-set value comes back if the
683 ;; theme is later disabled.
685 (if (and (eq prop
'theme-value
)
687 (or (null (get symbol
'standard-value
))
688 (not (equal (eval (car (get symbol
'standard-value
)))
689 (symbol-value symbol
)))))
690 (setq old
(list (list 'standard
'set
(symbol-value symbol
))))
692 (setq old
(list (list 'standard
'set
(list
693 (append '(t) (custom-face-attributes-get symbol nil
)))))))))
694 (put symbol prop
(cons (list theme mode value
) old
))
695 (put theme
'theme-settings
696 (cons (list prop symbol theme mode value
)
699 (defvar custom-local-buffer nil
700 "Non-nil, in a Customization buffer, means customize a specific buffer.
701 If this variable is non-nil, it should be a buffer,
702 and it means customize the local bindings of that buffer.
703 This variable is a permanent local, and it normally has a local binding
704 in every Customization buffer.")
705 (put 'custom-local-buffer
'permanent-local t
)
707 (defun custom-set-variables (&rest args
)
708 "Install user customizations of variable values specified in ARGS.
709 These settings are registered as theme `user'.
710 The arguments should each be a list of the form:
712 (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
714 This stores EXP (without evaluating it) as the saved value for SYMBOL.
715 If NOW is present and non-nil, then also evaluate EXP and set
716 the default value for the SYMBOL to the value of EXP.
718 REQUEST is a list of features we must require in order to
719 handle SYMBOL properly.
720 COMMENT is a comment string about SYMBOL."
721 (apply 'custom-theme-set-variables
'user args
))
723 (defun custom-reevaluate-setting (symbol)
724 "Reset the value of SYMBOL by re-evaluating its saved or standard value.
725 Use the :set function to do so. This is useful for customizable options
726 that are defined before their standard value can really be computed.
727 E.g. dumped variables whose default depends on run-time information."
728 (funcall (or (get symbol
'custom-set
) 'set-default
)
730 (eval (car (or (get symbol
'saved-value
) (get symbol
'standard-value
))))))
732 (defun custom-theme-set-variables (theme &rest args
)
733 "Initialize variables for theme THEME according to settings in ARGS.
734 Each of the arguments in ARGS should be a list of this form:
736 (SYMBOL EXP [NOW [REQUEST [COMMENT]]])
738 This stores EXP (without evaluating it) as the saved value for SYMBOL.
739 If NOW is present and non-nil, then also evaluate EXP and set
740 the default value for the SYMBOL to the value of EXP.
742 REQUEST is a list of features we must require in order to
743 handle SYMBOL properly.
744 COMMENT is a comment string about SYMBOL.
746 Several properties of THEME and SYMBOL are used in the process:
748 If THEME's property `theme-immediate' is non-nil, this is equivalent of
749 providing the NOW argument to all symbols in the argument list:
750 evaluate each EXP and set the corresponding SYMBOL. However,
751 there's a difference in the handling of SYMBOL's property
752 `force-value': if NOW is non-nil, SYMBOL's property `force-value' is set to
753 the symbol `rogue', else if THEME's property `theme-immediate' is non-nil,
754 SYMBOL's property `force-value' is set to the symbol `immediate'.
756 EXP itself is saved unevaluated as SYMBOL property `saved-value' and
757 in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
758 (custom-check-theme theme
)
762 (let* ((sym1 (car a1
))
764 (1-then-2 (memq sym1
(get sym2
'custom-dependencies
)))
765 (2-then-1 (memq sym2
(get sym1
'custom-dependencies
))))
766 (cond ((and 1-then-2
2-then-1
)
767 (error "Circular custom dependency between `%s' and `%s'"
770 ;; Put minor modes and symbols with :require last.
771 ;; Putting minor modes last ensures that the mode
772 ;; function will see other customized values rather
773 ;; than default values.
775 (eq (get sym2
'custom-set
)
776 'custom-set-minor-mode
))))))))
778 (let ((entry (car args
)))
780 (let* ((symbol (indirect-variable (nth 0 entry
)))
781 (value (nth 1 entry
))
783 (requests (nth 3 entry
))
784 (comment (nth 4 entry
))
787 (put symbol
'custom-requests requests
)
788 (mapc 'require requests
))
789 (setq set
(or (get symbol
'custom-set
) 'custom-set-default
))
790 (put symbol
'saved-value
(list value
))
791 (put symbol
'saved-variable-comment comment
)
792 (custom-push-theme 'theme-value symbol theme
'set value
)
793 ;; Allow for errors in the case where the setter has
794 ;; changed between versions, say, but let the user know.
797 ;; Rogue variable, set it now.
798 (put symbol
'force-value t
)
799 (funcall set symbol
(eval value
)))
800 ((default-boundp symbol
)
801 ;; Something already set this, overwrite it.
802 (funcall set symbol
(eval value
))))
804 (message "Error setting %s: %s" symbol data
)))
805 (setq args
(cdr args
))
806 (and (or now
(default-boundp symbol
))
807 (put symbol
'variable-comment comment
)))
808 ;; Old format, a plist of SYMBOL VALUE pairs.
809 (message "Warning: old format `custom-set-variables'")
812 (let ((symbol (indirect-variable (nth 0 args
)))
813 (value (nth 1 args
)))
814 (put symbol
'saved-value
(list value
))
815 (custom-push-theme 'theme-value symbol theme
'set value
))
816 (setq args
(cdr (cdr args
)))))))
818 (defun custom-set-default (variable value
)
819 "Default :set function for a customizable variable.
820 Normally, this sets the default value of VARIABLE to VALUE,
821 but if `custom-local-buffer' is non-nil,
822 this sets the local binding in that buffer instead."
823 (if custom-local-buffer
824 (with-current-buffer custom-local-buffer
825 (set variable value
))
826 (set-default variable value
)))
828 (defun custom-set-minor-mode (variable value
)
829 ":set function for minor mode variables.
830 Normally, this sets the default value of VARIABLE to nil if VALUE
831 is nil and to t otherwise,
832 but if `custom-local-buffer' is non-nil,
833 this sets the local binding in that buffer instead."
834 (if custom-local-buffer
835 (with-current-buffer custom-local-buffer
836 (funcall variable
(if value
1 0)))
837 (funcall variable
(if value
1 0))))
839 (defun custom-quote (sexp)
840 "Quote SEXP iff it is not self quoting."
841 (if (or (memq sexp
'(t nil
))
844 (memq (car sexp
) '(lambda)))
848 ;;; (and (fboundp 'characterp)
849 ;;; (characterp sexp))
854 (defun customize-mark-to-save (symbol)
855 "Mark SYMBOL for later saving.
857 If the default value of SYMBOL is different from the standard value,
858 set the `saved-value' property to a list whose car evaluates to the
859 default value. Otherwise, set it to nil.
861 To actually save the value, call `custom-save-all'.
863 Return non-nil iff the `saved-value' property actually changed."
864 (let* ((get (or (get symbol
'custom-get
) 'default-value
))
865 (value (funcall get symbol
))
866 (saved (get symbol
'saved-value
))
867 (standard (get symbol
'standard-value
))
868 (comment (get symbol
'customized-variable-comment
)))
869 ;; Save default value iff different from standard value.
870 (if (or (null standard
)
871 (not (equal value
(condition-case nil
872 (eval (car standard
))
874 (put symbol
'saved-value
(list (custom-quote value
)))
875 (put symbol
'saved-value nil
))
876 ;; Clear customized information (set, but not saved).
877 (put symbol
'customized-value nil
)
878 ;; Save any comment that might have been set.
880 (put symbol
'saved-variable-comment comment
))
881 (not (equal saved
(get symbol
'saved-value
)))))
883 (defun customize-mark-as-set (symbol)
884 "Mark current value of SYMBOL as being set from customize.
886 If the default value of SYMBOL is different from the saved value if any,
887 or else if it is different from the standard value, set the
888 `customized-value' property to a list whose car evaluates to the
889 default value. Otherwise, set it to nil.
891 Return non-nil iff the `customized-value' property actually changed."
892 (let* ((get (or (get symbol
'custom-get
) 'default-value
))
893 (value (funcall get symbol
))
894 (customized (get symbol
'customized-value
))
895 (old (or (get symbol
'saved-value
) (get symbol
'standard-value
))))
896 ;; Mark default value as set iff different from old value.
898 (not (equal value
(condition-case nil
901 (put symbol
'customized-value
(list (custom-quote value
)))
902 (put symbol
'customized-value nil
))
904 (not (equal customized
(get symbol
'customized-value
)))))
908 ;; deftheme is used at the beginning of the file that records a theme.
910 (defmacro deftheme
(theme &optional doc
&rest args
)
911 "Declare custom theme THEME.
912 The optional argument DOC is a doc string describing the theme.
913 The remaining arguments should have the form
917 The following KEYWORD's are defined:
920 VALUE is a short (one line) description of the theme. If not
923 If VALUE is non-nil, variables specified in this theme are set
924 immediately when loading the theme.
926 VALUE is a string used to indicate that a variable takes its
927 setting from this theme. It is passed to FORMAT with the name
928 of the theme as an additional argument. If not given, a
929 generic description is used.
930 :variable-reset-string
931 VALUE is a string used in the case a variable has been forced
932 to its value in this theme. It is passed to FORMAT with the
933 name of the theme as an additional argument. If not given, a
934 generic description is used.
936 VALUE is a string used to indicate that a face takes its
937 setting from this theme. It is passed to FORMAT with the name
938 of the theme as an additional argument. If not given, a
939 generic description is used.
941 VALUE is a string used in the case a face has been forced to
942 its value in this theme. It is passed to FORMAT with the name
943 of the theme as an additional argument. If not given, a
944 generic description is used.
946 Any theme `foo' should be defined in a file called `foo-theme.el';
947 see `custom-make-theme-feature' for more information."
948 (let ((feature (custom-make-theme-feature theme
)))
949 ;; It is better not to use backquote in this file,
950 ;; because that makes a bootstrapping problem
951 ;; if you need to recompile all the Lisp files using interpreted code.
952 (nconc (list 'custom-declare-theme
954 (list 'quote feature
)
958 (defun custom-declare-theme (theme feature
&optional doc
&rest args
)
959 "Like `deftheme', but THEME is evaluated as a normal argument.
960 FEATURE is the feature this theme provides. This symbol is created
961 from THEME by `custom-make-theme-feature'."
962 (add-to-list 'custom-known-themes theme
)
963 (put theme
'theme-feature feature
)
965 (put theme
'theme-documentation doc
))
967 (let ((arg (car args
)))
968 (setq args
(cdr args
))
969 (unless (symbolp arg
)
970 (error "Junk in args %S" args
))
974 (error "Keyword %s is missing an argument" keyword
))
975 (setq args
(cdr args
))
976 (cond ((eq keyword
:short-description
)
977 (put theme
'theme-short-description value
))
978 ((eq keyword
:immediate
)
979 (put theme
'theme-immediate value
))
980 ((eq keyword
:variable-set-string
)
981 (put theme
'theme-variable-set-string value
))
982 ((eq keyword
:variable-reset-string
)
983 (put theme
'theme-variable-reset-string value
))
984 ((eq keyword
:face-set-string
)
985 (put theme
'theme-face-set-string value
))
986 ((eq keyword
:face-reset-string
)
987 (put theme
'theme-face-reset-string value
)))))))
989 (defun custom-make-theme-feature (theme)
990 "Given a symbol THEME, create a new symbol by appending \"-theme\".
991 Store this symbol in the `theme-feature' property of THEME.
992 Calling `provide-theme' to provide THEME actually puts `THEME-theme'
995 This allows for a file-name convention for autoloading themes:
996 Every theme X has a property `provide-theme' whose value is \"X-theme\".
997 \(load-theme X) then attempts to load the file `X-theme.el'."
998 (intern (concat (symbol-name theme
) "-theme")))
1002 ;; The variable and face settings of a theme are recorded in
1003 ;; the `theme-settings' property of the theme name.
1004 ;; This property's value is a list of elements, each of the form
1005 ;; (PROP SYMBOL THEME MODE VALUE), where PROP is `theme-value' or `theme-face'
1006 ;; and SYMBOL is the face or variable name.
1007 ;; THEME is the theme name itself; that's redundant, but simplifies things.
1008 ;; MODE is `set' or `reset'.
1009 ;; If MODE is `set', then VALUE is an expression that specifies the
1010 ;; theme's setting for SYMBOL.
1011 ;; If MODE is `reset', then VALUE is another theme,
1012 ;; and it means to use the value from that theme.
1014 ;; Each variable has a `theme-value' property that describes all the
1015 ;; settings of enabled themes that apply to it.
1016 ;; Each face name has a `theme-face' property that describes all the
1017 ;; settings of enabled themes that apply to it.
1018 ;; The property value is a list of settings, each with the form
1019 ;; (THEME MODE VALUE). THEME, MODE and VALUE are as above.
1020 ;; Each of these lists is ordered by decreasing theme precedence.
1021 ;; Thus, the first element is always the one that is in effect.
1023 ;; Disabling a theme removes its settings from the `theme-value' and
1024 ;; `theme-face' properties, but the theme's own `theme-settings'
1025 ;; property remains unchanged.
1027 ;; Loading a theme implicitly enables it. Enabling a theme adds its
1028 ;; settings to the symbols' `theme-value' and `theme-face' properties,
1029 ;; or moves them to the front of those lists if they're already present.
1031 (defvar custom-loaded-themes nil
1032 "Custom themes that have been loaded.")
1034 (defcustom custom-theme-directory
1035 (if (eq system-type
'ms-dos
)
1036 ;; MS-DOS cannot have initial dot.
1039 "Directory in which Custom theme files should be written.
1040 `load-theme' searches this directory in addition to load-path.
1041 The command `customize-create-theme' writes the files it produces
1042 into this directory."
1047 (defun custom-theme-loaded-p (theme)
1048 "Return non-nil if THEME has been loaded."
1049 (memq theme custom-loaded-themes
))
1051 (defvar custom-enabled-themes
'(user)
1052 "Custom themes currently enabled, highest precedence first.
1053 The first one is always `user'.")
1055 (defun custom-theme-enabled-p (theme)
1056 "Return non-nil if THEME is enabled."
1057 (memq theme custom-enabled-themes
))
1059 (defun provide-theme (theme)
1060 "Indicate that this file provides THEME.
1061 Add THEME to `custom-loaded-themes', and `provide' whatever
1062 feature name is stored in THEME's property `theme-feature'.
1064 Usually the `theme-feature' property contains a symbol created
1065 by `custom-make-theme-feature'."
1066 (custom-check-theme theme
)
1067 (provide (get theme
'theme-feature
))
1068 (push theme custom-loaded-themes
)
1069 ;; Loading a theme also installs its settings,
1070 ;; so mark it as "enabled".
1071 (push theme custom-enabled-themes
)
1072 ;; `user' must always be the highest-precedence enabled theme.
1073 ;; Make that remain true. (This has the effect of making user settings
1074 ;; override the ones just loaded, too.)
1075 (enable-theme 'user
))
1077 (defun load-theme (theme)
1078 "Try to load a theme's settings from its file.
1079 This also enables the theme; use `disable-theme' to disable it."
1081 ;; THEME's feature is stored in THEME's `theme-feature' property.
1082 ;; Usually the `theme-feature' property contains a symbol created
1083 ;; by `custom-make-theme-feature'.
1085 ;; Note we do no check for validity of the theme here.
1086 ;; This allows to pull in themes by a file-name convention
1087 (interactive "SCustom theme name: ")
1088 (let ((load-path (if (file-directory-p custom-theme-directory
)
1089 (cons custom-theme-directory load-path
)
1091 (require (or (get theme
'theme-feature
)
1092 (custom-make-theme-feature theme
)))))
1094 ;;; How to load and enable various themes as part of `user'.
1096 (defun custom-theme-load-themes (by-theme &rest body
)
1097 "Load the themes specified by BODY.
1098 Record them as required by theme BY-THEME.
1100 BODY is a sequence of either
1103 Load THEME and enable it.
1105 Undo all the settings made by THEME
1107 Load THEME but do not enable it.
1109 All the themes loaded for BY-THEME are recorded in BY-THEME's property
1110 `theme-loads-themes'."
1111 (custom-check-theme by-theme
)
1112 (let ((themes-loaded (get by-theme
'theme-loads-themes
)))
1113 (dolist (theme body
)
1114 (cond ((and (consp theme
) (eq (car theme
) 'reset
))
1115 (disable-theme (cadr theme
)))
1116 ((and (consp theme
) (eq (car theme
) 'hidden
))
1117 (load-theme (cadr theme
))
1118 (disable-theme (cadr theme
)))
1120 (load-theme theme
)))
1121 (push theme themes-loaded
))
1122 (put by-theme
'theme-loads-themes themes-loaded
)))
1124 (defun custom-load-themes (&rest body
)
1125 "Load themes for the USER theme as specified by BODY.
1127 See `custom-theme-load-themes' for more information on BODY."
1128 (apply 'custom-theme-load-themes
'user body
))
1130 ;;; Enabling and disabling loaded themes.
1132 (defun enable-theme (theme)
1133 "Reenable all variable and face settings defined by THEME.
1134 The newly enabled theme gets the highest precedence (after `user').
1135 If it is already enabled, just give it highest precedence (after `user').
1137 This signals an error if THEME does not specify any theme
1138 settings. Theme settings are set using `load-theme'."
1139 (interactive "SEnable Custom theme: ")
1140 (let ((settings (get theme
'theme-settings
)))
1141 (if (and (not (eq theme
'user
)) (null settings
))
1142 (error "No theme settings defined in %s." (symbol-name theme
)))
1143 (dolist (s settings
)
1144 (let* ((prop (car s
))
1146 (spec-list (get symbol prop
)))
1147 (put symbol prop
(cons (cddr s
) (assq-delete-all theme spec-list
)))
1148 (if (eq prop
'theme-value
)
1149 (custom-theme-recalc-variable symbol
)
1151 (custom-theme-recalc-face symbol
))))))
1152 (setq custom-enabled-themes
1153 (cons theme
(delq theme custom-enabled-themes
)))
1154 ;; `user' must always be the highest-precedence enabled theme.
1155 (unless (eq theme
'user
)
1156 (enable-theme 'user
)))
1158 (defun disable-theme (theme)
1159 "Disable all variable and face settings defined by THEME.
1160 See `custom-known-themes' for a list of known themes."
1161 (interactive "SDisable Custom theme: ")
1162 (let ((settings (get theme
'theme-settings
)))
1163 (dolist (s settings
)
1164 (let* ((prop (car s
))
1166 (spec-list (get symbol prop
)))
1167 (put symbol prop
(assq-delete-all theme spec-list
))
1168 (if (eq prop
'theme-value
)
1169 (custom-theme-recalc-variable symbol
)
1170 (custom-theme-recalc-face symbol
)))))
1171 (setq custom-enabled-themes
1172 (delq theme custom-enabled-themes
)))
1174 (defun custom-theme-value (theme setting-list
)
1175 "Determine the value specified for THEME according to SETTING-LIST.
1176 Returns a list whose car is the specified value, if we
1177 find one; nil otherwise.
1179 SETTING-LIST is an alist with themes as its key.
1180 Each element has the form:
1184 MODE is either the symbol `set' or the symbol `reset'. See
1185 `custom-push-theme' for more information on the format of
1187 ;; Note we do _NOT_ signal an error if the theme is unknown
1188 ;; it might have gone away without the user knowing.
1189 (let ((elt (cdr (assoc theme setting-list
))))
1191 (if (eq (car elt
) 'set
)
1193 ;; `reset' means refer to another theme's value in the same alist.
1194 (custom-theme-value (cadr elt
) setting-list
)))))
1196 (defun custom-variable-theme-value (variable)
1197 "Return (list VALUE) indicating the custom theme value of VARIABLE.
1198 That is to say, it specifies what the value should be according to
1199 currently enabled custom themes.
1201 This function returns nil if no custom theme specifies a value for VARIABLE."
1202 (let* ((theme-value (get variable
'theme-value
)))
1204 (custom-theme-value (car (car theme-value
)) theme-value
))))
1206 (defun custom-theme-recalc-variable (variable)
1207 "Set VARIABLE according to currently enabled custom themes."
1208 (let ((valspec (custom-variable-theme-value variable
)))
1210 (put variable
'saved-value valspec
))
1212 (setq valspec
(get variable
'standard-value
)))
1214 (if (or (get 'force-value variable
) (default-boundp variable
))
1215 (funcall (or (get variable
'custom-set
) 'set-default
) variable
1216 (eval (car valspec
)))))))
1218 (defun custom-theme-recalc-face (face)
1219 "Set FACE according to currently enabled custom themes."
1220 (let ((theme-faces (reverse (get face
'theme-face
))))
1221 (dolist (spec theme-faces
)
1222 (face-spec-set face
(car (cddr spec
))))))
1224 (defun custom-theme-reset-variables (theme &rest args
)
1225 "Reset the specs in THEME of some variables to their values in other themes.
1226 Each of the arguments ARGS has this form:
1228 (VARIABLE FROM-THEME)
1230 This means reset VARIABLE to its value in FROM-THEME."
1231 (custom-check-theme theme
)
1233 (custom-push-theme 'theme-value
(car arg
) theme
'reset
(cadr arg
))))
1235 (defun custom-reset-variables (&rest args
)
1236 "Reset the specs of some variables to their values in certain themes.
1237 This creates settings in the `user' theme.
1239 Each of the arguments ARGS has this form:
1241 (VARIABLE FROM-THEME)
1243 This means reset VARIABLE to its value in FROM-THEME."
1244 (apply 'custom-theme-reset-variables
'user args
))
1248 ;; Process the defcustoms for variables loaded before this file.
1249 (while custom-declare-variable-list
1250 (apply 'custom-declare-variable
(car custom-declare-variable-list
))
1251 (setq custom-declare-variable-list
(cdr custom-declare-variable-list
)))
1255 ;; arch-tag: 041b6116-aabe-4f9a-902d-74092bc3dab2
1256 ;;; custom.el ends here