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