merge emacs-23
[emacs.git] / lisp / cus-start.el
blob4f3faf8a063c48941593dcf0180d34b26e818335
1 ;;; cus-start.el --- define customization properties of builtins
2 ;;
3 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7 ;; Keywords: internal
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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This file adds customize support for built-in variables.
28 ;; While dumping Emacs, this file is loaded, but it only records
29 ;; the standard values; it does not do the rest of the job.
30 ;; Later on, if the user makes a customization buffer,
31 ;; this file is loaded again with (require 'cus-start);
32 ;; then it does the whole job.
34 ;;; Code:
36 (let ((all '(;; alloc.c
37 (gc-cons-threshold alloc integer)
38 (garbage-collection-messages alloc boolean)
39 ;; buffer.c
40 (mode-line-format mode-line sexp) ;Hard to do right.
41 (major-mode internal function)
42 (case-fold-search matching boolean)
43 (fill-column fill integer)
44 (left-margin fill integer)
45 (tab-width editing-basics integer)
46 (ctl-arrow display boolean)
47 (truncate-lines display boolean)
48 (word-wrap display boolean)
49 (selective-display-ellipses display boolean)
50 (indicate-empty-lines fringe boolean)
51 (indicate-buffer-boundaries
52 fringe
53 (choice
54 (const :tag "No indicators" nil)
55 (const :tag "On left, with arrows" left)
56 (const :tag "On right, with arrows" right)
57 (set :tag "Pick your own design"
58 :value ((t . nil))
59 :format "%{%t%}:\n%v\n%d"
60 :doc "You can specify a default and then override it \
61 for individual indicators.
62 Leaving \"Default\" unchecked is equivalent with specifying a default of
63 \"Do not show\"."
64 (choice :tag "Default"
65 :value (t . nil)
66 (const :tag "Do not show" (t . nil))
67 (const :tag "On the left" (t . left))
68 (const :tag "On the right" (t . right)))
69 (choice :tag "Top"
70 :value (top . left)
71 (const :tag "Do not show" (top . nil))
72 (const :tag "On the left" (top . left))
73 (const :tag "On the right" (top . right)))
74 (choice :tag "Bottom"
75 :value (bottom . left)
76 (const :tag "Do not show" (bottom . nil))
77 (const :tag "On the left" (bottom . left))
78 (const :tag "On the right" (bottom . right)))
79 (choice :tag "Up arrow"
80 :value (up . left)
81 (const :tag "Do not show" (up . nil))
82 (const :tag "On the left" (up . left))
83 (const :tag "On the right" (up . right)))
84 (choice :tag "Down arrow"
85 :value (down . left)
86 (const :tag "Do not show" (down . nil))
87 (const :tag "On the left" (down . left))
88 (const :tag "On the right" (down . right))))
89 (other :tag "On left, no arrows" t)))
90 (scroll-up-aggressively windows
91 (choice (const :tag "off" nil) number)
92 "21.1")
93 (scroll-down-aggressively windows
94 (choice (const :tag "off" nil) number)
95 "21.1")
96 (line-spacing display (choice (const :tag "none" nil) integer)
97 "22.1")
98 ;; callint.c
99 (mark-even-if-inactive editing-basics boolean)
100 ;; callproc.c
101 (shell-file-name execute file)
102 (exec-path execute
103 (repeat (choice (const :tag "default directory" nil)
104 (directory :format "%v"))))
105 ;; charset.c
106 (charset-map-path installation
107 (repeat (directory :format "%v")))
108 ;; coding.c
109 (inhibit-eol-conversion mule boolean)
110 (eol-mnemonic-undecided mule string)
111 (eol-mnemonic-unix mule string)
112 (eol-mnemonic-dos mule string)
113 (eol-mnemonic-mac mule string)
114 (file-coding-system-alist
115 mule
116 (alist
117 :key-type (regexp :tag "File regexp")
118 :value-type (choice
119 :value (undecided . undecided)
120 (cons :tag "Encoding/decoding pair"
121 :value (undecided . undecided)
122 (coding-system :tag "Decoding")
123 (coding-system :tag "Encoding"))
124 (coding-system
125 :tag "Single coding system"
126 :value undecided
127 :match (lambda (widget value)
128 (and value (not (functionp value)))))
129 (function :value ignore))))
130 ;; dired.c
131 (completion-ignored-extensions dired
132 (repeat (string :format "%v")))
133 ;; dispnew.c
134 (baud-rate display integer)
135 (inverse-video display boolean)
136 (visible-bell display boolean)
137 (no-redraw-on-reenter display boolean)
138 ;; editfns.c
139 (user-full-name mail string)
140 ;; eval.c
141 (max-specpdl-size limits integer)
142 (max-lisp-eval-depth limits integer)
143 (max-mini-window-height limits
144 (choice (const :tag "quarter screen" nil)
145 number) "23.1")
146 (stack-trace-on-error debug
147 (choice (const :tag "off")
148 (repeat :menu-tag "When"
149 :value (nil)
150 (symbol :format "%v"))
151 (const :tag "always" t)))
152 (debug-on-error debug
153 (choice (const :tag "off")
154 (repeat :menu-tag "When"
155 :value (nil)
156 (symbol :format "%v"))
157 (const :tag "always" t)))
158 (debug-ignored-errors debug (repeat (choice symbol regexp)))
159 (debug-on-quit debug
160 (choice (const :tag "off")
161 (repeat :menu-tag "When"
162 :value (nil)
163 (symbol :format "%v"))
164 (const :tag "always" t)))
165 ;; fileio.c
166 (delete-by-moving-to-trash auto-save boolean "23.1")
167 (auto-save-visited-file-name auto-save boolean)
168 ;; fns.c
169 (use-dialog-box menu boolean "21.1")
170 (use-file-dialog menu boolean "22.1")
171 (focus-follows-mouse frames boolean "20.3")
172 ;; frame.c
173 (default-frame-alist frames
174 (repeat (cons :format "%v"
175 (symbol :tag "Parameter")
176 (sexp :tag "Value"))))
177 (mouse-highlight mouse (choice (const :tag "disabled" nil)
178 (const :tag "always shown" t)
179 (other :tag "hidden by keypress" 1))
180 "22.1")
181 (make-pointer-invisible mouse boolean "23.2")
182 ;; fringe.c
183 (overflow-newline-into-fringe fringe boolean)
184 ;; indent.c
185 (indent-tabs-mode indent boolean)
186 ;; keyboard.c
187 (meta-prefix-char keyboard character)
188 (auto-save-interval auto-save integer)
189 (auto-save-timeout auto-save (choice (const :tag "off" nil)
190 (integer :format "%v")))
191 (echo-keystrokes minibuffer number)
192 (polling-period keyboard integer)
193 (double-click-time mouse (restricted-sexp
194 :match-alternatives (integerp 'nil 't)))
195 (double-click-fuzz mouse integer "22.1")
196 (inhibit-local-menu-bar-menus menu boolean)
197 (help-char keyboard character)
198 (help-event-list keyboard (repeat (sexp :format "%v")))
199 (menu-prompting menu boolean)
200 (suggest-key-bindings keyboard (choice (const :tag "off" nil)
201 (integer :tag "time" 2)
202 (other :tag "on")))
204 ;; This is not good news because it will use the wrong
205 ;; version-specific directories when you upgrade. We need
206 ;; customization of the front of the list, maintaining the standard
207 ;; value intact at the back.
208 ;;; (load-path environment
209 ;;; (repeat (choice :tag "[Current dir?]"
210 ;;; :format "%[Current dir?%] %v"
211 ;;; (const :tag " current dir" nil)
212 ;;; (directory :format "%v"))))
213 ;; minibuf.c
214 (enable-recursive-minibuffers minibuffer boolean)
215 (history-length minibuffer
216 (choice (const :tag "Infinite" t) integer)
217 "22.1")
218 (history-delete-duplicates minibuffer boolean "22.1")
219 (read-buffer-completion-ignore-case minibuffer boolean "23.1")
221 (minibuffer-prompt-properties
222 minibuffer
223 (list
224 (checklist :inline t
225 (const :tag "Read-Only"
226 :doc "Prevent prompt from being modified"
227 :format "%t%n%h"
228 :inline t
229 (read-only t))
230 (const :tag "Don't Enter"
231 :doc "Prevent point from ever entering prompt"
232 :format "%t%n%h"
233 :inline t
234 (point-entered minibuffer-avoid-prompt)))
235 (repeat :inline t
236 :tag "Other Properties"
237 (list :inline t
238 :format "%v"
239 (symbol :tag "Property")
240 (sexp :tag "Value"))))
241 "21.1")
242 (minibuffer-auto-raise minibuffer boolean)
243 ;; options property set at end
244 (read-buffer-function minibuffer
245 (choice (const nil)
246 (function-item iswitchb-read-buffer)
247 function))
248 ;; msdos.c
249 (dos-unsupported-char-glyph display integer)
250 ;; nsterm.m
251 (ns-control-modifier
253 (choice (const :tag "No modifier" nil)
254 (const control) (const meta)
255 (const alt) (const hyper)
256 (const super)) "23.1")
257 (ns-command-modifier
259 (choice (const :tag "No modifier" nil)
260 (const control) (const meta)
261 (const alt) (const hyper)
262 (const super)) "23.1")
263 (ns-alternate-modifier
265 (choice (const :tag "No modifier (work as alternate/option)" none)
266 (const control) (const meta)
267 (const alt) (const hyper)
268 (const super)) "23.1")
269 (ns-right-alternate-modifier
271 (choice (const :tag "No modifier (work as alternate/option)" none)
272 (const :tag "Use the value of ns-alternate-modifier"
273 left)
274 (const control) (const meta)
275 (const alt) (const hyper)
276 (const super)) "23.3")
277 (ns-function-modifier
279 (choice (const :tag "No modifier (work as function)" none)
280 (const control) (const meta)
281 (const alt) (const hyper)
282 (const super)) "23.1")
283 (ns-antialias-text ns boolean "23.1")
284 ;; process.c
285 (delete-exited-processes processes-basics boolean)
286 ;; syntax.c
287 (parse-sexp-ignore-comments editing-basics boolean)
288 (words-include-escapes editing-basics boolean)
289 (open-paren-in-column-0-is-defun-start editing-basics boolean
290 "21.1")
291 ;; term.c
292 (visible-cursor cursor boolean "22.1")
293 ;; undo.c
294 (undo-limit undo integer)
295 (undo-strong-limit undo integer)
296 (undo-outer-limit undo
297 (choice integer
298 (const :tag "No limit"
299 :format "%t\n%d"
300 :doc
301 "With this choice, \
302 the undo info for the current command never gets discarded.
303 This should only be chosen under exceptional circumstances,
304 since it could result in memory overflow and make Emacs crash."
305 nil))
306 "22.1")
307 ;; window.c
308 (temp-buffer-show-function windows (choice (const nil) function))
309 (next-screen-context-lines windows integer)
310 (window-min-height windows integer)
311 (window-min-width windows integer)
312 (scroll-preserve-screen-position
313 windows (choice
314 (const :tag "Off (nil)" :value nil)
315 (const :tag "Full screen (t)" :value t)
316 (other :tag "Always" 1)) "22.1")
317 (recenter-redisplay windows
318 (choice
319 (const :tag "Never (nil)" :value nil)
320 (const :tag "Only on ttys" :value tty)
321 (other :tag "Always" t))
322 "23.1")
323 ;; xdisp.c
324 (scroll-step windows integer)
325 (scroll-conservatively windows integer)
326 (scroll-margin windows integer)
327 (hscroll-margin windows integer "22.1")
328 (hscroll-step windows number "22.1")
329 (truncate-partial-width-windows display boolean "23.1")
330 (mode-line-inverse-video mode-line boolean)
331 (mode-line-in-non-selected-windows mode-line boolean "22.1")
332 (line-number-display-limit display
333 (choice integer
334 (const :tag "No limit" nil)))
335 (line-number-display-limit-width display integer "22.1")
336 (highlight-nonselected-windows display boolean)
337 (message-log-max debug (choice (const :tag "Disable" nil)
338 (integer :menu-tag "lines"
339 :format "%v")
340 (other :tag "Unlimited" t)))
341 (unibyte-display-via-language-environment mule boolean)
342 (blink-cursor-alist cursor alist "22.1")
343 (overline-margin display integer "22.1")
344 (underline-minimum-offset display integer "23.1")
345 (mouse-autoselect-window
346 display (choice
347 (const :tag "Off (nil)" :value nil)
348 (const :tag "Immediate" :value t)
349 (number :tag "Delay by secs" :value 0.5)) "22.1")
350 ;; xfaces.c
351 (scalable-fonts-allowed display boolean "22.1")
352 ;; xfns.c
353 (x-bitmap-file-path installation
354 (repeat (directory :format "%v")))
355 (x-gtk-use-old-file-dialog menu boolean "22.1")
356 (x-gtk-show-hidden-files menu boolean "22.1")
357 (x-gtk-file-dialog-help-text menu boolean "22.1")
358 (x-gtk-whole-detached-tool-bar x boolean "22.1")
359 ;; xterm.c
360 (x-use-underline-position-properties display boolean "22.1")
361 (x-underline-at-descent-line display boolean "22.1")
362 (x-stretch-cursor display boolean "21.1")
363 ;; xsettings.c
364 (font-use-system-font font-selection boolean "23.2")))
365 this symbol group type standard version native-p
366 ;; This function turns a value
367 ;; into an expression which produces that value.
368 (quoter (lambda (sexp)
369 (if (or (memq sexp '(t nil))
370 (keywordp sexp)
371 (and (listp sexp)
372 (memq (car sexp) '(lambda)))
373 (stringp sexp)
374 (numberp sexp))
375 sexp
376 (list 'quote sexp)))))
377 (while all
378 (setq this (car all)
379 all (cdr all)
380 symbol (nth 0 this)
381 group (nth 1 this)
382 type (nth 2 this)
383 version (nth 3 this)
384 ;; If we did not specify any standard value expression above,
385 ;; use the current value as the standard value.
386 standard (if (nthcdr 4 this)
387 (nth 4 this)
388 (when (default-boundp symbol)
389 (funcall quoter (default-value symbol))))
390 ;; Don't complain about missing variables which are
391 ;; irrelevant to this platform.
392 native-p (save-match-data
393 (cond
394 ((string-match "\\`dos-" (symbol-name symbol))
395 (eq system-type 'ms-dos))
396 ((string-match "\\`w32-" (symbol-name symbol))
397 (eq system-type 'windows-nt))
398 ((string-match "\\`ns-" (symbol-name symbol))
399 (featurep 'ns))
400 ((string-match "\\`x-.*gtk" (symbol-name symbol))
401 (featurep 'gtk))
402 ((string-match "\\`x-" (symbol-name symbol))
403 (fboundp 'x-create-frame))
404 ((string-match "selection" (symbol-name symbol))
405 (fboundp 'x-selection-exists-p))
406 ((string-match "fringe" (symbol-name symbol))
407 (fboundp 'define-fringe-bitmap))
408 ((equal "font-use-system-font" (symbol-name symbol))
409 (featurep 'system-font-setting))
410 (t t))))
411 (if (not (boundp symbol))
412 ;; If variables are removed from C code, give an error here!
413 (and native-p
414 (message "Note, built-in variable `%S' not bound" symbol))
415 ;; Save the standard value, unless we already did.
416 (or (get symbol 'standard-value)
417 (put symbol 'standard-value (list standard)))
418 ;; If this is NOT while dumping Emacs,
419 ;; set up the rest of the customization info.
420 (unless purify-flag
421 ;; Add it to the right group.
422 (custom-add-to-group group symbol 'custom-variable)
423 ;; Set the type.
424 (put symbol 'custom-type type)
425 (put symbol 'custom-version version)))))
427 (custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
428 (custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
429 'custom-variable)
431 ;; Record cus-start as loaded
432 ;; if we have set up all the info that we can set up.
433 ;; Don't record cus-start as loaded
434 ;; if we have set up only the standard values.
435 (unless purify-flag
436 (provide 'cus-start))
438 ;; arch-tag: 4502730d-bcb3-4f5e-99a3-a86f2d54af60
439 ;;; cus-start.el ends here