cus-start.el 17.6 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 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
5 6 7 8
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: internal

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25

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

30 31 32 33 34
;; 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
35

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

38
(let ((all '(;; abbrev.c
Per Abrahamsen's avatar
Per Abrahamsen committed
39 40 41 42
	     (abbrev-all-caps abbrev-mode boolean)
	     (pre-abbrev-expand-hook abbrev-mode hook)
	     ;; alloc.c
	     (gc-cons-threshold alloc integer)
Luc Teirlinck's avatar
Luc Teirlinck committed
43
	     (garbage-collection-messages alloc boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
44 45 46
	     ;; buffer.c
	     (mode-line-format modeline sexp) ;Hard to do right.
	     (default-major-mode internal function)
47
	     (enable-multibyte-characters mule boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
48 49 50 51 52 53 54
	     (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)
	     (selective-display-ellipses display boolean)
55
	     (indicate-empty-lines fringe boolean)
56 57 58 59 60 61
	     (indicate-buffer-boundaries
	      fringe
	      (choice
	       (const :tag "No indicators" nil)
	       (const :tag "On left, with arrows" left)
	       (const :tag "On right, with arrows" right)
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 90 91 92 93
	       (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))))
94
	       (other :tag "On left, no arrows" t)))
95 96 97 98 99 100
	     (scroll-up-aggressively windows
				     (choice (const :tag "off" nil) number)
				     "21.1")
	     (scroll-down-aggressively windows
				       (choice (const :tag "off" nil) number)
				       "21.1")
101
	     (line-spacing display (choice (const :tag "none" nil) integer))
Per Abrahamsen's avatar
Per Abrahamsen committed
102 103 104 105 106
	     ;; callint.c
	     (mark-even-if-inactive editing-basics boolean)
	     ;; callproc.c
	     (shell-file-name execute file)
	     (exec-path execute
107
			(repeat (choice (const :tag "default directory" nil)
108
					(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
	     (file-coding-system-alist
	      mule
	      (alist
	       :key-type (regexp :tag "File regexp")
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
	       :value-type
	       (choice
		:value (undecided . undecided)
		(cons :tag "Encoding/decoding pair"
		      :value (undecided . undecided)
		      (coding-system :tag "Decoding")
		      (coding-system :tag "Encoding"))
		(coding-system
		 :tag "Single coding system"
		 :value undecided
		 :validate
		 (lambda (widget)
		   (unless (or (coding-system-p (widget-value widget))
			       (functionp (widget-value widget)))
		     (widget-put
		      widget
		      :error (format "Invalid coding system: %S"
				     (widget-value widget)))
		     widget)))
		(function :value ignore))))
139
	     (selection-coding-system mule coding-system)
Per Abrahamsen's avatar
Per Abrahamsen committed
140
	     ;; dired.c
141
	     (completion-ignored-extensions dired
Per Abrahamsen's avatar
Per Abrahamsen committed
142
					    (repeat (string :format "%v")))
143
	     ;; dispnew.c
Per Abrahamsen's avatar
Per Abrahamsen committed
144 145 146 147 148 149 150 151 152
	     (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)
153 154 155
	     (max-mini-window-height limits
				     (choice (const :tag "quarter screen" nil)
					     number))
Per Abrahamsen's avatar
Per Abrahamsen committed
156 157 158 159 160 161
	     (stack-trace-on-error debug
				   (choice (const :tag "off")
					   (repeat :menu-tag "When"
						   :value (nil)
						   (symbol :format "%v"))
					   (const :tag "always" t)))
162
	     (debug-on-error debug
Per Abrahamsen's avatar
Per Abrahamsen committed
163 164 165 166 167 168
			     (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)))
169 170 171 172 173 174
	     (debug-on-quit debug
			    (choice (const :tag "off")
				    (repeat :menu-tag "When"
					    :value (nil)
					    (symbol :format "%v"))
				    (const :tag "always" t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
175 176
	     ;; fileio.c
	     (insert-default-directory minibuffer boolean)
177
	     (read-file-name-completion-ignore-case minibuffer boolean "22.1")
Dave Love's avatar
Dave Love committed
178
	     ;; fns.c
179
	     (use-dialog-box menu boolean "21.1")
180
	     (use-file-dialog menu boolean "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
181 182 183 184 185
	     ;; 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
186 187 188
	     (mouse-highlight mouse (choice (const :tag "disabled" nil)
					    (const :tag "always shown" t)
					    (other :tag "hidden by keypress" 1)))
189
	     ;; fringe.c
190
	     (overflow-newline-into-fringe fringe boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
191
	     ;; indent.c
192
	     (indent-tabs-mode indent boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
193 194 195 196 197
	     ;; 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
198
	     (echo-keystrokes minibuffer number)
Per Abrahamsen's avatar
Per Abrahamsen committed
199
	     (polling-period keyboard integer)
200 201
	     (double-click-time mouse (restricted-sexp
				       :match-alternatives (integerp 'nil 't)))
202
	     (double-click-fuzz mouse integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
203 204 205 206 207 208
	     (inhibit-local-menu-bar-menus menu boolean)
	     (help-char keyboard character)
	     (help-event-list keyboard (repeat (sexp :format "%v")))
	     (menu-prompting menu boolean)
	     (suggest-key-bindings keyboard (choice (const :tag "off" nil)
						    (integer :tag "time" 2)
209
						    (other :tag "on")))
210 211
	     ;; macselect.c
	     (mac-dnd-known-types mac (repeat string) "22.1")
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
	     ;; macterm.c
	     (mac-control-modifier mac (choice (const :tag "No modifier" nil)
					       (const control) (const meta)
					       (const alt) (const hyper)
					       (const super)) "22.1")
	     (mac-command-modifier mac (choice (const :tag "No modifier" nil)
					       (const control) (const meta)
					       (const alt) (const hyper)
					       (const super)) "22.1")
	     (mac-option-modifier mac (choice (const :tag "No modifier (work as option)" nil)
					      (const control) (const meta)
					      (const alt) (const hyper)
					      (const super)) "22.1")
	     (mac-function-modifier mac
				    (choice (const :tag "No modifier (work as function)" nil)
					    (const control) (const meta)
					    (const alt) (const hyper)
					    (const super)) "22.1")
	     (mac-emulate-three-button-mouse mac
					     (choice (const :tag "No emulation" nil)
						     (const :tag "Option->2, Command->3" t)
						     (const :tag "Command->2, Option->3" reverse))
				    "22.1")
	     (mac-wheel-button-is-mouse-2 mac boolean "22.1")
	     (mac-pass-command-to-system mac boolean "22.1")
	     (mac-pass-control-to-system mac boolean "22.1")
	     (mac-allow-anti-aliasing mac boolean "22.1")
239 240 241 242 243 244 245
	     (mac-ts-script-language-on-focus mac
					      (choice (const :tag "System default behavior" nil)
						      (const :tag "Restore to script/language used in the last focus frame" t)
						      (cons :tag "Specify script/language"
							    (integer :tag "Script code")
							    (integer :tag "Language code")))
					      "22.1")
246

247 248 249 250
;; 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.
251
;;; 	     (load-path environment
252 253 254 255
;;; 			(repeat (choice :tag "[Current dir?]"
;;; 					:format "%[Current dir?%] %v"
;;; 					(const :tag " current dir" nil)
;;;					(directory :format "%v"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
256 257 258
	     ;; minibuf.c
	     (completion-auto-help minibuffer boolean)
	     (enable-recursive-minibuffers minibuffer boolean)
259 260 261
	     (history-length minibuffer
			     (choice (const :tag "Infinite" t)
				     integer))
262
	     (history-delete-duplicates minibuffer boolean)
263 264 265 266 267 268 269 270 271
	     (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))
272
			  (const :tag "Don't Enter"
273 274 275 276 277 278 279 280 281
				 :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
282 283
			     (sexp :tag "Value"))))
	      "21.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
284
	     (minibuffer-auto-raise minibuffer boolean)
Dave Love's avatar
Dave Love committed
285
	     ;; options property set at end
Dave Love's avatar
Dave Love committed
286 287 288 289
	     (read-buffer-function minibuffer
				   (choice (const nil)
					   (function-item iswitchb-read-buffer)
					   function))
290 291
	     ;; msdos.c
	     (dos-unsupported-char-glyph display integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
292
	     ;; process.c
293
	     (delete-exited-processes processes-basics boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
294 295 296
	     ;; syntax.c
	     (parse-sexp-ignore-comments editing-basics boolean)
	     (words-include-escapes editing-basics boolean)
297 298
	     (open-paren-in-column-0-is-defun-start editing-basics boolean
						    "21.1")
Stefan Monnier's avatar
Stefan Monnier committed
299 300
             ;; term.c
             (visible-cursor cursor boolean "22.1")
301 302 303 304 305 306 307 308 309 310 311 312 313 314
	     ;; 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
315
	     ;; window.c
316 317
	     (temp-buffer-show-function windows (choice (const nil) function))
	     (display-buffer-function windows (choice (const nil) function))
Per Abrahamsen's avatar
Per Abrahamsen committed
318 319
	     (pop-up-frames frames boolean)
	     (pop-up-frame-function frames function)
320 321
	     (special-display-buffer-names
	      frames
Per Abrahamsen's avatar
Per Abrahamsen committed
322 323 324 325 326 327 328 329 330 331 332 333
	      (repeat (choice :tag "Buffer"
			      :value ""
			      (string :format "%v")
			      (cons :tag "With attributes"
				    :format "%v"
				    :value ("" . nil)
				    (string :format "%v")
				    (repeat :tag "Attributes"
					    (cons :format "%v"
						  (symbol :tag "Parameter")
						  (sexp :tag "Value")))))))
	     (special-display-regexps
334
	      frames
Per Abrahamsen's avatar
Per Abrahamsen committed
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
	      (repeat (choice :tag "Buffer"
			      :value ""
			      (regexp :format "%v")
			      (cons :tag "With attributes"
				    :format "%v"
				    :value ("" . nil)
				    (regexp :format "%v")
				    (repeat :tag "Attributes"
					    (cons :format "%v"
						  (symbol :tag "Parameter")
						  (sexp :tag "Value")))))))
	     (special-display-function frames function)
	     (same-window-buffer-names windows (repeat (string :format "%v")))
	     (same-window-regexps windows (repeat (regexp :format "%v")))
	     (pop-up-windows windows boolean)
350
	     (even-window-heights windows boolean)
351
	     (next-screen-context-lines windows integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
352 353 354
	     (split-height-threshold windows integer)
	     (window-min-height windows integer)
	     (window-min-width windows integer)
355 356 357 358 359
 	     (scroll-preserve-screen-position
 	      windows (choice
 		       (const :tag "Off (nil)" :value nil)
 		       (const :tag "Full screen (t)" :value t)
 		       (other :tag "Always" 1)))
Dave Love's avatar
Dave Love committed
360
	     (display-buffer-reuse-frames windows boolean "21.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
361 362
	     ;; xdisp.c
	     (scroll-step windows integer)
363 364
	     (scroll-conservatively windows integer)
	     (scroll-margin windows integer)
Eli Zaretskii's avatar
Eli Zaretskii committed
365 366
	     (hscroll-margin windows integer "22.1")
	     (hscroll-step windows number "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
367
	     (truncate-partial-width-windows display boolean)
368
	     (mode-line-inverse-video modeline boolean)
Eli Zaretskii's avatar
Eli Zaretskii committed
369
	     (mode-line-in-non-selected-windows modeline boolean "22.1")
370 371 372
	     (line-number-display-limit display
					(choice integer
						(const :tag "No limit" nil)))
373
	     (line-number-display-limit-width display integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
374 375 376 377
	     (highlight-nonselected-windows display boolean)
	     (message-log-max debug (choice (const :tag "Disable" nil)
					    (integer :menu-tag "lines"
						     :format "%v")
378
					    (other :tag "Unlimited" t)))
379
	     (unibyte-display-via-language-environment mule boolean)
380
	     (blink-cursor-alist cursor alist "22.1")
381
	     (overline-margin display integer "22.1")
382 383 384 385 386
             (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")
387 388
	     ;; xfaces.c
	     (scalable-fonts-allowed display boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
389 390
	     ;; xfns.c
	     (x-bitmap-file-path installation
391
				 (repeat (directory :format "%v")))
392
	     (x-gtk-use-old-file-dialog menu boolean "22.1")
Jan Djärv's avatar
Jan Djärv committed
393
	     (x-gtk-show-hidden-files menu boolean "22.1")
394
	     (x-gtk-file-dialog-help-text menu boolean "22.1")
395
	     (x-gtk-whole-detached-tool-bar x boolean "22.1")
396
	     ;; xterm.c
Eli Zaretskii's avatar
Eli Zaretskii committed
397
	     (x-use-underline-position-properties display boolean "22.1")
398
	     (x-underline-at-descent-line display boolean "22.1")
399
	     (x-stretch-cursor display boolean "21.1")))
400
      this symbol group type standard version native-p
401 402 403 404
      ;; 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
405
			(keywordp sexp)
406 407 408
			(and (listp sexp)
			     (memq (car sexp) '(lambda)))
			(stringp sexp)
409
			(numberp sexp))
410 411
		    sexp
		  (list 'quote sexp)))))
412
  (while all
Per Abrahamsen's avatar
Per Abrahamsen committed
413 414 415 416
    (setq this (car all)
	  all (cdr all)
	  symbol (nth 0 this)
	  group (nth 1 this)
417
	  type (nth 2 this)
418
	  version (nth 3 this)
419 420 421 422
	  ;; 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)
423
		     (when (default-boundp symbol)
Lute Kamstra's avatar
Lute Kamstra committed
424
		       (funcall quoter (default-value symbol))))
425 426 427 428 429 430 431 432
	  ;; 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))
433 434
		      ((string-match "\\`mac-" (symbol-name symbol))
		       (eq window-system 'mac))
435
		      ((string-match "\\`x-.*gtk" (symbol-name symbol))
436
		       (or (boundp 'gtk)
Eli Zaretskii's avatar
Eli Zaretskii committed
437 438
			   (and window-system
				(not (eq window-system 'pc))
439
				(not (eq window-system 'mac))
440
				(not (eq system-type 'windows-nt)))))
441 442
		      ((string-match "\\`x-" (symbol-name symbol))
		       (fboundp 'x-create-frame))
443 444 445 446
		      ((string-match "selection" (symbol-name symbol))
		       (fboundp 'x-selection-exists-p))
		      ((string-match "fringe" (symbol-name symbol))
		       (fboundp 'define-fringe-bitmap))
447
		      (t t))))
Per Abrahamsen's avatar
Per Abrahamsen committed
448 449
    (if (not (boundp symbol))
	;; If variables are removed from C code, give an error here!
450 451
	(and native-p
	     (message "Note, built-in variable `%S' not bound" symbol))
452 453
      ;; Save the standard value, unless we already did.
      (or (get symbol 'standard-value)
454
	  (put symbol 'standard-value (list standard)))
455 456 457 458 459 460
      ;; 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.
461 462
	(put symbol 'custom-type type)
	(put symbol 'custom-version version)))))
463

Dave Love's avatar
Dave Love committed
464
(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
465 466
(custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
		     'custom-variable)
467 468 469 470
(put 'selection-coding-system 'custom-set
     (lambda (symbol value)
       (set-selection-coding-system value)
       (set symbol value)))
Dave Love's avatar
Dave Love committed
471

472 473 474 475 476 477
;; 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
478

Miles Bader's avatar
Miles Bader committed
479
;;; arch-tag: 4502730d-bcb3-4f5e-99a3-a86f2d54af60
480
;;; cus-start.el ends here