cus-edit.el 167 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-2016 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 <http://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)
Per Abrahamsen's avatar
Per Abrahamsen committed
155
(put 'custom-define-hook 'standard-value '(nil))
Per Abrahamsen's avatar
Per Abrahamsen committed
156 157
(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)

Per Abrahamsen's avatar
Per Abrahamsen committed
158 159 160 161 162 163 164 165 166 167 168
;;; 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 178 179 180 181 182 183 184 185
(defgroup convenience nil
  "Convenience features for faster editing."
  :group 'emacs)

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

(defgroup wp nil
  "Support for editing text files."
  :tag "Text"
  :group 'emacs)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
186 187 188
(defgroup abbrev nil
  "Abbreviation handling, typing shortcuts, macros."
  :tag "Abbreviations"
Chong Yidong's avatar
Chong Yidong committed
189
  :group 'convenience)
Per Abrahamsen's avatar
Per Abrahamsen committed
190 191 192 193 194 195 196

(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
197
  :link '(custom-manual "(emacs)Emulation")
Per Abrahamsen's avatar
Per Abrahamsen committed
198 199 200 201 202 203 204 205
  :group 'editing)

(defgroup mouse nil
  "Mouse support."
  :group 'editing)

(defgroup outlines nil
  "Support for hierarchical outlining."
Chong Yidong's avatar
Chong Yidong committed
206
  :group 'wp)
Per Abrahamsen's avatar
Per Abrahamsen committed
207 208 209 210 211

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

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

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

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

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

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

(defgroup c nil
  "Support for the C language and related languages."
237
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Dave Love's avatar
Dave Love committed
238
  :link '(custom-manual "(ccmode)")
Per Abrahamsen's avatar
Per Abrahamsen committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
  :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
258
  "Reading and posting to newsgroups."
Dave Love's avatar
Dave Love committed
259
  :link '(custom-manual "(gnus)")
Per Abrahamsen's avatar
Per Abrahamsen committed
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
  :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
Chong Yidong's avatar
Chong Yidong committed
292
  "Support for interfacing with miscellaneous hardware."
Per Abrahamsen's avatar
Per Abrahamsen committed
293 294 295 296 297 298 299
  :group 'environment)

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

(defgroup unix nil
300
  "Interfaces, assistants, and emulators for UNIX features."
Per Abrahamsen's avatar
Per Abrahamsen committed
301 302 303 304
  :group 'environment)

(defgroup i18n nil
  "Internationalization and alternate character-set support."
Dave Love's avatar
Dave Love committed
305
  :link '(custom-manual "(emacs)International")
Per Abrahamsen's avatar
Per Abrahamsen committed
306 307 308
  :group 'environment
  :group 'editing)

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

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

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

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

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

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

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

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

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

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

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

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

373
(defgroup mode-line nil
374
  "Contents of the mode line."
Per Abrahamsen's avatar
Per Abrahamsen committed
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 411 412 413 414 415 416
  :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
417 418 419 420
(defgroup dnd nil
  "Handling data from drag and drop."
  :group 'environment)

Per Abrahamsen's avatar
Per Abrahamsen committed
421
(defgroup auto-save nil
422
  "Preventing accidental loss of data."
423
  :group 'files)
Per Abrahamsen's avatar
Per Abrahamsen committed
424 425 426 427 428

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

Per Abrahamsen's avatar
Per Abrahamsen committed
429 430
(defgroup mule nil
  "MULE Emacs internationalization."
431
  :group 'i18n)
Per Abrahamsen's avatar
Per Abrahamsen committed
432

Per Abrahamsen's avatar
Per Abrahamsen committed
433 434
(defgroup windows nil
  "Windows within a frame."
Dave Love's avatar
Dave Love committed
435
  :link '(custom-manual "(emacs)Windows")
Per Abrahamsen's avatar
Per Abrahamsen committed
436
  :group 'environment)
Per Abrahamsen's avatar
Per Abrahamsen committed
437

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

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

466 467 468 469 470 471 472 473
(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)
474

Per Abrahamsen's avatar
Per Abrahamsen committed
475 476 477 478
;;; Utilities.

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

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

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

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

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

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

529
(defcustom custom-unlispify-remove-prefixes nil
530 531 532 533
  "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."
534
  :group 'custom-menu
535
  :group 'custom-buffer
536 537
  :type 'boolean)

Per Abrahamsen's avatar
Per Abrahamsen committed
538
(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
Dave Love's avatar
Dave Love committed
539
  "Convert SYMBOL into a menu entry."
Per Abrahamsen's avatar
Per Abrahamsen committed
540 541 542 543 544 545 546
  (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
547
	 (with-current-buffer (get-buffer-create " *Custom-Work*")
Per Abrahamsen's avatar
Per Abrahamsen committed
548 549 550
	   (erase-buffer)
	   (princ symbol (current-buffer))
	   (goto-char (point-min))
551 552 553 554 555 556
	   (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
557
		       (progn
558 559 560
			 (setq prefixes nil)
			 (delete-region (point-min) (point)))
		     (setq prefixes (cdr prefixes))))))
561
	   (subst-char-in-region (point-min) (point-max) ?- ?\s t)
Per Abrahamsen's avatar
Per Abrahamsen committed
562
	   (capitalize-region (point-min) (point-max))
Dave Love's avatar
Dave Love committed
563
	   (unless no-suffix
Per Abrahamsen's avatar
Per Abrahamsen committed
564 565 566 567 568
	     (goto-char (point-max))
	     (insert "..."))
	   (buffer-string)))))

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
584 585 586 587
;;; Guess.

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

Dave Love's avatar
Dave Love committed
598
MATCH should be a regexp matching the name of a symbol, and TYPE should
Per Abrahamsen's avatar
Per Abrahamsen committed
599 600
be a widget suitable for editing the value of that symbol.  The TYPE
of the first entry where MATCH matches the name of the symbol will be
Dave Love's avatar
Dave Love committed
601
used.
Per Abrahamsen's avatar
Per Abrahamsen committed
602 603 604 605

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
612 613 614 615
MATCH should be a regexp matching a documentation string, and TYPE
should be a widget suitable for editing the value of a variable with
that documentation string.  The TYPE of the first entry where MATCH
matches the name of the symbol will be used.
Per Abrahamsen's avatar
Per Abrahamsen committed
616

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

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

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

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

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

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

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
700 701
(defun custom-sort-items (items sort-alphabetically order-groups)
  "Return a sorted copy of ITEMS.
702
ITEMS should be a list of `custom-group' properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
703 704 705 706 707 708
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))
709
	   (namea (nth 0 a)) (nameb (nth 0 b)))
Per Abrahamsen's avatar
Per Abrahamsen committed
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
       (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
726

Per Abrahamsen's avatar
Per Abrahamsen committed
727 728
;;; Custom Mode Commands.

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

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

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

Dave Love's avatar
Dave Love committed
766
(defvar custom-reset-menu
767 768 769
  '(("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
770 771
  "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
772
Lisp function taking the widget as an element which will be called
Per Abrahamsen's avatar
Per Abrahamsen committed
773 774
when the action is chosen.")

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

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

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

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

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

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

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

;;; The Customize Commands

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

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

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

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

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

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

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

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

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

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
;; 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
1061 1062
	      (lambda ()
                (customize-push-and-save list-var elts)))))
1063

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

1073 1074
;;;###autoload
(defun customize-mode (mode)
1075 1076 1077 1078
  "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."