cus-start.el 15.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, 2009 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.
41
	     (major-mode internal function)
Per Abrahamsen's avatar
Per Abrahamsen committed
42 43 44 45 46 47
	     (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)
48
	     (word-wrap display boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
49
	     (selective-display-ellipses display boolean)
50
	     (indicate-empty-lines fringe boolean)
51 52 53 54 55 56
	     (indicate-buffer-boundaries
	      fringe
	      (choice
	       (const :tag "No indicators" nil)
	       (const :tag "On left, with arrows" left)
	       (const :tag "On right, with arrows" right)
57 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
	       (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))))
89
	       (other :tag "On left, no arrows" t)))
90 91 92 93 94 95
	     (scroll-up-aggressively windows
				     (choice (const :tag "off" nil) number)
				     "21.1")
	     (scroll-down-aggressively windows
				       (choice (const :tag "off" nil) number)
				       "21.1")
96 97
	     (line-spacing display (choice (const :tag "none" nil) integer)
			   "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
98 99 100 101 102
	     ;; callint.c
	     (mark-even-if-inactive editing-basics boolean)
	     ;; callproc.c
	     (shell-file-name execute file)
	     (exec-path execute
103
			(repeat (choice (const :tag "default directory" nil)
104
					(directory :format "%v"))))
Dave Love's avatar
Dave Love committed
105
	     ;; charset.c
106 107
	     (charset-map-path installation
			       (repeat (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
	     (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"))
124 125 126 127 128
			    (coding-system
			     :tag "Single coding system"
			     :value undecided
			     :match (lambda (widget value)
				      (and value (not (functionp value)))))
Dave Love's avatar
Dave Love committed
129
			    (function :value ignore))))
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
	     (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)
143 144
	     (max-mini-window-height limits
				     (choice (const :tag "quarter screen" nil)
145
					     number) "23.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
146 147 148 149 150 151
	     (stack-trace-on-error debug
				   (choice (const :tag "off")
					   (repeat :menu-tag "When"
						   :value (nil)
						   (symbol :format "%v"))
					   (const :tag "always" t)))
152
	     (debug-on-error debug
Per Abrahamsen's avatar
Per Abrahamsen committed
153 154 155 156 157 158
			     (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)))
159 160 161 162 163 164
	     (debug-on-quit debug
			    (choice (const :tag "off")
				    (repeat :menu-tag "When"
					    :value (nil)
					    (symbol :format "%v"))
				    (const :tag "always" t)))
165 166
             ;; fileio.c
             (delete-by-moving-to-trash auto-save boolean "23.1")
167
	     (auto-save-visited-file-name auto-save boolean)
Dave Love's avatar
Dave Love committed
168
	     ;; fns.c
169
	     (use-dialog-box menu boolean "21.1")
170
	     (use-file-dialog menu boolean "22.1")
171
	     (focus-follows-mouse frames boolean "20.3")
Per Abrahamsen's avatar
Per Abrahamsen committed
172 173 174 175 176
	     ;; 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
177 178
	     (mouse-highlight mouse (choice (const :tag "disabled" nil)
					    (const :tag "always shown" t)
179 180
					    (other :tag "hidden by keypress" 1))
			      "22.1")
181
	     (make-pointer-invisible mouse boolean "23.2")
182
	     ;; fringe.c
183
	     (overflow-newline-into-fringe fringe boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
184
	     ;; indent.c
185
	     (indent-tabs-mode indent boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
186 187 188 189 190
	     ;; 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
191
	     (echo-keystrokes minibuffer number)
Per Abrahamsen's avatar
Per Abrahamsen committed
192
	     (polling-period keyboard integer)
193 194
	     (double-click-time mouse (restricted-sexp
				       :match-alternatives (integerp 'nil 't)))
195
	     (double-click-fuzz mouse integer "22.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
196 197 198 199 200 201
	     (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)
202
						    (other :tag "on")))
203

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

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

Dave Love's avatar
Dave Love committed
415
(custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
Kenichi Handa's avatar
Kenichi Handa committed
416 417
(custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
		     'custom-variable)
Dave Love's avatar
Dave Love committed
418

419 420 421 422 423 424
;; 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
425

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