cus-start.el 14.5 KB
Newer Older
1
;;; cus-start.el --- define customization properties of builtins
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
Lute Kamstra's avatar
Lute Kamstra committed
3
;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2005 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
4 5 6 7
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: internal

Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21
;; 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
22 23
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
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

37
(let ((all '(;; abbrev.c
Per Abrahamsen's avatar
Per Abrahamsen committed
38 39 40 41
	     (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
42
	     (garbage-collection-messages alloc boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
43 44 45
	     ;; buffer.c
	     (mode-line-format modeline sexp) ;Hard to do right.
	     (default-major-mode internal function)
46
	     (enable-multibyte-characters mule boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
47 48 49 50 51 52 53
	     (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)
54 55 56 57 58 59 60
	     (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)
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 90 91 92
	       (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))))
93
	       (other :tag "On left, no arrows" t))
94
	      "22.1")
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")
Per Abrahamsen's avatar
Per Abrahamsen committed
101 102 103 104 105
	     ;; callint.c
	     (mark-even-if-inactive editing-basics boolean)
	     ;; callproc.c
	     (shell-file-name execute file)
	     (exec-path execute
106
			(repeat (choice (const :tag "default directory" nil)
107
					(directory :format "%v"))))
Dave Love's avatar
Dave Love committed
108 109
	     ;; coding.c
	     (inhibit-eol-conversion mule boolean)
110 111 112 113
	     (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
114 115 116 117 118 119 120 121 122 123 124 125 126
	     (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))))
127
	     (selection-coding-system mule coding-system)
Per Abrahamsen's avatar
Per Abrahamsen committed
128
	     ;; dired.c
129
	     (completion-ignored-extensions dired
Per Abrahamsen's avatar
Per Abrahamsen committed
130
					    (repeat (string :format "%v")))
131
	     ;; dispnew.c
Per Abrahamsen's avatar
Per Abrahamsen committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
	     (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)))
147
	     (debug-on-error debug
Per Abrahamsen's avatar
Per Abrahamsen committed
148 149 150 151 152 153
			     (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)))
154 155 156 157 158 159
	     (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
160 161
	     ;; fileio.c
	     (insert-default-directory minibuffer boolean)
162
	     (read-file-name-completion-ignore-case minibuffer boolean "22.1")
Dave Love's avatar
Dave Love committed
163
	     ;; fns.c
164
	     (use-dialog-box menu boolean "21.1")
165
	     (use-file-dialog menu boolean "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
166 167 168 169 170
	     ;; 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
171 172 173
	     (mouse-highlight mouse (choice (const :tag "disabled" nil)
					    (const :tag "always shown" t)
					    (other :tag "hidden by keypress" 1)))
Per Abrahamsen's avatar
Per Abrahamsen committed
174 175 176 177 178 179 180
	     ;; 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
181
	     (echo-keystrokes minibuffer number)
Per Abrahamsen's avatar
Per Abrahamsen committed
182
	     (polling-period keyboard integer)
183 184
	     (double-click-time mouse (restricted-sexp
				       :match-alternatives (integerp 'nil 't)))
185
	     (double-click-fuzz mouse integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
186 187 188 189 190 191
	     (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)
192
						    (other :tag "on")))
193

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

Dave Love's avatar
Dave Love committed
386
(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
387 388
(custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
		     'custom-variable)
389 390 391 392
(put 'selection-coding-system 'custom-set
     (lambda (symbol value)
       (set-selection-coding-system value)
       (set symbol value)))
Dave Love's avatar
Dave Love committed
393

394 395 396 397 398 399
;; 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
400

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