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