code.delx.au - gnu-emacs/blob - 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, 2007, 2008 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 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 (let ((all '(;; alloc.c
  37              (gc-cons-threshold alloc integer)
  38              (garbage-collection-messages alloc boolean)
  39              ;; buffer.c
  40              (mode-line-format mode-line sexp) ;Hard to do right.
  41              (default-major-mode internal function)
  42              (enable-multibyte-characters mule boolean)
  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              ;; callint.c
 100              (mark-even-if-inactive editing-basics boolean)
 101              (shift-select-mode editing-basics boolean)
 102              ;; callproc.c
 103              (shell-file-name execute file)
 104              (exec-path execute
 105                         (repeat (choice (const :tag "default directory" nil)
 106                                         (directory :format "%v"))))
 107              ;; charset.c
 108              (charset-map-path installation
 109                                (repeat (directory :format "%v")))
 110              ;; coding.c
 111              (inhibit-eol-conversion mule boolean)
 112              (eol-mnemonic-undecided mule string)
 113              (eol-mnemonic-unix mule string)
 114              (eol-mnemonic-dos mule string)
 115              (eol-mnemonic-mac mule string)
 116              (file-coding-system-alist
 117               mule
 118               (alist
 119                :key-type (regexp :tag "File regexp")
 120                :value-type (choice
 121                             :value (undecided . undecided)
 122                             (cons :tag "Encoding/decoding pair"
 123                                   :value (undecided . undecided)
 124                                   (coding-system :tag "Decoding")
 125                                   (coding-system :tag "Encoding"))
 126                             (coding-system
 127                              :tag "Single coding system"
 128                              :value undecided
 129                              :match (lambda (widget value)
 130                                       (and value (not (functionp value)))))
 131                             (function :value ignore))))
 132              ;; dired.c
 133              (completion-ignored-extensions dired
 134                                             (repeat (string :format "%v")))
 135              ;; dispnew.c
 136              (baud-rate display integer)
 137              (inverse-video display boolean)
 138              (visible-bell display boolean)
 139              (no-redraw-on-reenter display boolean)
 140              ;; editfns.c
 141              (user-full-name mail string)
 142              ;; eval.c
 143              (max-specpdl-size limits integer)
 144              (max-lisp-eval-depth limits integer)
 145              (max-mini-window-height limits
 146                                      (choice (const :tag "quarter screen" nil)
 147                                              number) "23.1")
 148              (stack-trace-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-on-error debug
 155                              (choice (const :tag "off")
 156                                      (repeat :menu-tag "When"
 157                                              :value (nil)
 158                                              (symbol :format "%v"))
 159                                      (const :tag "always" t)))
 160              (debug-ignored-errors debug (repeat (choice symbol regexp)))
 161              (debug-on-quit debug
 162                             (choice (const :tag "off")
 163                                     (repeat :menu-tag "When"
 164                                             :value (nil)
 165                                             (symbol :format "%v"))
 166                                     (const :tag "always" t)))
 167              ;; fileio.c
 168              (delete-by-moving-to-trash auto-save boolean "23.1")
 169              ;; fns.c
 170              (use-dialog-box menu boolean "21.1")
 171              (use-file-dialog menu boolean "22.1")
 172              (focus-follows-mouse frames boolean "20.3")
 173              ;; frame.c
 174              (default-frame-alist frames
 175                (repeat (cons :format "%v"
 176                              (symbol :tag "Parameter")
 177                              (sexp :tag "Value"))))
 178              (mouse-highlight mouse (choice (const :tag "disabled" nil)
 179                                             (const :tag "always shown" t)
 180                                             (other :tag "hidden by keypress" 1))
 181                               "22.1")
 182              ;; fringe.c
 183              (overflow-newline-into-fringe fringe boolean)
 184              ;; indent.c
 185              (indent-tabs-mode indent boolean)
 186              ;; keyboard.c
 187              (meta-prefix-char keyboard character)
 188              (auto-save-interval auto-save integer)
 189              (auto-save-timeout auto-save (choice (const :tag "off" nil)
 190                                                   (integer :format "%v")))
 191              (echo-keystrokes minibuffer number)
 192              (polling-period keyboard integer)
 193              (double-click-time mouse (restricted-sexp
 194                                        :match-alternatives (integerp 'nil 't)))
 195              (double-click-fuzz mouse integer "22.1")
 196              (inhibit-local-menu-bar-menus menu boolean)
 197              (help-char keyboard character)
 198              (help-event-list keyboard (repeat (sexp :format "%v")))
 199              (menu-prompting menu boolean)
 200              (suggest-key-bindings keyboard (choice (const :tag "off" nil)
 201                                                     (integer :tag "time" 2)
 202                                                     (other :tag "on")))
 203
 204 ;; This is not good news because it will use the wrong
 205 ;; version-specific directories when you upgrade.  We need
 206 ;; customization of the front of the list, maintaining the standard
 207 ;; value intact at the back.
 208 ;;;          (load-path environment
 209 ;;;                     (repeat (choice :tag "[Current dir?]"
 210 ;;;                                     :format "%[Current dir?%] %v"
 211 ;;;                                     (const :tag " current dir" nil)
 212 ;;;                                     (directory :format "%v"))))
 213              ;; minibuf.c
 214              (enable-recursive-minibuffers minibuffer boolean)
 215              (history-length minibuffer
 216                              (choice (const :tag "Infinite" t) integer)
 217                              "22.1")
 218              (history-delete-duplicates minibuffer boolean "22.1")
 219              (minibuffer-prompt-properties
 220               minibuffer
 221               (list
 222                (checklist :inline t
 223                           (const :tag "Read-Only"
 224                                  :doc "Prevent prompt from being modified"
 225                                  :format "%t%n%h"
 226                                  :inline t
 227                                  (read-only t))
 228                           (const :tag "Don't Enter"
 229                                  :doc "Prevent point from ever entering prompt"
 230                                  :format "%t%n%h"
 231                                  :inline t
 232                                  (point-entered minibuffer-avoid-prompt)))
 233                (repeat :inline t
 234                        :tag "Other Properties"
 235                        (list :inline t
 236                              :format "%v"
 237                              (symbol :tag "Property")
 238                              (sexp :tag "Value"))))
 239               "21.1")
 240              (minibuffer-auto-raise minibuffer boolean)
 241              ;; options property set at end
 242              (read-buffer-function minibuffer
 243                                    (choice (const nil)
 244                                            (function-item iswitchb-read-buffer)
 245                                            function))
 246              ;; msdos.c
 247              (dos-unsupported-char-glyph display integer)
 248              ;; process.c
 249              (delete-exited-processes processes-basics boolean)
 250              ;; syntax.c
 251              (parse-sexp-ignore-comments editing-basics boolean)
 252              (words-include-escapes editing-basics boolean)
 253              (open-paren-in-column-0-is-defun-start editing-basics boolean
 254                                                     "21.1")
 255              ;; term.c
 256              (visible-cursor cursor boolean "22.1")
 257              ;; undo.c
 258              (undo-limit undo integer)
 259              (undo-strong-limit undo integer)
 260              (undo-outer-limit undo
 261                                (choice integer
 262                                        (const :tag "No limit"
 263                                               :format "%t\n%d"
 264                                               :doc
 265                                               "With this choice, \
 266 the undo info for the current command never gets discarded.
 267 This should only be chosen under exceptional circumstances,
 268 since it could result in memory overflow and make Emacs crash."
 269                                               nil))
 270                                "22.1")
 271              ;; window.c
 272              (temp-buffer-show-function windows (choice (const nil) function))
 273              (next-screen-context-lines windows integer)
 274              (window-min-height windows integer)
 275              (window-min-width windows integer)
 276              (scroll-preserve-screen-position
 277               windows (choice
 278                        (const :tag "Off (nil)" :value nil)
 279                        (const :tag "Full screen (t)" :value t)
 280                        (other :tag "Always" 1)) "22.1")
 281              ;; xdisp.c
 282              (scroll-step windows integer)
 283              (scroll-conservatively windows integer)
 284              (scroll-margin windows integer)
 285              (hscroll-margin windows integer "22.1")
 286              (hscroll-step windows number "22.1")
 287              (truncate-partial-width-windows display boolean)
 288              (mode-line-inverse-video mode-line boolean)
 289              (mode-line-in-non-selected-windows mode-line boolean "22.1")
 290              (line-number-display-limit display
 291                                         (choice integer
 292                                                 (const :tag "No limit" nil)))
 293              (line-number-display-limit-width display integer "22.1")
 294              (highlight-nonselected-windows display boolean)
 295              (message-log-max debug (choice (const :tag "Disable" nil)
 296                                             (integer :menu-tag "lines"
 297                                                      :format "%v")
 298                                             (other :tag "Unlimited" t)))
 299              (unibyte-display-via-language-environment mule boolean)
 300              (blink-cursor-alist cursor alist "22.1")
 301              (overline-margin display integer "22.1")
 302              (underline-minimum-offset display integer "23.1")
 303              (mouse-autoselect-window
 304               display (choice
 305                        (const :tag "Off (nil)" :value nil)
 306                        (const :tag "Immediate" :value t)
 307                        (number :tag "Delay by secs" :value 0.5)) "22.1")
 308              ;; xfaces.c
 309              (scalable-fonts-allowed display boolean "22.1")
 310              ;; xfns.c
 311              (x-bitmap-file-path installation
 312                                  (repeat (directory :format "%v")))
 313              (x-gtk-use-old-file-dialog menu boolean "22.1")
 314              (x-gtk-show-hidden-files menu boolean "22.1")
 315              (x-gtk-file-dialog-help-text menu boolean "22.1")
 316              (x-gtk-whole-detached-tool-bar x boolean "22.1")
 317              ;; xterm.c
 318              (x-use-underline-position-properties display boolean "22.1")
 319              (x-underline-at-descent-line display boolean "22.1")
 320              (x-stretch-cursor display boolean "21.1")))
 321       this symbol group type standard version native-p
 322       ;; This function turns a value
 323       ;; into an expression which produces that value.
 324       (quoter (lambda (sexp)
 325                 (if (or (memq sexp '(t nil))
 326                         (keywordp sexp)
 327                         (and (listp sexp)
 328                              (memq (car sexp) '(lambda)))
 329                         (stringp sexp)
 330                         (numberp sexp))
 331                     sexp
 332                   (list 'quote sexp)))))
 333   (while all
 334     (setq this (car all)
 335           all (cdr all)
 336           symbol (nth 0 this)
 337           group (nth 1 this)
 338           type (nth 2 this)
 339           version (nth 3 this)
 340           ;; If we did not specify any standard value expression above,
 341           ;; use the current value as the standard value.
 342           standard (if (nthcdr 4 this)
 343                        (nth 4 this)
 344                      (when (default-boundp symbol)
 345                        (funcall quoter (default-value symbol))))
 346           ;; Don't complain about missing variables which are
 347           ;; irrelevant to this platform.
 348           native-p (save-match-data
 349                      (cond
 350                       ((string-match "\\`dos-" (symbol-name symbol))
 351                        (eq system-type 'ms-dos))
 352                       ((string-match "\\`w32-" (symbol-name symbol))
 353                        (eq system-type 'windows-nt))
 354                       ((string-match "\\`x-.*gtk" (symbol-name symbol))
 355                        (featurep 'gtk))
 356                       ((string-match "\\`x-" (symbol-name symbol))
 357                        (fboundp 'x-create-frame))
 358                       ((string-match "selection" (symbol-name symbol))
 359                        (fboundp 'x-selection-exists-p))
 360                       ((string-match "fringe" (symbol-name symbol))
 361                        (fboundp 'define-fringe-bitmap))
 362                       (t t))))
 363     (if (not (boundp symbol))
 364         ;; If variables are removed from C code, give an error here!
 365         (and native-p
 366              (message "Note, built-in variable `%S' not bound" symbol))
 367       ;; Save the standard value, unless we already did.
 368       (or (get symbol 'standard-value)
 369           (put symbol 'standard-value (list standard)))
 370       ;; If this is NOT while dumping Emacs,
 371       ;; set up the rest of the customization info.
 372       (unless purify-flag
 373         ;; Add it to the right group.
 374         (custom-add-to-group group symbol 'custom-variable)
 375         ;; Set the type.
 376         (put symbol 'custom-type type)
 377         (put symbol 'custom-version version)))))
 378
 379 (custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
 380 (custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
 381                      'custom-variable)
 382
 383 ;; Record cus-start as loaded
 384 ;; if we have set up all the info that we can set up.
 385 ;; Don't record cus-start as loaded
 386 ;; if we have set up only the standard values.
 387 (unless purify-flag
 388   (provide 'cus-start))
 389
 390 ;; arch-tag: 4502730d-bcb3-4f5e-99a3-a86f2d54af60
 391 ;;; cus-start.el ends here