cus-edit.el 103 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; cus-edit.el --- Tools for customizating Emacs and Lisp packages.
Per Abrahamsen's avatar
Per Abrahamsen committed
2 3 4 5 6
;;
;; 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.9944
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
;; See `custom.el'.

33 34 35 36
;; No commands should have names starting with `custom-' because
;; that interferes with completion.  Use `customize-' for commands
;; that the user will run with M-x, and `Custom-' for interactive commands.

Per Abrahamsen's avatar
Per Abrahamsen committed
37 38 39 40 41
;;; Code:

(require 'cus-face)
(require 'wid-edit)
(require 'easymenu)
Per Abrahamsen's avatar
Per Abrahamsen committed
42 43 44 45 46
(eval-when-compile (require 'cl))

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

Per Abrahamsen's avatar
Per Abrahamsen committed
48 49 50 51
(condition-case nil
    (require 'cus-start)
  (error nil))

Per Abrahamsen's avatar
Per Abrahamsen committed
52 53
(define-widget-keywords :custom-last :custom-prefix :custom-category
  :custom-prefixes :custom-menu  
Per Abrahamsen's avatar
Per Abrahamsen committed
54
  :custom-show  
Per Abrahamsen's avatar
Per Abrahamsen committed
55 56
  :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
57
  :custom-reset-standard)
Per Abrahamsen's avatar
Per Abrahamsen committed
58

Per Abrahamsen's avatar
Per Abrahamsen committed
59
(put 'custom-define-hook 'custom-type 'hook)
Per Abrahamsen's avatar
Per Abrahamsen committed
60
(put 'custom-define-hook 'standard-value '(nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
61 62
(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)

Per Abrahamsen's avatar
Per Abrahamsen committed
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 200 201 202 203 204
;;; 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
205 206 207 208
(defgroup x nil
  "The X Window system."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
209 210 211 212 213 214 215 216
(defgroup frames nil
  "Support for Emacs frames and window systems."
  :group 'environment)

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

217 218 219 220
(defgroup files nil
  "Support editing files."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
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 246 247 248 249 250
(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
251 252 253 254 255
  :group 'help)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
258 259 260 261 262
(defgroup custom-browse nil
  "Control customize browser."
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
263
(defgroup custom-buffer nil
Per Abrahamsen's avatar
Per Abrahamsen committed
264
  "Control customize buffers."
Per Abrahamsen's avatar
Per Abrahamsen committed
265 266 267 268
  :prefix "custom-"
  :group 'customize)

(defgroup custom-menu nil
Per Abrahamsen's avatar
Per Abrahamsen committed
269
  "Control customize menus."
Per Abrahamsen's avatar
Per Abrahamsen committed
270 271 272
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
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 330 331 332 333 334 335 336 337 338 339
(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."
340
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
341 342 343 344 345

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

Per Abrahamsen's avatar
Per Abrahamsen committed
346 347
(defgroup mule nil
  "MULE Emacs internationalization."
348
  :group 'i18n)
Per Abrahamsen's avatar
Per Abrahamsen committed
349

Per Abrahamsen's avatar
Per Abrahamsen committed
350 351
(defgroup windows nil
  "Windows within a frame."
Per Abrahamsen's avatar
Per Abrahamsen committed
352
  :group 'environment)
Per Abrahamsen's avatar
Per Abrahamsen committed
353

Per Abrahamsen's avatar
Per Abrahamsen committed
354 355
;;; Utilities.

Per Abrahamsen's avatar
Per Abrahamsen committed
356 357 358 359 360 361 362 363 364 365 366 367
(defun custom-last (x &optional n)
  ;; Stolen from `cl.el'.
  "Returns the last link in the list LIST.
With optional argument N, returns Nth-to-last link (default 1)."
  (if n
      (let ((m 0) (p x))
	(while (consp p) (incf m) (pop p))
	(if (<= n 0) p
	  (if (< n m) (nthcdr (- m n) x) x)))
    (while (consp (cdr x)) (pop x))
    x))

Per Abrahamsen's avatar
Per Abrahamsen committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
(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
397 398 399 400 401 402 403 404
(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 
405
		(if (symbolp v)
406
		    (format "Customize option: (default %s) " v)
Per Abrahamsen's avatar
Per Abrahamsen committed
407
		  "Customize variable: ")
Per Abrahamsen's avatar
Per Abrahamsen committed
408 409 410 411
		obarray (lambda (symbol)
			  (and (boundp symbol)
			       (or (get symbol 'custom-type)
				   (user-variable-p symbol))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
412
     (list (if (equal val "")
413 414
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
415

Per Abrahamsen's avatar
Per Abrahamsen committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
(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
433 434
;;; Unlispify.

Per Abrahamsen's avatar
Per Abrahamsen committed
435 436 437 438 439
(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
440
  :group 'custom-menu
Per Abrahamsen's avatar
Per Abrahamsen committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
  :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
457 458 459 460
	   (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
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
	   (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
479
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
480 481 482 483 484 485 486 487 488 489 490 491 492
  :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
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
;;; 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
514 515
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
516 517 518
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
519

Per Abrahamsen's avatar
Per Abrahamsen committed
520 521 522 523
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
524

Per Abrahamsen's avatar
Per Abrahamsen committed
525 526 527 528
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
529

Per Abrahamsen's avatar
Per Abrahamsen committed
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
(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
554

Per Abrahamsen's avatar
Per Abrahamsen committed
555 556
;;; Sorting.

Per Abrahamsen's avatar
Per Abrahamsen committed
557 558 559 560 561 562 563 564 565 566 567 568 569 570
(defcustom custom-browse-sort-alphabetically nil
  "If non-nil, sort members of each customization group alphabetically."
  :type 'boolean
  :group 'custom-browse)

(defcustom custom-browse-order-groups nil
  "If non-nil, order group members within each customization group.
If `first', order groups before non-groups.
If `last', order groups after non-groups."
  :type '(choice (const first)
		 (const last)
		 (const :tag "none" nil))
  :group 'custom-browse)

Per Abrahamsen's avatar
Per Abrahamsen committed
571 572 573 574 575
(defcustom custom-browse-only-groups nil
  "If non-nil, show group members only within each customization group."
  :type 'boolean
  :group 'custom-browse)

Per Abrahamsen's avatar
Per Abrahamsen committed
576
(defcustom custom-buffer-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
577
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
578
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
579
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
580

Per Abrahamsen's avatar
Per Abrahamsen committed
581 582 583 584 585 586 587
(defcustom custom-buffer-order-groups 'last
  "If non-nil, order group members within each customization group.
If `first', order groups before non-groups.
If `last', order groups after non-groups."
  :type '(choice (const first)
		 (const last)
		 (const :tag "none" nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
588
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
589

Per Abrahamsen's avatar
Per Abrahamsen committed
590
(defcustom custom-menu-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
591
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
592
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
593
  :group 'custom-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
594

Per Abrahamsen's avatar
Per Abrahamsen committed
595 596 597 598 599 600 601
(defcustom custom-menu-order-groups 'first
  "If non-nil, order group members within each customization group.
If `first', order groups before non-groups.
If `last', order groups after non-groups."
  :type '(choice (const first)
		 (const last)
		 (const :tag "none" nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
602 603
  :group 'custom-menu)

Per Abrahamsen's avatar
Per Abrahamsen committed
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
(defun custom-sort-items (items sort-alphabetically order-groups)
  "Return a sorted copy of ITEMS.
ITEMS should be a `custom-group' property.
If SORT-ALPHABETICALLY non-nil, sort alphabetically.
If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
groups after non-groups, if nil do not order groups at all."
  (sort (copy-sequence items)
   (lambda (a b)
     (let ((typea (nth 1 a)) (typeb (nth 1 b))
	   (namea (symbol-name (nth 0 a))) (nameb (symbol-name (nth 0 b))))
       (cond ((not order-groups)
	      ;; Since we don't care about A and B order, maybe sort.
	      (when sort-alphabetically
		(string-lessp namea nameb)))
	     ((eq typea 'custom-group)
	      ;; If B is also a group, maybe sort.  Otherwise, order A and B.
	      (if (eq typeb 'custom-group)
		  (when sort-alphabetically
		    (string-lessp namea nameb))
		(eq order-groups 'first)))
	     ((eq typeb 'custom-group)
	      ;; Since A cannot be a group, order A and B.
	      (eq order-groups 'last))
	     (sort-alphabetically
	      ;; Since A and B cannot be groups, sort.
	      (string-lessp namea nameb)))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
630

Per Abrahamsen's avatar
Per Abrahamsen committed
631 632
;;; Custom Mode Commands.

Per Abrahamsen's avatar
Per Abrahamsen committed
633 634 635
(defvar custom-options nil
  "Customization widgets in the current buffer.")

636
(defun Custom-set ()
Per Abrahamsen's avatar
Per Abrahamsen committed
637 638 639 640 641 642 643 644
  "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)))

645
(defun Custom-save ()
Per Abrahamsen's avatar
Per Abrahamsen committed
646 647 648 649 650 651 652 653 654 655
  "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 
656 657 658
  '(("Current" . Custom-reset-current)
    ("Saved" . Custom-reset-saved)
    ("Standard Settings" . Custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672
  "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))))

673
(defun Custom-reset-current (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
674 675 676 677 678 679 680 681
  "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)))

682
(defun Custom-reset-saved (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
683 684 685 686 687
  "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
688
		(widget-apply child :custom-reset-saved)))
Per Abrahamsen's avatar
Per Abrahamsen committed
689 690
	    children)))

691
(defun Custom-reset-standard (&rest ignore)
692
  "Reset all modified, set, or saved group members to their standard settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
693 694 695 696
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (eq (widget-get child :custom-state) 'modified)
Per Abrahamsen's avatar
Per Abrahamsen committed
697
		(widget-apply child :custom-reset-standard)))
Per Abrahamsen's avatar
Per Abrahamsen committed
698 699 700 701
	    children)))

;;; The Customize Commands

Per Abrahamsen's avatar
Per Abrahamsen committed
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 728 729 730 731 732 733 734 735 736
(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
737
(defun customize-set-value (var val)
Per Abrahamsen's avatar
Per Abrahamsen committed
738 739 740 741 742 743 744 745 746 747 748 749 750
  "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
751
(defun customize-set-variable (var val)
Per Abrahamsen's avatar
Per Abrahamsen committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
  "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
770
;;;###autoload
771 772 773 774 775 776
(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
777
  (customize-group 'emacs))
778 779 780 781

;;;###autoload
(defun customize-group (group)
  "Customize GROUP, which must be a customization group."
782 783 784 785 786 787
  (interactive (list (let ((completion-ignore-case t))
		       (completing-read "Customize group: (default emacs) "
					obarray 
					(lambda (symbol)
					  (get symbol 'custom-group))
					t))))
Per Abrahamsen's avatar
Per Abrahamsen committed
788

789 790 791 792
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
793 794 795 796 797
  (let ((name (format "*Customize Group: %s*"
		      (custom-unlispify-tag-name group))))
    (if (get-buffer name)
	(switch-to-buffer name)
      (custom-buffer-create (list (list group 'custom-group))
798 799 800
			    name
			    (concat " for group "
				    (custom-unlispify-tag-name group))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
801

Per Abrahamsen's avatar
Per Abrahamsen committed
802
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
803
(defun customize-group-other-window (symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
804 805 806 807 808 809 810 811 812 813 814
  "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
815 816 817
  (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
818

Per Abrahamsen's avatar
Per Abrahamsen committed
819 820
;;;###autoload
(defalias 'customize-variable 'customize-option)
821

Per Abrahamsen's avatar
Per Abrahamsen committed
822
;;;###autoload
823 824
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
825
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
826
  (custom-buffer-create (list (list symbol 'custom-variable))
827
			(format "*Customize Option: %s*"
Per Abrahamsen's avatar
Per Abrahamsen committed
828
				(custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
829

Per Abrahamsen's avatar
Per Abrahamsen committed
830 831 832
;;;###autoload
(defalias 'customize-variable-other-window 'customize-option-other-window)

Per Abrahamsen's avatar
Per Abrahamsen committed
833
;;;###autoload
834 835
(defun customize-option-other-window (symbol)
  "Customize SYMBOL, which must be a user option variable.
Per Abrahamsen's avatar
Per Abrahamsen committed
836 837
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
838 839
  (custom-buffer-create-other-window
   (list (list symbol 'custom-variable))
840
   (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
841

Per Abrahamsen's avatar
Per Abrahamsen committed
842 843 844 845 846 847 848
;;;###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))))
Per Abrahamsen's avatar
Per Abrahamsen committed
849 850 851 852 853 854 855 856
      (custom-buffer-create (custom-sort-items
			     (mapcar (lambda (symbol)
				       (list symbol 'custom-face))
				     (face-list))
			     t nil)
			    "*Customize Faces*")
    (when (stringp symbol)
      (setq symbol (intern symbol)))
Per Abrahamsen's avatar
Per Abrahamsen committed
857 858
    (unless (symbolp symbol)
      (error "Should be a symbol %S" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
859 860 861
    (custom-buffer-create (list (list symbol 'custom-face))
			  (format "*Customize Face: %s*"
				  (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
862

Per Abrahamsen's avatar
Per Abrahamsen committed
863 864 865 866 867 868 869 870 871 872 873
;;;###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
874 875 876
    (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
877

Per Abrahamsen's avatar
Per Abrahamsen committed
878 879
;;;###autoload
(defun customize-customized ()
Per Abrahamsen's avatar
Per Abrahamsen committed
880 881 882 883 884 885
  "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
886
		     (push (list symbol 'custom-face) found))
Per Abrahamsen's avatar
Per Abrahamsen committed
887 888
		(and (get symbol 'customized-value)
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
889
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
890 891 892 893
    (if (not found)
	(error "No customized user options")
      (custom-buffer-create (custom-sort-items found t nil)
			    "*Customize Customized*"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
894 895 896 897

;;;###autoload
(defun customize-saved ()
  "Customize all already saved user options."
Per Abrahamsen's avatar
Per Abrahamsen committed
898 899 900 901 902
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(and (get symbol 'saved-face)
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
903
		     (push (list symbol 'custom-face) found))
Per Abrahamsen's avatar
Per Abrahamsen committed
904 905
		(and (get symbol 'saved-value)
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
906
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
907 908 909 910
    (if (not found )
	(error "No saved user options")
      (custom-buffer-create (custom-sort-items found t nil)
			    "*Customize Saved*"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
911 912 913 914

;;;###autoload
(defun customize-apropos (regexp &optional all)
  "Customize all user options matching REGEXP.
Per Abrahamsen's avatar
Per Abrahamsen committed
915 916 917 918 919
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
920 921 922 923
  (interactive "sCustomize regexp: \nP")
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(when (string-match regexp (symbol-name symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
924 925 926 927 928 929 930 931
		  (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
932
			     (or (get symbol 'saved-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
933
				 (get symbol 'standard-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
934 935 936 937 938 939
				 (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")
Per Abrahamsen's avatar
Per Abrahamsen committed
940 941 942
      (custom-buffer-create (custom-sort-items found t
					       custom-buffer-order-groups)
			    "*Customize Apropos*"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961

;;;###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
962

Per Abrahamsen's avatar
Per Abrahamsen committed
963 964
;;; Buffer.

Per Abrahamsen's avatar
Per Abrahamsen committed
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
(defcustom custom-buffer-style 'links
  "Control the presentation style for customization buffers.
The value should be a symbol, one of:

brackets: groups nest within each other with big horizontal brackets.
links: groups have links to subgroups."
  :type '(radio (const brackets)
		(const links))
  :group 'custom-buffer)

(defcustom custom-buffer-indent 3
  "Number of spaces to indent nested groups."
  :type 'integer
  :group 'custom-buffer)

Per Abrahamsen's avatar
Per Abrahamsen committed
980
;;;###autoload
981
(defun custom-buffer-create (options &optional name description)
Per Abrahamsen's avatar
Per Abrahamsen committed
982
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
983
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
984 985 986
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
987 988 989
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
  (switch-to-buffer (get-buffer-create name))
990
  (custom-buffer-create-internal options description))
Per Abrahamsen's avatar
Per Abrahamsen committed
991

Per Abrahamsen's avatar
Per Abrahamsen committed
992
;;;###autoload
993
(defun custom-buffer-create-other-window (options &optional name description)
Per Abrahamsen's avatar
Per Abrahamsen committed
994
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
995
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
996 997 998
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
999 1000
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
Per Abrahamsen's avatar
Per Abrahamsen committed
1001
  (let ((window (selected-window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1002
    (switch-to-buffer-other-window (get-buffer-create name))
1003
    (custom-buffer-create-internal options description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1004
    (select-window window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1005 1006 1007 1008 1009

(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
1010
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
1011

1012
(defun custom-buffer-create-internal (options &optional description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1013
  (message "Creating customization buffer...")
Per Abrahamsen's avatar
Per Abrahamsen committed
1014
  (custom-mode)
1015 1016 1017 1018
  (widget-insert "This is a customization buffer")
  (if description
      (widget-insert description))
  (widget-insert ".
1019
Square brackets show active fields; type RET or click mouse-1
1020 1021 1022 1023
on an active field to invoke its action.  Editing an option value
changes the text in the buffer; invoke the State button and
choose the Set operation to set the option value.
Invoke ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1024
  (widget-create 'info-link 
1025
		 :tag "Help"
Per Abrahamsen's avatar
Per Abrahamsen committed
1026
		 :help-echo "Read the online help."
1027
		 "(emacs)Easy Customization")
Per Abrahamsen's avatar
Per Abrahamsen committed
1028
  (widget-insert " for more information.\n\n")
Per Abrahamsen's avatar
Per Abrahamsen committed
1029
  (message "Creating customization buttons...")
1030
  (widget-insert "Operate on everything in this buffer:\n ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1031
  (widget-create 'push-button
1032
		 :tag "Set for Current Session"
1033 1034
		 :help-echo "\
Make your editing in this buffer take effect for this session."
Per Abrahamsen's avatar
Per Abrahamsen committed
1035
		 :action (lambda (widget &optional event)
1036
			   (Custom-set)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1037 1038
  (widget-insert " ")
  (widget-create 'push-button
1039
		 :tag "Save for Future Sessions"
Per Abrahamsen's avatar
Per Abrahamsen committed
1040
		 :help-echo "\
1041
Make your editing in this buffer take effect for future Emacs sessions."
Per Abrahamsen's avatar
Per Abrahamsen committed
1042
		 :action (lambda (widget &optional event)
1043
			   (Custom-save)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1044
  (if custom-reset-button-menu
1045 1046 1047 1048 1049 1050 1051 1052 1053
      (progn
	(widget-insert " ")
	(widget-create 'push-button
		       :tag "Reset"
		       :help-echo "Show a menu with reset operations."
		       :mouse-down-action (lambda (&rest junk) t)
		       :action (lambda (widget &optional event)
				 (custom-reset event))))
    (widget-insert "\n ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1054 1055
    (widget-create 'push-button
		   :tag "Reset"
Per Abrahamsen's avatar
Per Abrahamsen committed
1056
		   :help-echo "\
1057
Reset all edited text in this buffer to reflect current values."
1058
		   :action 'Custom-reset-current)
Per Abrahamsen's avatar
Per Abrahamsen committed
1059 1060 1061
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Saved"
Per Abrahamsen's avatar
Per Abrahamsen committed
1062
		   :help-echo "\
1063
Reset all values in this buffer to their saved settings."
1064
		   :action 'Custom-reset-saved)
Per Abrahamsen's avatar
Per Abrahamsen committed
1065 1066 1067
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Standard"
Per Abrahamsen's avatar
Per Abrahamsen committed
1068
		   :help-echo "\
1069
Reset all values in this buffer to their standard settings."
1070
		   :action 'Custom-reset-standard))
1071
  (widget-insert "   ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1072
  (widget-create 'push-button
1073
		 :tag "Bury Buffer"
Per Abrahamsen's avatar
Per Abrahamsen committed
1074 1075 1076 1077 1078
		 :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
1079 1080 1081 1082
  (setq custom-options 
	(if (= (length options) 1)
	    (mapcar (lambda (entry)
		      (widget-create (nth 1 entry)
Per Abrahamsen's avatar
Per Abrahamsen committed
1083
				     :documentation-shown t
Per Abrahamsen's avatar
Per Abrahamsen committed
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
				     :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
1106 1107
  (unless (eq custom-buffer-style 'tree)
    (mapcar 'custom-magic-reset custom-options))
Per Abrahamsen's avatar
Per Abrahamsen committed
1108 1109 1110 1111 1112
  (message "Creating customization setup...")
  (widget-setup)
  (goto-char (point-min))
  (message "Creating customization buffer...done"))

Per Abrahamsen's avatar
Per Abrahamsen committed
1113 1114 1115
;;; The Tree Browser.

;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
1116
(defun customize-browse (group)
Per Abrahamsen's avatar
Per Abrahamsen committed
1117
  "Create a tree browser for the customize hierarchy."
Per Abrahamsen's avatar
Per Abrahamsen committed
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
  (interactive (list (let ((completion-ignore-case t))
		       (completing-read "Customize group: (default emacs) "
					obarray 
					(lambda (symbol)
					  (get symbol 'custom-group))
					t))))

  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1129 1130 1131 1132 1133
  (let ((name "*Customize Browser*"))
    (kill-buffer (get-buffer-create name))
    (switch-to-buffer (get-buffer-create name)))
  (custom-mode)
  (widget-insert "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
Invoke [+] or [?] below to expand items, and [-] to collapse items.\n")
  (if custom-browse-only-groups
      (widget-insert "\
Invoke the [Group] button below to edit that item in another window.\n\n")
    (widget-insert "Invoke the ") 
    (widget-create 'item 
		   :format "%t"
		   :tag "[Group]"
		   :tag-glyph "folder")
    (widget-insert ", ")
    (widget-create 'item 
		   :format "%t"
		   :tag "[Face]"
		   :tag-glyph "face")
    (widget-insert ", and ")
    (widget-create 'item 
		   :format "%t"
		   :tag "[Option]"
		   :tag-glyph "option")
    (widget-insert " buttons below to edit that
item in another window.\n\n"))
Per Abrahamsen's avatar
Per Abrahamsen committed
1155 1156 1157 1158
  (let ((custom-buffer-style 'tree))
    (widget-create 'custom-group 
		   :custom-last t
		   :custom-state 'unknown
Per Abrahamsen's avatar
Per Abrahamsen committed
1159 1160
		   :tag (custom-unlispify-tag-name group)
		   :value group))
Per Abrahamsen's avatar
Per Abrahamsen committed
1161 1162
  (goto-char (point-min)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1163
(define-widget 'custom-browse-visibility 'item
Per Abrahamsen's avatar
Per Abrahamsen committed
1164
  "Control visibility of of items in the customize tree browser."
Per Abrahamsen's avatar
Per Abrahamsen committed
1165
  :format "%[[%t]%]"
Per Abrahamsen's avatar
Per Abrahamsen committed
1166
  :action 'custom-browse-visibility-action)
Per Abrahamsen's avatar
Per Abrahamsen committed
1167

Per Abrahamsen's avatar
Per Abrahamsen committed
1168
(defun custom-browse-visibility-action (widget &rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
1169 1170 1171
  (let ((custom-buffer-style 'tree))
    (custom-toggle-parent widget)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1172
(define-widget 'custom-browse-group-tag 'push-button
Per Abrahamsen's avatar
Per Abrahamsen committed
1173
  "Show parent in other window when activated."
1174
  :tag "Group"
Per Abrahamsen's avatar
Per Abrahamsen committed
1175
  :tag-glyph "folder"
Per Abrahamsen's avatar
Per Abrahamsen committed
1176
  :action 'custom-browse-group-tag-action)
Per Abrahamsen's avatar
Per Abrahamsen committed
1177

Per Abrahamsen's avatar
Per Abrahamsen committed
1178
(defun custom-browse-group-tag-action (widget &rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
1179 1180 1181
  (let ((parent (widget-get widget :parent)))
    (customize-group-other-window (widget-value parent))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1182
(define-widget 'custom-browse-variable-tag 'push-button
Per Abrahamsen's avatar
Per Abrahamsen committed
1183
  "Show parent in other window when activated."
1184
  :tag "Option"
Per Abrahamsen's avatar
Per Abrahamsen committed
1185
  :tag-glyph "option"
Per Abrahamsen's avatar
Per Abrahamsen committed
1186
  :action 'custom-browse-variable-tag-action)
Per Abrahamsen's avatar
Per Abrahamsen committed
1187

Per Abrahamsen's avatar
Per Abrahamsen committed
1188
(defun custom-browse-variable-tag-action (widget &rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
1189 1190 1191
  (let ((parent (widget-get widget :parent)))
    (customize-variable-other-window (widget-value parent))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1192
(define-widget 'custom-browse-face-tag 'push-button
Per Abrahamsen's avatar
Per Abrahamsen committed
1193
  "Show parent in other window when activated."
1194
  :tag "Face"
Per Abrahamsen's avatar
Per Abrahamsen committed
1195
  :tag-glyph "face"
Per Abrahamsen's avatar
Per Abrahamsen committed
1196
  :action 'custom-browse-face-tag-action)
Per Abrahamsen's avatar
Per Abrahamsen committed
1197

Per Abrahamsen's avatar
Per Abrahamsen committed
1198
(defun custom-browse-face-tag-action (widget &rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
1199 1200 1201
  (let ((parent (widget-get widget :parent)))
    (customize-face-other-window (widget-value parent))))

Per Abrahamsen's avatar
Per Abrahamsen committed
1202
(defconst custom-browse-alist '(("   " "space")
Per Abrahamsen's avatar
Per Abrahamsen committed
1203 1204 1205 1206 1207
			      (" | " "vertical")
			      ("-\\ " "top")
			      (" |-" "middle")
			      (" `-" "bottom")))

Per Abrahamsen's avatar
Per Abrahamsen committed
1208
(defun custom-browse-insert-prefix (prefix)
Per Abrahamsen's avatar
Per Abrahamsen committed
1209 1210 1211 1212 1213 1214 1215 1216
  "Insert PREFIX.  On XEmacs convert it to line graphics."
  (if nil ; (string-match "XEmacs" emacs-version)
      (progn 
	(insert "*")
	(while (not (string-equal prefix ""))
	  (let ((entry (substring prefix 0 3)))
	    (setq prefix (substring prefix 3))
	    (let ((overlay (make-overlay (1- (point)) (point) nil t nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
1217
		  (name (nth 1 (assoc entry custom-browse-alist))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1218 1219 1220 1221 1222
	      (overlay-put overlay 'end-glyph (widget-glyph-find name entry))
	      (overlay-put overlay 'start-open t)
	      (overlay-put overlay 'end-open t)))))
    (insert prefix)))

Per Abrahamsen's avatar
Per Abrahamsen committed
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
;;; 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
1251 1252 1253 1254 1255
(defgroup custom-magic-faces nil
  "Faces used by the magic button."
  :group 'custom-faces
  :group 'custom-buffer)

Per Abrahamsen's avatar
Per Abrahamsen committed
1256 1257 1258 1259
(defface custom-invalid-face '((((class color))
				(:foreground "yellow" :background "red"))
			       (t
				(:bold t :italic t :underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1260 1261
  "Face used when the customize item is invalid."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1262 1263 1264 1265 1266

(defface custom-rogue-face '((((class color))
			      (:foreground "pink" :background "black"))
			     (t
			      (:underline t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1267 1268
  "Face used when the customize item is not defined for customization."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1269 1270 1271 1272 1273

(defface custom-modified-face '((((class color)) 
				 (:foreground "white" :background "blue"))
				(t
				 (:italic t :bold)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1274 1275
  "Face used when the customize item has been modified."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1276 1277 1278 1279 1280

(defface custom-set-face '((((class color)) 
				(:foreground "blue" :background "white"))
			       (t
				(:italic t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1281 1282
  "Face used when the customize item has been set."
  :group 'custom-magic-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
1283 1284 1285 1286 1287

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
1295
(defconst custom-magic-alist '((nil "#" underline "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1296
uninitialized, you should not see this.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1297
			       (unknown "?" italic "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1298
unknown, you should not see this.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1299
			       (hidden "-" default "\
1300 1301
hidden, invoke \"Show\" in the previous line to show." "\
group now hidden, invoke \"Show\", above, to show contents.")
Per Abrahamsen's avatar
Per Abrahamsen committed
1302
			       (invalid "x" custom-invalid-face "\