Document new mouse-highlight variable and associated behaviour.
[bpt/emacs.git] / lisp / cus-start.el
CommitLineData
1cd7adc6 1;;; cus-start.el --- define customization properties of builtins
1444b0c0 2;;
e369c773 3;; Copyright (C) 1997, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
1444b0c0
PA
4;;
5;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6;; Keywords: internal
7
c2383d2d
RS
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
12;; the Free Software Foundation; either version 2, or (at your option)
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs; see the file COPYING. If not, write to the
22;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23;; Boston, MA 02111-1307, USA.
24
1444b0c0
PA
25;;; Commentary:
26;;
4883633e 27;; This file adds customize support for built-in variables.
1444b0c0 28
4883633e
RS
29;; While dumping Emacs, this file is loaded, but it only records
30;; the standard values; it does not do the rest of the job.
31;; Later on, if the user makes a customization buffer,
32;; this file is loaded again with (require 'cus-start);
33;; then it does the whole job.
1444b0c0 34
4883633e 35;;; Code:
1444b0c0
PA
36
37(let ((all '(;; abbrev.c
38 (abbrev-all-caps abbrev-mode boolean)
39 (pre-abbrev-expand-hook abbrev-mode hook)
40 ;; alloc.c
41 (gc-cons-threshold alloc integer)
42 (undo-limit undo integer)
43 (undo-strong-limit undo integer)
44 (garbage-collection-messages alloc boolean)
45 ;; buffer.c
46 (mode-line-format modeline sexp) ;Hard to do right.
47 (default-major-mode internal function)
924ef223 48 (enable-multibyte-characters mule boolean)
1444b0c0
PA
49 (case-fold-search matching boolean)
50 (fill-column fill integer)
51 (left-margin fill integer)
52 (tab-width editing-basics integer)
53 (ctl-arrow display boolean)
54 (truncate-lines display boolean)
1444b0c0
PA
55 (selective-display-ellipses display boolean)
56 (transient-mark-mode editing-basics boolean)
37328bcd
DL
57 (indicate-empty-lines display boolean "21.1")
58 (scroll-up-aggressively windows boolean "21.1")
59 (scroll-down-aggressively windows boolean "21.1")
1444b0c0
PA
60 ;; callint.c
61 (mark-even-if-inactive editing-basics boolean)
62 ;; callproc.c
63 (shell-file-name execute file)
64 (exec-path execute
65 (repeat (choice (const :tag "default" nil)
66 (file :format "%v"))))
5fc9eb7c
DL
67 ;; coding.c
68 (inhibit-eol-conversion mule boolean)
de0d1fc5
EZ
69 (eol-mnemonic-undecided mule string)
70 (eol-mnemonic-unix mule string)
71 (eol-mnemonic-dos mule string)
72 (eol-mnemonic-mac mule string)
13eb63ff
DL
73 (file-coding-system-alist
74 mule
75 (alist
76 :key-type (regexp :tag "File regexp")
77 :value-type (choice
78 :value (undecided . undecided)
79 (cons :tag "Encoding/decoding pair"
80 :value (undecided . undecided)
81 (coding-system :tag "Decoding")
82 (coding-system :tag "Encoding"))
83 (coding-system :tag "Single coding system"
84 :value undecided)
85 (function :value ignore))))
1444b0c0
PA
86 ;; dired.c
87 (completion-ignored-extensions dired
88 (repeat (string :format "%v")))
0849a37e 89 ;; dispnew.c
1444b0c0
PA
90 (baud-rate display integer)
91 (inverse-video display boolean)
92 (visible-bell display boolean)
93 (no-redraw-on-reenter display boolean)
94 ;; editfns.c
95 (user-full-name mail string)
96 ;; eval.c
97 (max-specpdl-size limits integer)
98 (max-lisp-eval-depth limits integer)
99 (stack-trace-on-error debug
100 (choice (const :tag "off")
101 (repeat :menu-tag "When"
102 :value (nil)
103 (symbol :format "%v"))
104 (const :tag "always" t)))
105 (debug-on-error debug
106 (choice (const :tag "off")
107 (repeat :menu-tag "When"
108 :value (nil)
109 (symbol :format "%v"))
110 (const :tag "always" t)))
111 (debug-ignored-errors debug (repeat (choice symbol regexp)))
507c9247
RS
112 (debug-on-quit debug
113 (choice (const :tag "off")
114 (repeat :menu-tag "When"
115 :value (nil)
116 (symbol :format "%v"))
117 (const :tag "always" t)))
1444b0c0
PA
118 ;; fileio.c
119 (insert-default-directory minibuffer boolean)
78976e0a 120 ;; fns.c
37328bcd 121 (use-dialog-box menu boolean "21.1")
1444b0c0
PA
122 ;; frame.c
123 (default-frame-alist frames
124 (repeat (cons :format "%v"
125 (symbol :tag "Parameter")
126 (sexp :tag "Value"))))
127 ;; indent.c
128 (indent-tabs-mode fill boolean)
129 ;; keyboard.c
130 (meta-prefix-char keyboard character)
131 (auto-save-interval auto-save integer)
132 (auto-save-timeout auto-save (choice (const :tag "off" nil)
133 (integer :format "%v")))
ac1b1728 134 (echo-keystrokes minibuffer number)
1444b0c0 135 (polling-period keyboard integer)
4db2b1c7
RS
136 (double-click-time mouse (restricted-sexp
137 :match-alternatives (integerp 'nil 't)))
1444b0c0
PA
138 (inhibit-local-menu-bar-menus menu boolean)
139 (help-char keyboard character)
140 (help-event-list keyboard (repeat (sexp :format "%v")))
141 (menu-prompting menu boolean)
1444b0c0
PA
142 (suggest-key-bindings keyboard (choice (const :tag "off" nil)
143 (integer :tag "time" 2)
79221864 144 (other :tag "on")))
5f537e54 145
37328bcd
DL
146;; This is not good news because it will use the wrong
147;; version-specific directories when you upgrade. We need
148;; customization of the front of the list, maintaining the standard
149;; value intact at the back.
150;;; (load-path environment
151;;; (repeat (choice :tag "[Current dir?]"
152;;; :format "%[Current dir?%] %v"
153;;; (const :tag " current dir" nil)
154;;; (directory :format "%v"))))
1444b0c0
PA
155 ;; minibuf.c
156 (completion-auto-help minibuffer boolean)
157 (enable-recursive-minibuffers minibuffer boolean)
408f56b2
RS
158 (history-length minibuffer
159 (choice (const :tag "Infinite" t)
160 integer))
8f62f2b8
MB
161 (minibuffer-prompt-properties
162 minibuffer
163 (list
164 (checklist :inline t
165 (const :tag "Read-Only"
166 :doc "Prevent prompt from being modified"
167 :format "%t%n%h"
168 :inline t
169 (read-only t))
170 (const :tag "Inviolable"
171 :doc "Prevent point from ever entering prompt"
172 :format "%t%n%h"
173 :inline t
174 (point-entered minibuffer-avoid-prompt)))
175 (repeat :inline t
176 :tag "Other Properties"
177 (list :inline t
178 :format "%v"
179 (symbol :tag "Property")
ecf5279a
DL
180 (sexp :tag "Value"))))
181 "21.1")
1444b0c0 182 (minibuffer-auto-raise minibuffer boolean)
ecf5279a 183 ;; options property set at end
a8a1b05d
DL
184 (read-buffer-function minibuffer
185 (choice (const nil)
186 (function-item iswitchb-read-buffer)
187 function))
b78fba02
EZ
188 ;; msdos.c
189 (dos-unsupported-char-glyph display integer)
1444b0c0 190 ;; process.c
4883633e 191 (delete-exited-processes processes-basics boolean)
1444b0c0
PA
192 ;; syntax.c
193 (parse-sexp-ignore-comments editing-basics boolean)
194 (words-include-escapes editing-basics boolean)
195 ;; window.c
4cb464b7
DL
196 (temp-buffer-show-function windows (choice (const nil) function))
197 (display-buffer-function windows (choice (const nil) function))
1444b0c0
PA
198 (pop-up-frames frames boolean)
199 (pop-up-frame-function frames function)
200 (special-display-buffer-names
201 frames
202 (repeat (choice :tag "Buffer"
203 :value ""
204 (string :format "%v")
205 (cons :tag "With attributes"
206 :format "%v"
207 :value ("" . nil)
208 (string :format "%v")
209 (repeat :tag "Attributes"
210 (cons :format "%v"
211 (symbol :tag "Parameter")
212 (sexp :tag "Value")))))))
213 (special-display-regexps
214 frames
215 (repeat (choice :tag "Buffer"
216 :value ""
217 (regexp :format "%v")
218 (cons :tag "With attributes"
219 :format "%v"
220 :value ("" . nil)
221 (regexp :format "%v")
222 (repeat :tag "Attributes"
223 (cons :format "%v"
224 (symbol :tag "Parameter")
225 (sexp :tag "Value")))))))
226 (special-display-function frames function)
227 (same-window-buffer-names windows (repeat (string :format "%v")))
228 (same-window-regexps windows (repeat (regexp :format "%v")))
229 (pop-up-windows windows boolean)
d2946490 230 (even-window-heights windows boolean)
74f54b54 231 (next-screen-context-lines windows integer)
1444b0c0
PA
232 (split-height-threshold windows integer)
233 (window-min-height windows integer)
234 (window-min-width windows integer)
bcc67965 235 (scroll-preserve-screen-position windows boolean)
13eb63ff 236 (display-buffer-reuse-frames windows boolean "21.1")
1444b0c0
PA
237 ;; xdisp.c
238 (scroll-step windows integer)
ccbb360e
RS
239 (scroll-conservatively windows integer)
240 (scroll-margin windows integer)
1886439b
EZ
241 (automatic-hscroll-margin windows integer "21.3")
242 (automatic-hscroll-step windows number "21.3")
1444b0c0 243 (truncate-partial-width-windows display boolean)
67ee1125 244 (mode-line-inverse-video modeline boolean)
ec544bdd 245 (mode-line-in-non-selected-windows modeline boolean "21.3")
37328bcd
DL
246 (line-number-display-limit display
247 (choice integer
248 (const :tag "No limit" nil)))
1444b0c0
PA
249 (highlight-nonselected-windows display boolean)
250 (message-log-max debug (choice (const :tag "Disable" nil)
251 (integer :menu-tag "lines"
252 :format "%v")
79221864 253 (other :tag "Unlimited" t)))
daba3e25 254 (unibyte-display-via-language-environment mule boolean)
1444b0c0
PA
255 ;; xfns.c
256 (x-bitmap-file-path installation
0849a37e
DL
257 (repeat (directory :format "%v")))
258 ;; xterm.c
9c94a2e9 259 (x-autoselect-window display boolean "21.3")
e369c773 260 (x-use-underline-position-properties display boolean "21.3")
37328bcd
DL
261 (x-stretch-cursor display boolean "21.1")))
262 this symbol group type native-p version
4883633e
RS
263 ;; This function turns a value
264 ;; into an expression which produces that value.
265 (quoter (lambda (sexp)
266 (if (or (memq sexp '(t nil))
017266f8 267 (keywordp sexp)
4883633e
RS
268 (and (listp sexp)
269 (memq (car sexp) '(lambda)))
270 (stringp sexp)
37328bcd
DL
271;; (and (fboundp 'characterp)
272;; (characterp sexp))
273 (numberp sexp))
4883633e
RS
274 sexp
275 (list 'quote sexp)))))
1444b0c0
PA
276 (while all
277 (setq this (car all)
278 all (cdr all)
279 symbol (nth 0 this)
280 group (nth 1 this)
00377857 281 type (nth 2 this)
37328bcd 282 version (nth 3 this)
00377857
EZ
283 ;; Don't complain about missing variables which are
284 ;; irrelevant to this platform.
285 native-p (save-match-data
286 (cond
287 ((string-match "\\`dos-" (symbol-name symbol))
288 (eq system-type 'ms-dos))
289 ((string-match "\\`w32-" (symbol-name symbol))
290 (eq system-type 'windows-nt))
197a09bf
EZ
291 ((string-match "\\`x-" (symbol-name symbol))
292 (fboundp 'x-create-frame))
00377857 293 (t t))))
1444b0c0
PA
294 (if (not (boundp symbol))
295 ;; If variables are removed from C code, give an error here!
00377857
EZ
296 (and native-p
297 (message "Note, built-in variable `%S' not bound" symbol))
4883633e
RS
298 ;; Save the standard value, unless we already did.
299 (or (get symbol 'standard-value)
300 (put symbol 'standard-value
301 (list (funcall quoter (default-value symbol)))))
302 ;; If this is NOT while dumping Emacs,
303 ;; set up the rest of the customization info.
304 (unless purify-flag
305 ;; Add it to the right group.
306 (custom-add-to-group group symbol 'custom-variable)
307 ;; Set the type.
37328bcd
DL
308 (put symbol 'custom-type type)
309 (put symbol 'custom-version version)))))
4883633e 310
ecf5279a
DL
311(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
312
4883633e
RS
313;; Record cus-start as loaded
314;; if we have set up all the info that we can set up.
315;; Don't record cus-start as loaded
316;; if we have set up only the standard values.
317(unless purify-flag
318 (provide 'cus-start))
1444b0c0 319
1cd7adc6 320;;; cus-start.el ends here