Commit | Line | Data |
---|---|---|
55535639 PJ |
1 | ;;; custom.el --- tools for declaring and initializing options |
2 | ;; | |
0d30b337 | 3 | ;; Copyright (C) 1996, 1997, 1999, 2001, 2002, 2003, 2004, |
aaef169d | 4 | ;; 2005, 2006 Free Software Foundation, Inc. |
55535639 PJ |
5 | ;; |
6 | ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> | |
7 | ;; Maintainer: FSF | |
8 | ;; Keywords: help, faces | |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
15 | ;; any later version. | |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
086add15 LK |
24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 | ;; Boston, MA 02110-1301, USA. | |
55535639 PJ |
26 | |
27 | ;;; Commentary: | |
28 | ;; | |
e6bb31f3 | 29 | ;; This file only contains the code needed to declare and initialize |
55535639 PJ |
30 | ;; user options. The code to customize options is autoloaded from |
31 | ;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual. | |
32 | ||
e6bb31f3 | 33 | ;; The code implementing face declarations is in `cus-face.el'. |
55535639 PJ |
34 | |
35 | ;;; Code: | |
36 | ||
37 | (require 'widget) | |
38 | ||
39 | (defvar custom-define-hook nil | |
40 | ;; Customize information for this option is in `cus-edit.el'. | |
41 | "Hook called after defining each customize option.") | |
42 | ||
6da43544 RS |
43 | (defvar custom-dont-initialize nil |
44 | "Non-nil means `defcustom' should not initialize the variable. | |
45 | That is used for the sake of `custom-make-dependencies'. | |
46 | Users should not set it.") | |
47 | ||
d3b80e9b SM |
48 | (defvar custom-current-group-alist nil |
49 | "Alist of (FILE . GROUP) indicating the current group to use for FILE.") | |
50 | ||
55535639 PJ |
51 | ;;; The `defcustom' Macro. |
52 | ||
53 | (defun custom-initialize-default (symbol value) | |
54 | "Initialize SYMBOL with VALUE. | |
55 | This will do nothing if symbol already has a default binding. | |
56 | Otherwise, if symbol has a `saved-value' property, it will evaluate | |
494bcd27 | 57 | the car of that and use it as the default binding for symbol. |
55535639 PJ |
58 | Otherwise, VALUE will be evaluated and used as the default binding for |
59 | symbol." | |
60 | (unless (default-boundp symbol) | |
61 | ;; Use the saved value if it exists, otherwise the standard setting. | |
62 | (set-default symbol (if (get symbol 'saved-value) | |
63 | (eval (car (get symbol 'saved-value))) | |
64 | (eval value))))) | |
65 | ||
66 | (defun custom-initialize-set (symbol value) | |
67 | "Initialize SYMBOL based on VALUE. | |
68 | If the symbol doesn't have a default binding already, | |
69 | then set it using its `:set' function (or `set-default' if it has none). | |
70 | The value is either the value in the symbol's `saved-value' property, | |
71 | if any, or VALUE." | |
72 | (unless (default-boundp symbol) | |
73 | (funcall (or (get symbol 'custom-set) 'set-default) | |
74 | symbol | |
75 | (if (get symbol 'saved-value) | |
76 | (eval (car (get symbol 'saved-value))) | |
77 | (eval value))))) | |
78 | ||
ff48d7e6 LT |
79 | (defun custom-initialize-safe-set (symbol value) |
80 | "Like `custom-initialize-set', but catches errors. | |
81 | If an error occurs during initialization, SYMBOL is set to nil | |
82 | and no error is thrown. This is meant for use in pre-loaded files | |
f0856b6f | 83 | where some variables or functions used to compute VALUE may not yet |
c94112bf | 84 | be defined. You can then re-evaluate VALUE in startup.el, for instance |
a042b6ae | 85 | using `custom-reevaluate-setting'." |
ff48d7e6 LT |
86 | (condition-case nil |
87 | (custom-initialize-set symbol value) | |
88 | (error (set-default symbol nil)))) | |
89 | ||
90 | (defun custom-initialize-safe-default (symbol value) | |
91 | "Like `custom-initialize-default', but catches errors. | |
92 | If an error occurs during initialization, SYMBOL is set to nil | |
93 | and no error is thrown. This is meant for use in pre-loaded files | |
f0856b6f | 94 | where some variables or functions used to compute VALUE may not yet |
c94112bf | 95 | be defined. You can then re-evaluate VALUE in startup.el, for instance |
a042b6ae | 96 | using `custom-reevaluate-setting'." |
ff48d7e6 LT |
97 | (condition-case nil |
98 | (custom-initialize-default symbol value) | |
99 | (error (set-default symbol nil)))) | |
100 | ||
55535639 PJ |
101 | (defun custom-initialize-reset (symbol value) |
102 | "Initialize SYMBOL based on VALUE. | |
103 | Set the symbol, using its `:set' function (or `set-default' if it has none). | |
104 | The value is either the symbol's current value | |
105 | \(as obtained using the `:get' function), if any, | |
106 | or the value in the symbol's `saved-value' property if any, | |
107 | or (last of all) VALUE." | |
108 | (funcall (or (get symbol 'custom-set) 'set-default) | |
109 | symbol | |
110 | (cond ((default-boundp symbol) | |
111 | (funcall (or (get symbol 'custom-get) 'default-value) | |
112 | symbol)) | |
113 | ((get symbol 'saved-value) | |
114 | (eval (car (get symbol 'saved-value)))) | |
115 | (t | |
116 | (eval value))))) | |
117 | ||
118 | (defun custom-initialize-changed (symbol value) | |
119 | "Initialize SYMBOL with VALUE. | |
120 | Like `custom-initialize-reset', but only use the `:set' function if | |
121 | not using the standard setting. | |
122 | For the standard setting, use `set-default'." | |
123 | (cond ((default-boundp symbol) | |
124 | (funcall (or (get symbol 'custom-set) 'set-default) | |
125 | symbol | |
126 | (funcall (or (get symbol 'custom-get) 'default-value) | |
127 | symbol))) | |
128 | ((get symbol 'saved-value) | |
129 | (funcall (or (get symbol 'custom-set) 'set-default) | |
130 | symbol | |
131 | (eval (car (get symbol 'saved-value))))) | |
132 | (t | |
133 | (set-default symbol (eval value))))) | |
134 | ||
135 | (defun custom-declare-variable (symbol default doc &rest args) | |
136 | "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments. | |
137 | DEFAULT should be an expression to evaluate to compute the default value, | |
e1bab181 RS |
138 | not the default value itself. |
139 | ||
8989771d | 140 | DEFAULT is stored as SYMBOL's standard value, in SYMBOL's property |
e1bab181 RS |
141 | `standard-value'. At the same time, SYMBOL's property `force-value' is |
142 | set to nil, as the value is no longer rogue." | |
55535639 PJ |
143 | (put symbol 'standard-value (list default)) |
144 | ;; Maybe this option was rogue in an earlier version. It no longer is. | |
145 | (when (get symbol 'force-value) | |
146 | (put symbol 'force-value nil)) | |
147 | (when doc | |
148 | (put symbol 'variable-documentation doc)) | |
149 | (let ((initialize 'custom-initialize-reset) | |
150 | (requests nil)) | |
d3b80e9b SM |
151 | (unless (memq :group args) |
152 | (custom-add-to-group (custom-current-group) symbol 'custom-variable)) | |
55535639 PJ |
153 | (while args |
154 | (let ((arg (car args))) | |
155 | (setq args (cdr args)) | |
156 | (unless (symbolp arg) | |
157 | (error "Junk in args %S" args)) | |
158 | (let ((keyword arg) | |
159 | (value (car args))) | |
160 | (unless args | |
161 | (error "Keyword %s is missing an argument" keyword)) | |
162 | (setq args (cdr args)) | |
163 | (cond ((eq keyword :initialize) | |
164 | (setq initialize value)) | |
165 | ((eq keyword :set) | |
166 | (put symbol 'custom-set value)) | |
167 | ((eq keyword :get) | |
168 | (put symbol 'custom-get value)) | |
169 | ((eq keyword :require) | |
6f0d61bf | 170 | (push value requests)) |
55535639 PJ |
171 | ((eq keyword :type) |
172 | (put symbol 'custom-type (purecopy value))) | |
173 | ((eq keyword :options) | |
174 | (if (get symbol 'custom-options) | |
175 | ;; Slow safe code to avoid duplicates. | |
176 | (mapc (lambda (option) | |
177 | (custom-add-option symbol option)) | |
6f0d61bf | 178 | value) |
55535639 PJ |
179 | ;; Fast code for the common case. |
180 | (put symbol 'custom-options (copy-sequence value)))) | |
181 | (t | |
182 | (custom-handle-keyword symbol keyword value | |
183 | 'custom-variable)))))) | |
184 | (put symbol 'custom-requests requests) | |
185 | ;; Do the actual initialization. | |
6da43544 RS |
186 | (unless custom-dont-initialize |
187 | (funcall initialize symbol default))) | |
80888260 | 188 | (push symbol current-load-list) |
55535639 PJ |
189 | (run-hooks 'custom-define-hook) |
190 | symbol) | |
191 | ||
192 | (defmacro defcustom (symbol value doc &rest args) | |
193 | "Declare SYMBOL as a customizable variable that defaults to VALUE. | |
194 | DOC is the variable documentation. | |
195 | ||
494bcd27 | 196 | Neither SYMBOL nor VALUE need to be quoted. |
55535639 PJ |
197 | If SYMBOL is not already bound, initialize it to VALUE. |
198 | The remaining arguments should have the form | |
199 | ||
200 | [KEYWORD VALUE]... | |
201 | ||
202 | The following keywords are meaningful: | |
203 | ||
693d0bd3 | 204 | :type VALUE should be a widget type for editing the symbol's value. |
55535639 | 205 | :options VALUE should be a list of valid members of the widget type. |
81117bdd BW |
206 | :initialize |
207 | VALUE should be a function used to initialize the | |
208 | variable. It takes two arguments, the symbol and value | |
209 | given in the `defcustom' call. The default is | |
210 | `custom-initialize-reset'. | |
211 | :set VALUE should be a function to set the value of the symbol. | |
212 | It takes two arguments, the symbol to set and the value to | |
213 | give it. The default choice of function is `custom-set-default'. | |
214 | :get VALUE should be a function to extract the value of symbol. | |
215 | The function takes one argument, a symbol, and should return | |
216 | the current value for that symbol. The default choice of function | |
217 | is `custom-default-value'. | |
218 | :require | |
219 | VALUE should be a feature symbol. If you save a value | |
220 | for this option, then when your `.emacs' file loads the value, | |
221 | it does (require VALUE) first. | |
222 | ||
223 | The following common keywords are also meaningful. | |
224 | ||
55535639 | 225 | :group VALUE should be a customization group. |
81117bdd | 226 | Add SYMBOL (or FACE with `defface') to that group. |
3dc5f18e | 227 | :link LINK-DATA |
00644b82 EZ |
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. | |
71296446 | 231 | |
11ee7d4e | 232 | There are several alternatives you can use for LINK-DATA: |
71296446 | 233 | |
3dc5f18e | 234 | (custom-manual INFO-NODE) |
00644b82 | 235 | Link to an Info node; INFO-NODE is a string which specifies |
11ee7d4e | 236 | the node name, as in \"(emacs)Top\". |
71296446 | 237 | |
3dc5f18e | 238 | (info-link INFO-NODE) |
00644b82 EZ |
239 | Like `custom-manual' except that the link appears in the |
240 | customization buffer with the Info node name. | |
71296446 | 241 | |
3dc5f18e | 242 | (url-link URL) |
00644b82 | 243 | Link to a web page; URL is a string which specifies the URL. |
11ee7d4e JL |
244 | |
245 | (emacs-commentary-link LIBRARY) | |
246 | Link to the commentary section of LIBRARY. | |
247 | ||
248 | (emacs-library-link LIBRARY) | |
249 | Link to an Emacs Lisp LIBRARY file. | |
250 | ||
251 | (file-link FILE) | |
252 | Link to FILE. | |
253 | ||
254 | (function-link FUNCTION) | |
255 | Link to the documentation of FUNCTION. | |
256 | ||
257 | (variable-link VARIABLE) | |
258 | Link to the documentation of VARIABLE. | |
259 | ||
260 | (custom-group-link GROUP) | |
261 | Link to another customization GROUP. | |
71296446 | 262 | |
00644b82 EZ |
263 | You can specify the text to use in the customization buffer by |
264 | adding `:tag NAME' after the first element of the LINK-DATA; for | |
3dc5f18e | 265 | example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the |
00644b82 | 266 | Emacs manual which appears in the buffer as `foo'. |
71296446 | 267 | |
00644b82 EZ |
268 | An item can have more than one external link; however, most items |
269 | have none at all. | |
55535639 PJ |
270 | :version |
271 | VALUE should be a string specifying that the variable was | |
272 | first introduced, or its default value was changed, in Emacs | |
273 | version VERSION. | |
4e9c705e | 274 | :package-version |
994019df | 275 | VALUE should be a list with the form (PACKAGE . VERSION) |
4e9c705e BW |
276 | specifying that the variable was first introduced, or its |
277 | default value was changed, in PACKAGE version VERSION. This | |
278 | keyword takes priority over :version. The PACKAGE and VERSION | |
279 | must appear in the alist `customize-package-emacs-version-alist'. | |
994019df BW |
280 | Since PACKAGE must be unique and the user might see it in an |
281 | error message, a good choice is the official name of the | |
282 | package, such as MH-E or Gnus. | |
00644b82 EZ |
283 | :tag LABEL |
284 | Use LABEL, a string, instead of the item's name, to label the item | |
1c1da418 | 285 | in customization menus and buffers. |
00644b82 EZ |
286 | :load FILE |
287 | Load file FILE (a string) before displaying this customization | |
29512a0f | 288 | item. Loading is done with `load', and only if the file is |
00644b82 | 289 | not already loaded. |
64e9f9d9 DL |
290 | :set-after VARIABLES |
291 | Specifies that SYMBOL should be set after the list of variables | |
292 | VARIABLES when both have been customized. | |
55535639 | 293 | |
19229e5e LT |
294 | If SYMBOL has a local binding, then this form affects the local |
295 | binding. This is normally not what you want. Thus, if you need | |
296 | to load a file defining variables with this form, or with | |
297 | `defvar' or `defconst', you should always load that file | |
298 | _outside_ any bindings for these variables. \(`defvar' and | |
299 | `defconst' behave similarly in this respect.) | |
300 | ||
81117bdd BW |
301 | See Info node `(elisp) Customization' in the Emacs Lisp manual |
302 | for more information." | |
67a60caa | 303 | (declare (doc-string 3)) |
55535639 PJ |
304 | ;; It is better not to use backquote in this file, |
305 | ;; because that makes a bootstrapping problem | |
306 | ;; if you need to recompile all the Lisp files using interpreted code. | |
307 | (nconc (list 'custom-declare-variable | |
308 | (list 'quote symbol) | |
309 | (list 'quote value) | |
310 | doc) | |
311 | args)) | |
312 | ||
313 | ;;; The `defface' Macro. | |
314 | ||
315 | (defmacro defface (face spec doc &rest args) | |
316 | "Declare FACE as a customizable face that defaults to SPEC. | |
317 | FACE does not need to be quoted. | |
318 | ||
319 | Third argument DOC is the face documentation. | |
320 | ||
2a69edce | 321 | If FACE has been set with `custom-set-faces', set the face attributes |
55535639 PJ |
322 | as specified by that function, otherwise set the face attributes |
323 | according to SPEC. | |
324 | ||
325 | The remaining arguments should have the form | |
326 | ||
327 | [KEYWORD VALUE]... | |
328 | ||
81117bdd BW |
329 | For a list of valid keywords, see the common keywords listed in |
330 | `defcustom'. | |
55535639 PJ |
331 | |
332 | SPEC should be an alist of the form ((DISPLAY ATTS)...). | |
333 | ||
9c27debd RS |
334 | In the first element, DISPLAY can be :default. The ATTS in that |
335 | element then act as defaults for all the following elements. | |
336 | ||
337 | Aside from that, DISPLAY specifies conditions to match some or | |
338 | all frames. For each frame, the first element of SPEC where the | |
339 | DISPLAY conditions are satisfied is the one that applies to that | |
340 | frame. The ATTRs in this element take effect, and the following | |
341 | elements are ignored, on that frame. | |
342 | ||
343 | In the last element, DISPLAY can be t. That element applies to a | |
344 | frame if none of the previous elements (except the :default if | |
345 | any) did. | |
55535639 PJ |
346 | |
347 | ATTS is a list of face attributes followed by their values: | |
348 | (ATTR VALUE ATTR VALUE...) | |
349 | ||
350 | The possible attributes are `:family', `:width', `:height', `:weight', | |
351 | `:slant', `:underline', `:overline', `:strike-through', `:box', | |
3d58b15e | 352 | `:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'. |
55535639 | 353 | |
9c27debd RS |
354 | DISPLAY can be `:default' (only in the first element), the symbol |
355 | t (only in the last element) to match all frames, or an alist of | |
356 | conditions of the form \(REQ ITEM...). For such an alist to | |
357 | match a frame, each of the conditions must be satisfied, meaning | |
358 | that the REQ property of the frame must match one of the | |
359 | corresponding ITEMs. These are the defined REQ values: | |
55535639 PJ |
360 | |
361 | `type' (the value of `window-system') | |
362 | Under X, in addition to the values `window-system' can take, | |
9b44aa8b JD |
363 | `motif', `lucid', `gtk' and `x-toolkit' are allowed, and match when |
364 | the Motif toolkit, Lucid toolkit, GTK toolkit or any X toolkit is in use. | |
55535639 PJ |
365 | |
366 | `class' (the frame's color support) | |
367 | Should be one of `color', `grayscale', or `mono'. | |
368 | ||
369 | `background' (what color is used for the background text) | |
370 | Should be one of `light' or `dark'. | |
371 | ||
6e166990 EZ |
372 | `min-colors' (the minimum number of colors the frame should support) |
373 | Should be an integer, it is compared with the result of | |
374 | `display-color-cells'. | |
375 | ||
ec85856c JL |
376 | `supports' (only match frames that support the specified face attributes) |
377 | Should be a list of face attributes. See the documentation for | |
378 | the function `display-supports-face-attributes-p' for more | |
379 | information on exactly how testing is done. | |
380 | ||
81117bdd BW |
381 | See Info node `(elisp) Customization' in the Emacs Lisp manual |
382 | for more information." | |
67a60caa | 383 | (declare (doc-string 3)) |
55535639 PJ |
384 | ;; It is better not to use backquote in this file, |
385 | ;; because that makes a bootstrapping problem | |
386 | ;; if you need to recompile all the Lisp files using interpreted code. | |
387 | (nconc (list 'custom-declare-face (list 'quote face) spec doc) args)) | |
388 | ||
389 | ;;; The `defgroup' Macro. | |
390 | ||
d3b80e9b SM |
391 | (defun custom-current-group () |
392 | (cdr (assoc load-file-name custom-current-group-alist))) | |
393 | ||
55535639 PJ |
394 | (defun custom-declare-group (symbol members doc &rest args) |
395 | "Like `defgroup', but SYMBOL is evaluated as a normal argument." | |
396 | (while members | |
397 | (apply 'custom-add-to-group symbol (car members)) | |
398 | (setq members (cdr members))) | |
55535639 PJ |
399 | (when doc |
400 | ;; This text doesn't get into DOC. | |
401 | (put symbol 'group-documentation (purecopy doc))) | |
402 | (while args | |
403 | (let ((arg (car args))) | |
404 | (setq args (cdr args)) | |
405 | (unless (symbolp arg) | |
406 | (error "Junk in args %S" args)) | |
407 | (let ((keyword arg) | |
408 | (value (car args))) | |
409 | (unless args | |
410 | (error "Keyword %s is missing an argument" keyword)) | |
411 | (setq args (cdr args)) | |
412 | (cond ((eq keyword :prefix) | |
413 | (put symbol 'custom-prefix value)) | |
414 | (t | |
415 | (custom-handle-keyword symbol keyword value | |
416 | 'custom-group)))))) | |
d3b80e9b SM |
417 | ;; Record the group on the `current' list. |
418 | (let ((elt (assoc load-file-name custom-current-group-alist))) | |
419 | (if elt (setcdr elt symbol) | |
420 | (push (cons load-file-name symbol) custom-current-group-alist))) | |
55535639 PJ |
421 | (run-hooks 'custom-define-hook) |
422 | symbol) | |
423 | ||
424 | (defmacro defgroup (symbol members doc &rest args) | |
425 | "Declare SYMBOL as a customization group containing MEMBERS. | |
426 | SYMBOL does not need to be quoted. | |
427 | ||
428 | Third arg DOC is the group documentation. | |
429 | ||
430 | MEMBERS should be an alist of the form ((NAME WIDGET)...) where | |
431 | NAME is a symbol and WIDGET is a widget for editing that symbol. | |
432 | Useful widgets are `custom-variable' for editing variables, | |
433 | `custom-face' for edit faces, and `custom-group' for editing groups. | |
434 | ||
435 | The remaining arguments should have the form | |
436 | ||
437 | [KEYWORD VALUE]... | |
438 | ||
81117bdd BW |
439 | For a list of valid keywords, see the common keywords listed in |
440 | `defcustom'. | |
55535639 | 441 | |
81117bdd BW |
442 | See Info node `(elisp) Customization' in the Emacs Lisp manual |
443 | for more information." | |
45aacac6 | 444 | (declare (doc-string 3)) |
55535639 PJ |
445 | ;; It is better not to use backquote in this file, |
446 | ;; because that makes a bootstrapping problem | |
447 | ;; if you need to recompile all the Lisp files using interpreted code. | |
448 | (nconc (list 'custom-declare-group (list 'quote symbol) members doc) args)) | |
449 | ||
450 | (defun custom-add-to-group (group option widget) | |
451 | "To existing GROUP add a new OPTION of type WIDGET. | |
452 | If there already is an entry for OPTION and WIDGET, nothing is done." | |
453 | (let ((members (get group 'custom-group)) | |
454 | (entry (list option widget))) | |
455 | (unless (member entry members) | |
456 | (put group 'custom-group (nconc members (list entry)))))) | |
457 | ||
29512a0f SM |
458 | (defun custom-group-of-mode (mode) |
459 | "Return the custom group corresponding to the major or minor MODE. | |
460 | If no such group is found, return nil." | |
461 | (or (get mode 'custom-mode-group) | |
462 | (if (or (get mode 'custom-group) | |
463 | (and (string-match "-mode\\'" (symbol-name mode)) | |
464 | (get (setq mode (intern (substring (symbol-name mode) | |
465 | 0 (match-beginning 0)))) | |
466 | 'custom-group))) | |
467 | mode))) | |
468 | ||
55535639 PJ |
469 | ;;; Properties. |
470 | ||
471 | (defun custom-handle-all-keywords (symbol args type) | |
472 | "For customization option SYMBOL, handle keyword arguments ARGS. | |
473 | Third argument TYPE is the custom option type." | |
d3b80e9b | 474 | (unless (memq :group args) |
9b6098b9 | 475 | (custom-add-to-group (custom-current-group) symbol type)) |
55535639 PJ |
476 | (while args |
477 | (let ((arg (car args))) | |
478 | (setq args (cdr args)) | |
479 | (unless (symbolp arg) | |
480 | (error "Junk in args %S" args)) | |
481 | (let ((keyword arg) | |
482 | (value (car args))) | |
483 | (unless args | |
484 | (error "Keyword %s is missing an argument" keyword)) | |
485 | (setq args (cdr args)) | |
486 | (custom-handle-keyword symbol keyword value type))))) | |
487 | ||
488 | (defun custom-handle-keyword (symbol keyword value type) | |
489 | "For customization option SYMBOL, handle KEYWORD with VALUE. | |
490 | Fourth argument TYPE is the custom option type." | |
491 | (if purify-flag | |
492 | (setq value (purecopy value))) | |
493 | (cond ((eq keyword :group) | |
494 | (custom-add-to-group value symbol type)) | |
495 | ((eq keyword :version) | |
496 | (custom-add-version symbol value)) | |
4e9c705e BW |
497 | ((eq keyword :package-version) |
498 | (custom-add-package-version symbol value)) | |
55535639 PJ |
499 | ((eq keyword :link) |
500 | (custom-add-link symbol value)) | |
501 | ((eq keyword :load) | |
502 | (custom-add-load symbol value)) | |
503 | ((eq keyword :tag) | |
504 | (put symbol 'custom-tag value)) | |
505 | ((eq keyword :set-after) | |
506 | (custom-add-dependencies symbol value)) | |
507 | (t | |
508 | (error "Unknown keyword %s" keyword)))) | |
509 | ||
510 | (defun custom-add-dependencies (symbol value) | |
511 | "To the custom option SYMBOL, add dependencies specified by VALUE. | |
512 | VALUE should be a list of symbols. For each symbol in that list, | |
513 | this specifies that SYMBOL should be set after the specified symbol, if | |
514 | both appear in constructs like `custom-set-variables'." | |
515 | (unless (listp value) | |
516 | (error "Invalid custom dependency `%s'" value)) | |
517 | (let* ((deps (get symbol 'custom-dependencies)) | |
518 | (new-deps deps)) | |
519 | (while value | |
520 | (let ((dep (car value))) | |
521 | (unless (symbolp dep) | |
522 | (error "Invalid custom dependency `%s'" dep)) | |
523 | (unless (memq dep new-deps) | |
524 | (setq new-deps (cons dep new-deps))) | |
525 | (setq value (cdr value)))) | |
526 | (unless (eq deps new-deps) | |
527 | (put symbol 'custom-dependencies new-deps)))) | |
e1bab181 | 528 | |
55535639 PJ |
529 | (defun custom-add-option (symbol option) |
530 | "To the variable SYMBOL add OPTION. | |
531 | ||
a4842ffa RS |
532 | If SYMBOL's custom type is a hook, OPTION should be a hook member. |
533 | If SYMBOL's custom type is an alist, OPTION specifies a symbol | |
534 | to offer to the user as a possible key in the alist. | |
535 | For other custom types, this has no effect." | |
55535639 PJ |
536 | (let ((options (get symbol 'custom-options))) |
537 | (unless (member option options) | |
538 | (put symbol 'custom-options (cons option options))))) | |
539 | ||
540 | (defun custom-add-link (symbol widget) | |
541 | "To the custom option SYMBOL add the link WIDGET." | |
542 | (let ((links (get symbol 'custom-links))) | |
543 | (unless (member widget links) | |
544 | (put symbol 'custom-links (cons (purecopy widget) links))))) | |
545 | ||
546 | (defun custom-add-version (symbol version) | |
547 | "To the custom option SYMBOL add the version VERSION." | |
548 | (put symbol 'custom-version (purecopy version))) | |
549 | ||
4e9c705e BW |
550 | (defun custom-add-package-version (symbol version) |
551 | "To the custom option SYMBOL add the package version VERSION." | |
552 | (put symbol 'custom-package-version (purecopy version))) | |
553 | ||
55535639 PJ |
554 | (defun custom-add-load (symbol load) |
555 | "To the custom option SYMBOL add the dependency LOAD. | |
556 | LOAD should be either a library file name, or a feature name." | |
557 | (let ((loads (get symbol 'custom-loads))) | |
558 | (unless (member load loads) | |
559 | (put symbol 'custom-loads (cons (purecopy load) loads))))) | |
560 | ||
1669290d MR |
561 | (defun custom-autoload (symbol load) |
562 | "Mark SYMBOL as autoloaded custom variable and add dependency LOAD." | |
563 | (put symbol 'custom-autoload t) | |
564 | (custom-add-load symbol load)) | |
565 | ||
566 | ;; This test is also in the C code of `user-variable-p'. | |
567 | (defun custom-variable-p (variable) | |
289e1999 LT |
568 | "Return non-nil if VARIABLE is a custom variable. |
569 | This recursively follows aliases." | |
570 | (setq variable (indirect-variable variable)) | |
1669290d MR |
571 | (or (get variable 'standard-value) |
572 | (get variable 'custom-autoload))) | |
573 | ||
8f772dfd RS |
574 | ;;; Loading files needed to customize a symbol. |
575 | ;;; This is in custom.el because menu-bar.el needs it for toggle cmds. | |
576 | ||
577 | (defvar custom-load-recursion nil | |
578 | "Hack to avoid recursive dependencies.") | |
579 | ||
580 | (defun custom-load-symbol (symbol) | |
581 | "Load all dependencies for SYMBOL." | |
582 | (unless custom-load-recursion | |
29512a0f | 583 | (let ((custom-load-recursion t)) |
a8c78057 RS |
584 | ;; Load these files if not already done, |
585 | ;; to make sure we know all the dependencies of SYMBOL. | |
586 | (condition-case nil | |
587 | (require 'cus-load) | |
588 | (error nil)) | |
589 | (condition-case nil | |
590 | (require 'cus-start) | |
591 | (error nil)) | |
29512a0f SM |
592 | (dolist (load (get symbol 'custom-loads)) |
593 | (cond ((symbolp load) (condition-case nil (require load) (error nil))) | |
594 | ;; This is subsumed by the test below, but it's much faster. | |
8f772dfd RS |
595 | ((assoc load load-history)) |
596 | ;; This was just (assoc (locate-library load) load-history) | |
597 | ;; but has been optimized not to load locate-library | |
598 | ;; if not necessary. | |
29512a0f SM |
599 | ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load) |
600 | "\\(\\'\\|\\.\\)")) | |
601 | (found nil)) | |
8f772dfd | 602 | (dolist (loaded load-history) |
c3891447 RS |
603 | (and (stringp (car loaded)) |
604 | (string-match regexp (car loaded)) | |
8f772dfd RS |
605 | (setq found t))) |
606 | found)) | |
607 | ;; Without this, we would load cus-edit recursively. | |
608 | ;; We are still loading it when we call this, | |
609 | ;; and it is not in load-history yet. | |
610 | ((equal load "cus-edit")) | |
29512a0f | 611 | (t (condition-case nil (load load) (error nil)))))))) |
46ce5feb | 612 | \f |
c2e2f9be CY |
613 | (defvar custom-local-buffer nil |
614 | "Non-nil, in a Customization buffer, means customize a specific buffer. | |
615 | If this variable is non-nil, it should be a buffer, | |
616 | and it means customize the local bindings of that buffer. | |
617 | This variable is a permanent local, and it normally has a local binding | |
618 | in every Customization buffer.") | |
619 | (put 'custom-local-buffer 'permanent-local t) | |
620 | ||
621 | (defun custom-set-default (variable value) | |
622 | "Default :set function for a customizable variable. | |
623 | Normally, this sets the default value of VARIABLE to VALUE, | |
624 | but if `custom-local-buffer' is non-nil, | |
625 | this sets the local binding in that buffer instead." | |
626 | (if custom-local-buffer | |
627 | (with-current-buffer custom-local-buffer | |
628 | (set variable value)) | |
629 | (set-default variable value))) | |
630 | ||
631 | (defun custom-set-minor-mode (variable value) | |
632 | ":set function for minor mode variables. | |
633 | Normally, this sets the default value of VARIABLE to nil if VALUE | |
634 | is nil and to t otherwise, | |
635 | but if `custom-local-buffer' is non-nil, | |
636 | this sets the local binding in that buffer instead." | |
637 | (if custom-local-buffer | |
638 | (with-current-buffer custom-local-buffer | |
639 | (funcall variable (if value 1 0))) | |
640 | (funcall variable (if value 1 0)))) | |
641 | ||
642 | (defun custom-quote (sexp) | |
643 | "Quote SEXP iff it is not self quoting." | |
644 | (if (or (memq sexp '(t nil)) | |
645 | (keywordp sexp) | |
646 | (and (listp sexp) | |
647 | (memq (car sexp) '(lambda))) | |
648 | (stringp sexp) | |
649 | (numberp sexp) | |
650 | (vectorp sexp) | |
651 | ;;; (and (fboundp 'characterp) | |
652 | ;;; (characterp sexp)) | |
653 | ) | |
654 | sexp | |
655 | (list 'quote sexp))) | |
656 | ||
657 | (defun customize-mark-to-save (symbol) | |
658 | "Mark SYMBOL for later saving. | |
659 | ||
660 | If the default value of SYMBOL is different from the standard value, | |
661 | set the `saved-value' property to a list whose car evaluates to the | |
662 | default value. Otherwise, set it to nil. | |
663 | ||
664 | To actually save the value, call `custom-save-all'. | |
665 | ||
666 | Return non-nil iff the `saved-value' property actually changed." | |
ec9f0a62 | 667 | (custom-load-symbol symbol) |
c2e2f9be CY |
668 | (let* ((get (or (get symbol 'custom-get) 'default-value)) |
669 | (value (funcall get symbol)) | |
670 | (saved (get symbol 'saved-value)) | |
671 | (standard (get symbol 'standard-value)) | |
672 | (comment (get symbol 'customized-variable-comment))) | |
673 | ;; Save default value iff different from standard value. | |
674 | (if (or (null standard) | |
675 | (not (equal value (condition-case nil | |
676 | (eval (car standard)) | |
677 | (error nil))))) | |
678 | (put symbol 'saved-value (list (custom-quote value))) | |
679 | (put symbol 'saved-value nil)) | |
680 | ;; Clear customized information (set, but not saved). | |
681 | (put symbol 'customized-value nil) | |
682 | ;; Save any comment that might have been set. | |
683 | (when comment | |
684 | (put symbol 'saved-variable-comment comment)) | |
685 | (not (equal saved (get symbol 'saved-value))))) | |
686 | ||
687 | (defun customize-mark-as-set (symbol) | |
688 | "Mark current value of SYMBOL as being set from customize. | |
689 | ||
690 | If the default value of SYMBOL is different from the saved value if any, | |
691 | or else if it is different from the standard value, set the | |
692 | `customized-value' property to a list whose car evaluates to the | |
693 | default value. Otherwise, set it to nil. | |
694 | ||
695 | Return non-nil iff the `customized-value' property actually changed." | |
ec9f0a62 | 696 | (custom-load-symbol symbol) |
c2e2f9be CY |
697 | (let* ((get (or (get symbol 'custom-get) 'default-value)) |
698 | (value (funcall get symbol)) | |
699 | (customized (get symbol 'customized-value)) | |
700 | (old (or (get symbol 'saved-value) (get symbol 'standard-value)))) | |
701 | ;; Mark default value as set iff different from old value. | |
702 | (if (or (null old) | |
703 | (not (equal value (condition-case nil | |
704 | (eval (car old)) | |
705 | (error nil))))) | |
fccf2784 CY |
706 | (progn (put symbol 'customized-value (list (custom-quote value))) |
707 | (custom-push-theme 'theme-value symbol 'user 'set | |
708 | (custom-quote value))) | |
c2e2f9be CY |
709 | (put symbol 'customized-value nil)) |
710 | ;; Changed? | |
711 | (not (equal customized (get symbol 'customized-value))))) | |
712 | ||
713 | (defun custom-reevaluate-setting (symbol) | |
714 | "Reset the value of SYMBOL by re-evaluating its saved or standard value. | |
715 | Use the :set function to do so. This is useful for customizable options | |
716 | that are defined before their standard value can really be computed. | |
717 | E.g. dumped variables whose default depends on run-time information." | |
718 | (funcall (or (get symbol 'custom-set) 'set-default) | |
719 | symbol | |
720 | (eval (car (or (get symbol 'saved-value) (get symbol 'standard-value)))))) | |
721 | ||
722 | \f | |
d358aa10 CY |
723 | ;;; Custom Themes |
724 | ||
725 | ;; Custom themes are collections of settings that can be enabled or | |
726 | ;; disabled as a unit. | |
727 | ||
728 | ;; Each Custom theme is defined by a symbol, called the theme name. | |
729 | ;; The `theme-settings' property of the theme name records the | |
730 | ;; variable and face settings of the theme. This property is a list | |
731 | ;; of elements, each of the form | |
732 | ;; | |
733 | ;; (PROP SYMBOL THEME VALUE) | |
734 | ;; | |
735 | ;; - PROP is either `theme-value' or `theme-face' | |
736 | ;; - SYMBOL is the face or variable name | |
737 | ;; - THEME is the theme name (redundant, but simplifies the code) | |
738 | ;; - VALUE is an expression that gives the theme's setting for SYMBOL. | |
739 | ;; | |
740 | ;; The theme name also has a `theme-feature' property, whose value is | |
741 | ;; specified when the theme is defined (see `custom-declare-theme'). | |
742 | ;; Usually, this is just a symbol named THEME-theme. This lets | |
743 | ;; external libraries call (require 'foo-theme). | |
744 | ||
745 | ;; In addition, each symbol (either a variable or a face) affected by | |
746 | ;; an *enabled* theme has a `theme-value' or `theme-face' property, | |
747 | ;; which is a list of elements each of the form | |
748 | ;; | |
749 | ;; (THEME VALUE) | |
750 | ;; | |
751 | ;; which have the same meanings as in `theme-settings'. | |
752 | ;; | |
753 | ;; The `theme-value' and `theme-face' lists are ordered by decreasing | |
754 | ;; theme precedence. Thus, the first element is always the one that | |
755 | ;; is in effect. | |
756 | ||
757 | ;; Each theme is stored in a theme file, with filename THEME-theme.el. | |
758 | ;; Loading a theme basically involves calling (load "THEME-theme") | |
759 | ;; This is done by the function `load-theme'. Loading a theme | |
760 | ;; automatically enables it. | |
761 | ;; | |
762 | ;; When a theme is enabled, the `theme-value' and `theme-face' | |
763 | ;; properties for the affected symbols are set. When a theme is | |
764 | ;; disabled, its settings are removed from the `theme-value' and | |
765 | ;; `theme-face' properties, but the theme's own `theme-settings' | |
766 | ;; property remains unchanged. | |
767 | ||
d358aa10 | 768 | (defvar custom-known-themes '(user changed) |
9c4b6e94 | 769 | "Themes that have been defined with `deftheme'. |
d358aa10 | 770 | The default value is the list (user changed). The theme `changed' |
79a0aa11 | 771 | contains the settings before custom themes are applied. The |
9b05fb22 | 772 | theme `user' contains all the settings the user customized and saved. |
e1bab181 RS |
773 | Additional themes declared with the `deftheme' macro will be added to |
774 | the front of this list.") | |
775 | ||
e1bab181 RS |
776 | (defsubst custom-theme-p (theme) |
777 | "Non-nil when THEME has been defined." | |
778 | (memq theme custom-known-themes)) | |
779 | ||
780 | (defsubst custom-check-theme (theme) | |
781 | "Check whether THEME is valid, and signal an error if it is not." | |
782 | (unless (custom-theme-p theme) | |
783 | (error "Unknown theme `%s'" theme))) | |
784 | ||
d358aa10 CY |
785 | (defun custom-push-theme (prop symbol theme mode &optional value) |
786 | "Record VALUE for face or variable SYMBOL in custom theme THEME. | |
787 | PROP is `theme-face' for a face, `theme-value' for a variable. | |
e1bab181 RS |
788 | |
789 | MODE can be either the symbol `set' or the symbol `reset'. If it is the | |
790 | symbol `set', then VALUE is the value to use. If it is the symbol | |
d358aa10 | 791 | `reset', then SYMBOL will be removed from THEME (VALUE is ignored). |
e1bab181 | 792 | |
e1bab181 | 793 | See `custom-known-themes' for a list of known themes." |
b2a41d12 | 794 | (unless (memq prop '(theme-value theme-face)) |
d820f1fb | 795 | (error "Unknown theme property")) |
46ce5feb | 796 | (let* ((old (get symbol prop)) |
d358aa10 CY |
797 | (setting (assq theme old)) ; '(theme value) |
798 | (theme-settings ; '(prop symbol theme value) | |
799 | (get theme 'theme-settings))) | |
800 | (if (eq mode 'reset) | |
d820f1fb CY |
801 | ;; Remove a setting. |
802 | (when setting | |
803 | (let (res) | |
804 | (dolist (theme-setting theme-settings) | |
805 | (if (and (eq (car theme-setting) prop) | |
806 | (eq (cadr theme-setting) symbol)) | |
807 | (setq res theme-setting))) | |
808 | (put theme 'theme-settings (delq res theme-settings))) | |
809 | (put symbol prop (delq setting old))) | |
810 | (if setting | |
811 | ;; Alter an existing setting. | |
812 | (let (res) | |
813 | (dolist (theme-setting theme-settings) | |
814 | (if (and (eq (car theme-setting) prop) | |
815 | (eq (cadr theme-setting) symbol)) | |
816 | (setq res theme-setting))) | |
817 | (put theme 'theme-settings | |
d358aa10 | 818 | (cons (list prop symbol theme value) |
d820f1fb | 819 | (delq res theme-settings))) |
d358aa10 | 820 | (setcar (cdr setting) value)) |
d820f1fb CY |
821 | ;; Add a new setting. |
822 | ;; If the user changed the value outside of Customize, we | |
d358aa10 | 823 | ;; first save the current value to a fake theme, `changed'. |
d820f1fb CY |
824 | ;; This ensures that the user-set value comes back if the |
825 | ;; theme is later disabled. | |
826 | (if (null old) | |
827 | (if (and (eq prop 'theme-value) | |
e58d8ef5 CY |
828 | (boundp symbol)) |
829 | (let ((sv (get symbol 'standard-value))) | |
830 | (when (and (null sv) (custom-variable-p symbol)) | |
831 | (custom-load-symbol symbol) | |
832 | (setq sv (get symbol 'standard-value))) | |
833 | (if (or (null sv) | |
834 | (not (equal (eval (car (get symbol 'standard-value))) | |
835 | (symbol-value symbol)))) | |
836 | (setq old (list (list 'changed (symbol-value symbol)))))) | |
e02577b7 CY |
837 | (if (and (facep symbol) |
838 | (not (face-spec-match-p symbol (get symbol 'face-defface-spec)))) | |
d358aa10 | 839 | (setq old (list (list 'changed (list |
d820f1fb | 840 | (append '(t) (custom-face-attributes-get symbol nil))))))))) |
d358aa10 | 841 | (put symbol prop (cons (list theme value) old)) |
d820f1fb | 842 | (put theme 'theme-settings |
d358aa10 | 843 | (cons (list prop symbol theme value) |
d820f1fb | 844 | theme-settings)))))) |
55535639 | 845 | |
c2e2f9be | 846 | \f |
55535639 | 847 | (defun custom-set-variables (&rest args) |
f1a262ed RS |
848 | "Install user customizations of variable values specified in ARGS. |
849 | These settings are registered as theme `user'. | |
64e9f9d9 | 850 | The arguments should each be a list of the form: |
55535639 | 851 | |
f1a262ed | 852 | (SYMBOL EXP [NOW [REQUEST [COMMENT]]]) |
55535639 | 853 | |
f1a262ed RS |
854 | This stores EXP (without evaluating it) as the saved value for SYMBOL. |
855 | If NOW is present and non-nil, then also evaluate EXP and set | |
856 | the default value for the SYMBOL to the value of EXP. | |
e1bab181 | 857 | |
f1a262ed RS |
858 | REQUEST is a list of features we must require in order to |
859 | handle SYMBOL properly. | |
55535639 | 860 | COMMENT is a comment string about SYMBOL." |
e1bab181 RS |
861 | (apply 'custom-theme-set-variables 'user args)) |
862 | ||
863 | (defun custom-theme-set-variables (theme &rest args) | |
f1a262ed RS |
864 | "Initialize variables for theme THEME according to settings in ARGS. |
865 | Each of the arguments in ARGS should be a list of this form: | |
e1bab181 | 866 | |
f1a262ed | 867 | (SYMBOL EXP [NOW [REQUEST [COMMENT]]]) |
e1bab181 | 868 | |
f1a262ed RS |
869 | This stores EXP (without evaluating it) as the saved value for SYMBOL. |
870 | If NOW is present and non-nil, then also evaluate EXP and set | |
871 | the default value for the SYMBOL to the value of EXP. | |
e1bab181 | 872 | |
f1a262ed RS |
873 | REQUEST is a list of features we must require in order to |
874 | handle SYMBOL properly. | |
e1bab181 RS |
875 | COMMENT is a comment string about SYMBOL. |
876 | ||
f1a262ed | 877 | EXP itself is saved unevaluated as SYMBOL property `saved-value' and |
e1bab181 RS |
878 | in SYMBOL's list property `theme-value' \(using `custom-push-theme')." |
879 | (custom-check-theme theme) | |
059290d6 SM |
880 | (setq args |
881 | (sort args | |
882 | (lambda (a1 a2) | |
883 | (let* ((sym1 (car a1)) | |
884 | (sym2 (car a2)) | |
885 | (1-then-2 (memq sym1 (get sym2 'custom-dependencies))) | |
886 | (2-then-1 (memq sym2 (get sym1 'custom-dependencies)))) | |
887 | (cond ((and 1-then-2 2-then-1) | |
888 | (error "Circular custom dependency between `%s' and `%s'" | |
889 | sym1 sym2)) | |
890 | (2-then-1 nil) | |
b6790c3e SM |
891 | ;; Put minor modes and symbols with :require last. |
892 | ;; Putting minor modes last ensures that the mode | |
893 | ;; function will see other customized values rather | |
894 | ;; than default values. | |
895 | (t (or (nth 3 a2) | |
896 | (eq (get sym2 'custom-set) | |
897 | 'custom-set-minor-mode)))))))) | |
059290d6 SM |
898 | (while args |
899 | (let ((entry (car args))) | |
900 | (if (listp entry) | |
901 | (let* ((symbol (indirect-variable (nth 0 entry))) | |
902 | (value (nth 1 entry)) | |
903 | (now (nth 2 entry)) | |
904 | (requests (nth 3 entry)) | |
905 | (comment (nth 4 entry)) | |
906 | set) | |
907 | (when requests | |
908 | (put symbol 'custom-requests requests) | |
909 | (mapc 'require requests)) | |
910 | (setq set (or (get symbol 'custom-set) 'custom-set-default)) | |
911 | (put symbol 'saved-value (list value)) | |
912 | (put symbol 'saved-variable-comment comment) | |
913 | (custom-push-theme 'theme-value symbol theme 'set value) | |
914 | ;; Allow for errors in the case where the setter has | |
55535639 PJ |
915 | ;; changed between versions, say, but let the user know. |
916 | (condition-case data | |
917 | (cond (now | |
918 | ;; Rogue variable, set it now. | |
919 | (put symbol 'force-value t) | |
920 | (funcall set symbol (eval value))) | |
921 | ((default-boundp symbol) | |
922 | ;; Something already set this, overwrite it. | |
923 | (funcall set symbol (eval value)))) | |
71296446 | 924 | (error |
55535639 | 925 | (message "Error setting %s: %s" symbol data))) |
059290d6 SM |
926 | (setq args (cdr args)) |
927 | (and (or now (default-boundp symbol)) | |
928 | (put symbol 'variable-comment comment))) | |
929 | ;; Old format, a plist of SYMBOL VALUE pairs. | |
930 | (message "Warning: old format `custom-set-variables'") | |
931 | (ding) | |
932 | (sit-for 2) | |
933 | (let ((symbol (indirect-variable (nth 0 args))) | |
934 | (value (nth 1 args))) | |
935 | (put symbol 'saved-value (list value)) | |
936 | (custom-push-theme 'theme-value symbol theme 'set value)) | |
937 | (setq args (cdr (cdr args))))))) | |
55535639 | 938 | |
46ce5feb RS |
939 | \f |
940 | ;;; Defining themes. | |
941 | ||
d358aa10 CY |
942 | ;; A theme file should be named `THEME-theme.el' (where THEME is the theme |
943 | ;; name), and found in either `custom-theme-directory' or the load path. | |
944 | ;; It has the following format: | |
945 | ;; | |
946 | ;; (deftheme THEME | |
947 | ;; DOCSTRING) | |
948 | ;; | |
949 | ;; (custom-theme-set-variables | |
950 | ;; 'THEME | |
951 | ;; [THEME-VARIABLES]) | |
952 | ;; | |
953 | ;; (custom-theme-set-faces | |
954 | ;; 'THEME | |
955 | ;; [THEME-FACES]) | |
956 | ;; | |
957 | ;; (provide-theme 'THEME) | |
46ce5feb | 958 | |
46ce5feb | 959 | |
d358aa10 CY |
960 | ;; The IGNORED arguments to deftheme come from the XEmacs theme code, where |
961 | ;; they were used to supply keyword-value pairs like `:immediate', | |
962 | ;; `:variable-reset-string', etc. We don't use any of these, so ignore them. | |
6d912ee1 | 963 | |
d358aa10 CY |
964 | (defmacro deftheme (theme &optional doc &rest ignored) |
965 | "Declare THEME to be a Custom theme. | |
966 | The optional argument DOC is a doc string describing the theme. | |
46ce5feb RS |
967 | |
968 | Any theme `foo' should be defined in a file called `foo-theme.el'; | |
969 | see `custom-make-theme-feature' for more information." | |
970 | (let ((feature (custom-make-theme-feature theme))) | |
971 | ;; It is better not to use backquote in this file, | |
972 | ;; because that makes a bootstrapping problem | |
973 | ;; if you need to recompile all the Lisp files using interpreted code. | |
d358aa10 | 974 | (list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc))) |
46ce5feb | 975 | |
d358aa10 | 976 | (defun custom-declare-theme (theme feature &optional doc &rest ignored) |
46ce5feb | 977 | "Like `deftheme', but THEME is evaluated as a normal argument. |
d358aa10 CY |
978 | FEATURE is the feature this theme provides. Normally, this is a symbol |
979 | created from THEME by `custom-make-theme-feature'." | |
980 | (if (memq theme '(user changed)) | |
981 | (error "Custom theme cannot be named %S" theme)) | |
46ce5feb RS |
982 | (add-to-list 'custom-known-themes theme) |
983 | (put theme 'theme-feature feature) | |
d358aa10 | 984 | (when doc (put theme 'theme-documentation doc))) |
46ce5feb RS |
985 | |
986 | (defun custom-make-theme-feature (theme) | |
987 | "Given a symbol THEME, create a new symbol by appending \"-theme\". | |
988 | Store this symbol in the `theme-feature' property of THEME. | |
989 | Calling `provide-theme' to provide THEME actually puts `THEME-theme' | |
990 | into `features'. | |
991 | ||
992 | This allows for a file-name convention for autoloading themes: | |
993 | Every theme X has a property `provide-theme' whose value is \"X-theme\". | |
87d737ae | 994 | \(load-theme X) then attempts to load the file `X-theme.el'." |
46ce5feb RS |
995 | (intern (concat (symbol-name theme) "-theme"))) |
996 | \f | |
997 | ;;; Loading themes. | |
998 | ||
9c4b6e94 LT |
999 | (defcustom custom-theme-directory |
1000 | (if (eq system-type 'ms-dos) | |
1001 | ;; MS-DOS cannot have initial dot. | |
1002 | "~/_emacs.d/" | |
1003 | "~/.emacs.d/") | |
1004 | "Directory in which Custom theme files should be written. | |
87d737ae | 1005 | `load-theme' searches this directory in addition to load-path. |
9c4b6e94 LT |
1006 | The command `customize-create-theme' writes the files it produces |
1007 | into this directory." | |
1008 | :type 'string | |
1009 | :group 'customize | |
1010 | :version "22.1") | |
1011 | ||
e1bab181 | 1012 | (defun provide-theme (theme) |
d358aa10 CY |
1013 | "Indicate that this file provides THEME. |
1014 | This calls `provide' to provide the feature name stored in THEME's | |
1015 | property `theme-feature' (which is usually a symbol created by | |
1016 | `custom-make-theme-feature')." | |
1017 | (if (memq theme '(user changed)) | |
1018 | (error "Custom theme cannot be named %S" theme)) | |
e1bab181 RS |
1019 | (custom-check-theme theme) |
1020 | (provide (get theme 'theme-feature)) | |
d358aa10 | 1021 | ;; Loading a theme also enables it. |
46ce5feb RS |
1022 | (push theme custom-enabled-themes) |
1023 | ;; `user' must always be the highest-precedence enabled theme. | |
1024 | ;; Make that remain true. (This has the effect of making user settings | |
1025 | ;; override the ones just loaded, too.) | |
d358aa10 CY |
1026 | (let ((custom-enabling-themes t)) |
1027 | (enable-theme 'user))) | |
e1bab181 | 1028 | |
87d737ae | 1029 | (defun load-theme (theme) |
73e60f53 | 1030 | "Load a theme's settings from its file. |
87d737ae | 1031 | This also enables the theme; use `disable-theme' to disable it." |
e1bab181 RS |
1032 | ;; Note we do no check for validity of the theme here. |
1033 | ;; This allows to pull in themes by a file-name convention | |
87d737ae | 1034 | (interactive "SCustom theme name: ") |
73e60f53 CY |
1035 | ;; If reloading, clear out the old theme settings. |
1036 | (when (custom-theme-p theme) | |
1037 | (disable-theme theme) | |
1038 | (put theme 'theme-settings nil) | |
1039 | (put theme 'theme-feature nil) | |
1040 | (put theme 'theme-documentation nil)) | |
9c4b6e94 LT |
1041 | (let ((load-path (if (file-directory-p custom-theme-directory) |
1042 | (cons custom-theme-directory load-path) | |
1043 | load-path))) | |
d358aa10 | 1044 | (load (symbol-name (custom-make-theme-feature theme))))) |
46ce5feb RS |
1045 | \f |
1046 | ;;; Enabling and disabling loaded themes. | |
1047 | ||
b2a41d12 CY |
1048 | (defvar custom-enabling-themes nil) |
1049 | ||
87d737ae | 1050 | (defun enable-theme (theme) |
46ce5feb RS |
1051 | "Reenable all variable and face settings defined by THEME. |
1052 | The newly enabled theme gets the highest precedence (after `user'). | |
e335f09e CY |
1053 | If it is already enabled, just give it highest precedence (after `user'). |
1054 | ||
d358aa10 CY |
1055 | If THEME does not specify any theme settings, this tries to load |
1056 | the theme from its theme file, by calling `load-theme'." | |
87d737ae | 1057 | (interactive "SEnable Custom theme: ") |
d358aa10 CY |
1058 | (if (not (custom-theme-p theme)) |
1059 | (load-theme theme) | |
1060 | ;; This could use a bit of optimization -- cyd | |
1061 | (let ((settings (get theme 'theme-settings))) | |
1062 | (dolist (s settings) | |
1063 | (let* ((prop (car s)) | |
1064 | (symbol (cadr s)) | |
1065 | (spec-list (get symbol prop))) | |
1066 | (put symbol prop (cons (cddr s) (assq-delete-all theme spec-list))) | |
1067 | (if (eq prop 'theme-value) | |
1068 | (custom-theme-recalc-variable symbol) | |
1069 | (custom-theme-recalc-face symbol))))) | |
1070 | (unless (eq theme 'user) | |
1071 | (setq custom-enabled-themes | |
1072 | (cons theme (delq theme custom-enabled-themes))) | |
1073 | (unless custom-enabling-themes | |
1074 | (enable-theme 'user))))) | |
b2a41d12 CY |
1075 | |
1076 | (defcustom custom-enabled-themes nil | |
1077 | "List of enabled Custom Themes, highest precedence first. | |
1078 | ||
1079 | This does not include the `user' theme, which is set by Customize, | |
1080 | and always takes precedence over other Custom Themes." | |
1081 | :group 'customize | |
1082 | :type '(repeat symbol) | |
1083 | :set (lambda (symbol themes) | |
1084 | ;; Avoid an infinite loop when custom-enabled-themes is | |
1085 | ;; defined in a theme (e.g. `user'). Enabling the theme sets | |
1086 | ;; custom-enabled-themes, which enables the theme... | |
1087 | (unless custom-enabling-themes | |
d358aa10 | 1088 | (let ((custom-enabling-themes t) failures) |
b2a41d12 CY |
1089 | (setq themes (delq 'user (delete-dups themes))) |
1090 | (if (boundp symbol) | |
1091 | (dolist (theme (symbol-value symbol)) | |
1092 | (if (not (memq theme themes)) | |
1093 | (disable-theme theme)))) | |
1094 | (dolist (theme (reverse themes)) | |
d358aa10 | 1095 | (condition-case nil |
b2a41d12 | 1096 | (enable-theme theme) |
d358aa10 CY |
1097 | (error (progn (push theme failures) |
1098 | (setq themes (delq theme themes)))))) | |
b2a41d12 | 1099 | (enable-theme 'user) |
d358aa10 CY |
1100 | (custom-set-default symbol themes) |
1101 | (if failures | |
1102 | (message "Failed to enable themes: %s" | |
1103 | (mapconcat 'symbol-name failures " "))))))) | |
b2a41d12 | 1104 | |
d358aa10 | 1105 | (defsubst custom-theme-enabled-p (theme) |
b2a41d12 CY |
1106 | "Return non-nil if THEME is enabled." |
1107 | (memq theme custom-enabled-themes)) | |
46ce5feb | 1108 | |
87d737ae | 1109 | (defun disable-theme (theme) |
46ce5feb | 1110 | "Disable all variable and face settings defined by THEME. |
b2a41d12 | 1111 | See `custom-enabled-themes' for a list of enabled themes." |
d358aa10 CY |
1112 | (interactive (list (intern |
1113 | (completing-read | |
1114 | "Disable Custom theme: " | |
1115 | (mapcar 'symbol-name custom-enabled-themes) | |
1116 | nil t)))) | |
1117 | (when (custom-theme-enabled-p theme) | |
8913f945 RS |
1118 | (let ((settings (get theme 'theme-settings))) |
1119 | (dolist (s settings) | |
1120 | (let* ((prop (car s)) | |
1121 | (symbol (cadr s)) | |
1122 | (spec-list (get symbol prop))) | |
1123 | (put symbol prop (assq-delete-all theme spec-list)) | |
1124 | (if (eq prop 'theme-value) | |
1125 | (custom-theme-recalc-variable symbol) | |
b2a41d12 CY |
1126 | (custom-theme-recalc-face symbol))))) |
1127 | (setq custom-enabled-themes | |
1128 | (delq theme custom-enabled-themes)))) | |
46ce5feb | 1129 | |
46ce5feb RS |
1130 | (defun custom-variable-theme-value (variable) |
1131 | "Return (list VALUE) indicating the custom theme value of VARIABLE. | |
1132 | That is to say, it specifies what the value should be according to | |
1133 | currently enabled custom themes. | |
1134 | ||
1135 | This function returns nil if no custom theme specifies a value for VARIABLE." | |
1136 | (let* ((theme-value (get variable 'theme-value))) | |
1137 | (if theme-value | |
d358aa10 | 1138 | (cdr (car theme-value))))) |
46ce5feb | 1139 | |
46ce5feb RS |
1140 | (defun custom-theme-recalc-variable (variable) |
1141 | "Set VARIABLE according to currently enabled custom themes." | |
1142 | (let ((valspec (custom-variable-theme-value variable))) | |
d358aa10 CY |
1143 | (if valspec |
1144 | (put variable 'saved-value valspec) | |
46ce5feb | 1145 | (setq valspec (get variable 'standard-value))) |
d358aa10 CY |
1146 | (if (and valspec |
1147 | (or (get variable 'force-value) | |
1148 | (default-boundp variable))) | |
1149 | (funcall (or (get variable 'custom-set) 'set-default) variable | |
1150 | (eval (car valspec)))))) | |
46ce5feb RS |
1151 | |
1152 | (defun custom-theme-recalc-face (face) | |
1153 | "Set FACE according to currently enabled custom themes." | |
b2a41d12 CY |
1154 | (if (facep face) |
1155 | (let ((theme-faces (reverse (get face 'theme-face)))) | |
1156 | (dolist (spec theme-faces) | |
d358aa10 | 1157 | (face-spec-set face (cadr spec)))))) |
46ce5feb | 1158 | \f |
d358aa10 CY |
1159 | ;;; XEmacs compability functions |
1160 | ||
1161 | ;; In XEmacs, when you reset a Custom Theme, you have to specify the | |
1162 | ;; theme to reset it to. We just apply the next available theme, so | |
1163 | ;; just ignore the IGNORED arguments. | |
1164 | ||
e1bab181 | 1165 | (defun custom-theme-reset-variables (theme &rest args) |
d358aa10 | 1166 | "Reset some variable settings in THEME to their values in other themes. |
46ce5feb | 1167 | Each of the arguments ARGS has this form: |
e1bab181 | 1168 | |
d358aa10 | 1169 | (VARIABLE IGNORED) |
e1bab181 | 1170 | |
7e8b9dc3 | 1171 | This means reset VARIABLE. (The argument IGNORED is ignored)." |
e1bab181 | 1172 | (custom-check-theme theme) |
46ce5feb | 1173 | (dolist (arg args) |
d358aa10 | 1174 | (custom-push-theme 'theme-value (car arg) theme 'reset))) |
e1bab181 RS |
1175 | |
1176 | (defun custom-reset-variables (&rest args) | |
d358aa10 | 1177 | "Reset the specs of some variables to their values in other themes. |
46ce5feb | 1178 | This creates settings in the `user' theme. |
e1bab181 | 1179 | |
46ce5feb | 1180 | Each of the arguments ARGS has this form: |
e1bab181 | 1181 | |
d358aa10 | 1182 | (VARIABLE IGNORED) |
e1bab181 | 1183 | |
7e8b9dc3 | 1184 | This means reset VARIABLE. (The argument IGNORED is ignored)." |
e1bab181 RS |
1185 | (apply 'custom-theme-reset-variables 'user args)) |
1186 | ||
55535639 PJ |
1187 | ;;; The End. |
1188 | ||
1189 | ;; Process the defcustoms for variables loaded before this file. | |
1190 | (while custom-declare-variable-list | |
1191 | (apply 'custom-declare-variable (car custom-declare-variable-list)) | |
1192 | (setq custom-declare-variable-list (cdr custom-declare-variable-list))) | |
1193 | ||
1194 | (provide 'custom) | |
1195 | ||
059290d6 | 1196 | ;; arch-tag: 041b6116-aabe-4f9a-902d-74092bc3dab2 |
55535639 | 1197 | ;;; custom.el ends here |