lisp/cus-start.el

   1 ;;; cus-start.el --- define customization properties of builtins
   2 ;;
   3 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
   4 ;;
   5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   6 ;; Keywords: internal
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  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 '(;; abbrev.c
  38              (abbrev-all-caps abbrev-mode boolean)
  39              (pre-abbrev-expand-hook abbrev-mode hook)
  40              ;; alloc.c
  41              (gc-cons-threshold alloc integer)
  42              (undo-limit undo integer)
  43              (undo-strong-limit undo integer)
  44              (garbage-collection-messages alloc boolean)
  45              ;; buffer.c
  46              (mode-line-format modeline sexp) ;Hard to do right.
  47              (default-major-mode internal function)
  48              (enable-multibyte-characters mule boolean)
  49              (case-fold-search matching boolean)
  50              (fill-column fill integer)
  51              (left-margin fill integer)
  52              (tab-width editing-basics integer)
  53              (ctl-arrow display boolean)
  54              (truncate-lines display boolean)
  55              (selective-display-ellipses display boolean)
  56              (transient-mark-mode editing-basics boolean)
  57              (indicate-empty-lines display boolean "21.1")
  58              (scroll-up-aggressively windows boolean "21.1")
  59              (scroll-down-aggressively windows boolean "21.1")
  60              ;; callint.c
  61              (mark-even-if-inactive editing-basics boolean)
  62              ;; callproc.c
  63              (shell-file-name execute file)
  64              (exec-path execute
  65                         (repeat (choice (const :tag "default" nil)
  66                                         (file :format "%v"))))
  67              ;; coding.c
  68              (inhibit-eol-conversion mule boolean)
  69              (eol-mnemonic-undecided mule string)
  70              (eol-mnemonic-unix mule string)
  71              (eol-mnemonic-dos mule string)
  72              (eol-mnemonic-mac mule string)
  73              (file-coding-system-alist
  74               mule
  75               (alist
  76                :key-type (regexp :tag "File regexp")
  77                :value-type (choice
  78                             :value (undecided . undecided)
  79                             (cons :tag "Encoding/decoding pair"
  80                                   :value (undecided . undecided)
  81                                   (coding-system :tag "Decoding")
  82                                   (coding-system :tag "Encoding"))
  83                             (coding-system :tag "Single coding system"
  84                                            :value undecided)
  85                             (function :value ignore))))
  86              ;; dired.c
  87              (completion-ignored-extensions dired
  88                                             (repeat (string :format "%v")))
  89              ;; dispnew.c
  90              (baud-rate display integer)
  91              (inverse-video display boolean)
  92              (visible-bell display boolean)
  93              (no-redraw-on-reenter display boolean)
  94              ;; editfns.c
  95              (user-full-name mail string)
  96              ;; eval.c
  97              (max-specpdl-size limits integer)
  98              (max-lisp-eval-depth limits integer)
  99              (stack-trace-on-error debug
 100                                    (choice (const :tag "off")
 101                                            (repeat :menu-tag "When"
 102                                                    :value (nil)
 103                                                    (symbol :format "%v"))
 104                                            (const :tag "always" t)))
 105              (debug-on-error debug
 106                              (choice (const :tag "off")
 107                                      (repeat :menu-tag "When"
 108                                              :value (nil)
 109                                              (symbol :format "%v"))
 110                                      (const :tag "always" t)))
 111              (debug-ignored-errors debug (repeat (choice symbol regexp)))
 112              (debug-on-quit debug
 113                             (choice (const :tag "off")
 114                                     (repeat :menu-tag "When"
 115                                             :value (nil)
 116                                             (symbol :format "%v"))
 117                                     (const :tag "always" t)))
 118              ;; fileio.c
 119              (insert-default-directory minibuffer boolean)
 120              ;; fns.c
 121              (use-dialog-box menu boolean "21.1")
 122              ;; frame.c
 123              (default-frame-alist frames
 124                (repeat (cons :format "%v"
 125                              (symbol :tag "Parameter")
 126                              (sexp :tag "Value"))))
 127              (mouse-highlight mouse (choice (const :tag "disabled" nil)
 128                                             (const :tag "always shown" t)
 129                                             (other :tag "hidden by keypress" 1)))
 130              ;; indent.c
 131              (indent-tabs-mode fill boolean)
 132              ;; keyboard.c
 133              (meta-prefix-char keyboard character)
 134              (auto-save-interval auto-save integer)
 135              (auto-save-timeout auto-save (choice (const :tag "off" nil)
 136                                                   (integer :format "%v")))
 137              (echo-keystrokes minibuffer number)
 138              (polling-period keyboard integer)
 139              (double-click-time mouse (restricted-sexp
 140                                        :match-alternatives (integerp 'nil 't)))
 141              (inhibit-local-menu-bar-menus menu boolean)
 142              (help-char keyboard character)
 143              (help-event-list keyboard (repeat (sexp :format "%v")))
 144              (menu-prompting menu boolean)
 145              (suggest-key-bindings keyboard (choice (const :tag "off" nil)
 146                                                     (integer :tag "time" 2)
 147                                                     (other :tag "on")))
 148
 149 ;; This is not good news because it will use the wrong
 150 ;; version-specific directories when you upgrade.  We need
 151 ;; customization of the front of the list, maintaining the standard
 152 ;; value intact at the back.
 153 ;;;          (load-path environment
 154 ;;;                     (repeat (choice :tag "[Current dir?]"
 155 ;;;                                     :format "%[Current dir?%] %v"
 156 ;;;                                     (const :tag " current dir" nil)
 157 ;;;                                     (directory :format "%v"))))
 158              ;; minibuf.c
 159              (completion-auto-help minibuffer boolean)
 160              (enable-recursive-minibuffers minibuffer boolean)
 161              (history-length minibuffer
 162                              (choice (const :tag "Infinite" t)
 163                                      integer))
 164              (minibuffer-prompt-properties
 165               minibuffer
 166               (list
 167                (checklist :inline t
 168                           (const :tag "Read-Only"
 169                                  :doc "Prevent prompt from being modified"
 170                                  :format "%t%n%h"
 171                                  :inline t
 172                                  (read-only t))
 173                           (const :tag "Inviolable"
 174                                  :doc "Prevent point from ever entering prompt"
 175                                  :format "%t%n%h"
 176                                  :inline t
 177                                  (point-entered minibuffer-avoid-prompt)))
 178                (repeat :inline t
 179                        :tag "Other Properties"
 180                        (list :inline t
 181                              :format "%v"
 182                              (symbol :tag "Property")
 183                              (sexp :tag "Value"))))
 184               "21.1")
 185              (minibuffer-auto-raise minibuffer boolean)
 186              ;; options property set at end
 187              (read-buffer-function minibuffer
 188                                    (choice (const nil)
 189                                            (function-item iswitchb-read-buffer)
 190                                            function))
 191              ;; msdos.c
 192              (dos-unsupported-char-glyph display integer)
 193              ;; process.c
 194              (delete-exited-processes processes-basics boolean)
 195              ;; syntax.c
 196              (parse-sexp-ignore-comments editing-basics boolean)
 197              (words-include-escapes editing-basics boolean)
 198              ;; window.c
 199              (temp-buffer-show-function windows (choice (const nil) function))
 200              (display-buffer-function windows (choice (const nil) function))
 201              (pop-up-frames frames boolean)
 202              (pop-up-frame-function frames function)
 203              (special-display-buffer-names
 204               frames
 205               (repeat (choice :tag "Buffer"
 206                               :value ""
 207                               (string :format "%v")
 208                               (cons :tag "With attributes"
 209                                     :format "%v"
 210                                     :value ("" . nil)
 211                                     (string :format "%v")
 212                                     (repeat :tag "Attributes"
 213                                             (cons :format "%v"
 214                                                   (symbol :tag "Parameter")
 215                                                   (sexp :tag "Value")))))))
 216              (special-display-regexps
 217               frames
 218               (repeat (choice :tag "Buffer"
 219                               :value ""
 220                               (regexp :format "%v")
 221                               (cons :tag "With attributes"
 222                                     :format "%v"
 223                                     :value ("" . nil)
 224                                     (regexp :format "%v")
 225                                     (repeat :tag "Attributes"
 226                                             (cons :format "%v"
 227                                                   (symbol :tag "Parameter")
 228                                                   (sexp :tag "Value")))))))
 229              (special-display-function frames function)
 230              (same-window-buffer-names windows (repeat (string :format "%v")))
 231              (same-window-regexps windows (repeat (regexp :format "%v")))
 232              (pop-up-windows windows boolean)
 233              (even-window-heights windows boolean)
 234              (next-screen-context-lines windows integer)
 235              (split-height-threshold windows integer)
 236              (window-min-height windows integer)
 237              (window-min-width windows integer)
 238              (scroll-preserve-screen-position windows boolean)
 239              (display-buffer-reuse-frames windows boolean "21.1")
 240              ;; xdisp.c
 241              (scroll-step windows integer)
 242              (scroll-conservatively windows integer)
 243              (scroll-margin windows integer)
 244              (hscroll-margin windows integer "21.3")
 245              (hscroll-step windows number "21.3")
 246              (truncate-partial-width-windows display boolean)
 247              (mode-line-inverse-video modeline boolean)
 248              (mode-line-in-non-selected-windows modeline boolean "21.3")
 249              (line-number-display-limit display
 250                                         (choice integer
 251                                                 (const :tag "No limit" nil)))
 252              (highlight-nonselected-windows display boolean)
 253              (message-log-max debug (choice (const :tag "Disable" nil)
 254                                             (integer :menu-tag "lines"
 255                                                      :format "%v")
 256                                             (other :tag "Unlimited" t)))
 257              (unibyte-display-via-language-environment mule boolean)
 258              ;; xfns.c
 259              (x-bitmap-file-path installation
 260                                  (repeat (directory :format "%v")))
 261              ;; xterm.c
 262              (mouse-autoselect-window display boolean "21.3")
 263              (x-use-underline-position-properties display boolean "21.3")
 264              (x-stretch-cursor display boolean "21.1")))
 265       this symbol group type native-p version
 266       ;; This function turns a value
 267       ;; into an expression which produces that value.
 268       (quoter (lambda (sexp)
 269                 (if (or (memq sexp '(t nil))
 270                         (keywordp sexp)
 271                         (and (listp sexp)
 272                              (memq (car sexp) '(lambda)))
 273                         (stringp sexp)
 274 ;;                      (and (fboundp 'characterp)
 275 ;;                           (characterp sexp))
 276                         (numberp sexp))
 277                     sexp
 278                   (list 'quote sexp)))))
 279   (while all
 280     (setq this (car all)
 281           all (cdr all)
 282           symbol (nth 0 this)
 283           group (nth 1 this)
 284           type (nth 2 this)
 285           version (nth 3 this)
 286           ;; Don't complain about missing variables which are
 287           ;; irrelevant to this platform.
 288           native-p (save-match-data
 289                      (cond
 290                       ((string-match "\\`dos-" (symbol-name symbol))
 291                        (eq system-type 'ms-dos))
 292                       ((string-match "\\`w32-" (symbol-name symbol))
 293                        (eq system-type 'windows-nt))
 294                       ((string-match "\\`x-" (symbol-name symbol))
 295                        (fboundp 'x-create-frame))
 296                       (t t))))
 297     (if (not (boundp symbol))
 298         ;; If variables are removed from C code, give an error here!
 299         (and native-p
 300              (message "Note, built-in variable `%S' not bound" symbol))
 301       ;; Save the standard value, unless we already did.
 302       (or (get symbol 'standard-value)
 303           (put symbol 'standard-value
 304                (list (funcall quoter (default-value symbol)))))
 305       ;; If this is NOT while dumping Emacs,
 306       ;; set up the rest of the customization info.
 307       (unless purify-flag
 308         ;; Add it to the right group.
 309         (custom-add-to-group group symbol 'custom-variable)
 310         ;; Set the type.
 311         (put symbol 'custom-type type)
 312         (put symbol 'custom-version version)))))
 313
 314 (custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
 315
 316 ;; Record cus-start as loaded
 317 ;; if we have set up all the info that we can set up.
 318 ;; Don't record cus-start as loaded
 319 ;; if we have set up only the standard values.
 320 (unless purify-flag
 321   (provide 'cus-start))
 322
 323 ;;; cus-start.el ends here