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
  :group 'editing)

(defgroup outlines nil
  "Support for hierarchical outlining."
Chong Yidong's avatar
Chong Yidong committed
202
  :group 'wp)
Per Abrahamsen's avatar
Per Abrahamsen committed
203 204 205 206 207

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

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

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

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

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

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

(defgroup c nil
  "Support for the C language and related languages."
233
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Dave Love's avatar
Dave Love committed
234
  :link '(custom-manual "(ccmode)")
Per Abrahamsen's avatar
Per Abrahamsen committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
  :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
254
  "Reading and posting to newsgroups."
Dave Love's avatar
Dave Love committed
255
  :link '(custom-manual "(gnus)")
Per Abrahamsen's avatar
Per Abrahamsen committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
  :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
288
  "Support for interfacing with miscellaneous hardware."
Per Abrahamsen's avatar
Per Abrahamsen committed
289 290 291 292 293 294 295
  :group 'environment)

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

(defgroup unix nil
296
  "Interfaces, assistants, and emulators for UNIX features."
Per Abrahamsen's avatar
Per Abrahamsen committed
297 298 299 300
  :group 'environment)

(defgroup i18n nil
  "Internationalization and alternate character-set support."
Dave Love's avatar
Dave Love committed
301
  :link '(custom-manual "(emacs)International")
Per Abrahamsen's avatar
Per Abrahamsen committed
302 303 304
  :group 'environment
  :group 'editing)

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

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

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

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

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

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

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

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

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

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

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

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

369
(defgroup mode-line nil
370
  "Contents of the mode line."
Per Abrahamsen's avatar
Per Abrahamsen committed
371 372 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
  :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
409 410 411 412
(defgroup dnd nil
  "Handling data from drag and drop."
  :group 'environment)

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
421 422
(defgroup mule nil
  "MULE Emacs internationalization."
423
  :group 'i18n)
Per Abrahamsen's avatar
Per Abrahamsen committed
424

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

430 431 432 433 434 435 436
;;; 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)
437
    (define-key map " " 'scroll-up-command)
438
    (define-key map [?\S-\ ] 'scroll-down-command)
439
    (define-key map "\177" 'scroll-down-command)
440 441 442 443 444 445 446
    (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)
447
  "Keymap for `Custom-mode'.")
448 449 450 451 452 453 454 455

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
467 468 469 470
;;; Utilities.

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

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

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

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

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

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

521
(defcustom custom-unlispify-remove-prefixes nil
522 523 524 525
  "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."
526
  :group 'custom-menu
527
  :group 'custom-buffer
528 529
  :type 'boolean)

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

(defcustom custom-unlispify-tag-names t
561
  "Display tag names as words instead of symbols if non-nil."
Per Abrahamsen's avatar
Per Abrahamsen committed
562
  :group 'custom-buffer
Per Abrahamsen's avatar
Per Abrahamsen committed
563 564 565
  :type 'boolean)

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

Per Abrahamsen's avatar
Per Abrahamsen committed
576 577 578 579
;;; Guess.

(defcustom custom-guess-name-alist
  '(("-p\\'" boolean)
580
    ("-flag\\'" boolean)
Per Abrahamsen's avatar
Per Abrahamsen committed
581 582 583 584 585 586
    ("-hook\\'" hook)
    ("-face\\'" face)
    ("-file\\'" file)
    ("-function\\'" function)
    ("-functions\\'" (repeat function))
    ("-list\\'" (repeat sexp))
587
    ("-alist\\'" (alist :key-type sexp :value-type sexp)))
Per Abrahamsen's avatar
Per Abrahamsen committed
588 589
  "Alist of (MATCH TYPE).

Dave Love's avatar
Dave Love committed
590
MATCH should be a regexp matching the name of a symbol, and TYPE should
Per Abrahamsen's avatar
Per Abrahamsen committed
591 592
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
593
used.
Per Abrahamsen's avatar
Per Abrahamsen committed
594 595 596 597

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

Per Abrahamsen's avatar
Per Abrahamsen committed
600 601 602
(defcustom custom-guess-doc-alist
  '(("\\`\\*?Non-nil " boolean))
  "Alist of (MATCH TYPE).
Per Abrahamsen's avatar
Per Abrahamsen committed
603

Per Abrahamsen's avatar
Per Abrahamsen committed
604 605 606 607
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
608

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

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

Per Abrahamsen's avatar
Per Abrahamsen committed
639 640
;;; Sorting.

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

661
;;;###autoload
662 663
(defcustom custom-buffer-sort-alphabetically t
  "Whether to sort customization groups alphabetically in Custom buffer."
Per Abrahamsen's avatar
Per Abrahamsen committed
664
  :type 'boolean
665 666
  :group 'custom-buffer
  :version "24.1")
Per Abrahamsen's avatar
Per Abrahamsen committed
667

Per Abrahamsen's avatar
Per Abrahamsen committed
668 669 670 671 672 673 674
(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
675
  :group 'custom-buffer)
Per Abrahamsen's avatar
Per Abrahamsen committed
676

677
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
678
(defcustom custom-menu-sort-alphabetically nil
679
  "If non-nil, sort each customization group alphabetically in menus."
Per Abrahamsen's avatar
Per Abrahamsen committed
680
  :type 'boolean
Per Abrahamsen's avatar
Per Abrahamsen committed
681
  :group 'custom-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
682

Per Abrahamsen's avatar
Per Abrahamsen committed
683 684 685 686 687 688 689
(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
690 691
  :group 'custom-menu)

Per Abrahamsen's avatar
Per Abrahamsen committed
692 693
(defun custom-sort-items (items sort-alphabetically order-groups)
  "Return a sorted copy of ITEMS.
694
ITEMS should be a list of `custom-group' properties.
Per Abrahamsen's avatar
Per Abrahamsen committed
695 696 697 698 699 700
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))
701
	   (namea (nth 0 a)) (nameb (nth 0 b)))
Per Abrahamsen's avatar
Per Abrahamsen committed
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
       (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
718

Per Abrahamsen's avatar
Per Abrahamsen committed
719 720
;;; Custom Mode Commands.

721
;; This variable is used by `custom-tool-bar-map', or directly by
722
;; `custom-buffer-create-internal' if `custom-buffer-verbose-help' is non-nil.
723 724

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

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

Dave Love's avatar
Dave Love committed
758
(defvar custom-reset-menu
759 760 761
  '(("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
762 763
  "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
764
Lisp function taking the widget as an element which will be called
Per Abrahamsen's avatar
Per Abrahamsen committed
765 766
when the action is chosen.")

767 768 769 770 771 772 773
(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,
774 775
and `yes-or-no-p' otherwise.  Return non-nil if the functionality
has been executed, nil otherwise."
776 777 778 779 780 781 782 783
  (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))

784
(defun Custom-set (&rest _ignore)
785 786 787 788 789 790 791 792
  "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? "))

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

809
(defun custom-reset (_widget &optional event)
Per Abrahamsen's avatar
Per Abrahamsen committed
810 811
  "Select item from reset menu."
  (let* ((completion-ignore-case t)
812
	 (answer (widget-choose "Reset settings"
Per Abrahamsen's avatar
Per Abrahamsen committed
813 814 815 816 817
				custom-reset-menu
				event)))
    (if answer
	(funcall answer))))

818
(defun Custom-reset-current (&rest _ignore)
819
  "Reset all edited settings in the buffer to show their current values."
Per Abrahamsen's avatar
Per Abrahamsen committed
820
  (interactive)
821 822 823 824 825
  (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
826

827
(defun Custom-reset-saved (&rest _ignore)
828 829
  "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
830
  (interactive)
831 832 833 834 835
  (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
836

837 838 839 840 841 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
;; 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))))))

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

;;; The Customize Commands

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

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

;;;###autoload
947
(defun customize-set-value (variable value &optional comment)
948
  "Set VARIABLE to VALUE, and return VALUE.  VALUE is a Lisp object.
Per Abrahamsen's avatar
Per Abrahamsen committed
949 950 951 952 953

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
954 955 956
`: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
957
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
958 959
				       "Set %s to value: "
				       current-prefix-arg))
960

Dave Love's avatar
Dave Love committed
961
  (cond ((string= comment "")
962
 	 (put variable 'variable-comment nil))
Dave Love's avatar
Dave Love committed
963
 	(comment
964 965
 	 (put variable 'variable-comment comment)))
  (set variable value))
Per Abrahamsen's avatar
Per Abrahamsen committed
966 967

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

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
979 980 981
`:prompt-value' property of that widget will be used for reading the value.

If given a prefix (or a COMMENT argument), also prompt for a comment."
Per Abrahamsen's avatar
Per Abrahamsen committed
982
  (interactive (custom-prompt-variable "Set variable: "
Dave Love's avatar
Dave Love committed
983 984
				       "Set customized value for %s to: "
				       current-prefix-arg))
985
  (custom-load-symbol variable)
986
  (custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
Dave Love's avatar
Dave Love committed
987 988
  (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
989
  (cond ((string= comment "")
Dave Love's avatar
Dave Love committed
990 991
 	 (put variable 'variable-comment nil)
 	 (put variable 'customized-variable-comment nil))
Dave Love's avatar
Dave Love committed
992
 	(comment
Dave Love's avatar
Dave Love committed
993
 	 (put variable 'variable-comment comment)
994 995
 	 (put variable 'customized-variable-comment comment)))
  value)
Per Abrahamsen's avatar
Per Abrahamsen committed
996

Per Abrahamsen's avatar
Per Abrahamsen committed
997
;;;###autoload
998
(defun customize-save-variable (variable value &optional comment)
Per Abrahamsen's avatar
Per Abrahamsen committed
999
  "Set the default for VARIABLE to VALUE, and save it for future sessions.
1000 1001
Return VALUE.

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

1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
;; 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
1053 1054
	      (lambda ()
                (customize-push-and-save list-var elts)))))
1055

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

1065 1066
;;;###autoload
(defun customize-mode (mode)
1067 1068 1069 1070
  "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."
1071 1072 1073 1074 1075 1076 1077 1078
  (interactive
   (list
    (let ((completion-regexp-list '("-mode\\'"))
	  (