(tooltip-mode): Doc fix.
[emacs.git] / lisp / cus-start.el
blob12ffd93fefd3ce4a8579a700b9ffb4d478ba4acd
1 ;;; cus-start.el --- define customization properties of builtins
2 ;;
3 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Keywords: internal
8 ;; This file is part of GNU Emacs.
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.
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.
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.
25 ;;; Commentary:
27 ;; This file adds customize support for built-in variables.
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.
35 ;;; Code:
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)
48 (enable-multibyte-characters mule boolean)
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)
55 (selective-display-ellipses display boolean)
56 (indicate-empty-lines display boolean "21.1")
57 (scroll-up-aggressively windows
58 (choice (const :tag "off" nil) number)
59 "21.1")
60 (scroll-down-aggressively windows
61 (choice (const :tag "off" nil) number)
62 "21.1")
63 ;; callint.c
64 (mark-even-if-inactive editing-basics boolean)
65 ;; callproc.c
66 (shell-file-name execute file)
67 (exec-path execute
68 (repeat (choice (const :tag "default" nil)
69 (file :format "%v"))))
70 ;; coding.c
71 (inhibit-eol-conversion mule boolean)
72 (eol-mnemonic-undecided mule string)
73 (eol-mnemonic-unix mule string)
74 (eol-mnemonic-dos mule string)
75 (eol-mnemonic-mac mule string)
76 (file-coding-system-alist
77 mule
78 (alist
79 :key-type (regexp :tag "File regexp")
80 :value-type (choice
81 :value (undecided . undecided)
82 (cons :tag "Encoding/decoding pair"
83 :value (undecided . undecided)
84 (coding-system :tag "Decoding")
85 (coding-system :tag "Encoding"))
86 (coding-system :tag "Single coding system"
87 :value undecided)
88 (function :value ignore))))
89 (selection-coding-system mule coding-system)
90 ;; dired.c
91 (completion-ignored-extensions dired
92 (repeat (string :format "%v")))
93 ;; dispnew.c
94 (baud-rate display integer)
95 (inverse-video display boolean)
96 (visible-bell display boolean)
97 (no-redraw-on-reenter display boolean)
98 ;; editfns.c
99 (user-full-name mail string)
100 ;; eval.c
101 (max-specpdl-size limits integer)
102 (max-lisp-eval-depth limits integer)
103 (stack-trace-on-error debug
104 (choice (const :tag "off")
105 (repeat :menu-tag "When"
106 :value (nil)
107 (symbol :format "%v"))
108 (const :tag "always" t)))
109 (debug-on-error debug
110 (choice (const :tag "off")
111 (repeat :menu-tag "When"
112 :value (nil)
113 (symbol :format "%v"))
114 (const :tag "always" t)))
115 (debug-ignored-errors debug (repeat (choice symbol regexp)))
116 (debug-on-quit debug
117 (choice (const :tag "off")
118 (repeat :menu-tag "When"
119 :value (nil)
120 (symbol :format "%v"))
121 (const :tag "always" t)))
122 ;; fileio.c
123 (insert-default-directory minibuffer boolean)
124 (read-file-name-completion-ignore-case minibuffer boolean "21.4")
125 ;; fns.c
126 (use-dialog-box menu boolean "21.1")
127 (use-file-dialog menu boolean "21.4")
128 ;; frame.c
129 (default-frame-alist frames
130 (repeat (cons :format "%v"
131 (symbol :tag "Parameter")
132 (sexp :tag "Value"))))
133 (mouse-highlight mouse (choice (const :tag "disabled" nil)
134 (const :tag "always shown" t)
135 (other :tag "hidden by keypress" 1)))
136 ;; indent.c
137 (indent-tabs-mode fill boolean)
138 ;; keyboard.c
139 (meta-prefix-char keyboard character)
140 (auto-save-interval auto-save integer)
141 (auto-save-timeout auto-save (choice (const :tag "off" nil)
142 (integer :format "%v")))
143 (echo-keystrokes minibuffer number)
144 (polling-period keyboard integer)
145 (double-click-time mouse (restricted-sexp
146 :match-alternatives (integerp 'nil 't)))
147 (double-click-fuzz mouse integer)
148 (inhibit-local-menu-bar-menus menu boolean)
149 (help-char keyboard character)
150 (help-event-list keyboard (repeat (sexp :format "%v")))
151 (menu-prompting menu boolean)
152 (suggest-key-bindings keyboard (choice (const :tag "off" nil)
153 (integer :tag "time" 2)
154 (other :tag "on")))
156 ;; This is not good news because it will use the wrong
157 ;; version-specific directories when you upgrade. We need
158 ;; customization of the front of the list, maintaining the standard
159 ;; value intact at the back.
160 ;;; (load-path environment
161 ;;; (repeat (choice :tag "[Current dir?]"
162 ;;; :format "%[Current dir?%] %v"
163 ;;; (const :tag " current dir" nil)
164 ;;; (directory :format "%v"))))
165 ;; minibuf.c
166 (completion-auto-help minibuffer boolean)
167 (enable-recursive-minibuffers minibuffer boolean)
168 (history-length minibuffer
169 (choice (const :tag "Infinite" t)
170 integer))
171 (history-delete-duplicates minibuffer boolean)
172 (minibuffer-prompt-properties
173 minibuffer
174 (list
175 (checklist :inline t
176 (const :tag "Read-Only"
177 :doc "Prevent prompt from being modified"
178 :format "%t%n%h"
179 :inline t
180 (read-only t))
181 (const :tag "Inviolable"
182 :doc "Prevent point from ever entering prompt"
183 :format "%t%n%h"
184 :inline t
185 (point-entered minibuffer-avoid-prompt)))
186 (repeat :inline t
187 :tag "Other Properties"
188 (list :inline t
189 :format "%v"
190 (symbol :tag "Property")
191 (sexp :tag "Value"))))
192 "21.1")
193 (minibuffer-auto-raise minibuffer boolean)
194 ;; options property set at end
195 (read-buffer-function minibuffer
196 (choice (const nil)
197 (function-item iswitchb-read-buffer)
198 function))
199 ;; msdos.c
200 (dos-unsupported-char-glyph display integer)
201 ;; process.c
202 (delete-exited-processes processes-basics boolean)
203 ;; syntax.c
204 (parse-sexp-ignore-comments editing-basics boolean)
205 (words-include-escapes editing-basics boolean)
206 (open-paren-in-column-0-is-defun-start editing-basics boolean
207 "21.1")
208 ;; window.c
209 (temp-buffer-show-function windows (choice (const nil) function))
210 (display-buffer-function windows (choice (const nil) function))
211 (pop-up-frames frames boolean)
212 (pop-up-frame-function frames function)
213 (special-display-buffer-names
214 frames
215 (repeat (choice :tag "Buffer"
216 :value ""
217 (string :format "%v")
218 (cons :tag "With attributes"
219 :format "%v"
220 :value ("" . nil)
221 (string :format "%v")
222 (repeat :tag "Attributes"
223 (cons :format "%v"
224 (symbol :tag "Parameter")
225 (sexp :tag "Value")))))))
226 (special-display-regexps
227 frames
228 (repeat (choice :tag "Buffer"
229 :value ""
230 (regexp :format "%v")
231 (cons :tag "With attributes"
232 :format "%v"
233 :value ("" . nil)
234 (regexp :format "%v")
235 (repeat :tag "Attributes"
236 (cons :format "%v"
237 (symbol :tag "Parameter")
238 (sexp :tag "Value")))))))
239 (special-display-function frames function)
240 (same-window-buffer-names windows (repeat (string :format "%v")))
241 (same-window-regexps windows (repeat (regexp :format "%v")))
242 (pop-up-windows windows boolean)
243 (even-window-heights windows boolean)
244 (next-screen-context-lines windows integer)
245 (split-height-threshold windows integer)
246 (window-min-height windows integer)
247 (window-min-width windows integer)
248 (scroll-preserve-screen-position windows boolean)
249 (display-buffer-reuse-frames windows boolean "21.1")
250 ;; xdisp.c
251 (scroll-step windows integer)
252 (scroll-conservatively windows integer)
253 (scroll-margin windows integer)
254 (hscroll-margin windows integer "21.3")
255 (hscroll-step windows number "21.3")
256 (truncate-partial-width-windows display boolean)
257 (mode-line-inverse-video modeline boolean)
258 (mode-line-in-non-selected-windows modeline boolean "21.3")
259 (line-number-display-limit display
260 (choice integer
261 (const :tag "No limit" nil)))
262 (line-number-display-limit-width display integer)
263 (highlight-nonselected-windows display boolean)
264 (message-log-max debug (choice (const :tag "Disable" nil)
265 (integer :menu-tag "lines"
266 :format "%v")
267 (other :tag "Unlimited" t)))
268 (unibyte-display-via-language-environment mule boolean)
269 (blink-cursor-alist cursor alist "21.4")
270 ;; xfaces.c
271 (scalable-fonts-allowed display boolean)
272 ;; xfns.c
273 (x-bitmap-file-path installation
274 (repeat (directory :format "%v")))
275 (x-use-old-gtk-file-dialog menu boolean "21.4")
276 ;; xterm.c
277 (mouse-autoselect-window display boolean "21.3")
278 (x-use-underline-position-properties display boolean "21.3")
279 (x-stretch-cursor display boolean "21.1")))
280 this symbol group type native-p version
281 ;; This function turns a value
282 ;; into an expression which produces that value.
283 (quoter (lambda (sexp)
284 (if (or (memq sexp '(t nil))
285 (keywordp sexp)
286 (and (listp sexp)
287 (memq (car sexp) '(lambda)))
288 (stringp sexp)
289 ;; (and (fboundp 'characterp)
290 ;; (characterp sexp))
291 (numberp sexp))
292 sexp
293 (list 'quote sexp)))))
294 (while all
295 (setq this (car all)
296 all (cdr all)
297 symbol (nth 0 this)
298 group (nth 1 this)
299 type (nth 2 this)
300 version (nth 3 this)
301 ;; Don't complain about missing variables which are
302 ;; irrelevant to this platform.
303 native-p (save-match-data
304 (cond
305 ((string-match "\\`dos-" (symbol-name symbol))
306 (eq system-type 'ms-dos))
307 ((string-match "\\`w32-" (symbol-name symbol))
308 (eq system-type 'windows-nt))
309 ((string-match "\\`x-" (symbol-name symbol))
310 (fboundp 'x-create-frame))
311 (t t))))
312 (if (not (boundp symbol))
313 ;; If variables are removed from C code, give an error here!
314 (and native-p
315 (message "Note, built-in variable `%S' not bound" symbol))
316 ;; Save the standard value, unless we already did.
317 (or (get symbol 'standard-value)
318 (put symbol 'standard-value
319 (list (funcall quoter (default-value symbol)))))
320 ;; If this is NOT while dumping Emacs,
321 ;; set up the rest of the customization info.
322 (unless purify-flag
323 ;; Add it to the right group.
324 (custom-add-to-group group symbol 'custom-variable)
325 ;; Set the type.
326 (put symbol 'custom-type type)
327 (put symbol 'custom-version version)))))
329 (custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
330 (custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
331 'custom-variable)
332 (put 'selection-coding-system 'custom-set
333 (lambda (symbol value)
334 (set-selection-coding-system value)
335 (set symbol value)))
337 ;; Record cus-start as loaded
338 ;; if we have set up all the info that we can set up.
339 ;; Don't record cus-start as loaded
340 ;; if we have set up only the standard values.
341 (unless purify-flag
342 (provide 'cus-start))
344 ;;; arch-tag: 4502730d-bcb3-4f5e-99a3-a86f2d54af60
345 ;;; cus-start.el ends here