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

10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

Per Abrahamsen's avatar
Per Abrahamsen committed
27 28
;;; Commentary:
;;
Per Abrahamsen's avatar
Per Abrahamsen committed
29
;; This file implements the code to create and edit customize buffers.
30
;;
Per Abrahamsen's avatar
Per Abrahamsen committed
31 32
;; See `custom.el'.

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

37
;; The identity of a customize option is represented by a Lisp symbol.
Luc Teirlinck's avatar
Luc Teirlinck committed
38
;; The following values are associated with an option.
39 40 41 42 43 44 45 46 47 48 49 50

;; 0. The current value.

;;    This is the value of the option as seen by "the rest of Emacs".

;;    Usually extracted by 'default-value', but can be extracted with
;;    different means if the option symbol has the 'custom-get'
;;    property.  Similarly, set-default (or the 'custom-set' property)
;;    can set it.

;; 1. The widget value.

Luc Teirlinck's avatar
Luc Teirlinck committed
51
;;    This is the value shown in the widget in a customize buffer.
52 53 54 55 56 57

;; 2. The customized value.

;;    This is the last value given to the option through customize.

;;    It is stored in the 'customized-value' property of the option, in a
Luc Teirlinck's avatar
Luc Teirlinck committed
58
;;    cons-cell whose car evaluates to the customized value.
59 60 61 62 63 64

;; 3. The saved value.

;;    This is last value saved from customize.

;;    It is stored in the 'saved-value' property of the option, in a
Luc Teirlinck's avatar
Luc Teirlinck committed
65
;;    cons-cell whose car evaluates to the saved value.
66 67 68 69 70 71

;; 4. The standard value.

;;    This is the value given in the 'defcustom' declaration.

;;    It is stored in the 'standard-value' property of the option, in a
Luc Teirlinck's avatar
Luc Teirlinck committed
72
;;    cons-cell whose car evaluates to the standard value.
73 74

;; 5. The "think" value.
Luc Teirlinck's avatar
Luc Teirlinck committed
75 76 77 78

;;    This is what customize thinks the current value should be.

;;    This is the customized value, if any such value exists, otherwise
79
;;    the saved value, if that exists, and as a last resort the standard
Luc Teirlinck's avatar
Luc Teirlinck committed
80
;;    value.
81 82 83

;; The reason for storing values unevaluated: This is so you can have
;; values that depend on the environment.  For example, you can have a
Luc Teirlinck's avatar
Luc Teirlinck committed
84
;; variable that has one value when Emacs is running under a window
85
;; system, and another value on a tty.  Since the evaluation is only done
Luc Teirlinck's avatar
Luc Teirlinck committed
86
;; when the variable is first initialized, this is only relevant for the
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
;; saved (and standard) values, but affect others values for
;; compatibility.

;; You can see (and modify and save) this unevaluated value by selecting
;; "Show initial Lisp expression" from the Lisp interface.  This will
;; give you the unevaluated saved value, if any, otherwise the
;; unevaluated standard value.

;; The possible states for a customize widget are:

;; 0. unknown

;;    The state has not been determined yet.

;; 1. modified

;;    The widget value is different from the current value.

;; 2. changed
Luc Teirlinck's avatar
Luc Teirlinck committed
106 107

;;    The current value is different from the "think" value.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

;; 3. set

;;    The "think" value is the customized value.

;; 4. saved

;;    The "think" value is the saved value.

;; 5. standard

;;    The "think" value is the standard value.

;; 6. rogue

Luc Teirlinck's avatar
Luc Teirlinck committed
123
;;    There is no standard value.  This means that the variable was
Luc Teirlinck's avatar
Luc Teirlinck committed
124 125 126 127 128
;;    not defined with defcustom, nor handled in cus-start.el.  You
;;    can not create a Custom buffer for such variables using the
;;    normal interactive Custom commands.  However, such Custom
;;    buffers can be created in other ways, for instance, by calling
;;    `customize-option' non-interactively.
129 130 131 132 133 134 135 136

;; 7. hidden

;;    There is no widget value.

;; 8. mismatch

;;    The widget value is not valid member of the :type specified for the
Luc Teirlinck's avatar
Luc Teirlinck committed
137
;;    option.
138

Per Abrahamsen's avatar
Per Abrahamsen committed
139 140 141 142
;;; Code:

(require 'cus-face)
(require 'wid-edit)
143 144
(eval-when-compile
  (defvar custom-versions-load-alist))	; from cus-load
Per Abrahamsen's avatar
Per Abrahamsen committed
145 146 147 148

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

Per Abrahamsen's avatar
Per Abrahamsen committed
150 151 152 153
(condition-case nil
    (require 'cus-start)
  (error nil))

Per Abrahamsen's avatar
Per Abrahamsen committed
154
(put 'custom-define-hook 'custom-type 'hook)
Per Abrahamsen's avatar
Per Abrahamsen committed
155
(put 'custom-define-hook 'standard-value '(nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
156 157
(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)

Per Abrahamsen's avatar
Per Abrahamsen committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
;;; 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."
Dave Love's avatar
Dave Love committed
180
  :link '(custom-manual "(emacs)Emulation")
Per Abrahamsen's avatar
Per Abrahamsen committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
  :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 processes nil
  "Process, subshell, compilation, and job control support."
  :group 'external
  :group 'development)

200 201 202 203
(defgroup convenience nil
  "Convenience features for faster editing."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
(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."
Dave Love's avatar
Dave Love committed
219
  :link '(custom-manual "(ccmode)")
Per Abrahamsen's avatar
Per Abrahamsen committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
  :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."
Dave Love's avatar
Dave Love committed
244
  :link '(custom-manual "(gnus)")
Per Abrahamsen's avatar
Per Abrahamsen committed
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
  :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."
Dave Love's avatar
Dave Love committed
299
  :link '(custom-manual "(emacs)International")
Per Abrahamsen's avatar
Per Abrahamsen committed
300 301 302
  :group 'environment
  :group 'editing)

Per Abrahamsen's avatar
Per Abrahamsen committed
303 304 305 306
(defgroup x nil
  "The X Window system."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
307 308 309 310 311 312 313 314
(defgroup frames nil
  "Support for Emacs frames and window systems."
  :group 'environment)

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

315 316 317 318
(defgroup files nil
  "Support editing files."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
(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
339 340 341 342
(defgroup multimedia nil
  "Non-textual support, specifically images and sound."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
343 344 345 346 347 348 349
(defgroup local nil
  "Code local to your site."
  :group 'emacs)

(defgroup customize '((widgets custom-group))
  "Customization of the Customization support."
  :prefix "custom-"
Per Abrahamsen's avatar
Per Abrahamsen committed
350 351 352 353 354
  :group 'help)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
357 358 359 360 361
(defgroup custom-browse nil
  "Control customize browser."
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
362
(defgroup custom-buffer nil
Per Abrahamsen's avatar
Per Abrahamsen committed
363
  "Control customize buffers."
Per Abrahamsen's avatar
Per Abrahamsen committed
364 365 366 367
  :prefix "custom-"
  :group 'customize)

(defgroup custom-menu nil
Per Abrahamsen's avatar
Per Abrahamsen committed
368
  "Control customize menus."
Per Abrahamsen's avatar
Per Abrahamsen committed
369 370 371
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
372 373
(defgroup abbrev-mode nil
  "Word abbreviations mode."
Dave Love's avatar
Dave Love committed
374
  :link '(custom-manual "(emacs)Abbrevs")
Per Abrahamsen's avatar
Per Abrahamsen committed
375 376 377 378 379 380 381 382 383
  :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."
Dave Love's avatar
Dave Love committed
384
  :link '(custom-manual "(emacs)Undo")
Per Abrahamsen's avatar
Per Abrahamsen committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  :group 'editing)

(defgroup modeline nil
  "Content of the modeline."
  :group 'environment)

(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."
Dave Love's avatar
Dave Love committed
421
  :link '(custom-manual "(emacs)Minibuffer")
Per Abrahamsen's avatar
Per Abrahamsen committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
  :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."
438
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
439 440 441 442 443

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

Per Abrahamsen's avatar
Per Abrahamsen committed
444 445
(defgroup mule nil
  "MULE Emacs internationalization."
446
  :group 'i18n)
Per Abrahamsen's avatar
Per Abrahamsen committed
447

Per Abrahamsen's avatar
Per Abrahamsen committed
448 449
(defgroup windows nil
  "Windows within a frame."
Dave Love's avatar
Dave Love committed
450
  :link '(custom-manual "(emacs)Windows")
Per Abrahamsen's avatar
Per Abrahamsen committed
451
  :group 'environment)
Per Abrahamsen's avatar
Per Abrahamsen committed
452

Per Abrahamsen's avatar
Per Abrahamsen committed
453 454 455 456 457
;;; 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
458
	  (keywordp sexp)
Per Abrahamsen's avatar
Per Abrahamsen committed
459 460 461 462
	  (and (listp sexp)
	       (memq (car sexp) '(lambda)))
	  (stringp sexp)
	  (numberp sexp)
Dave Love's avatar
Dave Love committed
463 464 465 466
	  (vectorp sexp)
;;;  	  (and (fboundp 'characterp)
;;;  	       (characterp sexp))
	  )
Per Abrahamsen's avatar
Per Abrahamsen committed
467 468 469 470 471
      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
472
You can get the original back with from the result with:
Per Abrahamsen's avatar
Per Abrahamsen committed
473 474 475 476 477 478 479 480 481 482 483 484
  (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
485
(defun custom-variable-prompt ()
486
  "Prompt for a custom variable, defaulting to the variable at point.
Per Abrahamsen's avatar
Per Abrahamsen committed
487 488 489 490
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
491
     (setq val (completing-read
492
		(if (and (symbolp v) (custom-variable-p v))
493
		    (format "Customize option: (default %s) " v)
494 495
		  "Customize option: ")
		obarray 'custom-variable-p t))
Per Abrahamsen's avatar
Per Abrahamsen committed
496
     (list (if (equal val "")
497 498
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
499

Per Abrahamsen's avatar
Per Abrahamsen committed
500 501 502 503 504 505
(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
506
    (while menu
Per Abrahamsen's avatar
Per Abrahamsen committed
507 508 509 510 511 512 513 514 515 516
      (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
517 518
;;; Unlispify.

Per Abrahamsen's avatar
Per Abrahamsen committed
519
(defvar custom-prefix-list nil
Dave Love's avatar
Dave Love committed
520
  "List of prefixes that should be ignored by `custom-unlispify'.")
Per Abrahamsen's avatar
Per Abrahamsen committed
521 522 523

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

527 528 529
(defcustom custom-unlispify-remove-prefixes nil
  "Non-nil means remove group prefixes from option names in buffer."
  :group 'custom-menu
530
  :group 'custom-buffer
531 532
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
533
(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
Dave Love's avatar
Dave Love committed
534
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
535 536 537 538 539 540 541
  (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
542
	 (with-current-buffer (get-buffer-create " *Custom-Work*")
Per Abrahamsen's avatar
Per Abrahamsen committed
543 544 545
	   (erase-buffer)
	   (princ symbol (current-buffer))
	   (goto-char (point-min))
546 547 548 549 550 551
	   ;; FIXME: Boolean variables are not predicates, so they shouldn't
	   ;; end with `-p'.  -stef
	   ;; (when (and (eq (get symbol 'custom-type) 'boolean)
	   ;; 	      (re-search-forward "-p\\'" nil t))
	   ;;   (replace-match "" t t)
	   ;;   (goto-char (point-min)))
552 553 554 555 556 557
	   (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
558
		       (progn
559 560 561
			 (setq prefixes nil)
			 (delete-region (point-min) (point)))
		     (setq prefixes (cdr prefixes))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
562 563
	   (subst-char-in-region (point-min) (point-max) ?- ?\  t)
	   (capitalize-region (point-min) (point-max))
Dave Love's avatar
Dave Love committed
564
	   (unless no-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
565 566 567 568 569 570
	     (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
571
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
572 573 574
  :type 'boolean)

(defun custom-unlispify-tag-name (symbol)
Dave Love's avatar
Dave Love committed
575
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
576 577 578 579
  (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
580
  "Add SYMBOL to list of ignored PREFIXES."
Per Abrahamsen's avatar
Per Abrahamsen committed
581 582 583 584
  (cons (or (get symbol 'custom-prefix)
	    (concat (symbol-name symbol) "-"))
	prefixes))

Per Abrahamsen's avatar
Per Abrahamsen committed
585 586 587 588 589 590 591 592 593 594 595 596 597
;;; 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
598
MATCH should be a regexp matching the name of a symbol, and TYPE should
Per Abrahamsen's avatar
Per Abrahamsen committed
599 600
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
601
used.
Per Abrahamsen's avatar
Per Abrahamsen committed
602 603 604 605

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
606 607
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
608 609 610
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
611

Per Abrahamsen's avatar
Per Abrahamsen committed
612 613 614 615
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
616

Per Abrahamsen's avatar
Per Abrahamsen committed
617 618 619 620
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
621

Per Abrahamsen's avatar
Per Abrahamsen committed
622 623
(defun custom-guess-type (symbol)
  "Guess a widget suitable for editing the value of SYMBOL.
Dave Love's avatar
Dave Love committed
624
This is done by matching SYMBOL with `custom-guess-name-alist' and
Per Abrahamsen's avatar
Per Abrahamsen committed
625 626 627 628 629 630 631 632 633 634 635 636 637
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
638
	(when doc
Per Abrahamsen's avatar
Per Abrahamsen committed
639 640 641 642 643 644 645
	  (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
646

Per Abrahamsen's avatar
Per Abrahamsen committed
647 648
;;; Sorting.

Per Abrahamsen's avatar
Per Abrahamsen committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662
(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
663 664 665 666 667
(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
668
(defcustom custom-buffer-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
669
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
670
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
671
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
672

Per Abrahamsen's avatar
Per Abrahamsen committed
673 674 675 676 677 678 679
(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
680
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
681

Per Abrahamsen's avatar
Per Abrahamsen committed
682
(defcustom custom-menu-sort-alphabetically nil
Per Abrahamsen's avatar
Per Abrahamsen committed
683
  "If non-nil, sort members of each customization group alphabetically."
Per Abrahamsen's avatar
Per Abrahamsen committed
684
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
685
  :group 'custom-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
686

Per Abrahamsen's avatar
Per Abrahamsen committed
687 688 689 690 691 692 693
(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
694 695
  :group 'custom-menu)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
698 699 700 701 702 703 704 705 706
(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))
707
	   (namea (nth 0 a)) (nameb (nth 0 b)))
Per Abrahamsen's avatar
Per Abrahamsen committed
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
       (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
724

Per Abrahamsen's avatar
Per Abrahamsen committed
725 726
;;; Custom Mode Commands.

Per Abrahamsen's avatar
Per Abrahamsen committed
727 728 729
(defvar custom-options nil
  "Customization widgets in the current buffer.")

730
(defun Custom-set ()
Per Abrahamsen's avatar
Per Abrahamsen committed
731 732 733
  "Set changes in all modified options."
  (interactive)
  (let ((children custom-options))
734 735 736
    (mapc (lambda (child)
	    (when (eq (widget-get child :custom-state) 'modified)
	      (widget-apply child :custom-set)))
Per Abrahamsen's avatar
Per Abrahamsen committed
737 738
	    children)))

739
(defun Custom-save ()
Per Abrahamsen's avatar
Per Abrahamsen committed
740 741 742
  "Set all modified group members and save them."
  (interactive)
  (let ((children custom-options))
743 744 745 746
    (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
747 748 749
	    children))
  (custom-save-all))

Dave Love's avatar
Dave Love committed
750
(defvar custom-reset-menu
751 752
  '(("Current" . Custom-reset-current)
    ("Saved" . Custom-reset-saved)
753
    ("Erase Customization (use standard settings)" . Custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
754 755
  "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
756
Lisp function taking the widget as an element which will be called
Per Abrahamsen's avatar
Per Abrahamsen committed
757 758 759 760 761 762 763 764 765 766 767
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))))

768
(defun Custom-reset-current (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
769 770 771
  "Reset all modified group members to their current value."
  (interactive)
  (let ((children custom-options))
772
    (mapc (lambda (widget)
773 774 775 776
	    (if (memq (widget-get widget :custom-state)
		      '(modified changed))
		(widget-apply widget :custom-reset-current)))
	  children)))
Per Abrahamsen's avatar
Per Abrahamsen committed
777

778
(defun Custom-reset-saved (&rest ignore)
Per Abrahamsen's avatar
Per Abrahamsen committed
779 780 781
  "Reset all modified or set group members to their saved value."
  (interactive)
  (let ((children custom-options))
782
    (mapc (lambda (widget)
783 784 785 786
	    (if (memq (widget-get widget :custom-state)
		      '(modified set changed rogue))
		(widget-apply widget :custom-reset-saved)))
	  children)))
Per Abrahamsen's avatar
Per Abrahamsen committed
787

788
(defun Custom-reset-standard (&rest ignore)
789 790 791 792
  "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
793 794
  (interactive)
  (let ((children custom-options))
795
    (mapc (lambda (widget)
796
	    (and (widget-apply widget :custom-standard-value)
797 798 799
		 (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
800 801 802 803
	    children)))

;;; The Customize Commands

Dave Love's avatar
Dave Love committed
804
(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
805 806 807 808 809 810 811 812 813
  "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
814 815 816 817
`: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
818
  (let* ((var (read-variable prompt-var))
Dave Love's avatar
Dave Love committed
819 820
	 (minibuffer-help-form '(describe-variable var))
	 (val
Per Abrahamsen's avatar
Per Abrahamsen committed
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
	  (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
839 840 841 842 843
		   (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
844 845

;;;###autoload
846
(defun customize-set-value (variable value &optional comment)
847
  "Set VARIABLE to VALUE, and return VALUE.  VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
848 849 850 851 852

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
853 854 855
`: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
856
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
857 858
				       "Set %s to value: "
				       current-prefix-arg))
859

Dave Love's avatar
Dave Love committed
860
  (cond ((string= comment "")
861
 	 (put variable 'variable-comment nil))
Dave Love's avatar
Dave Love committed
862
 	(comment
863 864
 	 (put variable 'variable-comment comment)))
  (set variable value))
Per Abrahamsen's avatar
Per Abrahamsen committed
865 866

;;;###autoload
Dave Love's avatar
Dave Love committed
867
(defun customize-set-variable (variable value &optional comment)
868 869
  "Set the default for VARIABLE to VALUE, and return VALUE.
VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
870 871 872 873 874 875 876 877 878 879 880

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
881 882 883
`: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
884
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
885 886
				       "Set customized value for %s to: "
				       current-prefix-arg))
887
  (custom-load-symbol variable)
Dave Love's avatar
Dave Love committed
888 889
  (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
890
  (cond ((string= comment "")
Dave Love's avatar
Dave Love committed
891 892
 	 (put variable 'variable-comment nil)
 	 (put variable 'customized-variable-comment nil))
Dave Love's avatar
Dave Love committed
893
 	(comment
Dave Love's avatar
Dave Love committed
894
 	 (put variable 'variable-comment comment)
895 896
 	 (put variable 'customized-variable-comment comment)))
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
897

Per Abrahamsen's avatar
Per Abrahamsen committed
898
;;;###autoload
899
(defun customize-save-variable (variable value &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
900
  "Set the default for VARIABLE to VALUE, and save it for future sessions.
901 902
Return VALUE.

Per Abrahamsen's avatar
Per Abrahamsen committed
903 904 905 906 907 908 909 910 911 912
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
913 914 915
`: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
916
  (interactive (custom-prompt-variable "Set and save variable: "
Dave Love's avatar
Dave Love committed
917 918
				       "Set and save value for %s as: "
				       current-prefix-arg))
919 920
  (funcall (or (get variable 'custom-set) 'set-default) variable value)
  (put variable 'saved-value (list (custom-quote value)))
921
  (custom-push-theme 'theme-value variable 'user 'set (list (custom-quote value)))
Dave Love's avatar
Dave Love committed
922
  (cond ((string= comment "")
923 924
 	 (put variable 'variable-comment nil)
 	 (put variable 'saved-variable-comment nil))
Dave Love's avatar
Dave Love committed
925
 	(comment
926 927
 	 (put variable 'variable-comment comment)
 	 (put variable 'saved-variable-comment comment)))
928 929
  (custom-save-all)
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
930

Per Abrahamsen's avatar
Per Abrahamsen committed
931
;;;###autoload
932 933 934 935 936 937
(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
938
  (customize-group 'emacs))
939

940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
;;;###autoload
(defun customize-mode (mode)
  "Customize options related to the current major mode.
If a prefix \\[universal-argument] was given (or if the current major mode has no known group),
then prompt for the MODE to customize."
  (interactive
   (list
    (let ((completion-regexp-list '("-mode\\'"))
	  (group (custom-group-of-mode major-mode)))
      (if (and group (not current-prefix-arg))
	  major-mode
	(intern
	 (completing-read (if group
			      (format "Major mode (default %s): " major-mode)
			    "Major mode: ")
			  obarray
			  'custom-group-of-mode
			  t nil nil (if group (symbol-name major-mode))))))))
  (customize-group (custom-group-of-mode mode)))


961 962 963
;;;###autoload
(defun customize-group (group)
  "Customize GROUP, which must be a customization group."
964 965
  (interactive (list (let ((completion-ignore-case t))
		       (completing-read "Customize group: (default emacs) "
Dave Love's avatar
Dave Love committed
966
					obarray
967
					(lambda (symbol)
968 969
					  (or (get symbol 'custom-loads)
					      (get symbol 'custom-group)))
970
					t))))
971 972 973 974
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
975 976 977
  (let ((name (format "*Customize Group: %s*"
		      (custom-unlispify-tag-name group))))
    (if (get-buffer name)
978
	(pop-to-buffer name)
979
      (custom-buffer-create (list (list group 'custom-group))
980 981 982
			    name
			    (concat " for group "
				    (custom-unlispify-tag-name group))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
983

Per Abrahamsen's avatar
Per Abrahamsen committed
984
;;;###autoload
985 986 987 988
(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
989
					obarray
990 991 992 993 994 995 996 997 998 999 1000
					(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))))
  (let ((name (format "*Customize Group: %s*"
		      (custom-unlispify-tag-name group))))
    (if (get-buffer name)
1001
	(let (
1002 1003 1004 1005
	      ;; Copied from `custom-buffer-create-other-window'.
	      (pop-up-windows t)
	      (same-window-buffer-names nil)
	      (same-window-regexps nil))
1006
	  (pop-to-buffer name))
1007 1008 1009 1010 1011
      (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
1012

Per Abrahamsen's avatar
Per Abrahamsen committed
1013 1014
;;;###autoload
(defalias 'customize-variable 'customize-option)
1015

Per Abrahamsen's avatar
Per Abrahamsen committed
1016
;;;###autoload
1017 1018
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
1019
  (interactive (custom-variable-prompt))
Per Abrahamsen's avatar
Per Abrahamsen committed
1020
  (custom-buffer-create (list (list symbol 'custom-variable))
1021
			(format "*Customize Option: %s*"
Per Abrahamsen's avatar
Per Abrahamsen committed
1022
				(custom-unlispify-tag-name symbol))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1023

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
;;;###autoload
(defalias 'customize-variable-other-window 'customize-option-other-window)

;;;###autoload
(defun customize-option-other-window (symbol)
  "Customize SYMBOL, which must be a user option variable.
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
  (custom-buffer-create-other-window
   (list (list symbol 'custom-variable))
   (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))

1036 1037 1038
(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
1039
;;;###autoload
1040
(defun customize-changed-options (since-version)
1041 1042 1043 1044 1045 1046 1047
  "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
1048
version."
1049

1050 1051
  (interactive "sCustomize options changed, since version (default all versions): ")
  (if (equal since-version "")
1052 1053 1054 1055 1056
      (setq since-version nil)
    (unless (condition-case nil
		(numberp (read since-version))
	      (error nil))
      (signal 'wrong-type-argument (list 'numberp since-version))))
1057 1058
  (unless since-version
    (setq since-version customize-changed-options-previous-release))
1059 1060 1061 1062 1063

  ;; Load the information for versions since since-version.  We use
  ;; custom-load-symbol for this.
  (put 'custom-versions-load-alist 'custom-loads nil)
  (dolist (elt custom-versions-load-alist)
1064 1065 1066
    (if (customize-version-lessp since-version (car elt))
	(dolist (load (cdr elt))
	  (custom-add-load 'custom-versions-load-alist load))))
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
  (custom-load-symbol 'custom-versions-load-alist)
  (put 'custom-versions-load-alist 'custom-loads nil)

  (let (found)
    (mapatoms
     (lambda (symbol)
       (let ((version (get symbol 'custom-version)))
	 (if version
	     (when (customize-version-lessp since-version version)
	       (if (or (get symbol 'custom-group)
		       (get symbol 'group-documentation))
		   (push (list symbol 'custom-group) found))
	       (if (custom-variable-p symbol)
		   (push (list symbol 'custom-variable) found))
	       (if (custom-facep symbol)
		   (push (list symbol 'custom-face) found)))))))
    (if found
	(custom-buffer-create (custom-sort-items found t 'first)
			      "*Customize Changed Options*")
      (error "No user option defaults have been changed since Emacs %s"
	     since-version))))
1088 1089

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

1093 1094 1095 1096
  ;; In case someone made a mistake and left out the quotes
  ;; in the :version value.
  (if (numberp version2)
      (setq version2 (prin1-to-string version2)))
1097
  (let (major1 major2 minor1 minor2)
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
    (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")))
1108 1109 1110
    (or (< major1 major2)
	(and (= major1 major2)
	     (< minor1 minor2)))))
1111

Per Abrahamsen's avatar
Per Abrahamsen committed
1112
;;;###autoload
1113
(defun customize-face (&optional face)
1114 1115
  "Customize FACE, which should be a face name or nil.
If FACE is nil, customize all faces.
1116 1117

Interactively, when point is on text which has a face specified,
1118
suggest to customize that face, if it's customizable."
1119
  (interactive
1120 1121 1122 1123 1124 1125
   (list (read-face-name "Customize face" "all faces" t)))
  (if (member face '(nil ""))
      (setq face (face-list)))
  (if (and (listp face) (null (cdr face)))
      (setq face (car face)))
  (if (listp face)
Per Abrahamsen's avatar
Per Abrahamsen committed
1126
      (custom-buffer-create (custom-sort-items
1127 1128 1129
			     (mapcar (lambda (s)
				       (list s 'custom-face))
				     face)
Per Abrahamsen's avatar
Per Abrahamsen committed
1130 1131
			     t nil)
			    "*Customize Faces*")
1132
    (unless (facep face)
1133
      (error "Invalid face %S" face))
1134
    (custom-buffer-create (list (list face 'custom-face))
Per Abrahamsen's avatar
Per Abrahamsen committed
1135
			  (format "*Customize Face: %s*"
1136
				  (custom-unlispify-tag-name face)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1137

Per Abrahamsen's avatar
Per Abrahamsen committed
1138
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
1139
(defun customize-face-other-window (&optional face)
1140
  "Show customization buffer for face FACE in other window.
1141 1142

Interactively, when point is on text which has a face specified,
1143
suggest to customize that face, if it's customizable."
1144
  (interactive
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
   (list (read-face-name "Customize face" "all faces" t)))
  (if (member face '(nil ""))
      (setq face (face-list)))
  (if (and (listp face) (null (cdr face)))
      (setq face (car face)))
  (if (listp face)
      (custom-buffer-create-other-window
       (custom-sort-items
	(mapcar (lambda (s)
		  (list s 'custom-face))
		face)
	t nil)
       "*Customize Faces*")
    (unless (facep face)
1159
      (error "Invalid face %S" face))
Dave Love's avatar
Dave Love committed
1160
    (custom-buffer-create-other-window
1161 1162 1163
     (list (list face 'custom-face))
     (format "*Customize Face: %s*"
	     (custom-unlispify-tag-name face)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1164

Per Abrahamsen's avatar
Per Abrahamsen committed
1165 1166
;;;###autoload
(defun customize-customized ()
Per Abrahamsen's avatar
Per Abrahamsen committed
1167 1168 1169 1170
  "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
1171 1172
		(and (or (get symbol 'customized-face)
			 (get symbol 'customized-face-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1173
		     (custom-facep symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1174
		     (push (list symbol 'custom-face) found))
Dave Love's avatar
Dave Love committed
1175 1176
		(and (or (get symbol 'customized-value)
			 (get symbol 'customized-variable-comment))
Per Abrahamsen's avatar
Per Abrahamsen committed
1177
		     (boundp symbol)
Per Abrahamsen's avatar
Per Abrahamsen committed
1178
		     (push (list symbol 'custom-variable) found))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1179 1180 1181 1182
    (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
1183 1184
</