cus-edit.el 86.3 KB
Newer Older
Per Abrahamsen's avatar
Per Abrahamsen committed
1 2 3 4 5 6
;;; cus-edit.el --- Tools for customization Emacs.
;;
;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: help, faces
Per Abrahamsen's avatar
Per Abrahamsen committed
7
;; Version: 1.9924
Per Abrahamsen's avatar
Per Abrahamsen committed
8 9
;; X-URL: http://www.dina.kvl.dk/~abraham/custom/

10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

Per Abrahamsen's avatar
Per Abrahamsen committed
27 28
;;; Commentary:
;;
Per Abrahamsen's avatar
Per Abrahamsen committed
29 30
;; This file implements the code to create and edit customize buffers.
;; 
Per Abrahamsen's avatar
Per Abrahamsen committed
31 32 33 34 35 36 37
;; See `custom.el'.

;;; Code:

(require 'cus-face)
(require 'wid-edit)
(require 'easymenu)
Per Abrahamsen's avatar
Per Abrahamsen committed
38 39 40 41 42
(eval-when-compile (require 'cl))

(condition-case nil
    (require 'cus-load)
  (error nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
43

Per Abrahamsen's avatar
Per Abrahamsen committed
44 45 46 47 48 49
(condition-case nil
    (require 'cus-start)
  (error nil))

(define-widget-keywords :custom-category :custom-prefixes :custom-menu
  :custom-show  
Per Abrahamsen's avatar
Per Abrahamsen committed
50 51
  :custom-magic :custom-state :custom-level :custom-form
  :custom-set :custom-save :custom-reset-current :custom-reset-saved 
Per Abrahamsen's avatar
Per Abrahamsen committed
52
  :custom-reset-standard)
Per Abrahamsen's avatar
Per Abrahamsen committed
53

Per Abrahamsen's avatar
Per Abrahamsen committed
54
(put 'custom-define-hook 'custom-type 'hook)
Per Abrahamsen's avatar
Per Abrahamsen committed
55
(put 'custom-define-hook 'standard-value '(nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
56 57
(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)

Per Abrahamsen's avatar
Per Abrahamsen committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
;;; Customization Groups.

(defgroup emacs nil
  "Customization of the One True Editor."
  :link '(custom-manual "(emacs)Top"))

;; Most of these groups are stolen from `finder.el',
(defgroup editing nil
  "Basic text editing facilities."
  :group 'emacs)

(defgroup abbrev nil
  "Abbreviation handling, typing shortcuts, macros."
  :tag "Abbreviations"
  :group 'editing)

(defgroup matching nil
  "Various sorts of searching and matching."
  :group 'editing)

(defgroup emulations nil
  "Emulations of other editors."
  :group 'editing)

(defgroup mouse nil
  "Mouse support."
  :group 'editing)

(defgroup outlines nil
  "Support for hierarchical outlining."
  :group 'editing)

(defgroup external nil
  "Interfacing to external utilities."
  :group 'emacs)

(defgroup bib nil
  "Code related to the `bib' bibliography processor."
  :tag "Bibliography"
  :group 'external)

(defgroup processes nil
  "Process, subshell, compilation, and job control support."
  :group 'external
  :group 'development)

(defgroup programming nil
  "Support for programming in other languages."
  :group 'emacs)

(defgroup languages nil
  "Specialized modes for editing programming languages."
  :group 'programming)

(defgroup lisp nil
  "Lisp support, including Emacs Lisp."
  :group 'languages
  :group 'development)

(defgroup c nil
  "Support for the C language and related languages."
  :group 'languages)

(defgroup tools nil
  "Programming tools."
  :group 'programming)

(defgroup oop nil
  "Support for object-oriented programming."
  :group 'programming)

(defgroup applications nil
  "Applications written in Emacs."
  :group 'emacs)

(defgroup calendar nil
  "Calendar and time management support."
  :group 'applications)

(defgroup mail nil
  "Modes for electronic-mail handling."
  :group 'applications)

(defgroup news nil
  "Support for netnews reading and posting."
  :group 'applications)

(defgroup games nil
  "Games, jokes and amusements."
  :group 'applications)

(defgroup development nil
  "Support for further development of Emacs."
  :group 'emacs)

(defgroup docs nil
  "Support for Emacs documentation."
  :group 'development)

(defgroup extensions nil
  "Emacs Lisp language extensions."
  :group 'development)

(defgroup internal nil
  "Code for Emacs internals, build process, defaults."
  :group 'development)

(defgroup maint nil
  "Maintenance aids for the Emacs development group."
  :tag "Maintenance"
  :group 'development)

(defgroup environment nil
  "Fitting Emacs with its environment."
  :group 'emacs)

(defgroup comm nil
  "Communications, networking, remote access to files."
  :tag "Communication"
  :group 'environment)

(defgroup hardware nil
  "Support for interfacing with exotic hardware."
  :group 'environment)

(defgroup terminals nil
  "Support for terminal types."
  :group 'environment)

(defgroup unix nil
  "Front-ends/assistants for, or emulators of, UNIX features."
  :group 'environment)

(defgroup vms nil
  "Support code for vms."
  :group 'environment)

(defgroup i18n nil
  "Internationalization and alternate character-set support."
  :group 'environment
  :group 'editing)

Per Abrahamsen's avatar
Per Abrahamsen committed
200 201 202 203
(defgroup x nil
  "The X Window system."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
204 205 206 207 208 209 210 211
(defgroup frames nil
  "Support for Emacs frames and window systems."
  :group 'environment)

(defgroup data nil
  "Support editing files of data."
  :group 'emacs)

212 213 214 215
(defgroup files nil
  "Support editing files."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
(defgroup wp nil
  "Word processing."
  :group 'emacs)

(defgroup tex nil
  "Code related to the TeX formatter."
  :group 'wp)

(defgroup faces nil
  "Support for multiple fonts."
  :group 'emacs)

(defgroup hypermedia nil
  "Support for links between text or other media types."
  :group 'emacs)

(defgroup help nil
  "Support for on-line help systems."
  :group 'emacs)

(defgroup local nil
  "Code local to your site."
  :group 'emacs)

(defgroup customize '((widgets custom-group))
  "Customization of the Customization support."
  :link '(custom-manual "(custom)Top")
  :link '(url-link :tag "Development Page" 
		   "http://www.dina.kvl.dk/~abraham/custom/")
  :prefix "custom-"
Per Abrahamsen's avatar
Per Abrahamsen committed
246 247 248 249 250
  :group 'help)

(defgroup custom-faces nil
  "Faces used by customize."
  :group 'customize
Per Abrahamsen's avatar
Per Abrahamsen committed
251 252
  :group 'faces)

Per Abrahamsen's avatar
Per Abrahamsen committed
253 254 255 256 257 258 259 260 261 262
(defgroup custom-buffer nil
  "Control the customize buffers."
  :prefix "custom-"
  :group 'customize)

(defgroup custom-menu nil
  "Control how the customize menus."
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
(defgroup abbrev-mode nil
  "Word abbreviations mode."
  :group 'abbrev)

(defgroup alloc nil
  "Storage allocation and gc for GNU Emacs Lisp interpreter."
  :tag "Storage Allocation"
  :group 'internal)

(defgroup undo nil
  "Undoing changes in buffers."
  :group 'editing)

(defgroup modeline nil
  "Content of the modeline."
  :group 'environment)

(defgroup fill nil
  "Indenting and filling text."
  :group 'editing)

(defgroup editing-basics nil
  "Most basic editing facilities."
  :group 'editing)

(defgroup display nil
  "How characters are displayed in buffers."
  :group 'environment)

(defgroup execute nil
  "Executing external commands."
  :group 'processes)

(defgroup installation nil
  "The Emacs installation."
  :group 'environment)

(defgroup dired nil
  "Directory editing."
  :group 'environment)

(defgroup limits nil
  "Internal Emacs limits."
  :group 'internal)

(defgroup debug nil
  "Debugging Emacs itself."
  :group 'development)

(defgroup minibuffer nil
  "Controling the behaviour of the minibuffer."
  :group 'environment)

(defgroup keyboard nil
  "Input from the keyboard."
  :group 'environment)

(defgroup mouse nil
  "Input from the mouse."
  :group 'environment)

(defgroup menu nil
  "Input from the menus."
  :group 'environment)

(defgroup auto-save nil
  "Preventing accidential loss of data."
330
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
331 332 333 334 335

(defgroup processes-basics nil
  "Basic stuff dealing with processes."
  :group 'processes)

Per Abrahamsen's avatar
Per Abrahamsen committed
336 337
(defgroup mule nil
  "MULE Emacs internationalization."
338
  :group 'i18n)
Per Abrahamsen's avatar
Per Abrahamsen committed
339

Per Abrahamsen's avatar
Per Abrahamsen committed
340 341
(defgroup windows nil
  "Windows within a frame."
Per Abrahamsen's avatar
Per Abrahamsen committed
342
  :group 'environment)
Per Abrahamsen's avatar
Per Abrahamsen committed
343

Per Abrahamsen's avatar
Per Abrahamsen committed
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
;;; Utilities.

(defun custom-quote (sexp)
  "Quote SEXP iff it is not self quoting."
  (if (or (memq sexp '(t nil))
	  (and (symbolp sexp)
	       (eq (aref (symbol-name sexp) 0) ?:))
	  (and (listp sexp)
	       (memq (car sexp) '(lambda)))
	  (stringp sexp)
	  (numberp sexp)
	  (and (fboundp 'characterp)
	       (characterp sexp)))
      sexp
    (list 'quote sexp)))

(defun custom-split-regexp-maybe (regexp)
  "If REGEXP is a string, split it to a list at `\\|'.
You can get the original back with from the result with: 
  (mapconcat 'identity result \"\\|\")

IF REGEXP is not a string, return it unchanged."
  (if (stringp regexp)
      (let ((start 0)
	    all)
	(while (string-match "\\\\|" regexp start)
	  (setq all (cons (substring regexp start (match-beginning 0)) all)
		start (match-end 0)))
	(nreverse (cons (substring regexp start) all)))
    regexp))

Per Abrahamsen's avatar
Per Abrahamsen committed
375 376 377 378 379 380 381 382
(defun custom-variable-prompt ()
  ;; Code stolen from `help.el'.
  "Prompt for a variable, defaulting to the variable at point.
Return a list suitable for use in `interactive'."
   (let ((v (variable-at-point))
	 (enable-recursive-minibuffers t)
	 val)
     (setq val (completing-read 
383
		(if (symbolp v)
384
		    (format "Customize option: (default %s) " v)
Per Abrahamsen's avatar
Per Abrahamsen committed
385
		  "Customize variable: ")
Per Abrahamsen's avatar
Per Abrahamsen committed
386 387 388 389
		obarray (lambda (symbol)
			  (and (boundp symbol)
			       (or (get symbol 'custom-type)
				   (user-variable-p symbol))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
390
     (list (if (equal val "")
391 392
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
393

Per Abrahamsen's avatar
Per Abrahamsen committed
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
(defun custom-menu-filter (menu widget)
  "Convert MENU to the form used by `widget-choose'.
MENU should be in the same format as `custom-variable-menu'.
WIDGET is the widget to apply the filter entries of MENU on."
  (let ((result nil)
	current name action filter)
    (while menu 
      (setq current (car menu)
	    name (nth 0 current)
	    action (nth 1 current)
	    filter (nth 2 current)
	    menu (cdr menu))
      (if (or (null filter) (funcall filter widget))
	  (push (cons name action) result)
	(push name result)))
    (nreverse result)))

Per Abrahamsen's avatar
Per Abrahamsen committed
411 412
;;; Unlispify.

Per Abrahamsen's avatar
Per Abrahamsen committed
413 414 415 416 417
(defvar custom-prefix-list nil
  "List of prefixes that should be ignored by `custom-unlispify'")

(defcustom custom-unlispify-menu-entries t
  "Display menu entries as words instead of symbols if non nil."
Per Abrahamsen's avatar
Per Abrahamsen committed
418
  :group 'custom-menu
Per Abrahamsen's avatar
Per Abrahamsen committed
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
  :type 'boolean)

(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
  "Convert symbol into a menu entry."
  (cond ((not custom-unlispify-menu-entries)
	 (symbol-name symbol))
	((get symbol 'custom-tag)
	 (if no-suffix
	     (get symbol 'custom-tag)
	   (concat (get symbol 'custom-tag) "...")))
	(t
	 (save-excursion
	   (set-buffer (get-buffer-create " *Custom-Work*"))
	   (erase-buffer)
	   (princ symbol (current-buffer))
	   (goto-char (point-min))
Per Abrahamsen's avatar
Per Abrahamsen committed
435 436 437 438
	   (when (and (eq (get symbol 'custom-type) 'boolean)
		      (re-search-forward "-p\\'" nil t))
	     (replace-match "" t t)
	     (goto-char (point-min)))
Per Abrahamsen's avatar
Per Abrahamsen committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
	   (let ((prefixes custom-prefix-list)
		 prefix)
	     (while prefixes
	       (setq prefix (car prefixes))
	       (if (search-forward prefix (+ (point) (length prefix)) t)
		   (progn 
		     (setq prefixes nil)
		     (delete-region (point-min) (point)))
		 (setq prefixes (cdr prefixes)))))
	   (subst-char-in-region (point-min) (point-max) ?- ?\  t)
	   (capitalize-region (point-min) (point-max))
	   (unless no-suffix 
	     (goto-char (point-max))
	     (insert "..."))
	   (buffer-string)))))

(defcustom custom-unlispify-tag-names t
  "Display tag names as words instead of symbols if non nil."
Per Abrahamsen's avatar
Per Abrahamsen committed
457
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
458 459 460 461 462 463 464 465 466 467 468 469 470
  :type 'boolean)

(defun custom-unlispify-tag-name (symbol)
  "Convert symbol into a menu entry."
  (let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
    (custom-unlispify-menu-entry symbol t)))

(defun custom-prefix-add (symbol prefixes)
  ;; Addd SYMBOL to list of ignored PREFIXES.
  (cons (or (get symbol 'custom-prefix)
	    (concat (symbol-name symbol) "-"))
	prefixes))

Per Abrahamsen's avatar
Per Abrahamsen committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
;;; Guess.

(defcustom custom-guess-name-alist
  '(("-p\\'" boolean)
    ("-hook\\'" hook)
    ("-face\\'" face)
    ("-file\\'" file)
    ("-function\\'" function)
    ("-functions\\'" (repeat function))
    ("-list\\'" (repeat sexp))
    ("-alist\\'" (repeat (cons sexp sexp))))
  "Alist of (MATCH TYPE).

MATCH should be a regexp matching the name of a symbol, and TYPE should 
be a widget suitable for editing the value of that symbol.  The TYPE
of the first entry where MATCH matches the name of the symbol will be
used. 

This is used for guessing the type of variables not declared with
customize."
  :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
Per Abrahamsen's avatar
Per Abrahamsen committed
492 493
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
494 495 496
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
497

Per Abrahamsen's avatar
Per Abrahamsen committed
498 499 500 501
MATCH should be a regexp matching a documentation string, and TYPE
should be a widget suitable for editing the value of a variable with
that documentation string.  The TYPE of the first entry where MATCH
matches the name of the symbol will be used.
Per Abrahamsen's avatar
Per Abrahamsen committed
502

Per Abrahamsen's avatar
Per Abrahamsen committed
503 504 505 506
This is used for guessing the type of variables not declared with
customize."
  :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
  :group 'customize)
Per Abrahamsen's avatar
Per Abrahamsen committed
507

Per Abrahamsen's avatar
Per Abrahamsen committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
(defun custom-guess-type (symbol)
  "Guess a widget suitable for editing the value of SYMBOL.
This is done by matching SYMBOL with `custom-guess-name-alist' and 
if that fails, the doc string with `custom-guess-doc-alist'."
  (let ((name (symbol-name symbol))
	(names custom-guess-name-alist)
	current found)
    (while names
      (setq current (car names)
	    names (cdr names))
      (when (string-match (nth 0 current) name)
	(setq found (nth 1 current)
	      names nil)))
    (unless found
      (let ((doc (documentation-property symbol 'variable-documentation))
	    (docs custom-guess-doc-alist))
	(when doc 
	  (while docs
	    (setq current (car docs)
		  docs (cdr docs))
	    (when (string-match (nth 0 current) doc)
	      (setq found (nth 1 current)
		    docs nil))))))
    found))
Per Abrahamsen's avatar
Per Abrahamsen committed
532

Per Abrahamsen's avatar
Per Abrahamsen committed
533 534
;;; Sorting.

Per Abrahamsen's avatar
Per Abrahamsen committed
535
(defcustom custom-buffer-sort-predicate 'ignore
Per Abrahamsen's avatar
Per Abrahamsen committed
536 537 538
  "Function used for sorting group members in buffers.
The value should be useful as a predicate for `sort'.  
The list to be sorted is the value of the groups `custom-group' property."
Per Abrahamsen's avatar
Per Abrahamsen committed
539 540
  :type '(radio (const :tag "Unsorted" ignore)
		(const :tag "Alphabetic" custom-sort-items-alphabetically)
Per Abrahamsen's avatar
Per Abrahamsen committed
541
		(function :tag "Other"))
Per Abrahamsen's avatar
Per Abrahamsen committed
542
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
543

Per Abrahamsen's avatar
Per Abrahamsen committed
544 545 546 547 548 549 550 551
(defcustom custom-buffer-order-predicate 'custom-sort-groups-last
  "Function used for sorting group members in buffers.
The value should be useful as a predicate for `sort'.  
The list to be sorted is the value of the groups `custom-group' property."
  :type '(radio (const :tag "Groups first" custom-sort-groups-first)
		(const :tag "Groups last" custom-sort-groups-last)
		(function :tag "Other"))
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
552

Per Abrahamsen's avatar
Per Abrahamsen committed
553
(defcustom custom-menu-sort-predicate 'ignore
Per Abrahamsen's avatar
Per Abrahamsen committed
554 555 556
  "Function used for sorting group members in menus.
The value should be useful as a predicate for `sort'.  
The list to be sorted is the value of the groups `custom-group' property."
Per Abrahamsen's avatar
Per Abrahamsen committed
557 558
  :type '(radio (const :tag "Unsorted" ignore)
		(const :tag "Alphabetic" custom-sort-items-alphabetically)
Per Abrahamsen's avatar
Per Abrahamsen committed
559
		(function :tag "Other"))
Per Abrahamsen's avatar
Per Abrahamsen committed
560
  :group 'custom-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
561

Per Abrahamsen's avatar
Per Abrahamsen committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
(defcustom custom-menu-order-predicate 'custom-sort-groups-first
  "Function used for sorting group members in menus.
The value should be useful as a predicate for `sort'.  
The list to be sorted is the value of the groups `custom-group' property."
  :type '(radio (const :tag "Groups first" custom-sort-groups-first)
		(const :tag "Groups last" custom-sort-groups-last)
		(function :tag "Other"))
  :group 'custom-menu)

(defun custom-sort-items-alphabetically (a b)
  "Return t iff A is alphabetically before B and the same custom type.
A and B should be members of a `custom-group' property."
  (and (eq (nth 1 a) (nth 1 b))
       (string-lessp (symbol-name (nth 0 a)) (symbol-name (nth 0 b)))))

(defun custom-sort-groups-first (a b)
  "Return t iff A a custom group and B is a not.
A and B should be members of a `custom-group' property."
  (and (eq (nth 1 a) 'custom-group)
       (not (eq (nth 1 b) 'custom-group))))

(defun custom-sort-groups-last (a b)
  "Return t iff B a custom group and A is a not.
A and B should be members of a `custom-group' property."
  (and (eq (nth 1 b) 'custom-group)
       (not (eq (nth 1 a) 'custom-group))))
Per Abrahamsen's avatar
Per Abrahamsen committed
588

Per Abrahamsen's avatar
Per Abrahamsen committed
589 590
;;; Custom Mode Commands.

Per Abrahamsen's avatar
Per Abrahamsen committed
591 592 593
(defvar custom-options nil
  "Customization widgets in the current buffer.")

Per Abrahamsen's avatar
Per Abrahamsen committed
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
(defun custom-set ()
  "Set changes in all modified options."
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (eq (widget-get child :custom-state) 'modified)
		(widget-apply child :custom-set)))
	    children)))

(defun custom-save ()
  "Set all modified group members and save them."
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (memq (widget-get child :custom-state) '(modified set))
		(widget-apply child :custom-save)))
	    children))
  (custom-save-all))

(defvar custom-reset-menu 
  '(("Current" . custom-reset-current)
    ("Saved" . custom-reset-saved)
Per Abrahamsen's avatar
Per Abrahamsen committed
616
    ("Standard Settings" . custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
617 618 619 620 621 622 623 624 625 626 627 628 629 630
  "Alist of actions for the `Reset' button.
The key is a string containing the name of the action, the value is a
lisp function taking the widget as an element which will be called
when the action is chosen.")

(defun custom-reset (event)
  "Select item from reset menu."
  (let* ((completion-ignore-case t)
	 (answer (widget-choose "Reset to"
				custom-reset-menu
				event)))
    (if answer
	(funcall answer))))

Per Abrahamsen's avatar
Per Abrahamsen committed
631
(defun custom-reset-current (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
632 633 634 635 636 637 638 639
  "Reset all modified group members to their current value."
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (eq (widget-get child :custom-state) 'modified)
		(widget-apply child :custom-reset-current)))
	    children)))

Per Abrahamsen's avatar
Per Abrahamsen committed
640
(defun custom-reset-saved (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
641 642 643 644 645
  "Reset all modified or set group members to their saved value."
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (eq (widget-get child :custom-state) 'modified)
Per Abrahamsen's avatar
Per Abrahamsen committed
646
		(widget-apply child :custom-reset-saved)))
Per Abrahamsen's avatar
Per Abrahamsen committed
647 648
	    children)))

Per Abrahamsen's avatar
Per Abrahamsen committed
649
(defun custom-reset-standard (&rest ignore)
650
  "Reset all modified, set, or saved group members to their standard settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
651 652 653 654
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (eq (widget-get child :custom-state) 'modified)
Per Abrahamsen's avatar
Per Abrahamsen committed
655
		(widget-apply child :custom-reset-standard)))
Per Abrahamsen's avatar
Per Abrahamsen committed
656 657 658 659
	    children)))

;;; The Customize Commands

Per Abrahamsen's avatar
Per Abrahamsen committed
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
(defun custom-prompt-variable (prompt-var prompt-val)
  "Prompt for a variable and a value and return them as a list.
PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
prompt for the value.  The %s escape in PROMPT-VAL is replaced with
the name of the variable.

If the variable has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.

If the variable has a `custom-type' property, it must be a widget and the
`:prompt-value' property of that widget will be used for reading the value."
  (let* ((var (read-variable prompt-var))
	 (minibuffer-help-form '(describe-variable var)))
    (list var
	  (let ((prop (get var 'variable-interactive))
		(type (get var 'custom-type))
		(prompt (format prompt-val var)))
	    (unless (listp type)
	      (setq type (list type)))
	    (cond (prop
		   ;; Use VAR's `variable-interactive' property
		   ;; as an interactive spec for prompting.
		   (call-interactively (list 'lambda '(arg)
					     (list 'interactive prop)
					     'arg)))
		  (type
		   (widget-prompt-value type
					prompt
					(if (boundp var)
					    (symbol-value var))
					(not (boundp var))))
		  (t
		   (eval-minibuffer prompt)))))))

;;;###autoload
(defun custom-set-value (var val)
  "Set VARIABLE to VALUE.  VALUE is a Lisp object.

If VARIABLE has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.

If VARIABLE has a `custom-type' property, it must be a widget and the
`:prompt-value' property of that widget will be used for reading the value." 
  (interactive (custom-prompt-variable "Set variable: "
				       "Set %s to value: "))
   
  (set var val))

;;;###autoload
(defun custom-set-variable (var val)
  "Set the default for VARIABLE to VALUE.  VALUE is a Lisp object.

If VARIABLE has a `custom-set' property, that is used for setting
VARIABLE, otherwise `set-default' is used.

The `customized-value' property of the VARIABLE will be set to a list
with a quoted VALUE as its sole list member.

If VARIABLE has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.

If VARIABLE has a `custom-type' property, it must be a widget and the
`:prompt-value' property of that widget will be used for reading the value. " 
  (interactive (custom-prompt-variable "Set variable: "
				       "Set customized value for %s to: "))
  (funcall (or (get var 'custom-set) 'set-default) var val)
  (put var 'customized-value (list (custom-quote val))))

Per Abrahamsen's avatar
Per Abrahamsen committed
728
;;;###autoload
729 730 731 732 733 734
(defun customize ()
  "Select a customization buffer which you can use to set user options.
User options are structured into \"groups\".
Initially the top-level group `Emacs' and its immediate subgroups
are shown; the contents of those subgroups are initially hidden."
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
735
  (customize-group 'emacs))
736 737 738 739

;;;###autoload
(defun customize-group (group)
  "Customize GROUP, which must be a customization group."
Per Abrahamsen's avatar
Per Abrahamsen committed
740 741 742 743 744 745
  (interactive (list (completing-read "Customize group: (default emacs) "
				      obarray 
				      (lambda (symbol)
					(get symbol 'custom-group))
				      t)))

746 747 748 749
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
Per Abrahamsen's avatar
Per Abrahamsen committed
750 751 752
  (custom-buffer-create (list (list group 'custom-group))
			(format "*Customize Group: %s*"
				(custom-unlispify-tag-name group))))
Per Abrahamsen's avatar
Per Abrahamsen committed
753

Per Abrahamsen's avatar
Per Abrahamsen committed
754
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
755
(defun customize-group-other-window (symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
756 757 758 759 760 761 762 763 764 765 766
  "Customize SYMBOL, which must be a customization group."
  (interactive (list (completing-read "Customize group: (default emacs) "
				      obarray 
				      (lambda (symbol)
					(get symbol 'custom-group))
				      t)))

  (when (stringp symbol)
    (if (string-equal "" symbol)
	(setq symbol 'emacs)
      (setq symbol (intern symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
767 768 769
  (custom-buffer-create-other-window
   (list (list symbol 'custom-group))
   (format "*Customize Group: %s*" (custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
770

Per Abrahamsen's avatar
Per Abrahamsen committed
771 772
;;;###autoload
(defalias 'customize-variable 'customize-option)
773

Per Abrahamsen's avatar
Per Abrahamsen committed
774
;;;###autoload
775 776
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
777
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
778
  (custom-buffer-create (list (list symbol 'custom-variable))
779
			(format "*Customize Option: %s*"
Per Abrahamsen's avatar
Per Abrahamsen committed
780
				(custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
781

Per Abrahamsen's avatar
Per Abrahamsen committed
782 783 784
;;;###autoload
(defalias 'customize-variable-other-window 'customize-option-other-window)

Per Abrahamsen's avatar
Per Abrahamsen committed
785
;;;###autoload
786 787
(defun customize-option-other-window (symbol)
  "Customize SYMBOL, which must be a user option variable.
Per Abrahamsen's avatar
Per Abrahamsen committed
788 789
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
790 791
  (custom-buffer-create-other-window
   (list (list symbol 'custom-variable))
792
   (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
793

Per Abrahamsen's avatar
Per Abrahamsen committed
794 795 796 797 798 799 800 801 802 803
;;;###autoload
(defun customize-face (&optional symbol)
  "Customize SYMBOL, which should be a face name or nil.
If SYMBOL is nil, customize all faces."
  (interactive (list (completing-read "Customize face: (default all) " 
				      obarray 'custom-facep)))
  (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
      (let ((found nil))
	(message "Looking for faces...")
	(mapcar (lambda (symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
804 805
		  (push (list symbol 'custom-face) found))
		(nreverse (mapcar 'intern
Per Abrahamsen's avatar
Per Abrahamsen committed
806
				  (sort (mapcar 'symbol-name (face-list))
Per Abrahamsen's avatar
Per Abrahamsen committed
807
					'string-lessp))))
Per Abrahamsen's avatar
Per Abrahamsen committed
808
			
Per Abrahamsen's avatar
Per Abrahamsen committed
809
	(custom-buffer-create found "*Customize Faces*"))
Per Abrahamsen's avatar
Per Abrahamsen committed
810 811 812 813
    (if (stringp symbol)
	(setq symbol (intern symbol)))
    (unless (symbolp symbol)
      (error "Should be a symbol %S" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
814 815 816
    (custom-buffer-create (list (list symbol 'custom-face))
			  (format "*Customize Face: %s*"
				  (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
817

Per Abrahamsen's avatar
Per Abrahamsen committed
818 819 820 821 822 823 824 825 826 827 828
;;;###autoload
(defun customize-face-other-window (&optional symbol)
  "Show customization buffer for FACE in other window."
  (interactive (list (completing-read "Customize face: " 
				      obarray 'custom-facep)))
  (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
      ()
    (if (stringp symbol)
	(setq symbol (intern symbol)))
    (unless (symbolp symbol)
      (error "Should be a symbol %S" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
829 830 831
    (custom-buffer-create-other-window 
     (list (list symbol 'custom-face))
     (format "*Customize Face: %s*" (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
832

Per Abrahamsen's avatar
Per Abrahamsen committed
833 834
;;;###autoload
(defun customize-customized ()
Per Abrahamsen's avatar
Per Abrahamsen committed
835 836 837 838 839 840
  "Customize all user options set since the last save in this session."
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(and (get symbol 'customized-face)
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
841
		     (push (list symbol 'custom-face) found))
Per Abrahamsen's avatar
Per Abrahamsen committed
842 843
		(and (get symbol 'customized-value)
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
844
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
845
    (if found 
Per Abrahamsen's avatar
Per Abrahamsen committed
846
	(custom-buffer-create found "*Customize Customized*")
Per Abrahamsen's avatar
Per Abrahamsen committed
847 848 849 850 851
      (error "No customized user options"))))

;;;###autoload
(defun customize-saved ()
  "Customize all already saved user options."
Per Abrahamsen's avatar
Per Abrahamsen committed
852 853 854 855 856
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(and (get symbol 'saved-face)
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
857
		     (push (list symbol 'custom-face) found))
Per Abrahamsen's avatar
Per Abrahamsen committed
858 859
		(and (get symbol 'saved-value)
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
860
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
861
    (if found 
Per Abrahamsen's avatar
Per Abrahamsen committed
862
	(custom-buffer-create found "*Customize Saved*")
Per Abrahamsen's avatar
Per Abrahamsen committed
863
      (error "No saved user options"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
864 865 866 867

;;;###autoload
(defun customize-apropos (regexp &optional all)
  "Customize all user options matching REGEXP.
Per Abrahamsen's avatar
Per Abrahamsen committed
868 869 870 871 872
If ALL is `options', include only options.
If ALL is `faces', include only faces.
If ALL is `groups', include only groups.
If ALL is t (interactively, with prefix arg), include options which are not
user-settable, as well as faces and groups."
Per Abrahamsen's avatar
Per Abrahamsen committed
873 874 875 876
  (interactive "sCustomize regexp: \nP")
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(when (string-match regexp (symbol-name symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
877 878 879 880 881 882 883 884
		  (when (and (not (memq all '(faces options)))
			     (get symbol 'custom-group))
		    (push (list symbol 'custom-group) found))
		  (when (and (not (memq all '(options groups)))
			     (custom-facep symbol))
		    (push (list symbol 'custom-face) found))
		  (when (and (not (memq all '(groups faces)))
			     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
885
			     (or (get symbol 'saved-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
886
				 (get symbol 'standard-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
				 (if (memq all '(nil options))
				     (user-variable-p symbol)
				   (get symbol 'variable-documentation))))
		    (push (list symbol 'custom-variable) found)))))
    (if (not found)
	(error "No matches")
      (custom-buffer-create (sort (sort found
					;; Apropos should always be sorted.
					'custom-sort-items-alphabetically)
				  custom-buffer-order-predicate)
			    "*Customize Apropos*"))))

;;;###autoload
(defun customize-apropos-options (regexp &optional arg)
  "Customize all user options matching REGEXP.
With prefix arg, include options which are not user-settable."
  (interactive "sCustomize regexp: \nP")
  (customize-apropos regexp (or arg 'options)))

;;;###autoload
(defun customize-apropos-faces (regexp)
  "Customize all user faces matching REGEXP."
  (interactive "sCustomize regexp: \n")
  (customize-apropos regexp 'faces))

;;;###autoload
(defun customize-apropos-groups (regexp)
  "Customize all user groups matching REGEXP."
  (interactive "sCustomize regexp: \n")
  (customize-apropos regexp 'groups))
Per Abrahamsen's avatar
Per Abrahamsen committed
917

Per Abrahamsen's avatar
Per Abrahamsen committed
918 919
;;; Buffer.

Per Abrahamsen's avatar
Per Abrahamsen committed
920
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
921
(defun custom-buffer-create (options &optional name)
Per Abrahamsen's avatar
Per Abrahamsen committed
922
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
923
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
924 925 926
OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
SYMBOL is a customization option, and WIDGET is a widget for editing
that option."
Per Abrahamsen's avatar
Per Abrahamsen committed
927 928 929
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
  (switch-to-buffer (get-buffer-create name))
Per Abrahamsen's avatar
Per Abrahamsen committed
930 931
  (custom-buffer-create-internal options))

Per Abrahamsen's avatar
Per Abrahamsen committed
932
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
933
(defun custom-buffer-create-other-window (options &optional name)
Per Abrahamsen's avatar
Per Abrahamsen committed
934
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
935
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
936 937 938
OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
SYMBOL is a customization option, and WIDGET is a widget for editing
that option."
Per Abrahamsen's avatar
Per Abrahamsen committed
939 940
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
Per Abrahamsen's avatar
Per Abrahamsen committed
941
  (let ((window (selected-window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
942
    (switch-to-buffer-other-window (get-buffer-create name))
Per Abrahamsen's avatar
Per Abrahamsen committed
943 944
    (custom-buffer-create-internal options)
    (select-window window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
945 946 947 948 949

(defcustom custom-reset-button-menu nil
  "If non-nil, only show a single reset button in customize buffers.
This button will have a menu with all three reset operations."
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
950
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
951 952 953

(defun custom-buffer-create-internal (options)
  (message "Creating customization buffer...")
Per Abrahamsen's avatar
Per Abrahamsen committed
954 955 956 957 958 959
  (custom-mode)
  (widget-insert "This is a customization buffer.
Push RET or click mouse-2 on the word ")
  (widget-create 'info-link 
		 :tag "help"
		 :help-echo "Read the online help."
960
		 "(emacs)Easy Customization")
Per Abrahamsen's avatar
Per Abrahamsen committed
961
  (widget-insert " for more information.\n\n")
Per Abrahamsen's avatar
Per Abrahamsen committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975
  (message "Creating customization buttons...")
  (widget-create 'push-button
		 :tag "Set"
		 :help-echo "Set all modifications for this session."
		 :action (lambda (widget &optional event)
			   (custom-set)))
  (widget-insert " ")
  (widget-create 'push-button
		 :tag "Save"
		 :help-echo "\
Make the modifications default for future sessions."
		 :action (lambda (widget &optional event)
			   (custom-save)))
  (widget-insert " ")
Per Abrahamsen's avatar
Per Abrahamsen committed
976 977 978
  (if custom-reset-button-menu
      (widget-create 'push-button
		     :tag "Reset"
Per Abrahamsen's avatar
Per Abrahamsen committed
979
		     :help-echo "Show a menu with reset operations."
Per Abrahamsen's avatar
Per Abrahamsen committed
980 981 982 983 984
		     :mouse-down-action (lambda (&rest junk) t)
		     :action (lambda (widget &optional event)
			       (custom-reset event)))
    (widget-create 'push-button
		   :tag "Reset"
Per Abrahamsen's avatar
Per Abrahamsen committed
985 986
		   :help-echo "\
Reset all visible items in this buffer to their current settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
987 988 989 990
		   :action 'custom-reset-current)
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Saved"
Per Abrahamsen's avatar
Per Abrahamsen committed
991 992
		   :help-echo "\
Reset all visible items in this buffer to their saved settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
993 994 995 996
		   :action 'custom-reset-saved)
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Standard"
Per Abrahamsen's avatar
Per Abrahamsen committed
997 998
		   :help-echo "\
Reset all visible items in this buffer to their standard settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
999
		   :action 'custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
1000 1001 1002 1003 1004 1005 1006 1007
  (widget-insert " ")
  (widget-create 'push-button
		 :tag "Done"
		 :help-echo "Bury the buffer."
		 :action (lambda (widget &optional event)
			   (bury-buffer)))
  (widget-insert "\n\n")
  (message "Creating customization items...")
Per Abrahamsen's avatar
Per Abrahamsen committed
1008 1009 1010 1011
  (setq custom-options 
	(if (= (length options) 1)
	    (mapcar (lambda (entry)
		      (widget-create (nth 1 entry)
Per Abrahamsen's avatar
Per Abrahamsen committed
1012
				     :documentation-shown t
Per Abrahamsen's avatar
Per Abrahamsen committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
				     :custom-state 'unknown
				     :tag (custom-unlispify-tag-name
					   (nth 0 entry))
				     :value (nth 0 entry)))
		    options)
	  (let ((count 0)
		(length (length options)))
	    (mapcar (lambda (entry)
			(prog2
			    (message "Creating customization items %2d%%..."
				     (/ (* 100.0 count) length))
			    (widget-create (nth 1 entry)
					 :tag (custom-unlispify-tag-name
					       (nth 0 entry))
					 :value (nth 0 entry))
			  (setq count (1+ count))
			  (unless (eq (preceding-char) ?\n)
			    (widget-insert "\n"))
			  (widget-insert "\n")))
		      options))))
  (unless (eq (preceding-char) ?\n)
    (widget-insert "\n"))
Per Abrahamsen's avatar
Per Abrahamsen committed
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
  (when (= (length options) 1)
    (message "Creating parent links...")
    (let* ((entry (nth 0 options))
	   (name (nth 0 entry))
	   (type (nth 1 entry))
	   parents)
      (mapatoms (lambda (symbol)
		  (let ((group (get symbol 'custom-group)))
		    (when (assq name group)
		      (when (eq type (nth 1 (assq name group)))
			(push symbol parents))))))
      (when parents
	(widget-insert "\nParent groups:")
	(mapcar (lambda (group)
		  (widget-insert " ")
		  (widget-create 'link 
				 :tag (custom-unlispify-tag-name group)
				 :help-echo (format "\
Create customize buffer for `%S' group." group)
				 :action (lambda (widget &rest ignore)
					   (customize-group
					    (widget-value widget)))
				 group))
		parents)
	(widget-insert ".\n"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
  (message "Creating customization magic...")
  (mapcar 'custom-magic-reset custom-options)
  (message "Creating customization setup...")
  (widget-setup)
  (goto-char (point-min))
  (message "Creating customization buffer...done"))

;;; Modification of Basic Widgets.
;;
;; We add extra properties to the basic widgets needed here.  This is
;; fine, as long as we are careful to stay within out own namespace.
;;
;; We want simple widgets to be displayed by default, but complex
;; widgets to be hidden.

(widget-put (get 'item 'widget-type) :custom-show t)
(widget-put (get 'editable-field 'widget-type)
	    :custom-show (lambda (widget value)
			   (let ((pp (pp-to-string value)))
			     (cond ((string-match "\n" pp)
				    nil)
				   ((> (length pp) 40)
				    nil)
				   (t t)))))
(widget-put (get 'menu-choice 'widget-type) :custom-show t)

;;; The `custom-manual' Widget.

(define-widget 'custom-manual 'info-link
  "Link to the manual entry for this customization option."
  :help-echo "Read the manual entry for this option."
  :tag "Manual")

;;; The `custom-magic' Widget.

Per Abrahamsen's avatar
Per Abrahamsen committed
1095 1096 1097 1098 1099
(defgroup custom-magic-faces nil
  "Faces used by the magic button."
  :group 'custom-faces
  :group 'custom-buffer)

Per Abrahamsen's avatar
Per Abrahamsen committed
1100 1101 1102 1103
(defface custom-invalid-face '((((class color))
				(:foreground "yellow" :background "red"))
			       (t
				(:bold t :italic t :underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1104 1105
  "Face used when the customize item is invalid."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1106 1107 1108 1109 1110

(defface custom-rogue-face '((((class color))
			      (:foreground "pink" :background "black"))
			     (t
			      (:underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1111 1112
  "Face used when the customize item is not defined for customization."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1113 1114 1115 1116 1117

(defface custom-modified-face '((((class color)) 
				 (:foreground "white" :background "blue"))
				(t
				 (:italic t :bold)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1118 1119
  "Face used when the customize item has been modified."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1120 1121 1122 1123 1124

(defface custom-set-face '((((class color)) 
				(:foreground "blue" :background "white"))
			       (t
				(:italic t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1125 1126
  "Face used when the customize item has been set."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1127 1128 1129 1130 1131

(defface custom-changed-face '((((class color)) 
				(:foreground "white" :background "blue"))
			       (t
				(:italic t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1132 1133
  "Face used when the customize item has been changed."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1134 1135

(defface custom-saved-face '((t (:underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1136 1137
  "Face used when the customize item has been saved."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1138

Per Abrahamsen's avatar
Per Abrahamsen committed
1139
(defconst custom-magic-alist '((nil "#" underline "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1140
uninitialized, you should not see this.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1141
			       (unknown "?" italic "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1142
unknown, you should not see this.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1143
			       (hidden "-" default "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1144 1145
hidden, invoke the dots above to show." "\
group now hidden, invoke the dots above to show contents.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1146
			       (invalid "x" custom-invalid-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1147
the value displayed for this %c is invalid and cannot be set.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1148
			       (modified "*" custom-modified-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1149
you have edited the value, and can now set the %c." "\
1150
you have edited something in this group, and can now set it.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1151
			       (set "+" custom-set-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1152
you have set this %c, but not saved it." "\
1153
something in this group has been set, but not yet saved.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1154
			       (changed ":" custom-changed-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1155
this %c has been changed outside the customize buffer." "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1156 1157
something in this group has been changed outside customize.")
			       (saved "!" custom-saved-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1158
this %c has been set and saved." "\
1159
something in this group has been set and saved.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1160
			       (rogue "@" custom-rogue-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1161
this %c has not been changed with customize." "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1162 1163
something in this group is not prepared for customization.")
			       (standard " " nil "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1164
this %c is unchanged from its standard setting." "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1165
visible group members are all at standard settings."))
Per Abrahamsen's avatar
Per Abrahamsen committed
1166
  "Alist of customize option states.
Per Abrahamsen's avatar
Per Abrahamsen committed
1167
Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where 
Per Abrahamsen's avatar
Per Abrahamsen committed
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188

STATE is one of the following symbols:

`nil'
   For internal use, should never occur.
`unknown'
   For internal use, should never occur.
`hidden'
   This item is not being displayed. 
`invalid'
   This item is modified, but has an invalid form.
`modified'
   This item is modified, and has a valid form.
`set'
   This item has been set but not saved.
`changed'
   The current value of this item has been changed temporarily.
`saved'
   This item is marked for saving.
`rogue'
   This item has no customization information.
Per Abrahamsen's avatar
Per Abrahamsen committed
1189
`standard'
1190
   This item is unchanged from the standard setting.
Per Abrahamsen's avatar
Per Abrahamsen committed
1191 1192 1193 1194 1195

MAGIC is a string used to present that state.

FACE is a face used to present the state.

Per Abrahamsen's avatar
Per Abrahamsen committed
1196 1197 1198 1199 1200
ITEM-DESC is a string describing the state for options.

GROUP-DESC is a string describing the state for groups.  If this is
left out, ITEM-DESC will be used.

Per Abrahamsen's avatar
Per Abrahamsen committed
1201 1202 1203
The string %c in either description will be replaced with the
category of the item.  These are `group'. `option', and `face'.

Per Abrahamsen's avatar
Per Abrahamsen committed
1204
The list should be sorted most significant first.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1205 1206

(defcustom custom-magic-show 'long
Per Abrahamsen's avatar
Per Abrahamsen committed
1207 1208
  "If non-nil, show textual description of the state.
If non-nil and not the symbol `long', only show first word."
Per Abrahamsen's avatar
Per Abrahamsen committed
1209 1210 1211
  :type '(choice (const :tag "no" nil)
		 (const short)
		 (const long))
Per Abrahamsen's avatar
Per Abrahamsen committed
1212
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
1213

Per Abrahamsen's avatar
Per Abrahamsen committed
1214 1215 1216 1217 1218 1219
(defcustom custom-magic-show-hidden '(option face)
  "Control whether the state button is shown for hidden items.
The value should be a list with the custom categories where the state
button should be visible.  Possible categories are `group', `option',
and `face'."
  :type '(set (const group) (const option) (const face))
Per Abrahamsen's avatar
Per Abrahamsen committed
1220
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
1221

Per Abrahamsen's avatar
Per Abrahamsen committed
1222
(defcustom custom-magic-show-button nil
Per Abrahamsen's avatar
Per Abrahamsen committed
1223 1224
  "Show a magic button indicating the state of each customization option."
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
1225
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
1226 1227 1228 1229

(define-widget 'custom-magic 'default
  "Show and manipulate state for a customization option."
  :format "%v"
Per Abrahamsen's avatar
Per Abrahamsen committed
1230
  :action 'widget-parent-action
Per Abrahamsen's avatar
Per Abrahamsen committed
1231
  :notify 'ignore
Per Abrahamsen's avatar
Per Abrahamsen committed
1232 1233 1234 1235
  :value-get 'ignore
  :value-create 'custom-magic-value-create
  :value-delete 'widget-children-value-delete)

Per Abrahamsen's avatar
Per Abrahamsen committed
1236 1237 1238 1239 1240 1241
(defun widget-magic-mouse-down-action (widget &optional event)
  ;; Non-nil unless hidden.
  (not (eq (widget-get (widget-get (widget-get widget :parent) :parent) 
		       :custom-state)
	   'hidden)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1242 1243 1244 1245
(defun custom-magic-value-create (widget)
  ;; Create compact status report for WIDGET.
  (let* ((parent (widget-get widget :parent))
	 (state (widget-get parent :custom-state))
Per Abrahamsen's avatar
Per Abrahamsen committed
1246
	 (hidden (eq state 'hidden))
Per Abrahamsen's avatar
Per Abrahamsen committed
1247
	 (entry (assq state custom-magic-alist))
Per Abrahamsen's avatar
Per Abrahamsen committed
1248 1249
	 (magic (nth 1 entry))
	 (face (nth 2 entry))
Per Abrahamsen's avatar
Per Abrahamsen committed
1250 1251
	 (category (widget-get parent :custom-category))
	 (text (or (and (eq category 'group)
Per Abrahamsen's avatar
Per Abrahamsen committed
1252 1253
			(nth 4 entry))
		   (nth 3 entry)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1254 1255
	 (lisp (eq (widget-get parent :custom-form) 'lisp))
	 children)
Per Abrahamsen's avatar
Per Abrahamsen committed
1256 1257 1258 1259
    (while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text)
      (setq text (concat (match-string 1 text) 
			 (symbol-name category)
			 (match-string 2 text))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1260
    (when (and custom-magic-show
Per Abrahamsen's avatar
Per Abrahamsen committed
1261 1262
	       (or (not hidden)
		   (memq category custom-magic-show-hidden)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1263
      (insert "   ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1264 1265
      (when (eq category 'group)
	(insert-char ?\  (1+ (* 2 (widget-get parent :custom-level)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1266 1267
      (push (widget-create-child-and-convert 
	     widget 'choice-item 
Per Abrahamsen's avatar
Per Abrahamsen committed
1268
	     :help-echo "Change the state of this item."
Per Abrahamsen's avatar
Per Abrahamsen committed
1269
	     :format (if hidden "%t" "%[%t%]")
Per Abrahamsen's avatar
Per Abrahamsen committed
1270 1271
	     :button-prefix 'widget-push-button-prefix
	     :button-suffix 'widget-push-button-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
1272 1273
	     :mouse-down-action 'widget-magic-mouse-down-action
	     :tag "State")
Per Abrahamsen's avatar
Per Abrahamsen committed
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
	    children)
      (insert ": ")
      (if (eq custom-magic-show 'long)
	  (insert text)
	(insert (symbol-name state)))
      (when lisp 
	(insert " (lisp)"))
      (insert "\n"))
    (when custom-magic-show-button
      (when custom-magic-show
	(let ((indent (widget-get parent :indent)))
	  (when indent
	    (insert-char ?  indent))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1287 1288 1289 1290
      (push (widget-create-child-and-convert 
	     widget 'choice-item 
	     :mouse-down-action 'widget-magic-mouse-down-action
	     :button-face face
Per Abrahamsen's avatar
Per Abrahamsen committed