cus-start.el 14.9 KB
Newer Older
1
;;; cus-start.el --- define customization properties of builtins
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
3 4
;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004,
;;   2005 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 56 57 58 59 60 61
	     (indicate-empty-lines fringe boolean "21.1")
	     (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
	      "22.1")
96 97 98 99 100 101
	     (scroll-up-aggressively windows
				     (choice (const :tag "off" nil) number)
				     "21.1")
	     (scroll-down-aggressively windows
				       (choice (const :tag "off" nil) number)
				       "21.1")
102
	     (line-spacing display (choice (const :tag "none" nil) integer))
Per Abrahamsen's avatar
Per Abrahamsen committed
103 104 105 106 107
	     ;; callint.c
	     (mark-even-if-inactive editing-basics boolean)
	     ;; callproc.c
	     (shell-file-name execute file)
	     (exec-path execute
108
			(repeat (choice (const :tag "default directory" nil)
109
					(directory :format "%v"))))
Dave Love's avatar
Dave Love committed
110 111
	     ;; coding.c
	     (inhibit-eol-conversion mule boolean)
112 113 114 115
	     (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
116 117 118 119 120 121 122 123 124 125 126 127 128
	     (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"))
			    (coding-system :tag "Single coding system"
					   :value undecided)
			    (function :value ignore))))
129
	     (selection-coding-system mule coding-system)
Per Abrahamsen's avatar
Per Abrahamsen committed
130
	     ;; dired.c
131
	     (completion-ignored-extensions dired
Per Abrahamsen's avatar
Per Abrahamsen committed
132
					    (repeat (string :format "%v")))
133
	     ;; dispnew.c
Per Abrahamsen's avatar
Per Abrahamsen committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
	     (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)
	     (stack-trace-on-error debug
				   (choice (const :tag "off")
					   (repeat :menu-tag "When"
						   :value (nil)
						   (symbol :format "%v"))
					   (const :tag "always" t)))
149
	     (debug-on-error debug
Per Abrahamsen's avatar
Per Abrahamsen committed
150 151 152 153 154 155
			     (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)))
156 157 158 159 160 161
	     (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
162 163
	     ;; fileio.c
	     (insert-default-directory minibuffer boolean)
164
	     (read-file-name-completion-ignore-case minibuffer boolean "22.1")
Dave Love's avatar
Dave Love committed
165
	     ;; fns.c
166
	     (use-dialog-box menu boolean "21.1")
167
	     (use-file-dialog menu boolean "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
168 169 170 171 172
	     ;; 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
173 174 175
	     (mouse-highlight mouse (choice (const :tag "disabled" nil)
					    (const :tag "always shown" t)
					    (other :tag "hidden by keypress" 1)))
176 177
	     ;; fringe.c
	     (overflow-newline-into-fringe fringe boolean "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
178 179 180 181 182 183 184
	     ;; indent.c
	     (indent-tabs-mode fill boolean)
	     ;; 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
185
	     (echo-keystrokes minibuffer number)
Per Abrahamsen's avatar
Per Abrahamsen committed
186
	     (polling-period keyboard integer)
187 188
	     (double-click-time mouse (restricted-sexp
				       :match-alternatives (integerp 'nil 't)))
189
	     (double-click-fuzz mouse integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
190 191 192 193 194 195
	     (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)
196
						    (other :tag "on")))
197

198 199 200 201
;; 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.
202
;;; 	     (load-path environment
203 204 205 206
;;; 			(repeat (choice :tag "[Current dir?]"
;;; 					:format "%[Current dir?%] %v"
;;; 					(const :tag " current dir" nil)
;;;					(directory :format "%v"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
207 208 209
	     ;; minibuf.c
	     (completion-auto-help minibuffer boolean)
	     (enable-recursive-minibuffers minibuffer boolean)
210 211 212
	     (history-length minibuffer
			     (choice (const :tag "Infinite" t)
				     integer))
213
	     (history-delete-duplicates minibuffer boolean)
214 215 216 217 218 219 220 221 222
	     (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))
223
			  (const :tag "Don't Enter"
224 225 226 227 228 229 230 231 232
				 :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
233 234
			     (sexp :tag "Value"))))
	      "21.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
235
	     (minibuffer-auto-raise minibuffer boolean)
Dave Love's avatar
Dave Love committed
236
	     ;; options property set at end
Dave Love's avatar
Dave Love committed
237 238 239 240
	     (read-buffer-function minibuffer
				   (choice (const nil)
					   (function-item iswitchb-read-buffer)
					   function))
241 242
	     ;; msdos.c
	     (dos-unsupported-char-glyph display integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
243
	     ;; process.c
244
	     (delete-exited-processes processes-basics boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
245 246 247
	     ;; syntax.c
	     (parse-sexp-ignore-comments editing-basics boolean)
	     (words-include-escapes editing-basics boolean)
248 249
	     (open-paren-in-column-0-is-defun-start editing-basics boolean
						    "21.1")
250 251 252 253 254 255 256 257 258 259 260 261 262 263
	     ;; 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
264
	     ;; window.c
265 266
	     (temp-buffer-show-function windows (choice (const nil) function))
	     (display-buffer-function windows (choice (const nil) function))
Per Abrahamsen's avatar
Per Abrahamsen committed
267 268
	     (pop-up-frames frames boolean)
	     (pop-up-frame-function frames function)
269 270
	     (special-display-buffer-names
	      frames
Per Abrahamsen's avatar
Per Abrahamsen committed
271 272 273 274 275 276 277 278 279 280 281 282
	      (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
283
	      frames
Per Abrahamsen's avatar
Per Abrahamsen committed
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
	      (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)
299
	     (even-window-heights windows boolean)
300
	     (next-screen-context-lines windows integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
301 302 303
	     (split-height-threshold windows integer)
	     (window-min-height windows integer)
	     (window-min-width windows integer)
304
	     (scroll-preserve-screen-position windows boolean)
Dave Love's avatar
Dave Love committed
305
	     (display-buffer-reuse-frames windows boolean "21.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
306 307
	     ;; xdisp.c
	     (scroll-step windows integer)
308 309
	     (scroll-conservatively windows integer)
	     (scroll-margin windows integer)
310 311
	     (hscroll-margin windows integer "21.3")
	     (hscroll-step windows number "21.3")
Per Abrahamsen's avatar
Per Abrahamsen committed
312
	     (truncate-partial-width-windows display boolean)
313
	     (mode-line-inverse-video modeline boolean)
314
	     (mode-line-in-non-selected-windows modeline boolean "21.3")
315 316 317
	     (line-number-display-limit display
					(choice integer
						(const :tag "No limit" nil)))
318
	     (line-number-display-limit-width display integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
319 320 321 322
	     (highlight-nonselected-windows display boolean)
	     (message-log-max debug (choice (const :tag "Disable" nil)
					    (integer :menu-tag "lines"
						     :format "%v")
323
					    (other :tag "Unlimited" t)))
324
	     (unibyte-display-via-language-environment mule boolean)
325
	     (blink-cursor-alist cursor alist "22.1")
326 327
	     ;; xfaces.c
	     (scalable-fonts-allowed display boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
328 329
	     ;; xfns.c
	     (x-bitmap-file-path installation
330
				 (repeat (directory :format "%v")))
331
	     (x-use-old-gtk-file-dialog menu boolean "22.1")
332
	     ;; xterm.c
333
             (mouse-autoselect-window display boolean "21.3")
334
	     (x-use-underline-position-properties display boolean "21.3")
335
	     (x-stretch-cursor display boolean "21.1")))
336
      this symbol group type standard version native-p
337 338 339 340
      ;; 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
341
			(keywordp sexp)
342 343 344
			(and (listp sexp)
			     (memq (car sexp) '(lambda)))
			(stringp sexp)
345
			(numberp sexp))
346 347
		    sexp
		  (list 'quote sexp)))))
348
  (while all
Per Abrahamsen's avatar
Per Abrahamsen committed
349 350 351 352
    (setq this (car all)
	  all (cdr all)
	  symbol (nth 0 this)
	  group (nth 1 this)
353
	  type (nth 2 this)
354
	  version (nth 3 this)
355 356 357 358
	  ;; 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)
359
		     (when (default-boundp symbol)
Lute Kamstra's avatar
Lute Kamstra committed
360
		       (funcall quoter (default-value symbol))))
361 362 363 364 365 366 367 368
	  ;; 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))
369
		      ((string-match "\\`x-.*gtk" (symbol-name symbol))
370
		       (or (boundp 'gtk)
Eli Zaretskii's avatar
Eli Zaretskii committed
371 372
			   (and window-system
				(not (eq window-system 'pc))
373
				(not (eq system-type 'windows-nt)))))
374 375
		      ((string-match "\\`x-" (symbol-name symbol))
		       (fboundp 'x-create-frame))
376 377 378 379
		      ((string-match "selection" (symbol-name symbol))
		       (fboundp 'x-selection-exists-p))
		      ((string-match "fringe" (symbol-name symbol))
		       (fboundp 'define-fringe-bitmap))
380
		      (t t))))
Per Abrahamsen's avatar
Per Abrahamsen committed
381 382
    (if (not (boundp symbol))
	;; If variables are removed from C code, give an error here!
383 384
	(and native-p
	     (message "Note, built-in variable `%S' not bound" symbol))
385 386
      ;; Save the standard value, unless we already did.
      (or (get symbol 'standard-value)
387
	  (put symbol 'standard-value (list standard)))
388 389 390 391 392 393
      ;; 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.
394 395
	(put symbol 'custom-type type)
	(put symbol 'custom-version version)))))
396

Dave Love's avatar
Dave Love committed
397
(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
398 399
(custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
		     'custom-variable)
400 401 402 403
(put 'selection-coding-system 'custom-set
     (lambda (symbol value)
       (set-selection-coding-system value)
       (set symbol value)))
Dave Love's avatar
Dave Love committed
404

405 406 407 408 409 410
;; 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
411

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