cus-edit.el 129 KB
Newer Older
1
;;; cus-edit.el --- tools for customizing Emacs and Lisp packages
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
3
;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
4 5 6 7
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: help, faces

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

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

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
50
(put 'custom-define-hook 'custom-type 'hook)
Per Abrahamsen's avatar
Per Abrahamsen committed
51
(put 'custom-define-hook 'standard-value '(nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
52 53
(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)

Per Abrahamsen's avatar
Per Abrahamsen committed
54 55 56 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
;;; 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)

100 101 102 103
(defgroup convenience nil
  "Convenience features for faster editing."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
(defgroup programming nil
  "Support for programming in other languages."
  :group 'emacs)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
(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
236 237 238 239
(defgroup multimedia nil
  "Non-textual support, specifically images and sound."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
240 241 242 243 244 245
(defgroup local nil
  "Code local to your site."
  :group 'emacs)

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

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

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
(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."
339
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
340 341 342 343 344

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
353 354 355 356 357
;;; Utilities.

(defun custom-quote (sexp)
  "Quote SEXP iff it is not self quoting."
  (if (or (memq sexp '(t nil))
Dave Love's avatar
Dave Love committed
358
	  (keywordp sexp)
Per Abrahamsen's avatar
Per Abrahamsen committed
359 360 361 362
	  (and (listp sexp)
	       (memq (car sexp) '(lambda)))
	  (stringp sexp)
	  (numberp sexp)
Dave Love's avatar
Dave Love committed
363 364 365 366
	  (vectorp sexp)
;;;  	  (and (fboundp 'characterp)
;;;  	       (characterp sexp))
	  )
Per Abrahamsen's avatar
Per Abrahamsen committed
367 368 369 370 371
      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
372
You can get the original back with from the result with:
Per Abrahamsen's avatar
Per Abrahamsen committed
373 374 375 376 377 378 379 380 381 382 383 384
  (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
385 386 387 388 389 390
(defun custom-variable-prompt ()
  "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
391
     (setq val (completing-read
392
		(if (symbolp v)
393
		    (format "Customize option: (default %s) " v)
Per Abrahamsen's avatar
Per Abrahamsen committed
394
		  "Customize variable: ")
Per Abrahamsen's avatar
Per Abrahamsen committed
395 396 397
		obarray (lambda (symbol)
			  (and (boundp symbol)
			       (or (get symbol 'custom-type)
398
				   (get symbol 'custom-loads)
Dave Love's avatar
Dave Love committed
399
				   (get symbol 'standard-value)))) t))
Per Abrahamsen's avatar
Per Abrahamsen committed
400
     (list (if (equal val "")
401 402
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
403

Per Abrahamsen's avatar
Per Abrahamsen committed
404 405 406 407 408 409
(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
410
    (while menu
Per Abrahamsen's avatar
Per Abrahamsen committed
411 412 413 414 415 416 417 418 419 420
      (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
421 422
;;; Unlispify.

Per Abrahamsen's avatar
Per Abrahamsen committed
423
(defvar custom-prefix-list nil
Dave Love's avatar
Dave Love committed
424
  "List of prefixes that should be ignored by `custom-unlispify'.")
Per Abrahamsen's avatar
Per Abrahamsen committed
425 426 427

(defcustom custom-unlispify-menu-entries t
  "Display menu entries as words instead of symbols if non nil."
Per Abrahamsen's avatar
Per Abrahamsen committed
428
  :group 'custom-menu
Per Abrahamsen's avatar
Per Abrahamsen committed
429 430
  :type 'boolean)

431 432 433
(defcustom custom-unlispify-remove-prefixes nil
  "Non-nil means remove group prefixes from option names in buffer."
  :group 'custom-menu
434
  :group 'custom-buffer
435 436
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
437
(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
Dave Love's avatar
Dave Love committed
438
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
439 440 441 442 443 444 445 446 447 448 449 450
  (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
451 452 453 454
	   (when (and (eq (get symbol 'custom-type) 'boolean)
		      (re-search-forward "-p\\'" nil t))
	     (replace-match "" t t)
	     (goto-char (point-min)))
455 456 457 458 459 460
	   (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
461
		       (progn
462 463 464
			 (setq prefixes nil)
			 (delete-region (point-min) (point)))
		     (setq prefixes (cdr prefixes))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
465 466
	   (subst-char-in-region (point-min) (point-max) ?- ?\  t)
	   (capitalize-region (point-min) (point-max))
Dave Love's avatar
Dave Love committed
467
	   (unless no-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
468 469 470 471 472 473
	     (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
474
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
475 476 477
  :type 'boolean)

(defun custom-unlispify-tag-name (symbol)
Dave Love's avatar
Dave Love committed
478
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
479 480 481 482
  (let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
    (custom-unlispify-menu-entry symbol t)))

(defun custom-prefix-add (symbol prefixes)
Dave Love's avatar
Dave Love committed
483
  "Add SYMBOL to list of ignored PREFIXES."
Per Abrahamsen's avatar
Per Abrahamsen committed
484 485 486 487
  (cons (or (get symbol 'custom-prefix)
	    (concat (symbol-name symbol) "-"))
	prefixes))

Per Abrahamsen's avatar
Per Abrahamsen committed
488 489 490 491 492 493 494 495 496 497 498 499 500
;;; 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
501
MATCH should be a regexp matching the name of a symbol, and TYPE should
Per Abrahamsen's avatar
Per Abrahamsen committed
502 503
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
504
used.
Per Abrahamsen's avatar
Per Abrahamsen committed
505 506 507 508

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
509 510
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
511 512 513
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
514

Per Abrahamsen's avatar
Per Abrahamsen committed
515 516 517 518
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
519

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
550 551
;;; Sorting.

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

Per Abrahamsen's avatar
Per Abrahamsen committed
576 577 578 579 580 581 582
(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
583
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
584

Per Abrahamsen's avatar
Per Abrahamsen committed
585
(defcustom custom-menu-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
586
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
587
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
588
  :group 'custom-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
589

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
601 602 603 604 605 606 607 608 609
(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))
610
	   (namea (nth 0 a)) (nameb (nth 0 b)))
Per Abrahamsen's avatar
Per Abrahamsen committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
       (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
627

Per Abrahamsen's avatar
Per Abrahamsen committed
628 629
;;; Custom Mode Commands.

Per Abrahamsen's avatar
Per Abrahamsen committed
630 631 632
(defvar custom-options nil
  "Customization widgets in the current buffer.")

633
(defun Custom-set ()
Per Abrahamsen's avatar
Per Abrahamsen committed
634 635 636
  "Set changes in all modified options."
  (interactive)
  (let ((children custom-options))
637 638 639
    (mapc (lambda (child)
	    (when (eq (widget-get child :custom-state) 'modified)
	      (widget-apply child :custom-set)))
Per Abrahamsen's avatar
Per Abrahamsen committed
640 641
	    children)))

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

Dave Love's avatar
Dave Love committed
653
(defvar custom-reset-menu
654 655
  '(("Current" . Custom-reset-current)
    ("Saved" . Custom-reset-saved)
656
    ("Erase Customization (use standard settings)" . Custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
657 658
  "Alist of actions for the `Reset' button.
The key is a string containing the name of the action, the value is a
Dave Love's avatar
Dave Love committed
659
Lisp function taking the widget as an element which will be called
Per Abrahamsen's avatar
Per Abrahamsen committed
660 661 662 663 664 665 666 667 668 669 670
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))))

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

682
(defun Custom-reset-saved (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
683 684 685
  "Reset all modified or set group members to their saved value."
  (interactive)
  (let ((children custom-options))
686 687 688 689 690
    (mapc (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
691 692
	    children)))

693
(defun Custom-reset-standard (&rest ignore)
694 695 696 697
  "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
698 699
  (interactive)
  (let ((children custom-options))
700 701 702 703 704
    (mapc (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
705 706 707 708
	    children)))

;;; The Customize Commands

Dave Love's avatar
Dave Love committed
709
(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
710 711 712 713 714 715 716 717 718
  "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
719 720 721 722
`: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
723
  (let* ((var (read-variable prompt-var))
Dave Love's avatar
Dave Love committed
724 725
	 (minibuffer-help-form '(describe-variable var))
	 (val
Per Abrahamsen's avatar
Per Abrahamsen committed
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
	  (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
744 745 746 747 748
		   (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
749 750

;;;###autoload
Dave Love's avatar
Dave Love committed
751
(defun customize-set-value (var val &optional comment)
752
  "Set VARIABLE to VALUE, and return VALUE.  VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
753 754 755 756 757

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
758 759 760
`: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
761
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
762 763
				       "Set %s to value: "
				       current-prefix-arg))
Per Abrahamsen's avatar
Per Abrahamsen committed
764
   
Dave Love's avatar
Dave Love committed
765 766 767
  (cond ((string= comment "")
 	 (put var 'variable-comment nil))
 	(comment
768 769
 	 (put var 'variable-comment comment)))
  (set var val))
Per Abrahamsen's avatar
Per Abrahamsen committed
770 771

;;;###autoload
Dave Love's avatar
Dave Love committed
772
(defun customize-set-variable (variable value &optional comment)
773 774
  "Set the default for VARIABLE to VALUE, and return VALUE.
VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
775 776 777 778 779 780 781 782 783 784 785

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
786 787 788
`: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
789
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
790 791
				       "Set customized value for %s to: "
				       current-prefix-arg))
792
  (custom-load-symbol variable)
Dave Love's avatar
Dave Love committed
793 794
  (funcall (or (get variable 'custom-set) 'set-default) variable value)
  (put variable 'customized-value (list (custom-quote value)))
Dave Love's avatar
Dave Love committed
795
  (cond ((string= comment "")
Dave Love's avatar
Dave Love committed
796 797
 	 (put variable 'variable-comment nil)
 	 (put variable 'customized-variable-comment nil))
Dave Love's avatar
Dave Love committed
798
 	(comment
Dave Love's avatar
Dave Love committed
799
 	 (put variable 'variable-comment comment)
800 801
 	 (put variable 'customized-variable-comment comment)))
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
802

Per Abrahamsen's avatar
Per Abrahamsen committed
803
;;;###autoload
Dave Love's avatar
Dave Love committed
804
(defun customize-save-variable (var value &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
805
  "Set the default for VARIABLE to VALUE, and save it for future sessions.
806 807
Return VALUE.

Per Abrahamsen's avatar
Per Abrahamsen committed
808 809 810 811 812 813 814 815 816 817
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
818 819 820
`: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."
Pavel Janík's avatar
Pavel Janík committed
821
  (interactive (custom-prompt-variable "Set and save variable: "
Dave Love's avatar
Dave Love committed
822 823
				       "Set and save value for %s as: "
				       current-prefix-arg))
Dave Love's avatar
Dave Love committed
824 825
  (funcall (or (get var 'custom-set) 'set-default) var value)
  (put var 'saved-value (list (custom-quote value)))
Dave Love's avatar
Dave Love committed
826 827 828 829 830 831
  (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)))
832 833
  (custom-save-all)
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
834

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

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
900
;;;###autoload
901 902
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
903
  (interactive (custom-variable-prompt))
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
  ;; 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
926
  (custom-buffer-create (list (list symbol 'custom-variable))
927
			(format "*Customize Option: %s*"
Per Abrahamsen's avatar
Per Abrahamsen committed
928
				(custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
929

930 931 932
(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
933
;;;###autoload
934
(defun customize-changed-options (since-version)
935 936 937 938 939 940 941 942 943
  "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."

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

(defun customize-version-lessp (version1 version2)
1001 1002 1003
  ;; Why are the versions strings, and given that they are, why aren't
  ;; they converted to numbers and compared as such here?  -- fx

1004 1005 1006 1007
  ;; In case someone made a mistake and left out the quotes
  ;; in the :version value.
  (if (numberp version2)
      (setq version2 (prin1-to-string version2)))
1008
  (let (major1 major2 minor1 minor2)
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
    (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version1)
    (setq major1 (read (or (match-string 1 version1)
			   "0")))
    (setq minor1 (read (or (match-string 3 version1)
			   "0")))
    (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version2)
    (setq major2 (read (or (match-string 1 version2)
			   "0")))
    (setq minor2 (read (or (match-string 3 version2)
			   "0")))
1019 1020 1021 1022 1023
    (or (< major1 major2)
	(and (= major1 major2)
	     (< minor1 minor2)))))
  
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
1024 1025
(defalias 'customize-variable-other-window 'customize-option-other-window)

Per Abrahamsen's avatar
Per Abrahamsen committed
1026
;;;###autoload
1027 1028
(defun customize-option-other-window (symbol)
  "Customize SYMBOL, which must be a user option variable.
Per Abrahamsen's avatar
Per Abrahamsen committed
1029 1030
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
1031 1032
  (custom-buffer-create-other-window
   (list (list symbol 'custom-variable))
1033
   (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1034

Per Abrahamsen's avatar
Per Abrahamsen committed
1035 1036 1037 1038
;;;###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
1039
  (interactive (list (completing-read "Customize face: (default all) "
1040
				      obarray 'custom-facep t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1041
  (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1042 1043 1044 1045 1046 1047 1048 1049
      (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
1050 1051
    (unless (symbolp symbol)
      (error "Should be a symbol %S" symbol))
Per Abrahamsen's avatar
Per Abrahamsen committed
1052 1053 1054
    (custom-buffer-create (list (list symbol 'custom-face))
			  (format "*Customize Face: %s*"
				  (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1055

Per Abrahamsen's avatar
Per Abrahamsen committed
1056 1057
;;;###autoload
(defun customize-face-other-window (&optional symbol)
Dave Love's avatar
Dave Love committed
1058
  "Show customization buffer for face SYMBOL in other window."
Dave Love's avatar
Dave Love committed
1059
  (interactive (list (completing-read "Customize face: "
1060
				      obarray 'custom-facep t)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1061 1062 1063 1064 1065 1066
  (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
1067
    (custom-buffer-create-other-window
Per Abrahamsen's avatar
Per Abrahamsen committed
1068 1069
     (list (list symbol 'custom-face))
     (format "*Customize Face: %s*" (custom-unlispify-tag-name symbol)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1070

Per Abrahamsen's avatar
Per Abrahamsen committed
1071 1072
;;;###autoload
(defun customize-customized ()
Per Abrahamsen's avatar
Per Abrahamsen committed
1073 1074 1075 1076
  "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
1077 1078
		(and (or (get symbol 'customized-face)
			 (get symbol 'customized-face-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1079
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1080
		     (push (list symbol 'custom-face) found))
Dave Love's avatar
Dave Love committed
1081 1082
		(and (or (get symbol 'customized-value)
			 (get symbol 'customized-variable-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1083
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1084
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1085 1086 1087 1088
    (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
1089 1090 1091 1092

;;;###autoload
(defun customize-saved ()
  "Customize all already saved user options."
Per Abrahamsen's avatar
Per Abrahamsen committed
1093 1094 1095
  (interactive)
  (let ((found nil))
    (mapatoms (lambda (symbol)
Dave Love's avatar
Dave Love committed
1096 1097
		(and (or (get symbol 'saved-face)
			 (get symbol 'saved-face-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1098
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1099
		     (push (list symbol 'custom-face) found))
Dave Love's avatar
Dave Love committed
1100 1101
		(and (or (get symbol 'saved-value)
			 (get symbol 'saved-variable-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1102
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1103
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1104 1105 1106 1107
    (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
1108 1109 1110 1111

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