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, 2009, 2010 Free Software Foundation, Inc.
   5 ;;
   6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   7 ;; Keywords: internal
   8 ;; Package: emacs
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  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 '(;; alloc.c
  38              (gc-cons-threshold alloc integer)
  39              (garbage-collection-messages alloc boolean)
  40              ;; buffer.c
  41              (mode-line-format mode-line sexp) ;Hard to do right.
  42              (major-mode internal function)
  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              ;; callproc.c
 102              (shell-file-name execute file)
 103              (exec-path execute
 104                         (repeat (choice (const :tag "default directory" nil)
 105                                         (directory :format "%v"))))
 106              ;; charset.c
 107              (charset-map-path installation
 108                                (repeat (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
 126                              :tag "Single coding system"
 127                              :value undecided
 128                              :match (lambda (widget value)
 129                                       (and value (not (functionp value)))))
 130                             (function :value ignore))))
 131              ;; dired.c
 132              (completion-ignored-extensions dired
 133                                             (repeat (string :format "%v")))
 134              ;; dispnew.c
 135              (baud-rate display integer)
 136              (inverse-video display boolean)
 137              (visible-bell display boolean)
 138              (no-redraw-on-reenter display boolean)
 139              ;; editfns.c
 140              (user-full-name mail string)
 141              ;; eval.c
 142              (max-specpdl-size limits integer)
 143              (max-lisp-eval-depth limits integer)
 144              (max-mini-window-height limits
 145                                      (choice (const :tag "quarter screen" nil)
 146                                              number) "23.1")
 147              (stack-trace-on-error debug
 148                                    (choice (const :tag "off")
 149                                            (repeat :menu-tag "When"
 150                                                    :value (nil)
 151                                                    (symbol :format "%v"))
 152                                            (const :tag "always" t)))
 153              (debug-on-error debug
 154                              (choice (const :tag "off")
 155                                      (repeat :menu-tag "When"
 156                                              :value (nil)
 157                                              (symbol :format "%v"))
 158                                      (const :tag "always" t)))
 159              (debug-ignored-errors debug (repeat (choice symbol regexp)))
 160              (debug-on-quit debug
 161                             (choice (const :tag "off")
 162                                     (repeat :menu-tag "When"
 163                                             :value (nil)
 164                                             (symbol :format "%v"))
 165                                     (const :tag "always" t)))
 166              ;; fileio.c
 167              (delete-by-moving-to-trash auto-save boolean "23.1")
 168              (auto-save-visited-file-name auto-save boolean)
 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              (make-pointer-invisible mouse boolean "23.2")
 183              ;; fringe.c
 184              (overflow-newline-into-fringe fringe boolean)
 185              ;; indent.c
 186              (indent-tabs-mode indent boolean)
 187              ;; keyboard.c
 188              (meta-prefix-char keyboard character)
 189              (auto-save-interval auto-save integer)
 190              (auto-save-timeout auto-save (choice (const :tag "off" nil)
 191                                                   (integer :format "%v")))
 192              (echo-keystrokes minibuffer number)
 193              (polling-period keyboard integer)
 194              (double-click-time mouse (restricted-sexp
 195                                        :match-alternatives (integerp 'nil 't)))
 196              (double-click-fuzz mouse integer "22.1")
 197              (inhibit-local-menu-bar-menus menu boolean)
 198              (help-char keyboard character)
 199              (help-event-list keyboard (repeat (sexp :format "%v")))
 200              (menu-prompting menu boolean)
 201              (select-active-regions killing
 202                                     (choice (const :tag "always" t)
 203                                             (const :tag "only shift-selection or mouse-drag" only)
 204                                             (const :tag "off" nil))
 205                                     "24.1")
 206              (suggest-key-bindings keyboard (choice (const :tag "off" nil)
 207                                                     (integer :tag "time" 2)
 208                                                     (other :tag "on")))
 209
 210 ;; This is not good news because it will use the wrong
 211 ;; version-specific directories when you upgrade.  We need
 212 ;; customization of the front of the list, maintaining the standard
 213 ;; value intact at the back.
 214 ;;;          (load-path environment
 215 ;;;                     (repeat (choice :tag "[Current dir?]"
 216 ;;;                                     :format "%[Current dir?%] %v"
 217 ;;;                                     (const :tag " current dir" nil)
 218 ;;;                                     (directory :format "%v"))))
 219              ;; minibuf.c
 220              (enable-recursive-minibuffers minibuffer boolean)
 221              (history-length minibuffer
 222                              (choice (const :tag "Infinite" t) integer)
 223                              "22.1")
 224              (history-delete-duplicates minibuffer boolean "22.1")
 225              (read-buffer-completion-ignore-case minibuffer boolean "23.1")
 226
 227              (minibuffer-prompt-properties
 228               minibuffer
 229               (list
 230                (checklist :inline t
 231                           (const :tag "Read-Only"
 232                                  :doc "Prevent prompt from being modified"
 233                                  :format "%t%n%h"
 234                                  :inline t
 235                                  (read-only t))
 236                           (const :tag "Don't Enter"
 237                                  :doc "Prevent point from ever entering prompt"
 238                                  :format "%t%n%h"
 239                                  :inline t
 240                                  (point-entered minibuffer-avoid-prompt)))
 241                (repeat :inline t
 242                        :tag "Other Properties"
 243                        (list :inline t
 244                              :format "%v"
 245                              (symbol :tag "Property")
 246                              (sexp :tag "Value"))))
 247               "21.1")
 248              (minibuffer-auto-raise minibuffer boolean)
 249              ;; options property set at end
 250              (read-buffer-function minibuffer
 251                                    (choice (const nil)
 252                                            (function-item iswitchb-read-buffer)
 253                                            function))
 254              ;; msdos.c
 255              (dos-unsupported-char-glyph display integer)
 256              ;; nsterm.m
 257              (ns-control-modifier
 258               ns
 259               (choice (const :tag "No modifier" nil)
 260                       (const control) (const meta)
 261                       (const alt) (const hyper)
 262                       (const super)) "23.1")
 263              (ns-command-modifier
 264               ns
 265               (choice (const :tag "No modifier" nil)
 266                       (const control) (const meta)
 267                       (const alt) (const hyper)
 268                       (const super)) "23.1")
 269              (ns-alternate-modifier
 270               ns
 271               (choice (const :tag "No modifier (work as alternate/option)" none)
 272                       (const control) (const meta)
 273                       (const alt) (const hyper)
 274                       (const super)) "23.1")
 275              (ns-right-alternate-modifier
 276               ns
 277               (choice (const :tag "No modifier (work as alternate/option)" none)
 278                       (const :tag "Use the value of ns-alternate-modifier"
 279                              left)
 280                       (const control) (const meta)
 281                       (const alt) (const hyper)
 282                       (const super)) "23.3")
 283              (ns-function-modifier
 284               ns
 285               (choice (const :tag "No modifier (work as function)" none)
 286                       (const control) (const meta)
 287                       (const alt) (const hyper)
 288                       (const super)) "23.1")
 289              (ns-antialias-text ns boolean "23.1")
 290              ;; process.c
 291              (delete-exited-processes processes-basics boolean)
 292              ;; syntax.c
 293              (parse-sexp-ignore-comments editing-basics boolean)
 294              (words-include-escapes editing-basics boolean)
 295              (open-paren-in-column-0-is-defun-start editing-basics boolean
 296                                                     "21.1")
 297              ;; term.c
 298              (visible-cursor cursor boolean "22.1")
 299              ;; undo.c
 300              (undo-limit undo integer)
 301              (undo-strong-limit undo integer)
 302              (undo-outer-limit undo
 303                                (choice integer
 304                                        (const :tag "No limit"
 305                                               :format "%t\n%d"
 306                                               :doc
 307                                               "With this choice, \
 308 the undo info for the current command never gets discarded.
 309 This should only be chosen under exceptional circumstances,
 310 since it could result in memory overflow and make Emacs crash."
 311                                               nil))
 312                                "22.1")
 313              ;; window.c
 314              (temp-buffer-show-function windows (choice (const nil) function))
 315              (next-screen-context-lines windows integer)
 316              (window-min-height windows integer)
 317              (window-min-width windows integer)
 318              (scroll-preserve-screen-position
 319               windows (choice
 320                        (const :tag "Off (nil)" :value nil)
 321                        (const :tag "Full screen (t)" :value t)
 322                        (other :tag "Always" 1)) "22.1")
 323              (recenter-redisplay windows
 324                                  (choice
 325                                   (const :tag "Never (nil)" :value nil)
 326                                   (const :tag "Only on ttys" :value tty)
 327                                   (other :tag "Always" t))
 328                                  "23.1")
 329              ;; xdisp.c
 330              (scroll-step windows integer)
 331              (scroll-conservatively windows integer)
 332              (scroll-margin windows integer)
 333              (hscroll-margin windows integer "22.1")
 334              (hscroll-step windows number "22.1")
 335              (truncate-partial-width-windows display boolean "23.1")
 336              (mode-line-inverse-video mode-line boolean)
 337              (mode-line-in-non-selected-windows mode-line boolean "22.1")
 338              (line-number-display-limit display
 339                                         (choice integer
 340                                                 (const :tag "No limit" nil)))
 341              (line-number-display-limit-width display integer "22.1")
 342              (highlight-nonselected-windows display boolean)
 343              (message-log-max debug (choice (const :tag "Disable" nil)
 344                                             (integer :menu-tag "lines"
 345                                                      :format "%v")
 346                                             (other :tag "Unlimited" t)))
 347              (unibyte-display-via-language-environment mule boolean)
 348              (blink-cursor-alist cursor alist "22.1")
 349              (overline-margin display integer "22.1")
 350              (underline-minimum-offset display integer "23.1")
 351              (mouse-autoselect-window
 352               display (choice
 353                        (const :tag "Off (nil)" :value nil)
 354                        (const :tag "Immediate" :value t)
 355                        (number :tag "Delay by secs" :value 0.5)) "22.1")
 356              (tool-bar-style
 357               frames (choice
 358                       (const :tag "Images" :value image)
 359                       (const :tag "Text" :value text)
 360                       (const :tag "Both" :value both)
 361                       (const :tag "Both-horiz" :value both-horiz)
 362                       (const :tag "Text-image-horiz" :value text-image-horiz)
 363                       (const :tag "System default" :value nil)) "23.3")
 364              (tool-bar-max-label-size frames integer "23.3")
 365
 366              ;; xfaces.c
 367              (scalable-fonts-allowed display boolean "22.1")
 368              ;; xfns.c
 369              (x-bitmap-file-path installation
 370                                  (repeat (directory :format "%v")))
 371              (x-gtk-use-old-file-dialog menu boolean "22.1")
 372              (x-gtk-show-hidden-files menu boolean "22.1")
 373              (x-gtk-file-dialog-help-text menu boolean "22.1")
 374              (x-gtk-whole-detached-tool-bar x boolean "22.1")
 375              (x-gtk-use-system-tooltips tooltip boolean "23.3")
 376              ;; xterm.c
 377              (x-use-underline-position-properties display boolean "22.1")
 378              (x-underline-at-descent-line display boolean "22.1")
 379              (x-stretch-cursor display boolean "21.1")
 380              ;; xsettings.c
 381              (font-use-system-font font-selection boolean "23.2")))
 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 "\\`ns-" (symbol-name symbol))
 416                        (featurep 'ns))
 417                       ((string-match "\\`x-.*gtk" (symbol-name symbol))
 418                        (featurep 'gtk))
 419                       ((string-match "\\`x-" (symbol-name symbol))
 420                        (fboundp 'x-create-frame))
 421                       ((string-match "selection" (symbol-name symbol))
 422                        (fboundp 'x-selection-exists-p))
 423                       ((string-match "fringe" (symbol-name symbol))
 424                        (fboundp 'define-fringe-bitmap))
 425                       ((equal "font-use-system-font" (symbol-name symbol))
 426                        (featurep 'system-font-setting))
 427                       ;; Conditioned on x-create-frame, because that's
 428                       ;; the condition for loadup.el to preload tool-bar.el.
 429                       ((string-match "tool-bar-" (symbol-name symbol))
 430                        (fboundp 'x-create-frame))
 431                       (t t))))
 432     (if (not (boundp symbol))
 433         ;; If variables are removed from C code, give an error here!
 434         (and native-p
 435              (message "Note, built-in variable `%S' not bound" symbol))
 436       ;; Save the standard value, unless we already did.
 437       (or (get symbol 'standard-value)
 438           (put symbol 'standard-value (list standard)))
 439       ;; If this is NOT while dumping Emacs,
 440       ;; set up the rest of the customization info.
 441       (unless purify-flag
 442         ;; Add it to the right group.
 443         (custom-add-to-group group symbol 'custom-variable)
 444         ;; Set the type.
 445         (put symbol 'custom-type type)
 446         (put symbol 'custom-version version)))))
 447
 448 (custom-add-to-group 'iswitchb 'read-buffer-function 'custom-variable)
 449 (custom-add-to-group 'font-lock 'open-paren-in-column-0-is-defun-start
 450                      'custom-variable)
 451
 452 ;; Record cus-start as loaded
 453 ;; if we have set up all the info that we can set up.
 454 ;; Don't record cus-start as loaded
 455 ;; if we have set up only the standard values.
 456 (unless purify-flag
 457   (provide 'cus-start))
 458
 459 ;; arch-tag: 4502730d-bcb3-4f5e-99a3-a86f2d54af60
 460 ;;; cus-start.el ends here