| 1 | ;;; cus-start.el --- define customization properties of builtins |
| 2 | ;; |
| 3 | ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, |
| 4 | ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
| 5 | ;; |
| 6 | ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> |
| 7 | ;; Keywords: internal |
| 8 | ;; Package: emacs |
| 9 | |
| 10 | ;; This file is part of GNU Emacs. |
| 11 | |
| 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
| 13 | ;; it under the terms of the GNU General Public License as published by |
| 14 | ;; the Free Software Foundation, either version 3 of the License, or |
| 15 | ;; (at your option) any later version. |
| 16 | |
| 17 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 20 | ;; GNU General Public License for more details. |
| 21 | |
| 22 | ;; You should have received a copy of the GNU General Public License |
| 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
| 24 | |
| 25 | ;;; Commentary: |
| 26 | ;; |
| 27 | ;; This file adds customize support for built-in variables. |
| 28 | |
| 29 | ;; While dumping Emacs, this file is loaded, but it only records |
| 30 | ;; the standard values; it does not do the rest of the job. |
| 31 | ;; Later on, if the user makes a customization buffer, |
| 32 | ;; this file is loaded again with (require 'cus-start); |
| 33 | ;; then it does the whole job. |
| 34 | |
| 35 | ;;; Code: |
| 36 | |
| 37 | (let ((all '(;; alloc.c |
| 38 | (gc-cons-threshold alloc integer) |
| 39 | (garbage-collection-messages alloc boolean) |
| 40 | ;; buffer.c |
| 41 | (mode-line-format mode-line sexp) ;Hard to do right. |
| 42 | (major-mode internal function) |
| 43 | (case-fold-search matching boolean) |
| 44 | (fill-column fill integer) |
| 45 | (left-margin fill integer) |
| 46 | (tab-width editing-basics integer) |
| 47 | (ctl-arrow display boolean) |
| 48 | (truncate-lines display boolean) |
| 49 | (word-wrap display boolean) |
| 50 | (selective-display-ellipses display boolean) |
| 51 | (indicate-empty-lines fringe boolean) |
| 52 | (indicate-buffer-boundaries |
| 53 | fringe |
| 54 | (choice |
| 55 | (const :tag "No indicators" nil) |
| 56 | (const :tag "On left, with arrows" left) |
| 57 | (const :tag "On right, with arrows" right) |
| 58 | (set :tag "Pick your own design" |
| 59 | :value ((t . nil)) |
| 60 | :format "%{%t%}:\n%v\n%d" |
| 61 | :doc "You can specify a default and then override it \ |
| 62 | for individual indicators. |
| 63 | Leaving \"Default\" unchecked is equivalent with specifying a default of |
| 64 | \"Do not show\"." |
| 65 | (choice :tag "Default" |
| 66 | :value (t . nil) |
| 67 | (const :tag "Do not show" (t . nil)) |
| 68 | (const :tag "On the left" (t . left)) |
| 69 | (const :tag "On the right" (t . right))) |
| 70 | (choice :tag "Top" |
| 71 | :value (top . left) |
| 72 | (const :tag "Do not show" (top . nil)) |
| 73 | (const :tag "On the left" (top . left)) |
| 74 | (const :tag "On the right" (top . right))) |
| 75 | (choice :tag "Bottom" |
| 76 | :value (bottom . left) |
| 77 | (const :tag "Do not show" (bottom . nil)) |
| 78 | (const :tag "On the left" (bottom . left)) |
| 79 | (const :tag "On the right" (bottom . right))) |
| 80 | (choice :tag "Up arrow" |
| 81 | :value (up . left) |
| 82 | (const :tag "Do not show" (up . nil)) |
| 83 | (const :tag "On the left" (up . left)) |
| 84 | (const :tag "On the right" (up . right))) |
| 85 | (choice :tag "Down arrow" |
| 86 | :value (down . left) |
| 87 | (const :tag "Do not show" (down . nil)) |
| 88 | (const :tag "On the left" (down . left)) |
| 89 | (const :tag "On the right" (down . right)))) |
| 90 | (other :tag "On left, no arrows" t))) |
| 91 | (scroll-up-aggressively windows |
| 92 | (choice (const :tag "off" nil) number) |
| 93 | "21.1") |
| 94 | (scroll-down-aggressively windows |
| 95 | (choice (const :tag "off" nil) number) |
| 96 | "21.1") |
| 97 | (line-spacing display (choice (const :tag "none" nil) integer) |
| 98 | "22.1") |
| 99 | (cursor-in-non-selected-windows |
| 100 | cursor boolean nil t :tag "Cursor In Non-selected Windows" |
| 101 | :set #'(lambda (symbol value) |
| 102 | (set-default symbol value) |
| 103 | (force-mode-line-update t))) |
| 104 | ;; callint.c |
| 105 | (mark-even-if-inactive editing-basics boolean) |
| 106 | ;; callproc.c |
| 107 | (shell-file-name execute file) |
| 108 | (exec-path execute |
| 109 | (repeat (choice (const :tag "default directory" nil) |
| 110 | (directory :format "%v")))) |
| 111 | ;; charset.c |
| 112 | (charset-map-path installation |
| 113 | (repeat (directory :format "%v"))) |
| 114 | ;; coding.c |
| 115 | (inhibit-eol-conversion mule boolean) |
| 116 | (eol-mnemonic-undecided mule string) |
| 117 | (eol-mnemonic-unix mule string) |
| 118 | (eol-mnemonic-dos mule string) |
| 119 | (eol-mnemonic-mac mule string) |
| 120 | (file-coding-system-alist |
| 121 | mule |
| 122 | (alist |
| 123 | :key-type (regexp :tag "File regexp") |
| 124 | :value-type (choice |
| 125 | :value (undecided . undecided) |
| 126 | (cons :tag "Encoding/decoding pair" |
| 127 | :value (undecided . undecided) |
| 128 | (coding-system :tag "Decoding") |
| 129 | (coding-system :tag "Encoding")) |
| 130 | (coding-system |
| 131 | :tag "Single coding system" |
| 132 | :value undecided |
| 133 | :match (lambda (widget value) |
| 134 | (and value (not (functionp value))))) |
| 135 | (function :value ignore)))) |
| 136 | ;; dired.c |
| 137 | (completion-ignored-extensions dired |
| 138 | (repeat (string :format "%v"))) |
| 139 | ;; dispnew.c |
| 140 | (baud-rate display integer) |
| 141 | (inverse-video display boolean) |
| 142 | (visible-bell display boolean) |
| 143 | (no-redraw-on-reenter display boolean) |
| 144 | ;; editfns.c |
| 145 | (user-full-name mail string) |
| 146 | ;; eval.c |
| 147 | (max-specpdl-size limits integer) |
| 148 | (max-lisp-eval-depth limits integer) |
| 149 | (max-mini-window-height limits |
| 150 | (choice (const :tag "quarter screen" nil) |
| 151 | number) "23.1") |
| 152 | (stack-trace-on-error debug |
| 153 | (choice (const :tag "off") |
| 154 | (repeat :menu-tag "When" |
| 155 | :value (nil) |
| 156 | (symbol :format "%v")) |
| 157 | (const :tag "always" t))) |
| 158 | (debug-on-error debug |
| 159 | (choice (const :tag "off") |
| 160 | (repeat :menu-tag "When" |
| 161 | :value (nil) |
| 162 | (symbol :format "%v")) |
| 163 | (const :tag "always" t))) |
| 164 | (debug-ignored-errors debug (repeat (choice symbol regexp))) |
| 165 | (debug-on-quit debug |
| 166 | (choice (const :tag "off") |
| 167 | (repeat :menu-tag "When" |
| 168 | :value (nil) |
| 169 | (symbol :format "%v")) |
| 170 | (const :tag "always" t))) |
| 171 | ;; fileio.c |
| 172 | (delete-by-moving-to-trash auto-save boolean "23.1") |
| 173 | (auto-save-visited-file-name auto-save boolean) |
| 174 | ;; fns.c |
| 175 | (use-dialog-box menu boolean "21.1") |
| 176 | (use-file-dialog menu boolean "22.1") |
| 177 | (focus-follows-mouse frames boolean "20.3") |
| 178 | ;; frame.c |
| 179 | (default-frame-alist frames |
| 180 | (repeat (cons :format "%v" |
| 181 | (symbol :tag "Parameter") |
| 182 | (sexp :tag "Value")))) |
| 183 | (mouse-highlight mouse (choice (const :tag "disabled" nil) |
| 184 | (const :tag "always shown" t) |
| 185 | (other :tag "hidden by keypress" 1)) |
| 186 | "22.1") |
| 187 | (make-pointer-invisible mouse boolean "23.2") |
| 188 | ;; fringe.c |
| 189 | (overflow-newline-into-fringe fringe boolean) |
| 190 | ;; indent.c |
| 191 | (indent-tabs-mode indent boolean) |
| 192 | ;; keyboard.c |
| 193 | (meta-prefix-char keyboard character) |
| 194 | (auto-save-interval auto-save integer) |
| 195 | (auto-save-timeout auto-save (choice (const :tag "off" nil) |
| 196 | (integer :format "%v"))) |
| 197 | (echo-keystrokes minibuffer number) |
| 198 | (polling-period keyboard integer) |
| 199 | (double-click-time mouse (restricted-sexp |
| 200 | :match-alternatives (integerp 'nil 't))) |
| 201 | (double-click-fuzz mouse integer "22.1") |
| 202 | (inhibit-local-menu-bar-menus menu boolean) |
| 203 | (help-char keyboard character) |
| 204 | (help-event-list keyboard (repeat (sexp :format "%v"))) |
| 205 | (menu-prompting menu boolean) |
| 206 | (select-active-regions killing |
| 207 | (choice (const :tag "always" t) |
| 208 | (const :tag "only shift-selection or mouse-drag" only) |
| 209 | (const :tag "off" nil)) |
| 210 | "24.1") |
| 211 | (suggest-key-bindings keyboard (choice (const :tag "off" nil) |
| 212 | (integer :tag "time" 2) |
| 213 | (other :tag "on"))) |
| 214 | |
| 215 | ;; This is not good news because it will use the wrong |
| 216 | ;; version-specific directories when you upgrade. We need |
| 217 | ;; customization of the front of the list, maintaining the standard |
| 218 | ;; value intact at the back. |
| 219 | ;;; (load-path environment |
| 220 | ;;; (repeat (choice :tag "[Current dir?]" |
| 221 | ;;; :format "%[Current dir?%] %v" |
| 222 | ;;; (const :tag " current dir" nil) |
| 223 | ;;; (directory :format "%v")))) |
| 224 | ;; minibuf.c |
| 225 | (enable-recursive-minibuffers minibuffer boolean) |
| 226 | (history-length minibuffer |
| 227 | (choice (const :tag "Infinite" t) integer) |
| 228 | "22.1") |
| 229 | (history-delete-duplicates minibuffer boolean "22.1") |
| 230 | (read-buffer-completion-ignore-case minibuffer boolean "23.1") |
| 231 | |
| 232 | (minibuffer-prompt-properties |
| 233 | minibuffer |
| 234 | (list |
| 235 | (checklist :inline t |
| 236 | (const :tag "Read-Only" |
| 237 | :doc "Prevent prompt from being modified" |
| 238 | :format "%t%n%h" |
| 239 | :inline t |
| 240 | (read-only t)) |
| 241 | (const :tag "Don't Enter" |
| 242 | :doc "Prevent point from ever entering prompt" |
| 243 | :format "%t%n%h" |
| 244 | :inline t |
| 245 | (point-entered minibuffer-avoid-prompt))) |
| 246 | (repeat :inline t |
| 247 | :tag "Other Properties" |
| 248 | (list :inline t |
| 249 | :format "%v" |
| 250 | (symbol :tag "Property") |
| 251 | (sexp :tag "Value")))) |
| 252 | "21.1") |
| 253 | (minibuffer-auto-raise minibuffer boolean) |
| 254 | ;; options property set at end |
| 255 | (read-buffer-function minibuffer |
| 256 | (choice (const nil) |
| 257 | (function-item iswitchb-read-buffer) |
| 258 | function)) |
| 259 | ;; msdos.c |
| 260 | (dos-unsupported-char-glyph display integer) |
| 261 | ;; nsterm.m |
| 262 | (ns-control-modifier |
| 263 | ns |
| 264 | (choice (const :tag "No modifier" nil) |
| 265 | (const control) (const meta) |
| 266 | (const alt) (const hyper) |
| 267 | (const super)) "23.1") |
| 268 | (ns-command-modifier |
| 269 | ns |
| 270 | (choice (const :tag "No modifier" nil) |
| 271 | (const control) (const meta) |
| 272 | (const alt) (const hyper) |
| 273 | (const super)) "23.1") |
| 274 | (ns-alternate-modifier |
| 275 | ns |
| 276 | (choice (const :tag "No modifier (work as alternate/option)" none) |
| 277 | (const control) (const meta) |
| 278 | (const alt) (const hyper) |
| 279 | (const super)) "23.1") |
| 280 | (ns-right-alternate-modifier |
| 281 | ns |
| 282 | (choice (const :tag "No modifier (work as alternate/option)" none) |
| 283 | (const :tag "Use the value of ns-alternate-modifier" |
| 284 | left) |
| 285 | (const control) (const meta) |
| 286 | (const alt) (const hyper) |
| 287 | (const super)) "23.3") |
| 288 | (ns-function-modifier |
| 289 | ns |
| 290 | (choice (const :tag "No modifier (work as function)" none) |
| 291 | (const control) (const meta) |
| 292 | (const alt) (const hyper) |
| 293 | (const super)) "23.1") |
| 294 | (ns-antialias-text ns boolean "23.1") |
| 295 | ;; process.c |
| 296 | (delete-exited-processes processes-basics boolean) |
| 297 | ;; syntax.c |
| 298 | (parse-sexp-ignore-comments editing-basics boolean) |
| 299 | (words-include-escapes editing-basics boolean) |
| 300 | (open-paren-in-column-0-is-defun-start editing-basics boolean |
| 301 | "21.1") |
| 302 | ;; term.c |
| 303 | (visible-cursor cursor boolean "22.1") |
| 304 | ;; undo.c |
| 305 | (undo-limit undo integer) |
| 306 | (undo-strong-limit undo integer) |
| 307 | (undo-outer-limit undo |
| 308 | (choice integer |
| 309 | (const :tag "No limit" |
| 310 | :format "%t\n%d" |
| 311 | :doc |
| 312 | "With this choice, \ |
| 313 | the undo info for the current command never gets discarded. |
| 314 | This should only be chosen under exceptional circumstances, |
| 315 | since it could result in memory overflow and make Emacs crash." |
| 316 | nil)) |
| 317 | "22.1") |
| 318 | ;; window.c |
| 319 | (temp-buffer-show-function windows (choice (const nil) function)) |
| 320 | (next-screen-context-lines windows integer) |
| 321 | (window-min-height windows integer) |
| 322 | (window-min-width windows integer) |
| 323 | (scroll-preserve-screen-position |
| 324 | windows (choice |
| 325 | (const :tag "Off (nil)" :value nil) |
| 326 | (const :tag "Full screen (t)" :value t) |
| 327 | (other :tag "Always" 1)) "22.1") |
| 328 | (recenter-redisplay windows |
| 329 | (choice |
| 330 | (const :tag "Never (nil)" :value nil) |
| 331 | (const :tag "Only on ttys" :value tty) |
| 332 | (other :tag "Always" t)) |
| 333 | "23.1") |
| 334 | ;; xdisp.c |
| 335 | (show-trailing-whitespace whitespace-faces boolean nil nil |
| 336 | :safe booleanp) |
| 337 | (scroll-step windows integer) |
| 338 | (scroll-conservatively windows integer) |
| 339 | (scroll-margin windows integer) |
| 340 | (hscroll-margin windows integer "22.1") |
| 341 | (hscroll-step windows number "22.1") |
| 342 | (truncate-partial-width-windows display boolean "23.1") |
| 343 | (mode-line-inverse-video mode-line boolean) |
| 344 | (mode-line-in-non-selected-windows mode-line boolean "22.1") |
| 345 | (line-number-display-limit display |
| 346 | (choice integer |
| 347 | (const :tag "No limit" nil))) |
| 348 | (line-number-display-limit-width display integer "22.1") |
| 349 | (highlight-nonselected-windows display boolean) |
| 350 | (message-log-max debug (choice (const :tag "Disable" nil) |
| 351 | (integer :menu-tag "lines" |
| 352 | :format "%v") |
| 353 | (other :tag "Unlimited" t))) |
| 354 | (unibyte-display-via-language-environment mule boolean) |
| 355 | (blink-cursor-alist cursor alist "22.1") |
| 356 | (overline-margin display integer "22.1") |
| 357 | (underline-minimum-offset display integer "23.1") |
| 358 | (mouse-autoselect-window |
| 359 | display (choice |
| 360 | (const :tag "Off (nil)" :value nil) |
| 361 | (const :tag "Immediate" :value t) |
| 362 | (number :tag "Delay by secs" :value 0.5)) "22.1") |
| 363 | (tool-bar-style |
| 364 | frames (choice |
| 365 | (const :tag "Images" :value image) |
| 366 | (const :tag "Text" :value text) |
| 367 | (const :tag "Both" :value both) |
| 368 | (const :tag "Both-horiz" :value both-horiz) |
| 369 | (const :tag "Text-image-horiz" :value text-image-horiz) |
| 370 | (const :tag "System default" :value nil)) "23.3") |
| 371 | (tool-bar-max-label-size frames integer "23.3") |
| 372 | (auto-hscroll-mode scrolling boolean "21.1") |
| 373 | (display-hourglass cursor boolean) |
| 374 | (hourglass-delay cursor number) |
| 375 | |
| 376 | ;; xfaces.c |
| 377 | (scalable-fonts-allowed display boolean "22.1") |
| 378 | ;; xfns.c |
| 379 | (x-bitmap-file-path installation |
| 380 | (repeat (directory :format "%v"))) |
| 381 | (x-gtk-use-old-file-dialog menu boolean "22.1") |
| 382 | (x-gtk-show-hidden-files menu boolean "22.1") |
| 383 | (x-gtk-file-dialog-help-text menu boolean "22.1") |
| 384 | (x-gtk-whole-detached-tool-bar x boolean "22.1") |
| 385 | (x-gtk-use-system-tooltips tooltip boolean "23.3") |
| 386 | ;; xterm.c |
| 387 | (x-use-underline-position-properties display boolean "22.1") |
| 388 | (x-underline-at-descent-line display boolean "22.1") |
| 389 | (x-stretch-cursor display boolean "21.1") |
| 390 | ;; xsettings.c |
| 391 | (font-use-system-font font-selection boolean "23.2"))) |
| 392 | this symbol group type standard version native-p rest prop propval |
| 393 | ;; This function turns a value |
| 394 | ;; into an expression which produces that value. |
| 395 | (quoter (lambda (sexp) |
| 396 | (if (or (memq sexp '(t nil)) |
| 397 | (keywordp sexp) |
| 398 | (and (listp sexp) |
| 399 | (memq (car sexp) '(lambda))) |
| 400 | (stringp sexp) |
| 401 | (numberp sexp)) |
| 402 | sexp |
| 403 | (list 'quote sexp))))) |
| 404 | (while all |
| 405 | (setq this (car all) |
| 406 | all (cdr all) |
| 407 | symbol (nth 0 this) |
| 408 | group (nth 1 this) |
| 409 | type (nth 2 this) |
| 410 | version (nth 3 this) |
| 411 | ;; If we did not specify any standard value expression above, |
| 412 | ;; use the current value as the standard value. |
| 413 | standard (if (nthcdr 4 this) |
| 414 | (nth 4 this) |
| 415 | (when (default-boundp symbol) |
| 416 | (funcall quoter (default-value symbol)))) |
| 417 | rest (nthcdr 5 this) |
| 418 | ;; Don't complain about missing variables which are |
| 419 | ;; irrelevant to this platform. |
| 420 | native-p (save-match-data |
| 421 | (cond |
| 422 | ((string-match "\\`dos-" (symbol-name symbol)) |
| 423 | (eq system-type 'ms-dos)) |
| 424 | ((string-match "\\`w32-" (symbol-name symbol)) |
| 425 | (eq system-type 'windows-nt)) |
| 426 | ((string-match "\\`ns-" (symbol-name symbol)) |
| 427 | (featurep 'ns)) |
| 428 | ((string-match "\\`x-.*gtk" (symbol-name symbol)) |
| 429 | (featurep 'gtk)) |
| 430 | ((string-match "\\`x-" (symbol-name symbol)) |
| 431 | (fboundp 'x-create-frame)) |
| 432 | ((string-match "selection" (symbol-name symbol)) |
| 433 | (fboundp 'x-selection-exists-p)) |
| 434 | ((string-match "fringe" (symbol-name symbol)) |
| 435 | (fboundp 'define-fringe-bitmap)) |
| 436 | ((equal "font-use-system-font" (symbol-name symbol)) |
| 437 | (featurep 'system-font-setting)) |
| 438 | ;; Conditioned on x-create-frame, because that's |
| 439 | ;; the condition for loadup.el to preload tool-bar.el. |
| 440 | ((string-match "tool-bar-" (symbol-name symbol)) |
| 441 | (fboundp 'x-create-frame)) |
| 442 | (t t)))) |
| 443 | (if (not (boundp symbol)) |
| 444 | ;; If variables are removed from C code, give an error here! |
| 445 | (and native-p |
| 446 | (message "Note, built-in variable `%S' not bound" symbol)) |
| 447 | ;; Save the standard value, unless we already did. |
| 448 | (or (get symbol 'standard-value) |
| 449 | (put symbol 'standard-value (list standard))) |
| 450 | ;; We need these properties independent of whether cus-start is loaded. |
| 451 | (if (setq prop (memq :safe rest)) |
| 452 | (put symbol 'safe-local-variable (cadr prop))) |
| 453 | (if (setq prop (memq :risky rest)) |
| 454 | (put symbol 'risky-local-variable (cadr prop))) |
| 455 | ;; If this is NOT while dumping Emacs, |
| 456 | ;; set up the rest of the customization info. |
| 457 | (unless purify-flag |
| 458 | ;; Add it to the right group. |
| 459 | (custom-add-to-group group symbol 'custom-variable) |
| 460 | ;; Set the type. |
| 461 | (put symbol 'custom-type type) |
| 462 | (put symbol 'custom-version version) |
| 463 | (while rest |
| 464 | (setq prop (car rest) |
| 465 | propval (cadr rest) |
| 466 | rest (nthcdr 2 rest)) |
| 467 | (cond ((memq prop '(:risky :safe))) ; handled above |
| 468 | ((eq prop :set) |
| 469 | (put symbol 'custom-set propval)) |
| 470 | ((eq prop :tag) |
| 471 | (put symbol 'custom-tag propval)))))))) |
| 472 | |
| 473 | (custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable) |
| 474 | (custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start |
| 475 | 'custom-variable) |
| 476 | |
| 477 | ;; Record cus-start as loaded if we have set up all the info that we can. |
| 478 | ;; Don't record it as loaded if we have only set up the standard values |
| 479 | ;; and safe/risky properties. |
| 480 | (unless purify-flag |
| 481 | (provide 'cus-start)) |
| 482 | |
| 483 | ;;; cus-start.el ends here |