cus-edit.el 170 KB
Newer Older
1
;;; cus-edit.el --- tools for customizing Emacs and Lisp packages -*- lexical-binding:t -*-
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1996-1997, 1999-2020 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
4 5
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6
;; Maintainer: emacs-devel@gnu.org
Per Abrahamsen's avatar
Per Abrahamsen committed
7
;; Keywords: help, faces
8
;; Package: emacs
Per Abrahamsen's avatar
Per Abrahamsen committed
9

10 11
;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
24

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

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

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

;; 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
49
;;    This is the value shown in the widget in a customize buffer.
50 51 52 53 54 55

;; 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
56
;;    cons-cell whose car evaluates to the customized value.
57 58 59 60 61 62

;; 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
63
;;    cons-cell whose car evaluates to the saved value.
64 65 66 67 68 69

;; 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
70
;;    cons-cell whose car evaluates to the standard value.
71 72

;; 5. The "think" value.
Luc Teirlinck's avatar
Luc Teirlinck committed
73 74 75 76

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

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

;; 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
82
;; variable that has one value when Emacs is running under a window
83
;; system, and another value on a tty.  Since the evaluation is only done
Luc Teirlinck's avatar
Luc Teirlinck committed
84
;; when the variable is first initialized, this is only relevant for the
85 86 87 88
;; saved (and standard) values, but affect others values for
;; compatibility.

;; You can see (and modify and save) this unevaluated value by selecting
89
;; "Show Saved Lisp Expression" from the Lisp interface.  This will
90 91 92 93 94 95 96 97 98 99 100 101 102 103
;; 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
104 105

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

;; 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
121
;;    There is no standard value.  This means that the variable was
Luc Teirlinck's avatar
Luc Teirlinck committed
122 123 124 125 126
;;    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
127
;;    `customize-option' non-interactively.
128 129 130 131 132 133 134 135

;; 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
136
;;    option.
137

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

(require 'cus-face)
(require 'wid-edit)
142 143 144

(defvar custom-versions-load-alist)	; from cus-load
(defvar recentf-exclude)		; from recentf.el
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)
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
;;; 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)

169 170 171 172 173 174 175 176 177
(defgroup convenience nil
  "Convenience features for faster editing."
  :group 'emacs)

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

(defgroup wp nil
178 179
  "Support for editing text files.
Use group `text' for this instead.  This group is deprecated."
180 181
  :group 'emacs)

182 183 184 185 186 187
(defgroup text nil
  "Support for editing text files."
  :group 'emacs
  ;; Inherit from deprecated `wp' for compatibility, for now.
  :group 'wp)

188 189 190 191
(defgroup data nil
  "Support for editing binary data files."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
192 193 194
(defgroup abbrev nil
  "Abbreviation handling, typing shortcuts, macros."
  :tag "Abbreviations"
Chong Yidong's avatar
Chong Yidong committed
195
  :group 'convenience)
Per Abrahamsen's avatar
Per Abrahamsen committed
196 197 198 199 200 201 202

(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
203
  :link '(custom-manual "(emacs)Emulation")
Per Abrahamsen's avatar
Per Abrahamsen committed
204 205 206 207 208 209
  :group 'editing)

(defgroup external nil
  "Interfacing to external utilities."
  :group 'emacs)

210 211 212
(defgroup comm nil
  "Communications, networking, and remote access to files."
  :tag "Communication"
Chong Yidong's avatar
Chong Yidong committed
213 214
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
215 216
(defgroup processes nil
  "Process, subshell, compilation, and job control support."
Chong Yidong's avatar
Chong Yidong committed
217
  :group 'external)
Per Abrahamsen's avatar
Per Abrahamsen committed
218 219 220 221 222 223

(defgroup programming nil
  "Support for programming in other languages."
  :group 'emacs)

(defgroup languages nil
224
  "Modes for editing programming languages."
Per Abrahamsen's avatar
Per Abrahamsen committed
225 226 227 228
  :group 'programming)

(defgroup lisp nil
  "Lisp support, including Emacs Lisp."
229
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Per Abrahamsen's avatar
Per Abrahamsen committed
230 231 232 233 234
  :group 'languages
  :group 'development)

(defgroup c nil
  "Support for the C language and related languages."
235
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Dave Love's avatar
Dave Love committed
236
  :link '(custom-manual "(ccmode)")
Per Abrahamsen's avatar
Per Abrahamsen committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
  :group 'languages)

(defgroup tools nil
  "Programming tools."
  :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
256
  "Reading and posting to newsgroups."
Dave Love's avatar
Dave Love committed
257
  :link '(custom-manual "(gnus)")
Per Abrahamsen's avatar
Per Abrahamsen committed
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
  :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 hardware nil
290
  "Support for interfacing with miscellaneous hardware."
Per Abrahamsen's avatar
Per Abrahamsen committed
291 292 293 294 295 296 297
  :group 'environment)

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

(defgroup unix nil
298
  "Interfaces, assistants, and emulators for UNIX features."
Per Abrahamsen's avatar
Per Abrahamsen committed
299 300 301 302
  :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
(defgroup frames nil
  "Support for Emacs frames and window systems."
  :group 'environment)

(defgroup tex nil
  "Code related to the TeX formatter."
317
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
318
  :group 'text)
Per Abrahamsen's avatar
Per Abrahamsen committed
319 320 321 322 323 324

(defgroup faces nil
  "Support for multiple fonts."
  :group 'emacs)

(defgroup help nil
325
  "Support for Emacs help systems."
Per Abrahamsen's avatar
Per Abrahamsen committed
326 327
  :group 'emacs)

Dave Love's avatar
Dave Love committed
328 329 330 331
(defgroup multimedia nil
  "Non-textual support, specifically images and sound."
  :group 'emacs)

Per Abrahamsen's avatar
Per Abrahamsen committed
332 333 334 335 336 337 338
(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
339 340 341 342 343
  :group 'help)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
346 347 348 349 350
(defgroup custom-browse nil
  "Control customize browser."
  :prefix "custom-"
  :group 'customize)

Per Abrahamsen's avatar
Per Abrahamsen committed
351
(defgroup custom-buffer nil
Per Abrahamsen's avatar
Per Abrahamsen committed
352
  "Control customize buffers."
Per Abrahamsen's avatar
Per Abrahamsen committed
353 354 355 356
  :prefix "custom-"
  :group 'customize)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
361 362 363 364 365 366 367
(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
368
  :link '(custom-manual "(emacs)Undo")
Per Abrahamsen's avatar
Per Abrahamsen committed
369 370
  :group 'editing)

371
(defgroup mode-line nil
372
  "Contents of the mode line."
Per Abrahamsen's avatar
Per Abrahamsen committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
  :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 menu nil
  "Input from the menus."
  :group 'environment)

Jan Djärv's avatar
Jan Djärv committed
411 412 413 414
(defgroup dnd nil
  "Handling data from drag and drop."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
415
(defgroup auto-save nil
416
  "Preventing accidental loss of data."
417
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
418 419 420 421 422

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

423 424
(defgroup mule nil
  "MULE Emacs internationalization."
425
  :group 'i18n)
426

Per Abrahamsen's avatar
Per Abrahamsen committed
427 428
(defgroup windows nil
  "Windows within a frame."
Dave Love's avatar
Dave Love committed
429
  :link '(custom-manual "(emacs)Windows")
Per Abrahamsen's avatar
Per Abrahamsen committed
430
  :group 'environment)
Per Abrahamsen's avatar
Per Abrahamsen committed
431

432 433 434 435 436 437 438
;;; Custom mode keymaps

(defvar custom-mode-map
  (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)
439
    (define-key map " " 'scroll-up-command)
440
    (define-key map [?\S-\ ] 'scroll-down-command)
441
    (define-key map "\177" 'scroll-down-command)
442 443 444 445 446 447 448
    (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)
449
  "Keymap for `Custom-mode'.")
450 451 452 453 454 455 456 457

(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)
458
  "Local keymap for links in `Custom-mode'.")
459

460 461 462 463 464 465 466 467
(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)
468

Per Abrahamsen's avatar
Per Abrahamsen committed
469 470 471 472
;;; Utilities.

(defun custom-split-regexp-maybe (regexp)
  "If REGEXP is a string, split it to a list at `\\|'.
473
You can get the original back from the result with:
474
  (mapconcat \\='identity result \"\\|\")
Per Abrahamsen's avatar
Per Abrahamsen committed
475 476 477

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

Per Abrahamsen's avatar
Per Abrahamsen committed
481
(defun custom-variable-prompt ()
482
  "Prompt for a custom variable, defaulting to the variable at point.
Per Abrahamsen's avatar
Per Abrahamsen committed
483
Return a list suitable for use in `interactive'."
484 485 486 487 488
   (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
489 490
		(if default (format "Customize variable (default %s): " default)
		  "Customize variable: ")
491
		obarray 'custom-variable-p t nil nil default))
Per Abrahamsen's avatar
Per Abrahamsen committed
492
     (list (if (equal val "")
493 494
	       (if (symbolp v) v nil)
	     (intern val)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
495

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

Per Abrahamsen's avatar
Per Abrahamsen committed
515
(defvar custom-prefix-list nil
Dave Love's avatar
Dave Love committed
516
  "List of prefixes that should be ignored by `custom-unlispify'.")
Per Abrahamsen's avatar
Per Abrahamsen committed
517 518

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

523
(defcustom custom-unlispify-remove-prefixes nil
524 525 526 527
  "Non-nil means remove group prefixes from option names in buffer.
Discarding prefixes often leads to confusing names for options
and faces in Customize buffers, so do not set this to a non-nil
value unless you are sure you know what it does."
528
  :group 'custom-menu
529
  :group 'custom-buffer
530 531
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
532
(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
Dave Love's avatar
Dave Love committed
533
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
534 535 536 537 538 539 540
  (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
541
	 (with-current-buffer (get-buffer-create " *Custom-Work*")
Per Abrahamsen's avatar
Per Abrahamsen committed
542 543 544
	   (erase-buffer)
	   (princ symbol (current-buffer))
	   (goto-char (point-min))
545 546 547 548 549 550
	   (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
551
		       (progn
552 553 554
			 (setq prefixes nil)
			 (delete-region (point-min) (point)))
		     (setq prefixes (cdr prefixes))))))
555 556 557 558 559
	   (goto-char (point-min))
           ;; Translate characters commonly used as delimiters between
           ;; words in symbols into space; e.g. foo:bar-zot/thing.
	   (while (re-search-forward "[-:/]+" nil t)
	     (replace-match " "))
Per Abrahamsen's avatar
Per Abrahamsen committed
560
	   (capitalize-region (point-min) (point-max))
Dave Love's avatar
Dave Love committed
561
	   (unless no-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
562 563 564 565 566
	     (goto-char (point-max))
	     (insert "..."))
	   (buffer-string)))))

(defcustom custom-unlispify-tag-names t
567
  "Display tag names as words instead of symbols if non-nil."
Per Abrahamsen's avatar
Per Abrahamsen committed
568
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
569 570 571
  :type 'boolean)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
582 583 584 585
;;; Guess.

(defcustom custom-guess-name-alist
  '(("-p\\'" boolean)
586
    ("-flag\\'" boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
587 588 589 590 591 592
    ("-hook\\'" hook)
    ("-face\\'" face)
    ("-file\\'" file)
    ("-function\\'" function)
    ("-functions\\'" (repeat function))
    ("-list\\'" (repeat sexp))
593
    ("-alist\\'" (alist :key-type sexp :value-type sexp)))
Per Abrahamsen's avatar
Per Abrahamsen committed
594 595
  "Alist of (MATCH TYPE).

Dave Love's avatar
Dave Love committed
596
MATCH should be a regexp matching the name of a symbol, and TYPE should
Per Abrahamsen's avatar
Per Abrahamsen committed
597 598
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
599
used.
Per Abrahamsen's avatar
Per Abrahamsen committed
600 601 602 603

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

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
620 621
(defun custom-guess-type (symbol)
  "Guess a widget suitable for editing the value of SYMBOL.
Dave Love's avatar
Dave Love committed
622
This is done by matching SYMBOL with `custom-guess-name-alist' and
Per Abrahamsen's avatar
Per Abrahamsen committed
623 624 625 626 627 628 629
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))
630
      (when (string-match-p (nth 0 current) name)
Per Abrahamsen's avatar
Per Abrahamsen committed
631 632 633
	(setq found (nth 1 current)
	      names nil)))
    (unless found
634
      (let ((doc (documentation-property symbol 'variable-documentation t))
Per Abrahamsen's avatar
Per Abrahamsen committed
635
	    (docs custom-guess-doc-alist))
Dave Love's avatar
Dave Love committed
636
	(when doc
Per Abrahamsen's avatar
Per Abrahamsen committed
637 638 639
	  (while docs
	    (setq current (car docs)
		  docs (cdr docs))
640
	    (when (string-match-p (nth 0 current) doc)
Per Abrahamsen's avatar
Per Abrahamsen committed
641 642 643
	      (setq found (nth 1 current)
		    docs nil))))))
    found))
Per Abrahamsen's avatar
Per Abrahamsen committed
644

645 646
;;; Sorting.

647
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
648
(defcustom custom-browse-sort-alphabetically nil
649
  "If non-nil, sort customization group alphabetically in `custom-browse'."
Per Abrahamsen's avatar
Per Abrahamsen committed
650 651 652 653 654 655 656 657 658 659 660 661
  :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
662 663 664 665 666
(defcustom custom-browse-only-groups nil
  "If non-nil, show group members only within each customization group."
  :type 'boolean
  :group 'custom-browse)

667
;;;###autoload
668 669
(defcustom custom-buffer-sort-alphabetically t
  "Whether to sort customization groups alphabetically in Custom buffer."
Per Abrahamsen's avatar
Per Abrahamsen committed
670
  :type 'boolean
671 672
  :group 'custom-buffer
  :version "24.1")
673

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

683
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
684
(defcustom custom-menu-sort-alphabetically nil
685
  "If non-nil, sort each customization group alphabetically in menus."
Per Abrahamsen's avatar
Per Abrahamsen committed
686
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
687
  :group 'custom-menu)
688

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

Per Abrahamsen's avatar
Per Abrahamsen committed
698 699
(defun custom-sort-items (items sort-alphabetically order-groups)
  "Return a sorted copy of ITEMS.
700
ITEMS should be a list of `custom-group' properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
701 702 703 704 705 706
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)))))))
724

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

727
;; This variable is used by `custom-tool-bar-map', or directly by
728
;; `custom-buffer-create-internal' if `custom-buffer-verbose-help' is non-nil.
729 730

(defvar custom-commands
731
  '((" Apply " Custom-set t
732
     "Apply settings (for the current session only)."
733 734
     "index"
     "Apply")
735
    (" Apply and Save " Custom-save
736
     (or custom-file user-init-file)
737
     "Apply settings and save for future sessions."
738 739
     "save"
     "Save")
740 741
    (" Undo Edits " Custom-reset-current t
     "Restore customization buffer to reflect existing settings."
742 743
     "refresh"
     "Undo")
744 745
    (" Reset Customizations " Custom-reset-saved t
     "Undo any settings applied only for the current session."
746 747
     "undo"
     "Reset")
748
    (" Erase Customizations " Custom-reset-standard
749
     (or custom-file user-init-file)
750
     "Un-customize settings in this and future sessions."
751 752
     "delete"
     "Uncustomize")
753
    (" Help for Customize " Custom-help t
754
     "Get help for using Customize."
755 756
     "help"
     "Help")
757
    (" Exit " Custom-buffer-done t "Exit Customize." "exit" "Exit")))
758 759 760

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

Dave Love's avatar
Dave Love committed
764
(defvar custom-reset-menu
765 766 767
  '(("Undo Edits in Customization Buffer" . Custom-reset-current)
    ("Revert This Session's Customizations" . Custom-reset-saved)
    ("Erase Customizations" . Custom-reset-standard))
Per Abrahamsen's avatar
Per Abrahamsen committed
768 769
  "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
770
Lisp function taking the widget as an element which will be called
Per Abrahamsen's avatar
Per Abrahamsen committed
771 772
when the action is chosen.")

773 774 775 776 777 778 779
(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,
780 781
and `yes-or-no-p' otherwise.  Return non-nil if the functionality
has been executed, nil otherwise."
782 783 784 785 786 787 788 789
  (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))

790
(defun Custom-set (&rest _ignore)
791 792 793 794 795 796 797 798
  "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? "))

799
(defun Custom-save (&rest _ignore)
800
  "Set all edited settings, then save all settings that have been set.
801 802
If a setting was edited and set before, this saves it.  If a
setting was merely edited before, this sets it then saves it."
803
  (interactive)
804 805 806 807 808 809 810 811 812 813
  (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))))
814

815
(defun custom-reset (_widget &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
816 817
  "Select item from reset menu."
  (let* ((completion-ignore-case t)
818
	 (answer (widget-choose "Reset settings"
Per Abrahamsen's avatar
Per Abrahamsen committed
819 820 821 822 823
				custom-reset-menu
				event)))
    (if answer
	(funcall answer))))

824
(defun Custom-reset-current (&rest _ignore)
825
  "Reset all edited settings in the buffer to show their current values."
Per Abrahamsen's avatar
Per Abrahamsen committed
826
  (interactive)
827 828 829 830 831
  (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
832

833
(defun Custom-reset-saved (&rest _ignore)
834 835
  "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
836
  (interactive)
837 838 839 840 841
  (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
842

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
;; 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)))
	       (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))))))

885
(defun Custom-reset-standard (&rest _ignore)
886
  "Erase all customizations (either current or saved) in current buffer.
887 888
The immediate result is to restore them to their standard values.
This operation eliminates any saved values for the group members,
889
making them as if they had never been customized at all."
Per Abrahamsen's avatar
Per Abrahamsen committed
890
  (interactive)
891 892 893
  ;; Bind these temporarily.
  (let ((custom-reset-standard-variables-list '(t))
	(custom-reset-standard-faces-list '(t)))
894 895 896 897 898 899 900 901
    (if (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)))
	 "The settings will revert to their default values, in this
902
and future sessions.  Really erase customizations? " t)
903
	(custom-reset-standard-save-and-update))))
Per Abrahamsen's avatar
Per Abrahamsen committed
904 905 906

;;; The Customize Commands

Dave Love's avatar
Dave Love committed
907
(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
908 909 910 911 912 913 914 915 916
  "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
917
`:prompt-value' property of that widget will be used for reading the value.
918
If the variable also has a `custom-get' property, that is used for finding
919
the current value of the variable, otherwise `symbol-value' is used.
Dave Love's avatar
Dave Love committed
920

921
If optional COMMENT argument is non-nil, also prompt for a comment and return
Dave Love's avatar
Dave Love committed
922
it as the third element in the list."
Per Abrahamsen's avatar
Per Abrahamsen committed
923
  (let* ((var (read-variable prompt-var))
924
	 (minibuffer-help-form `(describe-variable ',var))
Dave Love's avatar
Dave Love committed
925
	 (val
Per Abrahamsen's avatar
Per Abrahamsen committed
926 927 928 929 930 931 932 933
	  (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.
934 935 936
		   (call-interactively `(lambda (arg)
					  (interactive ,prop)
					  arg)))
Per Abrahamsen's avatar
Per Abrahamsen committed
937 938 939 940
		  (type
		   (widget-prompt-value type
					prompt
					(if (boundp var)
941 942
                                            (funcall
                                             (or (get var 'custom-get) 'symbol-value)
943
                                             var))
Per Abrahamsen's avatar
Per Abrahamsen committed
944 945
					(not (boundp var))))
		  (t
Dave Love's avatar
Dave Love committed
946 947 948 949 950
		   (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
951 952

;;;###autoload
953
(defun customize-set-value (variable value &optional comment)
954
  "Set VARIABLE to VALUE, and return VALUE.  VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
955 956 957 958 959

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
960 961 962
`: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
963
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
964 965
				       "Set %s to value: "
				       current-prefix-arg))
966

Dave Love's avatar
Dave Love committed
967
  (cond ((string= comment "")
968
 	 (put variable 'variable-comment nil))
Dave Love's avatar
Dave Love committed
969
 	(comment
970 971
 	 (put variable 'variable-comment comment)))
  (set variable value))
Per Abrahamsen's avatar
Per Abrahamsen committed
972 973

;;;###autoload
Dave Love's avatar
Dave Love committed
974
(defun customize-set-variable (variable value &optional comment)
975 976
  "Set the default for VARIABLE to VALUE, and return VALUE.
VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
977 978 979 980 981 982 983 984

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
985 986 987
`: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
988
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
989 990
				       "Set customized value for %s to: "
				       current-prefix-arg))
991
  (custom-load-symbol variable)
992
  (custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
993
  (funcall (or (get variable 'custom-set) #'set-default) variable value)
Dave Love's avatar
Dave Love committed
994
  (put variable 'customized-value (list (custom-quote value)))
Dave Love's avatar
Dave Love committed
995
  (cond ((string= comment "")
Dave Love's avatar
Dave Love committed
996 997
 	 (put variable 'variable-comment nil)
 	 (put variable 'customized-variable-comment nil))
Dave Love's avatar
Dave Love committed
998
 	(comment
Dave Love's avatar
Dave Love committed
999
 	 (put variable 'variable-comment comment)
1000 1001
 	 (put variable 'customized-variable-comment comment)))
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1002

Per Abrahamsen's avatar
Per Abrahamsen committed
1003
;;;###autoload
1004
(defun customize-save-variable (variable value &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
1005
  "Set the default for VARIABLE to VALUE, and save it for future sessions.
1006 1007
Return VALUE.

Per Abrahamsen's avatar
Per Abrahamsen committed
1008 1009 1010 1011 1012 1013 1014
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
1015 1016 1017
`: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
1018
  (interactive (custom-prompt-variable "Set and save variable: "
Dave Love's avatar
Dave Love committed
1019 1020
				       "Set and save value for %s as: "
				       current-prefix-arg))
1021 1022
  (funcall (or (get variable 'custom-set) 'set-default) variable value)
  (put variable 'saved-value (list (custom-quote value)))
1023
  (custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
Dave Love's avatar
Dave Love committed
1024
  (cond ((string= comment "")
1025 1026
 	 (put variable 'variable-comment nil)
 	 (put variable 'saved-variable-comment nil))
Dave Love's avatar
Dave Love committed
1027
 	(comment
1028 1029
 	 (put variable 'variable-comment comment)
 	 (put variable 'saved-variable-comment comment)))
1030 1031
  (put variable 'customized-value nil)
  (put variable 'customized-variable-comment nil)
1032 1033 1034 1035 1036
  (if (custom-file t)
      (custom-save-all)
    (message "Setting `%s' temporarily since \"emacs -q\" would overwrite customizations"
	     variable)
    (set variable value))
1037
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
1038

1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
;; Some parts of Emacs might prompt the user to save customizations,
;; during startup before customizations are loaded.  This function
;; handles this corner case by avoiding calling `custom-save-variable'
;; too early, which could wipe out existing customizations.

;;;###autoload
(defun customize-push-and-save (list-var elts)
  "Add ELTS to LIST-VAR and save for future sessions, safely.
ELTS should be a list.  This function adds each entry to the
value of LIST-VAR using `add-to-list'.

If Emacs is initialized, call `customize-save-variable' to save
the resulting list value now.  Otherwise, add an entry to
`after-init-hook' to save it after initialization."
  (dolist (entry elts)
    (add-to-list list-var entry))
  (if after-init-time
      (let ((coding-system-for-read nil))
	(customize-save-variable list-var (eval list-var)))
    (add-hook 'after-init-hook
1059 1060
	      (lambda ()
                (customize-push-and-save list-var elts)))))
1061

Per Abrahamsen's avatar
Per Abrahamsen committed
1062
;;;###autoload
1063 1064 1065 1066 1067 1068
(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
1069
  (customize-group 'emacs))
1070

1071 1072
;;;###autoload
(defun customize-mode (mode)
1073 1074 1075 1076
  "Customize options related to a major or minor mode.
By default the current major mode is used.  With a prefix
argument or if the current major mode has no known group, prompt
for the MODE to customize."
1077 1078 1079 1080 1081 1082 1083 1084
  (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
1085 1086
			      (format "Mode (default %s): " major-mode)
			    "Mode: ")
1087 1088 1089 1090 1091
			  obarray
			  'custom-group-of-mode
			  t nil nil (if group (symbol-name major-mode))))))))
  (customize-group (custom-group-of-mode mode)))

1092 1093 1094 1095 1096 1097 1098 1099 1100
(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)))
1101

1102
;;;###autoload
1103 1104 1105
(defun customize-group (&optional group other-window)
  "Customize GROUP, which must be a customization group.
If OTHER-WINDOW is non-nil, display in another window."
1106
  (interactive (list (customize-read-group)))
1107 1108 1109 1110
  (when (stringp group)
    (if (string-equal "" group)
	(setq group 'emacs)
      (setq group (intern group))))
1111 1112
  (let ((name (format "*Customize Group: %s*"
		      (custom-unlispify-tag-name group))))
1113 1114
    (cond
     ((null (get-buffer name))
1115 1116 1117 1118 1119 1120
      (funcall (if other-window
		   'custom-buffer-create-other-window
		 'custom-buffer-create)
	       (list (list group 'custom-group))
	       name
	       (concat " for group "
1121 1122 1123 1124 1125
		       (custom-unlispify-tag-name group))))
     (other-window
      (switch-to-buffer-other-window name))
     (t
      (pop-to-buffer-same-window name)))))
Per Abrahamsen's avatar
Per Abrahamsen committed
1126

Per Abrahamsen's avatar
Per Abrahamsen committed
1127
;;;###autoload
1128 1129
(defun customize-group-other-window (&optional group)
  "Customize GROUP, which must be a customization group, in another window."
1130
  (interactive (list (customize-read-group)))
1131
  (customize-group group t))
Per Abrahamsen's avatar
Per Abrahamsen committed
1132

Per Abrahamsen's avatar
Per Abrahamsen committed
1133 1134
;;;###autoload
(defalias 'customize-variable 'customize-option)
1135

Per Abrahamsen's avatar
Per Abrahamsen committed
1136
;;;###autoload
1137
(defun customize-option (symbol)
1138
  "Customize SYMBOL, which must be a user option."
Per Abrahamsen's avatar
Per Abrahamsen committed
1139
  (interactive (custom-variable-prompt))
1140 1141
  (unless symbol
    (error "No variable specified"))
1142 1143 1144 1145 1146 1147
  (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
1148

1149 1150 1151 1152 1153
;;;###autoload
(defalias 'customize-variable-other-window 'customize-option-other-window)

;;;###autoload
(defun customize-option-other-window (symbol)
1154
  "Customize SYMBOL, which must be a user option.
1155 1156
Show the buffer in another window, but don't select it."
  (interactive (custom-variable-prompt))
1157 1158
  (unless symbol
    (error "No variable specified"))
1159 1160 1161 1162 1163 1164
  (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))))
1165

1166
(defvar customize-changed-options-previous-release "26.3"
1167 1168
  "Version for `customize-changed-options' to refer back to by default.")

1169 1170 1171
;; Packages will update this variable, so make it available.
;;;###autoload
(defvar customize-package-emacs-version-alist nil
1172 1173 1174 1175 1176
  "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:
1177 1178 1179

     (PACKAGE (PVERSION . EVERSION)...)

1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
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:
1190

Paul Eggert's avatar
Paul Eggert committed
1191 1192
     (add-to-list \\='customize-package-emacs-version-alist
                  \\='(MH-E (\"6.0\" . \"22.1\") (\"6.1\" . \"22.1\")
1193 1194 1195 1196 1197 1198
                         (\"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
1199
the user might see the value in an error message, a good choice is
1200
the official name of the package, such as MH-E or Gnus.")
1201

1202 1203 1204
;;;###autoload
(defalias 'customize-changed 'customize-changed-options)

Per Abrahamsen's avatar
Per Abrahamsen committed
1205
;;;###autoload
1206
(defun customize-changed-options (&optional since-version)
1207
  "Customize all settings whose meanings have changed in Emacs itself.
1208 1209 1210 1211
This includes new user options and faces, and new customization
groups, as well as older options and faces whose meanings or
default values have changed since the previous major Emacs
release.
1212

1213 1214
With argument SINCE-VERSION (a string), customize all settings
that were added or redefined since that version."
1215

1216 1217 1218 1219 1220
  (interactive
   (list
    (read-from-minibuffer
     (format "Customize options changed, since version (default %s): "
	     customize-changed-options-previous-release))))
1221
  (if (equal since-version "")
1222 1223 1224 1225 1226
      (setq since-version nil)
    (unless (condition-case nil
		(numberp (read since-version))
	      (error nil))
      (signal 'wrong-type-argument (list 'numberp since-version))))
1227 1228
  (unless since-version
    (setq since-version customize-changed-options-previous-release))
1229 1230 1231 1232 1233

  ;; 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)
1234 1235 1236
    (if (customize-version-lessp since-version (car elt))
	(dolist (load (cdr elt))
	  (custom-add-load 'custom-versions-load-alist load))))
1237 1238 1239 1240 1241 1242
  (custom-load-symbol 'custom-versions-load-alist)
  (put 'custom-versions-load-alist 'custom-loads nil)

  (let (found)
    (mapatoms
     (lambda (symbol)
1243 1244 1245 1246 1247 1248
        (let* ((package-version (get symbol 'custom-package-version))
               (version
                (or (and package-version
                         (customize-package-emacs-version symbol
                                                          package-version))
                    (get symbol 'custom-version))))
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
	 (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 (<