cus-start.el 17.3 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
;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
14 15 16 17 18 19 20 21 22
;; 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 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))))
131
	     (selection-coding-system mule coding-system)
Per Abrahamsen's avatar
Per Abrahamsen committed
132
	     ;; dired.c
133
	     (completion-ignored-extensions dired
Per Abrahamsen's avatar
Per Abrahamsen committed
134
					    (repeat (string :format "%v")))
135
	     ;; dispnew.c
Per Abrahamsen's avatar
Per Abrahamsen committed
136 137 138 139 140 141 142 143 144
	     (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)
145 146 147
	     (max-mini-window-height limits
				     (choice (const :tag "quarter screen" nil)
					     number))
Per Abrahamsen's avatar
Per Abrahamsen committed
148 149 150 151 152 153
	     (stack-trace-on-error debug
				   (choice (const :tag "off")
					   (repeat :menu-tag "When"
						   :value (nil)
						   (symbol :format "%v"))
					   (const :tag "always" t)))
154
	     (debug-on-error debug
Per Abrahamsen's avatar
Per Abrahamsen committed
155 156 157 158 159 160
			     (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)))
161 162 163 164 165 166
	     (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
167 168
	     ;; fileio.c
	     (insert-default-directory minibuffer boolean)
169
	     (read-file-name-completion-ignore-case minibuffer boolean "22.1")
Dave Love's avatar
Dave Love committed
170
	     ;; fns.c
171
	     (use-dialog-box menu boolean "21.1")
172
	     (use-file-dialog menu boolean "22.1")
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 180
	     (mouse-highlight mouse (choice (const :tag "disabled" nil)
					    (const :tag "always shown" t)
					    (other :tag "hidden by keypress" 1)))
181
	     ;; fringe.c
182
	     (overflow-newline-into-fringe fringe boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
183
	     ;; indent.c
184
	     (indent-tabs-mode indent boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
185 186 187 188 189
	     ;; 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
190
	     (echo-keystrokes minibuffer number)
Per Abrahamsen's avatar
Per Abrahamsen committed
191
	     (polling-period keyboard integer)
192 193
	     (double-click-time mouse (restricted-sexp
				       :match-alternatives (integerp 'nil 't)))
194
	     (double-click-fuzz mouse integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
195 196 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)
	     (suggest-key-bindings keyboard (choice (const :tag "off" nil)
						    (integer :tag "time" 2)
201
						    (other :tag "on")))
202 203
	     ;; macselect.c
	     (mac-dnd-known-types mac (repeat string) "22.1")
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
	     ;; 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")
231 232 233 234 235 236 237
	     (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")
238

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

Dave Love's avatar
Dave Love committed
452
(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
453 454
(custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
		     'custom-variable)
455 456 457 458
(put 'selection-coding-system 'custom-set
     (lambda (symbol value)
       (set-selection-coding-system value)
       (set symbol value)))
Dave Love's avatar
Dave Love committed
459

460 461 462 463 464 465
;; 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
466

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