lisp/cus-start.el

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