cus-start.el 14.4 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 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
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; 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
15 16 17 18 19 20 21

;; 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
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
23

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

28 29 30 31 32
;; 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
33

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

Stefan Monnier's avatar
Stefan Monnier committed
36
(let ((all '(;; alloc.c
Per Abrahamsen's avatar
Per Abrahamsen committed
37
	     (gc-cons-threshold alloc integer)
Luc Teirlinck's avatar
Luc Teirlinck committed
38
	     (garbage-collection-messages alloc boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
39
	     ;; buffer.c
40
	     (mode-line-format mode-line sexp) ;Hard to do right.
Per Abrahamsen's avatar
Per Abrahamsen committed
41
	     (default-major-mode internal function)
42
	     (enable-multibyte-characters mule boolean)
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
	     ;; callint.c
	     (mark-even-if-inactive editing-basics boolean)
101
	     (shift-select-mode editing-basics boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
102 103 104
	     ;; callproc.c
	     (shell-file-name execute file)
	     (exec-path execute
105
			(repeat (choice (const :tag "default directory" nil)
106
					(directory :format "%v"))))
Dave Love's avatar
Dave Love committed
107
	     ;; charset.c
108 109
	     (charset-map-path installation
			       (repeat (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
	     (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"))
126 127 128 129 130
			    (coding-system
			     :tag "Single coding system"
			     :value undecided
			     :match (lambda (widget value)
				      (and value (not (functionp value)))))
Dave Love's avatar
Dave Love committed
131
			    (function :value ignore))))
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
	     (max-mini-window-height limits
				     (choice (const :tag "quarter screen" nil)
147
					     number) "23.1")
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)))
167 168
             ;; fileio.c
             (delete-by-moving-to-trash auto-save boolean "23.1")
169
	     (auto-save-visited-file-name auto-save boolean)
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")
173
	     (focus-follows-mouse frames boolean "20.3")
Per Abrahamsen's avatar
Per Abrahamsen committed
174 175 176 177 178
	     ;; 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
179 180
	     (mouse-highlight mouse (choice (const :tag "disabled" nil)
					    (const :tag "always shown" t)
181 182
					    (other :tag "hidden by keypress" 1))
			      "22.1")
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 201 202
	     (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)
203
						    (other :tag "on")))
204

205 206 207 208
;; 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.
209
;;; 	     (load-path environment
210 211 212 213
;;; 			(repeat (choice :tag "[Current dir?]"
;;; 					:format "%[Current dir?%] %v"
;;; 					(const :tag " current dir" nil)
;;;					(directory :format "%v"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
214 215
	     ;; minibuf.c
	     (enable-recursive-minibuffers minibuffer boolean)
216
	     (history-length minibuffer
217 218 219
			     (choice (const :tag "Infinite" t) integer)
			     "22.1")
	     (history-delete-duplicates minibuffer boolean "22.1")
220 221
	     (read-buffer-completion-ignore-case minibuffer boolean "23.1")

222 223 224 225 226 227 228 229 230
	     (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))
231
			  (const :tag "Don't Enter"
232 233 234 235 236 237 238 239 240
				 :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
241 242
			     (sexp :tag "Value"))))
	      "21.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
243
	     (minibuffer-auto-raise minibuffer boolean)
Dave Love's avatar
Dave Love committed
244
	     ;; options property set at end
Dave Love's avatar
Dave Love committed
245 246 247 248
	     (read-buffer-function minibuffer
				   (choice (const nil)
					   (function-item iswitchb-read-buffer)
					   function))
249 250
	     ;; msdos.c
	     (dos-unsupported-char-glyph display integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
251
	     ;; process.c
252
	     (delete-exited-processes processes-basics boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
253 254 255
	     ;; syntax.c
	     (parse-sexp-ignore-comments editing-basics boolean)
	     (words-include-escapes editing-basics boolean)
Kenichi Handa's avatar
Kenichi Handa committed
256 257
	     (open-paren-in-column-0-is-defun-start editing-basics boolean
						    "21.1")
Stefan Monnier's avatar
Stefan Monnier committed
258 259
             ;; term.c
             (visible-cursor cursor boolean "22.1")
260 261 262 263 264 265 266 267 268 269 270 271 272 273
	     ;; 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
274
	     ;; window.c
275
	     (temp-buffer-show-function windows (choice (const nil) function))
276
	     (next-screen-context-lines windows integer)
Per Abrahamsen's avatar
Per Abrahamsen committed
277 278
	     (window-min-height windows integer)
	     (window-min-width windows integer)
279 280 281 282
 	     (scroll-preserve-screen-position
 	      windows (choice
 		       (const :tag "Off (nil)" :value nil)
 		       (const :tag "Full screen (t)" :value t)
283
 		       (other :tag "Always" 1)) "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
284 285
	     ;; xdisp.c
	     (scroll-step windows integer)
286 287
	     (scroll-conservatively windows integer)
	     (scroll-margin windows integer)
Eli Zaretskii's avatar
Eli Zaretskii committed
288 289
	     (hscroll-margin windows integer "22.1")
	     (hscroll-step windows number "22.1")
290
	     (truncate-partial-width-windows display boolean "23.1")
291 292
	     (mode-line-inverse-video mode-line boolean)
	     (mode-line-in-non-selected-windows mode-line boolean "22.1")
293 294 295
	     (line-number-display-limit display
					(choice integer
						(const :tag "No limit" nil)))
296
	     (line-number-display-limit-width display integer "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
297 298 299 300
	     (highlight-nonselected-windows display boolean)
	     (message-log-max debug (choice (const :tag "Disable" nil)
					    (integer :menu-tag "lines"
						     :format "%v")
301
					    (other :tag "Unlimited" t)))
302
	     (unibyte-display-via-language-environment mule boolean)
303
	     (blink-cursor-alist cursor alist "22.1")
304
	     (overline-margin display integer "22.1")
305
	     (underline-minimum-offset display integer "23.1")
306 307 308 309 310
             (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")
311
	     ;; xfaces.c
312
	     (scalable-fonts-allowed display boolean "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
313 314
	     ;; xfns.c
	     (x-bitmap-file-path installation
315
				 (repeat (directory :format "%v")))
316
	     (x-gtk-use-old-file-dialog menu boolean "22.1")
Jan Djärv's avatar
Jan Djärv committed
317
	     (x-gtk-show-hidden-files menu boolean "22.1")
318
	     (x-gtk-file-dialog-help-text menu boolean "22.1")
319
	     (x-gtk-whole-detached-tool-bar x boolean "22.1")
320
	     ;; xterm.c
Eli Zaretskii's avatar
Eli Zaretskii committed
321
	     (x-use-underline-position-properties display boolean "22.1")
322
	     (x-underline-at-descent-line display boolean "22.1")
323
	     (x-stretch-cursor display boolean "21.1")))
324
      this symbol group type standard version native-p
325 326 327 328
      ;; 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
329
			(keywordp sexp)
330 331 332
			(and (listp sexp)
			     (memq (car sexp) '(lambda)))
			(stringp sexp)
333
			(numberp sexp))
334 335
		    sexp
		  (list 'quote sexp)))))
336
  (while all
Per Abrahamsen's avatar
Per Abrahamsen committed
337 338 339 340
    (setq this (car all)
	  all (cdr all)
	  symbol (nth 0 this)
	  group (nth 1 this)
341
	  type (nth 2 this)
342
	  version (nth 3 this)
343 344 345 346
	  ;; 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)
347
		     (when (default-boundp symbol)
Lute Kamstra's avatar
Lute Kamstra committed
348
		       (funcall quoter (default-value symbol))))
349 350 351 352 353 354 355 356
	  ;; 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))
357
		      ((string-match "\\`x-.*gtk" (symbol-name symbol))
Karoly Lorentey's avatar
Karoly Lorentey committed
358
		       (featurep 'gtk))
359 360
		      ((string-match "\\`x-" (symbol-name symbol))
		       (fboundp 'x-create-frame))
361 362 363 364
		      ((string-match "selection" (symbol-name symbol))
		       (fboundp 'x-selection-exists-p))
		      ((string-match "fringe" (symbol-name symbol))
		       (fboundp 'define-fringe-bitmap))
365
		      (t t))))
Per Abrahamsen's avatar
Per Abrahamsen committed
366 367
    (if (not (boundp symbol))
	;; If variables are removed from C code, give an error here!
368 369
	(and native-p
	     (message "Note, built-in variable `%S' not bound" symbol))
370 371
      ;; Save the standard value, unless we already did.
      (or (get symbol 'standard-value)
372
	  (put symbol 'standard-value (list standard)))
373 374 375 376 377 378
      ;; 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.
379 380
	(put symbol 'custom-type type)
	(put symbol 'custom-version version)))))
381

Dave Love's avatar
Dave Love committed
382
(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
Kenichi Handa's avatar
Kenichi Handa committed
383 384
(custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
		     'custom-variable)
Dave Love's avatar
Dave Love committed
385

386 387 388 389 390 391
;; 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
392

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