cus-edit.el 161 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, 2003, 2004,
4
;;   2005, 2006, 2007, 2008 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
;; 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
14
;; the Free Software Foundation; either version 3, or (at your option)
15 16 17 18 19 20 21 22 23
;; 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
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
26

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
;; saved (and standard) values, but affect others values for
;; compatibility.

;; You can see (and modify and save) this unevaluated value by selecting
91
;; "Show Saved Lisp Expression" from the Lisp interface.  This will
92 93 94 95 96 97 98 99 100 101 102 103 104 105
;; 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.  Most
;;    standard interactive Custom commands do not let you create a
;;    Custom buffer containing such variables.  However, such Custom
;;    buffers can be created, for instance, by calling
;;    `customize-apropos' with a prefix arg or by calling
Luc Teirlinck's avatar
Luc Teirlinck committed
129
;;    `customize-option' non-interactively.
130 131 132 133 134 135 136 137

;; 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
138
;;    option.
139

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

(require 'cus-face)
(require 'wid-edit)
144 145 146

(defvar custom-versions-load-alist)	; from cus-load
(defvar recentf-exclude)		; from recentf.el
Per Abrahamsen's avatar
Per Abrahamsen committed
147 148 149 150

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
;;; 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
182
  :link '(custom-manual "(emacs)Emulation")
Per Abrahamsen's avatar
Per Abrahamsen committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
  :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)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
206 207 208 209 210 211 212 213 214 215
(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."
216
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
217 218 219 220 221
  :group 'languages
  :group 'development)

(defgroup c nil
  "Support for the C language and related languages."
222
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Dave Love's avatar
Dave Love committed
223
  :link '(custom-manual "(ccmode)")
Per Abrahamsen's avatar
Per Abrahamsen committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
  :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
248
  :link '(custom-manual "(gnus)")
Per Abrahamsen's avatar
Per Abrahamsen committed
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 299 300 301 302
  :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
303
  :link '(custom-manual "(emacs)International")
Per Abrahamsen's avatar
Per Abrahamsen committed
304 305 306
  :group 'environment
  :group 'editing)

Per Abrahamsen's avatar
Per Abrahamsen committed
307 308 309 310
(defgroup x nil
  "The X Window system."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
311 312 313 314 315 316 317 318
(defgroup frames nil
  "Support for Emacs frames and window systems."
  :group 'environment)

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

319 320 321 322
(defgroup files nil
  "Support editing files."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
323 324 325 326 327 328
(defgroup wp nil
  "Word processing."
  :group 'emacs)

(defgroup tex nil
  "Code related to the TeX formatter."
329
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343
  :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
344 345 346 347
(defgroup multimedia nil
  "Non-textual support, specifically images and sound."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
348 349 350 351 352 353 354
(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
355 356 357 358 359
  :group 'help)

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
367
(defgroup custom-buffer nil
Per Abrahamsen's avatar
Per Abrahamsen committed
368
  "Control customize buffers."
Per Abrahamsen's avatar
Per Abrahamsen committed
369 370 371 372
  :prefix "custom-"
  :group 'customize)

(defgroup custom-menu nil
Per Abrahamsen's avatar
Per Abrahamsen committed
373
  "Control customize menus."
Per Abrahamsen's avatar
Per Abrahamsen committed
374 375 376
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
377 378 379 380 381 382 383
(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
  :group 'editing)

387
(defgroup mode-line nil
Per Abrahamsen's avatar
Per Abrahamsen committed
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 421 422 423 424 425 426 427 428 429 430
  "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 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)

Jan Djärv's avatar
Jan Djärv committed
431 432 433 434
(defgroup dnd nil
  "Handling data from drag and drop."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
435
(defgroup auto-save nil
436
  "Preventing accidental loss of data."
437
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
438 439 440 441 442

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

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

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

YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
452 453 454 455 456 457 458
(defgroup mac nil
  "Mac specific features."
  :link '(custom-manual "(emacs)Mac OS")
  :group 'environment
  :version "22.1"
  :prefix "mac-")

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
;;; Custom mode keymaps

(defvar custom-mode-map
  ;; This keymap should be dense, but a dense keymap would prevent inheriting
  ;; "\r" bindings from the parent map.
  ;; Actually, this misfeature of dense keymaps was fixed on 2001-11-26.
  (let ((map (make-keymap)))
    (set-keymap-parent map widget-keymap)
    (define-key map [remap self-insert-command] 'Custom-no-edit)
    (define-key map "\^m" 'Custom-newline)
    (define-key map " " 'scroll-up)
    (define-key map "\177" 'scroll-down)
    (define-key map "\C-c\C-c" 'Custom-set)
    (define-key map "\C-x\C-s" 'Custom-save)
    (define-key map "q" 'Custom-buffer-done)
    (define-key map "u" 'Custom-goto-parent)
    (define-key map "n" 'widget-forward)
    (define-key map "p" 'widget-backward)
    map)
478
  "Keymap for `Custom-mode'.")
479 480 481 482 483 484 485 486

(defvar custom-mode-link-map
  (let ((map (make-keymap)))
    (set-keymap-parent map custom-mode-map)
    (define-key map [down-mouse-2] nil)
    (define-key map [down-mouse-1] 'mouse-drag-region)
    (define-key map [mouse-2] 'widget-move-and-invoke)
    map)
487
  "Local keymap for links in `Custom-mode'.")
488

489 490 491 492 493 494 495 496
(defvar custom-field-keymap
  (let ((map (copy-keymap widget-field-keymap)))
    (define-key map "\C-c\C-c" 'Custom-set)
    (define-key map "\C-x\C-s" 'Custom-save)
    map)
  "Keymap used inside editable fields in customization buffers.")

(widget-put (get 'editable-field 'widget-type) :keymap custom-field-keymap)
497

Per Abrahamsen's avatar
Per Abrahamsen committed
498 499 500 501
;;; Utilities.

(defun custom-split-regexp-maybe (regexp)
  "If REGEXP is a string, split it to a list at `\\|'.
502
You can get the original back from the result with:
Per Abrahamsen's avatar
Per Abrahamsen committed
503 504 505 506
  (mapconcat 'identity result \"\\|\")

IF REGEXP is not a string, return it unchanged."
  (if (stringp regexp)
507
      (split-string regexp "\\\\|")
Per Abrahamsen's avatar
Per Abrahamsen committed
508 509
    regexp))

Per Abrahamsen's avatar
Per Abrahamsen committed
510
(defun custom-variable-prompt ()
511
  "Prompt for a custom variable, defaulting to the variable at point.
Per Abrahamsen's avatar
Per Abrahamsen committed
512
Return a list suitable for use in `interactive'."
513 514 515 516 517
   (let* ((v (variable-at-point))
	  (default (and (symbolp v) (custom-variable-p v) (symbol-name v)))
	  (enable-recursive-minibuffers t)
	  val)
     (setq val (completing-read
518 519
		(if default (format "Customize variable (default %s): " default)
		  "Customize variable: ")
520
		obarray 'custom-variable-p t nil nil default))
Per Abrahamsen's avatar
Per Abrahamsen committed
521
     (list (if (equal val "")
522 523
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
524

Per Abrahamsen's avatar
Per Abrahamsen committed
525 526 527 528 529 530
(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
531
    (while menu
Per Abrahamsen's avatar
Per Abrahamsen committed
532 533 534 535 536 537 538 539 540 541
      (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
542 543
;;; Unlispify.

Per Abrahamsen's avatar
Per Abrahamsen committed
544
(defvar custom-prefix-list nil
Dave Love's avatar
Dave Love committed
545
  "List of prefixes that should be ignored by `custom-unlispify'.")
Per Abrahamsen's avatar
Per Abrahamsen committed
546 547

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

552 553 554
(defcustom custom-unlispify-remove-prefixes nil
  "Non-nil means remove group prefixes from option names in buffer."
  :group 'custom-menu
555
  :group 'custom-buffer
556 557
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
558
(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
Dave Love's avatar
Dave Love committed
559
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
560 561 562 563 564 565 566
  (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
567
	 (with-current-buffer (get-buffer-create " *Custom-Work*")
Per Abrahamsen's avatar
Per Abrahamsen committed
568 569 570
	   (erase-buffer)
	   (princ symbol (current-buffer))
	   (goto-char (point-min))
571 572 573 574 575 576
	   ;; 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)))
577 578 579 580 581 582
	   (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
583
		       (progn
584 585 586
			 (setq prefixes nil)
			 (delete-region (point-min) (point)))
		     (setq prefixes (cdr prefixes))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
587 588
	   (subst-char-in-region (point-min) (point-max) ?- ?\  t)
	   (capitalize-region (point-min) (point-max))
Dave Love's avatar
Dave Love committed
589
	   (unless no-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
590 591 592 593 594
	     (goto-char (point-max))
	     (insert "..."))
	   (buffer-string)))))

(defcustom custom-unlispify-tag-names t
595
  "Display tag names as words instead of symbols if non-nil."
Per Abrahamsen's avatar
Per Abrahamsen committed
596
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
597 598 599
  :type 'boolean)

(defun custom-unlispify-tag-name (symbol)
Dave Love's avatar
Dave Love committed
600
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
601 602 603 604
  (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
605
  "Add SYMBOL to list of ignored PREFIXES."
Per Abrahamsen's avatar
Per Abrahamsen committed
606 607 608 609
  (cons (or (get symbol 'custom-prefix)
	    (concat (symbol-name symbol) "-"))
	prefixes))

Per Abrahamsen's avatar
Per Abrahamsen committed
610 611 612 613
;;; Guess.

(defcustom custom-guess-name-alist
  '(("-p\\'" boolean)
614
    ("-flag\\'" boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
615 616 617 618 619 620 621 622 623
    ("-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
624
MATCH should be a regexp matching the name of a symbol, and TYPE should
Per Abrahamsen's avatar
Per Abrahamsen committed
625 626
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
627
used.
Per Abrahamsen's avatar
Per Abrahamsen committed
628 629 630 631

This is used for guessing the type of variables not declared with
customize."
  :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
632
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
633

Per Abrahamsen's avatar
Per Abrahamsen committed
634 635 636
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
637

Per Abrahamsen's avatar
Per Abrahamsen committed
638 639 640 641
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
642

Per Abrahamsen's avatar
Per Abrahamsen committed
643 644 645
This is used for guessing the type of variables not declared with
customize."
  :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
646
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
647

Per Abrahamsen's avatar
Per Abrahamsen committed
648 649
(defun custom-guess-type (symbol)
  "Guess a widget suitable for editing the value of SYMBOL.
Dave Love's avatar
Dave Love committed
650
This is done by matching SYMBOL with `custom-guess-name-alist' and
Per Abrahamsen's avatar
Per Abrahamsen committed
651 652 653 654 655 656 657 658 659 660 661 662 663
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
664
	(when doc
Per Abrahamsen's avatar
Per Abrahamsen committed
665 666 667 668 669 670 671
	  (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
672

Per Abrahamsen's avatar
Per Abrahamsen committed
673 674
;;; Sorting.

675
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
676
(defcustom custom-browse-sort-alphabetically nil
677
  "If non-nil, sort customization group alphabetically in `custom-browse'."
Per Abrahamsen's avatar
Per Abrahamsen committed
678 679 680 681 682 683 684 685 686 687 688 689
  :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
690 691 692 693 694
(defcustom custom-browse-only-groups nil
  "If non-nil, show group members only within each customization group."
  :type 'boolean
  :group 'custom-browse)

695
;;;###autoload
696
(defcustom custom-buffer-sort-alphabetically nil
697
  "If non-nil, sort each customization group alphabetically in Custom buffer."
Per Abrahamsen's avatar
Per Abrahamsen committed
698
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
699
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
700

Per Abrahamsen's avatar
Per Abrahamsen committed
701 702 703 704 705 706 707
(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
708
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
709

710
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
711
(defcustom custom-menu-sort-alphabetically nil
712
  "If non-nil, sort each customization group alphabetically in menus."
Per Abrahamsen's avatar
Per Abrahamsen committed
713
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
714
  :group 'custom-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
715

Per Abrahamsen's avatar
Per Abrahamsen committed
716 717 718 719 720 721 722
(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
723 724
  :group 'custom-menu)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
727 728 729 730 731 732 733 734 735
(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))
736
	   (namea (nth 0 a)) (nameb (nth 0 b)))
Per Abrahamsen's avatar
Per Abrahamsen committed
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
       (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
753

Per Abrahamsen's avatar
Per Abrahamsen committed
754 755
;;; Custom Mode Commands.

756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
;; This variable is used by `custom-tool-bar-map', or directly by
;; `custom-buffer-create-internal' if the toolbar is not present and
;; `custom-buffer-verbose-help' is non-nil.

(defvar custom-commands
  '(("Set for current session" Custom-set t
     "Apply all settings in this buffer to the current session"
     "index")
    ("Save for future sessions" Custom-save
     (or custom-file user-init-file)
     "Apply all settings in this buffer and save them for future Emacs sessions."
     "save")
    ("Undo edits" Custom-reset-current t
     "Restore all settings in this buffer to reflect their current values."
     "refresh")
    ("Reset to saved" Custom-reset-saved t
     "Restore all settings in this buffer to their saved values (if any)."
     "undo")
    ("Erase customizations" Custom-reset-standard
     (or custom-file user-init-file)
     "Un-customize all settings in this buffer and save them with standard values."
     "delete")
    ("Help for Customize" Custom-help t
     "Get help for using Customize."
     "help")
    ("Exit" Custom-buffer-done t "Exit Customize." "exit")))

(defun Custom-help ()
  "Read the node on Easy Customization in the Emacs manual."
Per Abrahamsen's avatar
Per Abrahamsen committed
785
  (interactive)
786
  (info "(emacs)Easy Customization"))
Per Abrahamsen's avatar
Per Abrahamsen committed
787

Dave Love's avatar
Dave Love committed
788
(defvar custom-reset-menu
789 790
  '(("Undo Edits" . Custom-reset-current)
    ("Reset to Saved" . Custom-reset-saved)
791
    ("Erase Customizations (use standard values)" . Custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
792 793
  "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
794
Lisp function taking the widget as an element which will be called
Per Abrahamsen's avatar
Per Abrahamsen committed
795 796
when the action is chosen.")

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
(defvar custom-options nil
  "Customization widgets in the current buffer.")

(defun custom-command-apply (fun query &optional strong-query)
  "Call function FUN on all widgets in `custom-options'.
If there is more than one widget, ask user for confirmation using
the query string QUERY, using `y-or-n-p' if STRONG-QUERY is nil,
and `yes-or-no-p' otherwise."
  (if (or (and (= 1 (length custom-options))
	       (memq (widget-type (car custom-options))
		     '(custom-variable custom-face)))
	  (funcall (if strong-query 'yes-or-no-p 'y-or-n-p) query))
      (progn (mapc fun custom-options) t)
    (message "Aborted")
    nil))

(defun Custom-set (&rest ignore)
  "Set the current value of all edited settings in the buffer."
  (interactive)
  (custom-command-apply
   (lambda (child)
     (when (eq (widget-get child :custom-state) 'modified)
       (widget-apply child :custom-set)))
   "Set all values according to this buffer? "))

(defun Custom-save (&rest ignore)
  "Set all edited settings, then save all settings that have been set.
824 825
If a setting was edited and set before, this saves it.  If a
setting was merely edited before, this sets it then saves it."
826
  (interactive)
827 828 829 830 831 832 833 834 835 836
  (when (custom-command-apply
	 (lambda (child)
	   (when (memq (widget-get child :custom-state)
		       '(modified set changed rogue))
	     (widget-apply child :custom-mark-to-save)))
	 "Save all settings in this buffer? " t)
    ;; Save changes to buffer and redraw.
    (custom-save-all)
    (dolist (child custom-options)
      (widget-apply child :custom-state-set-and-redraw))))
837 838

(defun custom-reset (widget &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
839 840
  "Select item from reset menu."
  (let* ((completion-ignore-case t)
841
	 (answer (widget-choose "Reset settings"
Per Abrahamsen's avatar
Per Abrahamsen committed
842 843 844 845 846
				custom-reset-menu
				event)))
    (if answer
	(funcall answer))))

847
(defun Custom-reset-current (&rest ignore)
848
  "Reset all edited settings in the buffer to show their current values."
Per Abrahamsen's avatar
Per Abrahamsen committed
849
  (interactive)
850 851 852 853 854
  (custom-command-apply
   (lambda (widget)
     (if (memq (widget-get widget :custom-state) '(modified changed))
	 (widget-apply widget :custom-reset-current)))
   "Reset all settings' buffer text to show current values? "))
Per Abrahamsen's avatar
Per Abrahamsen committed
855

856
(defun Custom-reset-saved (&rest ignore)
857 858
  "Reset all edited or set settings in the buffer to their saved value.
This also shows the saved values in the buffer."
Per Abrahamsen's avatar
Per Abrahamsen committed
859
  (interactive)
860 861 862 863 864
  (custom-command-apply
   (lambda (widget)
     (if (memq (widget-get widget :custom-state) '(modified set changed rogue))
	 (widget-apply widget :custom-reset-saved)))
   "Reset all settings (current values and buffer text) to saved values? "))
Per Abrahamsen's avatar
Per Abrahamsen committed
865

866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
;; The next two variables are bound to '(t) by `Custom-reset-standard'
;; and `custom-group-reset-standard'.  If these variables are nil, both
;; `custom-variable-reset-standard' and `custom-face-reset-standard'
;; save, reset and redraw the handled widget immediately.  Otherwise,
;; they add the widget to the corresponding list and leave it to
;; `custom-reset-standard-save-and-update' to save, reset and redraw it.
(defvar custom-reset-standard-variables-list nil)
(defvar custom-reset-standard-faces-list nil)

;; The next function was excerpted from `custom-variable-reset-standard'
;; and `custom-face-reset-standard' and is used to avoid calling
;; `custom-save-all' repeatedly (and thus saving settings to file one by
;; one) when erasing all customizations.
(defun custom-reset-standard-save-and-update ()
  "Save settings and redraw after erasing customizations."
  (when (or (and custom-reset-standard-variables-list
		 (not (eq custom-reset-standard-variables-list  '(t))))
	    (and custom-reset-standard-faces-list
		 (not (eq custom-reset-standard-faces-list '(t)))))
    ;; Save settings to file.
    (custom-save-all)
    ;; Set state of and redraw variables.
    (dolist (widget custom-reset-standard-variables-list)
      (unless (eq widget t)
	(widget-put widget :custom-state 'unknown)
	(custom-redraw widget)))
    ;; Set state of and redraw faces.
    (dolist (widget custom-reset-standard-faces-list)
      (unless (eq widget t)
	(let* ((symbol (widget-value widget))
	       (child (car (widget-get widget :children)))
	       (value (get symbol 'face-defface-spec))
	       (comment-widget (widget-get widget :comment-widget)))
	  (put symbol 'face-comment nil)
	  (widget-value-set child
			    (custom-pre-filter-face-spec
			     (list (list t (custom-face-attributes-get
					    symbol nil)))))
	  ;; This call manages the comment visibility
	  (widget-value-set comment-widget "")
	  (custom-face-state-set widget)
	  (custom-redraw-magic widget))))))

909
(defun Custom-reset-standard (&rest ignore)
910
  "Erase all customizations (either current or saved) in current buffer.
911 912
The immediate result is to restore them to their standard values.
This operation eliminates any saved values for the group members,
913
making them as if they had never been customized at all."
Per Abrahamsen's avatar
Per Abrahamsen committed
914
  (interactive)
915 916 917 918 919 920 921 922 923 924 925 926
  ;; Bind these temporarily.
  (let ((custom-reset-standard-variables-list '(t))
	(custom-reset-standard-faces-list '(t)))
    (custom-command-apply
     (lambda (widget)
       (and (or (null (widget-get widget :custom-standard-value))
		(widget-apply widget :custom-standard-value))
	    (memq (widget-get widget :custom-state)
		  '(modified set changed saved rogue))
	    (widget-apply widget :custom-mark-to-reset-standard)))
     "Erase all customizations for settings in this buffer? " t)
    (custom-reset-standard-save-and-update)))
Per Abrahamsen's avatar
Per Abrahamsen committed
927 928 929

;;; The Customize Commands

Dave Love's avatar
Dave Love committed
930
(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
931 932 933 934 935 936 937 938 939
  "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
940 941
`:prompt-value' property of that widget will be used for reading the value.

942
If optional COMMENT argument is non-nil, also prompt for a comment and return
Dave Love's avatar
Dave Love committed
943
it as the third element in the list."
Per Abrahamsen's avatar
Per Abrahamsen committed
944
  (let* ((var (read-variable prompt-var))
Dave Love's avatar
Dave Love committed
945 946
	 (minibuffer-help-form '(describe-variable var))
	 (val
Per Abrahamsen's avatar
Per Abrahamsen committed
947 948 949 950 951 952 953 954
	  (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.
955 956 957
		   (call-interactively `(lambda (arg)
					  (interactive ,prop)
					  arg)))
Per Abrahamsen's avatar
Per Abrahamsen committed
958 959 960 961 962 963 964
		  (type
		   (widget-prompt-value type
					prompt
					(if (boundp var)
					    (symbol-value var))
					(not (boundp var))))
		  (t
Dave Love's avatar
Dave Love committed
965 966 967 968 969
		   (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
970 971

;;;###autoload
972
(defun customize-set-value (variable value &optional comment)
973
  "Set VARIABLE to VALUE, and return VALUE.  VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
974 975 976 977 978

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
979 980 981
`: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
982
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
983 984
				       "Set %s to value: "
				       current-prefix-arg))
985

Dave Love's avatar
Dave Love committed
986
  (cond ((string= comment "")
987
 	 (put variable 'variable-comment nil))
Dave Love's avatar
Dave Love committed
988
 	(comment
989 990
 	 (put variable 'variable-comment comment)))
  (set variable value))
Per Abrahamsen's avatar
Per Abrahamsen committed
991 992

;;;###autoload
Dave Love's avatar
Dave Love committed
993
(defun customize-set-variable (variable value &optional comment)
994 995
  "Set the default for VARIABLE to VALUE, and return VALUE.
VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
996 997 998 999 1000 1001 1002 1003

If VARIABLE has a `custom-set' property, that is used for setting
VARIABLE, otherwise `set-default' is used.

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
1004 1005 1006
`: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
1007
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
1008 1009
				       "Set customized value for %s to: "
				       current-prefix-arg))
1010
  (custom-load-symbol variable)
1011
  (custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
Dave Love's avatar
Dave Love committed
1012 1013
  (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
1014
  (cond ((string= comment "")
Dave Love's avatar
Dave Love committed
1015 1016
 	 (put variable 'variable-comment nil)
 	 (put variable 'customized-variable-comment nil))
Dave Love's avatar
Dave Love committed
1017
 	(comment
Dave Love's avatar
Dave Love committed
1018
 	 (put variable 'variable-comment comment)
1019 1020
 	 (put variable 'customized-variable-comment comment)))
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1021

Per Abrahamsen's avatar
Per Abrahamsen committed
1022
;;;###autoload
1023
(defun customize-save-variable (variable value &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
1024
  "Set the default for VARIABLE to VALUE, and save it for future sessions.
1025 1026
Return VALUE.

Per Abrahamsen's avatar
Per Abrahamsen committed
1027 1028 1029 1030 1031 1032 1033
If VARIABLE has a `custom-set' property, that is used for setting
VARIABLE, otherwise `set-default' is used.

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
1034 1035 1036
`: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
1037
  (interactive (custom-prompt-variable "Set and save variable: "
Dave Love's avatar
Dave Love committed
1038 1039
				       "Set and save value for %s as: "
				       current-prefix-arg))
1040 1041
  (funcall (or (get variable 'custom-set) 'set-default) variable value)
  (put variable 'saved-value (list (custom-quote value)))
1042
  (custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
Dave Love's avatar
Dave Love committed
1043
  (cond ((string= comment "")
1044 1045
 	 (put variable 'variable-comment nil)
 	 (put variable 'saved-variable-comment nil))
Dave Love's avatar
Dave Love committed
1046
 	(comment
1047 1048
 	 (put variable 'variable-comment comment)
 	 (put variable 'saved-variable-comment comment)))
1049 1050
  (put variable 'customized-value nil)
  (put variable 'customized-variable-comment nil)
1051 1052
  (custom-save-all)
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1053

Per Abrahamsen's avatar
Per Abrahamsen committed
1054
;;;###autoload
1055 1056 1057 1058 1059 1060
(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
1061
  (customize-group 'emacs))
1062

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
;;;###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)))

1083 1084 1085 1086 1087 1088 1089 1090 1091
(defun customize-read-group ()
  (let ((completion-ignore-case t))
    (completing-read "Customize group (default emacs): "
                     obarray
                     (lambda (symbol)
                       (or (and (get symbol 'custom-loads)
                                (not (get symbol 'custom-autoload)))
                           (get symbol 'custom-group)))
                     t)))
1092

1093
;;;###autoload
1094
(defun customize-group (&optional group)
1095
  "Customize GROUP, which must be a customization group."
1096
  (interactive (list (customize-read-group)))
1097 1098 1099 1100
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
1101 1102 1103
  (let ((name (format "*Customize Group: %s*"
		      (custom-unlispify-tag-name group))))
    (if (get-buffer name)
1104 1105 1106 1107 1108 1109
        (pop-to-buffer name)
      (custom-buffer-create
       (list (list group 'custom-group))
       name
       (concat " for group "
               (custom-unlispify-tag-name group))))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1110

Per Abrahamsen's avatar
Per Abrahamsen committed
1111
;;;###autoload
1112 1113
(defun customize-group-other-window (&optional group)
  "Customize GROUP, which must be a customization group, in another window."
1114 1115 1116 1117 1118
  (interactive (list (customize-read-group)))
  (let ((pop-up-windows t)
        (same-window-buffer-names nil)
        (same-window-regexps nil))
    (customize-group group)))
Per Abrahamsen's avatar
Per Abrahamsen committed
1119

Per Abrahamsen's avatar
Per Abrahamsen committed
1120 1121
;;;###autoload
(defalias 'customize-variable 'customize-option)
1122

Per Abrahamsen's avatar
Per Abrahamsen committed
1123
;;;###autoload
1124 1125
(defun customize-option (symbol)
  "Customize SYMBOL, which must be a user option variable."
Per Abrahamsen's avatar
Per Abrahamsen committed
1126
  (interactive (custom-variable-prompt))
1127 1128
  (unless symbol
    (error "No variable specified"))
1129 1130 1131 1132 1133 1134
  (let ((basevar (indirect-variable symbol)))
    (custom-buffer-create (list (list basevar 'custom-variable))
			  (format "*Customize Option: %s*"
				  (custom-unlispify-tag-name basevar)))
    (unless (eq symbol basevar)
      (message "`%s' is an alias for `%s'" symbol basevar))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1135

1136 1137 1138 1139 1140 1141 1142 1143
;;;###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))
1144 1145
  (unless symbol
    (error "No variable specified"))
1146 1147 1148 1149 1150 1151
  (let ((basevar (indirect-variable symbol)))
    (custom-buffer-create-other-window
     (list (list basevar 'custom-variable))
     (format "*Customize Option: %s*" (custom-unlispify-tag-name basevar)))
    (unless (eq symbol basevar)
      (message "`%s' is an alias for `%s'" symbol basevar))))
1152

1153
(defvar customize-changed-options-previous-release "21.1"
1154 1155
  "Version for `customize-changed-options' to refer back to by default.")

1156 1157 1158
;; Packages will update this variable, so make it available.
;;;###autoload
(defvar customize-package-emacs-version-alist nil
1159 1160 1161 1162 1163
  "Alist mapping versions of a package to Emacs versions.
We use this for packages that have their own names, but are released
as part of Emacs itself.

Each elements looks like this:
1164 1165 1166

     (PACKAGE (PVERSION . EVERSION)...)

1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
Here PACKAGE is the name of a package, as a symbol.  After
PACKAGE come one or more elements, each associating a
package version PVERSION with the first Emacs version
EVERSION in which it (or a subsequent version of PACKAGE)
was first released.  Both PVERSION and EVERSION are strings.
PVERSION should be a string that this package used in
the :package-version keyword for `defcustom', `defgroup',
and `defface'.

For example, the MH-E package updates this alist as follows:
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187

     (add-to-list 'customize-package-emacs-version-alist
                  '(MH-E (\"6.0\" . \"22.1\") (\"6.1\" . \"22.1\")
                         (\"7.0\" . \"22.1\") (\"7.1\" . \"22.1\")
                         (\"7.2\" . \"22.1\") (\"7.3\" . \"22.1\")
                         (\"7.4\" . \"22.1\") (\"8.0\" . \"22.1\")))

The value of PACKAGE needs to be unique and it needs to match the
PACKAGE value appearing in the :package-version keyword.  Since
the user might see the value in a error message, a good choice is
the official name of the package, such as MH-E or Gnus.")
1188

1189 1190 1191
;;;###autoload
(defalias 'customize-changed 'customize-changed-options)

Per Abrahamsen's avatar
Per Abrahamsen committed
1192
;;;###autoload
1193
(defun customize-changed-options (&optional since-version)
1194
  "Customize all settings whose meanings have changed in Emacs itself.
1195
This includes new user option variables and faces, and new
1196 1197
customization groups, as well as older options and faces whose meanings
or default values have changed since the previous major Emacs release.
1198

1199 1200
With argument SINCE-VERSION (a string), customize all settings
that were added or redefined since that version."
1201