lisp/cus-start.el

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