Mercurial > hg > xemacs-beta
annotate lisp/custom.el @ 4502:8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
src/ChangeLog addition:
2008-08-23 Aidan Kehoe <kehoea@parhasard.net>
* eval.c (Fuser_variable_p): Moved to symbols.c
* symbols.c (Fcustom_variable_p): Moved here from custom.el.
(user_variable_alias_check_fun): Mapper function used in
`user-variable-p'.
(Fuser_variable_p): Moved here from eval.c, to allow it to examine
the variable alias chain. Expanded to check each entry in the
variable alias chain for signs of being a user variable;
documentation updated, noting the differences between GNU's
behaviour and ours (ours is a little more sensible)
(map_varalias_chain): New.
Given a C function, call it at least once for each symbol in a
symbol's varalias chain, signalling an error if there's a cycle,
and returning immediately if the function returns something other
than Qzero.
(Fdefvaralias): Correct the use of the word "alias" in the
docstring and in the argument name. Motivate this in a
comment. Add support for a DOCSTRING argument, something GNU has
too, and document this
* gc.c (vars_of_gc): Start the docstring of
`garbage-collection-messages' with an asterisk, to indicate that
it's a user variable.
lisp/ChangeLog addition:
2008-08-23 Aidan Kehoe <kehoea@parhasard.net>
* custom.el: Move #'custom-variable-p to C, since it's now called
from #'user-variable-p.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sat, 23 Aug 2008 16:38:51 +0200 |
| parents | 1d7faae1080c |
| children | 061e030e3270 |
| rev | line source |
|---|---|
| 2544 | 1 ;;; custom.el --- tools for declaring and initializing options |
| 2 ;; | |
| 3 ;; Copyright (C) 1996, 1997, 1999, 2001, 2002 Free Software Foundation, Inc. | |
| 4 ;; | |
| 428 | 5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> |
| 2544 | 6 ;; Maintainer: XEmacs Development Group |
| 428 | 7 ;; Keywords: help, faces, dumped |
| 8 | |
| 9 ;; This file is part of XEmacs. | |
| 10 | |
| 11 ;; XEmacs is free software; you can redistribute it and/or modify | |
| 12 ;; it under the terms of the GNU General Public License as published by | |
| 13 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 14 ;; any later version. | |
| 15 | |
| 16 ;; XEmacs is distributed in the hope that it will be useful, | |
| 17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 19 ;; GNU General Public License for more details. | |
| 20 | |
| 21 ;; You should have received a copy of the GNU General Public License | |
| 22 ;; along with XEmacs; see the file COPYING. If not, write to the | |
| 23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 24 ;; Boston, MA 02111-1307, USA. | |
| 25 | |
| 2544 | 26 ;;; Synched with: FSF 21.3. |
| 1333 | 27 |
| 428 | 28 ;;; Commentary: |
| 29 | |
| 30 ;; This file is dumped with XEmacs. | |
| 31 | |
| 2544 | 32 ;; |
| 33 ;; This file only contains the code needed to declare and initialize | |
| 428 | 34 ;; user options. The code to customize options is autoloaded from |
| 2544 | 35 ;; `cus-edit.el' and is documented in the XEmacs Lisp Reference manual. |
| 36 | |
| 37 ;; The code implementing face declarations is in `cus-face.el'. | |
| 428 | 38 |
| 39 ;;; Code: | |
| 40 | |
| 771 | 41 ;; it is now safe to put the `provide' anywhere. if an error occurs while |
| 42 ;; loading, all provides (and fsets) will be undone. put it first to | |
| 43 ;; prevent require/provide loop with custom and cus-face. | |
| 44 (provide 'custom) | |
| 45 | |
| 428 | 46 (eval-when-compile |
| 771 | 47 (load "cl-macs" nil t) |
| 48 ;; To elude warnings. | |
| 49 (require 'cus-face)) | |
| 428 | 50 |
| 442 | 51 (autoload 'custom-declare-face "cus-face") |
| 52 (autoload 'defun* "cl-macs") | |
| 428 | 53 |
| 54 (require 'widget) | |
| 55 | |
| 56 (defvar custom-define-hook nil | |
| 57 ;; Customize information for this option is in `cus-edit.el'. | |
| 58 "Hook called after defining each customize option.") | |
| 59 | |
| 2544 | 60 (defvar custom-dont-initialize nil |
| 61 "Non-nil means `defcustom' should not initialize the variable. | |
| 62 That is used for the sake of `custom-make-dependencies'. | |
| 63 Users should not set it.") | |
| 64 | |
| 65 (defvar custom-current-group-alist nil | |
| 66 "Alist of (FILE . GROUP) indicating the current group to use for FILE.") | |
| 67 | |
| 428 | 68 ;;; The `defcustom' Macro. |
| 69 | |
| 70 (defun custom-initialize-default (symbol value) | |
| 71 "Initialize SYMBOL with VALUE. | |
| 72 This will do nothing if symbol already has a default binding. | |
| 73 Otherwise, if symbol has a `saved-value' property, it will evaluate | |
| 74 the car of that and used as the default binding for symbol. | |
| 75 Otherwise, VALUE will be evaluated and used as the default binding for | |
| 76 symbol." | |
| 77 (unless (default-boundp symbol) | |
| 78 ;; Use the saved value if it exists, otherwise the standard setting. | |
| 79 (set-default symbol (if (get symbol 'saved-value) | |
| 80 (eval (car (get symbol 'saved-value))) | |
| 81 (eval value))))) | |
| 82 | |
| 83 (defun custom-initialize-set (symbol value) | |
| 84 "Initialize SYMBOL with VALUE. | |
| 1333 | 85 If the symbol doesn't have a default binding already, |
| 86 then set it using its `:set' function (or `set-default' if it has none). | |
| 87 The value is either the value in the symbol's `saved-value' property, | |
| 88 if any, or VALUE. | |
| 89 | |
| 90 This is like `custom-initialize-default', but uses the function specified by | |
| 428 | 91 `:set' to initialize SYMBOL." |
| 92 (unless (default-boundp symbol) | |
| 93 (funcall (or (get symbol 'custom-set) 'set-default) | |
| 94 symbol | |
| 95 (if (get symbol 'saved-value) | |
| 96 (eval (car (get symbol 'saved-value))) | |
| 97 (eval value))))) | |
| 98 | |
| 99 (defun custom-initialize-reset (symbol value) | |
| 100 "Initialize SYMBOL with VALUE. | |
| 1333 | 101 Set the symbol, using its `:set' function (or `set-default' if it has none). |
| 102 The value is either the symbol's current value | |
| 103 \(as obtained using the `:get' function), if any, | |
| 104 or the value in the symbol's `saved-value' property if any, | |
| 105 or (last of all) VALUE. | |
| 106 | |
| 428 | 107 Like `custom-initialize-set', but use the function specified by |
| 108 `:get' to reinitialize SYMBOL if it is already bound." | |
| 109 (funcall (or (get symbol 'custom-set) 'set-default) | |
| 110 symbol | |
| 111 (cond ((default-boundp symbol) | |
| 112 (funcall (or (get symbol 'custom-get) 'default-value) | |
| 113 symbol)) | |
| 114 ((get symbol 'saved-value) | |
| 115 (eval (car (get symbol 'saved-value)))) | |
| 116 (t | |
| 117 (eval value))))) | |
| 118 | |
| 4289 | 119 ;; XEmacs change; move to defsubst, since this is only called in one place |
| 120 ;; and usage of it clusters. | |
| 121 (defsubst custom-initialize-changed (symbol value) | |
| 428 | 122 "Initialize SYMBOL with VALUE. |
| 4289 | 123 Like `custom-initialize-reset', but only use the `:set' function if |
| 1333 | 124 not using the standard setting. |
| 125 For the standard setting, use `set-default'." | |
| 428 | 126 (cond ((default-boundp symbol) |
| 127 (funcall (or (get symbol 'custom-set) 'set-default) | |
| 128 symbol | |
| 129 (funcall (or (get symbol 'custom-get) 'default-value) | |
| 130 symbol))) | |
| 131 ((get symbol 'saved-value) | |
| 132 (funcall (or (get symbol 'custom-set) 'set-default) | |
| 133 symbol | |
| 134 (eval (car (get symbol 'saved-value))))) | |
| 135 (t | |
| 136 (set-default symbol (eval value))))) | |
| 137 | |
| 1333 | 138 (defun custom-declare-variable (symbol default doc &rest args) |
| 139 "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments. | |
| 140 DEFAULT should be an expression to evaluate to compute the default value, | |
| 2544 | 141 not the default value itself. |
| 142 | |
| 143 DEFAULT is stored as SYMBOL's value in the standard theme. See | |
| 144 `custom-known-themes' for a list of known themes. For backwards | |
| 145 compatibility, DEFAULT is also stored in SYMBOL's property | |
| 146 `standard-value'. At the same time, SYMBOL's property `force-value' is | |
| 4289 | 147 set to nil, as the value is no longer rogue. |
| 148 | |
| 149 The byte compiler adds an XEmacs-specific :default keyword and value to | |
| 150 `custom-declare-variable' calls when it byte-compiles the DEFAULT argument. | |
| 151 These describe what the custom UI shows when editing a customizable | |
| 152 variable's associated Lisp expression. We don't encourage use of this | |
| 153 keyword in your own programs. " | |
| 2544 | 154 ;; Remember the standard setting. The value should be in the standard |
| 4289 | 155 ;; theme, not in this property. However, this would require changing |
| 2544 | 156 ;; the C source of defvar and others as well... |
| 1333 | 157 (put symbol 'standard-value (list default)) |
| 428 | 158 ;; Maybe this option was rogue in an earlier version. It no longer is. |
| 159 (when (eq (get symbol 'force-value) 'rogue) | |
| 160 ;; It no longer is. | |
| 161 (put symbol 'force-value nil)) | |
| 162 (when doc | |
| 163 (put symbol 'variable-documentation doc)) | |
| 164 (let ((initialize 'custom-initialize-reset) | |
| 2544 | 165 (requests nil)) |
| 166 (unless (memq :group args) | |
| 167 (custom-add-to-group (custom-current-group) symbol 'custom-variable)) | |
| 428 | 168 (while args |
| 169 (let ((arg (car args))) | |
| 2544 | 170 (setq args (cdr args)) |
| 428 | 171 (check-argument-type 'keywordp arg) |
| 2544 | 172 (let ((keyword arg) |
| 173 (value (car args))) | |
| 174 (unless args | |
| 428 | 175 (signal 'error (list "Keyword is missing an argument" keyword))) |
| 2544 | 176 (setq args (cdr args)) |
| 177 (cond ((eq keyword :initialize) | |
| 178 (setq initialize value)) | |
| 179 ((eq keyword :set) | |
| 180 (put symbol 'custom-set value)) | |
| 181 ((eq keyword :get) | |
| 182 (put symbol 'custom-get value)) | |
| 183 ((eq keyword :require) | |
| 184 (push value requests)) | |
| 185 ((eq keyword :type) | |
| 186 (put symbol 'custom-type (purecopy value))) | |
| 187 ((eq keyword :options) | |
| 188 (if (get symbol 'custom-options) | |
| 189 ;; Slow safe code to avoid duplicates. | |
| 190 (mapc (lambda (option) | |
| 191 (custom-add-option symbol option)) | |
| 192 value) | |
| 193 ;; Fast code for the common case. | |
| 194 (put symbol 'custom-options (copy-sequence value)))) | |
| 4289 | 195 ;; In the event that the byte compile has compiled the init |
| 196 ;; value, we want the value the UI sees to be uncompiled. | |
| 197 ((eq keyword :default) | |
| 198 (put symbol 'standard-value (list value))) | |
| 2544 | 199 (t |
| 200 (custom-handle-keyword symbol keyword value | |
| 201 'custom-variable)))))) | |
| 428 | 202 (put symbol 'custom-requests requests) |
| 203 ;; Do the actual initialization. | |
| 2544 | 204 (unless custom-dont-initialize |
| 205 (funcall initialize symbol default))) | |
| 428 | 206 ;; #### This is a rough equivalent of LOADHIST_ATTACH. However, |
| 207 ;; LOADHIST_ATTACH also checks for `initialized'. | |
| 2544 | 208 (push (cons 'defvar symbol) current-load-list) |
| 428 | 209 (run-hooks 'custom-define-hook) |
| 210 symbol) | |
| 211 | |
| 212 (defmacro defcustom (symbol value doc &rest args) | |
| 213 "Declare SYMBOL as a customizable variable that defaults to VALUE. | |
| 214 DOC is the variable documentation. | |
| 215 | |
| 216 Neither SYMBOL nor VALUE needs to be quoted. | |
| 217 If SYMBOL is not already bound, initialize it to VALUE. | |
| 218 The remaining arguments should have the form | |
| 219 | |
| 220 [KEYWORD VALUE]... | |
| 221 | |
| 1333 | 222 The following keywords are meaningful: |
| 428 | 223 |
| 2544 | 224 :type VALUE should be a widget type for editing the symbol's value. |
| 428 | 225 The default is `sexp'. |
| 226 :options VALUE should be a list of valid members of the widget type. | |
| 227 :group VALUE should be a customization group. | |
| 228 Add SYMBOL to that group. | |
| 2544 | 229 :link LINK-DATA |
| 230 Include an external link after the documentation string for this | |
| 231 item. This is a sentence containing an active field which | |
| 232 references some other documentation. | |
| 233 | |
| 234 There are three alternatives you can use for LINK-DATA: | |
| 235 | |
| 236 (custom-manual INFO-NODE) | |
| 237 Link to an Info node; INFO-NODE is a string which specifies | |
| 238 the node name, as in \"(emacs)Top\". The link appears as | |
| 239 `[manual]' in the customization buffer. | |
| 240 | |
| 241 (info-link INFO-NODE) | |
| 242 Like `custom-manual' except that the link appears in the | |
| 243 customization buffer with the Info node name. | |
| 244 | |
| 245 (url-link URL) | |
| 246 Link to a web page; URL is a string which specifies the URL. | |
| 247 The link appears in the customization buffer as URL. | |
| 248 | |
| 249 You can specify the text to use in the customization buffer by | |
| 250 adding `:tag NAME' after the first element of the LINK-DATA; for | |
| 251 example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the | |
| 252 Emacs manual which appears in the buffer as `foo'. | |
| 253 | |
| 254 An item can have more than one external link; however, most items | |
| 255 have none at all. | |
| 1333 | 256 :initialize |
| 2544 | 257 VALUE should be a function used to initialize the |
| 258 variable. It takes two arguments, the symbol and value | |
| 259 given in the `defcustom' call. The default is | |
| 260 `custom-initialize-reset'. | |
| 1333 | 261 :set VALUE should be a function to set the value of the symbol. |
| 262 It takes two arguments, the symbol to set and the value to | |
| 263 give it. The default choice of function is `custom-set-default'. | |
| 428 | 264 :get VALUE should be a function to extract the value of symbol. |
| 1333 | 265 The function takes one argument, a symbol, and should return |
| 266 the current value for that symbol. The default choice of function | |
| 267 is `custom-default-value'. #### XEmacs used to say `default-value'; | |
| 268 is that right? | |
| 269 :require | |
| 270 VALUE should be a feature symbol. If you save a value | |
| 271 for this option, then when your custom init file loads the value, | |
| 272 it does (require VALUE) first. | |
| 273 :version | |
| 274 VALUE should be a string specifying that the variable was | |
| 903 | 275 first introduced, or its default value was changed, in Emacs |
| 276 version VERSION. | |
| 2544 | 277 :tag LABEL |
| 278 Use LABEL, a string, instead of the item's name, to label the item | |
| 279 in customization menus and buffers. | |
| 280 :load FILE | |
| 281 Load file FILE (a string) before displaying this customization | |
| 282 item. Loading is done with `load', and only if the file is | |
| 283 not already loaded. | |
| 284 :set-after VARIABLES | |
| 285 Specifies that SYMBOL should be set after the list of variables | |
| 286 VARIABLES when both have been customized. | |
| 428 | 287 |
| 288 Read the section about customization in the Emacs Lisp manual for more | |
| 289 information." | |
| 290 `(custom-declare-variable (quote ,symbol) (quote ,value) ,doc ,@args)) | |
| 291 | |
| 292 ;;; The `defface' Macro. | |
| 293 | |
| 294 (defmacro defface (face spec doc &rest args) | |
| 295 "Declare FACE as a customizable face that defaults to SPEC. | |
| 296 FACE does not need to be quoted. | |
| 297 | |
| 298 Third argument DOC is the face documentation. | |
| 299 | |
| 300 If FACE has been set with `custom-set-face', set the face attributes | |
| 301 as specified by that function, otherwise set the face attributes | |
| 302 according to SPEC. | |
| 303 | |
| 304 The remaining arguments should have the form | |
| 305 | |
| 306 [KEYWORD VALUE]... | |
| 307 | |
| 308 The following KEYWORDs are defined: | |
| 309 | |
| 310 :group VALUE should be a customization group. | |
| 311 Add FACE to that group. | |
| 312 | |
| 313 SPEC should be an alist of the form ((DISPLAY ATTS)...). | |
| 314 | |
| 315 ATTS is a list of face attributes and their values. The possible | |
| 316 attributes are defined in the variable `custom-face-attributes'. | |
| 317 | |
| 318 The ATTS of the first entry in SPEC where the DISPLAY matches the | |
| 319 frame should take effect in that frame. DISPLAY can either be the | |
| 320 symbol t, which will match all frames, or an alist of the form | |
| 321 \((REQ ITEM...)...) | |
| 322 | |
| 323 For the DISPLAY to match a FRAME, the REQ property of the frame must | |
| 324 match one of the ITEM. The following REQ are defined: | |
| 325 | |
| 326 `type' (the value of `window-system') | |
| 442 | 327 Should be one of `x', `mswindows', or `tty'. |
| 428 | 328 |
| 329 `class' (the frame's color support) | |
| 330 Should be one of `color', `grayscale', or `mono'. | |
| 331 | |
| 332 `background' (what color is used for the background text) | |
| 333 Should be one of `light' or `dark'. | |
| 334 | |
| 335 Read the section about customization in the Emacs Lisp manual for more | |
| 336 information." | |
| 337 `(custom-declare-face (quote ,face) ,spec ,doc ,@args)) | |
| 338 | |
| 339 ;;; The `defgroup' Macro. | |
| 340 | |
| 2544 | 341 (defun custom-current-group () |
| 342 (cdr (assoc load-file-name custom-current-group-alist))) | |
| 343 | |
| 428 | 344 (defun custom-declare-group (symbol members doc &rest args) |
| 345 "Like `defgroup', but SYMBOL is evaluated as a normal argument." | |
| 346 (while members | |
| 347 (apply 'custom-add-to-group symbol (car members)) | |
| 348 (pop members)) | |
| 349 (when doc | |
| 350 (put symbol 'group-documentation doc)) | |
| 351 (while args | |
| 352 (let ((arg (car args))) | |
| 353 (setq args (cdr args)) | |
| 354 (check-argument-type 'keywordp arg) | |
| 355 (let ((keyword arg) | |
| 2544 | 356 (value (car args))) |
| 428 | 357 (unless args |
| 358 (signal 'error (list "Keyword is missing an argument" keyword))) | |
| 2544 | 359 (setq args (cdr args)) |
| 360 (cond ((eq keyword :prefix) | |
| 361 (put symbol 'custom-prefix value)) | |
| 362 (t | |
| 363 (custom-handle-keyword symbol keyword value | |
| 364 'custom-group)))))) | |
| 365 ;; Record the group on the `current' list. | |
| 366 (let ((elt (assoc load-file-name custom-current-group-alist))) | |
| 367 (if elt (setcdr elt symbol) | |
| 368 (push (cons load-file-name symbol) custom-current-group-alist))) | |
| 428 | 369 (run-hooks 'custom-define-hook) |
| 370 symbol) | |
| 371 | |
| 372 (defmacro defgroup (symbol members doc &rest args) | |
| 373 "Declare SYMBOL as a customization group containing MEMBERS. | |
| 374 SYMBOL does not need to be quoted. | |
| 375 | |
| 376 Third arg DOC is the group documentation. | |
| 377 | |
| 378 MEMBERS should be an alist of the form ((NAME WIDGET)...) where NAME | |
| 379 is a symbol and WIDGET is a widget for editing that symbol. Useful | |
| 380 widgets are `custom-variable' for editing variables, `custom-face' for | |
| 381 edit faces, and `custom-group' for editing groups. | |
| 382 | |
| 383 The remaining arguments should have the form | |
| 384 | |
| 385 [KEYWORD VALUE]... | |
| 386 | |
| 2544 | 387 The following KEYWORDs are defined: |
| 428 | 388 |
| 389 :group VALUE should be a customization group. | |
| 390 Add SYMBOL to that group. | |
| 391 | |
| 392 Read the section about customization in the Emacs Lisp manual for more | |
| 393 information." | |
| 2544 | 394 |
| 395 ;; XEmacs: Evidently a purposeful omission from the docs: | |
| 396 ;:version VALUE should be a string specifying that the group was introduced | |
| 397 ; in Emacs version VERSION. | |
| 398 ; | |
| 399 | |
| 400 ;; FSF: (not a problem for XEmacs) | |
| 401 ;; It is better not to use backquote in this file, | |
| 402 ;; because that makes a bootstrapping problem | |
| 403 ;; if you need to recompile all the Lisp files using interpreted code. | |
| 404 ; (nconc (list 'custom-declare-group (list 'quote symbol) members doc) args)) | |
| 428 | 405 `(custom-declare-group (quote ,symbol) ,members ,doc ,@args)) |
| 406 | |
| 407 (defvar custom-group-hash-table (make-hash-table :size 300 :test 'eq) | |
| 408 "Hash-table of non-empty groups.") | |
| 409 | |
| 410 (defun custom-add-to-group (group option widget) | |
| 411 "To existing GROUP add a new OPTION of type WIDGET. | |
| 2544 | 412 If there already is an entry for OPTION and WIDGET, nothing is done." |
| 413 (let ((members (get group 'custom-group)) | |
| 414 (entry (list option widget))) | |
| 415 (unless (member entry members) | |
| 416 (put group 'custom-group (nconc members (list entry))))) | |
| 428 | 417 (puthash group t custom-group-hash-table)) |
| 418 | |
| 2544 | 419 (defun custom-group-of-mode (mode) |
| 420 "Return the custom group corresponding to the major or minor MODE. | |
| 421 If no such group is found, return nil." | |
| 422 (or (get mode 'custom-mode-group) | |
| 423 (if (or (get mode 'custom-group) | |
| 424 (and (string-match "-mode\\'" (symbol-name mode)) | |
| 425 (get (setq mode (intern (substring (symbol-name mode) | |
| 426 0 (match-beginning 0)))) | |
| 427 'custom-group))) | |
| 428 mode))) | |
| 429 | |
| 428 | 430 ;;; Properties. |
| 431 | |
| 432 (defun custom-handle-all-keywords (symbol args type) | |
| 433 "For customization option SYMBOL, handle keyword arguments ARGS. | |
| 434 Third argument TYPE is the custom option type." | |
| 2544 | 435 (unless (memq :group args) |
| 436 (custom-add-to-group (custom-current-group) symbol type)) | |
| 428 | 437 (while args |
| 438 (let ((arg (car args))) | |
| 439 (setq args (cdr args)) | |
| 440 (check-argument-type 'keywordp arg) | |
| 441 (let ((keyword arg) | |
| 442 (value (car args))) | |
| 443 (unless args | |
| 444 (signal 'error (list "Keyword is missing an argument" keyword))) | |
| 445 (setq args (cdr args)) | |
| 446 (custom-handle-keyword symbol keyword value type))))) | |
| 447 | |
| 448 (defun custom-handle-keyword (symbol keyword value type) | |
| 449 "For customization option SYMBOL, handle KEYWORD with VALUE. | |
| 450 Fourth argument TYPE is the custom option type." | |
| 451 (cond ((eq keyword :group) | |
| 903 | 452 (custom-add-to-group value symbol type)) |
| 453 ((eq keyword :version) | |
| 454 (custom-add-version symbol value)) | |
| 455 ((eq keyword :link) | |
| 456 (custom-add-link symbol value)) | |
| 457 ((eq keyword :load) | |
| 458 (custom-add-load symbol value)) | |
| 459 ((eq keyword :tag) | |
| 460 (put symbol 'custom-tag value)) | |
| 461 ((eq keyword :set-after) | |
| 462 (custom-add-dependencies symbol value)) | |
| 463 (t | |
| 464 (signal 'error (list "Unknown keyword" keyword))))) | |
| 465 | |
| 466 (defun custom-add-dependencies (symbol value) | |
| 467 "To the custom option SYMBOL, add dependencies specified by VALUE. | |
| 468 VALUE should be a list of symbols. For each symbol in that list, | |
| 469 this specifies that SYMBOL should be set after the specified symbol, if | |
| 470 both appear in constructs like `custom-set-variables'." | |
| 471 (unless (listp value) | |
| 472 (error "Invalid custom dependency `%s'" value)) | |
| 473 (let* ((deps (get symbol 'custom-dependencies)) | |
| 474 (new-deps deps)) | |
| 475 (while value | |
| 476 (let ((dep (car value))) | |
| 477 (unless (symbolp dep) | |
| 478 (error "Invalid custom dependency `%s'" dep)) | |
| 479 (unless (memq dep new-deps) | |
| 480 (setq new-deps (cons dep new-deps))) | |
| 481 (setq value (cdr value)))) | |
| 482 (unless (eq deps new-deps) | |
| 483 (put symbol 'custom-dependencies new-deps)))) | |
| 428 | 484 |
| 485 (defun custom-add-option (symbol option) | |
| 486 "To the variable SYMBOL add OPTION. | |
| 487 | |
| 488 If SYMBOL is a hook variable, OPTION should be a hook member. | |
| 489 For other types variables, the effect is undefined." | |
| 490 (let ((options (get symbol 'custom-options))) | |
| 491 (unless (member option options) | |
| 492 (put symbol 'custom-options (cons option options))))) | |
| 493 | |
| 494 (defun custom-add-link (symbol widget) | |
| 495 "To the custom option SYMBOL add the link WIDGET." | |
| 496 (let ((links (get symbol 'custom-links))) | |
| 497 (unless (member widget links) | |
| 498 (put symbol 'custom-links (cons widget links))))) | |
| 499 | |
| 500 (defun custom-add-version (symbol version) | |
| 501 "To the custom option SYMBOL add the version VERSION." | |
| 502 (put symbol 'custom-version version)) | |
| 503 | |
| 504 (defun custom-add-load (symbol load) | |
| 505 "To the custom option SYMBOL add the dependency LOAD. | |
| 506 LOAD should be either a library file name, or a feature name." | |
| 507 (puthash symbol t custom-group-hash-table) | |
| 508 (let ((loads (get symbol 'custom-loads))) | |
| 509 (unless (member load loads) | |
| 510 (put symbol 'custom-loads (cons load loads))))) | |
| 511 | |
| 2544 | 512 (defun custom-autoload (symbol load) |
| 513 "Mark SYMBOL as autoloaded custom variable and add dependency LOAD." | |
| 514 (put symbol 'custom-autoload t) | |
| 515 (custom-add-load symbol load)) | |
| 516 | |
|
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4441
diff
changeset
|
517 ;; XEmacs; |
|
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4441
diff
changeset
|
518 ;; #'custom-variable-p is in symbols.c, since it's called from |
|
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4441
diff
changeset
|
519 ;; #'user-variable-p. |
| 2544 | 520 |
| 521 ;;; Loading files needed to customize a symbol. | |
| 522 ;;; This is in custom.el because menu-bar.el needs it for toggle cmds. | |
| 523 | |
| 524 (defvar custom-load-recursion nil | |
| 525 "Hack to avoid recursive dependencies.") | |
| 526 | |
| 527 (defun custom-load-symbol (symbol) | |
| 528 "Load all dependencies for SYMBOL." | |
| 529 (unless custom-load-recursion | |
| 530 (let ((custom-load-recursion t)) | |
| 531 (dolist (load (get symbol 'custom-loads)) | |
| 532 (cond ((symbolp load) (condition-case nil (require load) (error nil))) | |
| 533 ;; This is subsumed by the test below, but it's much faster. | |
| 534 ((assoc load load-history)) | |
| 535 ;; This was just (assoc (locate-library load) load-history) | |
| 536 ;; but has been optimized not to load locate-library | |
| 537 ;; if not necessary. | |
| 538 ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load) | |
| 539 "\\(\\'\\|\\.\\)")) | |
| 540 (found nil)) | |
| 541 (dolist (loaded load-history) | |
| 542 (and (stringp (car loaded)) | |
| 543 (string-match regexp (car loaded)) | |
| 544 (setq found t))) | |
| 545 found)) | |
| 546 ;; Without this, we would load cus-edit recursively. | |
| 547 ;; We are still loading it when we call this, | |
| 548 ;; and it is not in load-history yet. | |
| 549 ((equal load "cus-edit")) | |
| 550 (t (condition-case nil (load load) (error nil)))))))) | |
| 428 | 551 |
| 552 (defvar custom-known-themes '(user standard) | |
| 2544 | 553 "Themes that have been define with `deftheme'. |
| 554 The default value is the list (user standard). The theme `standard' | |
| 555 contains the Emacs standard settings from the original Lisp files. The | |
| 556 theme `user' contains all the the settings the user customized and saved. | |
| 557 Additional themes declared with the `deftheme' macro will be added to | |
| 558 the front of this list.") | |
| 428 | 559 |
| 2544 | 560 (defun custom-declare-theme (theme feature &optional doc &rest args) |
| 561 "Like `deftheme', but THEME is evaluated as a normal argument. | |
| 562 FEATURE is the feature this theme provides. This symbol is created | |
| 563 from THEME by `custom-make-theme-feature'." | |
| 564 (add-to-list 'custom-known-themes theme) | |
| 428 | 565 (put theme 'theme-feature feature) |
| 2544 | 566 (when doc |
| 567 (put theme 'theme-documentation doc)) | |
| 568 (while args | |
| 569 (let ((arg (car args))) | |
| 570 (setq args (cdr args)) | |
| 571 (check-argument-type 'keywordp arg) | |
| 572 (let ((keyword arg) | |
| 573 (value (car args))) | |
| 574 (unless args | |
| 575 (signal 'error (list "Keyword is missing an argument" keyword))) | |
| 576 (setq args (cdr args)) | |
| 577 (cond ((eq keyword :short-description) | |
| 578 (put theme 'theme-short-description value)) | |
| 579 ((eq keyword :immediate) | |
| 580 (put theme 'theme-immediate value)) | |
| 581 ((eq keyword :variable-set-string) | |
| 582 (put theme 'theme-variable-set-string value)) | |
| 583 ((eq keyword :variable-reset-string) | |
| 584 (put theme 'theme-variable-reset-string value)) | |
| 585 ((eq keyword :face-set-string) | |
| 586 (put theme 'theme-face-set-string value)) | |
| 587 ((eq keyword :face-reset-string) | |
| 588 (put theme 'theme-face-reset-string value))))))) | |
| 589 | |
| 590 (defmacro deftheme (theme &optional doc &rest args) | |
| 591 "Declare custom theme THEME. | |
| 592 The optional argument DOC is a doc string describing the theme. | |
| 593 The remaining arguments should have the form | |
| 594 | |
| 595 [KEYWORD VALUE]... | |
| 596 | |
| 597 The following KEYWORD's are defined: | |
| 598 | |
| 599 :short-description | |
| 600 VALUE is a short (one line) description of the theme. If not | |
| 601 given, DOC is used. | |
| 602 :immediate | |
| 603 If VALUE is non-nil, variables specified in this theme are set | |
| 604 immediately when loading the theme. | |
| 605 :variable-set-string | |
| 606 VALUE is a string used to indicate that a variable takes its | |
| 607 setting from this theme. It is passed to FORMAT with the name | |
| 608 of the theme as an additional argument. If not given, a | |
| 609 generic description is used. | |
| 610 :variable-reset-string | |
| 611 VALUE is a string used in the case a variable has been forced | |
| 612 to its value in this theme. It is passed to FORMAT with the | |
| 613 name of the theme as an additional argument. If not given, a | |
| 614 generic description is used. | |
| 615 :face-set-string | |
| 616 VALUE is a string used to indicate that a face takes its | |
| 617 setting from this theme. It is passed to FORMAT with the name | |
| 618 of the theme as an additional argument. If not given, a | |
| 619 generic description is used. | |
| 620 :face-reset-string | |
| 621 VALUE is a string used in the case a face has been forced to | |
| 622 its value in this theme. It is passed to FORMAT with the name | |
| 623 of the theme as an additional argument. If not given, a | |
| 624 generic description is used. | |
| 625 | |
| 626 Any theme `foo' should be defined in a file called `foo-theme.el'; | |
| 627 see `custom-make-theme-feature' for more information." | |
| 628 (let ((feature (custom-make-theme-feature theme))) | |
| 629 ;; It is better not to use backquote in this file, | |
| 630 ;; because that makes a bootstrapping problem | |
| 631 ;; if you need to recompile all the Lisp files using interpreted code. | |
| 632 (nconc (list 'custom-declare-theme | |
| 633 (list 'quote theme) | |
| 634 (list 'quote feature) | |
| 635 doc) args))) | |
| 428 | 636 |
| 637 (defun custom-make-theme-feature (theme) | |
| 2544 | 638 "Given a symbol THEME, create a new symbol by appending \"-theme\". |
| 639 Store this symbol in the `theme-feature' property of THEME. | |
| 640 Calling `provide-theme' to provide THEME actually puts `THEME-theme' | |
| 641 into `features'. | |
| 428 | 642 |
| 2544 | 643 This allows for a file-name convention for autoloading themes: |
| 644 Every theme X has a property `provide-theme' whose value is \"X-theme\". | |
| 645 \(require-theme X) then attempts to load the file `X-theme.el'." | |
| 646 (intern (concat (symbol-name theme) "-theme"))) | |
| 428 | 647 |
| 648 (defsubst custom-theme-p (theme) | |
| 649 "Non-nil when THEME has been defined." | |
| 650 (memq theme custom-known-themes)) | |
| 651 | |
| 652 (defsubst custom-check-theme (theme) | |
| 2544 | 653 "Check whether THEME is valid, and signal an error if it is not." |
| 428 | 654 (unless (custom-theme-p theme) |
| 655 (error "Unknown theme `%s'" theme))) | |
| 656 | |
| 657 ;;; Initializing. | |
| 658 | |
| 659 (defun custom-push-theme (prop symbol theme mode value) | |
| 2544 | 660 "Add (THEME MODE VALUE) to the list in property PROP of SYMBOL. |
| 661 If the first element in that list is already (THEME ...), | |
| 662 discard it first. | |
| 663 | |
| 664 MODE can be either the symbol `set' or the symbol `reset'. If it is the | |
| 665 symbol `set', then VALUE is the value to use. If it is the symbol | |
| 666 `reset', then VALUE is the mode to query instead. | |
| 667 | |
| 668 In the following example for the variable `goto-address-url-face', the | |
| 669 theme `subtle-hacker' uses the same value for the variable as the theme | |
| 670 `gnome2': | |
| 671 | |
| 672 \((standard set bold) | |
| 673 \(gnome2 set info-xref) | |
| 674 \(jonadab set underline) | |
| 675 \(subtle-hacker reset gnome2)) | |
| 676 | |
| 677 | |
| 678 If a value has been stored for themes A B and C, and a new value | |
| 679 is to be stored for theme C, then the old value of C is discarded. | |
| 680 If a new value is to be stored for theme B, however, the old value | |
| 681 of B is not discarded because B is not the car of the list. | |
| 682 | |
| 683 For variables, list property PROP is `theme-value'. | |
| 684 For faces, list property PROP is `theme-face'. | |
| 685 This is used in `custom-do-theme-reset', for example. | |
| 686 | |
| 687 The list looks the same in any case; the examples shows a possible | |
| 688 value of the `theme-face' property for the face `region': | |
| 689 | |
| 690 \((gnome2 set ((t (:foreground \"cyan\" :background \"dark cyan\")))) | |
| 691 \(standard set ((((class color) (background dark)) | |
| 692 \(:background \"blue\")) | |
| 693 \(t (:background \"gray\"))))) | |
| 694 | |
| 695 This records values for the `standard' and the `gnome2' themes. | |
| 696 The user has not customized the face; had he done that, | |
| 697 the list would contain an entry for the `user' theme, too. | |
| 698 See `custom-known-themes' for a list of known themes." | |
| 428 | 699 (let ((old (get symbol prop))) |
| 700 (if (eq (car-safe (car-safe old)) theme) | |
| 701 (setq old (cdr old))) | |
| 702 (put symbol prop (cons (list theme mode value) old)))) | |
| 703 | |
| 988 | 704 (defvar custom-local-buffer nil |
| 705 "Non-nil, in a Customization buffer, means customize a specific buffer. | |
| 706 If this variable is non-nil, it should be a buffer, | |
| 707 and it means customize the local bindings of that buffer. | |
| 708 This variable is a permanent local, and it normally has a local binding | |
| 709 in every Customization buffer.") | |
| 710 (put 'custom-local-buffer 'permanent-local t) | |
| 711 | |
| 428 | 712 (defun custom-set-variables (&rest args) |
| 713 "Initialize variables according to user preferences. | |
| 714 The settings are registered as theme `user'. | |
| 2544 | 715 The arguments should each be a list of the form: |
| 428 | 716 |
| 717 (SYMBOL VALUE [NOW [REQUEST [COMMENT]]]) | |
| 718 | |
| 719 The unevaluated VALUE is stored as the saved value for SYMBOL. | |
| 720 If NOW is present and non-nil, VALUE is also evaluated and bound as | |
| 721 the default value for the SYMBOL. | |
| 2544 | 722 |
| 428 | 723 REQUEST is a list of features we must 'require for SYMBOL. |
| 724 COMMENT is a comment string about SYMBOL." | |
| 725 (apply 'custom-theme-set-variables 'user args)) | |
| 726 | |
| 727 (defun custom-theme-set-variables (theme &rest args) | |
| 728 "Initialize variables according to settings specified by args. | |
| 729 Records the settings as belonging to THEME. | |
| 730 | |
| 2544 | 731 The arguments should be a list where each entry has the form: |
| 732 | |
| 733 (SYMBOL VALUE [NOW [REQUEST [COMMENT]]]) | |
| 734 | |
| 735 The unevaluated VALUE is stored as the saved value for SYMBOL. | |
| 736 If NOW is present and non-nil, VALUE is also evaluated and bound as | |
| 737 the default value for the SYMBOL. | |
| 738 REQUEST is a list of features we must 'require for SYMBOL. | |
| 739 COMMENT is a comment string about SYMBOL. | |
| 740 | |
| 741 Several properties of THEME and SYMBOL are used in the process: | |
| 742 | |
| 743 If THEME property `theme-immediate' is non-nil, this is equivalent of | |
| 744 providing the NOW argument to all symbols in the argument list: SYMBOL | |
| 745 is bound to the evaluated VALUE. The only difference is SYMBOL property | |
| 746 `force-value': if NOW is non-nil, SYMBOL's property `force-value' is set to | |
| 747 the symbol `rogue', else if THEME's property `theme-immediate' is non-nil, | |
| 748 FACE's property `force-face' is set to the symbol `immediate'. | |
| 749 | |
| 750 VALUE itself is saved unevaluated as SYMBOL property `saved-value' and | |
| 751 in SYMBOL's list property `theme-value' \(using `custom-push-theme')." | |
| 428 | 752 (custom-check-theme theme) |
| 753 (let ((immediate (get theme 'theme-immediate))) | |
| 2544 | 754 (setq args |
| 755 (sort args | |
| 756 (lambda (a1 a2) | |
| 757 (let* ((sym1 (car a1)) | |
| 758 (sym2 (car a2)) | |
| 759 (1-then-2 (memq sym1 (get sym2 'custom-dependencies))) | |
| 760 (2-then-1 (memq sym2 (get sym1 'custom-dependencies)))) | |
| 761 (cond ((and 1-then-2 2-then-1) | |
| 762 (error "Circular custom dependency between `%s' and `%s'" | |
| 763 sym1 sym2)) | |
| 764 (2-then-1 nil) | |
| 765 ;; Put symbols with :require last. The macro | |
| 766 ;; define-minor-mode generates a defcustom | |
| 767 ;; with a :require and a :set, where the | |
| 768 ;; setter function calls the mode function. | |
| 769 ;; Putting symbols with :require last ensures | |
| 770 ;; that the mode function will see other | |
| 771 ;; customized values rather than default | |
| 772 ;; values. | |
| 773 (t (nth 3 a2))))))) | |
| 988 | 774 (while args |
| 428 | 775 (let ((entry (car args))) |
| 2544 | 776 (if (listp entry) |
| 777 (let* ((symbol (nth 0 entry)) | |
| 778 (value (nth 1 entry)) | |
| 779 (now (nth 2 entry)) | |
| 780 (requests (nth 3 entry)) | |
| 781 (comment (nth 4 entry)) | |
| 782 set) | |
| 783 (when requests | |
| 784 (put symbol 'custom-requests requests) | |
| 785 (mapc 'require requests)) | |
| 786 (setq set (or (get symbol 'custom-set) 'custom-set-default)) | |
| 787 (put symbol 'saved-value (list value)) | |
| 788 (put symbol 'saved-variable-comment comment) | |
| 428 | 789 (custom-push-theme 'theme-value symbol theme 'set value) |
| 2544 | 790 ;; Allow for errors in the case where the setter has |
| 791 ;; changed between versions, say, but let the user know. | |
| 792 (condition-case data | |
| 793 (cond ((or now immediate) | |
| 794 ;; Rogue variable, set it now. | |
| 795 (put symbol 'force-value (if now 'rogue 'immediate)) | |
| 796 (funcall set symbol (eval value))) | |
| 797 ((default-boundp symbol) | |
| 798 ;; Something already set this, overwrite it. | |
| 799 (funcall set symbol (eval value)))) | |
| 800 (error | |
| 988 | 801 (message "Error setting %s: %s" symbol data))) |
| 2544 | 802 (setq args (cdr args)) |
| 803 (and (or now (default-boundp symbol)) | |
| 804 (put symbol 'variable-comment comment))) | |
| 805 ;; Old format, a plist of SYMBOL VALUE pairs. | |
| 806 (message "Warning: old format `custom-set-variables'") | |
| 807 (ding) | |
| 808 (sit-for 2) | |
| 809 (let ((symbol (nth 0 args)) | |
| 810 (value (nth 1 args))) | |
| 811 (put symbol 'saved-value (list value)) | |
| 428 | 812 (custom-push-theme 'theme-value symbol theme 'set value)) |
| 2544 | 813 (setq args (cdr (cdr args)))))))) |
| 428 | 814 |
| 988 | 815 (defun custom-set-default (variable value) |
| 816 "Default :set function for a customizable variable. | |
| 817 Normally, this sets the default value of VARIABLE to VALUE, | |
| 818 but if `custom-local-buffer' is non-nil, | |
| 819 this sets the local binding in that buffer instead." | |
| 820 (if custom-local-buffer | |
| 821 (with-current-buffer custom-local-buffer | |
| 822 (set variable value)) | |
| 823 (set-default variable value))) | |
| 428 | 824 |
| 2544 | 825 (defun custom-quote (sexp) |
| 826 "Quote SEXP iff it is not self quoting." | |
| 827 (if (or (memq sexp '(t nil)) | |
| 828 (keywordp sexp) | |
| 829 (and (listp sexp) | |
| 830 (memq (car sexp) '(lambda))) | |
| 831 (stringp sexp) | |
| 832 (numberp sexp) | |
| 833 (vectorp sexp) | |
| 834 ;;; (and (fboundp 'characterp) | |
| 835 ;;; (characterp sexp)) | |
| 836 ) | |
| 837 sexp | |
| 838 (list 'quote sexp))) | |
| 839 | |
| 840 (defun customize-mark-to-save (symbol) | |
| 841 "Mark SYMBOL for later saving. | |
| 842 | |
| 843 If the default value of SYMBOL is different from the standard value, | |
| 844 set the `saved-value' property to a list whose car evaluates to the | |
| 845 default value. Otherwise, set it to nil. | |
| 846 | |
| 847 To actually save the value, call `custom-save-all'. | |
| 848 | |
| 849 Return non-nil iff the `saved-value' property actually changed." | |
| 850 (let* ((get (or (get symbol 'custom-get) 'default-value)) | |
| 851 (value (funcall get symbol)) | |
| 852 (saved (get symbol 'saved-value)) | |
| 853 (standard (get symbol 'standard-value)) | |
| 854 (comment (get symbol 'customized-variable-comment))) | |
| 855 ;; Save default value iff different from standard value. | |
| 856 (if (or (null standard) | |
| 857 (not (equal value (condition-case nil | |
| 858 (eval (car standard)) | |
| 859 (error nil))))) | |
| 860 (put symbol 'saved-value (list (custom-quote value))) | |
| 861 (put symbol 'saved-value nil)) | |
| 862 ;; Clear customized information (set, but not saved). | |
| 863 (put symbol 'customized-value nil) | |
| 864 ;; Save any comment that might have been set. | |
| 865 (when comment | |
| 866 (put symbol 'saved-variable-comment comment)) | |
| 867 (not (equal saved (get symbol 'saved-value))))) | |
| 868 | |
| 869 (defun customize-mark-as-set (symbol) | |
| 870 "Mark current value of SYMBOL as being set from customize. | |
| 871 | |
| 872 If the default value of SYMBOL is different from the saved value if any, | |
| 873 or else if it is different from the standard value, set the | |
| 874 `customized-value' property to a list whose car evaluates to the | |
| 875 default value. Otherwise, set it to nil. | |
| 876 | |
| 877 Return non-nil iff the `customized-value' property actually changed." | |
| 878 (let* ((get (or (get symbol 'custom-get) 'default-value)) | |
| 879 (value (funcall get symbol)) | |
| 880 (customized (get symbol 'customized-value)) | |
| 881 (old (or (get symbol 'saved-value) (get symbol 'standard-value)))) | |
| 882 ;; Mark default value as set iff different from old value. | |
| 883 (if (or (null old) | |
| 884 (not (equal value (condition-case nil | |
| 885 (eval (car old)) | |
| 886 (error nil))))) | |
| 887 (put symbol 'customized-value (list (custom-quote value))) | |
| 888 (put symbol 'customized-value nil)) | |
| 889 ;; Changed? | |
| 890 (not (equal customized (get symbol 'customized-value))))) | |
| 891 | |
| 892 ;;; Theme Manipulation | |
| 893 | |
| 894 (defvar custom-loaded-themes nil | |
| 895 "Themes in the order they are loaded.") | |
| 896 | |
| 897 (defun custom-theme-loaded-p (theme) | |
| 898 "Return non-nil when THEME has been loaded." | |
| 899 (memq theme custom-loaded-themes)) | |
| 900 | |
| 901 (defun provide-theme (theme) | |
| 902 "Indicate that this file provides THEME. | |
| 903 Add THEME to `custom-loaded-themes' and `provide' whatever | |
| 904 is stored in THEME's property `theme-feature'. | |
| 905 | |
| 906 Usually the theme-feature property contains a symbol created | |
| 907 by `custom-make-theme-feature'." | |
| 908 (custom-check-theme theme) | |
| 909 (provide (get theme 'theme-feature)) | |
| 910 (setq custom-loaded-themes (nconc (list theme) custom-loaded-themes))) | |
| 911 | |
| 912 (defun require-theme (theme) | |
| 913 "Try to load a theme by requiring its feature. | |
| 914 THEME's feature is stored in THEME's `theme-feature' property. | |
| 915 | |
| 916 Usually the `theme-feature' property contains a symbol created | |
| 917 by `custom-make-theme-feature'." | |
| 918 ;; Note we do no check for validity of the theme here. | |
| 919 ;; This allows to pull in themes by a file-name convention | |
| 920 (require (or (get theme 'theme-feature) | |
| 921 (custom-make-theme-feature theme)))) | |
| 922 | |
| 923 (defun custom-remove-theme (spec-alist theme) | |
| 924 "Delete all elements from SPEC-ALIST whose car is THEME." | |
| 925 (let ((elt (assoc theme spec-alist))) | |
| 926 (while elt | |
| 927 (setq spec-alist (delete elt spec-alist) | |
| 928 elt (assoc theme spec-alist)))) | |
| 929 spec-alist) | |
| 930 | |
| 931 (defun custom-do-theme-reset (theme) | |
| 932 "Undo all settings defined by THEME. | |
| 933 | |
| 934 A variable remains unchanged if its property `theme-value' does not | |
| 935 contain a value for THEME. A face remains unchanged if its property | |
| 936 `theme-face' does not contain a value for THEME. In either case, all | |
| 937 settings for THEME are removed from the property and the variable or | |
| 938 face is set to the `user' theme. | |
| 428 | 939 |
| 2544 | 940 See `custom-known-themes' for a list of known themes." |
| 941 (let (spec-list) | |
| 942 (mapatoms (lambda (symbol) | |
| 943 ;; This works even if symbol is both a variable and a | |
| 944 ;; face. | |
| 945 (setq spec-list (get symbol 'theme-value)) | |
| 946 (when spec-list | |
| 947 (put symbol 'theme-value (custom-remove-theme spec-list theme)) | |
| 948 (custom-theme-reset-internal symbol 'user)) | |
| 949 (setq spec-list (get symbol 'theme-face)) | |
| 950 (when spec-list | |
| 951 (put symbol 'theme-face (custom-remove-theme spec-list theme)) | |
| 952 (custom-theme-reset-internal-face symbol 'user)))))) | |
| 953 | |
| 954 (defun custom-theme-load-themes (by-theme &rest body) | |
| 955 "Load the themes specified by BODY. | |
| 956 Record them as required by theme BY-THEME. BODY is a sequence of either | |
| 957 | |
| 958 THEME | |
| 959 BY-THEME requires THEME | |
| 960 \(reset THEME) | |
| 961 Undo all the settings made by THEME | |
| 962 \(hidden THEME) | |
| 963 Require THEME but hide it from the user | |
| 964 | |
| 965 All the themes loaded for BY-THEME are recorded in BY-THEME's property | |
| 966 `theme-loads-themes'. Any theme loaded with the hidden predicate will | |
| 967 be given the property `theme-hidden' unless it has been loaded before. | |
| 968 Whether a theme has been loaded before is determined by the function | |
| 969 `custom-theme-loaded-p'." | |
| 970 (custom-check-theme by-theme) | |
| 971 (let ((theme) | |
| 972 (themes-loaded (get by-theme 'theme-loads-themes))) | |
| 973 (while theme | |
| 974 (setq theme (car body) | |
| 975 body (cdr body)) | |
| 976 (cond ((and (consp theme) (eq (car theme) 'reset)) | |
| 977 (custom-do-theme-reset (cadr theme))) | |
| 978 ((and (consp theme) (eq (car theme) 'hidden)) | |
| 979 (require-theme (cadr theme)) | |
| 980 (unless (custom-theme-loaded-p (cadr theme)) | |
| 981 (put (cadr theme) 'theme-hidden t))) | |
| 982 (t | |
| 983 (require-theme theme) | |
| 984 (put theme 'theme-hidden nil))) | |
| 985 (setq themes-loaded (nconc (list theme) themes-loaded))) | |
| 986 (put by-theme 'theme-loads-themes themes-loaded))) | |
| 987 | |
| 988 (defun custom-load-themes (&rest body) | |
| 989 "Load themes for the USER theme as specified by BODY. | |
| 990 | |
| 991 See `custom-theme-load-themes' for more information on BODY." | |
| 992 (apply 'custom-theme-load-themes 'user body)) | |
| 993 | |
| 994 ; (defsubst copy-upto-last (elt list) | |
| 995 ; "Copy all the elements of the list upto the last occurrence of elt" | |
| 996 ; ;; Is it faster to do more work in C than to do less in elisp? | |
| 997 ; (nreverse (cdr (member elt (reverse list))))) | |
| 998 | |
| 999 (defun custom-theme-value (theme theme-spec-list) | |
| 1000 "Determine the value for THEME defined by THEME-SPEC-LIST. | |
| 1001 Returns a list with the original value if found; nil otherwise. | |
| 1002 | |
| 1003 THEME-SPEC-LIST is an alist with themes as its key. As new themes are | |
| 1004 installed, these are added to the front of THEME-SPEC-LIST. | |
| 1005 Each element has the form | |
| 1006 | |
| 1007 \(THEME MODE VALUE) | |
| 1008 | |
| 1009 MODE is either the symbol `set' or the symbol `reset'. See | |
| 1010 `custom-push-theme' for more information on the format of | |
| 1011 THEME-SPEC-LIST." | |
| 1012 ;; Note we do _NOT_ signal an error if the theme is unknown | |
| 1013 ;; it might have gone away without the user knowing. | |
| 1014 (let ((value (cdr (assoc theme theme-spec-list)))) | |
| 1015 (if value | |
| 1016 (if (eq (car value) 'set) | |
| 1017 (cdr value) | |
| 1018 (custom-theme-value (cadr value) theme-spec-list))))) | |
| 1019 | |
| 1020 (defun custom-theme-variable-value (variable theme) | |
| 1021 "Return (list value) indicating value of VARIABLE in THEME. | |
| 1022 If THEME does not define a value for VARIABLE, return nil. The value | |
| 1023 definitions per theme are stored in VARIABLE's property `theme-value'. | |
| 1024 The actual work is done by function `custom-theme-value', which see. | |
| 1025 See `custom-push-theme' for more information on how these definitions | |
| 1026 are stored." | |
| 1027 (custom-theme-value theme (get variable 'theme-value))) | |
| 1028 | |
| 1029 (defun custom-theme-reset-internal (symbol to-theme) | |
| 1030 "Reset SYMBOL to the value defined by TO-THEME. | |
| 1031 If SYMBOL is not defined in TO-THEME, reset SYMBOL to the standard | |
| 1032 value. See `custom-theme-variable-value'. The standard value is | |
| 1033 stored in SYMBOL's property `standard-value'." | |
| 1034 (let ((value (custom-theme-variable-value symbol to-theme)) | |
| 1035 was-in-theme) | |
| 1036 (setq was-in-theme value) | |
| 1037 (setq value (or value (get symbol 'standard-value))) | |
| 1038 (when value | |
| 1039 (put symbol 'saved-value was-in-theme) | |
|
4441
1d7faae1080c
Fix call to get in custom-theme-reset-internal.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4289
diff
changeset
|
1040 (if (or (get symbol 'force-value) (default-boundp symbol)) |
| 2544 | 1041 (funcall (or (get symbol 'custom-set) 'set-default) symbol |
| 1042 (eval (car value))))) | |
| 1043 value)) | |
| 1044 | |
| 1045 (defun custom-theme-reset-variables (theme &rest args) | |
| 1046 "Reset the value of the variables to values previously defined. | |
| 1047 Associate this setting with THEME. | |
| 1048 | |
| 1049 ARGS is a list of lists of the form | |
| 1050 | |
| 1051 (VARIABLE TO-THEME) | |
| 1052 | |
| 1053 This means reset VARIABLE to its value in TO-THEME." | |
| 1054 (custom-check-theme theme) | |
| 4021 | 1055 (mapcar #'(lambda (arg) |
| 1056 (apply 'custom-theme-reset-internal arg) | |
| 1057 (custom-push-theme 'theme-value (car arg) theme 'reset (cadr arg))) | |
| 2544 | 1058 args)) |
| 1059 | |
| 1060 (defun custom-reset-variables (&rest args) | |
| 1061 "Reset the value of the variables to values previously saved. | |
| 1062 This is the setting associated the `user' theme. | |
| 1063 | |
| 1064 ARGS is a list of lists of the form | |
| 1065 | |
| 1066 (VARIABLE TO-THEME) | |
| 1067 | |
| 1068 This means reset VARIABLE to its value in TO-THEME." | |
| 1069 (apply 'custom-theme-reset-variables 'user args)) | |
| 1070 | |
| 1071 ;;; The End. | |
| 1333 | 1072 |
| 1073 ;; Process the defcustoms for variables loaded before this file. | |
| 1336 | 1074 ;; `custom-declare-variable-list' is defvar'd in subr.el. Utility programs |
| 1075 ;; run from temacs that do not load subr.el should defvar it themselves. | |
| 1076 ;; (As of 21.5.11, make-docfile.el.) | |
| 1333 | 1077 (while custom-declare-variable-list |
| 1078 (apply 'custom-declare-variable (car custom-declare-variable-list)) | |
| 1079 (setq custom-declare-variable-list (cdr custom-declare-variable-list))) | |
| 1080 | |
| 428 | 1081 ;; custom.el ends here |