Commit | Line | Data |
---|---|---|
d543e20b | 1 | ;;; custom.el -- Tools for declaring and initializing options. |
41487370 | 2 | ;; |
d543e20b | 3 | ;; Copyright (C) 1996, 1997 Free Software Foundation, Inc. |
41487370 | 4 | ;; |
d543e20b PA |
5 | ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> |
6 | ;; Keywords: help, faces | |
25ac13b5 | 7 | ;; Version: 1.9900 |
d543e20b PA |
8 | ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/ |
9 | ||
c2383d2d RS |
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 | |
24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
26 | ||
d543e20b | 27 | ;;; Commentary: |
41487370 | 28 | ;; |
d543e20b | 29 | ;; If you want to use this code, please visit the URL above. |
41487370 | 30 | ;; |
d543e20b PA |
31 | ;; This file only contain the code needed to declare and initialize |
32 | ;; user options. The code to customize options is autoloaded from | |
33 | ;; `cus-edit.el'. | |
41487370 | 34 | |
d543e20b | 35 | ;; The code implementing face declarations is in `cus-face.el' |
41487370 LMI |
36 | |
37 | ;;; Code: | |
38 | ||
d543e20b PA |
39 | (require 'widget) |
40 | ||
6d528fc5 PA |
41 | (define-widget-keywords :initialize :set :get :require :prefix :tag |
42 | :load :link :options :type :group) | |
43 | ||
d543e20b | 44 | |
bd042c03 PA |
45 | (defvar custom-define-hook nil |
46 | ;; Customize information for this option is in `cus-edit.el'. | |
47 | "Hook called after defining each customize option.") | |
48 | ||
d543e20b PA |
49 | ;;; The `defcustom' Macro. |
50 | ||
6d528fc5 PA |
51 | (defun custom-initialize-default (symbol value) |
52 | "Initialize SYMBOL with VALUE. | |
53 | This will do nothing if symbol already has a default binding. | |
54 | Otherwise, if symbol has a `saved-value' property, it will evaluate | |
55 | the car of that and used as the default binding for symbol. | |
56 | Otherwise, VALUE will be evaluated and used as the default binding for | |
57 | symbol." | |
bd042c03 | 58 | (unless (default-boundp symbol) |
25ac13b5 | 59 | ;; Use the saved value if it exists, otherwise the standard setting. |
d543e20b PA |
60 | (set-default symbol (if (get symbol 'saved-value) |
61 | (eval (car (get symbol 'saved-value))) | |
6d528fc5 PA |
62 | (eval value))))) |
63 | ||
64 | (defun custom-initialize-set (symbol value) | |
71bd46d2 RS |
65 | "Initialize SYMBOL based on VALUE. |
66 | If the symbol doesn't have a default binding already, | |
67 | then set it using its `:set' function (or `set-default' if it has none). | |
68 | The value is either the value in the symbol's `saved-value' property, | |
69 | if any, or VALUE." | |
6d528fc5 PA |
70 | (unless (default-boundp symbol) |
71 | (funcall (or (get symbol 'custom-set) 'set-default) | |
72 | symbol | |
73 | (if (get symbol 'saved-value) | |
74 | (eval (car (get symbol 'saved-value))) | |
75 | (eval value))))) | |
76 | ||
77 | (defun custom-initialize-reset (symbol value) | |
71bd46d2 RS |
78 | "Initialize SYMBOL based on VALUE. |
79 | Set the symbol, using its `:set' function (or `set-default' if it has none). | |
80 | The value is either the symbol's current value | |
81 | \(as obtained using the `:get' function), if any, | |
82 | or the value in the symbol's `saved-value' property if any, | |
83 | or (last of all) VALUE." | |
6d528fc5 PA |
84 | (funcall (or (get symbol 'custom-set) 'set-default) |
85 | symbol | |
86 | (cond ((default-boundp symbol) | |
87 | (funcall (or (get symbol 'custom-get) 'default-value) | |
88 | symbol)) | |
89 | ((get symbol 'saved-value) | |
90 | (eval (car (get symbol 'saved-value)))) | |
91 | (t | |
92 | (eval value))))) | |
93 | ||
94 | (defun custom-initialize-changed (symbol value) | |
95 | "Initialize SYMBOL with VALUE. | |
96 | Like `custom-initialize-reset', but only use the `:set' function if the | |
71bd46d2 RS |
97 | not using the standard setting. |
98 | For the standard setting, use the `set-default'." | |
6d528fc5 PA |
99 | (cond ((default-boundp symbol) |
100 | (funcall (or (get symbol 'custom-set) 'set-default) | |
101 | symbol | |
102 | (funcall (or (get symbol 'custom-get) 'default-value) | |
103 | symbol))) | |
104 | ((get symbol 'saved-value) | |
105 | (funcall (or (get symbol 'custom-set) 'set-default) | |
106 | symbol | |
107 | (eval (car (get symbol 'saved-value))))) | |
108 | (t | |
109 | (set-default symbol (eval value))))) | |
110 | ||
255d8b97 RS |
111 | (defun custom-declare-variable (symbol default doc &rest args) |
112 | "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments. | |
113 | DEFAULT should be an expression to evaluate to compute the default value, | |
114 | not the default value itself." | |
25ac13b5 | 115 | ;; Remember the standard setting. |
255d8b97 | 116 | (put symbol 'standard-value (list default)) |
bd042c03 PA |
117 | ;; Maybe this option was rogue in an earlier version. It no longer is. |
118 | (when (get symbol 'force-value) | |
119 | ;; It no longer is. | |
120 | (put symbol 'force-value nil)) | |
d543e20b PA |
121 | (when doc |
122 | (put symbol 'variable-documentation doc)) | |
71bd46d2 | 123 | (let ((initialize 'custom-initialize-reset) |
6d528fc5 PA |
124 | (requests nil)) |
125 | (while args | |
126 | (let ((arg (car args))) | |
d543e20b | 127 | (setq args (cdr args)) |
6d528fc5 PA |
128 | (unless (symbolp arg) |
129 | (error "Junk in args %S" args)) | |
130 | (let ((keyword arg) | |
131 | (value (car args))) | |
132 | (unless args | |
133 | (error "Keyword %s is missing an argument" keyword)) | |
134 | (setq args (cdr args)) | |
135 | (cond ((eq keyword :initialize) | |
136 | (setq initialize value)) | |
137 | ((eq keyword :set) | |
138 | (put symbol 'custom-set value)) | |
139 | ((eq keyword :get) | |
140 | (put symbol 'custom-get value)) | |
141 | ((eq keyword :require) | |
67efacf8 | 142 | (setq requests (cons value requests))) |
6d528fc5 PA |
143 | ((eq keyword :type) |
144 | (put symbol 'custom-type value)) | |
145 | ((eq keyword :options) | |
146 | (if (get symbol 'custom-options) | |
147 | ;; Slow safe code to avoid duplicates. | |
148 | (mapcar (lambda (option) | |
149 | (custom-add-option symbol option)) | |
150 | value) | |
151 | ;; Fast code for the common case. | |
152 | (put symbol 'custom-options (copy-sequence value)))) | |
153 | (t | |
154 | (custom-handle-keyword symbol keyword value | |
155 | 'custom-variable)))))) | |
156 | (put symbol 'custom-requests requests) | |
157 | ;; Do the actual initialization. | |
255d8b97 | 158 | (funcall initialize symbol default)) |
7c573adb | 159 | (setq current-load-list (cons symbol current-load-list)) |
d543e20b PA |
160 | (run-hooks 'custom-define-hook) |
161 | symbol) | |
41487370 | 162 | |
d543e20b PA |
163 | (defmacro defcustom (symbol value doc &rest args) |
164 | "Declare SYMBOL as a customizable variable that defaults to VALUE. | |
165 | DOC is the variable documentation. | |
41487370 | 166 | |
d543e20b PA |
167 | Neither SYMBOL nor VALUE needs to be quoted. |
168 | If SYMBOL is not already bound, initialize it to VALUE. | |
169 | The remaining arguments should have the form | |
41487370 | 170 | |
d543e20b | 171 | [KEYWORD VALUE]... |
41487370 | 172 | |
e612f4bd | 173 | The following keywords are meaningful: |
41487370 | 174 | |
6d528fc5 PA |
175 | :type VALUE should be a widget type for editing the symbols value. |
176 | The default is `sexp'. | |
d543e20b PA |
177 | :options VALUE should be a list of valid members of the widget type. |
178 | :group VALUE should be a customization group. | |
179 | Add SYMBOL to that group. | |
e612f4bd RS |
180 | :initialize |
181 | VALUE should be a function used to initialize the | |
6d528fc5 PA |
182 | variable. It takes two arguments, the symbol and value |
183 | given in the `defcustom' call. The default is | |
184 | `custom-initialize-default' | |
185 | :set VALUE should be a function to set the value of the symbol. | |
186 | It takes two arguments, the symbol to set and the value to | |
7ddd6031 | 187 | give it. The default choice of function is `custom-set-default'. |
6d528fc5 PA |
188 | :get VALUE should be a function to extract the value of symbol. |
189 | The function takes one argument, a symbol, and should return | |
e612f4bd | 190 | the current value for that symbol. The default choice of function |
7ddd6031 | 191 | is `custom-default-value'. |
e612f4bd RS |
192 | :require |
193 | VALUE should be a feature symbol. If you save a value | |
194 | for this option, then when your `.emacs' file loads the value, | |
195 | it does (require VALUE) first. | |
41487370 | 196 | |
305ec106 | 197 | Read the section about customization in the Emacs Lisp manual for more |
d543e20b | 198 | information." |
d7c0adec RS |
199 | ;; It is better not to use backquote in this file, |
200 | ;; because that makes a bootstrapping problem | |
201 | ;; if you need to recompile all the Lisp files using interpreted code. | |
202 | (nconc (list 'custom-declare-variable | |
203 | (list 'quote symbol) | |
204 | (list 'quote value) | |
205 | doc) | |
206 | args)) | |
41487370 | 207 | |
d543e20b | 208 | ;;; The `defface' Macro. |
41487370 | 209 | |
d543e20b PA |
210 | (defmacro defface (face spec doc &rest args) |
211 | "Declare FACE as a customizable face that defaults to SPEC. | |
212 | FACE does not need to be quoted. | |
41487370 | 213 | |
d543e20b | 214 | Third argument DOC is the face documentation. |
41487370 | 215 | |
d543e20b PA |
216 | If FACE has been set with `custom-set-face', set the face attributes |
217 | as specified by that function, otherwise set the face attributes | |
218 | according to SPEC. | |
41487370 | 219 | |
d543e20b | 220 | The remaining arguments should have the form |
41487370 | 221 | |
d543e20b | 222 | [KEYWORD VALUE]... |
41487370 | 223 | |
aafc86d2 | 224 | The following KEYWORDs are defined: |
41487370 | 225 | |
d543e20b PA |
226 | :group VALUE should be a customization group. |
227 | Add FACE to that group. | |
41487370 | 228 | |
d543e20b | 229 | SPEC should be an alist of the form ((DISPLAY ATTS)...). |
41487370 | 230 | |
aafc86d2 RS |
231 | The first element of SPEC where the DISPLAY matches the frame |
232 | is the one that takes effect in that frame. The ATTRs in this | |
233 | element take effect; the other elements are ignored, on that frame. | |
41487370 | 234 | |
aafc86d2 RS |
235 | ATTS is a list of face attributes followed by their values: |
236 | (ATTR VALUE ATTR VALUE...) | |
237 | The possible attributes are `:bold', `:italic', `:underline', | |
238 | `:foreground', `:background', `:stipple' and `:inverse-video'. | |
41487370 | 239 | |
aafc86d2 RS |
240 | DISPLAY can either be the symbol t, which will match all frames, or an |
241 | alist of the form \((REQ ITEM...)...). For the DISPLAY to match a | |
242 | FRAME, the REQ property of the frame must match one of the ITEM. The | |
243 | following REQ are defined: | |
41487370 | 244 | |
d543e20b PA |
245 | `type' (the value of `window-system') |
246 | Should be one of `x' or `tty'. | |
41487370 | 247 | |
d543e20b PA |
248 | `class' (the frame's color support) |
249 | Should be one of `color', `grayscale', or `mono'. | |
41487370 | 250 | |
d543e20b PA |
251 | `background' (what color is used for the background text) |
252 | Should be one of `light' or `dark'. | |
41487370 | 253 | |
305ec106 | 254 | Read the section about customization in the Emacs Lisp manual for more |
d543e20b | 255 | information." |
d7c0adec RS |
256 | ;; It is better not to use backquote in this file, |
257 | ;; because that makes a bootstrapping problem | |
258 | ;; if you need to recompile all the Lisp files using interpreted code. | |
259 | (nconc (list 'custom-declare-face (list 'quote face) spec doc) args)) | |
41487370 | 260 | |
d543e20b | 261 | ;;; The `defgroup' Macro. |
41487370 | 262 | |
d543e20b PA |
263 | (defun custom-declare-group (symbol members doc &rest args) |
264 | "Like `defgroup', but SYMBOL is evaluated as a normal argument." | |
6d528fc5 PA |
265 | (while members |
266 | (apply 'custom-add-to-group symbol (car members)) | |
267 | (setq members (cdr members))) | |
d543e20b PA |
268 | (put symbol 'custom-group (nconc members (get symbol 'custom-group))) |
269 | (when doc | |
270 | (put symbol 'group-documentation doc)) | |
271 | (while args | |
272 | (let ((arg (car args))) | |
273 | (setq args (cdr args)) | |
274 | (unless (symbolp arg) | |
275 | (error "Junk in args %S" args)) | |
276 | (let ((keyword arg) | |
277 | (value (car args))) | |
278 | (unless args | |
279 | (error "Keyword %s is missing an argument" keyword)) | |
280 | (setq args (cdr args)) | |
281 | (cond ((eq keyword :prefix) | |
282 | (put symbol 'custom-prefix value)) | |
283 | (t | |
284 | (custom-handle-keyword symbol keyword value | |
285 | 'custom-group)))))) | |
286 | (run-hooks 'custom-define-hook) | |
287 | symbol) | |
288 | ||
289 | (defmacro defgroup (symbol members doc &rest args) | |
290 | "Declare SYMBOL as a customization group containing MEMBERS. | |
291 | SYMBOL does not need to be quoted. | |
292 | ||
293 | Third arg DOC is the group documentation. | |
294 | ||
295 | MEMBERS should be an alist of the form ((NAME WIDGET)...) where | |
5e5e5b54 AS |
296 | NAME is a symbol and WIDGET is a widget for editing that symbol. |
297 | Useful widgets are `custom-variable' for editing variables, | |
d543e20b PA |
298 | `custom-face' for edit faces, and `custom-group' for editing groups. |
299 | ||
300 | The remaining arguments should have the form | |
301 | ||
302 | [KEYWORD VALUE]... | |
303 | ||
304 | The following KEYWORD's are defined: | |
305 | ||
306 | :group VALUE should be a customization group. | |
307 | Add SYMBOL to that group. | |
308 | ||
305ec106 | 309 | Read the section about customization in the Emacs Lisp manual for more |
d543e20b | 310 | information." |
d7c0adec RS |
311 | ;; It is better not to use backquote in this file, |
312 | ;; because that makes a bootstrapping problem | |
313 | ;; if you need to recompile all the Lisp files using interpreted code. | |
314 | (nconc (list 'custom-declare-group (list 'quote symbol) members doc) args)) | |
d543e20b PA |
315 | |
316 | (defun custom-add-to-group (group option widget) | |
317 | "To existing GROUP add a new OPTION of type WIDGET. | |
318 | If there already is an entry for that option, overwrite it." | |
319 | (let* ((members (get group 'custom-group)) | |
320 | (old (assq option members))) | |
321 | (if old | |
322 | (setcar (cdr old) widget) | |
323 | (put group 'custom-group (nconc members (list (list option widget))))))) | |
324 | ||
325 | ;;; Properties. | |
326 | ||
327 | (defun custom-handle-all-keywords (symbol args type) | |
328 | "For customization option SYMBOL, handle keyword arguments ARGS. | |
329 | Third argument TYPE is the custom option type." | |
330 | (while args | |
331 | (let ((arg (car args))) | |
332 | (setq args (cdr args)) | |
333 | (unless (symbolp arg) | |
334 | (error "Junk in args %S" args)) | |
335 | (let ((keyword arg) | |
336 | (value (car args))) | |
337 | (unless args | |
338 | (error "Keyword %s is missing an argument" keyword)) | |
339 | (setq args (cdr args)) | |
340 | (custom-handle-keyword symbol keyword value type))))) | |
341 | ||
342 | (defun custom-handle-keyword (symbol keyword value type) | |
343 | "For customization option SYMBOL, handle KEYWORD with VALUE. | |
344 | Fourth argument TYPE is the custom option type." | |
345 | (cond ((eq keyword :group) | |
346 | (custom-add-to-group value symbol type)) | |
c743cc52 KH |
347 | ((eq keyword :version) |
348 | (custom-add-version symbol value)) | |
d543e20b PA |
349 | ((eq keyword :link) |
350 | (custom-add-link symbol value)) | |
351 | ((eq keyword :load) | |
352 | (custom-add-load symbol value)) | |
353 | ((eq keyword :tag) | |
354 | (put symbol 'custom-tag value)) | |
41487370 | 355 | (t |
d543e20b PA |
356 | (error "Unknown keyword %s" symbol)))) |
357 | ||
358 | (defun custom-add-option (symbol option) | |
359 | "To the variable SYMBOL add OPTION. | |
360 | ||
361 | If SYMBOL is a hook variable, OPTION should be a hook member. | |
362 | For other types variables, the effect is undefined." | |
363 | (let ((options (get symbol 'custom-options))) | |
364 | (unless (member option options) | |
365 | (put symbol 'custom-options (cons option options))))) | |
366 | ||
367 | (defun custom-add-link (symbol widget) | |
368 | "To the custom option SYMBOL add the link WIDGET." | |
369 | (let ((links (get symbol 'custom-links))) | |
370 | (unless (member widget links) | |
371 | (put symbol 'custom-links (cons widget links))))) | |
372 | ||
c743cc52 KH |
373 | (defun custom-add-version (symbol version) |
374 | "To the custom option SYMBOL add the version VERSION." | |
375 | (put symbol 'custom-version version)) | |
376 | ||
d543e20b PA |
377 | (defun custom-add-load (symbol load) |
378 | "To the custom option SYMBOL add the dependency LOAD. | |
379 | LOAD should be either a library file name, or a feature name." | |
380 | (let ((loads (get symbol 'custom-loads))) | |
381 | (unless (member load loads) | |
382 | (put symbol 'custom-loads (cons load loads))))) | |
383 | ||
384 | ;;; Initializing. | |
385 | ||
7ddd6031 RS |
386 | (defvar custom-local-buffer nil |
387 | "Non-nil, in a Customization buffer, means customize a specific buffer. | |
388 | If this variable is non-nil, it should be a buffer, | |
389 | and it means customize the local bindings of that buffer. | |
390 | This variable is a permanent local, and it normally has a local binding | |
391 | in every Customization buffer.") | |
392 | (put 'custom-local-buffer 'permanent-local t) | |
393 | ||
d543e20b PA |
394 | (defun custom-set-variables (&rest args) |
395 | "Initialize variables according to user preferences. | |
396 | ||
397 | The arguments should be a list where each entry has the form: | |
398 | ||
399 | (SYMBOL VALUE [NOW]) | |
400 | ||
401 | The unevaluated VALUE is stored as the saved value for SYMBOL. | |
402 | If NOW is present and non-nil, VALUE is also evaluated and bound as | |
403 | the default value for the SYMBOL." | |
404 | (while args | |
405 | (let ((entry (car args))) | |
406 | (if (listp entry) | |
6d528fc5 PA |
407 | (let* ((symbol (nth 0 entry)) |
408 | (value (nth 1 entry)) | |
409 | (now (nth 2 entry)) | |
410 | (requests (nth 3 entry)) | |
98743206 KH |
411 | set) |
412 | (when requests | |
413 | (put symbol 'custom-requests requests) | |
414 | (mapcar 'require requests)) | |
415 | (setq set (or (get symbol 'custom-set) 'custom-set-default)) | |
d543e20b | 416 | (put symbol 'saved-value (list value)) |
bd042c03 PA |
417 | (cond (now |
418 | ;; Rogue variable, set it now. | |
419 | (put symbol 'force-value t) | |
6d528fc5 | 420 | (funcall set symbol (eval value))) |
bd042c03 PA |
421 | ((default-boundp symbol) |
422 | ;; Something already set this, overwrite it. | |
6d528fc5 | 423 | (funcall set symbol (eval value)))) |
d543e20b PA |
424 | (setq args (cdr args))) |
425 | ;; Old format, a plist of SYMBOL VALUE pairs. | |
bd042c03 PA |
426 | (message "Warning: old format `custom-set-variables'") |
427 | (ding) | |
428 | (sit-for 2) | |
d543e20b PA |
429 | (let ((symbol (nth 0 args)) |
430 | (value (nth 1 args))) | |
431 | (put symbol 'saved-value (list value))) | |
432 | (setq args (cdr (cdr args))))))) | |
433 | ||
7ddd6031 RS |
434 | (defun custom-set-default (variable value) |
435 | "Default :set function for a customizable variable. | |
436 | Normally, this sets the default value of VARIABLE to VALUE, | |
437 | but if `custom-local-buffer' is non-nil, | |
438 | this sets the local binding in that buffer instead." | |
439 | (if custom-local-buffer | |
440 | (with-current-buffer custom-local-buffer | |
441 | (set variable value)) | |
442 | (set-default variable value))) | |
443 | ||
d543e20b | 444 | ;;; The End. |
41487370 | 445 | |
a7d6bdac RS |
446 | ;; Process the defcustoms for variables loaded before this file. |
447 | (while custom-declare-variable-list | |
448 | (apply 'custom-declare-variable (car custom-declare-variable-list)) | |
449 | (setq custom-declare-variable-list (cdr custom-declare-variable-list))) | |
450 | ||
41487370 LMI |
451 | (provide 'custom) |
452 | ||
d543e20b | 453 | ;; custom.el ends here |