X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/a01639a36290eb5bcfa791d11e430f0e51b2aade..8d892d7fef218001fa8ef828db4a5a864448f950:/lisp/custom.el diff --git a/lisp/custom.el b/lisp/custom.el index d2e337164b..0831535f18 100644 --- a/lisp/custom.el +++ b/lisp/custom.el @@ -1,6 +1,7 @@ ;;; custom.el --- tools for declaring and initializing options ;; -;; Copyright (C) 1996, 1997, 1999, 2001 Free Software Foundation, Inc. +;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004, +;; 2005 Free Software Foundation, Inc. ;; ;; Author: Per Abrahamsen ;; Maintainer: FSF @@ -20,16 +21,16 @@ ;; 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 -;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: ;; -;; This file only contain the code needed to declare and initialize +;; This file only contains the code needed to declare and initialize ;; user options. The code to customize options is autoloaded from ;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual. -;; The code implementing face declarations is in `cus-face.el' +;; The code implementing face declarations is in `cus-face.el'. ;;; Code: @@ -39,6 +40,11 @@ ;; Customize information for this option is in `cus-edit.el'. "Hook called after defining each customize option.") +(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.") + (defvar custom-current-group-alist nil "Alist of (FILE . GROUP) indicating the current group to use for FILE.") @@ -48,7 +54,7 @@ "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 -the car of that and used as the default binding for symbol. +the car of that and use it as the default binding for symbol. Otherwise, VALUE will be evaluated and used as the default binding for symbol." (unless (default-boundp symbol) @@ -70,6 +76,28 @@ if any, or VALUE." (eval (car (get symbol 'saved-value))) (eval value))))) +(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 +where some variables or functions used to compute VALUE may not yet +be defined. You can then re-evaluate VALUE in startup.el, for instance +using `custom-reevaluate-setting'." + (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 +where some variables or functions used to compute VALUE may not yet +be defined. You can then re-evaluate VALUE in startup.el, for instance +using `custom-reevaluate-setting'." + (condition-case nil + (custom-initialize-default symbol value) + (error (set-default symbol nil)))) + (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). @@ -107,8 +135,11 @@ For the standard setting, use `set-default'." (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, -not the default value itself." - ;; Remember the standard setting. +not the default value itself. + +DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property +`standard-value'. At the same time, SYMBOL's property `force-value' is +set to nil, as the value is no longer rogue." (put symbol 'standard-value (list default)) ;; Maybe this option was rogue in an earlier version. It no longer is. (when (get symbol 'force-value) @@ -136,7 +167,7 @@ not the default value itself." ((eq keyword :get) (put symbol 'custom-get value)) ((eq keyword :require) - (setq requests (cons value requests))) + (push value requests)) ((eq keyword :type) (put symbol 'custom-type (purecopy value))) ((eq keyword :options) @@ -144,7 +175,7 @@ not the default value itself." ;; Slow safe code to avoid duplicates. (mapc (lambda (option) (custom-add-option symbol option)) - value) + value) ;; Fast code for the common case. (put symbol 'custom-options (copy-sequence value)))) (t @@ -152,8 +183,9 @@ not the default value itself." 'custom-variable)))))) (put symbol 'custom-requests requests) ;; Do the actual initialization. - (funcall initialize symbol default)) - (setq current-load-list (cons symbol current-load-list)) + (unless custom-dont-initialize + (funcall initialize symbol default))) + (push symbol current-load-list) (run-hooks 'custom-define-hook) symbol) @@ -161,7 +193,7 @@ not the default value itself." "Declare SYMBOL as a customizable variable that defaults to VALUE. DOC is the variable documentation. -Neither SYMBOL nor VALUE needs to be quoted. +Neither SYMBOL nor VALUE need to be quoted. If SYMBOL is not already bound, initialize it to VALUE. The remaining arguments should have the form @@ -169,10 +201,37 @@ The remaining arguments should have the form The following keywords are meaningful: -:type VALUE should be a widget type for editing the symbols value. +: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. :group VALUE should be a customization group. Add SYMBOL 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 + references some other documentation. + + There are three alternatives you can use for LINK-DATA: + + (custom-manual INFO-NODE) + Link to an Info node; INFO-NODE is a string which specifies + the node name, as in \"(emacs)Top\". The link appears as + `[manual]' in the customization buffer. + + (info-link INFO-NODE) + Like `custom-manual' except that the link appears in the + customization buffer with the Info node name. + + (url-link URL) + Link to a web page; URL is a string which specifies the URL. + The link appears in the customization buffer as URL. + + You can specify the text to use in the customization buffer by + adding `:tag NAME' after the first element of the LINK-DATA; for + example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the + Emacs manual which appears in the buffer as `foo'. + + 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 @@ -193,9 +252,23 @@ The following keywords are meaningful: VALUE should be a string specifying that the variable was first introduced, or its default value was changed, in Emacs version VERSION. -:set-after VARIABLE - Specifies that SYMBOL should be set after VARIABLE when - both have been customized. +:tag LABEL + Use LABEL, a string, instead of the item's name, to label the item + in customization menus and buffers. +:load FILE + Load file FILE (a string) before displaying this customization + item. Loading is done with `load', and only if the file is + not already loaded. +:set-after VARIABLES + Specifies that SYMBOL should be set after the list of variables + VARIABLES when both have been customized. + +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.) Read the section about customization in the Emacs Lisp manual for more information." @@ -216,7 +289,7 @@ FACE does not need to be quoted. Third argument DOC is the face documentation. -If FACE has been set with `custom-set-face', set the face attributes +If FACE has been set with `custom-set-faces', set the face attributes as specified by that function, otherwise set the face attributes according to SPEC. @@ -231,9 +304,18 @@ The following KEYWORDs are defined: SPEC should be an alist of the form ((DISPLAY ATTS)...). -The first element of SPEC where the DISPLAY matches the frame -is the one that takes effect in that frame. The ATTRs in this -element take effect; the other elements are ignored, on that frame. +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. ATTS is a list of face attributes followed by their values: (ATTR VALUE ATTR VALUE...) @@ -242,15 +324,17 @@ The possible attributes are `:family', `:width', `:height', `:weight', `:slant', `:underline', `:overline', `:strike-through', `:box', `:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'. -DISPLAY can either be the symbol t, which will match all frames, or an -alist of the form \((REQ ITEM...)...). For the DISPLAY to match a -FRAME, the REQ property of the frame must match one of the ITEM. The -following REQ are defined: +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: `type' (the value of `window-system') Under X, in addition to the values `window-system' can take, - `motif', `lucid' and `x-toolkit' are allowed, and match when - the Motif toolkit, Lucid toolkit, or any X toolkit is in use. + `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. `class' (the frame's color support) Should be one of `color', `grayscale', or `mono'. @@ -258,6 +342,15 @@ following REQ are defined: `background' (what color is used for the background text) Should be one of `light' or `dark'. +`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'. + +`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. + Read the section about customization in the Emacs Lisp manual for more information." ;; It is better not to use backquote in this file, @@ -275,7 +368,6 @@ information." (while members (apply 'custom-add-to-group symbol (car members)) (setq members (cdr members))) - (put symbol 'custom-group (nconc members (get symbol 'custom-group))) (when doc ;; This text doesn't get into DOC. (put symbol 'group-documentation (purecopy doc))) @@ -339,13 +431,24 @@ If there already is an entry for OPTION and WIDGET, nothing is done." (unless (member entry members) (put group 'custom-group (nconc members (list entry)))))) +(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))) + ;;; 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." (unless (memq :group args) - (custom-add-to-group (custom-current-group) symbol 'custom-face)) + (custom-add-to-group (custom-current-group) symbol type)) (while args (let ((arg (car args))) (setq args (cdr args)) @@ -396,12 +499,14 @@ both appear in constructs like `custom-set-variables'." (setq value (cdr value)))) (unless (eq deps new-deps) (put symbol 'custom-dependencies new-deps)))) - + (defun custom-add-option (symbol option) "To the variable SYMBOL add OPTION. -If SYMBOL is a hook variable, OPTION should be a hook member. -For other types variables, the effect is undefined." +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." (let ((options (get symbol 'custom-options))) (unless (member option options) (put symbol 'custom-options (cons option options))))) @@ -423,8 +528,133 @@ LOAD should be either a library file name, or a feature name." (unless (member load loads) (put symbol 'custom-loads (cons (purecopy load) loads))))) +(defun custom-autoload (symbol load) + "Mark SYMBOL as autoloaded custom variable and add dependency LOAD." + (put symbol 'custom-autoload t) + (custom-add-load symbol load)) + +;; This test is also in the C code of `user-variable-p'. +(defun custom-variable-p (variable) + "Return non-nil if VARIABLE is a custom variable. +This recursively follows aliases." + (setq variable (indirect-variable variable)) + (or (get variable 'standard-value) + (get variable 'custom-autoload))) + +;;; 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 + (let ((custom-load-recursion t)) + ;; 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)) + (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. + ((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. + ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load) + "\\(\\'\\|\\.\\)")) + (found nil)) + (dolist (loaded load-history) + (and (stringp (car loaded)) + (string-match regexp (car loaded)) + (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")) + (t (condition-case nil (load load) (error nil)))))))) + +(defvar custom-known-themes '(user standard) + "Themes that have been defined with `deftheme'. +The default value is the list (user standard). The theme `standard' +contains the Emacs standard settings from the original Lisp files. The +theme `user' contains all the settings the user customized and saved. +Additional themes declared with the `deftheme' macro will be added to +the front of this list.") + +(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))) + ;;; 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'. + +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 another theme, whose value for this face or +variable should be used. + +In the following example for the variable `goto-address-url-face', the +theme `subtle-hacker' uses the same value for the variable as the theme +`gnome2': + + \((standard set bold) + \(gnome2 set info-xref) + \(jonadab set underline) + \(subtle-hacker reset gnome2)) + + +If a value has been stored for themes A B and C, and a new value +is to be stored for theme C, then the old value of C is discarded. +If a new value is to be stored for theme B, however, the old value +of B is not discarded because B is not the car of the list. + +For variables, list property PROP is `theme-value'. +For faces, list property PROP is `theme-face'. +This is used in `custom-do-theme-reset', for example. + +The list looks the same in any case; the examples shows a possible +value of the `theme-face' property for the face `region': + + \((gnome2 set ((t (:foreground \"cyan\" :background \"dark cyan\")))) + \(standard set ((((class color) (background dark)) + \(:background \"blue\")) + \(t (:background \"gray\"))))) + +This records values for the `standard' and the `gnome2' themes. +The user has not customized the face; had he done that, +the list would contain an entry for the `user' theme, too. +See `custom-known-themes' for a list of known themes." + (let* ((old (get symbol prop)) + (setting (assq theme old))) + ;; Alter an existing theme-setting for the symbol, + ;; or add a new one. + (if setting + (progn + (setcar (cdr setting) mode) + (setcar (cddr setting) value)) + (put symbol prop (cons (list theme mode value) old))) + ;; Record, for each theme, all its settings. + (put theme 'theme-settings + (cons (list prop symbol theme mode value) + (get theme 'theme-settings))))) + (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, @@ -434,17 +664,57 @@ in every Customization buffer.") (put 'custom-local-buffer 'permanent-local t) (defun custom-set-variables (&rest args) - "Initialize variables according to user preferences. + "Install user customizations of variable values specified in ARGS. +These settings are registered as theme `user'. +The arguments should each be a list of the form: -The arguments should be a list where each entry has the form: + (SYMBOL EXP [NOW [REQUEST [COMMENT]]]) - (SYMBOL VALUE [NOW [REQUEST [COMMENT]]]) +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. -The unevaluated VALUE is stored as the saved value for SYMBOL. -If NOW is present and non-nil, VALUE is also evaluated and bound as -the default value for the SYMBOL. -REQUEST is a list of features we must require for SYMBOL. +REQUEST is a list of features we must require in order to +handle SYMBOL properly. 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: + + (SYMBOL EXP [NOW [REQUEST [COMMENT]]]) + +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. + +REQUEST is a list of features we must require in order to +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) (setq args (sort args (lambda (a1 a2) @@ -455,21 +725,18 @@ COMMENT is a comment string about SYMBOL." (cond ((and 1-then-2 2-then-1) (error "Circular custom dependency between `%s' and `%s'" sym1 sym2)) - (1-then-2 t) (2-then-1 nil) - ;; Put symbols with :require last. The macro - ;; define-minor-mode generates a defcustom - ;; with a :require and a :set, where the - ;; setter function calls the mode function. - ;; Putting symbols with :require last ensures - ;; that the mode function will see other - ;; customized values rather than default - ;; values. - (t (nth 3 a2))))))) + ;; 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)))))))) (while args (let ((entry (car args))) (if (listp entry) - (let* ((symbol (nth 0 entry)) + (let* ((symbol (indirect-variable (nth 0 entry))) (value (nth 1 entry)) (now (nth 2 entry)) (requests (nth 3 entry)) @@ -481,6 +748,7 @@ COMMENT is a comment string about SYMBOL." (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 ;; changed between versions, say, but let the user know. (condition-case data @@ -491,7 +759,7 @@ COMMENT is a comment string about SYMBOL." ((default-boundp symbol) ;; Something already set this, overwrite it. (funcall set symbol (eval value)))) - (error + (error (message "Error setting %s: %s" symbol data))) (setq args (cdr args)) (and (or now (default-boundp symbol)) @@ -500,9 +768,10 @@ COMMENT is a comment string about SYMBOL." (message "Warning: old format `custom-set-variables'") (ding) (sit-for 2) - (let ((symbol (nth 0 args)) + (let ((symbol (indirect-variable (nth 0 args))) (value (nth 1 args))) - (put symbol 'saved-value (list value))) + (put symbol 'saved-value (list value)) + (custom-push-theme 'theme-value symbol theme 'set value)) (setq args (cdr (cdr args))))))) (defun custom-set-default (variable value) @@ -515,6 +784,429 @@ this sets the local binding in that buffer instead." (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))))) + +;;; Defining themes. + +;; deftheme is used at the beginning of the file that records a 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 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. + +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. + (nconc (list 'custom-declare-theme + (list 'quote theme) + (list 'quote feature) + doc) + args))) + +(defun custom-declare-theme (theme feature &optional doc &rest args) + "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'." + (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))))))) + +(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\". +\(require-theme X) then attempts to load the file `X-theme.el'." + (intern (concat (symbol-name theme) "-theme"))) + +;;; 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. + "~/_emacs.d/" + "~/.emacs.d/") + "Directory in which Custom theme files should be written. +`require-theme' searches this directory in addition to load-path. +The command `customize-create-theme' writes the files it produces +into this directory." + :type 'string + :group 'customize + :version "22.1") + +(defun custom-theme-loaded-p (theme) + "Return non-nil if THEME has been loaded." + (memq theme custom-loaded-themes)) + +(defvar custom-enabled-themes '(user) + "Custom themes currently enabled, highest precedence first. +The first one is always `user'.") + +(defun custom-theme-enabled-p (theme) + "Return non-nil if THEME is enabled." + (memq theme custom-enabled-themes)) + +(defun provide-theme (theme) + "Indicate that this file provides THEME. +Add THEME to `custom-loaded-themes', and `provide' whatever +feature name is stored in THEME's property `theme-feature'. + +Usually the `theme-feature' property contains a symbol created +by `custom-make-theme-feature'." + (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". + (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.) + (custom-enable-theme 'user)) + +(defun require-theme (theme) + "Try to load a theme's settings from its file. +This also enables the theme; use `custom-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 + (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))))) + +;;; 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)) + (custom-disable-theme (cadr theme))) + ((and (consp theme) (eq (car theme) 'hidden)) + (require-theme (cadr theme)) + (custom-disable-theme (cadr theme))) + (t + (require-theme theme))) + (push theme themes-loaded)) + (put by-theme 'theme-loads-themes themes-loaded))) + +(defun custom-load-themes (&rest body) + "Load themes for the USER theme as specified by BODY. + +See `custom-theme-load-themes' for more information on BODY." + (apply 'custom-theme-load-themes 'user body)) + +;;; Enabling and disabling loaded themes. + +(defun custom-enable-theme (theme) + "Reenable all variable and face settings defined by THEME. +The newly enabled theme gets the highest precedence (after `user'). +If it is already enabled, just give it highest precedence (after `user')." + (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))))) + (setq custom-enabled-themes + (cons theme (delq theme custom-enabled-themes))) + ;; `user' must always be the highest-precedence enabled theme. + (unless (eq theme 'user) + (custom-enable-theme 'user))) + +(defun custom-disable-theme (theme) + "Disable all variable and face settings defined by THEME. +See `custom-known-themes' for a list of known themes." + (let ((settings (get theme 'theme-settings))) + (dolist (s settings) + (let* ((prop (car s)) + (symbol (cadr s)) + (spec-list (get symbol prop))) + (put symbol 'theme-value (assq-delete-all theme spec-list)) + (if (eq prop 'theme-value) + (custom-theme-recalc-variable symbol) + (custom-theme-recalc-face symbol))))) + (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 +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 + (custom-theme-value (car (car theme-value)) theme-value)))) + +(defun custom-face-theme-value (face) + "Return the face spec of FACE according to currently enabled custom themes. +This function returns nil if no custom theme specifies anything for FACE." + (let* ((theme-value (get face 'theme-face))) + (if theme-value + (custom-theme-value (car (car theme-value)) 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 + (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))))))) + +(defun custom-theme-recalc-face (face) + "Set FACE according to currently enabled custom themes." + (let ((spec (custom-face-theme-value face))) + (when spec + (put face 'save-face spec)) + (unless spec + (setq spec (get face 'face-defface-spec))) + (when spec + (when (or (get face 'force-face) (facep face)) + (unless (facep face) + (make-empty-face face)) + (face-spec-set face spec))))) + +(defun custom-theme-reset-variables (theme &rest args) + "Reset the specs in THEME of some variables to their values in other themes. +Each of the arguments ARGS has this form: + + (VARIABLE FROM-THEME) + +This means reset VARIABLE to its value in FROM-THEME." + (custom-check-theme theme) + (dolist (arg args) + (custom-push-theme 'theme-value (car arg) theme 'reset (cadr arg)))) + +(defun custom-reset-variables (&rest args) + "Reset the specs of some variables to their values in certain themes. +This creates settings in the `user' theme. + +Each of the arguments ARGS has this form: + + (VARIABLE FROM-THEME) + +This means reset VARIABLE to its value in FROM-THEME." + (apply 'custom-theme-reset-variables 'user args)) + ;;; The End. ;; Process the defcustoms for variables loaded before this file. @@ -524,4 +1216,5 @@ this sets the local binding in that buffer instead." (provide 'custom) +;; arch-tag: 041b6116-aabe-4f9a-902d-74092bc3dab2 ;;; custom.el ends here