1 ;;; custom.el --- tools for declaring and initializing options
3 ;; Copyright (C) 1996, 1997, 1999, 2001, 2002 Free Software Foundation, Inc.
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7 ;; Keywords: help, faces
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; This file only contain the code needed to declare and initialize
29 ;; user options. The code to customize options is autoloaded from
30 ;; `cus-edit.el' and is documented in the Emacs Lisp Reference manual.
32 ;; The code implementing face declarations is in `cus-face.el'
38 (defvar custom-define-hook nil
39 ;; Customize information for this option is in `cus-edit.el'.
40 "Hook called after defining each customize option.")
42 (defvar custom-current-group-alist nil
43 "Alist of (FILE . GROUP) indicating the current group to use for FILE.")
45 ;;; The `defcustom' Macro.
47 (defun custom-initialize-default (symbol value
)
48 "Initialize SYMBOL with VALUE.
49 This will do nothing if symbol already has a default binding.
50 Otherwise, if symbol has a `saved-value' property, it will evaluate
51 the car of that and used as the default binding for symbol.
52 Otherwise, VALUE will be evaluated and used as the default binding for
54 (unless (default-boundp symbol
)
55 ;; Use the saved value if it exists, otherwise the standard setting.
56 (set-default symbol
(if (get symbol
'saved-value
)
57 (eval (car (get symbol
'saved-value
)))
60 (defun custom-initialize-set (symbol value
)
61 "Initialize SYMBOL based on VALUE.
62 If the symbol doesn't have a default binding already,
63 then set it using its `:set' function (or `set-default' if it has none).
64 The value is either the value in the symbol's `saved-value' property,
66 (unless (default-boundp symbol
)
67 (funcall (or (get symbol
'custom-set
) 'set-default
)
69 (if (get symbol
'saved-value
)
70 (eval (car (get symbol
'saved-value
)))
73 (defun custom-initialize-reset (symbol value
)
74 "Initialize SYMBOL based on VALUE.
75 Set the symbol, using its `:set' function (or `set-default' if it has none).
76 The value is either the symbol's current value
77 \(as obtained using the `:get' function), if any,
78 or the value in the symbol's `saved-value' property if any,
79 or (last of all) VALUE."
80 (funcall (or (get symbol
'custom-set
) 'set-default
)
82 (cond ((default-boundp symbol
)
83 (funcall (or (get symbol
'custom-get
) 'default-value
)
85 ((get symbol
'saved-value
)
86 (eval (car (get symbol
'saved-value
))))
90 (defun custom-initialize-changed (symbol value
)
91 "Initialize SYMBOL with VALUE.
92 Like `custom-initialize-reset', but only use the `:set' function if
93 not using the standard setting.
94 For the standard setting, use `set-default'."
95 (cond ((default-boundp symbol
)
96 (funcall (or (get symbol
'custom-set
) 'set-default
)
98 (funcall (or (get symbol
'custom-get
) 'default-value
)
100 ((get symbol
'saved-value
)
101 (funcall (or (get symbol
'custom-set
) 'set-default
)
103 (eval (car (get symbol
'saved-value
)))))
105 (set-default symbol
(eval value
)))))
107 (defun custom-declare-variable (symbol default doc
&rest args
)
108 "Like `defcustom', but SYMBOL and DEFAULT are evaluated as normal arguments.
109 DEFAULT should be an expression to evaluate to compute the default value,
110 not the default value itself."
111 ;; Remember the standard setting.
112 (put symbol
'standard-value
(list default
))
113 ;; Maybe this option was rogue in an earlier version. It no longer is.
114 (when (get symbol
'force-value
)
115 (put symbol
'force-value nil
))
117 (put symbol
'variable-documentation doc
))
118 (let ((initialize 'custom-initialize-reset
)
120 (unless (memq :group args
)
121 (custom-add-to-group (custom-current-group) symbol
'custom-variable
))
123 (let ((arg (car args
)))
124 (setq args
(cdr args
))
125 (unless (symbolp arg
)
126 (error "Junk in args %S" args
))
130 (error "Keyword %s is missing an argument" keyword
))
131 (setq args
(cdr args
))
132 (cond ((eq keyword
:initialize
)
133 (setq initialize value
))
135 (put symbol
'custom-set value
))
137 (put symbol
'custom-get value
))
138 ((eq keyword
:require
)
139 (setq requests
(cons value requests
)))
141 (put symbol
'custom-type
(purecopy value
)))
142 ((eq keyword
:options
)
143 (if (get symbol
'custom-options
)
144 ;; Slow safe code to avoid duplicates.
145 (mapc (lambda (option)
146 (custom-add-option symbol option
))
148 ;; Fast code for the common case.
149 (put symbol
'custom-options
(copy-sequence value
))))
151 (custom-handle-keyword symbol keyword value
152 'custom-variable
))))))
153 (put symbol
'custom-requests requests
)
154 ;; Do the actual initialization.
155 (funcall initialize symbol default
))
156 (setq current-load-list
(cons symbol current-load-list
))
157 (run-hooks 'custom-define-hook
)
160 (defmacro defcustom
(symbol value doc
&rest args
)
161 "Declare SYMBOL as a customizable variable that defaults to VALUE.
162 DOC is the variable documentation.
164 Neither SYMBOL nor VALUE needs to be quoted.
165 If SYMBOL is not already bound, initialize it to VALUE.
166 The remaining arguments should have the form
170 The following keywords are meaningful:
172 :type VALUE should be a widget type for editing the symbols value.
173 :options VALUE should be a list of valid members of the widget type.
174 :group VALUE should be a customization group.
175 Add SYMBOL to that group.
177 Include an external link after the documentation string for this
178 item. This is a sentence containing an active field which
179 references some other documentation.
181 There are three alternatives you can use for LINK-DATA:
183 (custom-manual INFO-NODE)
184 Link to an Info node; INFO-NODE is a string which specifies
185 the node name, as in \"(emacs)Top\". The link appears as
186 `[manual]' in the customization buffer.
188 (info-link INFO-NODE)
189 Like `custom-manual' except that the link appears in the
190 customization buffer with the Info node name.
193 Link to a web page; URL is a string which specifies the URL.
194 The link appears in the customization buffer as URL.
196 You can specify the text to use in the customization buffer by
197 adding `:tag NAME' after the first element of the LINK-DATA; for
198 example, (info-link :tag \"foo\" \"(emacs)Top\") makes a link to the
199 Emacs manual which appears in the buffer as `foo'.
201 An item can have more than one external link; however, most items
204 VALUE should be a function used to initialize the
205 variable. It takes two arguments, the symbol and value
206 given in the `defcustom' call. The default is
207 `custom-initialize-reset'.
208 :set VALUE should be a function to set the value of the symbol.
209 It takes two arguments, the symbol to set and the value to
210 give it. The default choice of function is `custom-set-default'.
211 :get VALUE should be a function to extract the value of symbol.
212 The function takes one argument, a symbol, and should return
213 the current value for that symbol. The default choice of function
214 is `custom-default-value'.
216 VALUE should be a feature symbol. If you save a value
217 for this option, then when your `.emacs' file loads the value,
218 it does (require VALUE) first.
220 VALUE should be a string specifying that the variable was
221 first introduced, or its default value was changed, in Emacs
224 Use LABEL, a string, instead of the item's name, to label the item
225 in customization menus and buffers.
227 Load file FILE (a string) before displaying this customization
228 item. Loading is done with `load-library', and only if the file is
231 Specifies that SYMBOL should be set after VARIABLE when
232 both have been customized.
234 Read the section about customization in the Emacs Lisp manual for more
236 ;; It is better not to use backquote in this file,
237 ;; because that makes a bootstrapping problem
238 ;; if you need to recompile all the Lisp files using interpreted code.
239 (nconc (list 'custom-declare-variable
245 ;;; The `defface' Macro.
247 (defmacro defface
(face spec doc
&rest args
)
248 "Declare FACE as a customizable face that defaults to SPEC.
249 FACE does not need to be quoted.
251 Third argument DOC is the face documentation.
253 If FACE has been set with `custom-set-face', set the face attributes
254 as specified by that function, otherwise set the face attributes
257 The remaining arguments should have the form
261 The following KEYWORDs are defined:
263 :group VALUE should be a customization group.
264 Add FACE to that group.
266 SPEC should be an alist of the form ((DISPLAY ATTS)...).
268 The first element of SPEC where the DISPLAY matches the frame
269 is the one that takes effect in that frame. The ATTRs in this
270 element take effect; the other elements are ignored, on that frame.
272 ATTS is a list of face attributes followed by their values:
273 (ATTR VALUE ATTR VALUE...)
275 The possible attributes are `:family', `:width', `:height', `:weight',
276 `:slant', `:underline', `:overline', `:strike-through', `:box',
277 `:foreground', `:background', `:stipple', `:inverse-video', and `:inherit'.
279 DISPLAY can either be the symbol t, which will match all frames, or an
280 alist of the form \((REQ ITEM...)...). For the DISPLAY to match a
281 FRAME, the REQ property of the frame must match one of the ITEM. The
282 following REQ are defined:
284 `type' (the value of `window-system')
285 Under X, in addition to the values `window-system' can take,
286 `motif', `lucid' and `x-toolkit' are allowed, and match when
287 the Motif toolkit, Lucid toolkit, or any X toolkit is in use.
289 `class' (the frame's color support)
290 Should be one of `color', `grayscale', or `mono'.
292 `background' (what color is used for the background text)
293 Should be one of `light' or `dark'.
295 Read the section about customization in the Emacs Lisp manual for more
297 ;; It is better not to use backquote in this file,
298 ;; because that makes a bootstrapping problem
299 ;; if you need to recompile all the Lisp files using interpreted code.
300 (nconc (list 'custom-declare-face
(list 'quote face
) spec doc
) args
))
302 ;;; The `defgroup' Macro.
304 (defun custom-current-group ()
305 (cdr (assoc load-file-name custom-current-group-alist
)))
307 (defun custom-declare-group (symbol members doc
&rest args
)
308 "Like `defgroup', but SYMBOL is evaluated as a normal argument."
310 (apply 'custom-add-to-group symbol
(car members
))
311 (setq members
(cdr members
)))
312 (put symbol
'custom-group
(nconc members
(get symbol
'custom-group
)))
314 ;; This text doesn't get into DOC.
315 (put symbol
'group-documentation
(purecopy doc
)))
317 (let ((arg (car args
)))
318 (setq args
(cdr args
))
319 (unless (symbolp arg
)
320 (error "Junk in args %S" args
))
324 (error "Keyword %s is missing an argument" keyword
))
325 (setq args
(cdr args
))
326 (cond ((eq keyword
:prefix
)
327 (put symbol
'custom-prefix value
))
329 (custom-handle-keyword symbol keyword value
331 ;; Record the group on the `current' list.
332 (let ((elt (assoc load-file-name custom-current-group-alist
)))
333 (if elt
(setcdr elt symbol
)
334 (push (cons load-file-name symbol
) custom-current-group-alist
)))
335 (run-hooks 'custom-define-hook
)
338 (defmacro defgroup
(symbol members doc
&rest args
)
339 "Declare SYMBOL as a customization group containing MEMBERS.
340 SYMBOL does not need to be quoted.
342 Third arg DOC is the group documentation.
344 MEMBERS should be an alist of the form ((NAME WIDGET)...) where
345 NAME is a symbol and WIDGET is a widget for editing that symbol.
346 Useful widgets are `custom-variable' for editing variables,
347 `custom-face' for edit faces, and `custom-group' for editing groups.
349 The remaining arguments should have the form
353 The following KEYWORDs are defined:
355 :group VALUE should be a customization group.
356 Add SYMBOL to that group.
358 :version VALUE should be a string specifying that the group was introduced
359 in Emacs version VERSION.
361 Read the section about customization in the Emacs Lisp manual for more
363 ;; It is better not to use backquote in this file,
364 ;; because that makes a bootstrapping problem
365 ;; if you need to recompile all the Lisp files using interpreted code.
366 (nconc (list 'custom-declare-group
(list 'quote symbol
) members doc
) args
))
368 (defun custom-add-to-group (group option widget
)
369 "To existing GROUP add a new OPTION of type WIDGET.
370 If there already is an entry for OPTION and WIDGET, nothing is done."
371 (let ((members (get group
'custom-group
))
372 (entry (list option widget
)))
373 (unless (member entry members
)
374 (put group
'custom-group
(nconc members
(list entry
))))))
378 (defun custom-handle-all-keywords (symbol args type
)
379 "For customization option SYMBOL, handle keyword arguments ARGS.
380 Third argument TYPE is the custom option type."
381 (unless (memq :group args
)
382 (custom-add-to-group (custom-current-group) symbol
'custom-face
))
384 (let ((arg (car args
)))
385 (setq args
(cdr args
))
386 (unless (symbolp arg
)
387 (error "Junk in args %S" args
))
391 (error "Keyword %s is missing an argument" keyword
))
392 (setq args
(cdr args
))
393 (custom-handle-keyword symbol keyword value type
)))))
395 (defun custom-handle-keyword (symbol keyword value type
)
396 "For customization option SYMBOL, handle KEYWORD with VALUE.
397 Fourth argument TYPE is the custom option type."
399 (setq value
(purecopy value
)))
400 (cond ((eq keyword
:group
)
401 (custom-add-to-group value symbol type
))
402 ((eq keyword
:version
)
403 (custom-add-version symbol value
))
405 (custom-add-link symbol value
))
407 (custom-add-load symbol value
))
409 (put symbol
'custom-tag value
))
410 ((eq keyword
:set-after
)
411 (custom-add-dependencies symbol value
))
413 (error "Unknown keyword %s" keyword
))))
415 (defun custom-add-dependencies (symbol value
)
416 "To the custom option SYMBOL, add dependencies specified by VALUE.
417 VALUE should be a list of symbols. For each symbol in that list,
418 this specifies that SYMBOL should be set after the specified symbol, if
419 both appear in constructs like `custom-set-variables'."
420 (unless (listp value
)
421 (error "Invalid custom dependency `%s'" value
))
422 (let* ((deps (get symbol
'custom-dependencies
))
425 (let ((dep (car value
)))
426 (unless (symbolp dep
)
427 (error "Invalid custom dependency `%s'" dep
))
428 (unless (memq dep new-deps
)
429 (setq new-deps
(cons dep new-deps
)))
430 (setq value
(cdr value
))))
431 (unless (eq deps new-deps
)
432 (put symbol
'custom-dependencies new-deps
))))
434 (defun custom-add-option (symbol option
)
435 "To the variable SYMBOL add OPTION.
437 If SYMBOL is a hook variable, OPTION should be a hook member.
438 For other types variables, the effect is undefined."
439 (let ((options (get symbol
'custom-options
)))
440 (unless (member option options
)
441 (put symbol
'custom-options
(cons option options
)))))
443 (defun custom-add-link (symbol widget
)
444 "To the custom option SYMBOL add the link WIDGET."
445 (let ((links (get symbol
'custom-links
)))
446 (unless (member widget links
)
447 (put symbol
'custom-links
(cons (purecopy widget
) links
)))))
449 (defun custom-add-version (symbol version
)
450 "To the custom option SYMBOL add the version VERSION."
451 (put symbol
'custom-version
(purecopy version
)))
453 (defun custom-add-load (symbol load
)
454 "To the custom option SYMBOL add the dependency LOAD.
455 LOAD should be either a library file name, or a feature name."
456 (let ((loads (get symbol
'custom-loads
)))
457 (unless (member load loads
)
458 (put symbol
'custom-loads
(cons (purecopy load
) loads
)))))
460 ;;; Loading files needed to customize a symbol.
461 ;;; This is in custom.el because menu-bar.el needs it for toggle cmds.
463 (defvar custom-load-recursion nil
464 "Hack to avoid recursive dependencies.")
466 (defun custom-load-symbol (symbol)
467 "Load all dependencies for SYMBOL."
468 (unless custom-load-recursion
469 (let ((custom-load-recursion t
)
470 (loads (get symbol
'custom-loads
))
473 (setq load
(car loads
)
475 (cond ((symbolp load
)
479 ;; Don't reload a file already loaded.
480 ((and (boundp 'preloaded-file-list
)
481 (member load preloaded-file-list
)))
482 ((assoc load load-history
))
483 ;; This was just (assoc (locate-library load) load-history)
484 ;; but has been optimized not to load locate-library
486 ((let (found (regexp (regexp-quote load
)))
487 (dolist (loaded load-history
)
488 (and (stringp (car loaded
))
489 (string-match regexp
(car loaded
))
490 (eq (locate-library load
) (car loaded
))
493 ;; Without this, we would load cus-edit recursively.
494 ;; We are still loading it when we call this,
495 ;; and it is not in load-history yet.
496 ((equal load
"cus-edit"))
504 (defvar custom-local-buffer nil
505 "Non-nil, in a Customization buffer, means customize a specific buffer.
506 If this variable is non-nil, it should be a buffer,
507 and it means customize the local bindings of that buffer.
508 This variable is a permanent local, and it normally has a local binding
509 in every Customization buffer.")
510 (put 'custom-local-buffer
'permanent-local t
)
512 (defun custom-set-variables (&rest args
)
513 "Initialize variables according to user preferences.
515 The arguments should be a list where each entry has the form:
517 (SYMBOL VALUE [NOW [REQUEST [COMMENT]]])
519 The unevaluated VALUE is stored as the saved value for SYMBOL.
520 If NOW is present and non-nil, VALUE is also evaluated and bound as
521 the default value for the SYMBOL.
522 REQUEST is a list of features we must require for SYMBOL.
523 COMMENT is a comment string about SYMBOL."
527 (let* ((sym1 (car a1
))
529 (1-then-2 (memq sym1
(get sym2
'custom-dependencies
)))
530 (2-then-1 (memq sym2
(get sym1
'custom-dependencies
))))
531 (cond ((and 1-then-2
2-then-1
)
532 (error "Circular custom dependency between `%s' and `%s'"
536 ;; Put symbols with :require last. The macro
537 ;; define-minor-mode generates a defcustom
538 ;; with a :require and a :set, where the
539 ;; setter function calls the mode function.
540 ;; Putting symbols with :require last ensures
541 ;; that the mode function will see other
542 ;; customized values rather than default
546 (let ((entry (car args
)))
548 (let* ((symbol (nth 0 entry
))
549 (value (nth 1 entry
))
551 (requests (nth 3 entry
))
552 (comment (nth 4 entry
))
555 (put symbol
'custom-requests requests
)
556 (mapc 'require requests
))
557 (setq set
(or (get symbol
'custom-set
) 'custom-set-default
))
558 (put symbol
'saved-value
(list value
))
559 (put symbol
'saved-variable-comment comment
)
560 ;; Allow for errors in the case where the setter has
561 ;; changed between versions, say, but let the user know.
564 ;; Rogue variable, set it now.
565 (put symbol
'force-value t
)
566 (funcall set symbol
(eval value
)))
567 ((default-boundp symbol
)
568 ;; Something already set this, overwrite it.
569 (funcall set symbol
(eval value
))))
571 (message "Error setting %s: %s" symbol data
)))
572 (setq args
(cdr args
))
573 (and (or now
(default-boundp symbol
))
574 (put symbol
'variable-comment comment
)))
575 ;; Old format, a plist of SYMBOL VALUE pairs.
576 (message "Warning: old format `custom-set-variables'")
579 (let ((symbol (nth 0 args
))
580 (value (nth 1 args
)))
581 (put symbol
'saved-value
(list value
)))
582 (setq args
(cdr (cdr args
)))))))
584 (defun custom-set-default (variable value
)
585 "Default :set function for a customizable variable.
586 Normally, this sets the default value of VARIABLE to VALUE,
587 but if `custom-local-buffer' is non-nil,
588 this sets the local binding in that buffer instead."
589 (if custom-local-buffer
590 (with-current-buffer custom-local-buffer
591 (set variable value
))
592 (set-default variable value
)))
594 (defun custom-quote (sexp)
595 "Quote SEXP iff it is not self quoting."
596 (if (or (memq sexp
'(t nil
))
599 (memq (car sexp
) '(lambda)))
603 ;;; (and (fboundp 'characterp)
604 ;;; (characterp sexp))
609 (defun customize-mark-to-save (symbol)
610 "Mark SYMBOL for later saving.
612 If the default value of SYMBOL is different from the standard value,
613 set the `saved-value' property to a list whose car evaluates to the
614 default value. Otherwise, set it til nil.
616 To actually save the value, call `custom-save-all'.
618 Return non-nil iff the `saved-value' property actually changed."
619 (let* ((get (or (get symbol
'custom-get
) 'default-value
))
620 (value (funcall get symbol
))
621 (saved (get symbol
'saved-value
))
622 (standard (get symbol
'standard-value
))
623 (comment (get symbol
'customized-variable-comment
)))
624 ;; Save default value iff different from standard value.
625 (if (or (null standard
)
626 (not (equal value
(condition-case nil
627 (eval (car standard
))
629 (put symbol
'saved-value
(list (custom-quote value
)))
630 (put symbol
'saved-value nil
))
631 ;; Clear customized information (set, but not saved).
632 (put symbol
'customized-value nil
)
633 ;; Save any comment that might have been set.
635 (put symbol
'saved-variable-comment comment
))
636 (not (equal saved
(get symbol
'saved-value
)))))
638 (defun customize-mark-as-set (symbol)
639 "Mark current value of SYMBOL as being set from customize.
641 If the default value of SYMBOL is different from the saved value if any,
642 or else if it is different from the standard value, set the
643 `customized-value' property to a list whose car evaluates to the
644 default value. Otherwise, set it til nil.
646 Return non-nil iff the `customized-value' property actually changed."
647 (let* ((get (or (get symbol
'custom-get
) 'default-value
))
648 (value (funcall get symbol
))
649 (customized (get symbol
'customized-value
))
650 (old (or (get symbol
'saved-value
) (get symbol
'standard-value
))))
651 ;; Mark default value as set iff different from old value.
653 (not (equal value
(condition-case nil
656 (put symbol
'customized-value
(list (custom-quote value
)))
657 (put symbol
'customized-value nil
))
659 (not (equal customized
(get symbol
'customized-value
)))))
663 ;; Process the defcustoms for variables loaded before this file.
664 (while custom-declare-variable-list
665 (apply 'custom-declare-variable
(car custom-declare-variable-list
))
666 (setq custom-declare-variable-list
(cdr custom-declare-variable-list
)))
670 ;;; custom.el ends here