2001-07-15 16:15:35 +00:00
|
|
|
|
;;; custom.el --- tools for declaring and initializing options
|
|
|
|
|
;;
|
2005-08-06 22:13:43 +00:00
|
|
|
|
;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004,
|
2006-02-06 15:23:23 +00:00
|
|
|
|
;; 2005, 2006 Free Software Foundation, Inc.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;;
|
|
|
|
|
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
|
|
|
|
|
;; Maintainer: FSF
|
|
|
|
|
;; Keywords: help, faces
|
|
|
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
|
|
;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
|
;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
|
|
;; any later version.
|
|
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
|
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
2005-07-04 23:32:44 +00:00
|
|
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
|
;; Boston, MA 02110-1301, USA.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
;;
|
2002-11-10 04:20:06 +00:00
|
|
|
|
;; This file only contains the code needed to declare and initialize
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;; user options. The code to customize options is autoloaded from
|
|
|
|
|
;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual.
|
|
|
|
|
|
2002-11-10 04:20:06 +00:00
|
|
|
|
;; The code implementing face declarations is in `cus-face.el'.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
|
|
|
|
;;; 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.")
|
|
|
|
|
|
2002-09-21 19:59:42 +00:00
|
|
|
|
(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.")
|
|
|
|
|
|
2001-11-18 01:35:12 +00:00
|
|
|
|
(defvar custom-current-group-alist nil
|
|
|
|
|
"Alist of (FILE . GROUP) indicating the current group to use for FILE.")
|
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;;; 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
|
2004-05-10 22:08:58 +00:00
|
|
|
|
the car of that and use it as the default binding for symbol.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
Otherwise, VALUE will be evaluated and used as the default binding for
|
|
|
|
|
symbol."
|
|
|
|
|
(unless (default-boundp symbol)
|
|
|
|
|
;; Use the saved value if it exists, otherwise the standard setting.
|
|
|
|
|
(set-default symbol (if (get symbol 'saved-value)
|
|
|
|
|
(eval (car (get symbol 'saved-value)))
|
|
|
|
|
(eval value)))))
|
|
|
|
|
|
|
|
|
|
(defun custom-initialize-set (symbol value)
|
|
|
|
|
"Initialize SYMBOL based on VALUE.
|
|
|
|
|
If the symbol doesn't have a default binding already,
|
|
|
|
|
then set it using its `:set' function (or `set-default' if it has none).
|
|
|
|
|
The value is either the value in the symbol's `saved-value' property,
|
|
|
|
|
if any, or VALUE."
|
|
|
|
|
(unless (default-boundp symbol)
|
|
|
|
|
(funcall (or (get symbol 'custom-set) 'set-default)
|
|
|
|
|
symbol
|
|
|
|
|
(if (get symbol 'saved-value)
|
|
|
|
|
(eval (car (get symbol 'saved-value)))
|
|
|
|
|
(eval value)))))
|
|
|
|
|
|
2005-07-10 16:32:59 +00:00
|
|
|
|
(defun custom-initialize-safe-set (symbol value)
|
|
|
|
|
"Like `custom-initialize-set', but catches errors.
|
|
|
|
|
If an error occurs during initialization, SYMBOL is set to nil
|
|
|
|
|
and no error is thrown. This is meant for use in pre-loaded files
|
2005-07-14 01:17:35 +00:00
|
|
|
|
where some variables or functions used to compute VALUE may not yet
|
2005-07-14 01:19:10 +00:00
|
|
|
|
be defined. You can then re-evaluate VALUE in startup.el, for instance
|
2005-07-14 01:01:37 +00:00
|
|
|
|
using `custom-reevaluate-setting'."
|
2005-07-10 16:32:59 +00:00
|
|
|
|
(condition-case nil
|
|
|
|
|
(custom-initialize-set symbol value)
|
|
|
|
|
(error (set-default symbol nil))))
|
|
|
|
|
|
|
|
|
|
(defun custom-initialize-safe-default (symbol value)
|
|
|
|
|
"Like `custom-initialize-default', but catches errors.
|
|
|
|
|
If an error occurs during initialization, SYMBOL is set to nil
|
|
|
|
|
and no error is thrown. This is meant for use in pre-loaded files
|
2005-07-14 01:17:35 +00:00
|
|
|
|
where some variables or functions used to compute VALUE may not yet
|
2005-07-14 01:19:10 +00:00
|
|
|
|
be defined. You can then re-evaluate VALUE in startup.el, for instance
|
2005-07-14 01:01:37 +00:00
|
|
|
|
using `custom-reevaluate-setting'."
|
2005-07-10 16:32:59 +00:00
|
|
|
|
(condition-case nil
|
|
|
|
|
(custom-initialize-default symbol value)
|
|
|
|
|
(error (set-default symbol nil))))
|
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(defun custom-initialize-reset (symbol value)
|
|
|
|
|
"Initialize SYMBOL based on VALUE.
|
|
|
|
|
Set the symbol, using its `:set' function (or `set-default' if it has none).
|
|
|
|
|
The value is either the symbol's current value
|
|
|
|
|
\(as obtained using the `:get' function), if any,
|
|
|
|
|
or the value in the symbol's `saved-value' property if any,
|
|
|
|
|
or (last of all) VALUE."
|
|
|
|
|
(funcall (or (get symbol 'custom-set) 'set-default)
|
|
|
|
|
symbol
|
|
|
|
|
(cond ((default-boundp symbol)
|
|
|
|
|
(funcall (or (get symbol 'custom-get) 'default-value)
|
|
|
|
|
symbol))
|
|
|
|
|
((get symbol 'saved-value)
|
|
|
|
|
(eval (car (get symbol 'saved-value))))
|
|
|
|
|
(t
|
|
|
|
|
(eval value)))))
|
|
|
|
|
|
|
|
|
|
(defun custom-initialize-changed (symbol value)
|
|
|
|
|
"Initialize SYMBOL with VALUE.
|
|
|
|
|
Like `custom-initialize-reset', but only use the `:set' function if
|
|
|
|
|
not using the standard setting.
|
|
|
|
|
For the standard setting, use `set-default'."
|
|
|
|
|
(cond ((default-boundp symbol)
|
|
|
|
|
(funcall (or (get symbol 'custom-set) 'set-default)
|
|
|
|
|
symbol
|
|
|
|
|
(funcall (or (get symbol 'custom-get) 'default-value)
|
|
|
|
|
symbol)))
|
|
|
|
|
((get symbol 'saved-value)
|
|
|
|
|
(funcall (or (get symbol 'custom-set) 'set-default)
|
|
|
|
|
symbol
|
|
|
|
|
(eval (car (get symbol 'saved-value)))))
|
|
|
|
|
(t
|
|
|
|
|
(set-default symbol (eval value)))))
|
|
|
|
|
|
|
|
|
|
(defun custom-declare-variable (symbol default doc &rest args)
|
|
|
|
|
"Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments.
|
|
|
|
|
DEFAULT should be an expression to evaluate to compute the default value,
|
2002-12-23 18:40:55 +00:00
|
|
|
|
not the default value itself.
|
|
|
|
|
|
2005-07-11 05:41:57 +00:00
|
|
|
|
DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property
|
2002-12-23 18:40:55 +00:00
|
|
|
|
`standard-value'. At the same time, SYMBOL's property `force-value' is
|
|
|
|
|
set to nil, as the value is no longer rogue."
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(put symbol 'standard-value (list default))
|
|
|
|
|
;; Maybe this option was rogue in an earlier version. It no longer is.
|
|
|
|
|
(when (get symbol 'force-value)
|
|
|
|
|
(put symbol 'force-value nil))
|
|
|
|
|
(when doc
|
|
|
|
|
(put symbol 'variable-documentation doc))
|
|
|
|
|
(let ((initialize 'custom-initialize-reset)
|
|
|
|
|
(requests nil))
|
2001-11-18 01:35:12 +00:00
|
|
|
|
(unless (memq :group args)
|
|
|
|
|
(custom-add-to-group (custom-current-group) symbol 'custom-variable))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(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)
|
2002-11-20 14:35:54 +00:00
|
|
|
|
(push value requests))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
((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))
|
2002-11-20 14:35:54 +00:00
|
|
|
|
value)
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;; 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.
|
2002-09-21 19:59:42 +00:00
|
|
|
|
(unless custom-dont-initialize
|
|
|
|
|
(funcall initialize symbol default)))
|
2005-01-12 22:49:19 +00:00
|
|
|
|
(push symbol current-load-list)
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(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.
|
|
|
|
|
|
2004-05-10 22:08:58 +00:00
|
|
|
|
Neither SYMBOL nor VALUE need to be quoted.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
If SYMBOL is not already bound, initialize it to VALUE.
|
|
|
|
|
The remaining arguments should have the form
|
|
|
|
|
|
|
|
|
|
[KEYWORD VALUE]...
|
|
|
|
|
|
|
|
|
|
The following keywords are meaningful:
|
|
|
|
|
|
2002-09-29 04:19:06 +00:00
|
|
|
|
:type VALUE should be a widget type for editing the symbol's value.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
:options VALUE should be a list of valid members of the widget type.
|
2006-04-11 00:08:56 +00:00
|
|
|
|
: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.
|
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
:group VALUE should be a customization group.
|
2006-04-11 00:08:56 +00:00
|
|
|
|
Add SYMBOL (or FACE with `defface') to that group.
|
2002-01-03 19:57:07 +00:00
|
|
|
|
:link LINK-DATA
|
2002-01-03 16:56:30 +00:00
|
|
|
|
Include an external link after the documentation string for this
|
|
|
|
|
item. This is a sentence containing an active field which
|
|
|
|
|
references some other documentation.
|
2003-02-04 11:26:42 +00:00
|
|
|
|
|
2005-11-21 07:56:50 +00:00
|
|
|
|
There are several alternatives you can use for LINK-DATA:
|
2003-02-04 11:26:42 +00:00
|
|
|
|
|
2002-01-03 19:57:07 +00:00
|
|
|
|
(custom-manual INFO-NODE)
|
2002-01-03 16:56:30 +00:00
|
|
|
|
Link to an Info node; INFO-NODE is a string which specifies
|
2005-11-21 07:56:50 +00:00
|
|
|
|
the node name, as in \"(emacs)Top\".
|
2003-02-04 11:26:42 +00:00
|
|
|
|
|
2002-01-03 19:57:07 +00:00
|
|
|
|
(info-link INFO-NODE)
|
2002-01-03 16:56:30 +00:00
|
|
|
|
Like `custom-manual' except that the link appears in the
|
|
|
|
|
customization buffer with the Info node name.
|
2003-02-04 11:26:42 +00:00
|
|
|
|
|
2002-01-03 19:57:07 +00:00
|
|
|
|
(url-link URL)
|
2002-01-03 16:56:30 +00:00
|
|
|
|
Link to a web page; URL is a string which specifies the URL.
|
2005-11-21 07:56:50 +00:00
|
|
|
|
|
|
|
|
|
(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.
|
2003-02-04 11:26:42 +00:00
|
|
|
|
|
2002-01-03 16:56:30 +00:00
|
|
|
|
You can specify the text to use in the customization buffer by
|
|
|
|
|
adding `:tag NAME' after the first element of the LINK-DATA; for
|
2002-01-03 19:57:07 +00:00
|
|
|
|
example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the
|
2002-01-03 16:56:30 +00:00
|
|
|
|
Emacs manual which appears in the buffer as `foo'.
|
2003-02-04 11:26:42 +00:00
|
|
|
|
|
2002-01-03 16:56:30 +00:00
|
|
|
|
An item can have more than one external link; however, most items
|
|
|
|
|
have none at all.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
:version
|
|
|
|
|
VALUE should be a string specifying that the variable was
|
|
|
|
|
first introduced, or its default value was changed, in Emacs
|
|
|
|
|
version VERSION.
|
2006-04-10 23:43:34 +00:00
|
|
|
|
:package-version
|
2006-04-14 00:46:39 +00:00
|
|
|
|
VALUE should be a list with the form (PACKAGE . VERSION)
|
2006-04-10 23:43:34 +00:00
|
|
|
|
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'.
|
2006-04-14 00:46:39 +00:00
|
|
|
|
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.
|
2002-01-03 16:56:30 +00:00
|
|
|
|
:tag LABEL
|
|
|
|
|
Use LABEL, a string, instead of the item's name, to label the item
|
2002-01-05 18:56:56 +00:00
|
|
|
|
in customization menus and buffers.
|
2002-01-03 16:56:30 +00:00
|
|
|
|
:load FILE
|
|
|
|
|
Load file FILE (a string) before displaying this customization
|
2002-10-10 13:09:13 +00:00
|
|
|
|
item. Loading is done with `load', and only if the file is
|
2002-01-03 16:56:30 +00:00
|
|
|
|
not already loaded.
|
2002-12-12 20:27:09 +00:00
|
|
|
|
:set-after VARIABLES
|
|
|
|
|
Specifies that SYMBOL should be set after the list of variables
|
|
|
|
|
VARIABLES when both have been customized.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
2004-07-29 01:47:01 +00:00
|
|
|
|
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.)
|
|
|
|
|
|
2006-04-11 00:08:56 +00:00
|
|
|
|
See Info node `(elisp) Customization' in the Emacs Lisp manual
|
|
|
|
|
for more information."
|
2005-10-24 16:17:11 +00:00
|
|
|
|
(declare (doc-string 3))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;; It is better not to use backquote in this file,
|
|
|
|
|
;; because that makes a bootstrapping problem
|
|
|
|
|
;; if you need to recompile all the Lisp files using interpreted code.
|
|
|
|
|
(nconc (list 'custom-declare-variable
|
|
|
|
|
(list 'quote symbol)
|
|
|
|
|
(list 'quote value)
|
|
|
|
|
doc)
|
|
|
|
|
args))
|
|
|
|
|
|
|
|
|
|
;;; The `defface' Macro.
|
|
|
|
|
|
|
|
|
|
(defmacro defface (face spec doc &rest args)
|
|
|
|
|
"Declare FACE as a customizable face that defaults to SPEC.
|
|
|
|
|
FACE does not need to be quoted.
|
|
|
|
|
|
|
|
|
|
Third argument DOC is the face documentation.
|
|
|
|
|
|
2003-11-11 14:28:53 +00:00
|
|
|
|
If FACE has been set with `custom-set-faces', set the face attributes
|
2001-07-15 16:15:35 +00:00
|
|
|
|
as specified by that function, otherwise set the face attributes
|
|
|
|
|
according to SPEC.
|
|
|
|
|
|
|
|
|
|
The remaining arguments should have the form
|
|
|
|
|
|
|
|
|
|
[KEYWORD VALUE]...
|
|
|
|
|
|
2006-04-11 00:08:56 +00:00
|
|
|
|
For a list of valid keywords, see the common keywords listed in
|
|
|
|
|
`defcustom'.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
|
|
|
|
SPEC should be an alist of the form ((DISPLAY ATTS)...).
|
|
|
|
|
|
2005-04-13 17:39:00 +00:00
|
|
|
|
In the first element, DISPLAY can be :default. The ATTS in that
|
|
|
|
|
element then act as defaults for all the following elements.
|
|
|
|
|
|
|
|
|
|
Aside from that, DISPLAY specifies conditions to match some or
|
|
|
|
|
all frames. For each frame, the first element of SPEC where the
|
|
|
|
|
DISPLAY conditions are satisfied is the one that applies to that
|
|
|
|
|
frame. The ATTRs in this element take effect, and the following
|
|
|
|
|
elements are ignored, on that frame.
|
|
|
|
|
|
|
|
|
|
In the last element, DISPLAY can be t. That element applies to a
|
|
|
|
|
frame if none of the previous elements (except the :default if
|
|
|
|
|
any) did.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
|
|
|
|
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',
|
2001-10-17 01:13:10 +00:00
|
|
|
|
`:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
2005-04-13 17:39:00 +00:00
|
|
|
|
DISPLAY can be `:default' (only in the first element), the symbol
|
|
|
|
|
t (only in the last element) to match all frames, or an alist of
|
|
|
|
|
conditions of the form \(REQ ITEM...). For such an alist to
|
|
|
|
|
match a frame, each of the conditions must be satisfied, meaning
|
|
|
|
|
that the REQ property of the frame must match one of the
|
|
|
|
|
corresponding ITEMs. These are the defined REQ values:
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
|
|
|
|
`type' (the value of `window-system')
|
|
|
|
|
Under X, in addition to the values `window-system' can take,
|
2004-05-12 09:23:02 +00:00
|
|
|
|
`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.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
|
|
|
|
`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'.
|
|
|
|
|
|
2004-02-27 17:00:58 +00:00
|
|
|
|
`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'.
|
|
|
|
|
|
2004-06-06 02:46:29 +00:00
|
|
|
|
`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.
|
|
|
|
|
|
2006-04-11 00:08:56 +00:00
|
|
|
|
See Info node `(elisp) Customization' in the Emacs Lisp manual
|
|
|
|
|
for more information."
|
2005-10-24 16:17:11 +00:00
|
|
|
|
(declare (doc-string 3))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;; 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.
|
|
|
|
|
|
2001-11-18 01:35:12 +00:00
|
|
|
|
(defun custom-current-group ()
|
|
|
|
|
(cdr (assoc load-file-name custom-current-group-alist)))
|
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(defun custom-declare-group (symbol members doc &rest args)
|
|
|
|
|
"Like `defgroup', but SYMBOL is evaluated as a normal argument."
|
|
|
|
|
(while members
|
|
|
|
|
(apply 'custom-add-to-group symbol (car members))
|
|
|
|
|
(setq members (cdr members)))
|
|
|
|
|
(when doc
|
|
|
|
|
;; This text doesn't get into DOC.
|
|
|
|
|
(put symbol 'group-documentation (purecopy doc)))
|
|
|
|
|
(while args
|
|
|
|
|
(let ((arg (car args)))
|
|
|
|
|
(setq args (cdr args))
|
|
|
|
|
(unless (symbolp arg)
|
|
|
|
|
(error "Junk in args %S" args))
|
|
|
|
|
(let ((keyword arg)
|
|
|
|
|
(value (car args)))
|
|
|
|
|
(unless args
|
|
|
|
|
(error "Keyword %s is missing an argument" keyword))
|
|
|
|
|
(setq args (cdr args))
|
|
|
|
|
(cond ((eq keyword :prefix)
|
|
|
|
|
(put symbol 'custom-prefix value))
|
|
|
|
|
(t
|
|
|
|
|
(custom-handle-keyword symbol keyword value
|
|
|
|
|
'custom-group))))))
|
2001-11-18 01:35:12 +00:00
|
|
|
|
;; Record the group on the `current' list.
|
|
|
|
|
(let ((elt (assoc load-file-name custom-current-group-alist)))
|
|
|
|
|
(if elt (setcdr elt symbol)
|
|
|
|
|
(push (cons load-file-name symbol) custom-current-group-alist)))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(run-hooks 'custom-define-hook)
|
|
|
|
|
symbol)
|
|
|
|
|
|
|
|
|
|
(defmacro defgroup (symbol members doc &rest args)
|
|
|
|
|
"Declare SYMBOL as a customization group containing MEMBERS.
|
|
|
|
|
SYMBOL does not need to be quoted.
|
|
|
|
|
|
|
|
|
|
Third arg DOC is the group documentation.
|
|
|
|
|
|
|
|
|
|
MEMBERS should be an alist of the form ((NAME WIDGET)...) where
|
|
|
|
|
NAME is a symbol and WIDGET is a widget for editing that symbol.
|
|
|
|
|
Useful widgets are `custom-variable' for editing variables,
|
|
|
|
|
`custom-face' for edit faces, and `custom-group' for editing groups.
|
|
|
|
|
|
|
|
|
|
The remaining arguments should have the form
|
|
|
|
|
|
|
|
|
|
[KEYWORD VALUE]...
|
|
|
|
|
|
2006-04-11 00:08:56 +00:00
|
|
|
|
For a list of valid keywords, see the common keywords listed in
|
|
|
|
|
`defcustom'.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
2006-04-11 00:08:56 +00:00
|
|
|
|
See Info node `(elisp) Customization' in the Emacs Lisp manual
|
|
|
|
|
for more information."
|
2005-11-21 00:01:06 +00:00
|
|
|
|
(declare (doc-string 3))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;; 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))))))
|
|
|
|
|
|
2002-10-10 13:09:13 +00:00
|
|
|
|
(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)))
|
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;;; 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."
|
2001-11-18 01:35:12 +00:00
|
|
|
|
(unless (memq :group args)
|
2002-11-13 02:27:21 +00:00
|
|
|
|
(custom-add-to-group (custom-current-group) symbol type))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(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))
|
2006-04-10 23:43:34 +00:00
|
|
|
|
((eq keyword :package-version)
|
|
|
|
|
(custom-add-package-version symbol value))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
((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))))
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(defun custom-add-option (symbol option)
|
|
|
|
|
"To the variable SYMBOL add OPTION.
|
|
|
|
|
|
2005-07-03 16:09:07 +00:00
|
|
|
|
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."
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(let ((options (get symbol 'custom-options)))
|
|
|
|
|
(unless (member option options)
|
|
|
|
|
(put symbol 'custom-options (cons option options)))))
|
|
|
|
|
|
|
|
|
|
(defun custom-add-link (symbol widget)
|
|
|
|
|
"To the custom option SYMBOL add the link WIDGET."
|
|
|
|
|
(let ((links (get symbol 'custom-links)))
|
|
|
|
|
(unless (member widget links)
|
|
|
|
|
(put symbol 'custom-links (cons (purecopy widget) links)))))
|
|
|
|
|
|
|
|
|
|
(defun custom-add-version (symbol version)
|
|
|
|
|
"To the custom option SYMBOL add the version VERSION."
|
|
|
|
|
(put symbol 'custom-version (purecopy version)))
|
|
|
|
|
|
2006-04-10 23:43:34 +00:00
|
|
|
|
(defun custom-add-package-version (symbol version)
|
|
|
|
|
"To the custom option SYMBOL add the package version VERSION."
|
|
|
|
|
(put symbol 'custom-package-version (purecopy version)))
|
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(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)))))
|
|
|
|
|
|
2006-07-17 21:26:32 +00:00
|
|
|
|
(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))
|
2003-01-07 18:33:18 +00:00
|
|
|
|
(custom-add-load symbol load))
|
|
|
|
|
|
|
|
|
|
;; This test is also in the C code of `user-variable-p'.
|
|
|
|
|
(defun custom-variable-p (variable)
|
2005-07-07 23:12:43 +00:00
|
|
|
|
"Return non-nil if VARIABLE is a custom variable.
|
|
|
|
|
This recursively follows aliases."
|
|
|
|
|
(setq variable (indirect-variable variable))
|
2003-01-07 18:33:18 +00:00
|
|
|
|
(or (get variable 'standard-value)
|
|
|
|
|
(get variable 'custom-autoload)))
|
|
|
|
|
|
2002-04-28 03:23:52 +00:00
|
|
|
|
;;; 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
|
2002-10-10 13:09:13 +00:00
|
|
|
|
(let ((custom-load-recursion t))
|
2003-08-17 00:17:16 +00:00
|
|
|
|
;; 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))
|
2002-10-10 13:09:13 +00:00
|
|
|
|
(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.
|
2002-04-28 03:23:52 +00:00
|
|
|
|
((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.
|
2002-10-10 13:09:13 +00:00
|
|
|
|
((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
|
|
|
|
|
"\\(\\'\\|\\.\\)"))
|
|
|
|
|
(found nil))
|
2002-04-28 03:23:52 +00:00
|
|
|
|
(dolist (loaded load-history)
|
2002-05-19 16:07:13 +00:00
|
|
|
|
(and (stringp (car loaded))
|
|
|
|
|
(string-match regexp (car loaded))
|
2002-04-28 03:23:52 +00:00
|
|
|
|
(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"))
|
2002-10-10 13:09:13 +00:00
|
|
|
|
(t (condition-case nil (load load) (error nil))))))))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
2006-01-02 15:18:08 +00:00
|
|
|
|
(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."
|
2006-02-20 15:59:51 +00:00
|
|
|
|
(custom-load-symbol symbol)
|
2006-01-02 15:18:08 +00:00
|
|
|
|
(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."
|
2006-02-20 15:59:51 +00:00
|
|
|
|
(custom-load-symbol symbol)
|
2006-01-02 15:18:08 +00:00
|
|
|
|
(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.
|
2006-07-17 21:26:32 +00:00
|
|
|
|
(if (not (and old
|
|
|
|
|
(equal value (condition-case nil
|
|
|
|
|
(eval (car old))
|
|
|
|
|
(error nil)))))
|
2006-02-19 17:26:44 +00:00
|
|
|
|
(progn (put symbol 'customized-value (list (custom-quote value)))
|
|
|
|
|
(custom-push-theme 'theme-value symbol 'user 'set
|
|
|
|
|
(custom-quote value)))
|
2006-01-02 15:18:08 +00:00
|
|
|
|
(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))))))
|
|
|
|
|
|
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
;;; 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)
|
2005-07-02 22:52:27 +00:00
|
|
|
|
"Themes that have been defined with `deftheme'.
|
2006-01-02 15:11:14 +00:00
|
|
|
|
The default value is the list (user changed). The theme `changed'
|
2005-09-05 19:50:02 +00:00
|
|
|
|
contains the settings before custom themes are applied. The
|
2005-07-18 15:17:30 +00:00
|
|
|
|
theme `user' contains all the settings the user customized and saved.
|
2002-12-23 18:40:55 +00:00
|
|
|
|
Additional themes declared with the `deftheme' macro will be added to
|
|
|
|
|
the front of this list.")
|
|
|
|
|
|
|
|
|
|
(defsubst custom-theme-p (theme)
|
|
|
|
|
"Non-nil when THEME has been defined."
|
|
|
|
|
(memq theme custom-known-themes))
|
|
|
|
|
|
|
|
|
|
(defsubst custom-check-theme (theme)
|
|
|
|
|
"Check whether THEME is valid, and signal an error if it is not."
|
|
|
|
|
(unless (custom-theme-p theme)
|
|
|
|
|
(error "Unknown theme `%s'" theme)))
|
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(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.
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
|
|
|
|
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
|
2006-01-02 15:11:14 +00:00
|
|
|
|
`reset', then SYMBOL will be removed from THEME (VALUE is ignored).
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
|
|
|
|
See `custom-known-themes' for a list of known themes."
|
2005-12-31 20:49:22 +00:00
|
|
|
|
(unless (memq prop '(theme-value theme-face))
|
2005-12-24 01:26:54 +00:00
|
|
|
|
(error "Unknown theme property"))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
(let* ((old (get symbol prop))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(setting (assq theme old)) ; '(theme value)
|
|
|
|
|
(theme-settings ; '(prop symbol theme value)
|
|
|
|
|
(get theme 'theme-settings)))
|
|
|
|
|
(if (eq mode 'reset)
|
2005-12-24 01:26:54 +00:00
|
|
|
|
;; Remove a setting.
|
|
|
|
|
(when setting
|
|
|
|
|
(let (res)
|
|
|
|
|
(dolist (theme-setting theme-settings)
|
|
|
|
|
(if (and (eq (car theme-setting) prop)
|
|
|
|
|
(eq (cadr theme-setting) symbol))
|
|
|
|
|
(setq res theme-setting)))
|
|
|
|
|
(put theme 'theme-settings (delq res theme-settings)))
|
|
|
|
|
(put symbol prop (delq setting old)))
|
|
|
|
|
(if setting
|
|
|
|
|
;; Alter an existing setting.
|
|
|
|
|
(let (res)
|
|
|
|
|
(dolist (theme-setting theme-settings)
|
|
|
|
|
(if (and (eq (car theme-setting) prop)
|
|
|
|
|
(eq (cadr theme-setting) symbol))
|
|
|
|
|
(setq res theme-setting)))
|
|
|
|
|
(put theme 'theme-settings
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(cons (list prop symbol theme value)
|
2005-12-24 01:26:54 +00:00
|
|
|
|
(delq res theme-settings)))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(setcar (cdr setting) value))
|
2005-12-24 01:26:54 +00:00
|
|
|
|
;; Add a new setting.
|
|
|
|
|
;; If the user changed the value outside of Customize, we
|
2006-01-02 15:11:14 +00:00
|
|
|
|
;; first save the current value to a fake theme, `changed'.
|
2005-12-24 01:26:54 +00:00
|
|
|
|
;; This ensures that the user-set value comes back if the
|
|
|
|
|
;; theme is later disabled.
|
|
|
|
|
(if (null old)
|
|
|
|
|
(if (and (eq prop 'theme-value)
|
2006-05-13 16:16:43 +00:00
|
|
|
|
(boundp symbol))
|
|
|
|
|
(let ((sv (get symbol 'standard-value)))
|
2006-07-17 21:26:32 +00:00
|
|
|
|
(unless (and sv
|
|
|
|
|
(equal (eval (car sv)) (symbol-value symbol)))
|
|
|
|
|
(setq old (list (list 'changed (symbol-value symbol))))))
|
2006-03-21 16:44:10 +00:00
|
|
|
|
(if (and (facep symbol)
|
|
|
|
|
(not (face-spec-match-p symbol (get symbol 'face-defface-spec))))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(setq old (list (list 'changed (list
|
2005-12-24 01:26:54 +00:00
|
|
|
|
(append '(t) (custom-face-attributes-get symbol nil)))))))))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(put symbol prop (cons (list theme value) old))
|
2005-12-24 01:26:54 +00:00
|
|
|
|
(put theme 'theme-settings
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(cons (list prop symbol theme value)
|
2005-12-24 01:26:54 +00:00
|
|
|
|
theme-settings))))))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
2006-01-02 15:18:08 +00:00
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(defun custom-set-variables (&rest args)
|
2005-01-06 03:58:33 +00:00
|
|
|
|
"Install user customizations of variable values specified in ARGS.
|
|
|
|
|
These settings are registered as theme `user'.
|
2002-12-12 20:27:09 +00:00
|
|
|
|
The arguments should each be a list of the form:
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
2005-01-06 03:58:33 +00:00
|
|
|
|
(SYMBOL EXP [NOW [REQUEST [COMMENT]]])
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
2005-01-06 03:58:33 +00:00
|
|
|
|
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.
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2005-01-06 03:58:33 +00:00
|
|
|
|
REQUEST is a list of features we must require in order to
|
|
|
|
|
handle SYMBOL properly.
|
2001-07-15 16:15:35 +00:00
|
|
|
|
COMMENT is a comment string about SYMBOL."
|
2002-12-23 18:40:55 +00:00
|
|
|
|
(apply 'custom-theme-set-variables 'user args))
|
|
|
|
|
|
|
|
|
|
(defun custom-theme-set-variables (theme &rest args)
|
2005-01-06 03:58:33 +00:00
|
|
|
|
"Initialize variables for theme THEME according to settings in ARGS.
|
|
|
|
|
Each of the arguments in ARGS should be a list of this form:
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2005-01-06 03:58:33 +00:00
|
|
|
|
(SYMBOL EXP [NOW [REQUEST [COMMENT]]])
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2005-01-06 03:58:33 +00:00
|
|
|
|
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.
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2005-01-06 03:58:33 +00:00
|
|
|
|
REQUEST is a list of features we must require in order to
|
|
|
|
|
handle SYMBOL properly.
|
2002-12-23 18:40:55 +00:00
|
|
|
|
COMMENT is a comment string about SYMBOL.
|
|
|
|
|
|
2005-01-06 03:58:33 +00:00
|
|
|
|
EXP itself is saved unevaluated as SYMBOL property `saved-value' and
|
2002-12-23 18:40:55 +00:00
|
|
|
|
in SYMBOL's list property `theme-value' \(using `custom-push-theme')."
|
|
|
|
|
(custom-check-theme theme)
|
2006-08-31 17:10:34 +00:00
|
|
|
|
|
|
|
|
|
;; Process all the needed autoloads before anything else, so that the
|
|
|
|
|
;; subsequent code has all the info it needs (e.g. which var corresponds
|
|
|
|
|
;; to a minor mode), regardless of the ordering of the variables.
|
|
|
|
|
(dolist (entry args)
|
|
|
|
|
(let* ((symbol (indirect-variable (nth 0 entry))))
|
|
|
|
|
(unless (or (get symbol 'standard-value)
|
|
|
|
|
(memq (get symbol 'custom-autoload) '(nil noset)))
|
|
|
|
|
;; This symbol needs to be autoloaded, even just for a `set'.
|
|
|
|
|
(custom-load-symbol symbol))))
|
|
|
|
|
|
|
|
|
|
;; Move minor modes and variables with explicit requires to the end.
|
2005-03-06 00:27:53 +00:00
|
|
|
|
(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)
|
2005-08-24 11:49:07 +00:00
|
|
|
|
;; 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))))))))
|
2005-03-06 00:27:53 +00:00
|
|
|
|
(while args
|
|
|
|
|
(let ((entry (car args)))
|
|
|
|
|
(if (listp entry)
|
|
|
|
|
(let* ((symbol (indirect-variable (nth 0 entry)))
|
|
|
|
|
(value (nth 1 entry))
|
|
|
|
|
(now (nth 2 entry))
|
|
|
|
|
(requests (nth 3 entry))
|
|
|
|
|
(comment (nth 4 entry))
|
|
|
|
|
set)
|
|
|
|
|
(when requests
|
|
|
|
|
(put symbol 'custom-requests requests)
|
|
|
|
|
(mapc 'require requests))
|
|
|
|
|
(setq set (or (get symbol 'custom-set) 'custom-set-default))
|
|
|
|
|
(put symbol 'saved-value (list value))
|
|
|
|
|
(put symbol 'saved-variable-comment comment)
|
|
|
|
|
(custom-push-theme 'theme-value symbol theme 'set value)
|
|
|
|
|
;; Allow for errors in the case where the setter has
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;; 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))))
|
2003-02-04 11:26:42 +00:00
|
|
|
|
(error
|
2001-07-15 16:15:35 +00:00
|
|
|
|
(message "Error setting %s: %s" symbol data)))
|
2005-03-06 00:27:53 +00:00
|
|
|
|
(setq args (cdr args))
|
|
|
|
|
(and (or now (default-boundp symbol))
|
|
|
|
|
(put symbol 'variable-comment comment)))
|
2006-07-17 21:26:32 +00:00
|
|
|
|
;; I believe this is dead-code, because the `sort' code above would
|
|
|
|
|
;; have burped before we could get here. --Stef
|
2005-03-06 00:27:53 +00:00
|
|
|
|
;; Old format, a plist of SYMBOL VALUE pairs.
|
|
|
|
|
(message "Warning: old format `custom-set-variables'")
|
|
|
|
|
(ding)
|
|
|
|
|
(sit-for 2)
|
|
|
|
|
(let ((symbol (indirect-variable (nth 0 args)))
|
|
|
|
|
(value (nth 1 args)))
|
|
|
|
|
(put symbol 'saved-value (list value))
|
|
|
|
|
(custom-push-theme 'theme-value symbol theme 'set value))
|
|
|
|
|
(setq args (cdr (cdr args)))))))
|
2001-07-15 16:15:35 +00:00
|
|
|
|
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
;;; Defining themes.
|
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
;; 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)
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
;; 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.
|
2002-04-19 07:43:43 +00:00
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(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.
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
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.
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc)))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(defun custom-declare-theme (theme feature &optional doc &rest ignored)
|
2005-07-11 00:57:23 +00:00
|
|
|
|
"Like `deftheme', but THEME is evaluated as a normal argument.
|
2006-01-02 15:11:14 +00:00
|
|
|
|
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))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
(add-to-list 'custom-known-themes theme)
|
|
|
|
|
(put theme 'theme-feature feature)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(when doc (put theme 'theme-documentation doc)))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
(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\".
|
2005-09-04 18:00:43 +00:00
|
|
|
|
\(load-theme X) then attempts to load the file `X-theme.el'."
|
2005-07-11 00:57:23 +00:00
|
|
|
|
(intern (concat (symbol-name theme) "-theme")))
|
|
|
|
|
|
|
|
|
|
;;; Loading themes.
|
|
|
|
|
|
2005-07-02 22:52:27 +00:00
|
|
|
|
(defcustom custom-theme-directory
|
|
|
|
|
(if (eq system-type 'ms-dos)
|
|
|
|
|
;; MS-DOS cannot have initial dot.
|
|
|
|
|
"~/_emacs.d/"
|
|
|
|
|
"~/.emacs.d/")
|
|
|
|
|
"Directory in which Custom theme files should be written.
|
2005-09-04 18:00:43 +00:00
|
|
|
|
`load-theme' searches this directory in addition to load-path.
|
2005-07-02 22:52:27 +00:00
|
|
|
|
The command `customize-create-theme' writes the files it produces
|
|
|
|
|
into this directory."
|
|
|
|
|
:type 'string
|
|
|
|
|
:group 'customize
|
|
|
|
|
:version "22.1")
|
|
|
|
|
|
2002-12-23 18:40:55 +00:00
|
|
|
|
(defun provide-theme (theme)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
"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))
|
2002-12-23 18:40:55 +00:00
|
|
|
|
(custom-check-theme theme)
|
|
|
|
|
(provide (get theme 'theme-feature))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
;; Loading a theme also enables it.
|
2005-07-11 00:57:23 +00:00
|
|
|
|
(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.)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(let ((custom-enabling-themes t))
|
|
|
|
|
(enable-theme 'user)))
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2005-09-04 18:00:43 +00:00
|
|
|
|
(defun load-theme (theme)
|
2006-01-04 15:56:08 +00:00
|
|
|
|
"Load a theme's settings from its file.
|
2005-09-04 18:00:43 +00:00
|
|
|
|
This also enables the theme; use `disable-theme' to disable it."
|
2002-12-23 18:40:55 +00:00
|
|
|
|
;; Note we do no check for validity of the theme here.
|
|
|
|
|
;; This allows to pull in themes by a file-name convention
|
2005-09-04 18:00:43 +00:00
|
|
|
|
(interactive "SCustom theme name: ")
|
2006-01-04 15:56:08 +00:00
|
|
|
|
;; 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))
|
2005-07-02 22:52:27 +00:00
|
|
|
|
(let ((load-path (if (file-directory-p custom-theme-directory)
|
|
|
|
|
(cons custom-theme-directory load-path)
|
|
|
|
|
load-path)))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(load (symbol-name (custom-make-theme-feature theme)))))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
;;; Enabling and disabling loaded themes.
|
|
|
|
|
|
2005-12-31 20:49:22 +00:00
|
|
|
|
(defvar custom-enabling-themes nil)
|
|
|
|
|
|
2005-09-04 18:00:43 +00:00
|
|
|
|
(defun enable-theme (theme)
|
2005-07-11 00:57:23 +00:00
|
|
|
|
"Reenable all variable and face settings defined by THEME.
|
|
|
|
|
The newly enabled theme gets the highest precedence (after `user').
|
2005-11-25 18:00:10 +00:00
|
|
|
|
If it is already enabled, just give it highest precedence (after `user').
|
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
If THEME does not specify any theme settings, this tries to load
|
|
|
|
|
the theme from its theme file, by calling `load-theme'."
|
2005-09-04 18:00:43 +00:00
|
|
|
|
(interactive "SEnable Custom theme: ")
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(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)))))
|
2005-12-31 20:49:22 +00:00
|
|
|
|
|
|
|
|
|
(defcustom custom-enabled-themes nil
|
|
|
|
|
"List of enabled Custom Themes, highest precedence first.
|
|
|
|
|
|
|
|
|
|
This does not include the `user' theme, which is set by Customize,
|
|
|
|
|
and always takes precedence over other Custom Themes."
|
|
|
|
|
:group 'customize
|
|
|
|
|
:type '(repeat symbol)
|
|
|
|
|
:set (lambda (symbol themes)
|
|
|
|
|
;; Avoid an infinite loop when custom-enabled-themes is
|
|
|
|
|
;; defined in a theme (e.g. `user'). Enabling the theme sets
|
|
|
|
|
;; custom-enabled-themes, which enables the theme...
|
|
|
|
|
(unless custom-enabling-themes
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(let ((custom-enabling-themes t) failures)
|
2005-12-31 20:49:22 +00:00
|
|
|
|
(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))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(condition-case nil
|
2005-12-31 20:49:22 +00:00
|
|
|
|
(enable-theme theme)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(error (progn (push theme failures)
|
|
|
|
|
(setq themes (delq theme themes))))))
|
2005-12-31 20:49:22 +00:00
|
|
|
|
(enable-theme 'user)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(custom-set-default symbol themes)
|
|
|
|
|
(if failures
|
|
|
|
|
(message "Failed to enable themes: %s"
|
|
|
|
|
(mapconcat 'symbol-name failures " ")))))))
|
2005-12-31 20:49:22 +00:00
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(defsubst custom-theme-enabled-p (theme)
|
2005-12-31 20:49:22 +00:00
|
|
|
|
"Return non-nil if THEME is enabled."
|
|
|
|
|
(memq theme custom-enabled-themes))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
2005-09-04 18:00:43 +00:00
|
|
|
|
(defun disable-theme (theme)
|
2005-07-11 00:57:23 +00:00
|
|
|
|
"Disable all variable and face settings defined by THEME.
|
2005-12-31 20:49:22 +00:00
|
|
|
|
See `custom-enabled-themes' for a list of enabled themes."
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(interactive (list (intern
|
|
|
|
|
(completing-read
|
|
|
|
|
"Disable Custom theme: "
|
|
|
|
|
(mapcar 'symbol-name custom-enabled-themes)
|
|
|
|
|
nil t))))
|
|
|
|
|
(when (custom-theme-enabled-p theme)
|
2005-12-30 22:58:31 +00:00
|
|
|
|
(let ((settings (get theme 'theme-settings)))
|
|
|
|
|
(dolist (s settings)
|
|
|
|
|
(let* ((prop (car s))
|
|
|
|
|
(symbol (cadr s))
|
|
|
|
|
(spec-list (get symbol prop)))
|
|
|
|
|
(put symbol prop (assq-delete-all theme spec-list))
|
|
|
|
|
(if (eq prop 'theme-value)
|
|
|
|
|
(custom-theme-recalc-variable symbol)
|
2005-12-31 20:49:22 +00:00
|
|
|
|
(custom-theme-recalc-face symbol)))))
|
|
|
|
|
(setq custom-enabled-themes
|
|
|
|
|
(delq theme custom-enabled-themes))))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
(defun custom-variable-theme-value (variable)
|
|
|
|
|
"Return (list VALUE) indicating the custom theme value of VARIABLE.
|
|
|
|
|
That is to say, it specifies what the value should be according to
|
|
|
|
|
currently enabled custom themes.
|
|
|
|
|
|
|
|
|
|
This function returns nil if no custom theme specifies a value for VARIABLE."
|
|
|
|
|
(let* ((theme-value (get variable 'theme-value)))
|
|
|
|
|
(if theme-value
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(cdr (car theme-value)))))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
(defun custom-theme-recalc-variable (variable)
|
|
|
|
|
"Set VARIABLE according to currently enabled custom themes."
|
|
|
|
|
(let ((valspec (custom-variable-theme-value variable)))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(if valspec
|
|
|
|
|
(put variable 'saved-value valspec)
|
2005-07-11 00:57:23 +00:00
|
|
|
|
(setq valspec (get variable 'standard-value)))
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(if (and valspec
|
|
|
|
|
(or (get variable 'force-value)
|
|
|
|
|
(default-boundp variable)))
|
|
|
|
|
(funcall (or (get variable 'custom-set) 'set-default) variable
|
|
|
|
|
(eval (car valspec))))))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
|
|
|
|
(defun custom-theme-recalc-face (face)
|
|
|
|
|
"Set FACE according to currently enabled custom themes."
|
2005-12-31 20:49:22 +00:00
|
|
|
|
(if (facep face)
|
|
|
|
|
(let ((theme-faces (reverse (get face 'theme-face))))
|
|
|
|
|
(dolist (spec theme-faces)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(face-spec-set face (cadr spec))))))
|
2005-07-11 00:57:23 +00:00
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
;;; 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.
|
|
|
|
|
|
2002-12-23 18:40:55 +00:00
|
|
|
|
(defun custom-theme-reset-variables (theme &rest args)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
"Reset some variable settings in THEME to their values in other themes.
|
2005-07-11 00:57:23 +00:00
|
|
|
|
Each of the arguments ARGS has this form:
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(VARIABLE IGNORED)
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2006-01-02 15:41:56 +00:00
|
|
|
|
This means reset VARIABLE. (The argument IGNORED is ignored)."
|
2002-12-23 18:40:55 +00:00
|
|
|
|
(custom-check-theme theme)
|
2005-07-11 00:57:23 +00:00
|
|
|
|
(dolist (arg args)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(custom-push-theme 'theme-value (car arg) theme 'reset)))
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
|
|
|
|
(defun custom-reset-variables (&rest args)
|
2006-01-02 15:11:14 +00:00
|
|
|
|
"Reset the specs of some variables to their values in other themes.
|
2005-07-11 00:57:23 +00:00
|
|
|
|
This creates settings in the `user' theme.
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2005-07-11 00:57:23 +00:00
|
|
|
|
Each of the arguments ARGS has this form:
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2006-01-02 15:11:14 +00:00
|
|
|
|
(VARIABLE IGNORED)
|
2002-12-23 18:40:55 +00:00
|
|
|
|
|
2006-01-02 15:41:56 +00:00
|
|
|
|
This means reset VARIABLE. (The argument IGNORED is ignored)."
|
2002-12-23 18:40:55 +00:00
|
|
|
|
(apply 'custom-theme-reset-variables 'user args))
|
|
|
|
|
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;;; The End.
|
|
|
|
|
|
|
|
|
|
;; Process the defcustoms for variables loaded before this file.
|
|
|
|
|
(while custom-declare-variable-list
|
|
|
|
|
(apply 'custom-declare-variable (car custom-declare-variable-list))
|
|
|
|
|
(setq custom-declare-variable-list (cdr custom-declare-variable-list)))
|
|
|
|
|
|
|
|
|
|
(provide 'custom)
|
|
|
|
|
|
2005-03-06 00:27:53 +00:00
|
|
|
|
;; arch-tag: 041b6116-aabe-4f9a-902d-74092bc3dab2
|
2001-07-15 16:15:35 +00:00
|
|
|
|
;;; custom.el ends here
|