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