cus-edit.el 82.2 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.9905
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 212 213 214 215 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
(defgroup frames nil
  "Support for Emacs frames and window systems."
  :group 'environment)

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

(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
242 243 244 245 246
  :group 'help)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 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
(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."
  :group 'data)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
322 323
(defgroup mule nil
  "MULE Emacs internationalization."
324
  :group 'i18n)
Per Abrahamsen's avatar
Per Abrahamsen committed
325

Per Abrahamsen's avatar
Per Abrahamsen committed
326 327
(defgroup windows nil
  "Windows within a frame."
Per Abrahamsen's avatar
Per Abrahamsen committed
328
  :group 'environment)
Per Abrahamsen's avatar
Per Abrahamsen committed
329

Per Abrahamsen's avatar
Per Abrahamsen committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
;;; 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
361 362 363 364 365 366 367 368
(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 
369
		(if (symbolp v)
Per Abrahamsen's avatar
Per Abrahamsen committed
370
		    (format "Customize variable: (default %s) " v)
Per Abrahamsen's avatar
Per Abrahamsen committed
371
		  "Customize variable: ")
Per Abrahamsen's avatar
Per Abrahamsen committed
372 373 374 375
		obarray (lambda (symbol)
			  (and (boundp symbol)
			       (or (get symbol 'custom-type)
				   (user-variable-p symbol))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
376
     (list (if (equal val "")
377 378
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
379

Per Abrahamsen's avatar
Per Abrahamsen committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
(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
397 398
;;; Unlispify.

Per Abrahamsen's avatar
Per Abrahamsen committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
(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."
  :group 'customize
  :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
421 422 423 424
	   (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
425 426 427 428 429 430 431 432 433 434 435 436 437 438 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."
  :group 'customize
  :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
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
;;; 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
478 479
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
480 481 482
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
483

Per Abrahamsen's avatar
Per Abrahamsen committed
484 485 486 487
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
488

Per Abrahamsen's avatar
Per Abrahamsen committed
489 490 491 492
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
493

Per Abrahamsen's avatar
Per Abrahamsen committed
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
(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
518

Per Abrahamsen's avatar
Per Abrahamsen committed
519 520 521 522 523 524
;;; Sorting.

(defcustom custom-buffer-sort-predicate 'custom-buffer-sort-alphabetically
  "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
525
  :type '(radio (function-item custom-buffer-sort-alphabetically)
Per Abrahamsen's avatar
Per Abrahamsen committed
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
		(function :tag "Other"))
  :group 'customize)

(defun custom-buffer-sort-alphabetically (a b)
  "Return t iff is A should be before B.
A and B should be members of a `custom-group' property. 
The members are sorted alphabetically, except that all groups are
sorted after all non-groups."
  (cond ((and (eq (nth 1 a) 'custom-group) 
	      (not (eq (nth 1 b) 'custom-group)))
	 nil)
	((and (eq (nth 1 b) 'custom-group) 
	      (not (eq (nth 1 a) 'custom-group)))
	 t)
	(t
	 (string-lessp (symbol-name (nth 0 a)) (symbol-name (nth 0 b))))))

(defcustom custom-menu-sort-predicate 'custom-menu-sort-alphabetically
  "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
547
  :type '(radio (function-item custom-menu-sort-alphabetically)
Per Abrahamsen's avatar
Per Abrahamsen committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
		(function :tag "Other"))
  :group 'customize)

(defun custom-menu-sort-alphabetically (a b)
  "Return t iff is A should be before B.
A and B should be members of a `custom-group' property. 
The members are sorted alphabetically, except that all groups are
sorted before all non-groups."
  (cond ((and (eq (nth 1 a) 'custom-group) 
	      (not (eq (nth 1 b) 'custom-group)))
	 t)
	((and (eq (nth 1 b) 'custom-group) 
	      (not (eq (nth 1 a) 'custom-group)))
	 nil)
	(t
	 (string-lessp (symbol-name (nth 0 a)) (symbol-name (nth 0 b))))))

Per Abrahamsen's avatar
Per Abrahamsen committed
565 566
;;; Custom Mode Commands.

Per Abrahamsen's avatar
Per Abrahamsen committed
567 568 569
(defvar custom-options nil
  "Customization widgets in the current buffer.")

Per Abrahamsen's avatar
Per Abrahamsen committed
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
(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
592
    ("Standard Settings" . custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606
  "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
607
(defun custom-reset-current (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
608 609 610 611 612 613 614 615
  "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
616
(defun custom-reset-saved (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
617 618 619 620 621 622 623 624
  "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)
		(widget-apply child :custom-reset-current)))
	    children)))

Per Abrahamsen's avatar
Per Abrahamsen committed
625
(defun custom-reset-standard (&rest ignore)
626
  "Reset all modified, set, or saved group members to their standard settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
627 628 629 630 631 632 633 634 635
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (eq (widget-get child :custom-state) 'modified)
		(widget-apply child :custom-reset-current)))
	    children)))

;;; The Customize Commands

Per Abrahamsen's avatar
Per Abrahamsen committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 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
(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
704
;;;###autoload
705 706 707 708 709 710
(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
711
  (customize-group 'emacs))
712 713 714 715

;;;###autoload
(defun customize-group (group)
  "Customize GROUP, which must be a customization group."
Per Abrahamsen's avatar
Per Abrahamsen committed
716 717 718 719 720 721
  (interactive (list (completing-read "Customize group: (default emacs) "
				      obarray 
				      (lambda (symbol)
					(get symbol 'custom-group))
				      t)))

722 723 724 725
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
Per Abrahamsen's avatar
Per Abrahamsen committed
726 727 728
  (custom-buffer-create (list (list group 'custom-group))
			(format "*Customize Group: %s*"
				(custom-unlispify-tag-name group))))
Per Abrahamsen's avatar
Per Abrahamsen committed
729

Per Abrahamsen's avatar
Per Abrahamsen committed
730
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
731
(defun customize-group-other-window (symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
732 733 734 735 736 737 738 739 740 741 742
  "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
743 744 745
  (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
746

Per Abrahamsen's avatar
Per Abrahamsen committed
747 748
;;;###autoload
(defalias 'customize-variable 'customize-option)
749

Per Abrahamsen's avatar
Per Abrahamsen committed
750
;;;###autoload
751 752
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
753
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
754
  (custom-buffer-create (list (list symbol 'custom-variable))
755
			(format "*Customize Option: %s*"
Per Abrahamsen's avatar
Per Abrahamsen committed
756
				(custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
757

Per Abrahamsen's avatar
Per Abrahamsen committed
758
;;;###autoload
759 760
(defun customize-option-other-window (symbol)
  "Customize SYMBOL, which must be a user option variable.
Per Abrahamsen's avatar
Per Abrahamsen committed
761 762
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
763 764
  (custom-buffer-create-other-window
   (list (list symbol 'custom-variable))
765
   (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
766

Per Abrahamsen's avatar
Per Abrahamsen committed
767 768 769 770 771 772 773 774 775 776 777
;;;###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)
		  (setq found (cons (list symbol 'custom-face) found)))
Per Abrahamsen's avatar
Per Abrahamsen committed
778 779 780 781
		(nreverse (mapcar 'intern 
				  (sort (mapcar 'symbol-name (face-list))
					'string<))))
			
Per Abrahamsen's avatar
Per Abrahamsen committed
782
	(custom-buffer-create found "*Customize Faces*"))
Per Abrahamsen's avatar
Per Abrahamsen committed
783 784 785 786
    (if (stringp symbol)
	(setq symbol (intern symbol)))
    (unless (symbolp symbol)
      (error "Should be a symbol %S" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
787 788 789
    (custom-buffer-create (list (list symbol 'custom-face))
			  (format "*Customize Face: %s*"
				  (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
790

Per Abrahamsen's avatar
Per Abrahamsen committed
791 792 793 794 795 796 797 798 799 800 801
;;;###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
802 803 804
    (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
805

Per Abrahamsen's avatar
Per Abrahamsen committed
806 807
;;;###autoload
(defun customize-customized ()
Per Abrahamsen's avatar
Per Abrahamsen committed
808 809 810 811 812 813 814 815 816 817 818 819
  "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)
		     (setq found (cons (list symbol 'custom-face) found)))
		(and (get symbol 'customized-value)
		     (boundp symbol)
		     (setq found
			   (cons (list symbol 'custom-variable) found)))))
    (if found 
Per Abrahamsen's avatar
Per Abrahamsen committed
820
	(custom-buffer-create found "*Customize Customized*")
Per Abrahamsen's avatar
Per Abrahamsen committed
821 822 823 824 825
      (error "No customized user options"))))

;;;###autoload
(defun customize-saved ()
  "Customize all already saved user options."
Per Abrahamsen's avatar
Per Abrahamsen committed
826 827 828 829 830 831 832 833 834 835 836
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(and (get symbol 'saved-face)
		     (custom-facep symbol)
		     (setq found (cons (list symbol 'custom-face) found)))
		(and (get symbol 'saved-value)
		     (boundp symbol)
		     (setq found
			   (cons (list symbol 'custom-variable) found)))))
    (if found 
Per Abrahamsen's avatar
Per Abrahamsen committed
837
	(custom-buffer-create found "*Customize Saved*")
Per Abrahamsen's avatar
Per Abrahamsen committed
838
      (error "No saved user options"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854

;;;###autoload
(defun customize-apropos (regexp &optional all)
  "Customize all user options matching REGEXP.
If ALL (e.g., started with a prefix key), include options which are not
user-settable."
  (interactive "sCustomize regexp: \nP")
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(when (string-match regexp (symbol-name symbol))
		  (when (get symbol 'custom-group)
		    (setq found (cons (list symbol 'custom-group) found)))
		  (when (custom-facep symbol)
		    (setq found (cons (list symbol 'custom-face) found)))
		  (when (and (boundp symbol)
			     (or (get symbol 'saved-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
855
				 (get symbol 'standard-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
856 857 858 859 860 861
				 (if all
				     (get symbol 'variable-documentation)
				   (user-variable-p symbol))))
		    (setq found
			  (cons (list symbol 'custom-variable) found))))))
    (if found 
Per Abrahamsen's avatar
Per Abrahamsen committed
862
	(custom-buffer-create found "*Customize Apropos*")
Per Abrahamsen's avatar
Per Abrahamsen committed
863 864
      (error "No matches"))))

Per Abrahamsen's avatar
Per Abrahamsen committed
865 866
;;; Buffer.

Per Abrahamsen's avatar
Per Abrahamsen committed
867
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
868
(defun custom-buffer-create (options &optional name)
Per Abrahamsen's avatar
Per Abrahamsen committed
869
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
870
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
871 872 873
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
874 875 876
  (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
877 878
  (custom-buffer-create-internal options))

Per Abrahamsen's avatar
Per Abrahamsen committed
879
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
880
(defun custom-buffer-create-other-window (options &optional name)
Per Abrahamsen's avatar
Per Abrahamsen committed
881
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
882
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
883 884 885
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
886 887
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
Per Abrahamsen's avatar
Per Abrahamsen committed
888
  (let ((window (selected-window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
889
    (switch-to-buffer-other-window (get-buffer-create name))
Per Abrahamsen's avatar
Per Abrahamsen committed
890 891
    (custom-buffer-create-internal options)
    (select-window window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
892 893 894 895 896 897

(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
  :group 'customize)
Per Abrahamsen's avatar
Per Abrahamsen committed
898 899 900

(defun custom-buffer-create-internal (options)
  (message "Creating customization buffer...")
Per Abrahamsen's avatar
Per Abrahamsen committed
901 902 903 904 905 906
  (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."
907
		 "(emacs)Easy Customization")
Per Abrahamsen's avatar
Per Abrahamsen committed
908
  (widget-insert " for more information.\n\n")
Per Abrahamsen's avatar
Per Abrahamsen committed
909 910 911 912 913 914 915 916 917 918 919 920 921 922
  (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
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
  (if custom-reset-button-menu
      (widget-create 'push-button
		     :tag "Reset"
		     :help-echo "Undo all modifications."
		     :mouse-down-action (lambda (&rest junk) t)
		     :action (lambda (widget &optional event)
			       (custom-reset event)))
    (widget-create 'push-button
		   :tag "Reset"
		   :help-echo "Undo all modifications."
		   :action 'custom-reset-current)
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Saved"
		   :help-echo "Undo all modifications."
		   :action 'custom-reset-saved)
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Standard"
		   :help-echo "Undo all modifications."
		   :action 'custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
944 945 946 947 948 949 950 951
  (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
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
  (setq custom-options 
	(if (= (length options) 1)
	    (mapcar (lambda (entry)
		      (widget-create (nth 1 entry)
				     :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"))
  (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.

(defface custom-invalid-face '((((class color))
				(:foreground "yellow" :background "red"))
			       (t
				(:bold t :italic t :underline t)))
  "Face used when the customize item is invalid.")

(defface custom-rogue-face '((((class color))
			      (:foreground "pink" :background "black"))
			     (t
			      (:underline t)))
  "Face used when the customize item is not defined for customization.")

(defface custom-modified-face '((((class color)) 
				 (:foreground "white" :background "blue"))
				(t
				 (:italic t :bold)))
  "Face used when the customize item has been modified.")

(defface custom-set-face '((((class color)) 
				(:foreground "blue" :background "white"))
			       (t
				(:italic t)))
  "Face used when the customize item has been set.")

(defface custom-changed-face '((((class color)) 
				(:foreground "white" :background "blue"))
			       (t
				(:italic t)))
  "Face used when the customize item has been changed.")

(defface custom-saved-face '((t (:underline t)))
  "Face used when the customize item has been saved.")

Per Abrahamsen's avatar
Per Abrahamsen committed
1046
(defconst custom-magic-alist '((nil "#" underline "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1047
uninitialized, you should not see this.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1048
			       (unknown "?" italic "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1049
unknown, you should not see this.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1050
			       (hidden "-" default "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1051 1052
hidden, invoke the dots above to show." "\
group now hidden, invoke the dots above to show contents.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1053
			       (invalid "x" custom-invalid-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1054
the value displayed for this %c is invalid and cannot be set.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1055
			       (modified "*" custom-modified-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1056
you have edited the value, and can now set the %c." "\
1057
you have edited something in this group, and can now set it.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1058
			       (set "+" custom-set-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1059
you have set this %c, but not saved it." "\
1060
something in this group has been set, but not yet saved.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1061
			       (changed ":" custom-changed-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1062
this %c has been changed outside the customize buffer." "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1063 1064
something in this group has been changed outside customize.")
			       (saved "!" custom-saved-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1065
this %c has been set and saved." "\
1066
something in this group has been set and saved.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1067
			       (rogue "@" custom-rogue-face "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1068
this %c has not been changed with customize." "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1069 1070
something in this group is not prepared for customization.")
			       (standard " " nil "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1071
this %c is unchanged from its standard setting." "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1072
the visible members of this group are all at standard settings."))
Per Abrahamsen's avatar
Per Abrahamsen committed
1073
  "Alist of customize option states.
Per Abrahamsen's avatar
Per Abrahamsen committed
1074
Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where 
Per Abrahamsen's avatar
Per Abrahamsen committed
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095

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
1096
`standard'
1097
   This item is unchanged from the standard setting.
Per Abrahamsen's avatar
Per Abrahamsen committed
1098 1099 1100 1101 1102

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
1103 1104 1105 1106 1107
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
1108 1109 1110
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
1111
The list should be sorted most significant first.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1112 1113

(defcustom custom-magic-show 'long
Per Abrahamsen's avatar
Per Abrahamsen committed
1114 1115
  "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
1116 1117 1118 1119 1120
  :type '(choice (const :tag "no" nil)
		 (const short)
		 (const long))
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
1121 1122 1123 1124 1125 1126
(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
1127 1128
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
1129
(defcustom custom-magic-show-button nil
Per Abrahamsen's avatar
Per Abrahamsen committed
1130 1131 1132 1133 1134 1135 1136
  "Show a magic button indicating the state of each customization option."
  :type 'boolean
  :group 'customize)

(define-widget 'custom-magic 'default
  "Show and manipulate state for a customization option."
  :format "%v"
Per Abrahamsen's avatar
Per Abrahamsen committed
1137
  :action 'widget-parent-action
Per Abrahamsen's avatar
Per Abrahamsen committed
1138
  :notify 'ignore
Per Abrahamsen's avatar
Per Abrahamsen committed
1139 1140 1141 1142
  :value-get 'ignore
  :value-create 'custom-magic-value-create
  :value-delete 'widget-children-value-delete)

Per Abrahamsen's avatar
Per Abrahamsen committed
1143 1144 1145 1146 1147 1148
(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
1149 1150 1151 1152
(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
1153
	 (hidden (eq state 'hidden))
Per Abrahamsen's avatar
Per Abrahamsen committed
1154
	 (entry (assq state custom-magic-alist))
Per Abrahamsen's avatar
Per Abrahamsen committed
1155 1156
	 (magic (nth 1 entry))
	 (face (nth 2 entry))
Per Abrahamsen's avatar
Per Abrahamsen committed
1157 1158
	 (category (widget-get parent :custom-category))
	 (text (or (and (eq category 'group)
Per Abrahamsen's avatar
Per Abrahamsen committed
1159 1160
			(nth 4 entry))
		   (nth 3 entry)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1161 1162
	 (lisp (eq (widget-get parent :custom-form) 'lisp))
	 children)
Per Abrahamsen's avatar
Per Abrahamsen committed
1163 1164 1165 1166
    (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
1167
    (when (and custom-magic-show
Per Abrahamsen's avatar
Per Abrahamsen committed
1168 1169
	       (or (not hidden)
		   (memq category custom-magic-show-hidden)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1170
      (insert "   ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1171 1172
      (push (widget-create-child-and-convert 
	     widget 'choice-item 
Per Abrahamsen's avatar
Per Abrahamsen committed
1173
	     :help-echo "Change the state of this item."
Per Abrahamsen's avatar
Per Abrahamsen committed
1174
	     :format (if hidden "%t" "%[%t%]")
Per Abrahamsen's avatar
Per Abrahamsen committed
1175 1176
	     :button-prefix 'widget-push-button-prefix
	     :button-suffix 'widget-push-button-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
1177 1178
	     :mouse-down-action 'widget-magic-mouse-down-action
	     :tag "State")
Per Abrahamsen's avatar
Per Abrahamsen committed
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
	    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
1192 1193 1194 1195
      (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
1196 1197
	     :button-prefix ""
	     :button-suffix ""
Per Abrahamsen's avatar
Per Abrahamsen committed
1198
	     :help-echo "Change the state."
Per Abrahamsen's avatar
Per Abrahamsen committed
1199
	     :format (if hidden "%t" "%[%t%]")
Per Abrahamsen's avatar
Per Abrahamsen committed
1200 1201 1202
	     :tag (if lisp 
		      (concat "(" magic ")")
		    (concat "[" magic "]")))
Per Abrahamsen's avatar
Per Abrahamsen committed
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
	    children)
      (insert " "))
    (widget-put widget :children children)))

(defun custom-magic-reset (widget)
  "Redraw the :custom-magic property of WIDGET."
  (let ((magic (widget-get widget :custom-magic)))
    (widget-value-set magic (widget-value magic))))

;;; The `custom' Widget.

(define-widget 'custom 'default
  "Customize a user option."
  :convert-widget 'custom-convert-widget
  :format-handler 'custom-format-handler
  :notify 'custom-notify
  :custom-level 1
  :custom-state 'hidden
  :documentation-property 'widget-subclass-responsibility
  :value-create 'widget-subclass-responsibility
  :value-delete 'widget-children-value-delete
Per Abrahamsen's avatar
Per Abrahamsen committed
1224 1225
  :value-get 'widget-value-value-get
  :validate 'widget-children-validate
Per Abrahamsen's avatar
Per Abrahamsen committed
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
  :match (lambda (widget value) (symbolp value)))

(defun custom-convert-widget (widget)
  ;; Initialize :value and :tag from :args in WIDGET.
  (let ((args (widget-get widget :args)))
    (when args 
      (widget-put widget :value (widget-apply widget
					      :value-to-internal (car args)))
      (widget-put widget :tag (custom-unlispify-tag-name (car args)))
      (widget-put widget :args nil)))
  widget)

(defun custom-format-handler (widget escape)
  ;; We recognize extra escape sequences.
  (let* ((buttons (widget-get widget :buttons))
	 (state (widget-get widget :custom-state))
	 (level (widget-get widget :custom-level)))
    (cond ((eq escape ?l)
	   (when level 
Per Abrahamsen's avatar
Per Abrahamsen committed
1245
	     (insert-char ?\  (1- level))
Per Abrahamsen's avatar
Per Abrahamsen committed
1246
	     (if (eq state 'hidden)
Per Abrahamsen's avatar
Per Abrahamsen committed
1247 1248 1249
		 (insert-char ?- (1+ level))
	       (insert "/")
	       (insert-char ?- level))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1250 1251
	  ((eq escape ?e)
	   (when (and level (not (eq state 'hidden)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1252 1253 1254 1255 1256 1257 1258
	     (insert "\n")
	     (insert-char ?\  (1- level))
	     (insert "\\")
	     (insert-char ?-  level)
	     (insert " " (widget-get widget :tag) " group end ")
	     (insert-char ?- (- 75 (current-column) level))
	     (insert "/\n")))
Per Abrahamsen's avatar
Per Abrahamsen committed
1259
	  ((eq escape ?-)
Per Abrahamsen's avatar
Per Abrahamsen committed
1260 1261 1262
	   (when (and level (not (eq state 'hidden)))
	     (insert-char ?- (- 76 (current-column) level))
	     (insert "\\")))
Per Abrahamsen's avatar
Per Abrahamsen committed
1263
	  ((eq escape ?L)
Per Abrahamsen's avatar
Per Abrahamsen committed
1264 1265 1266 1267 1268
	   (push (widget-create-child-and-convert
		  widget 'visibility
		  :action 'custom-toggle-parent
		  (not (eq state 'hidden)))
		 buttons))
Per Abrahamsen's avatar
Per Abrahamsen committed
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
	  ((eq escape ?m)
	   (and (eq (preceding-char) ?\n)
		(widget-get widget :indent)
		(insert-char ?  (widget-get widget :indent)))
	   (let ((magic (widget-create-child-and-convert
			 widget 'custom-magic nil)))
	     (widget-put widget :custom-magic magic)
	     (push magic buttons)
	     (widget-put widget :buttons buttons)))
	  ((eq escape ?a)
Per Abrahamsen's avatar
Per Abrahamsen committed
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
	   (unless (eq state 'hidden)
	     (let* ((symbol (widget-get widget :value))
		    (links (get symbol 'custom-links))
		    (many (> (length links) 2)))
	       (when links
		 (and (eq (preceding-char) ?\n)
		      (widget-get widget :indent)
		      (insert-char ?  (widget-get widget :indent)))
		 (insert "See also ")
		 (while links
		   (push (widget-create-child-and-convert widget (car links))
			 buttons)
		   (setq links (cdr links))
		   (cond ((null links)
			  (insert ".\n"))
			 ((null (cdr links))
			  (if many
			      (insert ", and ")
			    (insert " and ")))
			 (t 
			  (insert ", "))))
		 (widget-put widget :buttons buttons)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1301 1302 1303 1304 1305
	  (t 
	   (widget-default-format-handler widget escape)))))

(defun custom-notify (widget &rest args)
  "Keep track of changes."
Per Abrahamsen's avatar
Per Abrahamsen committed
1306 1307 1308 1309 1310 1311
  (let ((state (widget-get widget :custom-state)))
    (unless (eq state 'modified)
      (unless (memq state '(nil unknown hidden))
	(widget-put widget :custom-state 'modified))
      (custom-magic-reset widget)
      (apply 'widget-default-notify widget args))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1312 1313 1314

(defun custom-redraw (widget)
  "Redraw WIDGET with current settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
1315 1316 1317
  (let ((line (count-lines (point-min) (point)))
	(column (current-column))
	(pos (point))
Per Abrahamsen's avatar
Per Abrahamsen committed
1318 1319 1320 1321 1322 1323
	(from (marker-position (widget-get widget :from)))
	(to (marker-position (widget-get widget :to))))
    (save-excursion
      (widget-value-set widget (widget-value widget))
      (custom-redraw-magic widget))
    (when (and (>= pos from) (<= pos to))
Per Abrahamsen's avatar
Per Abrahamsen committed
1324 1325
      (condition-case nil
	  (progn 
Per Abrahamsen's avatar
Per Abrahamsen committed
1326 1327 1328
	    (if (> column 0)
		(goto-line line)
	      (goto-line (1+ line)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1329 1330
	    (move-to-column column))
	(error nil)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352

(defun custom-redraw-magic (widget)
  "Redraw WIDGET state with current settings."
  (while widget 
    (let ((magic (widget-get widget :custom-magic)))
      (unless magic 
	(debug))
      (widget-value-set magic (widget-value magic))
      (when (setq widget (widget-get widget :group))
	(custom-group-state-update widget))))
  (widget-setup))

(defun custom-show (widget value)
  "Non-nil if WIDGET should be shown with VALUE by default."
  (let ((show (widget-get widget :custom-show)))
    (cond ((null show)
	   nil)
	  ((eq t show)
	   t)
	  (t
	   (funcall show widget value)))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1353 1354 1355
(defvar custom-load-recursion nil
  "Hack to avoid recursive dependencies.")

Per Abrahamsen's avatar
Per Abrahamsen committed
1356 1357
(defun custom-load-symbol (symbol)
  "Load all dependencies for SYMBOL."
Per Abrahamsen's avatar
Per Abrahamsen committed
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
  (unless custom-load-recursion
    (let ((custom-load-recursion t) 
	  (loads (get symbol 'custom-loads))
	  load)
      (while loads
	(setq load (car loads)
	      loads (cdr loads))
	(cond ((symbolp load)
	       (condition-case nil
		   (require load)
		 (error nil)))
1369
	      ;; Don't reload a file already loaded.
1370
	      ((assoc load load-history))
1371
	      ((assoc (locate-library load) load-history))
Per Abrahamsen's avatar
Per Abrahamsen committed
1372 1373
	      (t
	       (condition-case nil
1374 1375 1376 1377 1378
		   ;; Without this, we would load cus-edit recursively.
		   ;; We are still loading it when we call this,
		   ;; and it is not in load-history yet.
		   (or (equal load "cus-edit")
		       (load-library load))
Per Abrahamsen's avatar
Per Abrahamsen committed
1379
		 (error nil))))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1380 1381 1382 1383 1384

(defun custom-load-widget (widget)
  "Load all dependencies for WIDGET."
  (custom-load-symbol (widget-value widget)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1385 1386 1387 1388 1389 1390 1391 1392
(defun custom-toggle-hide (widget)
  "Toggle visibility of WIDGET."
  (let ((state (widget-get widget :custom-state)))
    (cond ((memq state '(invalid modified))
	   (error "There are unset changes"))
	  ((eq state 'hidden)
	   (widget-put widget :custom-state 'unknown))
	  (t 
Per Abrahamsen's avatar
Per Abrahamsen committed
1393
	   (widget-put widget :documentation-shown nil)
Per Abrahamsen's avatar
Per Abrahamsen committed
1394 1395 1396
	   (widget-put widget :custom-state 'hidden)))
    (custom-redraw widget)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1397 1398 1399 1400
(defun custom-toggle-parent (widget &rest ignore)
  "Toggle visibility of parent to WIDGET."
  (custom-toggle-hide (widget-get widget :parent)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1401 1402 1403 1404
;;; The `custom-variable' Widget.

(defface custom-variable-sample-face '((t (:underline t)))
  "Face used for unpushable variable tags."