;;; custom.el --- tools for declaring and initializing options
;;
;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004,
-;; 2005 Free Software Foundation, Inc.
+;; 2005, 2006 Free Software Foundation, Inc.
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Maintainer: FSF
:type VALUE should be a widget type for editing the symbol's value.
:options VALUE should be a list of valid members of the widget type.
+:initialize
+ VALUE should be a function used to initialize the
+ variable. It takes two arguments, the symbol and value
+ given in the `defcustom' call. The default is
+ `custom-initialize-reset'.
+:set VALUE should be a function to set the value of the symbol.
+ It takes two arguments, the symbol to set and the value to
+ give it. The default choice of function is `custom-set-default'.
+:get VALUE should be a function to extract the value of symbol.
+ The function takes one argument, a symbol, and should return
+ the current value for that symbol. The default choice of function
+ is `custom-default-value'.
+:require
+ VALUE should be a feature symbol. If you save a value
+ for this option, then when your `.emacs' file loads the value,
+ it does (require VALUE) first.
+
+The following common keywords are also meaningful.
+
:group VALUE should be a customization group.
- Add SYMBOL to that group.
+ Add SYMBOL (or FACE with `defface') to that group.
:link LINK-DATA
Include an external link after the documentation string for this
item. This is a sentence containing an active field which
An item can have more than one external link; however, most items
have none at all.
-:initialize
- VALUE should be a function used to initialize the
- variable. It takes two arguments, the symbol and value
- given in the `defcustom' call. The default is
- `custom-initialize-reset'.
-:set VALUE should be a function to set the value of the symbol.
- It takes two arguments, the symbol to set and the value to
- give it. The default choice of function is `custom-set-default'.
-:get VALUE should be a function to extract the value of symbol.
- The function takes one argument, a symbol, and should return
- the current value for that symbol. The default choice of function
- is `custom-default-value'.
-:require
- VALUE should be a feature symbol. If you save a value
- for this option, then when your `.emacs' file loads the value,
- it does (require VALUE) first.
:version
VALUE should be a string specifying that the variable was
first introduced, or its default value was changed, in Emacs
version VERSION.
+:package-version
+ VALUE should be a list with the form (PACKAGE . VERSION)
+ 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'.
+ 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.
:tag LABEL
Use LABEL, a string, instead of the item's name, to label the item
in customization menus and buffers.
_outside_ any bindings for these variables. \(`defvar' and
`defconst' behave similarly in this respect.)
-Read the section about customization in the Emacs Lisp manual for more
-information."
+See Info node `(elisp) Customization' in the Emacs Lisp manual
+for more information."
(declare (doc-string 3))
;; It is better not to use backquote in this file,
;; because that makes a bootstrapping problem
[KEYWORD VALUE]...
-The following KEYWORDs are defined:
-
-:group VALUE should be a customization group.
- Add FACE to that group.
+For a list of valid keywords, see the common keywords listed in
+`defcustom'.
SPEC should be an alist of the form ((DISPLAY ATTS)...).
the function `display-supports-face-attributes-p' for more
information on exactly how testing is done.
-Read the section about customization in the Emacs Lisp manual for more
-information."
+See Info node `(elisp) Customization' in the Emacs Lisp manual
+for more information."
(declare (doc-string 3))
;; It is better not to use backquote in this file,
;; because that makes a bootstrapping problem
[KEYWORD VALUE]...
-The following KEYWORDs are defined:
-
-:group VALUE should be a customization group.
- Add SYMBOL to that group.
+For a list of valid keywords, see the common keywords listed in
+`defcustom'.
-:version VALUE should be a string specifying that the group was introduced
- in Emacs version VERSION.
-
-Read the section about customization in the Emacs Lisp manual for more
-information."
+See Info node `(elisp) Customization' in the Emacs Lisp manual
+for more information."
(declare (doc-string 3))
;; It is better not to use backquote in this file,
;; because that makes a bootstrapping problem
(custom-add-to-group value symbol type))
((eq keyword :version)
(custom-add-version symbol value))
+ ((eq keyword :package-version)
+ (custom-add-package-version symbol value))
((eq keyword :link)
(custom-add-link symbol value))
((eq keyword :load)
"To the custom option SYMBOL add the version VERSION."
(put symbol 'custom-version (purecopy version)))
+(defun custom-add-package-version (symbol version)
+ "To the custom option SYMBOL add the package version VERSION."
+ (put symbol 'custom-package-version (purecopy version)))
+
(defun custom-add-load (symbol load)
"To the custom option SYMBOL add the dependency LOAD.
LOAD should be either a library file name, or a feature name."
((equal load "cus-edit"))
(t (condition-case nil (load load) (error nil))))))))
\f
-(defvar custom-known-themes '(user standard)
+(defvar custom-local-buffer nil
+ "Non-nil, in a Customization buffer, means customize a specific buffer.
+If this variable is non-nil, it should be a buffer,
+and it means customize the local bindings of that buffer.
+This variable is a permanent local, and it normally has a local binding
+in every Customization buffer.")
+(put 'custom-local-buffer 'permanent-local t)
+
+(defun custom-set-default (variable value)
+ "Default :set function for a customizable variable.
+Normally, this sets the default value of VARIABLE to VALUE,
+but if `custom-local-buffer' is non-nil,
+this sets the local binding in that buffer instead."
+ (if custom-local-buffer
+ (with-current-buffer custom-local-buffer
+ (set variable value))
+ (set-default variable value)))
+
+(defun custom-set-minor-mode (variable value)
+ ":set function for minor mode variables.
+Normally, this sets the default value of VARIABLE to nil if VALUE
+is nil and to t otherwise,
+but if `custom-local-buffer' is non-nil,
+this sets the local binding in that buffer instead."
+ (if custom-local-buffer
+ (with-current-buffer custom-local-buffer
+ (funcall variable (if value 1 0)))
+ (funcall variable (if value 1 0))))
+
+(defun custom-quote (sexp)
+ "Quote SEXP iff it is not self quoting."
+ (if (or (memq sexp '(t nil))
+ (keywordp sexp)
+ (and (listp sexp)
+ (memq (car sexp) '(lambda)))
+ (stringp sexp)
+ (numberp sexp)
+ (vectorp sexp)
+;;; (and (fboundp 'characterp)
+;;; (characterp sexp))
+ )
+ sexp
+ (list 'quote sexp)))
+
+(defun customize-mark-to-save (symbol)
+ "Mark SYMBOL for later saving.
+
+If the default value of SYMBOL is different from the standard value,
+set the `saved-value' property to a list whose car evaluates to the
+default value. Otherwise, set it to nil.
+
+To actually save the value, call `custom-save-all'.
+
+Return non-nil iff the `saved-value' property actually changed."
+ (custom-load-symbol symbol)
+ (let* ((get (or (get symbol 'custom-get) 'default-value))
+ (value (funcall get symbol))
+ (saved (get symbol 'saved-value))
+ (standard (get symbol 'standard-value))
+ (comment (get symbol 'customized-variable-comment)))
+ ;; Save default value iff different from standard value.
+ (if (or (null standard)
+ (not (equal value (condition-case nil
+ (eval (car standard))
+ (error nil)))))
+ (put symbol 'saved-value (list (custom-quote value)))
+ (put symbol 'saved-value nil))
+ ;; Clear customized information (set, but not saved).
+ (put symbol 'customized-value nil)
+ ;; Save any comment that might have been set.
+ (when comment
+ (put symbol 'saved-variable-comment comment))
+ (not (equal saved (get symbol 'saved-value)))))
+
+(defun customize-mark-as-set (symbol)
+ "Mark current value of SYMBOL as being set from customize.
+
+If the default value of SYMBOL is different from the saved value if any,
+or else if it is different from the standard value, set the
+`customized-value' property to a list whose car evaluates to the
+default value. Otherwise, set it to nil.
+
+Return non-nil iff the `customized-value' property actually changed."
+ (custom-load-symbol symbol)
+ (let* ((get (or (get symbol 'custom-get) 'default-value))
+ (value (funcall get symbol))
+ (customized (get symbol 'customized-value))
+ (old (or (get symbol 'saved-value) (get symbol 'standard-value))))
+ ;; Mark default value as set iff different from old value.
+ (if (or (null old)
+ (not (equal value (condition-case nil
+ (eval (car old))
+ (error nil)))))
+ (progn (put symbol 'customized-value (list (custom-quote value)))
+ (custom-push-theme 'theme-value symbol 'user 'set
+ (custom-quote value)))
+ (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))))))
+
+\f
+;;; 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)
"Themes that have been defined with `deftheme'.
-The default value is the list (user standard). The theme `standard'
+The default value is the list (user changed). The theme `changed'
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
(unless (custom-theme-p theme)
(error "Unknown theme `%s'" theme)))
-;;; Initializing.
-
-(defun custom-push-theme (prop symbol theme mode value)
- "Record a value for face or variable SYMBOL in custom theme THEME.
-PROP is`theme-face' for a face, `theme-value' for a variable.
-The value is specified by (THEME MODE VALUE), which is interpreted
-by `custom-theme-value'.
+(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.
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
-`reset', then VALUE is either another theme, which means to use the
-value defined by that theme; or nil, which means to remove SYMBOL from
-THEME entirely.
-
-In the following example, the variable `goto-address-url-face' has been
-set by three different themes. Its `theme-value' property is:
-
- \((subtle-hacker reset gnome2)
- \(jonadab set underline)
- \(gnome2 set info-xref)
-
-The theme value defined by `subtle-hacker' is in effect, because
-that theme currently has the highest precedence. The theme
-`subtle-hacker' says to use the same value for the variable as
-the theme `gnome2'. Therefore, the theme value of the variable
-is `info-xref'. To change the precedence of the themes, use
-`enable-theme'.
-
-The user has not customized the variable; had he done that, the
-list would contain an entry for the `user' theme, too.
+`reset', then SYMBOL will be removed from THEME (VALUE is ignored).
See `custom-known-themes' for a list of known themes."
(unless (memq prop '(theme-value theme-face))
(error "Unknown theme property"))
(let* ((old (get symbol prop))
- (setting (assq theme old))
- (theme-settings (get theme 'theme-settings)))
- (if (and (eq mode 'reset) (null value))
+ (setting (assq theme old)) ; '(theme value)
+ (theme-settings ; '(prop symbol theme value)
+ (get theme 'theme-settings)))
+ (if (eq mode 'reset)
;; Remove a setting.
(when setting
(let (res)
(eq (cadr theme-setting) symbol))
(setq res theme-setting)))
(put theme 'theme-settings
- (cons (list prop symbol theme mode value)
+ (cons (list prop symbol theme value)
(delq res theme-settings)))
- (setcar (cdr setting) mode)
- (setcar (cddr setting) value))
+ (setcar (cdr setting) value))
;; Add a new setting.
;; If the user changed the value outside of Customize, we
- ;; first save the current value to a fake theme, `standard'.
+ ;; first save the current value to a fake theme, `changed'.
;; This ensures that the user-set value comes back if the
;; theme is later disabled.
(if (null old)
(or (null (get symbol 'standard-value))
(not (equal (eval (car (get symbol 'standard-value)))
(symbol-value symbol)))))
- (setq old (list (list 'standard 'set (symbol-value symbol))))
- (if (facep symbol)
- (setq old (list (list 'standard 'set (list
+ (setq old (list (list 'changed (symbol-value symbol))))
+ (if (and (facep symbol)
+ (not (face-spec-match-p symbol (get symbol 'face-defface-spec))))
+ (setq old (list (list 'changed (list
(append '(t) (custom-face-attributes-get symbol nil)))))))))
- (put symbol prop (cons (list theme mode value) old))
+ (put symbol prop (cons (list theme value) old))
(put theme 'theme-settings
- (cons (list prop symbol theme mode value)
+ (cons (list prop symbol theme value)
theme-settings))))))
-\f
-(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)
+\f
(defun custom-set-variables (&rest args)
"Install user customizations of variable values specified in ARGS.
These settings are registered as theme `user'.
COMMENT is a comment string about SYMBOL."
(apply 'custom-theme-set-variables 'user args))
-(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))))))
-
(defun custom-theme-set-variables (theme &rest args)
"Initialize variables for theme THEME according to settings in ARGS.
Each of the arguments in ARGS should be a list of this form:
handle SYMBOL properly.
COMMENT is a comment string about SYMBOL.
-Several properties of THEME and SYMBOL are used in the process:
-
-If THEME's property `theme-immediate' is non-nil, this is equivalent of
-providing the NOW argument to all symbols in the argument list:
-evaluate each EXP and set the corresponding SYMBOL. However,
-there's a difference in the handling of SYMBOL's property
-`force-value': if NOW is non-nil, SYMBOL's property `force-value' is set to
-the symbol `rogue', else if THEME's property `theme-immediate' is non-nil,
-SYMBOL's property `force-value' is set to the symbol `immediate'.
-
EXP itself is saved unevaluated as SYMBOL property `saved-value' and
in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
(custom-check-theme theme)
(custom-push-theme 'theme-value symbol theme 'set value))
(setq args (cdr (cdr args)))))))
-(defun custom-set-default (variable value)
- "Default :set function for a customizable variable.
-Normally, this sets the default value of VARIABLE to VALUE,
-but if `custom-local-buffer' is non-nil,
-this sets the local binding in that buffer instead."
- (if custom-local-buffer
- (with-current-buffer custom-local-buffer
- (set variable value))
- (set-default variable value)))
-
-(defun custom-set-minor-mode (variable value)
- ":set function for minor mode variables.
-Normally, this sets the default value of VARIABLE to nil if VALUE
-is nil and to t otherwise,
-but if `custom-local-buffer' is non-nil,
-this sets the local binding in that buffer instead."
- (if custom-local-buffer
- (with-current-buffer custom-local-buffer
- (funcall variable (if value 1 0)))
- (funcall variable (if value 1 0))))
-
-(defun custom-quote (sexp)
- "Quote SEXP iff it is not self quoting."
- (if (or (memq sexp '(t nil))
- (keywordp sexp)
- (and (listp sexp)
- (memq (car sexp) '(lambda)))
- (stringp sexp)
- (numberp sexp)
- (vectorp sexp)
-;;; (and (fboundp 'characterp)
-;;; (characterp sexp))
- )
- sexp
- (list 'quote sexp)))
-
-(defun customize-mark-to-save (symbol)
- "Mark SYMBOL for later saving.
-
-If the default value of SYMBOL is different from the standard value,
-set the `saved-value' property to a list whose car evaluates to the
-default value. Otherwise, set it to nil.
-
-To actually save the value, call `custom-save-all'.
-
-Return non-nil iff the `saved-value' property actually changed."
- (let* ((get (or (get symbol 'custom-get) 'default-value))
- (value (funcall get symbol))
- (saved (get symbol 'saved-value))
- (standard (get symbol 'standard-value))
- (comment (get symbol 'customized-variable-comment)))
- ;; Save default value iff different from standard value.
- (if (or (null standard)
- (not (equal value (condition-case nil
- (eval (car standard))
- (error nil)))))
- (put symbol 'saved-value (list (custom-quote value)))
- (put symbol 'saved-value nil))
- ;; Clear customized information (set, but not saved).
- (put symbol 'customized-value nil)
- ;; Save any comment that might have been set.
- (when comment
- (put symbol 'saved-variable-comment comment))
- (not (equal saved (get symbol 'saved-value)))))
-
-(defun customize-mark-as-set (symbol)
- "Mark current value of SYMBOL as being set from customize.
-
-If the default value of SYMBOL is different from the saved value if any,
-or else if it is different from the standard value, set the
-`customized-value' property to a list whose car evaluates to the
-default value. Otherwise, set it to nil.
-
-Return non-nil iff the `customized-value' property actually changed."
- (let* ((get (or (get symbol 'custom-get) 'default-value))
- (value (funcall get symbol))
- (customized (get symbol 'customized-value))
- (old (or (get symbol 'saved-value) (get symbol 'standard-value))))
- ;; Mark default value as set iff different from old value.
- (if (or (null old)
- (not (equal value (condition-case nil
- (eval (car old))
- (error nil)))))
- (put symbol 'customized-value (list (custom-quote value)))
- (put symbol 'customized-value nil))
- ;; Changed?
- (not (equal customized (get symbol 'customized-value)))))
\f
;;; Defining themes.
-;; deftheme is used at the beginning of the file that records a theme.
+;; A theme file should be named `THEME-theme.el' (where THEME is the theme
+;; name), and found in either `custom-theme-directory' or the load path.
+;; It has the following format:
+;;
+;; (deftheme THEME
+;; DOCSTRING)
+;;
+;; (custom-theme-set-variables
+;; 'THEME
+;; [THEME-VARIABLES])
+;;
+;; (custom-theme-set-faces
+;; 'THEME
+;; [THEME-FACES])
+;;
+;; (provide-theme 'THEME)
-(defmacro deftheme (theme &optional doc &rest args)
- "Declare custom theme THEME.
-The optional argument DOC is a doc string describing the theme.
-The remaining arguments should have the form
- [KEYWORD VALUE]...
+;; 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.
-The following KEYWORD's are defined:
-
-:short-description
- VALUE is a short (one line) description of the theme. If not
- given, DOC is used.
-:immediate
- If VALUE is non-nil, variables specified in this theme are set
- immediately when loading the theme.
-:variable-set-string
- VALUE is a string used to indicate that a variable takes its
- setting from this theme. It is passed to FORMAT with the name
- of the theme as an additional argument. If not given, a
- generic description is used.
-:variable-reset-string
- VALUE is a string used in the case a variable has been forced
- to its value in this theme. It is passed to FORMAT with the
- name of the theme as an additional argument. If not given, a
- generic description is used.
-:face-set-string
- VALUE is a string used to indicate that a face takes its
- setting from this theme. It is passed to FORMAT with the name
- of the theme as an additional argument. If not given, a
- generic description is used.
-:face-reset-string
- VALUE is a string used in the case a face has been forced to
- its value in this theme. It is passed to FORMAT with the name
- of the theme as an additional argument. If not given, a
- generic description is used.
+(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.
Any theme `foo' should be defined in a file called `foo-theme.el';
see `custom-make-theme-feature' for more information."
;; It is better not to use backquote in this file,
;; because that makes a bootstrapping problem
;; if you need to recompile all the Lisp files using interpreted code.
- (nconc (list 'custom-declare-theme
- (list 'quote theme)
- (list 'quote feature)
- doc)
- args)))
+ (list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc)))
-(defun custom-declare-theme (theme feature &optional doc &rest args)
+(defun custom-declare-theme (theme feature &optional doc &rest ignored)
"Like `deftheme', but THEME is evaluated as a normal argument.
-FEATURE is the feature this theme provides. This symbol is created
-from THEME by `custom-make-theme-feature'."
+FEATURE is the feature this theme provides. Normally, this is a symbol
+created from THEME by `custom-make-theme-feature'."
+ (if (memq theme '(user changed))
+ (error "Custom theme cannot be named %S" theme))
(add-to-list 'custom-known-themes theme)
(put theme 'theme-feature feature)
- (when doc
- (put theme 'theme-documentation doc))
- (while args
- (let ((arg (car args)))
- (setq args (cdr args))
- (unless (symbolp arg)
- (error "Junk in args %S" args))
- (let ((keyword arg)
- (value (car args)))
- (unless args
- (error "Keyword %s is missing an argument" keyword))
- (setq args (cdr args))
- (cond ((eq keyword :short-description)
- (put theme 'theme-short-description value))
- ((eq keyword :immediate)
- (put theme 'theme-immediate value))
- ((eq keyword :variable-set-string)
- (put theme 'theme-variable-set-string value))
- ((eq keyword :variable-reset-string)
- (put theme 'theme-variable-reset-string value))
- ((eq keyword :face-set-string)
- (put theme 'theme-face-set-string value))
- ((eq keyword :face-reset-string)
- (put theme 'theme-face-reset-string value)))))))
+ (when doc (put theme 'theme-documentation doc)))
(defun custom-make-theme-feature (theme)
"Given a symbol THEME, create a new symbol by appending \"-theme\".
\f
;;; Loading themes.
-;; The variable and face settings of a theme are recorded in
-;; the `theme-settings' property of the theme name.
-;; This property's value is a list of elements, each of the form
-;; (PROP SYMBOL THEME MODE VALUE), where PROP is `theme-value' or `theme-face'
-;; and SYMBOL is the face or variable name.
-;; THEME is the theme name itself; that's redundant, but simplifies things.
-;; MODE is `set' or `reset'.
-;; If MODE is `set', then VALUE is an expression that specifies the
-;; theme's setting for SYMBOL.
-;; If MODE is `reset', then VALUE is another theme,
-;; and it means to use the value from that theme.
-
-;; Each variable has a `theme-value' property that describes all the
-;; settings of enabled themes that apply to it.
-;; Each face name has a `theme-face' property that describes all the
-;; settings of enabled themes that apply to it.
-;; The property value is a list of settings, each with the form
-;; (THEME MODE VALUE). THEME, MODE and VALUE are as above.
-;; Each of these lists is ordered by decreasing theme precedence.
-;; Thus, the first element is always the one that is in effect.
-
-;; Disabling a theme removes its settings from the `theme-value' and
-;; `theme-face' properties, but the theme's own `theme-settings'
-;; property remains unchanged.
-
-;; Loading a theme implicitly enables it. Enabling a theme adds its
-;; settings to the symbols' `theme-value' and `theme-face' properties,
-;; or moves them to the front of those lists if they're already present.
-
-(defvar custom-loaded-themes nil
- "Custom themes that have been loaded.")
-
(defcustom custom-theme-directory
(if (eq system-type 'ms-dos)
;; MS-DOS cannot have initial dot.
:group 'customize
:version "22.1")
-(defun custom-theme-loaded-p (theme)
- "Return non-nil if THEME has been loaded."
- (memq theme custom-loaded-themes))
-
(defun provide-theme (theme)
- "Indicate that this file provides THEME, and mark it as enabled.
-Add THEME to `custom-loaded-themes' and `custom-enabled-themes',
-and `provide' the feature name stored in THEME's property `theme-feature'.
-
-Usually the `theme-feature' property contains a symbol created
-by `custom-make-theme-feature'."
- (if (eq theme 'user)
- (error "Custom theme cannot be named `user'"))
+ "Indicate that this file provides THEME.
+This calls `provide' to provide the feature name stored in THEME's
+property `theme-feature' (which is usually a symbol created by
+`custom-make-theme-feature')."
+ (if (memq theme '(user changed))
+ (error "Custom theme cannot be named %S" theme))
(custom-check-theme theme)
(provide (get theme 'theme-feature))
- (push theme custom-loaded-themes)
- ;; Loading a theme also installs its settings,
- ;; so mark it as "enabled".
+ ;; Loading a theme also enables it.
(push theme custom-enabled-themes)
;; `user' must always be the highest-precedence enabled theme.
;; Make that remain true. (This has the effect of making user settings
;; override the ones just loaded, too.)
- (enable-theme 'user))
+ (let ((custom-enabling-themes t))
+ (enable-theme 'user)))
(defun load-theme (theme)
- "Try to load a theme's settings from its file.
+ "Load a theme's settings from its file.
This also enables the theme; use `disable-theme' to disable it."
-
- ;; THEME's feature is stored in THEME's `theme-feature' property.
- ;; Usually the `theme-feature' property contains a symbol created
- ;; by `custom-make-theme-feature'.
-
;; Note we do no check for validity of the theme here.
;; This allows to pull in themes by a file-name convention
(interactive "SCustom theme name: ")
+ ;; 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))
(let ((load-path (if (file-directory-p custom-theme-directory)
(cons custom-theme-directory load-path)
load-path)))
- (require (or (get theme 'theme-feature)
- (custom-make-theme-feature theme)))))
-\f
-;;; How to load and enable various themes as part of `user'.
-
-(defun custom-theme-load-themes (by-theme &rest body)
- "Load the themes specified by BODY.
-Record them as required by theme BY-THEME.
-
-BODY is a sequence of either
-
-THEME
- Load THEME and enable it.
-\(reset THEME)
- Undo all the settings made by THEME
-\(hidden THEME)
- Load THEME but do not enable it.
-
-All the themes loaded for BY-THEME are recorded in BY-THEME's property
-`theme-loads-themes'."
- (custom-check-theme by-theme)
- (let ((themes-loaded (get by-theme 'theme-loads-themes)))
- (dolist (theme body)
- (cond ((and (consp theme) (eq (car theme) 'reset))
- (disable-theme (cadr theme)))
- ((and (consp theme) (eq (car theme) 'hidden))
- (load-theme (cadr theme))
- (disable-theme (cadr theme)))
- (t
- (load-theme theme)))
- (push theme themes-loaded))
- (put by-theme 'theme-loads-themes themes-loaded)))
+ (load (symbol-name (custom-make-theme-feature theme)))))
\f
;;; Enabling and disabling loaded themes.
The newly enabled theme gets the highest precedence (after `user').
If it is already enabled, just give it highest precedence (after `user').
-This signals an error if THEME does not specify any theme
-settings. Theme settings are set using `load-theme'."
+If THEME does not specify any theme settings, this tries to load
+the theme from its theme file, by calling `load-theme'."
(interactive "SEnable Custom theme: ")
- (unless (or (eq theme 'user) (memq theme custom-loaded-themes))
- (error "Theme %s not defined" (symbol-name theme)))
- (let ((settings (get theme 'theme-settings)))
- (dolist (s settings)
- (let* ((prop (car s))
- (symbol (cadr s))
- (spec-list (get symbol prop)))
- (put symbol prop (cons (cddr s) (assq-delete-all theme spec-list)))
- (if (eq prop 'theme-value)
- (custom-theme-recalc-variable symbol)
- (custom-theme-recalc-face symbol)))))
- (unless (eq theme 'user)
- (setq custom-enabled-themes
- (cons theme (delq theme custom-enabled-themes)))
- (unless custom-enabling-themes
- (enable-theme 'user))))
+ (if (not (custom-theme-p theme))
+ (load-theme theme)
+ ;; This could use a bit of optimization -- cyd
+ (let ((settings (get theme 'theme-settings)))
+ (dolist (s settings)
+ (let* ((prop (car s))
+ (symbol (cadr s))
+ (spec-list (get symbol prop)))
+ (put symbol prop (cons (cddr s) (assq-delete-all theme spec-list)))
+ (if (eq prop 'theme-value)
+ (custom-theme-recalc-variable symbol)
+ (custom-theme-recalc-face symbol)))))
+ (unless (eq theme 'user)
+ (setq custom-enabled-themes
+ (cons theme (delq theme custom-enabled-themes)))
+ (unless custom-enabling-themes
+ (enable-theme 'user)))))
(defcustom custom-enabled-themes nil
"List of enabled Custom Themes, highest precedence first.
;; defined in a theme (e.g. `user'). Enabling the theme sets
;; custom-enabled-themes, which enables the theme...
(unless custom-enabling-themes
- (let ((custom-enabling-themes t))
+ (let ((custom-enabling-themes t) failures)
(setq themes (delq 'user (delete-dups themes)))
(if (boundp symbol)
(dolist (theme (symbol-value symbol))
(if (not (memq theme themes))
(disable-theme theme))))
(dolist (theme (reverse themes))
- (if (or (custom-theme-loaded-p theme) (eq theme 'user))
+ (condition-case nil
(enable-theme theme)
- (load-theme theme)))
+ (error (progn (push theme failures)
+ (setq themes (delq theme themes))))))
(enable-theme 'user)
- (custom-set-default symbol themes)))))
+ (custom-set-default symbol themes)
+ (if failures
+ (message "Failed to enable themes: %s"
+ (mapconcat 'symbol-name failures " ")))))))
-(defun custom-theme-enabled-p (theme)
+(defsubst custom-theme-enabled-p (theme)
"Return non-nil if THEME is enabled."
(memq theme custom-enabled-themes))
(defun disable-theme (theme)
"Disable all variable and face settings defined by THEME.
See `custom-enabled-themes' for a list of enabled themes."
- (interactive "SDisable Custom theme: ")
- (when (memq theme custom-enabled-themes)
+ (interactive (list (intern
+ (completing-read
+ "Disable Custom theme: "
+ (mapcar 'symbol-name custom-enabled-themes)
+ nil t))))
+ (when (custom-theme-enabled-p theme)
(let ((settings (get theme 'theme-settings)))
(dolist (s settings)
(let* ((prop (car s))
(setq custom-enabled-themes
(delq theme custom-enabled-themes))))
-(defun custom-theme-value (theme setting-list)
- "Determine the value specified for THEME according to SETTING-LIST.
-Returns a list whose car is the specified value, if we
-find one; nil otherwise.
-
-SETTING-LIST is an alist with themes as its key.
-Each element has the form:
-
- \(THEME MODE VALUE)
-
-MODE is either the symbol `set' or the symbol `reset'. See
-`custom-push-theme' for more information on the format of
-SETTING-LIST."
- ;; Note we do _NOT_ signal an error if the theme is unknown
- ;; it might have gone away without the user knowing.
- (let ((elt (cdr (assoc theme setting-list))))
- (if elt
- (if (eq (car elt) 'set)
- (cdr elt)
- ;; `reset' means refer to another theme's value in the same alist.
- (custom-theme-value (cadr elt) setting-list)))))
-
(defun custom-variable-theme-value (variable)
"Return (list VALUE) indicating the custom theme value of VARIABLE.
That is to say, it specifies what the value should be according to
This function returns nil if no custom theme specifies a value for VARIABLE."
(let* ((theme-value (get variable 'theme-value)))
(if theme-value
- (custom-theme-value (car (car theme-value)) theme-value))))
+ (cdr (car theme-value)))))
(defun custom-theme-recalc-variable (variable)
"Set VARIABLE according to currently enabled custom themes."
(let ((valspec (custom-variable-theme-value variable)))
- (when valspec
- (put variable 'saved-value valspec))
- (unless valspec
+ (if valspec
+ (put variable 'saved-value valspec)
(setq valspec (get variable 'standard-value)))
- (when valspec
- (if (or (get 'force-value variable) (default-boundp variable))
- (funcall (or (get variable 'custom-set) 'set-default) variable
- (eval (car valspec)))))))
+ (if (and valspec
+ (or (get variable 'force-value)
+ (default-boundp variable)))
+ (funcall (or (get variable 'custom-set) 'set-default) variable
+ (eval (car valspec))))))
(defun custom-theme-recalc-face (face)
"Set FACE according to currently enabled custom themes."
(if (facep face)
(let ((theme-faces (reverse (get face 'theme-face))))
(dolist (spec theme-faces)
- (face-spec-set face (car (cddr spec)))))))
+ (face-spec-set face (cadr spec))))))
\f
+;;; XEmacs compability functions
+
+;; In XEmacs, when you reset a Custom Theme, you have to specify the
+;; theme to reset it to. We just apply the next available theme, so
+;; just ignore the IGNORED arguments.
+
(defun custom-theme-reset-variables (theme &rest args)
- "Reset the specs in THEME of some variables to their values in other themes.
+ "Reset some variable settings in THEME to their values in other themes.
Each of the arguments ARGS has this form:
- (VARIABLE FROM-THEME)
+ (VARIABLE IGNORED)
-This means reset VARIABLE to its value in FROM-THEME."
+This means reset VARIABLE. (The argument IGNORED is ignored)."
(custom-check-theme theme)
(dolist (arg args)
- (custom-push-theme 'theme-value (car arg) theme 'reset (cadr arg))))
+ (custom-push-theme 'theme-value (car arg) theme 'reset)))
(defun custom-reset-variables (&rest args)
- "Reset the specs of some variables to their values in certain themes.
+ "Reset the specs of some variables to their values in other themes.
This creates settings in the `user' theme.
Each of the arguments ARGS has this form:
- (VARIABLE FROM-THEME)
+ (VARIABLE IGNORED)
-This means reset VARIABLE to its value in FROM-THEME."
+This means reset VARIABLE. (The argument IGNORED is ignored)."
(apply 'custom-theme-reset-variables 'user args))
;;; The End.