cus-edit.el 122 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
;; Copyright (C) 1996, 1997, 1999, 2000 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
4 5 6
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: help, faces
Dave Love's avatar
Dave Love committed
7
;; X-URL: http://www.dina.kvl.dk/~abraham/custom/ (probably obsolete)
Per Abrahamsen's avatar
Per Abrahamsen committed
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
;; 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
26 27
;;; Commentary:
;;
Per Abrahamsen's avatar
Per Abrahamsen committed
28 29
;; This file implements the code to create and edit customize buffers.
;; 
Per Abrahamsen's avatar
Per Abrahamsen committed
30 31
;; See `custom.el'.

32 33 34 35
;; 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
36 37 38 39 40
;;; Code:

(require 'cus-face)
(require 'wid-edit)
(require 'easymenu)
41 42 43
(eval-when-compile
  (require 'cl)
  (defvar custom-versions-load-alist))	; from cus-load
Per Abrahamsen's avatar
Per Abrahamsen committed
44 45 46 47

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
;;; 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)

103 104 105 106
(defgroup convenience nil
  "Convenience features for faster editing."
  :group 'emacs)

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

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

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

215 216 217 218
(defgroup files nil
  "Support editing files."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
(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)

Dave Love's avatar
Dave Love committed
239 240 241 242
(defgroup multimedia nil
  "Non-textual support, specifically images and sound."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
243 244 245 246 247 248
(defgroup local nil
  "Code local to your site."
  :group 'emacs)

(defgroup customize '((widgets custom-group))
  "Customization of the Customization support."
249
  :link '(custom-manual "(elisp)Customization")
Dave Love's avatar
Dave Love committed
250
  :link '(url-link :tag "(Old?) Development Page"
Per Abrahamsen's avatar
Per Abrahamsen committed
251 252
		   "http://www.dina.kvl.dk/~abraham/custom/")
  :prefix "custom-"
Per Abrahamsen's avatar
Per Abrahamsen committed
253 254 255 256 257
  :group 'help)

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

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

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

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

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

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
356 357 358 359 360 361 362 363 364 365 366
;;; Utilities.

(defun custom-quote (sexp)
  "Quote SEXP iff it is not self quoting."
  (if (or (memq sexp '(t nil))
	  (and (symbolp sexp)
	       (eq (aref (symbol-name sexp) 0) ?:))
	  (and (listp sexp)
	       (memq (car sexp) '(lambda)))
	  (stringp sexp)
	  (numberp sexp)
Dave Love's avatar
Dave Love committed
367 368 369 370
	  (vectorp sexp)
;;;  	  (and (fboundp 'characterp)
;;;  	       (characterp sexp))
	  )
Per Abrahamsen's avatar
Per Abrahamsen committed
371 372 373 374 375
      sexp
    (list 'quote sexp)))

(defun custom-split-regexp-maybe (regexp)
  "If REGEXP is a string, split it to a list at `\\|'.
Dave Love's avatar
Dave Love committed
376
You can get the original back with from the result with:
Per Abrahamsen's avatar
Per Abrahamsen committed
377 378 379 380 381 382 383 384 385 386 387 388
  (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
389 390 391 392 393 394 395
(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)
Dave Love's avatar
Dave Love committed
396
     (setq val (completing-read
397
		(if (symbolp v)
398
		    (format "Customize option: (default %s) " v)
Per Abrahamsen's avatar
Per Abrahamsen committed
399
		  "Customize variable: ")
Per Abrahamsen's avatar
Per Abrahamsen committed
400 401 402
		obarray (lambda (symbol)
			  (and (boundp symbol)
			       (or (get symbol 'custom-type)
403
				   (get symbol 'custom-loads)
404
				   (user-variable-p symbol)))) t))
Per Abrahamsen's avatar
Per Abrahamsen committed
405
     (list (if (equal val "")
406 407
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
408

Per Abrahamsen's avatar
Per Abrahamsen committed
409 410 411 412 413 414
(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)
Dave Love's avatar
Dave Love committed
415
    (while menu
Per Abrahamsen's avatar
Per Abrahamsen committed
416 417 418 419 420 421 422 423 424 425
      (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
426 427
;;; Unlispify.

Per Abrahamsen's avatar
Per Abrahamsen committed
428 429 430 431 432
(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
433
  :group 'custom-menu
Per Abrahamsen's avatar
Per Abrahamsen committed
434 435
  :type 'boolean)

436 437 438 439 440
(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
441 442 443 444 445 446 447 448 449 450 451 452 453 454
(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
455 456 457 458
	   (when (and (eq (get symbol 'custom-type) 'boolean)
		      (re-search-forward "-p\\'" nil t))
	     (replace-match "" t t)
	     (goto-char (point-min)))
459 460 461 462 463 464
	   (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)
Dave Love's avatar
Dave Love committed
465
		       (progn
466 467 468
			 (setq prefixes nil)
			 (delete-region (point-min) (point)))
		     (setq prefixes (cdr prefixes))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
469 470
	   (subst-char-in-region (point-min) (point-max) ?- ?\  t)
	   (capitalize-region (point-min) (point-max))
Dave Love's avatar
Dave Love committed
471
	   (unless no-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
472 473 474 475 476 477
	     (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
478
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
479 480 481 482 483 484 485 486 487 488 489 490 491
  :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
492 493 494 495 496 497 498 499 500 501 502 503 504
;;; 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).

Dave Love's avatar
Dave Love committed
505
MATCH should be a regexp matching the name of a symbol, and TYPE should
Per Abrahamsen's avatar
Per Abrahamsen committed
506 507
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
Dave Love's avatar
Dave Love committed
508
used.
Per Abrahamsen's avatar
Per Abrahamsen committed
509 510 511 512

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
513 514
  :group 'customize)

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
529 530
(defun custom-guess-type (symbol)
  "Guess a widget suitable for editing the value of SYMBOL.
Dave Love's avatar
Dave Love committed
531
This is done by matching SYMBOL with `custom-guess-name-alist' and
Per Abrahamsen's avatar
Per Abrahamsen committed
532 533 534 535 536 537 538 539 540 541 542 543 544
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))
Dave Love's avatar
Dave Love committed
545
	(when doc
Per Abrahamsen's avatar
Per Abrahamsen committed
546 547 548 549 550 551 552
	  (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
553

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

Per Abrahamsen's avatar
Per Abrahamsen committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569
(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
570 571 572 573 574
(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
575
(defcustom custom-buffer-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
576
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
577
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
578
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
579

Per Abrahamsen's avatar
Per Abrahamsen committed
580 581 582 583 584 585 586
(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
587
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
588

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

Per Abrahamsen's avatar
Per Abrahamsen committed
594 595 596 597 598 599 600
(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
601 602
  :group 'custom-menu)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
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 630
(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
631

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

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

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

646
(defun Custom-save ()
Per Abrahamsen's avatar
Per Abrahamsen committed
647 648 649 650
  "Set all modified group members and save them."
  (interactive)
  (let ((children custom-options))
    (mapcar (lambda (child)
651 652
	      (when (memq (widget-get child :custom-state)
			  '(modified set changed rogue))
Per Abrahamsen's avatar
Per Abrahamsen committed
653 654 655 656
		(widget-apply child :custom-save)))
	    children))
  (custom-save-all))

Dave Love's avatar
Dave Love committed
657
(defvar custom-reset-menu
658 659
  '(("Current" . Custom-reset-current)
    ("Saved" . Custom-reset-saved)
660
    ("Erase Customization (use standard settings)" . Custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674
  "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))))

675
(defun Custom-reset-current (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
676 677 678
  "Reset all modified group members to their current value."
  (interactive)
  (let ((children custom-options))
679 680
    (mapcar (lambda (widget)
	      (and (default-boundp (widget-value widget))
Dave Love's avatar
Dave Love committed
681
		   (if (memq (widget-get widget :custom-state)
682 683
			     '(modified changed))
		       (widget-apply widget :custom-reset-current))))
Per Abrahamsen's avatar
Per Abrahamsen committed
684 685
	    children)))

686
(defun Custom-reset-saved (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
687 688 689
  "Reset all modified or set group members to their saved value."
  (interactive)
  (let ((children custom-options))
690 691 692 693 694
    (mapcar (lambda (widget)
	      (and (get (widget-value widget) 'saved-value)
		   (if (memq (widget-get widget :custom-state)
			     '(modified set changed rogue))
		       (widget-apply widget :custom-reset-saved))))
Per Abrahamsen's avatar
Per Abrahamsen committed
695 696
	    children)))

697
(defun Custom-reset-standard (&rest ignore)
698 699 700 701
  "Erase all customization (either current or saved) for the group members.
The immediate result is to restore them to their standard settings.
This operation eliminates any saved settings for the group members,
making them as if they had never been customized at all."
Per Abrahamsen's avatar
Per Abrahamsen committed
702 703
  (interactive)
  (let ((children custom-options))
704 705 706 707 708
    (mapcar (lambda (widget)
	      (and (get (widget-value widget) 'standard-value)
		   (if (memq (widget-get widget :custom-state)
			     '(modified set changed saved rogue))
		       (widget-apply widget :custom-reset-standard))))
Per Abrahamsen's avatar
Per Abrahamsen committed
709 710 711 712
	    children)))

;;; The Customize Commands

Dave Love's avatar
Dave Love committed
713
(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
714 715 716 717 718 719 720 721 722
  "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
Dave Love's avatar
Dave Love committed
723 724 725 726
`:prompt-value' property of that widget will be used for reading the value.

If optional COMMENT argument is non nil, also prompt for a comment and return
it as the third element in the list."
Per Abrahamsen's avatar
Per Abrahamsen committed
727
  (let* ((var (read-variable prompt-var))
Dave Love's avatar
Dave Love committed
728 729
	 (minibuffer-help-form '(describe-variable var))
	 (val
Per Abrahamsen's avatar
Per Abrahamsen committed
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
	  (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
Dave Love's avatar
Dave Love committed
748 749 750 751 752
		   (eval-minibuffer prompt))))))
    (if comment
 	(list var val
 	      (read-string "Comment: " (get var 'variable-comment)))
      (list var val))))
Per Abrahamsen's avatar
Per Abrahamsen committed
753 754

;;;###autoload
Dave Love's avatar
Dave Love committed
755
(defun customize-set-value (var val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
756 757 758 759 760 761
  "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
Dave Love's avatar
Dave Love committed
762 763 764
`:prompt-value' property of that widget will be used for reading the value.

If given a prefix (or a COMMENT argument), also prompt for a comment."
Per Abrahamsen's avatar
Per Abrahamsen committed
765
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
766 767
				       "Set %s to value: "
				       current-prefix-arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
768
   
Dave Love's avatar
Dave Love committed
769 770 771 772 773
  (set var val)
  (cond ((string= comment "")
 	 (put var 'variable-comment nil))
 	(comment
 	 (put var 'variable-comment comment))))
Per Abrahamsen's avatar
Per Abrahamsen committed
774 775

;;;###autoload
Dave Love's avatar
Dave Love committed
776
(defun customize-set-variable (var val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
777 778 779 780 781 782 783 784 785 786 787 788
  "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
Dave Love's avatar
Dave Love committed
789 790 791
`:prompt-value' property of that widget will be used for reading the value.

If given a prefix (or a COMMENT argument), also prompt for a comment."
Per Abrahamsen's avatar
Per Abrahamsen committed
792
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
793 794
				       "Set customized value for %s to: "
				       current-prefix-arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
795
  (funcall (or (get var 'custom-set) 'set-default) var val)
Dave Love's avatar
Dave Love committed
796 797 798 799 800 801 802
  (put var 'customized-value (list (custom-quote val)))
  (cond ((string= comment "")
 	 (put var 'variable-comment nil)
 	 (put var 'customized-variable-comment nil))
 	(comment
 	 (put var 'variable-comment comment)
 	 (put var 'customized-variable-comment comment))))
Per Abrahamsen's avatar
Per Abrahamsen committed
803

Per Abrahamsen's avatar
Per Abrahamsen committed
804
;;;###autoload
Dave Love's avatar
Dave Love committed
805
(defun customize-save-variable (var val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
806 807 808 809 810 811 812 813 814 815 816
  "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
Dave Love's avatar
Dave Love committed
817 818 819
`:prompt-value' property of that widget will be used for reading the value.

If given a prefix (or a COMMENT argument), also prompt for a comment."
Per Abrahamsen's avatar
Per Abrahamsen committed
820
  (interactive (custom-prompt-variable "Set and ave variable: "
Dave Love's avatar
Dave Love committed
821 822
				       "Set and save value for %s as: "
				       current-prefix-arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
823 824
  (funcall (or (get var 'custom-set) 'set-default) var val)
  (put var 'saved-value (list (custom-quote val)))
Dave Love's avatar
Dave Love committed
825 826 827 828 829 830
  (cond ((string= comment "")
 	 (put var 'variable-comment nil)
 	 (put var 'saved-variable-comment nil))
 	(comment
 	 (put var 'variable-comment comment)
 	 (put var 'saved-variable-comment comment)))
Per Abrahamsen's avatar
Per Abrahamsen committed
831 832
  (custom-save-all))

Per Abrahamsen's avatar
Per Abrahamsen committed
833
;;;###autoload
834 835 836 837 838 839
(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
840
  (customize-group 'emacs))
841 842 843 844

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

Per Abrahamsen's avatar
Per Abrahamsen committed
867
;;;###autoload
868 869 870 871
(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) "
Dave Love's avatar
Dave Love committed
872
					obarray
873 874 875 876 877 878 879 880 881 882 883 884 885 886
					(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)))
887
	  (pop-to-buffer name)
888 889 890 891 892 893
	  (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
894

Per Abrahamsen's avatar
Per Abrahamsen committed
895 896
;;;###autoload
(defalias 'customize-variable 'customize-option)
897

Per Abrahamsen's avatar
Per Abrahamsen committed
898
;;;###autoload
899 900
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
901
  (interactive (custom-variable-prompt))
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
  ;; If we don't have SYMBOL's real definition loaded,
  ;; try to load it.
  (unless (get symbol 'custom-type)
    (let ((loaddefs-file (locate-library "loaddefs.el" t))
	  file)
      ;; See if it is autoloaded from some library.
      (when loaddefs-file
	(with-temp-buffer
	  (insert-file-contents loaddefs-file)
	  (when (re-search-forward (concat "^(defvar " (symbol-name symbol))
				   nil t)
	    (search-backward "\n;;; Generated autoloads from ")
	    (goto-char (match-end 0))
	    (setq file (buffer-substring (point)
					 (progn (end-of-line) (point)))))))
      ;; If it is, load that library.
      (when file
	(when (string-match "\\.el\\'" file)
	  (setq file (substring file 0 (match-beginning 0))))
	(load file))))
  (unless (get symbol 'custom-type)
    (error "Variable %s cannot be customized" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
924
  (custom-buffer-create (list (list symbol 'custom-variable))
925
			(format "*Customize Option: %s*"
Per Abrahamsen's avatar
Per Abrahamsen committed
926
				(custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
927

928 929 930
(defvar customize-changed-options-previous-release "20.2"
  "Version for `customize-changed-options' to refer back to by default.")

Per Abrahamsen's avatar
Per Abrahamsen committed
931
;;;###autoload
932
(defun customize-changed-options (since-version)
933 934 935 936 937 938 939 940 941
  "Customize all user option variables changed in Emacs itself.
This includes new user option variables and faces, and new
customization groups, as well as older options and faces whose default
values have changed since the previous major Emacs release.

With argument SINCE-VERSION (a string), customize all user option
variables that were added (or their meanings were changed) since that
version."

942 943 944
  (interactive "sCustomize options changed, since version (default all versions): ")
  (if (equal since-version "")
      (setq since-version nil))
945 946
  (unless since-version
    (setq since-version customize-changed-options-previous-release))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
947 948
  (let ((found nil)
	(versions nil))
949
    (mapatoms (lambda (symbol)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
950
		(and (or (boundp symbol)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
951 952
			 ;; For variables not yet loaded.
			 (get symbol 'standard-value)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
953 954 955 956
			 ;; 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))
957 958 959
		     (let ((version (get symbol 'custom-version)))
		       (and version
			    (or (null since-version)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
960
				(customize-version-lessp since-version version))
Dave Love's avatar
Dave Love committed
961
			    (if (member version versions)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
962 963 964
				t
			      ;;; Collect all versions that we use.
			      (push version versions))))
965
		     (setq found
Dan Nicolaescu's avatar
Dan Nicolaescu committed
966 967
			   ;; We have to set the right thing here,
			   ;; depending if we have a group or a
Dave Love's avatar
Dave Love committed
968
			   ;; variable.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
969 970 971
			   (if (get  symbol 'group-documentation)
			       (cons (list symbol 'custom-group) found)
			     (cons (list symbol 'custom-variable) found))))))
972
    (if (not found)
973 974
	(error "No user option defaults have been changed since Emacs %s"
	       since-version)
975 976
      (let ((flist nil))
	(while versions
Dave Love's avatar
Dave Love committed
977
	  (push (copy-sequence
978 979 980
		 (cdr (assoc (car versions)  custom-versions-load-alist)))
		flist)
	  (setq versions (cdr versions)))
Dave Love's avatar
Dave Love committed
981
	(put 'custom-versions-load-alist 'custom-loads
982 983
	     ;; Get all the files that correspond to element from the
	     ;; VERSIONS list. This could use some simplification.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
984 985 986 987 988 989 990 991
	     (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)
992 993 994
			    "*Customize Changed Options*"))))

(defun customize-version-lessp (version1 version2)
995 996 997 998
  ;; In case someone made a mistake and left out the quotes
  ;; in the :version value.
  (if (numberp version2)
      (setq version2 (prin1-to-string version2)))
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
  (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
1011 1012
(defalias 'customize-variable-other-window 'customize-option-other-window)

Per Abrahamsen's avatar
Per Abrahamsen committed
1013
;;;###autoload
1014 1015
(defun customize-option-other-window (symbol)
  "Customize SYMBOL, which must be a user option variable.
Per Abrahamsen's avatar
Per Abrahamsen committed
1016 1017
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
1018 1019
  (custom-buffer-create-other-window
   (list (list symbol 'custom-variable))
1020
   (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1021

Per Abrahamsen's avatar
Per Abrahamsen committed
1022 1023 1024 1025
;;;###autoload
(defun customize-face (&optional symbol)
  "Customize SYMBOL, which should be a face name or nil.
If SYMBOL is nil, customize all faces."
Dave Love's avatar
Dave Love committed
1026
  (interactive (list (completing-read "Customize face: (default all) "
1027
				      obarray 'custom-facep t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1028
  (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1029 1030 1031 1032 1033 1034 1035 1036
      (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
1037 1038
    (unless (symbolp symbol)
      (error "Should be a symbol %S" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
1039 1040 1041
    (custom-buffer-create (list (list symbol 'custom-face))
			  (format "*Customize Face: %s*"
				  (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1042

Per Abrahamsen's avatar
Per Abrahamsen committed
1043 1044 1045
;;;###autoload
(defun customize-face-other-window (&optional symbol)
  "Show customization buffer for FACE in other window."
Dave Love's avatar
Dave Love committed
1046
  (interactive (list (completing-read "Customize face: "
1047
				      obarray 'custom-facep t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1048 1049 1050 1051 1052 1053
  (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))
Dave Love's avatar
Dave Love committed
1054
    (custom-buffer-create-other-window
Per Abrahamsen's avatar
Per Abrahamsen committed
1055 1056
     (list (list symbol 'custom-face))
     (format "*Customize Face: %s*" (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1057

Per Abrahamsen's avatar
Per Abrahamsen committed
1058 1059
;;;###autoload
(defun customize-customized ()
Per Abrahamsen's avatar
Per Abrahamsen committed
1060 1061 1062 1063
  "Customize all user options set since the last save in this session."
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
Dave Love's avatar
Dave Love committed
1064 1065
		(and (or (get symbol 'customized-face)
			 (get symbol 'customized-face-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1066
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1067
		     (push (list symbol 'custom-face) found))
Dave Love's avatar
Dave Love committed
1068 1069
		(and (or (get symbol 'customized-value)
			 (get symbol 'customized-variable-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1070
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1071
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1072 1073 1074 1075
    (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
1076 1077 1078 1079

;;;###autoload
(defun customize-saved ()
  "Customize all already saved user options."
Per Abrahamsen's avatar
Per Abrahamsen committed
1080 1081 1082
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
Dave Love's avatar
Dave Love committed
1083 1084
		(and (or (get symbol 'saved-face)
			 (get symbol 'saved-face-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1085
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1086
		     (push (list symbol 'custom-face) found))
Dave Love's avatar
Dave Love committed
1087 1088
		(and (or (get symbol 'saved-value)
			 (get symbol 'saved-variable-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1089
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1090
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1091 1092 1093 1094
    (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
1095 1096 1097 1098

;;;###autoload
(defun customize-apropos (regexp &optional all)
  "Customize all user options matching REGEXP.
Per Abrahamsen's avatar
Per Abrahamsen committed
1099 1100 1101 1102 1103
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
1104 1105 1106 1107
  (interactive "sCustomize regexp: \nP")
  (let ((found nil))
    (mapatoms (lambda (symbol)
		(when (string-match regexp (symbol-name symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
1108 1109 1110 1111 1112 1113 1114 1115
		  (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
1116
			     (or (get symbol 'saved-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1117
				 (get symbol 'standard-value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1118 1119 1120 1121 1122 1123
				 (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
1124 1125 1126
      (custom-buffer-create (custom-sort-items found t
					       custom-buffer-order-groups)
			    "*Customize Apropos*"))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145

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

Per Abrahamsen's avatar
Per Abrahamsen committed
1147 1148
;;; Buffer.

Per Abrahamsen's avatar
Per Abrahamsen committed
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
(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)

1159 1160
;; If we pass BUFFER to `bury-buffer', the buffer isn't removed from
;; the window.
1161 1162 1163
(defun custom-bury-buffer (buffer)
  (bury-buffer))

1164
(defcustom custom-buffer-done-function 'custom-bury-buffer
Dave Love's avatar
Dave Love committed
1165 1166
  "*Function called to remove a Custom buffer when the user is done with it.
Called with one argument, the buffer to remove."
1167 1168
  :type '(choice (function-item :tag "Bury buffer" custom-bury-buffer)
		 (function-item :tag "Kill buffer" kill-buffer)
Dave Love's avatar
Dave Love committed
1169 1170 1171 1172
		 (function :tag "Other"))
  :version "21.1"
  :group 'custom-buffer)

Per Abrahamsen's avatar
Per Abrahamsen committed
1173 1174 1175 1176 1177
(defcustom custom-buffer-indent 3
  "Number of spaces to indent nested groups."
  :type 'integer
  :group 'custom-buffer)

Per Abrahamsen's avatar
Per Abrahamsen committed
1178
;;;###autoload
1179
(defun custom-buffer-create (options &optional name description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1180
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
1181
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
1182 1183 1184
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
1185 1186
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
1187
  (pop-to-buffer (get-buffer-create name))
1188
  (custom-buffer-create-internal options description))
Per Abrahamsen's avatar
Per Abrahamsen committed
1189

Per Abrahamsen's avatar
Per Abrahamsen committed
1190
;;;###autoload
1191
(defun custom-buffer-create-other-window (options &optional name description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1192
  "Create a buffer containing OPTIONS.
Per Abrahamsen's avatar
Per Abrahamsen committed
1193
Optional NAME is the name of the buffer.
Per Abrahamsen's avatar
Per Abrahamsen committed
1194 1195 1196
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
1197 1198
  (unless name (setq name "*Customization*"))
  (kill-buffer (get-buffer-create name))
1199 1200 1201 1202 1203 1204 1205
  (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))
1206
    (custom-buffer-create-internal options description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1207
    (select-window window)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1208 1209 1210 1211 1212

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

Dave Love's avatar
Dave Love committed
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
(defun Custom-buffer-done (&rest ignore)
  "Remove current buffer by calling `custom-buffer-done-function'."
  (interactive)
  (funcall custom-buffer-done-function (current-buffer)))

(defcustom custom-raised-buttons (not (equal (face-valid-attribute-values :box)
					     '(("unspecified" . unspecified))))
  "If non-nil, indicate active buttons in a `raised-button' style.
Otherwise use brackets."
  :type 'boolean
  :version "21.1"
  :group 'custom-buffer)

1228
(defun custom-buffer-create-internal (options &optional description)
Per Abrahamsen's avatar
Per Abrahamsen committed
1229
  (message "Creating customization buffer...")
Per Abrahamsen's avatar
Per Abrahamsen committed
1230
  (custom-mode)
1231 1232 1233
  (widget-insert "This is a customization buffer")
  (if description
      (widget-insert description))
Dave Love's avatar
Dave Love committed