cus-start.el 16.7 KB
Newer Older
1
;;; cus-start.el --- define customization properties of builtins
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
3
;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
5 6 7
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: internal
8
;; Package: emacs
Per Abrahamsen's avatar
Per Abrahamsen committed
9

Richard M. Stallman's avatar
Richard M. Stallman committed
10 11
;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

Per Abrahamsen's avatar
Per Abrahamsen committed
25 26
;;; Commentary:
;;
27
;; This file adds customize support for built-in variables.
Per Abrahamsen's avatar
Per Abrahamsen committed
28

29 30 31 32 33
;; While dumping Emacs, this file is loaded, but it only records
;; the standard values; it does not do the rest of the job.
;; Later on, if the user makes a customization buffer,
;; this file is loaded again with (require 'cus-start);
;; then it does the whole job.
Per Abrahamsen's avatar
Per Abrahamsen committed
34

35
;;; Code:
Per Abrahamsen's avatar
Per Abrahamsen committed
36

Stefan Monnier's avatar
Stefan Monnier committed
37
(let ((all '(;; alloc.c
Per Abrahamsen's avatar
Per Abrahamsen committed
38
	     (gc-cons-threshold alloc integer)
Luc Teirlinck's avatar
Luc Teirlinck committed
39
	     (garbage-collection-messages alloc boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
40
	     ;; buffer.c
41
	     (mode-line-format mode-line sexp) ;Hard to do right.
42
	     (major-mode internal function)
Per Abrahamsen's avatar
Per Abrahamsen committed
43 44 45 46 47 48
	     (case-fold-search matching boolean)
	     (fill-column fill integer)
	     (left-margin fill integer)
	     (tab-width editing-basics integer)
	     (ctl-arrow display boolean)
	     (truncate-lines display boolean)
49
	     (word-wrap display boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
50
	     (selective-display-ellipses display boolean)
51
	     (indicate-empty-lines fringe boolean)
52 53 54 55 56 57
	     (indicate-buffer-boundaries
	      fringe
	      (choice
	       (const :tag "No indicators" nil)
	       (const :tag "On left, with arrows" left)
	       (const :tag "On right, with arrows" right)
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
	       (set :tag "Pick your own design"
		    :value ((t . nil))
		    :format "%{%t%}:\n%v\n%d"
		    :doc "You can specify a default and then override it \
for individual indicators.
Leaving \"Default\" unchecked is equivalent with specifying a default of
\"Do not show\"."
		    (choice :tag "Default"
			    :value (t . nil)
			    (const :tag "Do not show" (t . nil))
			    (const :tag "On the left" (t . left))
			    (const :tag "On the right" (t . right)))
		    (choice :tag "Top"
			    :value (top . left)
			    (const :tag "Do not show" (top . nil))
			    (const :tag "On the left" (top . left))
			    (const :tag "On the right" (top . right)))
		    (choice :tag "Bottom"
			    :value (bottom . left)
			    (const :tag "Do not show" (bottom . nil))
			    (const :tag "On the left" (bottom . left))
			    (const :tag "On the right" (bottom . right)))
		    (choice :tag "Up arrow"
			    :value (up . left)
			    (const :tag "Do not show" (up . nil))
			    (const :tag "On the left" (up . left))
			    (const :tag "On the right" (up . right)))
		    (choice :tag "Down arrow"
			    :value (down . left)
			    (const :tag "Do not show" (down . nil))
			    (const :tag "On the left" (down . left))
			    (const :tag "On the right" (down . right))))
90
	       (other :tag "On left, no arrows" t)))
91 92 93 94 95 96
	     (scroll-up-aggressively windows
				     (choice (const :tag "off" nil) number)
				     "21.1")
	     (scroll-down-aggressively windows
				       (choice (const :tag "off" nil) number)
				       "21.1")
97 98
	     (line-spacing display (choice (const :tag "none" nil) integer)
			   "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
99 100 101 102 103
	     ;; callint.c
	     (mark-even-if-inactive editing-basics boolean)
	     ;; callproc.c
	     (shell-file-name execute file)
	     (exec-path execute
104
			(repeat (choice (const :tag "default directory" nil)
105
					(directory :format "%v"))))
Dave Love's avatar
Dave Love committed
106
	     ;; charset.c
107 108
	     (charset-map-path installation
			       (repeat (directory :format "%v")))
Dave Love's avatar
Dave Love committed
109 110
	     ;; coding.c
	     (inhibit-eol-conversion mule boolean)
111 112 113 114
	     (eol-mnemonic-undecided mule string)
	     (eol-mnemonic-unix mule string)
	     (eol-mnemonic-dos mule string)
	     (eol-mnemonic-mac mule string)
Dave Love's avatar
Dave Love committed
115 116 117 118 119 120 121 122 123 124
	     (file-coding-system-alist
	      mule
	      (alist
	       :key-type (regexp :tag "File regexp")
	       :value-type (choice
			    :value (undecided . undecided)
			    (cons :tag "Encoding/decoding pair"
				  :value (undecided . undecided)
				  (coding-system :tag "Decoding")
				  (coding-system :tag "Encoding"))
125 126 127 128 129
			    (coding-system
			     :tag "Single coding system"
			     :value undecided
			     :match (lambda (widget value)
				      (and value (not (functionp value)))))
Dave Love's avatar
Dave Love committed
130
			    (function :value ignore))))
Per Abrahamsen's avatar
Per Abrahamsen committed
131
	     ;; dired.c
132
	     (completion-ignored-extensions dired
Per Abrahamsen's avatar
Per Abrahamsen committed
133
					    (repeat (string :format "%v")))
134
	     ;; dispnew.c
Per Abrahamsen's avatar
Per Abrahamsen committed
135 136 137 138 139 140 141 142 143
	     (baud-rate display integer)
	     (inverse-video display boolean)
	     (visible-bell display boolean)
	     (no-redraw-on-reenter display boolean)
	     ;; editfns.c
	     (user-full-name mail string)
	     ;; eval.c
	     (max-specpdl-size limits integer)
	     (max-lisp-eval-depth limits integer)
144 145
	     (max-mini-window-height limits
				     (choice (const :tag "quarter screen" nil)
146
					     number) "23.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
147 148 149 150 151 152
	     (stack-trace-on-error debug
				   (choice (const :tag "off")
					   (repeat :menu-tag "When"
						   :value (nil)
						   (symbol :format "%v"))
					   (const :tag "always" t)))
153
	     (debug-on-error debug
Per Abrahamsen's avatar
Per Abrahamsen committed
154 155 156 157 158 159
			     (choice (const :tag "off")
				     (repeat :menu-tag "When"
					     :value (nil)
					     (symbol :format "%v"))
				     (const :tag "always" t)))
	     (debug-ignored-errors debug (repeat (choice symbol regexp)))
160 161 162 163 164 165
	     (debug-on-quit debug
			    (choice (const :tag "off")
				    (repeat :menu-tag "When"
					    :value (nil)
					    (symbol :format "%v"))
				    (const :tag "always" t)))
166 167
             ;; fileio.c
             (delete-by-moving-to-trash auto-save boolean "23.1")
168
	     (auto-save-visited-file-name auto-save boolean)
Dave Love's avatar
Dave Love committed
169
	     ;; fns.c
170
	     (use-dialog-box menu boolean "21.1")
171
	     (use-file-dialog menu boolean "22.1")
172
	     (focus-follows-mouse frames boolean "20.3")
Per Abrahamsen's avatar
Per Abrahamsen committed
173 174 175 176 177
	     ;; frame.c
	     (default-frame-alist frames
	       (repeat (cons :format "%v"
			     (symbol :tag "Parameter")
			     (sexp :tag "Value"))))
Kim F. Storm's avatar
Kim F. Storm committed
178 179
	     (mouse-highlight mouse (choice (const :tag "disabled" nil)
					    (const :tag "always shown" t)
180 181
					    (other :tag "hidden by keypress" 1))
			      "22.1")
182
	     (make-pointer-invisible mouse boolean "23.2")
183
	     ;; fringe.c
184
	     (overflow-newline-into-fringe fringe boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
185
	     ;; indent.c
186
	     (indent-tabs-mode indent boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
187 188 189 190 191
	     ;; keyboard.c
	     (meta-prefix-char keyboard character)
	     (auto-save-interval auto-save integer)
	     (auto-save-timeout auto-save (choice (const :tag "off" nil)
						  (integer :format "%v")))
Dave Love's avatar
Dave Love committed
192
	     (echo-keystrokes minibuffer number)
Per Abrahamsen's avatar
Per Abrahamsen committed
193
	     (polling-period keyboard integer)
194 195
	     (double-click-time mouse (restricted-sexp
				       :match-alternatives (integerp 'nil 't)))
196
	     (double-click-fuzz mouse integer "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
197 198 199 200
	     (inhibit-local-menu-bar-menus menu boolean)
	     (help-char keyboard character)
	     (help-event-list keyboard (repeat (sexp :format "%v")))
	     (menu-prompting menu boolean)
201
	     (select-active-regions killing
202 203
				    (choice (const :tag "always" t)
					    (const :tag "only shift-selection or mouse-drag" only)
204 205
					    (const :tag "off" nil))
				    "24.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
206 207
	     (suggest-key-bindings keyboard (choice (const :tag "off" nil)
						    (integer :tag "time" 2)
208
						    (other :tag "on")))
209

210 211 212 213
;; This is not good news because it will use the wrong
;; version-specific directories when you upgrade.  We need
;; customization of the front of the list, maintaining the standard
;; value intact at the back.
214
;;; 	     (load-path environment
215 216 217 218
;;; 			(repeat (choice :tag "[Current dir?]"
;;; 					:format "%[Current dir?%] %v"
;;; 					(const :tag " current dir" nil)
;;;					(directory :format "%v"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
219 220
	     ;; minibuf.c
	     (enable-recursive-minibuffers minibuffer boolean)
221
	     (history-length minibuffer
222 223 224
			     (choice (const :tag "Infinite" t) integer)
			     "22.1")
	     (history-delete-duplicates minibuffer boolean "22.1")
225 226
	     (read-buffer-completion-ignore-case minibuffer boolean "23.1")

227 228 229 230 231 232 233 234 235
	     (minibuffer-prompt-properties
	      minibuffer
	      (list
	       (checklist :inline t
			  (const :tag "Read-Only"
				 :doc "Prevent prompt from being modified"
				 :format "%t%n%h"
				 :inline t
				 (read-only t))
236
			  (const :tag "Don't Enter"
237 238 239 240 241 242 243 244 245
				 :doc "Prevent point from ever entering prompt"
				 :format "%t%n%h"
				 :inline t
				 (point-entered minibuffer-avoid-prompt)))
	       (repeat :inline t
		       :tag "Other Properties"
		       (list :inline t
			     :format "%v"
			     (symbol :tag "Property")
Dave Love's avatar
Dave Love committed
246 247
			     (sexp :tag "Value"))))
	      "21.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
248
	     (minibuffer-auto-raise minibuffer boolean)
Dave Love's avatar
Dave Love committed
249
	     ;; options property set at end
Dave Love's avatar
Dave Love committed
250 251 252 253
	     (read-buffer-function minibuffer
				   (choice (const nil)
					   (function-item iswitchb-read-buffer)
					   function))
254 255
	     ;; msdos.c
	     (dos-unsupported-char-glyph display integer)
256
	     ;; nsterm.m
Eli Zaretskii's avatar
Eli Zaretskii committed
257
	     (ns-control-modifier
258
	      ns
259 260 261 262
	      (choice (const :tag "No modifier" nil)
		      (const control) (const meta)
		      (const alt) (const hyper)
		      (const super)) "23.1")
Eli Zaretskii's avatar
Eli Zaretskii committed
263
	     (ns-command-modifier
264
	      ns
265 266 267 268
	      (choice (const :tag "No modifier" nil)
		      (const control) (const meta)
		      (const alt) (const hyper)
		      (const super)) "23.1")
Eli Zaretskii's avatar
Eli Zaretskii committed
269
	     (ns-alternate-modifier
270
	      ns
271 272 273 274
	      (choice (const :tag "No modifier (work as alternate/option)" none)
		      (const control) (const meta)
		      (const alt) (const hyper)
		      (const super)) "23.1")
275 276 277 278 279 280 281 282
	     (ns-right-alternate-modifier
	      ns
	      (choice (const :tag "No modifier (work as alternate/option)" none)
		      (const :tag "Use the value of ns-alternate-modifier"
			     left)
		      (const control) (const meta)
		      (const alt) (const hyper)
		      (const super)) "23.3")
Eli Zaretskii's avatar
Eli Zaretskii committed
283
	     (ns-function-modifier
284
	      ns
285 286 287 288 289
	      (choice (const :tag "No modifier (work as function)" none)
		      (const control) (const meta)
		      (const alt) (const hyper)
		      (const super)) "23.1")
	     (ns-antialias-text ns boolean "23.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
290
	     ;; process.c
291
	     (delete-exited-processes processes-basics boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
292 293 294
	     ;; syntax.c
	     (parse-sexp-ignore-comments editing-basics boolean)
	     (words-include-escapes editing-basics boolean)
Kenichi Handa's avatar
Kenichi Handa committed
295 296
	     (open-paren-in-column-0-is-defun-start editing-basics boolean
						    "21.1")
Stefan Monnier's avatar
Stefan Monnier committed
297 298
             ;; term.c
             (visible-cursor cursor boolean "22.1")
299 300 301 302 303 304 305 306 307 308 309 310 311 312
	     ;; undo.c
	     (undo-limit undo integer)
	     (undo-strong-limit undo integer)
	     (undo-outer-limit undo
			       (choice integer
				       (const :tag "No limit"
					      :format "%t\n%d"
					      :doc
					      "With this choice, \
the undo info for the current command never gets discarded.
This should only be chosen under exceptional circumstances,
since it could result in memory overflow and make Emacs crash."
					      nil))
			       "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
313
	     ;; window.c
314
	     (temp-buffer-show-function windows (choice (const nil) function))
315
	     (next-screen-context-lines windows integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
316 317
	     (window-min-height windows integer)
	     (window-min-width windows integer)
318 319 320 321
 	     (scroll-preserve-screen-position
 	      windows (choice
 		       (const :tag "Off (nil)" :value nil)
 		       (const :tag "Full screen (t)" :value t)
322
 		       (other :tag "Always" 1)) "22.1")
323 324 325 326 327 328
	     (recenter-redisplay windows
				 (choice
				  (const :tag "Never (nil)" :value nil)
				  (const :tag "Only on ttys" :value tty)
				  (other :tag "Always" t))
				 "23.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
329 330
	     ;; xdisp.c
	     (scroll-step windows integer)
331 332
	     (scroll-conservatively windows integer)
	     (scroll-margin windows integer)
Eli Zaretskii's avatar
Eli Zaretskii committed
333 334
	     (hscroll-margin windows integer "22.1")
	     (hscroll-step windows number "22.1")
335
	     (truncate-partial-width-windows display boolean "23.1")
336 337
	     (mode-line-inverse-video mode-line boolean)
	     (mode-line-in-non-selected-windows mode-line boolean "22.1")
338 339 340
	     (line-number-display-limit display
					(choice integer
						(const :tag "No limit" nil)))
341
	     (line-number-display-limit-width display integer "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
342 343 344 345
	     (highlight-nonselected-windows display boolean)
	     (message-log-max debug (choice (const :tag "Disable" nil)
					    (integer :menu-tag "lines"
						     :format "%v")
346
					    (other :tag "Unlimited" t)))
347
	     (unibyte-display-via-language-environment mule boolean)
348
	     (blink-cursor-alist cursor alist "22.1")
349
	     (overline-margin display integer "22.1")
350
	     (underline-minimum-offset display integer "23.1")
351 352 353 354 355
             (mouse-autoselect-window
	      display (choice
		       (const :tag "Off (nil)" :value nil)
		       (const :tag "Immediate" :value t)
		       (number :tag "Delay by secs" :value 0.5)) "22.1")
356 357 358 359 360 361
             (tool-bar-style
	      frames (choice
		      (const :tag "Images" :value image)
		      (const :tag "Text" :value text)
		      (const :tag "Both" :value both)
		      (const :tag "Both-horiz" :value both-horiz)
362
		      (const :tag "Text-image-horiz" :value text-image-horiz)
363 364 365
		      (const :tag "System default" :value nil)) "23.3")
             (tool-bar-max-label-size frames integer "23.3")

366
	     ;; xfaces.c
367
	     (scalable-fonts-allowed display boolean "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
368 369
	     ;; xfns.c
	     (x-bitmap-file-path installation
370
				 (repeat (directory :format "%v")))
371
	     (x-gtk-use-old-file-dialog menu boolean "22.1")
Jan Djärv's avatar
Jan Djärv committed
372
	     (x-gtk-show-hidden-files menu boolean "22.1")
373
	     (x-gtk-file-dialog-help-text menu boolean "22.1")
374
	     (x-gtk-whole-detached-tool-bar x boolean "22.1")
375
	     (x-gtk-use-system-tooltips tooltip boolean "23.3")
376
	     ;; xterm.c
Eli Zaretskii's avatar
Eli Zaretskii committed
377
	     (x-use-underline-position-properties display boolean "22.1")
378
	     (x-underline-at-descent-line display boolean "22.1")
379 380 381
	     (x-stretch-cursor display boolean "21.1")
	     ;; xsettings.c
	     (font-use-system-font font-selection boolean "23.2")))
382
      this symbol group type standard version native-p
383 384 385 386
      ;; This function turns a value
      ;; into an expression which produces that value.
      (quoter (lambda (sexp)
		(if (or (memq sexp '(t nil))
Dave Love's avatar
Dave Love committed
387
			(keywordp sexp)
388 389 390
			(and (listp sexp)
			     (memq (car sexp) '(lambda)))
			(stringp sexp)
391
			(numberp sexp))
392 393
		    sexp
		  (list 'quote sexp)))))
394
  (while all
Per Abrahamsen's avatar
Per Abrahamsen committed
395 396 397 398
    (setq this (car all)
	  all (cdr all)
	  symbol (nth 0 this)
	  group (nth 1 this)
399
	  type (nth 2 this)
400
	  version (nth 3 this)
401 402 403 404
	  ;; If we did not specify any standard value expression above,
	  ;; use the current value as the standard value.
	  standard (if (nthcdr 4 this)
		       (nth 4 this)
405
		     (when (default-boundp symbol)
Lute Kamstra's avatar
Lute Kamstra committed
406
		       (funcall quoter (default-value symbol))))
407 408 409 410 411 412 413 414
	  ;; Don't complain about missing variables which are
	  ;; irrelevant to this platform.
	  native-p (save-match-data
		     (cond
		      ((string-match "\\`dos-" (symbol-name symbol))
		       (eq system-type 'ms-dos))
		      ((string-match "\\`w32-" (symbol-name symbol))
		       (eq system-type 'windows-nt))
Eli Zaretskii's avatar
Eli Zaretskii committed
415 416
		      ((string-match "\\`ns-" (symbol-name symbol))
		       (featurep 'ns))
417
		      ((string-match "\\`x-.*gtk" (symbol-name symbol))
Karoly Lorentey's avatar
Karoly Lorentey committed
418
		       (featurep 'gtk))
419 420
		      ((string-match "\\`x-" (symbol-name symbol))
		       (fboundp 'x-create-frame))
421 422 423 424
		      ((string-match "selection" (symbol-name symbol))
		       (fboundp 'x-selection-exists-p))
		      ((string-match "fringe" (symbol-name symbol))
		       (fboundp 'define-fringe-bitmap))
425 426
		      ((equal "font-use-system-font" (symbol-name symbol))
		       (featurep 'system-font-setting))
427 428 429 430
		      ;; Conditioned on x-create-frame, because that's
		      ;; the condition for loadup.el to preload tool-bar.el.
		      ((string-match "tool-bar-" (symbol-name symbol))
		       (fboundp 'x-create-frame))
431
		      (t t))))
Per Abrahamsen's avatar
Per Abrahamsen committed
432 433
    (if (not (boundp symbol))
	;; If variables are removed from C code, give an error here!
434 435
	(and native-p
	     (message "Note, built-in variable `%S' not bound" symbol))
436 437
      ;; Save the standard value, unless we already did.
      (or (get symbol 'standard-value)
438
	  (put symbol 'standard-value (list standard)))
439 440 441 442 443 444
      ;; If this is NOT while dumping Emacs,
      ;; set up the rest of the customization info.
      (unless purify-flag
	;; Add it to the right group.
	(custom-add-to-group group symbol 'custom-variable)
	;; Set the type.
445 446
	(put symbol 'custom-type type)
	(put symbol 'custom-version version)))))
447

Dave Love's avatar
Dave Love committed
448
(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
Kenichi Handa's avatar
Kenichi Handa committed
449 450
(custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
		     'custom-variable)
Dave Love's avatar
Dave Love committed
451

452 453 454 455 456 457
;; Record cus-start as loaded
;; if we have set up all the info that we can set up.
;; Don't record cus-start as loaded
;; if we have set up only the standard values.
(unless purify-flag
  (provide 'cus-start))
Per Abrahamsen's avatar
Per Abrahamsen committed
458

459
;; arch-tag: 4502730d-bcb3-4f5e-99a3-a86f2d54af60
460
;;; cus-start.el ends here