cus-edit.el 108 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.9954
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
;;; 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)

109 110 111 112
(defgroup convenience nil
  "Convenience features for faster editing."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
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 205 206 207 208
(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
209 210 211 212
(defgroup x nil
  "The X Window system."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
213 214 215 216 217 218 219 220
(defgroup frames nil
  "Support for Emacs frames and window systems."
  :group 'environment)

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

221 222 223 224
(defgroup files nil
  "Support editing files."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
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 251 252 253 254
(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
255 256 257 258 259
  :group 'help)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
262 263 264 265 266
(defgroup custom-browse nil
  "Control customize browser."
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
267
(defgroup custom-buffer nil
Per Abrahamsen's avatar
Per Abrahamsen committed
268
  "Control customize buffers."
Per Abrahamsen's avatar
Per Abrahamsen committed
269 270 271 272
  :prefix "custom-"
  :group 'customize)

(defgroup custom-menu nil
Per Abrahamsen's avatar
Per Abrahamsen committed
273
  "Control customize menus."
Per Abrahamsen's avatar
Per Abrahamsen committed
274 275 276
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
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 340 341 342 343
(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."
344
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
345 346 347 348 349

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

Per Abrahamsen's avatar
Per Abrahamsen committed
350 351
(defgroup mule nil
  "MULE Emacs internationalization."
352
  :group 'i18n)
Per Abrahamsen's avatar
Per Abrahamsen committed
353

Per Abrahamsen's avatar
Per Abrahamsen committed
354 355
(defgroup windows nil
  "Windows within a frame."
Per Abrahamsen's avatar
Per Abrahamsen committed
356
  :group 'environment)
Per Abrahamsen's avatar
Per Abrahamsen committed
357

Per Abrahamsen's avatar
Per Abrahamsen committed
358 359
;;; Utilities.

Per Abrahamsen's avatar
Per Abrahamsen committed
360 361 362 363 364 365 366 367 368 369 370 371
(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
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 397 398 399 400
(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
401 402 403 404 405 406 407 408
(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 
409
		(if (symbolp v)
410
		    (format "Customize option: (default %s) " v)
Per Abrahamsen's avatar
Per Abrahamsen committed
411
		  "Customize variable: ")
Per Abrahamsen's avatar
Per Abrahamsen committed
412 413 414
		obarray (lambda (symbol)
			  (and (boundp symbol)
			       (or (get symbol 'custom-type)
415
				   (user-variable-p symbol)))) t))
Per Abrahamsen's avatar
Per Abrahamsen committed
416
     (list (if (equal val "")
417 418
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
419

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

Per Abrahamsen's avatar
Per Abrahamsen committed
439 440 441 442 443
(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
444
  :group 'custom-menu
Per Abrahamsen's avatar
Per Abrahamsen committed
445 446
  :type 'boolean)

447 448 449 450 451
(defcustom custom-unlispify-remove-prefixes nil
  "Non-nil means remove group prefixes from option names in buffer."
  :group 'custom-menu
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
452 453 454 455 456 457 458 459 460 461 462 463 464 465
(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
466 467 468 469
	   (when (and (eq (get symbol 'custom-type) 'boolean)
		      (re-search-forward "-p\\'" nil t))
	     (replace-match "" t t)
	     (goto-char (point-min)))
470 471 472 473 474 475 476 477 478 479
	   (if custom-unlispify-remove-prefixes
	       (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))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
480 481 482 483 484 485 486 487 488
	   (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
489
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
490 491 492 493 494 495 496 497 498 499 500 501 502
  :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
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
;;; 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
524 525
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
526 527 528
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
529

Per Abrahamsen's avatar
Per Abrahamsen committed
530 531 532 533
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
534

Per Abrahamsen's avatar
Per Abrahamsen committed
535 536 537 538
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
539

Per Abrahamsen's avatar
Per Abrahamsen committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
(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
564

Per Abrahamsen's avatar
Per Abrahamsen committed
565 566
;;; Sorting.

Per Abrahamsen's avatar
Per Abrahamsen committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580
(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
581 582 583 584 585
(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
586
(defcustom custom-buffer-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
587
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
588
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
589
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
590

Per Abrahamsen's avatar
Per Abrahamsen committed
591 592 593 594 595 596 597
(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
598
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
599

Per Abrahamsen's avatar
Per Abrahamsen committed
600
(defcustom custom-menu-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
601
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
602
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
603
  :group 'custom-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
604

Per Abrahamsen's avatar
Per Abrahamsen committed
605 606 607 608 609 610 611
(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
612 613
  :group 'custom-menu)

614 615
;;;###autoload (add-hook 'same-window-regexps "\\`\\*Customiz.*\\*\\'")

Per Abrahamsen's avatar
Per Abrahamsen committed
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
(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
642

Per Abrahamsen's avatar
Per Abrahamsen committed
643 644
;;; Custom Mode Commands.

Per Abrahamsen's avatar
Per Abrahamsen committed
645 646 647
(defvar custom-options nil
  "Customization widgets in the current buffer.")

648
(defun Custom-set ()
Per Abrahamsen's avatar
Per Abrahamsen committed
649 650 651 652 653 654 655 656
  "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)))

657
(defun Custom-save ()
Per Abrahamsen's avatar
Per Abrahamsen committed
658 659 660 661 662 663 664 665 666 667
  "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 
668 669 670
  '(("Current" . Custom-reset-current)
    ("Saved" . Custom-reset-saved)
    ("Standard Settings" . Custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684
  "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))))

685
(defun Custom-reset-current (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
686 687 688 689 690 691 692 693
  "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)))

694
(defun Custom-reset-saved (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
695 696 697 698 699
  "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
700
		(widget-apply child :custom-reset-saved)))
Per Abrahamsen's avatar
Per Abrahamsen committed
701 702
	    children)))

703
(defun Custom-reset-standard (&rest ignore)
704
  "Reset all modified, set, or saved group members to their standard settings."
Per Abrahamsen's avatar
Per Abrahamsen committed
705 706 707 708
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
	      (when (eq (widget-get child :custom-state) 'modified)
Per Abrahamsen's avatar
Per Abrahamsen committed
709
		(widget-apply child :custom-reset-standard)))
Per Abrahamsen's avatar
Per Abrahamsen committed
710 711 712 713
	    children)))

;;; The Customize Commands

Per Abrahamsen's avatar
Per Abrahamsen committed
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
(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
749
(defun customize-set-value (var val)
Per Abrahamsen's avatar
Per Abrahamsen committed
750 751 752 753 754 755 756 757 758 759 760 761 762
  "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
763
(defun customize-set-variable (var val)
Per Abrahamsen's avatar
Per Abrahamsen committed
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
  "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
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
;;;###autoload
(defun customize-save-variable (var val)
  "Set the default for VARIABLE to VALUE, and save it for future sessions.
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 and ave variable: "
				       "Set and save value for %s as: "))
  (funcall (or (get var 'custom-set) 'set-default) var val)
  (put var 'saved-value (list (custom-quote val)))
  (custom-save-all))

Per Abrahamsen's avatar
Per Abrahamsen committed
802
;;;###autoload
803 804 805 806 807 808
(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
809
  (customize-group 'emacs))
810 811 812 813

;;;###autoload
(defun customize-group (group)
  "Customize GROUP, which must be a customization group."
814 815 816 817
  (interactive (list (let ((completion-ignore-case t))
		       (completing-read "Customize group: (default emacs) "
					obarray 
					(lambda (symbol)
818 819
					  (or (get symbol 'custom-loads)
					      (get symbol 'custom-group)))
820
					t))))
821 822 823 824
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
825 826
  (or (get group 'custom-group)
      (custom-load-symbol group))
827 828 829
  (let ((name (format "*Customize Group: %s*"
		      (custom-unlispify-tag-name group))))
    (if (get-buffer name)
830
	(pop-to-buffer name)
831
      (custom-buffer-create (list (list group 'custom-group))
832 833 834
			    name
			    (concat " for group "
				    (custom-unlispify-tag-name group))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
835

Per Abrahamsen's avatar
Per Abrahamsen committed
836
;;;###autoload
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
(defun customize-group-other-window (group)
  "Customize GROUP, which must be a customization group."
  (interactive (list (let ((completion-ignore-case t))
		       (completing-read "Customize group: (default emacs) "
					obarray 
					(lambda (symbol)
					  (or (get symbol 'custom-loads)
					      (get symbol 'custom-group)))
					t))))
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
  (or (get group 'custom-group)
      (custom-load-symbol group))
  (let ((name (format "*Customize Group: %s*"
		      (custom-unlispify-tag-name group))))
    (if (get-buffer name)
	(let ((window (selected-window)))
856
	  (pop-to-buffer name)
857 858 859 860 861 862
	  (select-window window))
      (custom-buffer-create-other-window
       (list (list group 'custom-group))
       name
       (concat " for group "
	       (custom-unlispify-tag-name group))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
863

Per Abrahamsen's avatar
Per Abrahamsen committed
864 865
;;;###autoload
(defalias 'customize-variable 'customize-option)
866

Per Abrahamsen's avatar
Per Abrahamsen committed
867
;;;###autoload
868 869
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
870
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
871
  (custom-buffer-create (list (list symbol 'custom-variable))
872
			(format "*Customize Option: %s*"
Per Abrahamsen's avatar
Per Abrahamsen committed
873
				(custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
874

Per Abrahamsen's avatar
Per Abrahamsen committed
875
;;;###autoload
876 877
(defun customize-changed-options (since-version)
  "Customize all user option variables whose default values changed recently.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
878 879
This means, in other words, variables and groups defined with a `:version' 
option."
880 881 882
  (interactive "sCustomize options changed, since version (default all versions): ")
  (if (equal since-version "")
      (setq since-version nil))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
883 884
  (let ((found nil)
	(versions nil))
885
    (mapatoms (lambda (symbol)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
886
		(and (or (boundp symbol)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
887 888
			 ;; For variables not yet loaded.
			 (get symbol 'standard-value)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
889 890 891 892
			 ;; For groups the previous test fails, this one
			 ;; could be used to determine if symbol is a
			 ;; group. Is there a better way for this?
			 (get symbol 'group-documentation))
893 894 895
		     (let ((version (get symbol 'custom-version)))
		       (and version
			    (or (null since-version)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
896 897 898 899 900
				(customize-version-lessp since-version version))
			    (if (member version versions) 
				t
			      ;;; Collect all versions that we use.
			      (push version versions))))
901
		     (setq found
Dan Nicolaescu's avatar
Dan Nicolaescu committed
902 903 904 905 906 907
			   ;; We have to set the right thing here,
			   ;; depending if we have a group or a
			   ;; variable. 
			   (if (get  symbol 'group-documentation)
			       (cons (list symbol 'custom-group) found)
			     (cons (list symbol 'custom-variable) found))))))
908 909
    (if (not found)
	(error "No user options have changed defaults in recent Emacs versions")
910 911 912 913 914 915 916 917 918
      (let ((flist nil))
	(while versions
	  (push (copy-sequence 
		 (cdr (assoc (car versions)  custom-versions-load-alist)))
		flist)
	  (setq versions (cdr versions)))
	(put 'custom-versions-load-alist 'custom-loads 
	     ;; Get all the files that correspond to element from the
	     ;; VERSIONS list. This could use some simplification.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
919 920 921 922 923 924 925 926
	     (apply 'nconc flist)))
      ;; Because we set all the files needed to be loaded as a
      ;; `custom-loads' property to `custom-versions-load-alist' this
      ;; call will actually load them.
      (custom-load-symbol 'custom-versions-load-alist)
      ;; Clean up
      (put 'custom-versions-load-alist 'custom-loads nil)
      (custom-buffer-create (custom-sort-items found t 'first)
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
			    "*Customize Changed Options*"))))

(defun customize-version-lessp (version1 version2)
  (let (major1 major2 minor1 minor2)
    (string-match "\\([0-9]+\\)[.]\\([0-9]+\\)" version1)
    (setq major1 (read (match-string 1 version1)))
    (setq minor1 (read (match-string 2 version1)))
    (string-match "\\([0-9]+\\)[.]\\([0-9]+\\)" version2)
    (setq major2 (read (match-string 1 version2)))
    (setq minor2 (read (match-string 2 version2)))
    (or (< major1 major2)
	(and (= major1 major2)
	     (< minor1 minor2)))))
  
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
942 943
(defalias 'customize-variable-other-window 'customize-option-other-window)

Per Abrahamsen's avatar
Per Abrahamsen committed
944
;;;###autoload
945 946
(defun customize-option-other-window (symbol)
  "Customize SYMBOL, which must be a user option variable.
Per Abrahamsen's avatar
Per Abrahamsen committed
947 948
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
949 950
  (custom-buffer-create-other-window
   (list (list symbol 'custom-variable))
951
   (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
952

Per Abrahamsen's avatar
Per Abrahamsen committed
953 954 955 956 957 958 959
;;;###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
960 961 962 963 964 965 966 967
      (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
968 969
    (unless (symbolp symbol)
      (error "Should be a symbol %S" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
970 971 972
    (custom-buffer-create (list (list symbol 'custom-face))
			  (format "*Customize Face: %s*"
				  (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
973

Per Abrahamsen's avatar
Per Abrahamsen committed
974 975 976 977 978 979 980 981 982 983 984
;;;###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
985 986 987
    (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
988

Per Abrahamsen's avatar
Per Abrahamsen committed
989 990
;;;###autoload
(defun customize-customized ()
Per Abrahamsen's avatar
Per Abrahamsen committed
991 992 993 994 995 996
  "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
997
		     (push (list symbol 'custom-face) found))
Per Abrahamsen's avatar
Per Abrahamsen committed
998 999
		(and (get symbol 'customized-value)
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1000
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1001 1002 1003 1004
    (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
1005 1006 1007 1008

;;;###autoload
(defun customize-saved ()
  "Customize all already saved user options."
Per Abrahamsen's avatar
Per Abrahamsen committed
1009 1010 1011 1012 1013
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(and (get symbol 'saved-face)
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1014
		     (push (list symbol 'custom-face) found))
Per Abrahamsen's avatar
Per Abrahamsen committed
1015 1016
		(and (get symbol 'saved-value)
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1017
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1018 1019 1020 1021
    (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
1022 1023 1024 1025

;;;###autoload
(defun customize-apropos (regexp &optional all)
  "Customize all user options matching REGEXP.
Per Abrahamsen's avatar
Per Abrahamsen committed
1026 1027 1028 1029 1030
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
1031 1032 1033 1034
  (interactive "sCustomize regexp: \nP")
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(when (string-match regexp (symbol-name symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
1035 1036 1037 1038 1039 1040 1041 1042
		  (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
1043
			     (or (get symbol 'saved-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1044
				 (get symbol 'standard-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1045 1046 1047 1048 1049 1050
				 (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
1051 1052 1053
      (custom-buffer-create (custom-sort-items found t
					       custom-buffer-order-groups)
			    "*Customize Apropos*"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072

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

Per Abrahamsen's avatar
Per Abrahamsen committed
1074 1075
;;; Buffer.

Per Abrahamsen's avatar
Per Abrahamsen committed
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
(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
1091
;;;###autoload
1092
(defun custom-buffer-create (options &optional name description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1093
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
1094
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
1095 1096 1097
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
1098 1099
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
1100
  (pop-to-buffer (get-buffer-create name))
1101
  (custom-buffer-create-internal options description))
Per Abrahamsen's avatar
Per Abrahamsen committed
1102

Per Abrahamsen's avatar
Per Abrahamsen committed
1103
;;;###autoload
1104
(defun custom-buffer-create-other-window (options &optional name description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1105
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
1106
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
1107 1108 1109
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
1110 1111
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
1112 1113 1114 1115 1116 1117 1118
  (let ((window (selected-window))
	(pop-up-windows t)
	(special-display-buffer-names nil)
	(special-display-regexps nil)
	(same-window-buffer-names nil)
	(same-window-regexps nil))
    (pop-to-buffer (get-buffer-create name))
1119
    (custom-buffer-create-internal options description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1120
    (select-window window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1121 1122 1123 1124 1125

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

1128
(defun custom-buffer-create-internal (options &optional description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1129
  (message "Creating customization buffer...")
Per Abrahamsen's avatar
Per Abrahamsen committed
1130
  (custom-mode)
1131 1132 1133 1134
  (widget-insert "This is a customization buffer")
  (if description
      (widget-insert description))
  (widget-insert ".
1135
Square brackets show active fields; type RET or click mouse-1
1136 1137 1138 1139
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
1140
  (widget-create 'info-link 
1141
		 :tag "Help"
Per Abrahamsen's avatar
Per Abrahamsen committed
1142
		 :help-echo "Read the online help."
1143
		 "(emacs)Easy Customization")
Per Abrahamsen's avatar
Per Abrahamsen committed
1144
  (widget-insert " for more information.\n\n")
Per Abrahamsen's avatar
Per Abrahamsen committed
1145
  (message "Creating customization buttons...")
1146
  (widget-insert "Operate on everything in this buffer:\n ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1147
  (widget-create 'push-button
1148
		 :tag "Set for Current Session"
1149 1150
		 :help-echo "\
Make your editing in this buffer take effect for this session."
Per Abrahamsen's avatar
Per Abrahamsen committed
1151
		 :action (lambda (widget &optional event)
1152
			   (Custom-set)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1153 1154
  (widget-insert " ")
  (widget-create 'push-button
1155
		 :tag "Save for Future Sessions"
Per Abrahamsen's avatar
Per Abrahamsen committed
1156
		 :help-echo "\
1157
Make your editing in this buffer take effect for future Emacs sessions."
Per Abrahamsen's avatar
Per Abrahamsen committed
1158
		 :action (lambda (widget &optional event)
1159
			   (Custom-save)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1160
  (if custom-reset-button-menu
1161 1162 1163 1164 1165 1166 1167 1168 1169
      (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
1170 1171
    (widget-create 'push-button
		   :tag "Reset"
Per Abrahamsen's avatar
Per Abrahamsen committed
1172
		   :help-echo "\
1173
Reset all edited text in this buffer to reflect current values."
1174
		   :action 'Custom-reset-current)
Per Abrahamsen's avatar
Per Abrahamsen committed
1175 1176 1177
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Saved"
Per Abrahamsen's avatar
Per Abrahamsen committed
1178
		   :help-echo "\
1179
Reset all values in this buffer to their saved settings."
1180
		   :action 'Custom-reset-saved)
Per Abrahamsen's avatar
Per Abrahamsen committed
1181 1182 1183
    (widget-insert " ")
    (widget-create 'push-button
		   :tag "Reset to Standard"
Per Abrahamsen's avatar
Per Abrahamsen committed
1184
		   :help-echo "\
1185
Reset all values in this buffer to their standard settings."
1186
		   :action 'Custom-reset-standard))
1187
  (widget-insert "   ")
Per Abrahamsen's avatar
Per Abrahamsen committed
1188
  (widget-create 'push-button
1189
		 :tag "Bury Buffer"
Per Abrahamsen's avatar
Per Abrahamsen committed
1190 1191 1192 1193 1194
		 :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
1195 1196 1197 1198
  (setq custom-options 
	(if (= (length options) 1)
	    (mapcar (lambda (entry)
		      (widget-create (nth 1 entry)
Per Abrahamsen's avatar
Per Abrahamsen committed
1199
				     :documentation-shown t
Per Abrahamsen's avatar
Per Abrahamsen committed
1200 1201 1202 1203 1204 1205 1206 1207 1208
				     :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
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1209
			    (message "Creating customization items ...%2d%%"
Per Abrahamsen's avatar
Per Abrahamsen committed
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
				     (/ (* 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"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1222
  (message "Creating customization items ...%2d%%done" 100)
Per Abrahamsen's avatar
Per Abrahamsen committed
1223 1224
  (unless (eq custom-buffer-style 'tree)
    (mapcar 'custom-magic-reset custom-options))
Per Abrahamsen's avatar
Per Abrahamsen committed
1225 1226 1227 1228 1229
  (message "Creating customization setup...")
  (widget-setup)
  (goto-char (point-min))
  (message "Creating customization buffer...done"))

Per Abrahamsen's avatar
Per Abrahamsen committed
1230 1231 1232
;;; The Tree Browser.

;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
1233
(defun customize-browse (&optional group)
Per Abrahamsen's avatar
Per Abrahamsen committed
1234
  "Create a tree browser for the customize hierarchy."
1235
  (interactive)
Per Abrahamsen's avatar
Per Abrahamsen committed
1236 1237 1238 1239
  (unless group
    (setq group 'emacs))
  (let ((name "*Customize Browser*"))
    (kill-buffer (get-buffer-create name))
1240
    (pop-to-buffer (get-buffer-create name)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1241 1242
  (custom-mode)
  (widget-insert "\
1243 1244
Square brackets show active fields; type RET or click mouse-1
on an active field to invoke its action.
1245
Invoke [+] below to expand a group, and [-] to collapse an expanded group.\n")
Per Abrahamsen's avatar
Per Abrahamsen committed
1246 1247
  (if custom-browse-only-groups
      (widget-insert "\
Per Abrahamsen's avatar
Per Abrahamsen committed
1248
Invoke the [Group] button below to edit that item in another window.\n\n")
Per Abrahamsen's avatar
Per Abrahamsen committed
1249