Fix info and customize *-other-window commands.
[bpt/emacs.git] / lisp / cus-edit.el
CommitLineData
e8af40ee 1;;; cus-edit.el --- tools for customizing Emacs and Lisp packages
d543e20b 2;;
73b0cd50 3;; Copyright (C) 1996-1997, 1999-2011 Free Software Foundation, Inc.
d543e20b
PA
4;;
5;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
c942535f 6;; Maintainer: FSF
d543e20b 7;; Keywords: help, faces
bd78fa1d 8;; Package: emacs
d543e20b 9
f2b98a56
RS
10;; This file is part of GNU Emacs.
11
eb3fa2cf 12;; GNU Emacs is free software: you can redistribute it and/or modify
f2b98a56 13;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
f2b98a56
RS
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
eb3fa2cf 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
f2b98a56 24
d543e20b
PA
25;;; Commentary:
26;;
6d528fc5 27;; This file implements the code to create and edit customize buffers.
c942535f 28;;
d543e20b
PA
29;; See `custom.el'.
30
ab678382
RS
31;; No commands should have names starting with `custom-' because
32;; that interferes with completion. Use `customize-' for commands
33;; that the user will run with M-x, and `Custom-' for interactive commands.
34
9f5d3236 35;; The identity of a customize option is represented by a Lisp symbol.
62bf2fd1 36;; The following values are associated with an option.
9f5d3236
RS
37
38;; 0. The current value.
39
40;; This is the value of the option as seen by "the rest of Emacs".
41
42;; Usually extracted by 'default-value', but can be extracted with
43;; different means if the option symbol has the 'custom-get'
44;; property. Similarly, set-default (or the 'custom-set' property)
45;; can set it.
46
47;; 1. The widget value.
48
62bf2fd1 49;; This is the value shown in the widget in a customize buffer.
9f5d3236
RS
50
51;; 2. The customized value.
52
53;; This is the last value given to the option through customize.
54
55;; It is stored in the 'customized-value' property of the option, in a
62bf2fd1 56;; cons-cell whose car evaluates to the customized value.
9f5d3236
RS
57
58;; 3. The saved value.
59
60;; This is last value saved from customize.
61
62;; It is stored in the 'saved-value' property of the option, in a
62bf2fd1 63;; cons-cell whose car evaluates to the saved value.
9f5d3236
RS
64
65;; 4. The standard value.
66
67;; This is the value given in the 'defcustom' declaration.
68
69;; It is stored in the 'standard-value' property of the option, in a
62bf2fd1 70;; cons-cell whose car evaluates to the standard value.
9f5d3236
RS
71
72;; 5. The "think" value.
62bf2fd1
LT
73
74;; This is what customize thinks the current value should be.
75
76;; This is the customized value, if any such value exists, otherwise
9f5d3236 77;; the saved value, if that exists, and as a last resort the standard
62bf2fd1 78;; value.
9f5d3236
RS
79
80;; The reason for storing values unevaluated: This is so you can have
81;; values that depend on the environment. For example, you can have a
62bf2fd1 82;; variable that has one value when Emacs is running under a window
9f5d3236 83;; system, and another value on a tty. Since the evaluation is only done
62bf2fd1 84;; when the variable is first initialized, this is only relevant for the
9f5d3236
RS
85;; saved (and standard) values, but affect others values for
86;; compatibility.
87
88;; You can see (and modify and save) this unevaluated value by selecting
70482877 89;; "Show Saved Lisp Expression" from the Lisp interface. This will
9f5d3236
RS
90;; give you the unevaluated saved value, if any, otherwise the
91;; unevaluated standard value.
92
93;; The possible states for a customize widget are:
94
95;; 0. unknown
96
97;; The state has not been determined yet.
98
99;; 1. modified
100
101;; The widget value is different from the current value.
102
103;; 2. changed
62bf2fd1
LT
104
105;; The current value is different from the "think" value.
9f5d3236
RS
106
107;; 3. set
108
109;; The "think" value is the customized value.
110
111;; 4. saved
112
113;; The "think" value is the saved value.
114
115;; 5. standard
116
117;; The "think" value is the standard value.
118
119;; 6. rogue
120
62bf2fd1 121;; There is no standard value. This means that the variable was
f63d5a0e
LT
122;; not defined with defcustom, nor handled in cus-start.el. Most
123;; standard interactive Custom commands do not let you create a
124;; Custom buffer containing such variables. However, such Custom
125;; buffers can be created, for instance, by calling
126;; `customize-apropos' with a prefix arg or by calling
f32a1cb5 127;; `customize-option' non-interactively.
9f5d3236
RS
128
129;; 7. hidden
130
131;; There is no widget value.
132
133;; 8. mismatch
134
135;; The widget value is not valid member of the :type specified for the
62bf2fd1 136;; option.
9f5d3236 137
d543e20b
PA
138;;; Code:
139
140(require 'cus-face)
141(require 'wid-edit)
a0247dcf
SM
142
143(defvar custom-versions-load-alist) ; from cus-load
144(defvar recentf-exclude) ; from recentf.el
6d528fc5
PA
145
146(condition-case nil
147 (require 'cus-load)
148 (error nil))
d543e20b 149
9097aeb7
PA
150(condition-case nil
151 (require 'cus-start)
152 (error nil))
153
bd042c03 154(put 'custom-define-hook 'custom-type 'hook)
25ac13b5 155(put 'custom-define-hook 'standard-value '(nil))
bd042c03
PA
156(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)
157
d543e20b
PA
158;;; Customization Groups.
159
160(defgroup emacs nil
161 "Customization of the One True Editor."
162 :link '(custom-manual "(emacs)Top"))
163
164;; Most of these groups are stolen from `finder.el',
165(defgroup editing nil
166 "Basic text editing facilities."
167 :group 'emacs)
168
647f9993
CY
169(defgroup convenience nil
170 "Convenience features for faster editing."
171 :group 'emacs)
172
173(defgroup files nil
174 "Support for editing files."
175 :group 'emacs)
176
177(defgroup wp nil
178 "Support for editing text files."
179 :tag "Text"
180 :group 'emacs)
181
182(defgroup data nil
183 "Support for editing binary data files."
184 :group 'emacs)
185
d543e20b
PA
186(defgroup abbrev nil
187 "Abbreviation handling, typing shortcuts, macros."
188 :tag "Abbreviations"
eba5b4dd 189 :group 'convenience)
d543e20b
PA
190
191(defgroup matching nil
192 "Various sorts of searching and matching."
193 :group 'editing)
194
195(defgroup emulations nil
196 "Emulations of other editors."
6ea2832e 197 :link '(custom-manual "(emacs)Emulation")
d543e20b
PA
198 :group 'editing)
199
200(defgroup mouse nil
201 "Mouse support."
202 :group 'editing)
203
204(defgroup outlines nil
205 "Support for hierarchical outlining."
eba5b4dd 206 :group 'wp)
d543e20b
PA
207
208(defgroup external nil
209 "Interfacing to external utilities."
210 :group 'emacs)
211
26f4b8ab
CY
212(defgroup comm nil
213 "Communications, networking, and remote access to files."
214 :tag "Communication"
eba5b4dd
CY
215 :group 'emacs)
216
d543e20b
PA
217(defgroup processes nil
218 "Process, subshell, compilation, and job control support."
eba5b4dd 219 :group 'external)
d543e20b
PA
220
221(defgroup programming nil
222 "Support for programming in other languages."
223 :group 'emacs)
224
225(defgroup languages nil
226 "Specialized modes for editing programming languages."
227 :group 'programming)
228
229(defgroup lisp nil
230 "Lisp support, including Emacs Lisp."
3e721a14 231 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
d543e20b
PA
232 :group 'languages
233 :group 'development)
234
235(defgroup c nil
236 "Support for the C language and related languages."
3e721a14 237 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
6ea2832e 238 :link '(custom-manual "(ccmode)")
d543e20b
PA
239 :group 'languages)
240
241(defgroup tools nil
242 "Programming tools."
243 :group 'programming)
244
d543e20b
PA
245(defgroup applications nil
246 "Applications written in Emacs."
247 :group 'emacs)
248
249(defgroup calendar nil
250 "Calendar and time management support."
251 :group 'applications)
252
253(defgroup mail nil
254 "Modes for electronic-mail handling."
255 :group 'applications)
256
257(defgroup news nil
258 "Support for netnews reading and posting."
6ea2832e 259 :link '(custom-manual "(gnus)")
d543e20b
PA
260 :group 'applications)
261
262(defgroup games nil
263 "Games, jokes and amusements."
264 :group 'applications)
265
266(defgroup development nil
267 "Support for further development of Emacs."
268 :group 'emacs)
269
270(defgroup docs nil
271 "Support for Emacs documentation."
272 :group 'development)
273
274(defgroup extensions nil
275 "Emacs Lisp language extensions."
276 :group 'development)
277
278(defgroup internal nil
279 "Code for Emacs internals, build process, defaults."
280 :group 'development)
281
282(defgroup maint nil
283 "Maintenance aids for the Emacs development group."
284 :tag "Maintenance"
285 :group 'development)
286
287(defgroup environment nil
288 "Fitting Emacs with its environment."
289 :group 'emacs)
290
d543e20b 291(defgroup hardware nil
ff90f4b0 292 "Support for interfacing with miscellaneous hardware."
d543e20b
PA
293 :group 'environment)
294
295(defgroup terminals nil
296 "Support for terminal types."
297 :group 'environment)
298
299(defgroup unix nil
300 "Front-ends/assistants for, or emulators of, UNIX features."
301 :group 'environment)
302
d543e20b
PA
303(defgroup i18n nil
304 "Internationalization and alternate character-set support."
6ea2832e 305 :link '(custom-manual "(emacs)International")
d543e20b
PA
306 :group 'environment
307 :group 'editing)
308
86bd10bc
PA
309(defgroup x nil
310 "The X Window system."
311 :group 'environment)
312
d543e20b
PA
313(defgroup frames nil
314 "Support for Emacs frames and window systems."
315 :group 'environment)
316
d543e20b
PA
317(defgroup tex nil
318 "Code related to the TeX formatter."
3e721a14 319 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
d543e20b
PA
320 :group 'wp)
321
322(defgroup faces nil
323 "Support for multiple fonts."
324 :group 'emacs)
325
d543e20b
PA
326(defgroup help nil
327 "Support for on-line help systems."
328 :group 'emacs)
329
d3d4df42
DL
330(defgroup multimedia nil
331 "Non-textual support, specifically images and sound."
332 :group 'emacs)
333
d543e20b
PA
334(defgroup local nil
335 "Code local to your site."
336 :group 'emacs)
337
338(defgroup customize '((widgets custom-group))
339 "Customization of the Customization support."
d543e20b 340 :prefix "custom-"
bd042c03
PA
341 :group 'help)
342
343(defgroup custom-faces nil
344 "Faces used by customize."
345 :group 'customize
d543e20b
PA
346 :group 'faces)
347
da5ec617
PA
348(defgroup custom-browse nil
349 "Control customize browser."
350 :prefix "custom-"
351 :group 'customize)
352
6aaedd12 353(defgroup custom-buffer nil
da5ec617 354 "Control customize buffers."
6aaedd12
PA
355 :prefix "custom-"
356 :group 'customize)
357
358(defgroup custom-menu nil
da5ec617 359 "Control customize menus."
6aaedd12
PA
360 :prefix "custom-"
361 :group 'customize)
362
bd042c03
PA
363(defgroup alloc nil
364 "Storage allocation and gc for GNU Emacs Lisp interpreter."
365 :tag "Storage Allocation"
366 :group 'internal)
367
368(defgroup undo nil
369 "Undoing changes in buffers."
6ea2832e 370 :link '(custom-manual "(emacs)Undo")
bd042c03
PA
371 :group 'editing)
372
0518917a 373(defgroup mode-line nil
bd042c03
PA
374 "Content of the modeline."
375 :group 'environment)
376
bd042c03
PA
377(defgroup editing-basics nil
378 "Most basic editing facilities."
379 :group 'editing)
380
381(defgroup display nil
382 "How characters are displayed in buffers."
383 :group 'environment)
384
385(defgroup execute nil
386 "Executing external commands."
387 :group 'processes)
388
389(defgroup installation nil
390 "The Emacs installation."
391 :group 'environment)
392
393(defgroup dired nil
394 "Directory editing."
395 :group 'environment)
396
397(defgroup limits nil
398 "Internal Emacs limits."
399 :group 'internal)
400
401(defgroup debug nil
402 "Debugging Emacs itself."
403 :group 'development)
404
bd042c03
PA
405(defgroup keyboard nil
406 "Input from the keyboard."
407 :group 'environment)
408
409(defgroup mouse nil
410 "Input from the mouse."
411 :group 'environment)
412
413(defgroup menu nil
414 "Input from the menus."
415 :group 'environment)
416
153bd017
JD
417(defgroup dnd nil
418 "Handling data from drag and drop."
419 :group 'environment)
420
bd042c03 421(defgroup auto-save nil
040ee34f 422 "Preventing accidental loss of data."
482e54f3 423 :group 'files)
bd042c03
PA
424
425(defgroup processes-basics nil
426 "Basic stuff dealing with processes."
427 :group 'processes)
428
25ac13b5
PA
429(defgroup mule nil
430 "MULE Emacs internationalization."
70bc91bc 431 :group 'i18n)
25ac13b5 432
bd042c03
PA
433(defgroup windows nil
434 "Windows within a frame."
6ea2832e 435 :link '(custom-manual "(emacs)Windows")
86bd10bc 436 :group 'environment)
bd042c03 437
f3093f77
CY
438;;; Custom mode keymaps
439
440(defvar custom-mode-map
f3093f77
CY
441 (let ((map (make-keymap)))
442 (set-keymap-parent map widget-keymap)
443 (define-key map [remap self-insert-command] 'Custom-no-edit)
444 (define-key map "\^m" 'Custom-newline)
445 (define-key map " " 'scroll-up)
446 (define-key map "\177" 'scroll-down)
447 (define-key map "\C-c\C-c" 'Custom-set)
448 (define-key map "\C-x\C-s" 'Custom-save)
449 (define-key map "q" 'Custom-buffer-done)
450 (define-key map "u" 'Custom-goto-parent)
451 (define-key map "n" 'widget-forward)
452 (define-key map "p" 'widget-backward)
453 map)
6aec3b9d 454 "Keymap for `Custom-mode'.")
f3093f77
CY
455
456(defvar custom-mode-link-map
457 (let ((map (make-keymap)))
458 (set-keymap-parent map custom-mode-map)
459 (define-key map [down-mouse-2] nil)
460 (define-key map [down-mouse-1] 'mouse-drag-region)
461 (define-key map [mouse-2] 'widget-move-and-invoke)
462 map)
6aec3b9d 463 "Local keymap for links in `Custom-mode'.")
f3093f77 464
34cf517c
MR
465(defvar custom-field-keymap
466 (let ((map (copy-keymap widget-field-keymap)))
467 (define-key map "\C-c\C-c" 'Custom-set)
468 (define-key map "\C-x\C-s" 'Custom-save)
469 map)
470 "Keymap used inside editable fields in customization buffers.")
471
472(widget-put (get 'editable-field 'widget-type) :keymap custom-field-keymap)
f3093f77 473
d543e20b
PA
474;;; Utilities.
475
d543e20b
PA
476(defun custom-split-regexp-maybe (regexp)
477 "If REGEXP is a string, split it to a list at `\\|'.
12bafdaa 478You can get the original back from the result with:
d543e20b
PA
479 (mapconcat 'identity result \"\\|\")
480
481IF REGEXP is not a string, return it unchanged."
482 (if (stringp regexp)
12bafdaa 483 (split-string regexp "\\\\|")
d543e20b
PA
484 regexp))
485
bd042c03 486(defun custom-variable-prompt ()
3a495e15 487 "Prompt for a custom variable, defaulting to the variable at point.
bd042c03 488Return a list suitable for use in `interactive'."
3e721a14
JL
489 (let* ((v (variable-at-point))
490 (default (and (symbolp v) (custom-variable-p v) (symbol-name v)))
491 (enable-recursive-minibuffers t)
492 val)
493 (setq val (completing-read
0a57ffed
RS
494 (if default (format "Customize variable (default %s): " default)
495 "Customize variable: ")
3e721a14 496 obarray 'custom-variable-p t nil nil default))
bd042c03 497 (list (if (equal val "")
5b5cdd97
RS
498 (if (symbolp v) v nil)
499 (intern val)))))
bd042c03 500
6d528fc5
PA
501(defun custom-menu-filter (menu widget)
502 "Convert MENU to the form used by `widget-choose'.
503MENU should be in the same format as `custom-variable-menu'.
504WIDGET is the widget to apply the filter entries of MENU on."
505 (let ((result nil)
506 current name action filter)
d3d4df42 507 (while menu
6d528fc5
PA
508 (setq current (car menu)
509 name (nth 0 current)
510 action (nth 1 current)
511 filter (nth 2 current)
512 menu (cdr menu))
513 (if (or (null filter) (funcall filter widget))
514 (push (cons name action) result)
515 (push name result)))
516 (nreverse result)))
517
bd042c03
PA
518;;; Unlispify.
519
d543e20b 520(defvar custom-prefix-list nil
2365594b 521 "List of prefixes that should be ignored by `custom-unlispify'.")
d543e20b
PA
522
523(defcustom custom-unlispify-menu-entries t
10cb6e7b 524 "Display menu entries as words instead of symbols if non-nil."
6aaedd12 525 :group 'custom-menu
d543e20b
PA
526 :type 'boolean)
527
cda987f4
RS
528(defcustom custom-unlispify-remove-prefixes nil
529 "Non-nil means remove group prefixes from option names in buffer."
530 :group 'custom-menu
42b4edc5 531 :group 'custom-buffer
cda987f4
RS
532 :type 'boolean)
533
d543e20b 534(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
2365594b 535 "Convert SYMBOL into a menu entry."
d543e20b
PA
536 (cond ((not custom-unlispify-menu-entries)
537 (symbol-name symbol))
538 ((get symbol 'custom-tag)
539 (if no-suffix
540 (get symbol 'custom-tag)
541 (concat (get symbol 'custom-tag) "...")))
542 (t
d9f67134 543 (with-current-buffer (get-buffer-create " *Custom-Work*")
d543e20b
PA
544 (erase-buffer)
545 (princ symbol (current-buffer))
546 (goto-char (point-min))
3b2f3d30
SM
547 ;; FIXME: Boolean variables are not predicates, so they shouldn't
548 ;; end with `-p'. -stef
549 ;; (when (and (eq (get symbol 'custom-type) 'boolean)
550 ;; (re-search-forward "-p\\'" nil t))
551 ;; (replace-match "" t t)
552 ;; (goto-char (point-min)))
cda987f4
RS
553 (if custom-unlispify-remove-prefixes
554 (let ((prefixes custom-prefix-list)
555 prefix)
556 (while prefixes
557 (setq prefix (car prefixes))
558 (if (search-forward prefix (+ (point) (length prefix)) t)
d3d4df42 559 (progn
cda987f4
RS
560 (setq prefixes nil)
561 (delete-region (point-min) (point)))
562 (setq prefixes (cdr prefixes))))))
d543e20b
PA
563 (subst-char-in-region (point-min) (point-max) ?- ?\ t)
564 (capitalize-region (point-min) (point-max))
d3d4df42 565 (unless no-suffix
d543e20b
PA
566 (goto-char (point-max))
567 (insert "..."))
568 (buffer-string)))))
569
570(defcustom custom-unlispify-tag-names t
10cb6e7b 571 "Display tag names as words instead of symbols if non-nil."
6aaedd12 572 :group 'custom-buffer
d543e20b
PA
573 :type 'boolean)
574
575(defun custom-unlispify-tag-name (symbol)
2365594b 576 "Convert SYMBOL into a menu entry."
d543e20b
PA
577 (let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
578 (custom-unlispify-menu-entry symbol t)))
579
580(defun custom-prefix-add (symbol prefixes)
2365594b 581 "Add SYMBOL to list of ignored PREFIXES."
d543e20b
PA
582 (cons (or (get symbol 'custom-prefix)
583 (concat (symbol-name symbol) "-"))
584 prefixes))
585
bd042c03
PA
586;;; Guess.
587
588(defcustom custom-guess-name-alist
589 '(("-p\\'" boolean)
11f0cdf8 590 ("-flag\\'" boolean)
bd042c03
PA
591 ("-hook\\'" hook)
592 ("-face\\'" face)
593 ("-file\\'" file)
594 ("-function\\'" function)
595 ("-functions\\'" (repeat function))
596 ("-list\\'" (repeat sexp))
5bedb26c 597 ("-alist\\'" (alist :key-type sexp :value-type sexp)))
bd042c03
PA
598 "Alist of (MATCH TYPE).
599
d3d4df42 600MATCH should be a regexp matching the name of a symbol, and TYPE should
bd042c03
PA
601be a widget suitable for editing the value of that symbol. The TYPE
602of the first entry where MATCH matches the name of the symbol will be
d3d4df42 603used.
bd042c03
PA
604
605This is used for guessing the type of variables not declared with
606customize."
607 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
3ee07367 608 :group 'custom-buffer)
d543e20b 609
bd042c03
PA
610(defcustom custom-guess-doc-alist
611 '(("\\`\\*?Non-nil " boolean))
612 "Alist of (MATCH TYPE).
d543e20b 613
bd042c03
PA
614MATCH should be a regexp matching a documentation string, and TYPE
615should be a widget suitable for editing the value of a variable with
616that documentation string. The TYPE of the first entry where MATCH
617matches the name of the symbol will be used.
d543e20b 618
bd042c03
PA
619This is used for guessing the type of variables not declared with
620customize."
621 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
3ee07367 622 :group 'custom-buffer)
d543e20b 623
bd042c03
PA
624(defun custom-guess-type (symbol)
625 "Guess a widget suitable for editing the value of SYMBOL.
d3d4df42 626This is done by matching SYMBOL with `custom-guess-name-alist' and
bd042c03
PA
627if that fails, the doc string with `custom-guess-doc-alist'."
628 (let ((name (symbol-name symbol))
629 (names custom-guess-name-alist)
630 current found)
631 (while names
632 (setq current (car names)
633 names (cdr names))
634 (when (string-match (nth 0 current) name)
635 (setq found (nth 1 current)
636 names nil)))
637 (unless found
638 (let ((doc (documentation-property symbol 'variable-documentation))
639 (docs custom-guess-doc-alist))
d3d4df42 640 (when doc
bd042c03
PA
641 (while docs
642 (setq current (car docs)
643 docs (cdr docs))
644 (when (string-match (nth 0 current) doc)
645 (setq found (nth 1 current)
646 docs nil))))))
647 found))
d543e20b 648
25ac13b5
PA
649;;; Sorting.
650
ba5b643e 651;;;###autoload
da5ec617 652(defcustom custom-browse-sort-alphabetically nil
ba5b643e 653 "If non-nil, sort customization group alphabetically in `custom-browse'."
da5ec617
PA
654 :type 'boolean
655 :group 'custom-browse)
656
657(defcustom custom-browse-order-groups nil
658 "If non-nil, order group members within each customization group.
659If `first', order groups before non-groups.
660If `last', order groups after non-groups."
661 :type '(choice (const first)
662 (const last)
663 (const :tag "none" nil))
664 :group 'custom-browse)
665
c953515e
PA
666(defcustom custom-browse-only-groups nil
667 "If non-nil, show group members only within each customization group."
668 :type 'boolean
669 :group 'custom-browse)
670
ba5b643e 671;;;###autoload
647f9993
CY
672(defcustom custom-buffer-sort-alphabetically t
673 "Whether to sort customization groups alphabetically in Custom buffer."
944c91b6 674 :type 'boolean
1625d379
CY
675 :group 'custom-buffer
676 :version "24.1")
25ac13b5 677
da5ec617
PA
678(defcustom custom-buffer-order-groups 'last
679 "If non-nil, order group members within each customization group.
680If `first', order groups before non-groups.
681If `last', order groups after non-groups."
682 :type '(choice (const first)
683 (const last)
684 (const :tag "none" nil))
6aaedd12 685 :group 'custom-buffer)
25ac13b5 686
ba5b643e 687;;;###autoload
944c91b6 688(defcustom custom-menu-sort-alphabetically nil
ba5b643e 689 "If non-nil, sort each customization group alphabetically in menus."
944c91b6 690 :type 'boolean
6aaedd12 691 :group 'custom-menu)
25ac13b5 692
da5ec617
PA
693(defcustom custom-menu-order-groups 'first
694 "If non-nil, order group members within each customization group.
695If `first', order groups before non-groups.
696If `last', order groups after non-groups."
697 :type '(choice (const first)
698 (const last)
699 (const :tag "none" nil))
6aaedd12
PA
700 :group 'custom-menu)
701
da5ec617
PA
702(defun custom-sort-items (items sort-alphabetically order-groups)
703 "Return a sorted copy of ITEMS.
704ITEMS should be a `custom-group' property.
705If SORT-ALPHABETICALLY non-nil, sort alphabetically.
706If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
707groups after non-groups, if nil do not order groups at all."
708 (sort (copy-sequence items)
709 (lambda (a b)
710 (let ((typea (nth 1 a)) (typeb (nth 1 b))
359476e0 711 (namea (nth 0 a)) (nameb (nth 0 b)))
da5ec617
PA
712 (cond ((not order-groups)
713 ;; Since we don't care about A and B order, maybe sort.
714 (when sort-alphabetically
715 (string-lessp namea nameb)))
716 ((eq typea 'custom-group)
717 ;; If B is also a group, maybe sort. Otherwise, order A and B.
718 (if (eq typeb 'custom-group)
719 (when sort-alphabetically
720 (string-lessp namea nameb))
721 (eq order-groups 'first)))
722 ((eq typeb 'custom-group)
723 ;; Since A cannot be a group, order A and B.
724 (eq order-groups 'last))
725 (sort-alphabetically
726 ;; Since A and B cannot be groups, sort.
727 (string-lessp namea nameb)))))))
25ac13b5 728
d543e20b
PA
729;;; Custom Mode Commands.
730
9db1942d 731;; This variable is used by `custom-tool-bar-map', or directly by
f6542587 732;; `custom-buffer-create-internal' if `custom-buffer-verbose-help' is non-nil.
9db1942d
CY
733
734(defvar custom-commands
587faadd 735 '((" Set for current session " Custom-set t
9db1942d 736 "Apply all settings in this buffer to the current session"
f904c0f9
JD
737 "index"
738 "Apply")
587faadd 739 (" Save for future sessions " Custom-save
9db1942d
CY
740 (or custom-file user-init-file)
741 "Apply all settings in this buffer and save them for future Emacs sessions."
f904c0f9
JD
742 "save"
743 "Save")
587faadd 744 (" Undo edits " Custom-reset-current t
9db1942d 745 "Restore all settings in this buffer to reflect their current values."
f904c0f9
JD
746 "refresh"
747 "Undo")
587faadd 748 (" Reset to saved " Custom-reset-saved t
9db1942d 749 "Restore all settings in this buffer to their saved values (if any)."
f904c0f9
JD
750 "undo"
751 "Reset")
587faadd 752 (" Erase customizations " Custom-reset-standard
9db1942d
CY
753 (or custom-file user-init-file)
754 "Un-customize all settings in this buffer and save them with standard values."
f904c0f9
JD
755 "delete"
756 "Uncustomize")
587faadd 757 (" Help for Customize " Custom-help t
9db1942d 758 "Get help for using Customize."
f904c0f9
JD
759 "help"
760 "Help")
587faadd 761 (" Exit " Custom-buffer-done t "Exit Customize." "exit" "Exit")))
9db1942d
CY
762
763(defun Custom-help ()
764 "Read the node on Easy Customization in the Emacs manual."
d543e20b 765 (interactive)
9db1942d 766 (info "(emacs)Easy Customization"))
d543e20b 767
d3d4df42 768(defvar custom-reset-menu
70482877
LT
769 '(("Undo Edits" . Custom-reset-current)
770 ("Reset to Saved" . Custom-reset-saved)
9db1942d 771 ("Erase Customizations (use standard values)" . Custom-reset-standard))
d543e20b
PA
772 "Alist of actions for the `Reset' button.
773The key is a string containing the name of the action, the value is a
2365594b 774Lisp function taking the widget as an element which will be called
d543e20b
PA
775when the action is chosen.")
776
9db1942d
CY
777(defvar custom-options nil
778 "Customization widgets in the current buffer.")
779
780(defun custom-command-apply (fun query &optional strong-query)
781 "Call function FUN on all widgets in `custom-options'.
782If there is more than one widget, ask user for confirmation using
783the query string QUERY, using `y-or-n-p' if STRONG-QUERY is nil,
784and `yes-or-no-p' otherwise."
785 (if (or (and (= 1 (length custom-options))
786 (memq (widget-type (car custom-options))
787 '(custom-variable custom-face)))
788 (funcall (if strong-query 'yes-or-no-p 'y-or-n-p) query))
789 (progn (mapc fun custom-options) t)
790 (message "Aborted")
791 nil))
792
06b60517 793(defun Custom-set (&rest _ignore)
9db1942d
CY
794 "Set the current value of all edited settings in the buffer."
795 (interactive)
796 (custom-command-apply
797 (lambda (child)
798 (when (eq (widget-get child :custom-state) 'modified)
799 (widget-apply child :custom-set)))
800 "Set all values according to this buffer? "))
801
06b60517 802(defun Custom-save (&rest _ignore)
9db1942d 803 "Set all edited settings, then save all settings that have been set.
5ae87ed4
MR
804If a setting was edited and set before, this saves it. If a
805setting was merely edited before, this sets it then saves it."
9db1942d 806 (interactive)
5ae87ed4
MR
807 (when (custom-command-apply
808 (lambda (child)
809 (when (memq (widget-get child :custom-state)
810 '(modified set changed rogue))
811 (widget-apply child :custom-mark-to-save)))
812 "Save all settings in this buffer? " t)
813 ;; Save changes to buffer and redraw.
814 (custom-save-all)
815 (dolist (child custom-options)
816 (widget-apply child :custom-state-set-and-redraw))))
9db1942d 817
06b60517 818(defun custom-reset (_widget &optional event)
d543e20b
PA
819 "Select item from reset menu."
820 (let* ((completion-ignore-case t)
eaa99205 821 (answer (widget-choose "Reset settings"
d543e20b
PA
822 custom-reset-menu
823 event)))
824 (if answer
825 (funcall answer))))
826
06b60517 827(defun Custom-reset-current (&rest _ignore)
67177975 828 "Reset all edited settings in the buffer to show their current values."
d543e20b 829 (interactive)
9db1942d
CY
830 (custom-command-apply
831 (lambda (widget)
832 (if (memq (widget-get widget :custom-state) '(modified changed))
833 (widget-apply widget :custom-reset-current)))
834 "Reset all settings' buffer text to show current values? "))
d543e20b 835
06b60517 836(defun Custom-reset-saved (&rest _ignore)
67177975
RS
837 "Reset all edited or set settings in the buffer to their saved value.
838This also shows the saved values in the buffer."
d543e20b 839 (interactive)
9db1942d
CY
840 (custom-command-apply
841 (lambda (widget)
842 (if (memq (widget-get widget :custom-state) '(modified set changed rogue))
843 (widget-apply widget :custom-reset-saved)))
844 "Reset all settings (current values and buffer text) to saved values? "))
d543e20b 845
5ae87ed4
MR
846;; The next two variables are bound to '(t) by `Custom-reset-standard'
847;; and `custom-group-reset-standard'. If these variables are nil, both
848;; `custom-variable-reset-standard' and `custom-face-reset-standard'
849;; save, reset and redraw the handled widget immediately. Otherwise,
850;; they add the widget to the corresponding list and leave it to
851;; `custom-reset-standard-save-and-update' to save, reset and redraw it.
852(defvar custom-reset-standard-variables-list nil)
853(defvar custom-reset-standard-faces-list nil)
854
855;; The next function was excerpted from `custom-variable-reset-standard'
856;; and `custom-face-reset-standard' and is used to avoid calling
857;; `custom-save-all' repeatedly (and thus saving settings to file one by
858;; one) when erasing all customizations.
859(defun custom-reset-standard-save-and-update ()
860 "Save settings and redraw after erasing customizations."
861 (when (or (and custom-reset-standard-variables-list
862 (not (eq custom-reset-standard-variables-list '(t))))
863 (and custom-reset-standard-faces-list
864 (not (eq custom-reset-standard-faces-list '(t)))))
865 ;; Save settings to file.
866 (custom-save-all)
867 ;; Set state of and redraw variables.
868 (dolist (widget custom-reset-standard-variables-list)
869 (unless (eq widget t)
870 (widget-put widget :custom-state 'unknown)
871 (custom-redraw widget)))
872 ;; Set state of and redraw faces.
873 (dolist (widget custom-reset-standard-faces-list)
874 (unless (eq widget t)
875 (let* ((symbol (widget-value widget))
876 (child (car (widget-get widget :children)))
5ae87ed4
MR
877 (comment-widget (widget-get widget :comment-widget)))
878 (put symbol 'face-comment nil)
879 (widget-value-set child
880 (custom-pre-filter-face-spec
881 (list (list t (custom-face-attributes-get
882 symbol nil)))))
883 ;; This call manages the comment visibility
884 (widget-value-set comment-widget "")
885 (custom-face-state-set widget)
886 (custom-redraw-magic widget))))))
887
06b60517 888(defun Custom-reset-standard (&rest _ignore)
5ae87ed4 889 "Erase all customizations (either current or saved) in current buffer.
50137744
RS
890The immediate result is to restore them to their standard values.
891This operation eliminates any saved values for the group members,
19d63704 892making them as if they had never been customized at all."
d543e20b 893 (interactive)
5ae87ed4
MR
894 ;; Bind these temporarily.
895 (let ((custom-reset-standard-variables-list '(t))
896 (custom-reset-standard-faces-list '(t)))
897 (custom-command-apply
898 (lambda (widget)
899 (and (or (null (widget-get widget :custom-standard-value))
900 (widget-apply widget :custom-standard-value))
901 (memq (widget-get widget :custom-state)
902 '(modified set changed saved rogue))
903 (widget-apply widget :custom-mark-to-reset-standard)))
904 "Erase all customizations for settings in this buffer? " t)
905 (custom-reset-standard-save-and-update)))
d543e20b
PA
906
907;;; The Customize Commands
908
d3d4df42 909(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
6d528fc5
PA
910 "Prompt for a variable and a value and return them as a list.
911PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
912prompt for the value. The %s escape in PROMPT-VAL is replaced with
913the name of the variable.
914
915If the variable has a `variable-interactive' property, that is used as if
916it were the arg to `interactive' (which see) to interactively read the value.
917
918If the variable has a `custom-type' property, it must be a widget and the
d3d4df42 919`:prompt-value' property of that widget will be used for reading the value.
06b60517 920If the variable also has a `custom-get' property, that is used for finding
da0275f8 921the current value of the variable, otherwise `symbol-value' is used.
d3d4df42 922
10cb6e7b 923If optional COMMENT argument is non-nil, also prompt for a comment and return
d3d4df42 924it as the third element in the list."
6d528fc5 925 (let* ((var (read-variable prompt-var))
d3d4df42
DL
926 (minibuffer-help-form '(describe-variable var))
927 (val
6d528fc5
PA
928 (let ((prop (get var 'variable-interactive))
929 (type (get var 'custom-type))
930 (prompt (format prompt-val var)))
931 (unless (listp type)
932 (setq type (list type)))
933 (cond (prop
934 ;; Use VAR's `variable-interactive' property
935 ;; as an interactive spec for prompting.
9db1942d
CY
936 (call-interactively `(lambda (arg)
937 (interactive ,prop)
938 arg)))
6d528fc5
PA
939 (type
940 (widget-prompt-value type
941 prompt
942 (if (boundp var)
06b60517
JB
943 (funcall
944 (or (get var 'custom-get) 'symbol-value)
da0275f8 945 var))
6d528fc5
PA
946 (not (boundp var))))
947 (t
d3d4df42
DL
948 (eval-minibuffer prompt))))))
949 (if comment
950 (list var val
951 (read-string "Comment: " (get var 'variable-comment)))
952 (list var val))))
6d528fc5
PA
953
954;;;###autoload
7ec8d2c6 955(defun customize-set-value (variable value &optional comment)
4f9b9060 956 "Set VARIABLE to VALUE, and return VALUE. VALUE is a Lisp object.
6d528fc5
PA
957
958If VARIABLE has a `variable-interactive' property, that is used as if
959it were the arg to `interactive' (which see) to interactively read the value.
960
961If VARIABLE has a `custom-type' property, it must be a widget and the
d3d4df42
DL
962`:prompt-value' property of that widget will be used for reading the value.
963
964If given a prefix (or a COMMENT argument), also prompt for a comment."
6d528fc5 965 (interactive (custom-prompt-variable "Set variable: "
d3d4df42
DL
966 "Set %s to value: "
967 current-prefix-arg))
ee1f522d 968
d3d4df42 969 (cond ((string= comment "")
7ec8d2c6 970 (put variable 'variable-comment nil))
d3d4df42 971 (comment
7ec8d2c6
PJ
972 (put variable 'variable-comment comment)))
973 (set variable value))
6d528fc5
PA
974
975;;;###autoload
2365594b 976(defun customize-set-variable (variable value &optional comment)
4f9b9060
PA
977 "Set the default for VARIABLE to VALUE, and return VALUE.
978VALUE is a Lisp object.
6d528fc5
PA
979
980If VARIABLE has a `custom-set' property, that is used for setting
981VARIABLE, otherwise `set-default' is used.
982
6d528fc5
PA
983If VARIABLE has a `variable-interactive' property, that is used as if
984it were the arg to `interactive' (which see) to interactively read the value.
985
986If VARIABLE has a `custom-type' property, it must be a widget and the
d3d4df42
DL
987`:prompt-value' property of that widget will be used for reading the value.
988
989If given a prefix (or a COMMENT argument), also prompt for a comment."
6d528fc5 990 (interactive (custom-prompt-variable "Set variable: "
d3d4df42
DL
991 "Set customized value for %s to: "
992 current-prefix-arg))
4f9b9060 993 (custom-load-symbol variable)
8ed50a66 994 (custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
2365594b
DL
995 (funcall (or (get variable 'custom-set) 'set-default) variable value)
996 (put variable 'customized-value (list (custom-quote value)))
d3d4df42 997 (cond ((string= comment "")
2365594b
DL
998 (put variable 'variable-comment nil)
999 (put variable 'customized-variable-comment nil))
d3d4df42 1000 (comment
2365594b 1001 (put variable 'variable-comment comment)
4f9b9060
PA
1002 (put variable 'customized-variable-comment comment)))
1003 value)
6d528fc5 1004
4ee1cf9f 1005;;;###autoload
7ec8d2c6 1006(defun customize-save-variable (variable value &optional comment)
4ee1cf9f 1007 "Set the default for VARIABLE to VALUE, and save it for future sessions.
4f9b9060
PA
1008Return VALUE.
1009
4ee1cf9f
PA
1010If VARIABLE has a `custom-set' property, that is used for setting
1011VARIABLE, otherwise `set-default' is used.
1012
4ee1cf9f
PA
1013If VARIABLE has a `variable-interactive' property, that is used as if
1014it were the arg to `interactive' (which see) to interactively read the value.
1015
1016If VARIABLE has a `custom-type' property, it must be a widget and the
d3d4df42
DL
1017`:prompt-value' property of that widget will be used for reading the value.
1018
1019If given a prefix (or a COMMENT argument), also prompt for a comment."
901cd78b 1020 (interactive (custom-prompt-variable "Set and save variable: "
d3d4df42
DL
1021 "Set and save value for %s as: "
1022 current-prefix-arg))
7ec8d2c6
PJ
1023 (funcall (or (get variable 'custom-set) 'set-default) variable value)
1024 (put variable 'saved-value (list (custom-quote value)))
c5d290fb 1025 (custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
d3d4df42 1026 (cond ((string= comment "")
7ec8d2c6
PJ
1027 (put variable 'variable-comment nil)
1028 (put variable 'saved-variable-comment nil))
d3d4df42 1029 (comment
7ec8d2c6
PJ
1030 (put variable 'variable-comment comment)
1031 (put variable 'saved-variable-comment comment)))
fe4acc60
CY
1032 (put variable 'customized-value nil)
1033 (put variable 'customized-variable-comment nil)
eab5dc07
LMI
1034 (if (custom-file t)
1035 (custom-save-all)
1036 (message "Setting `%s' temporarily since \"emacs -q\" would overwrite customizations"
1037 variable)
1038 (set variable value))
4f9b9060 1039 value)
4ee1cf9f 1040
658d8eb8
CY
1041;; Some parts of Emacs might prompt the user to save customizations,
1042;; during startup before customizations are loaded. This function
1043;; handles this corner case by avoiding calling `custom-save-variable'
1044;; too early, which could wipe out existing customizations.
1045
1046;;;###autoload
1047(defun customize-push-and-save (list-var elts)
1048 "Add ELTS to LIST-VAR and save for future sessions, safely.
1049ELTS should be a list. This function adds each entry to the
1050value of LIST-VAR using `add-to-list'.
1051
1052If Emacs is initialized, call `customize-save-variable' to save
1053the resulting list value now. Otherwise, add an entry to
1054`after-init-hook' to save it after initialization."
1055 (dolist (entry elts)
1056 (add-to-list list-var entry))
1057 (if after-init-time
1058 (let ((coding-system-for-read nil))
1059 (customize-save-variable list-var (eval list-var)))
1060 (add-hook 'after-init-hook
1061 `(lambda ()
1062 (customize-push-and-save ',list-var ',elts)))))
1063
d543e20b 1064;;;###autoload
5dd0cad0
RS
1065(defun customize ()
1066 "Select a customization buffer which you can use to set user options.
1067User options are structured into \"groups\".
1068Initially the top-level group `Emacs' and its immediate subgroups
1069are shown; the contents of those subgroups are initially hidden."
1070 (interactive)
dc2e979f 1071 (customize-group 'emacs))
5dd0cad0 1072
87434e7a
SM
1073;;;###autoload
1074(defun customize-mode (mode)
1075 "Customize options related to the current major mode.
1076If a prefix \\[universal-argument] was given (or if the current major mode has no known group),
1077then prompt for the MODE to customize."
1078 (interactive
1079 (list
1080 (let ((completion-regexp-list '("-mode\\'"))
1081 (group (custom-group-of-mode major-mode)))
1082 (if (and group (not current-prefix-arg))
1083 major-mode
1084 (intern
1085 (completing-read (if group
1086 (format "Major mode (default %s): " major-mode)
1087 "Major mode: ")
1088 obarray
1089 'custom-group-of-mode
1090 t nil nil (if group (symbol-name major-mode))))))))
1091 (customize-group (custom-group-of-mode mode)))
1092
a0247dcf
SM
1093(defun customize-read-group ()
1094 (let ((completion-ignore-case t))
1095 (completing-read "Customize group (default emacs): "
1096 obarray
1097 (lambda (symbol)
1098 (or (and (get symbol 'custom-loads)
1099 (not (get symbol 'custom-autoload)))
1100 (get symbol 'custom-group)))
1101 t)))
87434e7a 1102
5dd0cad0 1103;;;###autoload
919a69aa
CY
1104(defun customize-group (&optional group other-window)
1105 "Customize GROUP, which must be a customization group.
1106If OTHER-WINDOW is non-nil, display in another window."
a0247dcf 1107 (interactive (list (customize-read-group)))
5dd0cad0
RS
1108 (when (stringp group)
1109 (if (string-equal "" group)
1110 (setq group 'emacs)
1111 (setq group (intern group))))
241d3080
RS
1112 (let ((name (format "*Customize Group: %s*"
1113 (custom-unlispify-tag-name group))))
1114 (if (get-buffer name)
919a69aa
CY
1115 (pop-to-buffer name other-window)
1116 (funcall (if other-window
1117 'custom-buffer-create-other-window
1118 'custom-buffer-create)
1119 (list (list group 'custom-group))
1120 name
1121 (concat " for group "
1122 (custom-unlispify-tag-name group))))))
d543e20b 1123
6d528fc5 1124;;;###autoload
9db1942d
CY
1125(defun customize-group-other-window (&optional group)
1126 "Customize GROUP, which must be a customization group, in another window."
a0247dcf 1127 (interactive (list (customize-read-group)))
919a69aa 1128 (customize-group group t))
6d528fc5 1129
9097aeb7
PA
1130;;;###autoload
1131(defalias 'customize-variable 'customize-option)
38d58078 1132
d543e20b 1133;;;###autoload
38d58078
RS
1134(defun customize-option (symbol)
1135 "Customize SYMBOL, which must be a user option variable."
bd042c03 1136 (interactive (custom-variable-prompt))
161c7127
RS
1137 (unless symbol
1138 (error "No variable specified"))
dcb380c0
LT
1139 (let ((basevar (indirect-variable symbol)))
1140 (custom-buffer-create (list (list basevar 'custom-variable))
1141 (format "*Customize Option: %s*"
1142 (custom-unlispify-tag-name basevar)))
1143 (unless (eq symbol basevar)
1144 (message "`%s' is an alias for `%s'" symbol basevar))))
d543e20b 1145
ffec8c5a
MR
1146;;;###autoload
1147(defalias 'customize-variable-other-window 'customize-option-other-window)
1148
1149;;;###autoload
1150(defun customize-option-other-window (symbol)
1151 "Customize SYMBOL, which must be a user option variable.
1152Show the buffer in another window, but don't select it."
1153 (interactive (custom-variable-prompt))
161c7127
RS
1154 (unless symbol
1155 (error "No variable specified"))
dcb380c0
LT
1156 (let ((basevar (indirect-variable symbol)))
1157 (custom-buffer-create-other-window
1158 (list (list basevar 'custom-variable))
1159 (format "*Customize Option: %s*" (custom-unlispify-tag-name basevar)))
1160 (unless (eq symbol basevar)
1161 (message "`%s' is an alias for `%s'" symbol basevar))))
ffec8c5a 1162
0dcf7d7e 1163(defvar customize-changed-options-previous-release "23.1"
e418be26
KH
1164 "Version for `customize-changed-options' to refer back to by default.")
1165
4e9c705e
BW
1166;; Packages will update this variable, so make it available.
1167;;;###autoload
1168(defvar customize-package-emacs-version-alist nil
7eb944cf
RS
1169 "Alist mapping versions of a package to Emacs versions.
1170We use this for packages that have their own names, but are released
1171as part of Emacs itself.
1172
1173Each elements looks like this:
994019df
BW
1174
1175 (PACKAGE (PVERSION . EVERSION)...)
1176
7eb944cf
RS
1177Here PACKAGE is the name of a package, as a symbol. After
1178PACKAGE come one or more elements, each associating a
1179package version PVERSION with the first Emacs version
1180EVERSION in which it (or a subsequent version of PACKAGE)
1181was first released. Both PVERSION and EVERSION are strings.
1182PVERSION should be a string that this package used in
1183the :package-version keyword for `defcustom', `defgroup',
1184and `defface'.
1185
1186For example, the MH-E package updates this alist as follows:
994019df
BW
1187
1188 (add-to-list 'customize-package-emacs-version-alist
1189 '(MH-E (\"6.0\" . \"22.1\") (\"6.1\" . \"22.1\")
1190 (\"7.0\" . \"22.1\") (\"7.1\" . \"22.1\")
1191 (\"7.2\" . \"22.1\") (\"7.3\" . \"22.1\")
1192 (\"7.4\" . \"22.1\") (\"8.0\" . \"22.1\")))
1193
1194The value of PACKAGE needs to be unique and it needs to match the
1195PACKAGE value appearing in the :package-version keyword. Since
1196the user might see the value in a error message, a good choice is
1197the official name of the package, such as MH-E or Gnus.")
4e9c705e 1198
bba50f8a
RS
1199;;;###autoload
1200(defalias 'customize-changed 'customize-changed-options)
1201
c32de15e 1202;;;###autoload
8c89fb87 1203(defun customize-changed-options (&optional since-version)
bba50f8a 1204 "Customize all settings whose meanings have changed in Emacs itself.
e418be26 1205This includes new user option variables and faces, and new
bba50f8a
RS
1206customization groups, as well as older options and faces whose meanings
1207or default values have changed since the previous major Emacs release.
e418be26 1208
bba50f8a
RS
1209With argument SINCE-VERSION (a string), customize all settings
1210that were added or redefined since that version."
e418be26 1211
2071d184
LT
1212 (interactive
1213 (list
1214 (read-from-minibuffer
1215 (format "Customize options changed, since version (default %s): "
1216 customize-changed-options-previous-release))))
f50dc5d2 1217 (if (equal since-version "")
26c67de8
DL
1218 (setq since-version nil)
1219 (unless (condition-case nil
1220 (numberp (read since-version))
1221 (error nil))
1222 (signal 'wrong-type-argument (list 'numberp since-version))))
e418be26
KH
1223 (unless since-version
1224 (setq since-version customize-changed-options-previous-release))
cba752d0
MR
1225
1226 ;; Load the information for versions since since-version. We use
1227 ;; custom-load-symbol for this.
1228 (put 'custom-versions-load-alist 'custom-loads nil)
1229 (dolist (elt custom-versions-load-alist)
2ee398c4
MR
1230 (if (customize-version-lessp since-version (car elt))
1231 (dolist (load (cdr elt))
1232 (custom-add-load 'custom-versions-load-alist load))))
cba752d0
MR
1233 (custom-load-symbol 'custom-versions-load-alist)
1234 (put 'custom-versions-load-alist 'custom-loads nil)
1235
1236 (let (found)
1237 (mapatoms
1238 (lambda (symbol)
4e9c705e
BW
1239 (let* ((package-version (get symbol 'custom-package-version))
1240 (version
1241 (or (and package-version
1242 (customize-package-emacs-version symbol
1243 package-version))
1244 (get symbol 'custom-version))))
cba752d0
MR
1245 (if version
1246 (when (customize-version-lessp since-version version)
1247 (if (or (get symbol 'custom-group)
1248 (get symbol 'group-documentation))
1249 (push (list symbol 'custom-group) found))
1250 (if (custom-variable-p symbol)
1251 (push (list symbol 'custom-variable) found))
1252 (if (custom-facep symbol)
1253 (push (list symbol 'custom-face) found)))))))
1254 (if found
1255 (custom-buffer-create (custom-sort-items found t 'first)
1256 "*Customize Changed Options*")
1257 (error "No user option defaults have been changed since Emacs %s"
1258 since-version))))
f50dc5d2 1259
4e9c705e 1260(defun customize-package-emacs-version (symbol package-version)
7eb944cf
RS
1261 "Return the Emacs version in which SYMBOL's meaning last changed.
1262PACKAGE-VERSION has the form (PACKAGE . VERSION). We use
4e9c705e 1263`customize-package-emacs-version-alist' to find the version of
7eb944cf 1264Emacs that is associated with version VERSION of PACKAGE."
4e9c705e
BW
1265 (let (package-versions emacs-version)
1266 ;; Use message instead of error since we want user to be able to
1267 ;; see the rest of the symbols even if a package author has
1268 ;; botched things up.
1269 (cond ((not (listp package-version))
1270 (message "Invalid package-version value for %s" symbol))
1271 ((setq package-versions (assq (car package-version)
1272 customize-package-emacs-version-alist))
1273 (setq emacs-version
994019df 1274 (cdr (assoc (cdr package-version) package-versions)))
4e9c705e 1275 (unless emacs-version
994019df
BW
1276 (message "%s version %s not found in %s" symbol
1277 (cdr package-version)
4e9c705e
BW
1278 "customize-package-emacs-version-alist")))
1279 (t
7eb944cf 1280 (message "Package %s version %s lists no corresponding Emacs version"
4e9c705e 1281 (car package-version)
7eb944cf 1282 (cdr package-version))))
4e9c705e
BW
1283 emacs-version))
1284
f50dc5d2 1285(defun customize-version-lessp (version1 version2)
26c67de8
DL
1286 ;; Why are the versions strings, and given that they are, why aren't
1287 ;; they converted to numbers and compared as such here? -- fx
1288
e418be26
KH
1289 ;; In case someone made a mistake and left out the quotes
1290 ;; in the :version value.
1291 (if (numberp version2)
1292 (setq version2 (prin1-to-string version2)))
f50dc5d2 1293 (let (major1 major2 minor1 minor2)
26c67de8
DL
1294 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version1)
1295 (setq major1 (read (or (match-string 1 version1)
1296 "0")))
1297 (setq minor1 (read (or (match-string 3 version1)
1298 "0")))
1299 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version2)
1300 (setq major2 (read (or (match-string 1 version2)
1301 "0")))
1302 (setq minor2 (read (or (match-string 3 version2)
1303 "0")))
f50dc5d2
KH
1304 (or (< major1 major2)
1305 (and (= major1 major2)
1306 (< minor1 minor2)))))
c942535f 1307
d543e20b 1308;;;###autoload
919a69aa 1309(defun customize-face (&optional face other-window)
3127aa13 1310 "Customize FACE, which should be a face name or nil.
c40f3193
GM
1311If FACE is nil, customize all faces. If FACE is actually a
1312face-alias, customize the face it is aliased to.
d29a536a 1313
919a69aa
CY
1314If OTHER-WINDOW is non-nil, display in another window.
1315
d29a536a 1316Interactively, when point is on text which has a face specified,
3127aa13 1317suggest to customize that face, if it's customizable."
a0247dcf 1318 (interactive (list (read-face-name "Customize face" "all faces" t)))
cdd50dea
RS
1319 (if (member face '(nil ""))
1320 (setq face (face-list)))
1321 (if (and (listp face) (null (cdr face)))
1322 (setq face (car face)))
919a69aa
CY
1323 (let ((display-fun (if other-window
1324 'custom-buffer-create-other-window
1325 'custom-buffer-create)))
1326 (if (listp face)
1327 (funcall display-fun
1328 (custom-sort-items
1329 (mapcar (lambda (s) (list s 'custom-face)) face)
1330 t nil)
1331 "*Customize Faces*")
1332 ;; If FACE is actually an alias, customize the face it is aliased to.
1333 (if (get face 'face-alias)
1334 (setq face (get face 'face-alias)))
1335 (unless (facep face)
1336 (error "Invalid face %S" face))
1337 (funcall display-fun
1338 (list (list face 'custom-face))
1339 (format "*Customize Face: %s*"
1340 (custom-unlispify-tag-name face))))))
d543e20b 1341
bd042c03 1342;;;###autoload
701f49d2 1343(defun customize-face-other-window (&optional face)
3127aa13 1344 "Show customization buffer for face FACE in other window.
c40f3193 1345If FACE is actually a face-alias, customize the face it is aliased to.
d29a536a
GM
1346
1347Interactively, when point is on text which has a face specified,
3127aa13 1348suggest to customize that face, if it's customizable."
a0247dcf 1349 (interactive (list (read-face-name "Customize face" "all faces" t)))
919a69aa 1350 (customize-face face t))
bd042c03 1351
0b97da8f
RS
1352(defalias 'customize-customized 'customize-unsaved)
1353
d543e20b 1354;;;###autoload
0b97da8f
RS
1355(defun customize-unsaved ()
1356 "Customize all user options set in this session but not saved."
6d528fc5
PA
1357 (interactive)
1358 (let ((found nil))
1359 (mapatoms (lambda (symbol)
d3d4df42
DL
1360 (and (or (get symbol 'customized-face)
1361 (get symbol 'customized-face-comment))
6d528fc5 1362 (custom-facep symbol)
a1a4fa22 1363 (push (list symbol 'custom-face) found))
d3d4df42
DL
1364 (and (or (get symbol 'customized-value)
1365 (get symbol 'customized-variable-comment))
6d528fc5 1366 (boundp symbol)
a1a4fa22 1367 (push (list symbol 'custom-variable) found))))
da5ec617 1368 (if (not found)
0b97da8f 1369 (error "No user options are set but unsaved")
da5ec617 1370 (custom-buffer-create (custom-sort-items found t nil)
0b97da8f 1371 "*Customize Unsaved*"))))
6d528fc5
PA
1372
1373;;;###autoload
963c2e09 1374(defun customize-rogue ()
c111d7ae 1375 "Customize all user variables modified outside customize."
963c2e09
PA
1376 (interactive)
1377 (let ((found nil))
1378 (mapatoms (lambda (symbol)
1379 (let ((cval (or (get symbol 'customized-value)
1380 (get symbol 'saved-value)
1381 (get symbol 'standard-value))))
1382 (when (and cval ;Declared with defcustom.
1383 (default-boundp symbol) ;Has a value.
3127aa13 1384 (not (equal (eval (car cval))
963c2e09
PA
1385 ;; Which does not match customize.
1386 (default-value symbol))))
1387 (push (list symbol 'custom-variable) found)))))
1388 (if (not found)
1389 (error "No rogue user options")
1390 (custom-buffer-create (custom-sort-items found t nil)
1391 "*Customize Rogue*"))))
1392;;;###autoload
6d528fc5
PA
1393(defun customize-saved ()
1394 "Customize all already saved user options."
d543e20b
PA
1395 (interactive)
1396 (let ((found nil))
1397 (mapatoms (lambda (symbol)
d3d4df42
DL
1398 (and (or (get symbol 'saved-face)
1399 (get symbol 'saved-face-comment))
d543e20b 1400 (custom-facep symbol)
a1a4fa22 1401 (push (list symbol 'custom-face) found))
d3d4df42
DL
1402 (and (or (get symbol 'saved-value)
1403 (get symbol 'saved-variable-comment))
d543e20b 1404 (boundp symbol)
a1a4fa22 1405 (push (list symbol 'custom-variable) found))))
da5ec617
PA
1406 (if (not found )
1407 (error "No saved user options")
1408 (custom-buffer-create (custom-sort-items found t nil)
1409 "*Customize Saved*"))))
d543e20b 1410
647f9993
CY
1411(declare-function apropos-parse-pattern "apropos" (pattern))
1412
d543e20b 1413;;;###autoload
647f9993
CY
1414(defun customize-apropos (pattern &optional type)
1415 "Customize all loaded options, faces and groups matching PATTERN.
1416PATTERN can be a word, a list of words (separated by spaces),
1417or a regexp (using some regexp special characters). If it is a word,
1418search for matches for that word as a substring. If it is a list of words,
1419search for matches for any two (or more) of those words.
1420
1421If TYPE is `options', include only options.
1422If TYPE is `faces', include only faces.
1423If TYPE is `groups', include only groups.
1424If TYPE is t (interactively, with prefix arg), include variables
06cdb5db
LT
1425that are not customizable options, as well as faces and groups
1426\(but we recommend using `apropos-variable' instead)."
647f9993
CY
1427 (interactive (list (apropos-read-pattern "symbol") current-prefix-arg))
1428 (require 'apropos)
1429 (apropos-parse-pattern pattern)
06b60517 1430 (let (found)
647f9993
CY
1431 (mapatoms
1432 `(lambda (symbol)
1433 (when (string-match apropos-regexp (symbol-name symbol))
1434 ,(if (not (memq type '(faces options)))
1435 '(if (get symbol 'custom-group)
1436 (push (list symbol 'custom-group) found)))
1437 ,(if (not (memq type '(options groups)))
1438 '(if (custom-facep symbol)
1439 (push (list symbol 'custom-face) found)))
1440 ,(if (not (memq type '(groups faces)))
1441 `(if (and (boundp symbol)
1442 (eq (indirect-variable symbol) symbol)
1443 (or (get symbol 'saved-value)
1444 (custom-variable-p symbol)
1445 ,(if (not (memq type '(nil options)))
1446 '(get symbol 'variable-documentation))))
1447 (push (list symbol 'custom-variable) found))))))
a1a4fa22 1448 (if (not found)
da435d1c 1449 (error "No %s matching %s"
647f9993
CY
1450 (if (eq type t)
1451 "items"
1452 (format "customizable %s"
1453 (if (memq type '(options faces groups))
1454 (symbol-name type)
1455 "items")))
1456 pattern)
81711dba
EZ
1457 (custom-buffer-create
1458 (custom-sort-items found t custom-buffer-order-groups)
1459 "*Customize Apropos*"))))
a1a4fa22
PA
1460
1461;;;###autoload
1462(defun customize-apropos-options (regexp &optional arg)
0322b9c3 1463 "Customize all loaded customizable options matching REGEXP.
6cda144f 1464With prefix ARG, include variables that are not customizable options
8ed10e73 1465\(but it is better to use `apropos-variable' if you want to find those)."
bd18cd19 1466 (interactive "sCustomize options (regexp): \nP")
a1a4fa22
PA
1467 (customize-apropos regexp (or arg 'options)))
1468
1469;;;###autoload
1470(defun customize-apropos-faces (regexp)
0322b9c3 1471 "Customize all loaded faces matching REGEXP."
bd18cd19 1472 (interactive "sCustomize faces (regexp): \n")
a1a4fa22
PA
1473 (customize-apropos regexp 'faces))
1474
1475;;;###autoload
1476(defun customize-apropos-groups (regexp)
0322b9c3 1477 "Customize all loaded groups matching REGEXP."
bd18cd19 1478 (interactive "sCustomize groups (regexp): \n")
a1a4fa22 1479 (customize-apropos regexp 'groups))
d543e20b 1480
6d528fc5
PA
1481;;; Buffer.
1482
944c91b6
PA
1483(defcustom custom-buffer-style 'links
1484 "Control the presentation style for customization buffers.
1485The value should be a symbol, one of:
1486
1487brackets: groups nest within each other with big horizontal brackets.
1488links: groups have links to subgroups."
1489 :type '(radio (const brackets)
1490 (const links))
1491 :group 'custom-buffer)
1492
97733c3d 1493(defcustom custom-buffer-done-kill nil
6cda144f 1494 "Non-nil means exiting a Custom buffer should kill it."
97733c3d 1495 :type 'boolean
bf247b6e 1496 :version "22.1"
d3d4df42
DL
1497 :group 'custom-buffer)
1498
944c91b6
PA
1499(defcustom custom-buffer-indent 3
1500 "Number of spaces to indent nested groups."
1501 :type 'integer
1502 :group 'custom-buffer)
1503
40627755
SM
1504(defun custom-get-fresh-buffer (name)
1505 "Get a fresh new buffer with name NAME.
a153acb7
SM
1506If the buffer already exist, clean it up to be like new.
1507Beware: it's not quite like new. Good enough for custom, but maybe
1508not for everybody."
1509 ;; To be more complete, we should also kill all permanent-local variables,
1510 ;; but it's not needed for custom.
40627755 1511 (let ((buf (get-buffer name)))
fd1c38f4 1512 (when (and buf (buffer-local-value 'buffer-file-name buf))
a153acb7
SM
1513 ;; This will check if the file is not saved.
1514 (kill-buffer buf)
1515 (setq buf nil))
40627755
SM
1516 (if (null buf)
1517 (get-buffer-create name)
1518 (with-current-buffer buf
1519 (kill-all-local-variables)
a153acb7 1520 (run-hooks 'kill-buffer-hook)
f5a9b180
SM
1521 ;; Delete overlays before erasing the buffer so the overlay hooks
1522 ;; don't get run spuriously when we erase the buffer.
40627755
SM
1523 (let ((ols (overlay-lists)))
1524 (dolist (ol (nconc (car ols) (cdr ols)))
1525 (delete-overlay ol)))
f5a9b180 1526 (erase-buffer)
40627755
SM
1527 buf))))
1528
d543e20b 1529;;;###autoload
3aec85bf 1530(defun custom-buffer-create (options &optional name description)
d543e20b 1531 "Create a buffer containing OPTIONS.
86bd10bc 1532Optional NAME is the name of the buffer.
d543e20b
PA
1533OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1534SYMBOL is a customization option, and WIDGET is a widget for editing
1535that option."
40627755 1536 (pop-to-buffer (custom-get-fresh-buffer (or name "*Customization*")))
3aec85bf 1537 (custom-buffer-create-internal options description))
bd042c03 1538
6d528fc5 1539;;;###autoload
3aec85bf 1540(defun custom-buffer-create-other-window (options &optional name description)
5f97a49d
RS
1541 "Create a buffer containing OPTIONS, and display it in another window.
1542The result includes selecting that window.
86bd10bc 1543Optional NAME is the name of the buffer.
bd042c03
PA
1544OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1545SYMBOL is a customization option, and WIDGET is a widget for editing
1546that option."
86bd10bc 1547 (unless name (setq name "*Customization*"))
919a69aa
CY
1548 (pop-to-buffer (custom-get-fresh-buffer name) t)
1549 (custom-buffer-create-internal options description))
9097aeb7
PA
1550
1551(defcustom custom-reset-button-menu nil
1552 "If non-nil, only show a single reset button in customize buffers.
1553This button will have a menu with all three reset operations."
1554 :type 'boolean
6aaedd12 1555 :group 'custom-buffer)
bd042c03 1556
c42c5c7c
KS
1557(defcustom custom-buffer-verbose-help t
1558 "If non-nil, include explanatory text in the customization buffer."
1559 :type 'boolean
1560 :group 'custom-buffer)
1561
06b60517 1562(defun Custom-buffer-done (&rest _ignore)
97733c3d 1563 "Exit current Custom buffer according to `custom-buffer-done-kill'."
d3d4df42 1564 (interactive)
97733c3d 1565 (quit-window custom-buffer-done-kill))
d3d4df42 1566
87911bdb
CY
1567(defvar custom-button nil
1568 "Face used for buttons in customization buffers.")
1569
85a5eb0e
CY
1570(defvar custom-button-mouse nil
1571 "Mouse face used for buttons in customization buffers.")
1572
87911bdb
CY
1573(defvar custom-button-pressed nil
1574 "Face used for pressed buttons in customization buffers.")
1575
647f9993
CY
1576(defcustom custom-search-field t
1577 "If non-nil, show a search field in Custom buffers."
1578 :type 'boolean
1579 :version "24.1"
1580 :group 'custom-buffer)
1581
d3d4df42
DL
1582(defcustom custom-raised-buttons (not (equal (face-valid-attribute-values :box)
1583 '(("unspecified" . unspecified))))
1584 "If non-nil, indicate active buttons in a `raised-button' style.
1585Otherwise use brackets."
1586 :type 'boolean
1587 :version "21.1"
87911bdb
CY
1588 :group 'custom-buffer
1589 :set (lambda (variable value)
1590 (custom-set-default variable value)
1591 (setq custom-button
1592 (if value 'custom-button 'custom-button-unraised))
85a5eb0e
CY
1593 (setq custom-button-mouse
1594 (if value 'custom-button-mouse 'highlight))
87911bdb
CY
1595 (setq custom-button-pressed
1596 (if value
1597 'custom-button-pressed
1598 'custom-button-pressed-unraised))))
d3d4df42 1599
06b60517 1600(defun custom-buffer-create-internal (options &optional _description)
6aec3b9d 1601 (Custom-mode)
9db1942d
CY
1602 (let ((init-file (or custom-file user-init-file)))
1603 ;; Insert verbose help at the top of the custom buffer.
1604 (when custom-buffer-verbose-help
647f9993
CY
1605 (widget-insert (if init-file
1606 "To apply changes, use the Save or Set buttons."
1607 "Custom settings cannot be saved; maybe you started Emacs with `-q'.")
9db1942d
CY
1608 "\nFor details, see ")
1609 (widget-create 'custom-manual
1610 :tag "Saving Customizations"
1611 "(emacs)Saving Customizations")
1612 (widget-insert " in the ")
1613 (widget-create 'custom-manual
1614 :tag "Emacs manual"
1615 :help-echo "Read the Emacs manual."
1616 "(emacs)Top")
1617 (widget-insert "."))
9db1942d 1618 (widget-insert "\n")
647f9993
CY
1619
1620 ;; Insert the search field.
1621 (when custom-search-field
1622 (widget-insert "\n")
1623 (let* ((echo "Search for custom items")
1624 (search-widget
1625 (widget-create
1626 'editable-field
1627 :size 40 :help-echo echo
1628 :action `(lambda (widget &optional event)
d8c8743b 1629 (customize-apropos (split-string (widget-value widget)))))))
647f9993
CY
1630 (widget-insert " ")
1631 (widget-create-child-and-convert
1632 search-widget 'push-button
587faadd 1633 :tag " Search "
647f9993 1634 :help-echo echo :action
06b60517 1635 (lambda (widget &optional _event)
647f9993
CY
1636 (customize-apropos (widget-value (widget-get widget :parent)))))
1637 (widget-insert "\n")))
1638
f6542587
GM
1639 ;; The custom command buttons are also in the toolbar, so for a
1640 ;; time they were not inserted in the buffer if the toolbar was in use.
1641 ;; But it can be a little confusing for the buffer layout to
1642 ;; change according to whether or nor the toolbar is on, not to
1643 ;; mention that a custom buffer can in theory be created in a
1644 ;; frame with a toolbar, then later viewed in one without.
1645 ;; So now the buttons are always inserted in the buffer. (Bug#1326)
f6542587 1646 (if custom-buffer-verbose-help
647f9993
CY
1647 (widget-insert "
1648 Operate on all settings in this buffer:\n"))
06b60517 1649 (let ((button (lambda (tag action active help _icon _label)
f6542587
GM
1650 (widget-insert " ")
1651 (if (eval active)
1652 (widget-create 'push-button :tag tag
1653 :help-echo help :action action))))
1654 (commands custom-commands))
1655 (apply button (pop commands)) ; Set for current session
1656 (apply button (pop commands)) ; Save for future sessions
1657 (if custom-reset-button-menu
1658 (progn
1659 (widget-insert " ")
1660 (widget-create 'push-button
1661 :tag "Reset buffer"
1662 :help-echo "Show a menu with reset operations."
1663 :mouse-down-action 'ignore
1664 :action 'custom-reset))
1665 (widget-insert "\n")
1666 (apply button (pop commands)) ; Undo edits
1667 (apply button (pop commands)) ; Reset to saved
1668 (apply button (pop commands)) ; Erase customization
1669 (widget-insert " ")
1670 (pop commands) ; Help (omitted)
1671 (apply button (pop commands)))) ; Exit
9db1942d
CY
1672 (widget-insert "\n\n"))
1673
1674 ;; Now populate the custom buffer.
25ac13b5 1675 (message "Creating customization items...")
fadbdfea 1676 (buffer-disable-undo)
d3d4df42 1677 (setq custom-options
d543e20b
PA
1678 (if (= (length options) 1)
1679 (mapcar (lambda (entry)
1680 (widget-create (nth 1 entry)
c32de15e 1681 :documentation-shown t
d543e20b
PA
1682 :custom-state 'unknown
1683 :tag (custom-unlispify-tag-name
1684 (nth 0 entry))
1685 :value (nth 0 entry)))
1686 options)
1687 (let ((count 0)
1688 (length (length options)))
1689 (mapcar (lambda (entry)
6b292312
DL
1690 (prog2
1691 (message "Creating customization items ...%2d%%"
1692 (/ (* 100.0 count) length))
1693 (widget-create (nth 1 entry)
d543e20b
PA
1694 :tag (custom-unlispify-tag-name
1695 (nth 0 entry))
1696 :value (nth 0 entry))
6b292312
DL
1697 (setq count (1+ count))
1698 (unless (eq (preceding-char) ?\n)
1699 (widget-insert "\n"))
1700 (widget-insert "\n")))
1701 options))))
d543e20b
PA
1702 (unless (eq (preceding-char) ?\n)
1703 (widget-insert "\n"))
a9bcbf3f 1704 (message "Creating customization items ...done")
1833b7b3 1705 (message "Resetting customization items...")
944c91b6 1706 (unless (eq custom-buffer-style 'tree)
fadbdfea 1707 (mapc 'custom-magic-reset custom-options))
1833b7b3 1708 (message "Resetting customization items...done")
d543e20b
PA
1709 (message "Creating customization setup...")
1710 (widget-setup)
fadbdfea 1711 (buffer-enable-undo)
d543e20b 1712 (goto-char (point-min))
1833b7b3 1713 (message "Creating customization setup...done"))
d543e20b 1714
944c91b6
PA
1715;;; The Tree Browser.
1716
1717;;;###autoload
4ee1cf9f 1718(defun customize-browse (&optional group)
944c91b6 1719 "Create a tree browser for the customize hierarchy."
cda987f4 1720 (interactive)
4ee1cf9f
PA
1721 (unless group
1722 (setq group 'emacs))
1723 (let ((name "*Customize Browser*"))
40627755 1724 (pop-to-buffer (custom-get-fresh-buffer name)))
6aec3b9d 1725 (Custom-mode)
b758ae9a
RS
1726 (widget-insert (format "\
1727%s buttons; type RET or click mouse-1
1728on a button to invoke its action.
1729Invoke [+] to expand a group, and [-] to collapse an expanded group.\n"
1730 (if custom-raised-buttons
1731 "`Raised' text indicates"
1732 "Square brackets indicate")))
1733
1734
4ee1cf9f
PA
1735 (if custom-browse-only-groups
1736 (widget-insert "\
c953515e 1737Invoke the [Group] button below to edit that item in another window.\n\n")
d3d4df42
DL
1738 (widget-insert "Invoke the ")
1739 (widget-create 'item
4ee1cf9f
PA
1740 :format "%t"
1741 :tag "[Group]"
1742 :tag-glyph "folder")
1743 (widget-insert ", ")
d3d4df42 1744 (widget-create 'item
4ee1cf9f
PA
1745 :format "%t"
1746 :tag "[Face]"
1747 :tag-glyph "face")
1748 (widget-insert ", and ")
d3d4df42 1749 (widget-create 'item
4ee1cf9f
PA
1750 :format "%t"
1751 :tag "[Option]"
1752 :tag-glyph "option")
1753 (widget-insert " buttons below to edit that
c953515e 1754item in another window.\n\n"))
4ee1cf9f 1755 (let ((custom-buffer-style 'tree))
d3d4df42 1756 (widget-create 'custom-group
4ee1cf9f
PA
1757 :custom-last t
1758 :custom-state 'unknown
1759 :tag (custom-unlispify-tag-name group)
1760 :value group))
f134b461 1761 (widget-setup)
4ee1cf9f 1762 (goto-char (point-min)))
944c91b6 1763
c953515e 1764(define-widget 'custom-browse-visibility 'item
1edec9cf 1765 "Control visibility of items in the customize tree browser."
da5ec617 1766 :format "%[[%t]%]"
c953515e 1767 :action 'custom-browse-visibility-action)
944c91b6 1768
06b60517 1769(defun custom-browse-visibility-action (widget &rest _ignore)
944c91b6
PA
1770 (let ((custom-buffer-style 'tree))
1771 (custom-toggle-parent widget)))
1772
192e44fc 1773(define-widget 'custom-browse-group-tag 'custom-group-link
944c91b6 1774 "Show parent in other window when activated."
cd6c0940 1775 :tag "Group"
da5ec617 1776 :tag-glyph "folder"
c953515e 1777 :action 'custom-browse-group-tag-action)
944c91b6 1778
06b60517 1779(defun custom-browse-group-tag-action (widget &rest _ignore)
944c91b6
PA
1780 (let ((parent (widget-get widget :parent)))
1781 (customize-group-other-window (widget-value parent))))
1782
192e44fc 1783(define-widget 'custom-browse-variable-tag 'custom-group-link
944c91b6 1784 "Show parent in other window when activated."
cd6c0940 1785 :tag "Option"
da5ec617 1786 :tag-glyph "option"
c953515e 1787 :action 'custom-browse-variable-tag-action)
944c91b6 1788
06b60517 1789(defun custom-browse-variable-tag-action (widget &rest _ignore)
944c91b6
PA
1790 (let ((parent (widget-get widget :parent)))
1791 (customize-variable-other-window (widget-value parent))))
1792
192e44fc 1793(define-widget 'custom-browse-face-tag 'custom-group-link
944c91b6 1794 "Show parent in other window when activated."
cd6c0940 1795 :tag "Face"
da5ec617 1796 :tag-glyph "face"
c953515e 1797 :action 'custom-browse-face-tag-action)
944c91b6 1798
06b60517 1799(defun custom-browse-face-tag-action (widget &rest _ignore)
944c91b6
PA
1800 (let ((parent (widget-get widget :parent)))
1801 (customize-face-other-window (widget-value parent))))
1802
c953515e 1803(defconst custom-browse-alist '((" " "space")
da5ec617
PA
1804 (" | " "vertical")
1805 ("-\\ " "top")
1806 (" |-" "middle")
1807 (" `-" "bottom")))
1808
c953515e 1809(defun custom-browse-insert-prefix (prefix)
da5ec617 1810 "Insert PREFIX. On XEmacs convert it to line graphics."
d3d4df42 1811 ;; Fixme: do graphics.
a7f58f4b 1812 (if nil ; (featurep 'xemacs)
d3d4df42 1813 (progn
da5ec617
PA
1814 (insert "*")
1815 (while (not (string-equal prefix ""))
1816 (let ((entry (substring prefix 0 3)))
1817 (setq prefix (substring prefix 3))
1818 (let ((overlay (make-overlay (1- (point)) (point) nil t nil))
c953515e 1819 (name (nth 1 (assoc entry custom-browse-alist))))
da5ec617
PA
1820 (overlay-put overlay 'end-glyph (widget-glyph-find name entry))
1821 (overlay-put overlay 'start-open t)
1822 (overlay-put overlay 'end-open t)))))
1823 (insert prefix)))
1824
d543e20b
PA
1825;;; Modification of Basic Widgets.
1826;;
1827;; We add extra properties to the basic widgets needed here. This is
62a918ca 1828;; fine, as long as we are careful to stay within our own namespace.
d543e20b
PA
1829;;
1830;; We want simple widgets to be displayed by default, but complex
1831;; widgets to be hidden.
1832
af0905c8 1833;; This widget type is obsolete as of Emacs 24.1.
d543e20b
PA
1834(widget-put (get 'item 'widget-type) :custom-show t)
1835(widget-put (get 'editable-field 'widget-type)
06b60517 1836 :custom-show (lambda (_widget value)
d543e20b
PA
1837 (let ((pp (pp-to-string value)))
1838 (cond ((string-match "\n" pp)
1839 nil)
1840 ((> (length pp) 40)
1841 nil)
1842 (t t)))))
1843(widget-put (get 'menu-choice 'widget-type) :custom-show t)
1844
1845;;; The `custom-manual' Widget.
1846
1847(define-widget 'custom-manual 'info-link
1848 "Link to the manual entry for this customization option."
1849 :help-echo "Read the manual entry for this option."
f3093f77
CY
1850 :keymap custom-mode-link-map
1851 :follow-link 'mouse-face
73e60f53
CY
1852 :button-face 'custom-link
1853 :mouse-face 'highlight
e1ec62a5 1854 :pressed-face 'highlight
d543e20b
PA
1855 :tag "Manual")
1856
1857;;; The `custom-magic' Widget.
1858
6aaedd12
PA
1859(defgroup custom-magic-faces nil
1860 "Faces used by the magic button."
1861 :group 'custom-faces
1862 :group 'custom-buffer)
1863
d478e69d
MB
1864(defface custom-invalid '((((class color))
1865 (:foreground "yellow1" :background "red1"))
1866 (t
1867 (:weight bold :slant italic :underline t)))
6aaedd12
PA
1868 "Face used when the customize item is invalid."
1869 :group 'custom-magic-faces)
c4f6e489 1870(define-obsolete-face-alias 'custom-invalid-face 'custom-invalid "22.1")
d543e20b 1871
d478e69d
MB
1872(defface custom-rogue '((((class color))
1873 (:foreground "pink" :background "black"))
1874 (t
1875 (:underline t)))
6aaedd12
PA
1876 "Face used when the customize item is not defined for customization."
1877 :group 'custom-magic-faces)
c4f6e489 1878(define-obsolete-face-alias 'custom-rogue-face 'custom-rogue "22.1")
d543e20b 1879
d478e69d
MB
1880(defface custom-modified '((((min-colors 88) (class color))
1881 (:foreground "white" :background "blue1"))
ea81d57e 1882 (((class color))
d478e69d 1883 (:foreground "white" :background "blue"))
2dfa4c57 1884 (t
d478e69d
MB
1885 (:slant italic :bold)))
1886 "Face used when the customize item has been modified."
1887 :group 'custom-magic-faces)
c4f6e489 1888(define-obsolete-face-alias 'custom-modified-face 'custom-modified "22.1")
d478e69d
MB
1889
1890(defface custom-set '((((min-colors 88) (class color))
1891 (:foreground "blue1" :background "white"))
1892 (((class color))
1893 (:foreground "blue" :background "white"))
1894 (t
1895 (:slant italic)))
6aaedd12
PA
1896 "Face used when the customize item has been set."
1897 :group 'custom-magic-faces)
c4f6e489 1898(define-obsolete-face-alias 'custom-set-face 'custom-set "22.1")
d478e69d
MB
1899
1900(defface custom-changed '((((min-colors 88) (class color))
1901 (:foreground "white" :background "blue1"))
1902 (((class color))
1903 (:foreground "white" :background "blue"))
1904 (t
1905 (:slant italic)))
6aaedd12
PA
1906 "Face used when the customize item has been changed."
1907 :group 'custom-magic-faces)
c4f6e489 1908(define-obsolete-face-alias 'custom-changed-face 'custom-changed "22.1")
d543e20b 1909
d820f1fb
CY
1910(defface custom-themed '((((min-colors 88) (class color))
1911 (:foreground "white" :background "blue1"))
1912 (((class color))
1913 (:foreground "white" :background "blue"))
1914 (t
1915 (:slant italic)))
1916 "Face used when the customize item has been set by a theme."
1917 :group 'custom-magic-faces)
1918
d478e69d 1919(defface custom-saved '((t (:underline t)))
6aaedd12
PA
1920 "Face used when the customize item has been saved."
1921 :group 'custom-magic-faces)
c4f6e489 1922(define-obsolete-face-alias 'custom-saved-face 'custom-saved "22.1")
d543e20b 1923
2dfa4c57
RS
1924(defconst custom-magic-alist
1925 '((nil "#" underline "\
167eefc5 1926UNINITIALIZED, you should not see this.")
2dfa4c57 1927 (unknown "?" italic "\
167eefc5 1928UNKNOWN, you should not see this.")
2dfa4c57 1929 (hidden "-" default "\
167eefc5 1930HIDDEN, invoke \"Show\" in the previous line to show." "\
cbc7d892 1931group now hidden, invoke \"Show\", above, to show contents.")
d478e69d 1932 (invalid "x" custom-invalid "\
167eefc5 1933INVALID, the displayed value cannot be set.")
d478e69d 1934 (modified "*" custom-modified "\
167eefc5 1935EDITED, shown value does not take effect until you set or save it." "\
1833b7b3 1936something in this group has been edited but not set.")
d478e69d 1937 (set "+" custom-set "\
167eefc5 1938SET for current session only." "\
1833b7b3 1939something in this group has been set but not saved.")
d478e69d 1940 (changed ":" custom-changed "\
61328d7c 1941CHANGED outside Customize." "\
25ac13b5 1942something in this group has been changed outside customize.")
d478e69d 1943 (saved "!" custom-saved "\
167eefc5 1944SAVED and set." "\
5dd0cad0 1945something in this group has been set and saved.")
d820f1fb
CY
1946 (themed "o" custom-themed "\
1947THEMED." "\
1948visible group members are all at standard values.")
d478e69d 1949 (rogue "@" custom-rogue "\
f63d5a0e 1950NO CUSTOMIZATION DATA; not intended to be customized." "\
25ac13b5 1951something in this group is not prepared for customization.")
2dfa4c57 1952 (standard " " nil "\
167eefc5 1953STANDARD." "\
50137744 1954visible group members are all at standard values."))
d543e20b 1955 "Alist of customize option states.
d3d4df42 1956Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where
d543e20b
PA
1957
1958STATE is one of the following symbols:
1959
1960`nil'
1961 For internal use, should never occur.
1962`unknown'
1963 For internal use, should never occur.
1964`hidden'
d3d4df42 1965 This item is not being displayed.
d543e20b
PA
1966`invalid'
1967 This item is modified, but has an invalid form.
1968`modified'
1969 This item is modified, and has a valid form.
1970`set'
1971 This item has been set but not saved.
1972`changed'
167eefc5 1973 The current value of this item has been changed outside Customize.
d543e20b
PA
1974`saved'
1975 This item is marked for saving.
1976`rogue'
1977 This item has no customization information.
25ac13b5 1978`standard'
5dd0cad0 1979 This item is unchanged from the standard setting.
d543e20b
PA
1980
1981MAGIC is a string used to present that state.
1982
1983FACE is a face used to present the state.
1984
25ac13b5
PA
1985ITEM-DESC is a string describing the state for options.
1986
1987GROUP-DESC is a string describing the state for groups. If this is
1988left out, ITEM-DESC will be used.
1989
9097aeb7
PA
1990The string %c in either description will be replaced with the
1991category of the item. These are `group'. `option', and `face'.
1992
25ac13b5 1993The list should be sorted most significant first.")
d543e20b
PA
1994
1995(defcustom custom-magic-show 'long
3acab5ef 1996 "If non-nil, show textual description of the state.
b62c92bb 1997If `long', show a full-line description, not just one word."
d543e20b 1998 :type '(choice (const :tag "no" nil)
c992338c
AS
1999 (const long)
2000 (other :tag "short" short))
6aaedd12 2001 :group 'custom-buffer)
d543e20b 2002
9097aeb7 2003(defcustom custom-magic-show-hidden '(option face)
b62c92bb
RS
2004 "Control whether the State button is shown for hidden items.
2005The value should be a list with the custom categories where the State
9097aeb7
PA
2006button should be visible. Possible categories are `group', `option',
2007and `face'."
2008 :type '(set (const group) (const option) (const face))
6aaedd12 2009 :group 'custom-buffer)
3acab5ef 2010
25ac13b5 2011(defcustom custom-magic-show-button nil
b62c92bb 2012 "Show a \"magic\" button indicating the state of each customization option."
d543e20b 2013 :type 'boolean
6aaedd12 2014 :group 'custom-buffer)
d543e20b
PA
2015
2016(define-widget 'custom-magic 'default
2017 "Show and manipulate state for a customization option."
2018 :format "%v"
86bd10bc 2019 :action 'widget-parent-action
6d528fc5 2020 :notify 'ignore
d543e20b
PA
2021 :value-get 'ignore
2022 :value-create 'custom-magic-value-create
2023 :value-delete 'widget-children-value-delete)
2024
06b60517 2025(defun widget-magic-mouse-down-action (widget &optional _event)
86bd10bc 2026 ;; Non-nil unless hidden.
d3d4df42 2027 (not (eq (widget-get (widget-get (widget-get widget :parent) :parent)
86bd10bc
PA
2028 :custom-state)
2029 'hidden)))
2030
d543e20b 2031(defun custom-magic-value-create (widget)
2365594b 2032 "Create compact status report for WIDGET."
d543e20b
PA
2033 (let* ((parent (widget-get widget :parent))
2034 (state (widget-get parent :custom-state))
3acab5ef 2035 (hidden (eq state 'hidden))
25ac13b5 2036 (entry (assq state custom-magic-alist))
d543e20b
PA
2037 (magic (nth 1 entry))
2038 (face (nth 2 entry))
9097aeb7
PA
2039 (category (widget-get parent :custom-category))
2040 (text (or (and (eq category 'group)
25ac13b5
PA
2041 (nth 4 entry))
2042 (nth 3 entry)))
f985c5f7 2043 (form (widget-get parent :custom-form))
d543e20b 2044 children)
647f9993
CY
2045 (unless (eq state 'hidden)
2046 (while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text)
2047 (setq text (concat (match-string 1 text)
2048 (symbol-name category)
2049 (match-string 2 text))))
2050 (when (and custom-magic-show
2051 (or (not hidden)
2052 (memq category custom-magic-show-hidden)))
2053 (insert " ")
2054 (when (and (eq category 'group)
2055 (not (and (eq custom-buffer-style 'links)
2056 (> (widget-get parent :custom-level) 1))))
2057 (insert-char ?\ (* custom-buffer-indent
2058 (widget-get parent :custom-level))))
2059 (push (widget-create-child-and-convert
2060 widget 'choice-item
2061 :help-echo "Change the state of this item."
2062 :format (if hidden "%t" "%[%t%]")
2063 :button-prefix 'widget-push-button-prefix
2064 :button-suffix 'widget-push-button-suffix
2065 :mouse-down-action 'widget-magic-mouse-down-action
587faadd 2066 :tag " State ")
647f9993
CY
2067 children)
2068 (insert ": ")
2069 (let ((start (point)))
2070 (if (eq custom-magic-show 'long)
2071 (insert text)
2072 (insert (symbol-name state)))
2073 (cond ((eq form 'lisp)
2074 (insert " (lisp)"))
2075 ((eq form 'mismatch)
2076 (insert " (mismatch)")))
2077 (put-text-property start (point) 'face 'custom-state))
2078 (insert "\n"))
26c7b3ef
RS
2079 (when (and (eq category 'group)
2080 (not (and (eq custom-buffer-style 'links)
2081 (> (widget-get parent :custom-level) 1))))
944c91b6
PA
2082 (insert-char ?\ (* custom-buffer-indent
2083 (widget-get parent :custom-level))))
647f9993
CY
2084 (when custom-magic-show-button
2085 (when custom-magic-show
2086 (let ((indent (widget-get parent :indent)))
2087 (when indent
2088 (insert-char ? indent))))
2089 (push (widget-create-child-and-convert
2090 widget 'choice-item
2091 :mouse-down-action 'widget-magic-mouse-down-action
2092 :button-face face
2093 :button-prefix ""
2094 :button-suffix ""
2095 :help-echo "Change the state."
2096 :format (if hidden "%t" "%[%t%]")
2097 :tag (if (memq form '(lisp mismatch))
2098 (concat "(" magic ")")
2099 (concat "[" magic "]")))
2100 children)
2101 (insert " "))
2102 (widget-put widget :children children))))
d543e20b
PA
2103
2104(defun custom-magic-reset (widget)
2105 "Redraw the :custom-magic property of WIDGET."
2106 (let ((magic (widget-get widget :custom-magic)))
647bc502
CY
2107 (when magic
2108 (widget-value-set magic (widget-value magic)))))
d543e20b 2109
d543e20b
PA
2110;;; The `custom' Widget.
2111
d478e69d 2112(defface custom-button
9e2a2647 2113 '((((type x w32 ns) (class color)) ; Like default modeline
1a578e9b
AC
2114 (:box (:line-width 2 :style released-button)
2115 :background "lightgrey" :foreground "black"))
d3d4df42
DL
2116 (t
2117 nil))
87911bdb 2118 "Face for custom buffer buttons if `custom-raised-buttons' is non-nil."
d3d4df42
DL
2119 :version "21.1"
2120 :group 'custom-faces)
c4f6e489 2121(define-obsolete-face-alias 'custom-button-face 'custom-button "22.1")
d3d4df42 2122
85a5eb0e 2123(defface custom-button-mouse
9e2a2647 2124 '((((type x w32 ns) (class color))
85a5eb0e
CY
2125 (:box (:line-width 2 :style released-button)
2126 :background "grey90" :foreground "black"))
2127 (t
746abd4d
EZ
2128 ;; This is for text terminals that support mouse, like GPM mouse
2129 ;; or the MS-DOS terminal: inverse-video makes the button stand
2130 ;; out on mouse-over.
19758b95 2131 (:inverse-video t)))
85a5eb0e
CY
2132 "Mouse face for custom buffer buttons if `custom-raised-buttons' is non-nil."
2133 :version "22.1"
2134 :group 'custom-faces)
2135
87911bdb 2136(defface custom-button-unraised
192e44fc 2137 '((t :inherit underline))
87911bdb
CY
2138 "Face for custom buffer buttons if `custom-raised-buttons' is nil."
2139 :version "22.1"
2140 :group 'custom-faces)
2141
2142(setq custom-button
2143 (if custom-raised-buttons 'custom-button 'custom-button-unraised))
2144
85a5eb0e
CY
2145(setq custom-button-mouse
2146 (if custom-raised-buttons 'custom-button-mouse 'highlight))
2147
d478e69d 2148(defface custom-button-pressed
9e2a2647 2149 '((((type x w32 ns) (class color))
1a578e9b
AC
2150 (:box (:line-width 2 :style pressed-button)
2151 :background "lightgrey" :foreground "black"))
d3d4df42
DL
2152 (t
2153 (:inverse-video t)))
87911bdb 2154 "Face for pressed custom buttons if `custom-raised-buttons' is non-nil."
d3d4df42 2155 :version "21.1"
b62c92bb 2156 :group 'custom-faces)
c4f6e489
GM
2157(define-obsolete-face-alias 'custom-button-pressed-face
2158 'custom-button-pressed "22.1")
b62c92bb 2159
87911bdb
CY
2160(defface custom-button-pressed-unraised
2161 '((default :inherit custom-button-unraised)
2162 (((class color) (background light)) :foreground "magenta4")
2163 (((class color) (background dark)) :foreground "violet"))
2164 "Face for pressed custom buttons if `custom-raised-buttons' is nil."
2165 :version "22.1"
2166 :group 'custom-faces)
2167
2168(setq custom-button-pressed
2169 (if custom-raised-buttons
2170 'custom-button-pressed
2171 'custom-button-pressed-unraised))
2172
dbc1f997 2173(defface custom-documentation '((t nil))
b62c92bb
RS
2174 "Face used for documentation strings in customization buffers."
2175 :group 'custom-faces)
c4f6e489
GM
2176(define-obsolete-face-alias 'custom-documentation-face
2177 'custom-documentation "22.1")
d478e69d
MB
2178
2179(defface custom-state '((((class color)
2180 (background dark))
2181 (:foreground "lime green"))
2182 (((class color)
2183 (background light))
2184 (:foreground "dark green"))
2185 (t nil))
b62c92bb
RS
2186 "Face used for State descriptions in the customize buffer."
2187 :group 'custom-faces)
c4f6e489 2188(define-obsolete-face-alias 'custom-state-face 'custom-state "22.1")
b62c92bb 2189
73e60f53 2190(defface custom-link
192e44fc
JL
2191 '((t :inherit link))
2192 "Face for links in customization buffers."
2193 :version "22.1"
2194 :group 'custom-faces)
73e60f53 2195
d543e20b
PA
2196(define-widget 'custom 'default
2197 "Customize a user option."
944c91b6 2198 :format "%v"
d543e20b 2199 :convert-widget 'custom-convert-widget
d543e20b 2200 :notify 'custom-notify
944c91b6 2201 :custom-prefix ""
d543e20b
PA
2202 :custom-level 1
2203 :custom-state 'hidden
2204 :documentation-property 'widget-subclass-responsibility
2205 :value-create 'widget-subclass-responsibility
2206 :value-delete 'widget-children-value-delete
86bd10bc
PA
2207 :value-get 'widget-value-value-get
2208 :validate 'widget-children-validate
06b60517 2209 :match (lambda (_widget value) (symbolp value)))
d543e20b
PA
2210
2211(defun custom-convert-widget (widget)
2365594b 2212 "Initialize :value and :tag from :args in WIDGET."
d543e20b 2213 (let ((args (widget-get widget :args)))
d3d4df42 2214 (when args
d543e20b
PA
2215 (widget-put widget :value (widget-apply widget
2216 :value-to-internal (car args)))
2217 (widget-put widget :tag (custom-unlispify-tag-name (car args)))
2218 (widget-put widget :args nil)))
2219 widget)
2220
d543e20b
PA
2221(defun custom-notify (widget &rest args)
2222 "Keep track of changes."
0a3a0b56
PA
2223 (let ((state (widget-get widget :custom-state)))
2224 (unless (eq state 'modified)
2225 (unless (memq state '(nil unknown hidden))
2226 (widget-put widget :custom-state 'modified))
2227 (custom-magic-reset widget)
2228 (apply 'widget-default-notify widget args))))
d543e20b
PA
2229
2230(defun custom-redraw (widget)
2231 "Redraw WIDGET with current settings."
6d528fc5
PA
2232 (let ((line (count-lines (point-min) (point)))
2233 (column (current-column))
2234 (pos (point))
d543e20b
PA
2235 (from (marker-position (widget-get widget :from)))
2236 (to (marker-position (widget-get widget :to))))
2237 (save-excursion
2238 (widget-value-set widget (widget-value widget))
2239 (custom-redraw-magic widget))
2240 (when (and (>= pos from) (<= pos to))
6d528fc5 2241 (condition-case nil
d3d4df42 2242 (progn
e6ce8c42
GM
2243 (goto-char (point-min))
2244 (forward-line (if (> column 0)
2245 (1- line)
2246 line))
6d528fc5
PA
2247 (move-to-column column))
2248 (error nil)))))
d543e20b
PA
2249
2250(defun custom-redraw-magic (widget)
2251 "Redraw WIDGET state with current settings."
d3d4df42 2252 (while widget
d543e20b 2253 (let ((magic (widget-get widget :custom-magic)))
d3d4df42 2254 (cond (magic
944c91b6
PA
2255 (widget-value-set magic (widget-value magic))
2256 (when (setq widget (widget-get widget :group))
2257 (custom-group-state-update widget)))
2258 (t
2259 (setq widget nil)))))
d543e20b
PA
2260 (widget-setup))
2261
af0905c8 2262(make-obsolete 'custom-show "this widget type is no longer supported." "24.1")
d543e20b
PA
2263(defun custom-show (widget value)
2264 "Non-nil if WIDGET should be shown with VALUE by default."
2265 (let ((show (widget-get widget :custom-show)))
647f9993
CY
2266 (if (functionp show)
2267 (funcall show widget value)
2268 show)))
d543e20b 2269
d543e20b
PA
2270(defun custom-load-widget (widget)
2271 "Load all dependencies for WIDGET."
2272 (custom-load-symbol (widget-value widget)))
2273
c953515e 2274(defun custom-unloaded-symbol-p (symbol)
3127aa13 2275 "Return non-nil if the dependencies of SYMBOL have not yet been loaded."
c953515e
PA
2276 (let ((found nil)
2277 (loads (get symbol 'custom-loads))
2278 load)
2279 (while loads
2280 (setq load (car loads)
2281 loads (cdr loads))
2282 (cond ((symbolp load)
2283 (unless (featurep load)
2284 (setq found t)))
2285 ((assoc load load-history))
2286 ((assoc (locate-library load) load-history)
2287 (message nil))
2288 (t
2289 (setq found t))))
2290 found))
2291
2292(defun custom-unloaded-widget-p (widget)
3127aa13 2293 "Return non-nil if the dependencies of WIDGET have not yet been loaded."
c953515e
PA
2294 (custom-unloaded-symbol-p (widget-value widget)))
2295
6d528fc5
PA
2296(defun custom-toggle-hide (widget)
2297 "Toggle visibility of WIDGET."
c953515e 2298 (custom-load-widget widget)
6d528fc5 2299 (let ((state (widget-get widget :custom-state)))
fdbdd068
CY
2300 (cond ((memq state '(invalid modified set))
2301 (error "There are unsaved changes"))
6d528fc5
PA
2302 ((eq state 'hidden)
2303 (widget-put widget :custom-state 'unknown))
d3d4df42 2304 (t
3acab5ef 2305 (widget-put widget :documentation-shown nil)
6d528fc5 2306 (widget-put widget :custom-state 'hidden)))
8697863a
PA
2307 (custom-redraw widget)
2308 (widget-setup)))
6d528fc5 2309
06b60517 2310(defun custom-toggle-parent (widget &rest _ignore)
b62c92bb 2311 "Toggle visibility of parent of WIDGET."
3acab5ef
PA
2312 (custom-toggle-hide (widget-get widget :parent)))
2313
944c91b6
PA
2314(defun custom-add-see-also (widget &optional prefix)
2315 "Add `See also ...' to WIDGET if there are any links.
2316Insert PREFIX first if non-nil."
2317 (let* ((symbol (widget-get widget :value))
2318 (links (get symbol 'custom-links))
2319 (many (> (length links) 2))
2320 (buttons (widget-get widget :buttons))
2321 (indent (widget-get widget :indent)))
2322 (when links
2323 (when indent
2324 (insert-char ?\ indent))
2325 (when prefix
2326 (insert prefix))
2327 (insert "See also ")
2328 (while links
83dc149d
EZ
2329 (push (widget-create-child-and-convert
2330 widget (car links)
2331 :button-face 'custom-link
e1ec62a5
CY
2332 :mouse-face 'highlight
2333 :pressed-face 'highlight)
944c91b6
PA
2334 buttons)
2335 (setq links (cdr links))
2336 (cond ((null links)
2337 (insert ".\n"))
2338 ((null (cdr links))
2339 (if many
2340 (insert ", and ")
2341 (insert " and ")))
d3d4df42 2342 (t
944c91b6
PA
2343 (insert ", "))))
2344 (widget-put widget :buttons buttons))))
2345
06b60517 2346(defun custom-add-parent-links (widget &optional initial-string _doc-initial-string)
cd6c0940 2347 "Add \"Parent groups: ...\" to WIDGET if the group has parents.
08adfdbb 2348The value is non-nil if any parents were found.
cd6c0940 2349If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
944c91b6
PA
2350 (let ((name (widget-value widget))
2351 (type (widget-type widget))
2352 (buttons (widget-get widget :buttons))
d377bee9 2353 (start (point))
ac00d71c 2354 (parents nil))
f1201e3a 2355 (insert (or initial-string "Groups:"))
944c91b6 2356 (mapatoms (lambda (symbol)
08adfdbb
LT
2357 (when (member (list name type) (get symbol 'custom-group))
2358 (insert " ")
2359 (push (widget-create-child-and-convert
2360 widget 'custom-group-link
2361 :tag (custom-unlispify-tag-name symbol)
2362 symbol)
2363 buttons)
2364 (setq parents (cons symbol parents)))))
ac00d71c
PA
2365 (if parents
2366 (insert "\n")
d377bee9 2367 (delete-region start (point)))
ac00d71c
PA
2368 (widget-put widget :buttons buttons)
2369 parents))
944c91b6 2370
d3d4df42
DL
2371;;; The `custom-comment' Widget.
2372
2373;; like the editable field
ee5137b3
JPW
2374(defface custom-comment '((((type tty))
2375 :background "yellow3"
2376 :foreground "black")
2377 (((class grayscale color)
d478e69d 2378 (background light))
ee5137b3 2379 :background "gray85")
d478e69d
MB
2380 (((class grayscale color)
2381 (background dark))
ee5137b3 2382 :background "dim gray")
d478e69d 2383 (t
ee5137b3 2384 :slant italic))
6cda144f 2385 "Face used for comments on variables or faces."
d3d4df42
DL
2386 :version "21.1"
2387 :group 'custom-faces)
c4f6e489 2388(define-obsolete-face-alias 'custom-comment-face 'custom-comment "22.1")
d3d4df42
DL
2389
2390;; like font-lock-comment-face
d478e69d 2391(defface custom-comment-tag
d3d4df42
DL
2392 '((((class color) (background dark)) (:foreground "gray80"))
2393 (((class color) (background light)) (:foreground "blue4"))
2394 (((class grayscale) (background light))
b5555381 2395 (:foreground "DimGray" :weight bold :slant italic))
d3d4df42 2396 (((class grayscale) (background dark))
b5555381
RS
2397 (:foreground "LightGray" :weight bold :slant italic))
2398 (t (:weight bold)))
6200ac6c 2399 "Face used for the comment tag on variables or faces."
d3d4df42 2400 :group 'custom-faces)
c4f6e489 2401(define-obsolete-face-alias 'custom-comment-tag-face 'custom-comment-tag "22.1")
d3d4df42
DL
2402
2403(define-widget 'custom-comment 'string
164cfaeb 2404 "User comment."
d3d4df42 2405 :tag "Comment"
164cfaeb 2406 :help-echo "Edit a comment here."
6200ac6c
GM
2407 :sample-face 'custom-comment-tag
2408 :value-face 'custom-comment
164cfaeb
DL
2409 :shown nil
2410 :create 'custom-comment-create)
d3d4df42
DL
2411
2412(defun custom-comment-create (widget)
164cfaeb 2413 (let* ((null-comment (equal "" (widget-value widget))))
6171a945
DL
2414 (if (or (widget-get (widget-get widget :parent) :comment-shown)
2415 (not null-comment))
2416 (widget-default-create widget)
2417 ;; `widget-default-delete' expects markers in these slots --
2418 ;; maybe it shouldn't.
2419 (widget-put widget :from (point-marker))
2420 (widget-put widget :to (point-marker)))))
164cfaeb
DL
2421
2422(defun custom-comment-hide (widget)
2423 (widget-put (widget-get widget :parent) :comment-shown nil))
d3d4df42
DL
2424
2425;; Those functions are for the menu. WIDGET is NOT the comment widget. It's
2426;; the global custom one
2427(defun custom-comment-show (widget)
164cfaeb
DL
2428 (widget-put widget :comment-shown t)
2429 (custom-redraw widget)
2430 (widget-setup))
d3d4df42
DL
2431
2432(defun custom-comment-invisible-p (widget)
164cfaeb
DL
2433 (let ((val (widget-value (widget-get widget :comment-widget))))
2434 (and (equal "" val)
2435 (not (widget-get widget :comment-shown)))))
d3d4df42 2436
d543e20b
PA
2437;;; The `custom-variable' Widget.
2438
d478e69d 2439(defface custom-variable-tag
16b20ed9
GM
2440 `((((class color)
2441 (background dark))
9db1942d 2442 (:foreground "light blue" :weight bold))
ea81d57e
DN
2443 (((min-colors 88) (class color)
2444 (background light))
9db1942d 2445 (:foreground "blue1" :weight bold))
16b20ed9
GM
2446 (((class color)
2447 (background light))
9db1942d 2448 (:foreground "blue" :weight bold))
b5555381 2449 (t (:weight bold)))
d543e20b 2450 "Face used for unpushable variable tags."
bd042c03 2451 :group 'custom-faces)
c4f6e489
GM
2452(define-obsolete-face-alias 'custom-variable-tag-face
2453 'custom-variable-tag "22.1")
d543e20b 2454
d478e69d 2455(defface custom-variable-button '((t (:underline t :weight bold)))
d543e20b 2456 "Face used for pushable variable tags."
bd042c03 2457 :group 'custom-faces)
c4f6e489
GM
2458(define-obsolete-face-alias 'custom-variable-button-face
2459 'custom-variable-button "22.1")
d543e20b 2460
d64478da
KH
2461(defcustom custom-variable-default-form 'edit
2462 "Default form of displaying variable values."
2463 :type '(choice (const edit)
2464 (const lisp))
cd32a7ba
DN
2465 :group 'custom-buffer
2466 :version "20.3")
d64478da 2467
a075569a
LT
2468(defun custom-variable-documentation (variable)
2469 "Return documentation of VARIABLE for use in Custom buffer.
2470Normally just return the docstring. But if VARIABLE automatically
2471becomes buffer local when set, append a message to that effect."
2472 (if (and (local-variable-if-set-p variable)
2473 (or (not (local-variable-p variable))
2474 (with-temp-buffer
2475 (local-variable-if-set-p variable))))
2476 (concat (documentation-property variable 'variable-documentation)
2477 "\n
2478This variable automatically becomes buffer-local when set outside Custom.
2479However, setting it through Custom sets the default value.")
2480 (documentation-property variable 'variable-documentation)))
2481
d543e20b 2482(define-widget 'custom-variable 'custom
647f9993 2483 "A widget for displaying a Custom variable.
61328d7c
CY
2484The following properties have special meanings for this widget:
2485
2486:hidden-states should be a list of widget states for which the
2487 widget's initial contents are to be hidden.
2488
2489:custom-form should be a symbol describing how to display and
2490 edit the variable---either `edit' (using edit widgets),
2491 `lisp' (as a Lisp sexp), or `mismatch' (should not happen);
da16abfc
CY
2492 if nil, use the return value of `custom-variable-default-form'.
2493
2494:shown-value, if non-nil, should be a list whose `car' is the
2495 variable value to display in place of the current value.
2496
647bc502
CY
2497:custom-style describes the widget interface style; nil is the
2498 default style, while `simple' means a simpler interface that
2499 inhibits the magic custom-state widget."
944c91b6 2500 :format "%v"
d543e20b 2501 :help-echo "Set or reset this variable."
a075569a 2502 :documentation-property #'custom-variable-documentation
9097aeb7 2503 :custom-category 'option
d543e20b
PA
2504 :custom-state nil
2505 :custom-menu 'custom-variable-menu-create
61328d7c 2506 :custom-form nil
d543e20b
PA
2507 :value-create 'custom-variable-value-create
2508 :action 'custom-variable-action
647f9993 2509 :hidden-states '(standard)
d543e20b 2510 :custom-set 'custom-variable-set
5ae87ed4 2511 :custom-mark-to-save 'custom-variable-mark-to-save
d543e20b
PA
2512 :custom-reset-current 'custom-redraw
2513 :custom-reset-saved 'custom-variable-reset-saved
4f985043 2514 :custom-reset-standard 'custom-variable-reset-standard
5ae87ed4
MR
2515 :custom-mark-to-reset-standard 'custom-variable-mark-to-reset-standard
2516 :custom-standard-value 'custom-variable-standard-value
2517 :custom-state-set-and-redraw 'custom-variable-state-set-and-redraw)
d543e20b 2518
bd042c03
PA
2519(defun custom-variable-type (symbol)
2520 "Return a widget suitable for editing the value of SYMBOL.
d3d4df42 2521If SYMBOL has a `custom-type' property, use that.
f0fc8583
RS
2522Otherwise, try matching SYMBOL against `custom-guess-name-alist' and
2523try matching its doc string against `custom-guess-doc-alist'."
bd042c03 2524 (let* ((type (or (get symbol 'custom-type)
25ac13b5 2525 (and (not (get symbol 'standard-value))
bd042c03
PA
2526 (custom-guess-type symbol))
2527 'sexp))
2528 (options (get symbol 'custom-options))
2529 (tmp (if (listp type)
46fa5a83 2530 (copy-sequence type)
bd042c03
PA
2531 (list type))))
2532 (when options
2533 (widget-put tmp :options options))
2534 tmp))
2535
d543e20b 2536(defun custom-variable-value-create (widget)
164cfaeb 2537 "Here is where you edit the variable's value."
d543e20b 2538 (custom-load-widget widget)
d64478da
KH
2539 (unless (widget-get widget :custom-form)
2540 (widget-put widget :custom-form custom-variable-default-form))
d543e20b
PA
2541 (let* ((buttons (widget-get widget :buttons))
2542 (children (widget-get widget :children))
2543 (form (widget-get widget :custom-form))
d543e20b 2544 (symbol (widget-get widget :value))
d543e20b 2545 (tag (widget-get widget :tag))
bd042c03 2546 (type (custom-variable-type symbol))
d543e20b 2547 (conv (widget-convert type))
6d528fc5 2548 (get (or (get symbol 'custom-get) 'default-value))
944c91b6
PA
2549 (prefix (widget-get widget :custom-prefix))
2550 (last (widget-get widget :custom-last))
29a4c45b 2551 (style (widget-get widget :custom-style))
da16abfc
CY
2552 (value (let ((shown-value (widget-get widget :shown-value)))
2553 (cond (shown-value
2554 (car shown-value))
2555 ((default-boundp symbol)
2556 (funcall get symbol))
2557 (t (widget-get conv :value)))))
647f9993
CY
2558 (state (or (widget-get widget :custom-state)
2559 (if (memq (custom-variable-state symbol value)
2560 (widget-get widget :hidden-states))
2561 'hidden))))
2562
d543e20b 2563 ;; If we don't know the state, see if we need to edit it in lisp form.
647f9993
CY
2564 (unless state
2565 (setq state (if (custom-show type value) 'unknown 'hidden)))
d543e20b
PA
2566 (when (eq state 'unknown)
2567 (unless (widget-apply conv :match value)
f985c5f7 2568 (setq form 'mismatch)))
d543e20b 2569 ;; Now we can create the child widget.
944c91b6 2570 (cond ((eq custom-buffer-style 'tree)
da5ec617 2571 (insert prefix (if last " `--- " " |--- "))
944c91b6 2572 (push (widget-create-child-and-convert
c953515e 2573 widget 'custom-browse-variable-tag)
944c91b6
PA
2574 buttons)
2575 (insert " " tag "\n")
2576 (widget-put widget :buttons buttons))
2577 ((eq state 'hidden)
d543e20b 2578 ;; Indicate hidden value.
d3d4df42 2579 (push (widget-create-child-and-convert
647f9993 2580 widget 'custom-visibility
8697863a 2581 :help-echo "Show the value of this option."
895123f5 2582 :on-glyph "down"
647f9993 2583 :on "Hide"
895123f5 2584 :off-glyph "right"
7f663295 2585 :off "Show Value"
647bc502 2586 :action 'custom-toggle-hide-variable
3acab5ef 2587 nil)
647f9993
CY
2588 buttons)
2589 (insert " ")
2590 (push (widget-create-child-and-convert
2591 widget 'item
2592 :format "%{%t%} "
2593 :sample-face 'custom-variable-tag
2594 :tag tag
2595 :parent widget)
3acab5ef 2596 buttons))
f985c5f7 2597 ((memq form '(lisp mismatch))
d543e20b 2598 ;; In lisp mode edit the saved value when possible.
647f9993
CY
2599 (push (widget-create-child-and-convert
2600 widget 'custom-visibility
2601 :help-echo "Hide the value of this option."
2602 :on "Hide"
2603 :off "Show"
895123f5
CY
2604 :on-glyph "down"
2605 :off-glyph "right"
647bc502 2606 :action 'custom-toggle-hide-variable
647f9993
CY
2607 t)
2608 buttons)
2609 (insert " ")
d543e20b
PA
2610 (let* ((value (cond ((get symbol 'saved-value)
2611 (car (get symbol 'saved-value)))
25ac13b5
PA
2612 ((get symbol 'standard-value)
2613 (car (get symbol 'standard-value)))
d543e20b 2614 ((default-boundp symbol)
6d528fc5 2615 (custom-quote (funcall get symbol)))
d543e20b
PA
2616 (t
2617 (custom-quote (widget-get conv :value))))))
3acab5ef 2618 (insert (symbol-name symbol) ": ")
d3d4df42
DL
2619 (push (widget-create-child-and-convert
2620 widget 'sexp
d543e20b 2621 :button-face 'custom-variable-button-face
3acab5ef 2622 :format "%v"
d543e20b
PA
2623 :tag (symbol-name symbol)
2624 :parent widget
2625 :value value)
2626 children)))
2627 (t
2628 ;; Edit mode.
647f9993
CY
2629 (push (widget-create-child-and-convert
2630 widget 'custom-visibility
2631 :help-echo "Hide or show this option."
2632 :on "Hide"
2633 :off "Show"
895123f5
CY
2634 :on-glyph "down"
2635 :off-glyph "right"
647bc502 2636 :action 'custom-toggle-hide-variable
647f9993
CY
2637 t)
2638 buttons)
2639 (insert " ")
3acab5ef
PA
2640 (let* ((format (widget-get type :format))
2641 tag-format value-format)
2642 (unless (string-match ":" format)
896a6a5d 2643 (error "Bad format"))
3acab5ef
PA
2644 (setq tag-format (substring format 0 (match-end 0)))
2645 (setq value-format (substring format (match-end 0)))
2646 (push (widget-create-child-and-convert
d3d4df42 2647 widget 'item
3acab5ef
PA
2648 :format tag-format
2649 :action 'custom-tag-action
8697863a 2650 :help-echo "Change value of this option."
3acab5ef 2651 :mouse-down-action 'custom-tag-mouse-down-action
ee108e88
GM
2652 :button-face 'custom-variable-button
2653 :sample-face 'custom-variable-tag
3acab5ef
PA
2654 tag)
2655 buttons)
3acab5ef 2656 (push (widget-create-child-and-convert
d3d4df42 2657 widget type
3acab5ef
PA
2658 :format value-format
2659 :value value)
2660 children))))
944c91b6 2661 (unless (eq custom-buffer-style 'tree)
944c91b6
PA
2662 (unless (eq (preceding-char) ?\n)
2663 (widget-insert "\n"))
944c91b6 2664 ;; Create the magic button.
29a4c45b 2665 (unless (eq style 'simple)
da16abfc
CY
2666 (let ((magic (widget-create-child-and-convert
2667 widget 'custom-magic nil)))
2668 (widget-put widget :custom-magic magic)
2669 (push magic buttons)))
944c91b6 2670 (widget-put widget :buttons buttons)
944c91b6 2671 ;; Insert documentation.
9db1942d 2672 (widget-put widget :documentation-indent 3)
29a4c45b
CY
2673 (unless (and (eq style 'simple)
2674 (eq state 'hidden))
2675 (widget-add-documentation-string-button
2676 widget :visibility-widget 'custom-visibility))
d3d4df42
DL
2677
2678 ;; The comment field
2679 (unless (eq state 'hidden)
2680 (let* ((comment (get symbol 'variable-comment))
2681 (comment-widget
2682 (widget-create-child-and-convert
2683 widget 'custom-comment
2684 :parent widget
2685 :value (or comment ""))))
2686 (widget-put widget :comment-widget comment-widget)
2687 ;; Don't push it !!! Custom assumes that the first child is the
2688 ;; value one.
2689 (setq children (append children (list comment-widget)))))
647f9993 2690 ;; Update the rest of the properties.
d3d4df42
DL
2691 (widget-put widget :custom-form form)
2692 (widget-put widget :children children)
2693 ;; Now update the state.
2694 (if (eq state 'hidden)
2695 (widget-put widget :custom-state state)
2696 (custom-variable-state-set widget))
944c91b6
PA
2697 ;; See also.
2698 (unless (eq state 'hidden)
2699 (when (eq (widget-get widget :custom-level) 1)
2700 (custom-add-parent-links widget))
2701 (custom-add-see-also widget)))))
d543e20b 2702
06b60517 2703(defun custom-toggle-hide-variable (visibility-widget &rest _ignore)
647bc502
CY
2704 "Toggle the visibility of a `custom-variable' parent widget.
2705By default, this signals an error if the parent has unsaved
2706changes. If the parent has a `simple' :custom-style property,
2707the present value is saved to its :shown-value property instead."
2708 (let ((widget (widget-get visibility-widget :parent)))
2709 (unless (eq (widget-type widget) 'custom-variable)
2710 (error "Invalid widget type"))
2711 (custom-load-widget widget)
2712 (let ((state (widget-get widget :custom-state)))
2713 (if (eq state 'hidden)
2714 (widget-put widget :custom-state 'unknown)
2715 ;; In normal interface, widget can't be hidden if modified.
2716 (when (memq state '(invalid modified set))
2717 (if (eq (widget-get widget :custom-style) 'simple)
2718 (widget-put widget :shown-value
2719 (list (widget-value
2720 (car-safe
2721 (widget-get widget :children)))))
2722 (error "There are unsaved changes")))
2723 (widget-put widget :documentation-shown nil)
2724 (widget-put widget :custom-state 'hidden))
2725 (custom-redraw widget)
2726 (widget-setup))))
2727
3acab5ef
PA
2728(defun custom-tag-action (widget &rest args)
2729 "Pass :action to first child of WIDGET's parent."
2730 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2731 :action args))
2732
2733(defun custom-tag-mouse-down-action (widget &rest args)
2734 "Pass :mouse-down-action to first child of WIDGET's parent."
2735 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2736 :mouse-down-action args))
2737
647f9993
CY
2738(defun custom-variable-state (symbol val)
2739 "Return the state of SYMBOL if its value is VAL.
2740If SYMBOL has a non-nil `custom-get' property, it overrides VAL.
2741Possible return values are `standard', `saved', `set', `themed',
2742`changed', and `rogue'."
2743 (let* ((get (or (get symbol 'custom-get) 'default-value))
d543e20b 2744 (value (if (default-boundp symbol)
6d528fc5 2745 (funcall get symbol)
647f9993 2746 val))
d3d4df42 2747 (comment (get symbol 'variable-comment))
d543e20b 2748 tmp
647f9993
CY
2749 temp)
2750 (cond ((progn (setq tmp (get symbol 'customized-value))
2751 (setq temp
2752 (get symbol 'customized-variable-comment))
2753 (or tmp temp))
2754 (if (condition-case nil
2755 (and (equal value (eval (car tmp)))
2756 (equal comment temp))
2757 (error nil))
2758 'set
2759 'changed))
2760 ((progn (setq tmp (get symbol 'theme-value))
2761 (setq temp (get symbol 'saved-variable-comment))
2762 (or tmp temp))
2763 (if (condition-case nil
2764 (and (equal comment temp)
2765 (equal value
2766 (eval
2767 (car (custom-variable-theme-value
2768 symbol)))))
2769 (error nil))
2770 (cond
2771 ((eq (caar tmp) 'user) 'saved)
2772 ((eq (caar tmp) 'changed)
2773 (if (condition-case nil
2774 (and (null comment)
2775 (equal value
2776 (eval
2777 (car (get symbol 'standard-value)))))
2778 (error nil))
2779 ;; The value was originally set outside
2780 ;; custom, but it was set to the standard
2781 ;; value (probably an autoloaded defcustom).
2782 'standard
2783 'changed))
2784 (t 'themed))
2785 'changed))
2786 ((setq tmp (get symbol 'standard-value))
2787 (if (condition-case nil
2788 (and (equal value (eval (car tmp)))
2789 (equal comment nil))
2790 (error nil))
2791 'standard
2792 'changed))
2793 (t 'rogue))))
2794
2795(defun custom-variable-state-set (widget &optional state)
2796 "Set the state of WIDGET to STATE.
2797If STATE is nil, the value is computed by `custom-variable-state'."
2798 (widget-put widget :custom-state
2799 (or state (custom-variable-state (widget-value widget)
2800 (widget-get widget :value)))))
d543e20b 2801
4f985043
RS
2802(defun custom-variable-standard-value (widget)
2803 (get (widget-value widget) 'standard-value))
2804
d3d4df42 2805(defvar custom-variable-menu
70482877 2806 `(("Set for Current Session" custom-variable-set
0c731046 2807 (lambda (widget)
eaa99205 2808 (eq (widget-get widget :custom-state) 'modified)))
9b5007e7
GM
2809 ;; Note that in all the backquoted code in this file, we test
2810 ;; init-file-user rather than user-init-file. This is in case
2811 ;; cus-edit is loaded by something in site-start.el, because
2812 ;; user-init-file is not set at that stage.
2813 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00310.html
2814 ,@(when (or custom-file init-file-user)
70482877 2815 '(("Save for Future Sessions" custom-variable-save
eaa99205
CY
2816 (lambda (widget)
2817 (memq (widget-get widget :custom-state)
2818 '(modified set changed rogue))))))
70482877 2819 ("Undo Edits" custom-redraw
6d528fc5
PA
2820 (lambda (widget)
2821 (and (default-boundp (widget-value widget))
86bd10bc 2822 (memq (widget-get widget :custom-state) '(modified changed)))))
70482877 2823 ("Reset to Saved" custom-variable-reset-saved
6d528fc5 2824 (lambda (widget)
d3d4df42
DL
2825 (and (or (get (widget-value widget) 'saved-value)
2826 (get (widget-value widget) 'saved-variable-comment))
6d528fc5
PA
2827 (memq (widget-get widget :custom-state)
2828 '(modified set changed rogue)))))
9b5007e7 2829 ,@(when (or custom-file init-file-user)
70482877 2830 '(("Erase Customization" custom-variable-reset-standard
73e60f53
CY
2831 (lambda (widget)
2832 (and (get (widget-value widget) 'standard-value)
2833 (memq (widget-get widget :custom-state)
2834 '(modified set changed saved rogue)))))))
70482877
LT
2835 ("Set to Backup Value" custom-variable-reset-backup
2836 (lambda (widget)
2837 (get (widget-value widget) 'backup-value)))
2838 ("---" ignore ignore)
2839 ("Add Comment" custom-comment-show custom-comment-invisible-p)
eaa99205 2840 ("---" ignore ignore)
70482877 2841 ("Show Current Value" custom-variable-edit
73e60f53 2842 (lambda (widget)
eaa99205 2843 (eq (widget-get widget :custom-form) 'lisp)))
70482877 2844 ("Show Saved Lisp Expression" custom-variable-edit-lisp
eaa99205
CY
2845 (lambda (widget)
2846 (eq (widget-get widget :custom-form) 'edit))))
d543e20b 2847 "Alist of actions for the `custom-variable' widget.
6d528fc5
PA
2848Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2849the menu entry, ACTION is the function to call on the widget when the
2850menu is selected, and FILTER is a predicate which takes a `custom-variable'
2851widget as an argument, and returns non-nil if ACTION is valid on that
19d63704 2852widget. If FILTER is nil, ACTION is always valid.")
d543e20b
PA
2853
2854(defun custom-variable-action (widget &optional event)
2855 "Show the menu for `custom-variable' WIDGET.
2856Optional EVENT is the location for the menu."
2857 (if (eq (widget-get widget :custom-state) 'hidden)
6d528fc5 2858 (custom-toggle-hide widget)
86bd10bc
PA
2859 (unless (eq (widget-get widget :custom-state) 'modified)
2860 (custom-variable-state-set widget))
2861 (custom-redraw-magic widget)
d543e20b 2862 (let* ((completion-ignore-case t)
25ac13b5
PA
2863 (answer (widget-choose (concat "Operation on "
2864 (custom-unlispify-tag-name
2865 (widget-get widget :value)))
6d528fc5
PA
2866 (custom-menu-filter custom-variable-menu
2867 widget)
d543e20b
PA
2868 event)))
2869 (if answer
2870 (funcall answer widget)))))
2871
2872(defun custom-variable-edit (widget)
2873 "Edit value of WIDGET."
2874 (widget-put widget :custom-state 'unknown)
2875 (widget-put widget :custom-form 'edit)
2876 (custom-redraw widget))
2877
2878(defun custom-variable-edit-lisp (widget)
2365594b 2879 "Edit the Lisp representation of the value of WIDGET."
d543e20b
PA
2880 (widget-put widget :custom-state 'unknown)
2881 (widget-put widget :custom-form 'lisp)
2882 (custom-redraw widget))
2883
2884(defun custom-variable-set (widget)
2885 "Set the current value for the variable being edited by WIDGET."
6d528fc5
PA
2886 (let* ((form (widget-get widget :custom-form))
2887 (state (widget-get widget :custom-state))
2888 (child (car (widget-get widget :children)))
2889 (symbol (widget-value widget))
2890 (set (or (get symbol 'custom-set) 'set-default))
d3d4df42
DL
2891 (comment-widget (widget-get widget :comment-widget))
2892 (comment (widget-value comment-widget))
2893 val)
d543e20b 2894 (cond ((eq state 'hidden)
896a6a5d 2895 (error "Cannot set hidden variable"))
d543e20b
PA
2896 ((setq val (widget-apply child :validate))
2897 (goto-char (widget-get val :from))
2898 (error "%s" (widget-get val :error)))
f985c5f7 2899 ((memq form '(lisp mismatch))
d3d4df42
DL
2900 (when (equal comment "")
2901 (setq comment nil)
2902 ;; Make the comment invisible by hand if it's empty
164cfaeb 2903 (custom-comment-hide comment-widget))
bde4f354 2904 (custom-variable-backup-value widget)
25c6d447 2905 (custom-push-theme 'theme-value symbol 'user
c5d290fb 2906 'set (custom-quote (widget-value child)))
6d528fc5 2907 (funcall set symbol (eval (setq val (widget-value child))))
d3d4df42
DL
2908 (put symbol 'customized-value (list val))
2909 (put symbol 'variable-comment comment)
2910 (put symbol 'customized-variable-comment comment))
d543e20b 2911 (t
d3d4df42
DL
2912 (when (equal comment "")
2913 (setq comment nil)
2914 ;; Make the comment invisible by hand if it's empty
164cfaeb 2915 (custom-comment-hide comment-widget))
bde4f354 2916 (custom-variable-backup-value widget)
25c6d447 2917 (custom-push-theme 'theme-value symbol 'user
c5d290fb 2918 'set (custom-quote (widget-value child)))
6d528fc5 2919 (funcall set symbol (setq val (widget-value child)))
d3d4df42
DL
2920 (put symbol 'customized-value (list (custom-quote val)))
2921 (put symbol 'variable-comment comment)
2922 (put symbol 'customized-variable-comment comment)))
d543e20b
PA
2923 (custom-variable-state-set widget)
2924 (custom-redraw-magic widget)))
2925
5ae87ed4
MR
2926(defun custom-variable-mark-to-save (widget)
2927 "Set value and mark for saving the variable edited by WIDGET."
6d528fc5
PA
2928 (let* ((form (widget-get widget :custom-form))
2929 (state (widget-get widget :custom-state))
2930 (child (car (widget-get widget :children)))
2931 (symbol (widget-value widget))
2932 (set (or (get symbol 'custom-set) 'set-default))
d3d4df42
DL
2933 (comment-widget (widget-get widget :comment-widget))
2934 (comment (widget-value comment-widget))
6d528fc5 2935 val)
d543e20b 2936 (cond ((eq state 'hidden)
896a6a5d 2937 (error "Cannot set hidden variable"))
d543e20b
PA
2938 ((setq val (widget-apply child :validate))
2939 (goto-char (widget-get val :from))
6b292312 2940 (error "Saving %s: %s" symbol (widget-get val :error)))
f985c5f7 2941 ((memq form '(lisp mismatch))
d3d4df42
DL
2942 (when (equal comment "")
2943 (setq comment nil)
2944 ;; Make the comment invisible by hand if it's empty
164cfaeb 2945 (custom-comment-hide comment-widget))
d543e20b 2946 (put symbol 'saved-value (list (widget-value child)))
c942535f 2947 (custom-push-theme 'theme-value symbol 'user
c5d290fb 2948 'set (custom-quote (widget-value child)))
d3d4df42
DL
2949 (funcall set symbol (eval (widget-value child)))
2950 (put symbol 'variable-comment comment)
2951 (put symbol 'saved-variable-comment comment))
d543e20b 2952 (t
d3d4df42
DL
2953 (when (equal comment "")
2954 (setq comment nil)
2955 ;; Make the comment invisible by hand if it's empty
164cfaeb 2956 (custom-comment-hide comment-widget))
d3d4df42
DL
2957 (put symbol 'saved-value
2958 (list (custom-quote (widget-value child))))
c942535f 2959 (custom-push-theme 'theme-value symbol 'user
c5d290fb 2960 'set (custom-quote (widget-value child)))
d3d4df42
DL
2961 (funcall set symbol (widget-value child))
2962 (put symbol 'variable-comment comment)
2963 (put symbol 'saved-variable-comment comment)))
d543e20b 2964 (put symbol 'customized-value nil)
5ae87ed4
MR
2965 (put symbol 'customized-variable-comment nil)))
2966
2967(defsubst custom-variable-state-set-and-redraw (widget)
2968 "Set state of variable widget WIDGET and redraw with current settings."
2969 (custom-variable-state-set widget)
2970 (custom-redraw-magic widget))
2971
2972(defun custom-variable-save (widget)
2973 "Save value of variable edited by widget WIDGET."
2974 (custom-variable-mark-to-save widget)
2975 (custom-save-all)
2976 (custom-variable-state-set-and-redraw widget))
d543e20b
PA
2977
2978(defun custom-variable-reset-saved (widget)
bde4f354 2979 "Restore the saved value for the variable being edited by WIDGET.
67177975 2980This also updates the buffer to show that value.
bde4f354
RS
2981The value that was current before this operation
2982becomes the backup value, so you can get it again."
6d528fc5 2983 (let* ((symbol (widget-value widget))
d3d4df42 2984 (set (or (get symbol 'custom-set) 'set-default))
d3d4df42
DL
2985 (value (get symbol 'saved-value))
2986 (comment (get symbol 'saved-variable-comment)))
2987 (cond ((or value comment)
2988 (put symbol 'variable-comment comment)
bde4f354 2989 (custom-variable-backup-value widget)
d358aa10 2990 (custom-push-theme 'theme-value symbol 'user 'set (car-safe value))
d3d4df42
DL
2991 (condition-case nil
2992 (funcall set symbol (eval (car value)))
2993 (error nil)))
2994 (t
2995 (error "No saved value for %s" symbol)))
d543e20b 2996 (put symbol 'customized-value nil)
d3d4df42 2997 (put symbol 'customized-variable-comment nil)
d543e20b 2998 (widget-put widget :custom-state 'unknown)
d3d4df42 2999 ;; This call will possibly make the comment invisible
d543e20b
PA
3000 (custom-redraw widget)))
3001
5ae87ed4
MR
3002(defun custom-variable-mark-to-reset-standard (widget)
3003 "Mark to restore standard setting for the variable edited by widget WIDGET.
3004If `custom-reset-standard-variables-list' is nil, save, reset and
3005redraw the widget immediately."
d358aa10 3006 (let* ((symbol (widget-value widget)))
25ac13b5 3007 (if (get symbol 'standard-value)
25c6d447 3008 (custom-variable-backup-value widget)
5dd0cad0 3009 (error "No standard setting known for %S" symbol))
164cfaeb 3010 (put symbol 'variable-comment nil)
d543e20b 3011 (put symbol 'customized-value nil)
d3d4df42 3012 (put symbol 'customized-variable-comment nil)
d358aa10 3013 (custom-push-theme 'theme-value symbol 'user 'reset)
25c6d447 3014 (custom-theme-recalc-variable symbol)
5ae87ed4
MR
3015 (if (and custom-reset-standard-variables-list
3016 (or (get symbol 'saved-value) (get symbol 'saved-variable-comment)))
3017 (progn
3018 (put symbol 'saved-value nil)
3019 (put symbol 'saved-variable-comment nil)
3020 ;; Append this to `custom-reset-standard-variables-list' to
3021 ;; have `custom-reset-standard-save-and-update' save setting
3022 ;; to the file, update the widget's state, and redraw it.
3023 (setq custom-reset-standard-variables-list
3024 (cons widget custom-reset-standard-variables-list)))
3025 (when (or (get symbol 'saved-value) (get symbol 'saved-variable-comment))
3026 (put symbol 'saved-value nil)
3027 (put symbol 'saved-variable-comment nil)
3028 (custom-save-all))
3029 (widget-put widget :custom-state 'unknown)
3030 ;; This call will possibly make the comment invisible
3031 (custom-redraw widget))))
3032
3033(defun custom-variable-reset-standard (widget)
3034 "Restore standard setting for the variable edited by WIDGET.
3035This operation eliminates any saved setting for the variable,
3036restoring it to the state of a variable that has never been customized.
3037The value that was current before this operation
3038becomes the backup value, so you can get it again."
3039 (let (custom-reset-standard-variables-list)
3040 (custom-variable-mark-to-reset-standard widget)))
d543e20b 3041
bde4f354
RS
3042(defun custom-variable-backup-value (widget)
3043 "Back up the current value for WIDGET's variable.
3044The backup value is kept in the car of the `backup-value' property."
3045 (let* ((symbol (widget-value widget))
3046 (get (or (get symbol 'custom-get) 'default-value))
3047 (type (custom-variable-type symbol))
3048 (conv (widget-convert type))
3049 (value (if (default-boundp symbol)
3050 (funcall get symbol)
3051 (widget-get conv :value))))
3052 (put symbol 'backup-value (list value))))
3053
3054(defun custom-variable-reset-backup (widget)
3055 "Restore the backup value for the variable being edited by WIDGET.
3056The value that was current before this operation
3057becomes the backup value, so you can use this operation repeatedly
3058to switch between two values."
3059 (let* ((symbol (widget-value widget))
3060 (set (or (get symbol 'custom-set) 'set-default))
3061 (value (get symbol 'backup-value))
3062 (comment-widget (widget-get widget :comment-widget))
3063 (comment (widget-value comment-widget)))
3064 (if value
3065 (progn
3066 (custom-variable-backup-value widget)
25c6d447 3067 (custom-push-theme 'theme-value symbol 'user 'set value)
bde4f354
RS
3068 (condition-case nil
3069 (funcall set symbol (car value))
3070 (error nil)))
3071 (error "No backup value for %s" symbol))
3072 (put symbol 'customized-value (list (car value)))
3073 (put symbol 'variable-comment comment)
3074 (put symbol 'customized-variable-comment comment)
3075 (custom-variable-state-set widget)
3076 ;; This call will possibly make the comment invisible
3077 (custom-redraw widget)))
3078
12bafdaa
CY
3079;;; The `custom-visibility' Widget
3080
3081(define-widget 'custom-visibility 'visibility
3082 "Show or hide a documentation string."
3083 :button-face 'custom-visibility
3084 :pressed-face 'custom-visibility
3085 :mouse-face 'highlight
647f9993 3086 :pressed-face 'highlight
895123f5
CY
3087 :on-glyph nil
3088 :off-glyph nil)
12bafdaa
CY
3089
3090(defface custom-visibility
3091 '((t :height 0.8 :inherit link))
3092 "Face for the `custom-visibility' widget."
3093 :version "23.1"
3094 :group 'custom-faces)
3095
d543e20b
PA
3096;;; The `custom-face-edit' Widget.
3097
3098(define-widget 'custom-face-edit 'checklist
587faadd
CY
3099 "Widget for editing face attributes.
3100The following properties have special meanings for this widget:
3101
3102:value is a plist of face attributes.
3103
3104:default-face-attributes, if non-nil, is a plist of defaults for
3105face attributes (as specified by a `default' defface entry)."
61328d7c
CY
3106 :format "%v"
3107 :extra-offset 3
d3d4df42 3108 :button-args '(:help-echo "Control whether this attribute has any effect.")
d75fa08f
RS
3109 :value-to-internal 'custom-face-edit-fix-value
3110 :match (lambda (widget value)
ee1f522d 3111 (widget-checklist-match widget
d75fa08f 3112 (custom-face-edit-fix-value widget value)))
61328d7c 3113 :value-create 'custom-face-edit-value-create
3ea051cb 3114 :convert-widget 'custom-face-edit-convert-widget
d543e20b 3115 :args (mapcar (lambda (att)
61328d7c 3116 (list 'group :inline t
d543e20b 3117 :sibling-args (widget-get (nth 1 att) :sibling-args)
d3d4df42 3118 (list 'const :format "" :value (nth 0 att))
d543e20b
PA
3119 (nth 1 att)))
3120 custom-face-attributes))
3121
61328d7c 3122(defun custom-face-edit-value-create (widget)
587faadd
CY
3123 (let* ((alist (widget-checklist-match-find
3124 widget (widget-get widget :value)))
61328d7c
CY
3125 (args (widget-get widget :args))
3126 (show-all (widget-get widget :show-all-attributes))
587faadd
CY
3127 (buttons (widget-get widget :buttons))
3128 (defaults (widget-checklist-match-find
3129 widget
3130 (widget-get widget :default-face-attributes)))
61328d7c
CY
3131 entry)
3132 (unless (looking-back "^ *")
3133 (insert ?\n))
3134 (insert-char ?\s (widget-get widget :extra-offset))
587faadd 3135 (if (or alist defaults show-all)
61328d7c 3136 (dolist (prop args)
587faadd
CY
3137 (setq entry (or (assq prop alist)
3138 (assq prop defaults)))
61328d7c
CY
3139 (if (or entry show-all)
3140 (widget-checklist-add-item widget prop entry)))
3141 (insert (propertize "-- Empty face --" 'face 'shadow) ?\n))
3142 (let ((indent (widget-get widget :indent)))
3143 (if indent (insert-char ?\s (widget-get widget :indent))))
3144 (push (widget-create-child-and-convert
3145 widget 'visibility
3146 :help-echo "Show or hide all face attributes."
3147 :button-face 'custom-visibility
3148 :pressed-face 'custom-visibility
3149 :mouse-face 'highlight
3150 :on "Hide Unused Attributes" :off "Show All Attributes"
895123f5 3151 :on-glyph nil :off-glyph nil
61328d7c
CY
3152 :always-active t
3153 :action 'custom-face-edit-value-visibility-action
3154 show-all)
3155 buttons)
3156 (insert ?\n)
3157 (widget-put widget :buttons buttons)
3158 (widget-put widget :children (nreverse (widget-get widget :children)))))
3159
06b60517 3160(defun custom-face-edit-value-visibility-action (widget &rest _ignore)
61328d7c
CY
3161 ;; Toggle hiding of face attributes.
3162 (let ((parent (widget-get widget :parent)))
3163 (widget-put parent :show-all-attributes
3164 (not (widget-get parent :show-all-attributes)))
3165 (custom-redraw parent)))
3166
06b60517 3167(defun custom-face-edit-fix-value (_widget value)
0bbe869a
AS
3168 "Ignoring WIDGET, convert :bold and :italic in VALUE to new form.
3169Also change :reverse-video to :inverse-video."
05d22d02 3170 (custom-fix-face-spec value))
d75fa08f 3171
3ea051cb
MB
3172(defun custom-face-edit-convert-widget (widget)
3173 "Convert :args as widget types in WIDGET."
3174 (widget-put
3175 widget
3176 :args (mapcar (lambda (arg)
3177 (widget-convert arg
3178 :deactivate 'custom-face-edit-deactivate
3179 :activate 'custom-face-edit-activate
3180 :delete 'custom-face-edit-delete))
3181 (widget-get widget :args)))
3182 widget)
3183
587faadd
CY
3184(defconst custom-face-edit (widget-convert 'custom-face-edit)
3185 "Converted version of the `custom-face-edit' widget.")
3186
3ea051cb
MB
3187(defun custom-face-edit-deactivate (widget)
3188 "Make face widget WIDGET inactive for user modifications."
3189 (unless (widget-get widget :inactive)
3190 (let ((tag (custom-face-edit-attribute-tag widget))
3191 (from (copy-marker (widget-get widget :from)))
3ea051cb
MB
3192 (value (widget-value widget))
3193 (inhibit-read-only t)
3194 (inhibit-modification-hooks t))
3195 (save-excursion
3196 (goto-char from)
3197 (widget-default-delete widget)
61328d7c 3198 (insert tag ": " (propertize "--" 'face 'shadow) "\n")
3ea051cb
MB
3199 (widget-put widget :inactive
3200 (cons value (cons from (- (point) from))))))))
3201
3202(defun custom-face-edit-activate (widget)
47fdaab8 3203 "Make face widget WIDGET active for user modifications."
3ea051cb
MB
3204 (let ((inactive (widget-get widget :inactive))
3205 (inhibit-read-only t)
3206 (inhibit-modification-hooks t))
3207 (when (consp inactive)
3208 (save-excursion
3209 (goto-char (car (cdr inactive)))
3210 (delete-region (point) (+ (point) (cdr (cdr inactive))))
3211 (widget-put widget :inactive nil)
3212 (widget-apply widget :create)
3213 (widget-value-set widget (car inactive))
3214 (widget-setup)))))
3215
3216(defun custom-face-edit-delete (widget)
3127aa13 3217 "Remove WIDGET from the buffer."
3ea051cb
MB
3218 (let ((inactive (widget-get widget :inactive))
3219 (inhibit-read-only t)
3220 (inhibit-modification-hooks t))
3221 (if (not inactive)
3222 ;; Widget is alive, we don't have to do anything special
3223 (widget-default-delete widget)
3224 ;; WIDGET is already deleted because we did so to inactivate it;
3225 ;; now just get rid of the label we put in its place.
3226 (delete-region (car (cdr inactive))
3227 (+ (car (cdr inactive)) (cdr (cdr inactive))))
3228 (widget-put widget :inactive nil))))
ee1f522d 3229
3ea051cb
MB
3230
3231(defun custom-face-edit-attribute-tag (widget)
6cda144f 3232 "Return the first :tag property in WIDGET or one of its children."
3ea051cb
MB
3233 (let ((tag (widget-get widget :tag)))
3234 (or (and (not (equal tag "")) tag)
3235 (let ((children (widget-get widget :children)))
3236 (while (and (null tag) children)
3237 (setq tag (custom-face-edit-attribute-tag (pop children))))
3238 tag))))
3239
d543e20b
PA
3240;;; The `custom-display' Widget.
3241
3242(define-widget 'custom-display 'menu-choice
3243 "Select a display type."
3244 :tag "Display"
3245 :value t
3246 :help-echo "Specify frames where the face attributes should be used."
3247 :args '((const :tag "all" t)
b9afd6dd 3248 (const :tag "defaults" default)
d543e20b
PA
3249 (checklist
3250 :offset 0
3251 :extra-offset 9
3252 :args ((group :sibling-args (:help-echo "\
3253Only match the specified window systems.")
3254 (const :format "Type: "
3255 type)
3256 (checklist :inline t
3257 :offset 0
3258 (const :format "X "
3259 :sibling-args (:help-echo "\
3260The X11 Window System.")
3261 x)
3262 (const :format "PM "
3263 :sibling-args (:help-echo "\
3264OS/2 Presentation Manager.")
3265 pm)
b97aca27 3266 (const :format "W32 "
d543e20b 3267 :sibling-args (:help-echo "\
b97aca27
GV
3268Windows NT/9X.")
3269 w32)
edfda783
AR
3270 (const :format "NS "
3271 :sibling-args (:help-echo "\
3272GNUstep or Macintosh OS Cocoa interface.")
3273 ns)
d543e20b
PA
3274 (const :format "DOS "
3275 :sibling-args (:help-echo "\
3276Plain MS-DOS.")
3277 pc)
3278 (const :format "TTY%n"
3279 :sibling-args (:help-echo "\
3280Plain text terminals.")
3281 tty)))
3282 (group :sibling-args (:help-echo "\
3283Only match the frames with the specified color support.")
3284 (const :format "Class: "
3285 class)
3286 (checklist :inline t
3287 :offset 0
3288 (const :format "Color "
3289 :sibling-args (:help-echo "\
3290Match color frames.")
3291 color)
3292 (const :format "Grayscale "
3293 :sibling-args (:help-echo "\
3294Match grayscale frames.")
3295 grayscale)
3296 (const :format "Monochrome%n"
3297 :sibling-args (:help-echo "\
3298Match frames with no color support.")
3299 mono)))
3300 (group :sibling-args (:help-echo "\
c4d9734c
JL
3301The minimum number of colors the frame should support.")
3302 (const :format "" min-colors)
3303 (integer :tag "Minimum number of colors" ))
3304 (group :sibling-args (:help-echo "\
d543e20b
PA
3305Only match frames with the specified intensity.")
3306 (const :format "\
3307Background brightness: "
3308 background)
3309 (checklist :inline t
3310 :offset 0
3311 (const :format "Light "
3312 :sibling-args (:help-echo "\
3313Match frames with light backgrounds.")
3314 light)
3315 (const :format "Dark\n"
3316 :sibling-args (:help-echo "\
3317Match frames with dark backgrounds.")
2b32d1a7
MB
3318 dark)))
3319 (group :sibling-args (:help-echo "\
3320Only match frames that support the specified face attributes.")
3321 (const :format "Supports attributes:" supports)
4abe16b5 3322 (custom-face-edit :inline t :format "%n%v"))))))
d543e20b
PA
3323
3324;;; The `custom-face' Widget.
3325
d478e69d 3326(defface custom-face-tag
01b38d61 3327 `((t :inherit custom-variable-tag))
d543e20b 3328 "Face used for face tags."
bd042c03 3329 :group 'custom-faces)
c4f6e489 3330(define-obsolete-face-alias 'custom-face-tag-face 'custom-face-tag "22.1")
d543e20b 3331
d64478da
KH
3332(defcustom custom-face-default-form 'selected
3333 "Default form of displaying face definition."
3334 :type '(choice (const all)
3335 (const selected)
3336 (const lisp))
cd32a7ba
DN
3337 :group 'custom-buffer
3338 :version "20.3")
d64478da 3339
d543e20b 3340(define-widget 'custom-face 'custom
61328d7c 3341 "Widget for customizing a face.
61328d7c
CY
3342The following properties have special meanings for this widget:
3343
587faadd
CY
3344:value is the face name (a symbol).
3345
61328d7c
CY
3346:custom-form should be a symbol describing how to display and
3347 edit the face attributes---either `selected' (attributes for
3348 selected display only), `all' (all attributes), `lisp' (as a
3349 Lisp sexp), or `mismatch' (should not happen); if nil, use
587faadd
CY
3350 the return value of `custom-face-default-form'.
3351
647bc502
CY
3352:custom-style describes the widget interface style; nil is the
3353 default style, while `simple' means a simpler interface that
3354 inhibits the magic custom-state widget.
da16abfc
CY
3355
3356:sample-indent, if non-nil, is the number of columns to which to
3357 indent the face sample (an integer).
587faadd 3358
da16abfc 3359:shown-value, if non-nil, is the face spec to display as the value
647bc502 3360 of the widget, instead of the current face spec."
ee108e88 3361 :sample-face 'custom-face-tag
d543e20b 3362 :help-echo "Set or reset this face."
23c0fb21 3363 :documentation-property #'face-doc-string
d543e20b
PA
3364 :value-create 'custom-face-value-create
3365 :action 'custom-face-action
9097aeb7 3366 :custom-category 'face
61328d7c 3367 :custom-form nil
d543e20b 3368 :custom-set 'custom-face-set
5ae87ed4 3369 :custom-mark-to-save 'custom-face-mark-to-save
d543e20b
PA
3370 :custom-reset-current 'custom-redraw
3371 :custom-reset-saved 'custom-face-reset-saved
25ac13b5 3372 :custom-reset-standard 'custom-face-reset-standard
5ae87ed4 3373 :custom-mark-to-reset-standard 'custom-face-mark-to-reset-standard
4f985043 3374 :custom-standard-value 'custom-face-standard-value
5ae87ed4 3375 :custom-state-set-and-redraw 'custom-face-state-set-and-redraw
d543e20b
PA
3376 :custom-menu 'custom-face-menu-create)
3377
d3d4df42 3378(define-widget 'custom-face-all 'editable-list
d543e20b
PA
3379 "An editable list of display specifications and attributes."
3380 :entry-format "%i %d %v"
3381 :insert-button-args '(:help-echo "Insert new display specification here.")
3382 :append-button-args '(:help-echo "Append new display specification here.")
3383 :delete-button-args '(:help-echo "Delete this display specification.")
3384 :args '((group :format "%v" custom-display custom-face-edit)))
3385
3386(defconst custom-face-all (widget-convert 'custom-face-all)
3387 "Converted version of the `custom-face-all' widget.")
3388
3ea051cb 3389(defun custom-filter-face-spec (spec filter-index &optional default-filter)
f5b50baa
MB
3390 "Return a canonicalized version of SPEC using.
3391FILTER-INDEX is the index in the entry for each attribute in
3392`custom-face-attributes' at which the appropriate filter function can be
3393found, and DEFAULT-FILTER is the filter to apply for attributes that
3394don't specify one."
3395 (mapcar (lambda (entry)
3396 ;; Filter a single face-spec entry
3397 (let ((tests (car entry))
3398 (unfiltered-attrs
3399 ;; Handle both old- and new-style attribute syntax
3400 (if (listp (car (cdr entry)))
3401 (car (cdr entry))
3402 (cdr entry)))
3403 (filtered-attrs nil))
3404 ;; Filter each face attribute
3405 (while unfiltered-attrs
3406 (let* ((attr (pop unfiltered-attrs))
3407 (pre-filtered-value (pop unfiltered-attrs))
3408 (filter
3409 (or (nth filter-index (assq attr custom-face-attributes))
3410 default-filter))
3411 (filtered-value
3412 (if filter
3413 (funcall filter pre-filtered-value)
3414 pre-filtered-value)))
3415 (push filtered-value filtered-attrs)
3416 (push attr filtered-attrs)))
3417 ;;
3418 (list tests filtered-attrs)))
3419 spec))
3420
3421(defun custom-pre-filter-face-spec (spec)
3422 "Return SPEC changed as necessary for editing by the face customization widget.
3423SPEC must be a full face spec."
3ea051cb 3424 (custom-filter-face-spec spec 2))
f5b50baa
MB
3425
3426(defun custom-post-filter-face-spec (spec)
3427 "Return the customized SPEC in a form suitable for setting the face."
3ea051cb 3428 (custom-filter-face-spec spec 3))
f5b50baa 3429
76c16af8
CY
3430(defun custom-face-widget-to-spec (widget)
3431 "Return a face spec corresponding to WIDGET.
3432WIDGET should be a `custom-face' widget."
3433 (unless (eq (widget-type widget) 'custom-face)
3434 (error "Invalid widget"))
3435 (let ((child (car (widget-get widget :children))))
3436 (custom-post-filter-face-spec
3437 (if (eq (widget-type child) 'custom-face-edit)
3438 `((t ,(widget-value child)))
3439 (widget-value child)))))
3440
3441(defun custom-face-get-current-spec (face)
3442 (let ((spec (or (get face 'customized-face)
3443 (get face 'saved-face)
3444 (get face 'face-defface-spec)
3445 ;; Attempt to construct it.
3446 `((t ,(custom-face-attributes-get
3447 face (selected-frame)))))))
3448 ;; If the user has changed this face in some other way,
3449 ;; edit it as the user has specified it.
3450 (if (not (face-spec-match-p face spec (selected-frame)))
3451 (setq spec `((t ,(face-attr-construct face (selected-frame))))))
3452 (custom-pre-filter-face-spec spec)))
3453
06b60517 3454(defun custom-toggle-hide-face (visibility-widget &rest _ignore)
647bc502
CY
3455 "Toggle the visibility of a `custom-face' parent widget.
3456By default, this signals an error if the parent has unsaved
3457changes. If the parent has a `simple' :custom-style property,
3458the present value is saved to its :shown-value property instead."
3459 (let ((widget (widget-get visibility-widget :parent)))
3460 (unless (eq (widget-type widget) 'custom-face)
3461 (error "Invalid widget type"))
3462 (custom-load-widget widget)
3463 (let ((state (widget-get widget :custom-state)))
3464 (if (eq state 'hidden)
3465 (widget-put widget :custom-state 'unknown)
3466 ;; In normal interface, widget can't be hidden if modified.
3467 (when (memq state '(invalid modified set))
3468 (if (eq (widget-get widget :custom-style) 'simple)
3469 (widget-put widget :shown-value
3470 (custom-face-widget-to-spec widget))
3471 (error "There are unsaved changes")))
3472 (widget-put widget :documentation-shown nil)
3473 (widget-put widget :custom-state 'hidden))
3474 (custom-redraw widget)
3475 (widget-setup))))
3476
d543e20b 3477(defun custom-face-value-create (widget)
944c91b6 3478 "Create a list of the display specifications for WIDGET."
61328d7c
CY
3479 (let* ((buttons (widget-get widget :buttons))
3480 (symbol (widget-get widget :value))
3481 (tag (or (widget-get widget :tag)
3482 (prin1-to-string symbol)))
3483 (hiddenp (eq (widget-get widget :custom-state) 'hidden))
647bc502 3484 (style (widget-get widget :custom-style))
61328d7c
CY
3485 children)
3486
3487 (if (eq custom-buffer-style 'tree)
3488
3489 ;; Draw a tree-style `custom-face' widget
3490 (progn
3491 (insert (widget-get widget :custom-prefix)
3492 (if (widget-get widget :custom-last) " `--- " " |--- "))
3493 (push (widget-create-child-and-convert
3494 widget 'custom-browse-face-tag)
3495 buttons)
3496 (insert " " tag "\n")
3497 (widget-put widget :buttons buttons))
3498
3499 ;; Draw an ordinary `custom-face' widget
3500 (let ((opoint (point)))
3501 ;; Visibility indicator.
3502 (push (widget-create-child-and-convert
3503 widget 'custom-visibility
3504 :help-echo "Hide or show this face."
3505 :on "Hide" :off "Show"
895123f5 3506 :on-glyph "down" :off-glyph "right"
647bc502 3507 :action 'custom-toggle-hide-face
61328d7c
CY
3508 (not hiddenp))
3509 buttons)
3510 ;; Face name (tag).
3511 (insert " " tag)
3512 (widget-specify-sample widget opoint (point)))
3513 (insert
3514 (cond ((eq custom-buffer-style 'face) " ")
3515 ((string-match "face\\'" tag) ":")
3516 (t " face: ")))
3517
3518 ;; Face sample.
587faadd
CY
3519 (let ((sample-indent (widget-get widget :sample-indent))
3520 (indent-tabs-mode nil))
3521 (and sample-indent
3522 (<= (current-column) sample-indent)
3523 (indent-to-column sample-indent)))
61328d7c
CY
3524 (push (widget-create-child-and-convert
3525 widget 'item
da16abfc
CY
3526 :format "[%{%t%}]"
3527 :sample-face (let ((spec (widget-get widget :shown-value)))
3528 (if spec (face-spec-choose spec) symbol))
3529 :tag "sample")
61328d7c 3530 buttons)
61328d7c 3531 (insert "\n")
da16abfc
CY
3532
3533 ;; Magic.
647bc502 3534 (unless (eq (widget-get widget :custom-style) 'simple)
da16abfc
CY
3535 (let ((magic (widget-create-child-and-convert
3536 widget 'custom-magic nil)))
3537 (widget-put widget :custom-magic magic)
3538 (push magic buttons)))
61328d7c
CY
3539
3540 ;; Update buttons.
3541 (widget-put widget :buttons buttons)
3542
3543 ;; Insert documentation.
647bc502 3544 (unless (and hiddenp (eq style 'simple))
587faadd
CY
3545 (widget-put widget :documentation-indent 3)
3546 (widget-add-documentation-string-button
3547 widget :visibility-widget 'custom-visibility)
3548 ;; The comment field
3549 (unless hiddenp
3550 (let* ((comment (get symbol 'face-comment))
3551 (comment-widget
3552 (widget-create-child-and-convert
3553 widget 'custom-comment
3554 :parent widget
3555 :value (or comment ""))))
3556 (widget-put widget :comment-widget comment-widget)
3557 (push comment-widget children))))
61328d7c
CY
3558
3559 ;; Editor.
3560 (unless (eq (preceding-char) ?\n)
3561 (insert "\n"))
3562 (unless hiddenp
3563 (custom-load-widget widget)
3564 (unless (widget-get widget :custom-form)
3565 (widget-put widget :custom-form custom-face-default-form))
3566
da16abfc
CY
3567 (let* ((spec (or (widget-get widget :shown-value)
3568 (custom-face-get-current-spec symbol)))
61328d7c
CY
3569 (form (widget-get widget :custom-form))
3570 (indent (widget-get widget :indent))
587faadd 3571 face-alist face-entry spec-default spec-match editor)
61328d7c 3572
587faadd
CY
3573 ;; Find a display in SPEC matching the selected display.
3574 ;; This will use the usual face customization interface.
3575 (setq face-alist spec)
3576 (when (eq (car-safe (car-safe face-alist)) 'default)
3577 (setq spec-default (pop face-alist)))
3578
3579 (while (and face-alist (listp face-alist) (null spec-match))
3580 (setq face-entry (car face-alist))
3581 (and (listp face-entry)
3582 (face-spec-set-match-display (car face-entry)
3583 (selected-frame))
3584 (widget-apply custom-face-edit :match (cadr face-entry))
3585 (setq spec-match face-entry))
3586 (setq face-alist (cdr face-alist)))
3587
3588 ;; Insert the appropriate editing widget.
3589 (setq editor
3590 (cond
3591 ((and (eq form 'selected)
3592 (or spec-match spec-default))
3593 (when indent (insert-char ?\s indent))
3594 (widget-create-child-and-convert
3595 widget 'custom-face-edit
3596 :value (cadr spec-match)
3597 :default-face-attributes (cadr spec-default)))
3598 ((and (not (eq form 'lisp))
3599 (widget-apply custom-face-all :match spec))
3600 (widget-create-child-and-convert
3601 widget 'custom-face-all :value spec))
3602 (t
3603 (when indent
3604 (insert-char ?\s indent))
3605 (widget-create-child-and-convert
3606 widget 'sexp :value spec))))
61328d7c 3607 (custom-face-state-set widget)
587faadd 3608 (push editor children)
61328d7c 3609 (widget-put widget :children children))))))
d543e20b 3610
d3d4df42 3611(defvar custom-face-menu
70482877 3612 `(("Set for Current Session" custom-face-set)
9b5007e7 3613 ,@(when (or custom-file init-file-user)
633bb8a9 3614 '(("Save for Future Sessions" custom-face-save)))
70482877
LT
3615 ("Undo Edits" custom-redraw
3616 (lambda (widget)
3617 (memq (widget-get widget :custom-state) '(modified changed))))
3618 ("Reset to Saved" custom-face-reset-saved
0c731046
CY
3619 (lambda (widget)
3620 (or (get (widget-value widget) 'saved-face)
3621 (get (widget-value widget) 'saved-face-comment))))
9b5007e7 3622 ,@(when (or custom-file init-file-user)
70482877 3623 '(("Erase Customization" custom-face-reset-standard
73e60f53
CY
3624 (lambda (widget)
3625 (get (widget-value widget) 'face-defface-spec)))))
eaa99205 3626 ("---" ignore ignore)
70482877
LT
3627 ("Add Comment" custom-comment-show custom-comment-invisible-p)
3628 ("---" ignore ignore)
3629 ("For Current Display" custom-face-edit-selected
eaa99205
CY
3630 (lambda (widget)
3631 (not (eq (widget-get widget :custom-form) 'selected))))
70482877
LT
3632 ("For All Kinds of Displays" custom-face-edit-all
3633 (lambda (widget)
3634 (not (eq (widget-get widget :custom-form) 'all))))
3635 ("Show Lisp Expression" custom-face-edit-lisp
eaa99205
CY
3636 (lambda (widget)
3637 (not (eq (widget-get widget :custom-form) 'lisp)))))
d543e20b 3638 "Alist of actions for the `custom-face' widget.
6d528fc5
PA
3639Each entry has the form (NAME ACTION FILTER) where NAME is the name of
3640the menu entry, ACTION is the function to call on the widget when the
3641menu is selected, and FILTER is a predicate which takes a `custom-face'
3642widget as an argument, and returns non-nil if ACTION is valid on that
19d63704 3643widget. If FILTER is nil, ACTION is always valid.")
d543e20b
PA
3644
3645(defun custom-face-edit-selected (widget)
3646 "Edit selected attributes of the value of WIDGET."
3647 (widget-put widget :custom-state 'unknown)
3648 (widget-put widget :custom-form 'selected)
3649 (custom-redraw widget))
3650
3651(defun custom-face-edit-all (widget)
3652 "Edit all attributes of the value of WIDGET."
3653 (widget-put widget :custom-state 'unknown)
3654 (widget-put widget :custom-form 'all)
3655 (custom-redraw widget))
3656
3657(defun custom-face-edit-lisp (widget)
2365594b 3658 "Edit the Lisp representation of the value of WIDGET."
d543e20b
PA
3659 (widget-put widget :custom-state 'unknown)
3660 (widget-put widget :custom-form 'lisp)
3661 (custom-redraw widget))
3662
76c16af8
CY
3663(defun custom-face-state (face)
3664 "Return the current state of the face FACE.
3665This is one of `set', `saved', `changed', `themed', or `rogue'."
3666 (let* ((comment (get face 'face-comment))
a4992f73 3667 (state
76c16af8
CY
3668 (cond
3669 ((or (get face 'customized-face)
3670 (get face 'customized-face-comment))
3671 (if (equal (get face 'customized-face-comment) comment)
3672 'set
3673 'changed))
3674 ((or (get face 'saved-face)
3675 (get face 'saved-face-comment))
3676 (if (equal (get face 'saved-face-comment) comment)
3677 (cond
3678 ((eq 'user (caar (get face 'theme-face)))
3679 'saved)
3680 ((eq 'changed (caar (get face 'theme-face)))
3681 'changed)
3682 (t 'themed))
3683 'changed))
3684 ((get face 'face-defface-spec)
3685 (if (equal comment nil)
3686 'standard
3687 'changed))
3688 (t 'rogue))))
3689 ;; If the user called set-face-attribute to change the default for
3690 ;; new frames, this face is "set outside of Customize".
a4992f73 3691 (if (and (not (eq state 'rogue))
76c16af8
CY
3692 (get face 'face-modified))
3693 'changed
3694 state)))
3695
3696(defun custom-face-state-set (widget)
3697 "Set the state of WIDGET."
3698 (widget-put widget :custom-state
3699 (custom-face-state (widget-value widget))))
d543e20b
PA
3700
3701(defun custom-face-action (widget &optional event)
3702 "Show the menu for `custom-face' WIDGET.
3703Optional EVENT is the location for the menu."
3704 (if (eq (widget-get widget :custom-state) 'hidden)
6d528fc5 3705 (custom-toggle-hide widget)
d543e20b
PA
3706 (let* ((completion-ignore-case t)
3707 (symbol (widget-get widget :value))
25ac13b5
PA
3708 (answer (widget-choose (concat "Operation on "
3709 (custom-unlispify-tag-name symbol))
6d528fc5
PA
3710 (custom-menu-filter custom-face-menu
3711 widget)
3712 event)))
d543e20b
PA
3713 (if answer
3714 (funcall answer widget)))))
3715
3716(defun custom-face-set (widget)
3717 "Make the face attributes in WIDGET take effect."
3718 (let* ((symbol (widget-value widget))
76c16af8 3719 (value (custom-face-widget-to-spec widget))
d3d4df42
DL
3720 (comment-widget (widget-get widget :comment-widget))
3721 (comment (widget-value comment-widget)))
3722 (when (equal comment "")
3723 (setq comment nil)
3724 ;; Make the comment invisible by hand if it's empty
164cfaeb 3725 (custom-comment-hide comment-widget))
d543e20b 3726 (put symbol 'customized-face value)
e02577b7 3727 (custom-push-theme 'theme-face symbol 'user 'set value)
f5b50baa 3728 (if (face-spec-choose value)
d50e9d5b 3729 (face-spec-set symbol value t)
f5b50baa
MB
3730 ;; face-set-spec ignores empty attribute lists, so just give it
3731 ;; something harmless instead.
d50e9d5b 3732 (face-spec-set symbol '((t :foreground unspecified)) t))
d3d4df42
DL
3733 (put symbol 'customized-face-comment comment)
3734 (put symbol 'face-comment comment)
d543e20b
PA
3735 (custom-face-state-set widget)
3736 (custom-redraw-magic widget)))
3737
5ae87ed4
MR
3738(defun custom-face-mark-to-save (widget)
3739 "Mark for saving the face edited by WIDGET."
d543e20b 3740 (let* ((symbol (widget-value widget))
76c16af8 3741 (value (custom-face-widget-to-spec widget))
d3d4df42
DL
3742 (comment-widget (widget-get widget :comment-widget))
3743 (comment (widget-value comment-widget)))
3744 (when (equal comment "")
3745 (setq comment nil)
3746 ;; Make the comment invisible by hand if it's empty
164cfaeb 3747 (custom-comment-hide comment-widget))
b76747af 3748 (custom-push-theme 'theme-face symbol 'user 'set value)
e475612a 3749 (if (face-spec-choose value)
d50e9d5b 3750 (face-spec-set symbol value t)
e475612a
MB
3751 ;; face-set-spec ignores empty attribute lists, so just give it
3752 ;; something harmless instead.
d50e9d5b 3753 (face-spec-set symbol '((t :foreground unspecified)) t))
4f985043
RS
3754 (unless (eq (widget-get widget :custom-state) 'standard)
3755 (put symbol 'saved-face value))
d543e20b 3756 (put symbol 'customized-face nil)
d3d4df42
DL
3757 (put symbol 'face-comment comment)
3758 (put symbol 'customized-face-comment nil)
5ae87ed4
MR
3759 (put symbol 'saved-face-comment comment)))
3760
3761(defsubst custom-face-state-set-and-redraw (widget)
3762 "Set state of face widget WIDGET and redraw with current settings."
3763 (custom-face-state-set widget)
3764 (custom-redraw-magic widget))
3765
3766(defun custom-face-save (widget)
3767 "Save the face edited by WIDGET."
3768 (custom-face-mark-to-save widget)
3769 (custom-save-all)
3770 (custom-face-state-set-and-redraw widget))
d543e20b 3771
633bb8a9
LT
3772;; For backward compatibility.
3773(define-obsolete-function-alias 'custom-face-save-command 'custom-face-save
3774 "22.1")
3775
d543e20b
PA
3776(defun custom-face-reset-saved (widget)
3777 "Restore WIDGET to the face's default attributes."
3778 (let* ((symbol (widget-value widget))
3779 (child (car (widget-get widget :children)))
d3d4df42
DL
3780 (value (get symbol 'saved-face))
3781 (comment (get symbol 'saved-face-comment))
3782 (comment-widget (widget-get widget :comment-widget)))
3783 (unless (or value comment)
d543e20b
PA
3784 (error "No saved value for this face"))
3785 (put symbol 'customized-face nil)
d3d4df42 3786 (put symbol 'customized-face-comment nil)
25c6d447 3787 (custom-push-theme 'theme-face symbol 'user 'set value)
d50e9d5b 3788 (face-spec-set symbol value t)
d3d4df42 3789 (put symbol 'face-comment comment)
d543e20b 3790 (widget-value-set child value)
d3d4df42
DL
3791 ;; This call manages the comment visibility
3792 (widget-value-set comment-widget (or comment ""))
d543e20b
PA
3793 (custom-face-state-set widget)
3794 (custom-redraw-magic widget)))
3795
4f985043
RS
3796(defun custom-face-standard-value (widget)
3797 (get (widget-value widget) 'face-defface-spec))
3798
5ae87ed4
MR
3799(defun custom-face-mark-to-reset-standard (widget)
3800 "Restore widget WIDGET to the face's standard attribute values.
3801If `custom-reset-standard-faces-list' is nil, save, reset and
3802redraw the widget immediately."
d543e20b
PA
3803 (let* ((symbol (widget-value widget))
3804 (child (car (widget-get widget :children)))
d3d4df42
DL
3805 (value (get symbol 'face-defface-spec))
3806 (comment-widget (widget-get widget :comment-widget)))
d543e20b 3807 (unless value
5dd0cad0 3808 (error "No standard setting for this face"))
d543e20b 3809 (put symbol 'customized-face nil)
d3d4df42 3810 (put symbol 'customized-face-comment nil)
d358aa10 3811 (custom-push-theme 'theme-face symbol 'user 'reset)
d50e9d5b 3812 (face-spec-set symbol value t)
25c6d447 3813 (custom-theme-recalc-face symbol)
5ae87ed4
MR
3814 (if (and custom-reset-standard-faces-list
3815 (or (get symbol 'saved-face) (get symbol 'saved-face-comment)))
3816 ;; Do this later.
3817 (progn
3818 (put symbol 'saved-face nil)
3819 (put symbol 'saved-face-comment nil)
3820 ;; Append this to `custom-reset-standard-faces-list' and have
3821 ;; `custom-reset-standard-save-and-update' save setting to the
3822 ;; file, update the widget's state, and redraw it.
3823 (setq custom-reset-standard-faces-list
3824 (cons widget custom-reset-standard-faces-list)))
3825 (when (or (get symbol 'saved-face) (get symbol 'saved-face-comment))
3826 (put symbol 'saved-face nil)
3827 (put symbol 'saved-face-comment nil)
3828 (custom-save-all))
3829 (put symbol 'face-comment nil)
3830 (widget-value-set child
3831 (custom-pre-filter-face-spec
3832 (list (list t (custom-face-attributes-get
3833 symbol nil)))))
3834 ;; This call manages the comment visibility
3835 (widget-value-set comment-widget "")
3836 (custom-face-state-set widget)
3837 (custom-redraw-magic widget))))
3838
3839(defun custom-face-reset-standard (widget)
3840 "Restore WIDGET to the face's standard attribute values.
3841This operation eliminates any saved attributes for the face,
3842restoring it to the state of a face that has never been customized."
3843 (let (custom-reset-standard-faces-list)
3844 (custom-face-mark-to-reset-standard widget)))
d543e20b
PA
3845
3846;;; The `face' Widget.
3847
1833b7b3
RS
3848(defvar widget-face-prompt-value-history nil
3849 "History of input to `widget-face-prompt-value'.")
3850
0e739597
DP
3851(define-widget 'face 'symbol
3852 "A Lisp face name (with sample)."
49698bb7 3853 :format "%{%t%}: (%{sample%}) %v"
0e739597
DP
3854 :tag "Face"
3855 :value 'default
3856 :sample-face-get 'widget-face-sample-face-get
3857 :notify 'widget-face-notify
06b60517 3858 :match (lambda (_widget value) (facep value))
bcd70d97
SM
3859 :completions (apply-partially #'completion-table-with-predicate
3860 obarray #'facep 'strict)
1833b7b3
RS
3861 :prompt-match 'facep
3862 :prompt-history 'widget-face-prompt-value-history
1833b7b3
RS
3863 :validate (lambda (widget)
3864 (unless (facep (widget-value widget))
0e739597
DP
3865 (widget-put widget
3866 :error (format "Invalid face: %S"
3867 (widget-value widget)))
3868 widget)))
3869
3870(defun widget-face-sample-face-get (widget)
3871 (let ((value (widget-value widget)))
3872 (if (facep value)
3873 value
3874 'default)))
3875
3876(defun widget-face-notify (widget child &optional event)
3877 "Update the sample, and notify the parent."
3878 (overlay-put (widget-get widget :sample-overlay)
3879 'face (widget-apply widget :sample-face-get))
3880 (widget-default-notify widget child event))
1833b7b3 3881
d543e20b
PA
3882
3883;;; The `hook' Widget.
3884
3885(define-widget 'hook 'list
c8c9333c 3886 "An Emacs Lisp hook."
06b60517 3887 :value-to-internal (lambda (_widget value)
5aa3f181 3888 (if (and value (symbolp value))
f985c5f7
PA
3889 (list value)
3890 value))
3891 :match (lambda (widget value)
3892 (or (symbolp value)
4743fc91 3893 (widget-group-match widget value)))
2365594b
DL
3894 ;; Avoid adding undefined functions to the hook, especially for
3895 ;; things like `find-file-hook' or even more basic ones, to avoid
3896 ;; chaos.
3897 :set (lambda (symbol value)
d4881668
SM
3898 (dolist (elt value)
3899 (if (fboundp elt)
3900 (add-hook symbol elt))))
d543e20b
PA
3901 :convert-widget 'custom-hook-convert-widget
3902 :tag "Hook")
3903
3904(defun custom-hook-convert-widget (widget)
3c708e98 3905 ;; Handle `:options'.
d543e20b 3906 (let* ((options (widget-get widget :options))
d3d4df42 3907 (other `(editable-list :inline t
d543e20b
PA
3908 :entry-format "%i %d%v"
3909 (function :format " %v")))
3910 (args (if options
3911 (list `(checklist :inline t
3912 ,@(mapcar (lambda (entry)
3913 `(function-item ,entry))
3914 options))
3915 other)
3916 (list other))))
3917 (widget-put widget :args args)
3918 widget))
3919
944c91b6
PA
3920;;; The `custom-group-link' Widget.
3921
3922(define-widget 'custom-group-link 'link
3923 "Show parent in other window when activated."
192e44fc
JL
3924 :button-face 'custom-link
3925 :mouse-face 'highlight
e1ec62a5 3926 :pressed-face 'highlight
b62c92bb 3927 :help-echo "Create customization buffer for this group."
f3093f77
CY
3928 :keymap custom-mode-link-map
3929 :follow-link 'mouse-face
944c91b6
PA
3930 :action 'custom-group-link-action)
3931
06b60517 3932(defun custom-group-link-action (widget &rest _ignore)
944c91b6
PA
3933 (customize-group (widget-value widget)))
3934
d543e20b
PA
3935;;; The `custom-group' Widget.
3936
b62c92bb 3937(defcustom custom-group-tag-faces nil
d543e20b 3938 ;; In XEmacs, this ought to play games with font size.
d3d4df42 3939 ;; Fixme: make it do so in Emacs.
d543e20b
PA
3940 "Face used for group tags.
3941The first member is used for level 1 groups, the second for level 2,
d478e69d 3942and so forth. The remaining group tags are shown with `custom-group-tag'."
d543e20b 3943 :type '(repeat face)
bd042c03 3944 :group 'custom-faces)
d543e20b 3945
d478e69d 3946(defface custom-group-tag-1
16b20ed9
GM
3947 `((((class color)
3948 (background dark))
b5555381 3949 (:foreground "pink" :weight bold :height 1.2 :inherit variable-pitch))
ea81d57e
DN
3950 (((min-colors 88) (class color)
3951 (background light))
3952 (:foreground "red1" :weight bold :height 1.2 :inherit variable-pitch))
16b20ed9
GM
3953 (((class color)
3954 (background light))
b5555381
RS
3955 (:foreground "red" :weight bold :height 1.2 :inherit variable-pitch))
3956 (t (:weight bold)))
16b20ed9
GM
3957 "Face used for group tags."
3958 :group 'custom-faces)
c4f6e489 3959(define-obsolete-face-alias 'custom-group-tag-face-1 'custom-group-tag-1 "22.1")
16b20ed9 3960
d478e69d 3961(defface custom-group-tag
16b20ed9
GM
3962 `((((class color)
3963 (background dark))
9db1942d 3964 (:foreground "light blue" :weight bold :height 1.2 :inherit variable-pitch))
ea81d57e
DN
3965 (((min-colors 88) (class color)
3966 (background light))
9db1942d 3967 (:foreground "blue1" :weight bold :height 1.2 :inherit variable-pitch))
16b20ed9
GM
3968 (((class color)
3969 (background light))
9db1942d 3970 (:foreground "blue" :weight bold :height 1.2 :inherit variable-pitch))
b5555381 3971 (t (:weight bold)))
d543e20b 3972 "Face used for low level group tags."
bd042c03 3973 :group 'custom-faces)
c4f6e489 3974(define-obsolete-face-alias 'custom-group-tag-face 'custom-group-tag "22.1")
d543e20b
PA
3975
3976(define-widget 'custom-group 'custom
3977 "Customize group."
944c91b6 3978 :format "%v"
d543e20b
PA
3979 :sample-face-get 'custom-group-sample-face-get
3980 :documentation-property 'group-documentation
3981 :help-echo "Set or reset all members of this group."
3982 :value-create 'custom-group-value-create
3983 :action 'custom-group-action
9097aeb7 3984 :custom-category 'group
d543e20b 3985 :custom-set 'custom-group-set
5ae87ed4 3986 :custom-mark-to-save 'custom-group-mark-to-save
d543e20b
PA
3987 :custom-reset-current 'custom-group-reset-current
3988 :custom-reset-saved 'custom-group-reset-saved
25ac13b5 3989 :custom-reset-standard 'custom-group-reset-standard
5ae87ed4
MR
3990 :custom-mark-to-reset-standard 'custom-group-mark-to-reset-standard
3991 :custom-state-set-and-redraw 'custom-group-state-set-and-redraw
d543e20b
PA
3992 :custom-menu 'custom-group-menu-create)
3993
3994(defun custom-group-sample-face-get (widget)
3995 ;; Use :sample-face.
3996 (or (nth (1- (widget-get widget :custom-level)) custom-group-tag-faces)
d478e69d 3997 'custom-group-tag))
d543e20b 3998
8691cfa7
RS
3999(define-widget 'custom-group-visibility 'visibility
4000 "An indicator and manipulator for hidden group contents."
4001 :create 'custom-group-visibility-create)
4002
4003(defun custom-group-visibility-create (widget)
4004 (let ((visible (widget-value widget)))
4005 (if visible
4006 (insert "--------")))
4007 (widget-default-create widget))
4008
4ee1cf9f
PA
4009(defun custom-group-members (symbol groups-only)
4010 "Return SYMBOL's custom group members.
4011If GROUPS-ONLY non-nil, return only those members that are groups."
4012 (if (not groups-only)
4013 (get symbol 'custom-group)
4014 (let (members)
4015 (dolist (entry (get symbol 'custom-group))
4016 (when (eq (nth 1 entry) 'custom-group)
4017 (push entry members)))
4018 (nreverse members))))
4019
d543e20b 4020(defun custom-group-value-create (widget)
944c91b6 4021 "Insert a customize group for WIDGET in the current buffer."
2de2cb02 4022 (unless (eq (widget-get widget :custom-state) 'hidden)
2ee398c4 4023 (custom-load-widget widget))
4ee1cf9f
PA
4024 (let* ((state (widget-get widget :custom-state))
4025 (level (widget-get widget :custom-level))
f985c5f7 4026 ;; (indent (widget-get widget :indent))
4ee1cf9f
PA
4027 (prefix (widget-get widget :custom-prefix))
4028 (buttons (widget-get widget :buttons))
4029 (tag (widget-get widget :tag))
4030 (symbol (widget-value widget))
4031 (members (custom-group-members symbol
4032 (and (eq custom-buffer-style 'tree)
c19aae89
MR
4033 custom-browse-only-groups)))
4034 (doc (widget-docstring widget)))
944c91b6 4035 (cond ((and (eq custom-buffer-style 'tree)
c953515e 4036 (eq state 'hidden)
4ee1cf9f 4037 (or members (custom-unloaded-widget-p widget)))
c953515e 4038 (custom-browse-insert-prefix prefix)
944c91b6 4039 (push (widget-create-child-and-convert
d3d4df42 4040 widget 'custom-browse-visibility
da5ec617 4041 ;; :tag-glyph "plus"
df816618 4042 :tag "+")
944c91b6
PA
4043 buttons)
4044 (insert "-- ")
da5ec617 4045 ;; (widget-glyph-insert nil "-- " "horizontal")
944c91b6 4046 (push (widget-create-child-and-convert
c953515e 4047 widget 'custom-browse-group-tag)
944c91b6
PA
4048 buttons)
4049 (insert " " tag "\n")
4050 (widget-put widget :buttons buttons))
4051 ((and (eq custom-buffer-style 'tree)
4ee1cf9f 4052 (zerop (length members)))
c953515e 4053 (custom-browse-insert-prefix prefix)
da5ec617
PA
4054 (insert "[ ]-- ")
4055 ;; (widget-glyph-insert nil "[ ]" "empty")
4056 ;; (widget-glyph-insert nil "-- " "horizontal")
d3d4df42 4057 (push (widget-create-child-and-convert
c953515e 4058 widget 'custom-browse-group-tag)
944c91b6
PA
4059 buttons)
4060 (insert " " tag "\n")
4061 (widget-put widget :buttons buttons))
4062 ((eq custom-buffer-style 'tree)
c953515e 4063 (custom-browse-insert-prefix prefix)
4ee1cf9f 4064 (if (zerop (length members))
d3d4df42 4065 (progn
c953515e 4066 (custom-browse-insert-prefix prefix)
da5ec617
PA
4067 (insert "[ ]-- ")
4068 ;; (widget-glyph-insert nil "[ ]" "empty")
4069 ;; (widget-glyph-insert nil "-- " "horizontal")
d3d4df42 4070 (push (widget-create-child-and-convert
c953515e 4071 widget 'custom-browse-group-tag)
944c91b6
PA
4072 buttons)
4073 (insert " " tag "\n")
4074 (widget-put widget :buttons buttons))
d3d4df42
DL
4075 (push (widget-create-child-and-convert
4076 widget 'custom-browse-visibility
da5ec617
PA
4077 ;; :tag-glyph "minus"
4078 :tag "-")
944c91b6 4079 buttons)
da5ec617
PA
4080 (insert "-\\ ")
4081 ;; (widget-glyph-insert nil "-\\ " "top")
d3d4df42 4082 (push (widget-create-child-and-convert
c953515e 4083 widget 'custom-browse-group-tag)
944c91b6
PA
4084 buttons)
4085 (insert " " tag "\n")
4086 (widget-put widget :buttons buttons)
4087 (message "Creating group...")
647f9993
CY
4088 (let* ((members (custom-sort-items
4089 members
4090 ;; Never sort the top-level custom group.
4091 (unless (eq symbol 'emacs)
4092 custom-browse-sort-alphabetically)
da5ec617 4093 custom-browse-order-groups))
944c91b6
PA
4094 (prefixes (widget-get widget :custom-prefixes))
4095 (custom-prefix-list (custom-prefix-add symbol prefixes))
944c91b6
PA
4096 (extra-prefix (if (widget-get widget :custom-last)
4097 " "
4098 " | "))
4099 (prefix (concat prefix extra-prefix))
4100 children entry)
4101 (while members
4102 (setq entry (car members)
4103 members (cdr members))
4ee1cf9f
PA
4104 (push (widget-create-child-and-convert
4105 widget (nth 1 entry)
4106 :group widget
4107 :tag (custom-unlispify-tag-name (nth 0 entry))
4108 :custom-prefixes custom-prefix-list
4109 :custom-level (1+ level)
4110 :custom-last (null members)
4111 :value (nth 0 entry)
4112 :custom-prefix prefix)
4113 children))
944c91b6
PA
4114 (widget-put widget :children (reverse children)))
4115 (message "Creating group...done")))
4116 ;; Nested style.
4117 ((eq state 'hidden)
4118 ;; Create level indicator.
944c91b6 4119 ;; Create tag.
944c91b6
PA
4120 (if (eq custom-buffer-style 'links)
4121 (push (widget-create-child-and-convert
d3d4df42 4122 widget 'custom-group-link
9db1942d 4123 :tag tag
944c91b6
PA
4124 symbol)
4125 buttons)
9db1942d
CY
4126 (insert-char ?\ (* custom-buffer-indent (1- level)))
4127 (insert "-- ")
d3d4df42 4128 (push (widget-create-child-and-convert
98d5aafe 4129 widget 'custom-group-visibility
944c91b6
PA
4130 :help-echo "Show members of this group."
4131 :action 'custom-toggle-parent
4132 (not (eq state 'hidden)))
4133 buttons))
9db1942d 4134 (insert " : ")
944c91b6
PA
4135 ;; Create magic button.
4136 (let ((magic (widget-create-child-and-convert
4137 widget 'custom-magic nil)))
4138 (widget-put widget :custom-magic magic)
4139 (push magic buttons))
4140 ;; Update buttons.
4141 (widget-put widget :buttons buttons)
4142 ;; Insert documentation.
26c7b3ef
RS
4143 (if (and (eq custom-buffer-style 'links) (> level 1))
4144 (widget-put widget :documentation-indent 0))
12bafdaa
CY
4145 (widget-add-documentation-string-button
4146 widget :visibility-widget 'custom-visibility))
4147
944c91b6
PA
4148 ;; Nested style.
4149 (t ;Visible.
647f9993
CY
4150 ;; Draw a horizontal line (this works for both graphical
4151 ;; and text displays):
4152 (let ((p (point)))
4153 (insert "\n")
4154 (put-text-property p (1+ p) 'face '(:underline t))
4155 (overlay-put (make-overlay p (1+ p))
4156 'before-string
4157 (propertize "\n" 'face '(:underline t)
4158 'display '(space :align-to 999))))
4159
d377bee9 4160 ;; Add parent groups references above the group.
647f9993
CY
4161 (when (eq level 1)
4162 (if (custom-add-parent-links widget "Parent groups:")
4163 (insert "\n")))
944c91b6 4164 (insert-char ?\ (* custom-buffer-indent (1- level)))
944c91b6
PA
4165 ;; Create tag.
4166 (let ((start (point)))
9db1942d 4167 (insert tag " group: ")
944c91b6 4168 (widget-specify-sample widget start (point)))
1e3d9386
MR
4169 (cond
4170 ((not doc)
4171 (insert " Group definition missing. "))
4172 ((< (length doc) 50)
4173 (insert doc)))
944c91b6
PA
4174 ;; Create visibility indicator.
4175 (unless (eq custom-buffer-style 'links)
4176 (insert "--------")
d3d4df42 4177 (push (widget-create-child-and-convert
944c91b6
PA
4178 widget 'visibility
4179 :help-echo "Hide members of this group."
4180 :action 'custom-toggle-parent
4181 (not (eq state 'hidden)))
4182 buttons)
4183 (insert " "))
647f9993 4184 (insert "\n")
944c91b6
PA
4185 ;; Create magic button.
4186 (let ((magic (widget-create-child-and-convert
d3d4df42 4187 widget 'custom-magic
944c91b6
PA
4188 :indent 0
4189 nil)))
4190 (widget-put widget :custom-magic magic)
4191 (push magic buttons))
4192 ;; Update buttons.
4193 (widget-put widget :buttons buttons)
4194 ;; Insert documentation.
c19aae89
MR
4195 (when (and doc (>= (length doc) 50))
4196 (widget-add-documentation-string-button
4197 widget :visibility-widget 'custom-visibility))
12bafdaa 4198
d377bee9
RS
4199 ;; Parent groups.
4200 (if nil ;;; This should test that the buffer
4201 ;;; was not made to display a group.
4202 (when (eq level 1)
4203 (insert-char ?\ custom-buffer-indent)
4204 (custom-add-parent-links widget)))
d3d4df42 4205 (custom-add-see-also widget
944c91b6
PA
4206 (make-string (* custom-buffer-indent level)
4207 ?\ ))
4208 ;; Members.
4209 (message "Creating group...")
647f9993
CY
4210 (let* ((members (custom-sort-items
4211 members
4212 ;; Never sort the top-level custom group.
4213 (unless (eq symbol 'emacs)
4214 custom-buffer-sort-alphabetically)
4215 custom-buffer-order-groups))
944c91b6
PA
4216 (prefixes (widget-get widget :custom-prefixes))
4217 (custom-prefix-list (custom-prefix-add symbol prefixes))
647f9993 4218 (len (length members))
944c91b6 4219 (count 0)
647f9993
CY
4220 (reporter (make-progress-reporter
4221 "Creating group entries..." 0 len))
4222 children)
4223 (setq children
4224 (mapcar
4225 (lambda (entry)
4226 (widget-insert "\n")
4227 (progress-reporter-update reporter (setq count (1+ count)))
4228 (let ((sym (nth 0 entry))
06b60517 4229 (type (nth 1 entry)))
647f9993
CY
4230 (prog1
4231 (widget-create-child-and-convert
4232 widget type
4233 :group widget
4234 :tag (custom-unlispify-tag-name sym)
4235 :custom-prefixes custom-prefix-list
4236 :custom-level (1+ level)
4237 :value sym)
4238 (unless (eq (preceding-char) ?\n)
4239 (widget-insert "\n")))))
4240 members))
fadbdfea 4241 (mapc 'custom-magic-reset children)
944c91b6
PA
4242 (widget-put widget :children children)
4243 (custom-group-state-update widget)
647f9993 4244 (progress-reporter-done reporter))
944c91b6 4245 ;; End line
d64b8a68
CY
4246 (let ((p (1+ (point))))
4247 (insert "\n\n")
647f9993
CY
4248 (put-text-property p (1+ p) 'face '(:underline t))
4249 (overlay-put (make-overlay p (1+ p))
4250 'before-string
4251 (propertize "\n" 'face '(:underline t)
4252 'display '(space :align-to 999))))))))
d543e20b 4253
d3d4df42 4254(defvar custom-group-menu
70482877 4255 `(("Set for Current Session" custom-group-set
eaa99205
CY
4256 (lambda (widget)
4257 (eq (widget-get widget :custom-state) 'modified)))
9b5007e7 4258 ,@(when (or custom-file init-file-user)
70482877 4259 '(("Save for Future Sessions" custom-group-save
eaa99205
CY
4260 (lambda (widget)
4261 (memq (widget-get widget :custom-state) '(modified set))))))
70482877 4262 ("Undo Edits" custom-group-reset-current
6d528fc5 4263 (lambda (widget)
86bd10bc 4264 (memq (widget-get widget :custom-state) '(modified))))
70482877 4265 ("Reset to Saved" custom-group-reset-saved
6d528fc5 4266 (lambda (widget)
86bd10bc 4267 (memq (widget-get widget :custom-state) '(modified set))))
9b5007e7 4268 ,@(when (or custom-file init-file-user)
70482877 4269 '(("Erase Customization" custom-group-reset-standard
73e60f53 4270 (lambda (widget)
eaa99205 4271 (memq (widget-get widget :custom-state) '(modified set saved)))))))
d543e20b 4272 "Alist of actions for the `custom-group' widget.
6d528fc5
PA
4273Each entry has the form (NAME ACTION FILTER) where NAME is the name of
4274the menu entry, ACTION is the function to call on the widget when the
4275menu is selected, and FILTER is a predicate which takes a `custom-group'
4276widget as an argument, and returns non-nil if ACTION is valid on that
d3d4df42 4277widget. If FILTER is nil, ACTION is always valid.")
d543e20b
PA
4278
4279(defun custom-group-action (widget &optional event)
4280 "Show the menu for `custom-group' WIDGET.
4281Optional EVENT is the location for the menu."
4282 (if (eq (widget-get widget :custom-state) 'hidden)
6d528fc5 4283 (custom-toggle-hide widget)
d543e20b 4284 (let* ((completion-ignore-case t)
25ac13b5
PA
4285 (answer (widget-choose (concat "Operation on "
4286 (custom-unlispify-tag-name
4287 (widget-get widget :value)))
6d528fc5
PA
4288 (custom-menu-filter custom-group-menu
4289 widget)
d543e20b
PA
4290 event)))
4291 (if answer
4292 (funcall answer widget)))))
4293
4294(defun custom-group-set (widget)
4295 "Set changes in all modified group members."
9db1942d
CY
4296 (dolist (child (widget-get widget :children))
4297 (when (eq (widget-get child :custom-state) 'modified)
4298 (widget-apply child :custom-set))))
d543e20b 4299
5ae87ed4
MR
4300(defun custom-group-mark-to-save (widget)
4301 "Mark all modified group members for saving."
ed8c9cf1 4302 (dolist (child (widget-get widget :children))
9db1942d 4303 (when (memq (widget-get child :custom-state) '(modified set))
5ae87ed4
MR
4304 (widget-apply child :custom-mark-to-save))))
4305
4306(defsubst custom-group-state-set-and-redraw (widget)
4307 "Set state of group widget WIDGET and redraw with current settings."
4308 (dolist (child (widget-get widget :children))
4309 (when (memq (widget-get child :custom-state) '(modified set))
4310 (widget-apply child :custom-state-set-and-redraw))))
4311
4312(defun custom-group-save (widget)
4313 "Save all modified group members."
4314 (custom-group-mark-to-save widget)
4315 (custom-save-all)
4316 (custom-group-state-set-and-redraw widget))
d543e20b
PA
4317
4318(defun custom-group-reset-current (widget)
4319 "Reset all modified group members."
9db1942d
CY
4320 (dolist (child (widget-get widget :children))
4321 (when (eq (widget-get child :custom-state) 'modified)
4322 (widget-apply child :custom-reset-current))))
d543e20b
PA
4323
4324(defun custom-group-reset-saved (widget)
4325 "Reset all modified or set group members."
9db1942d
CY
4326 (dolist (child (widget-get widget :children))
4327 (when (memq (widget-get child :custom-state) '(modified set))
4328 (widget-apply child :custom-reset-saved))))
d543e20b 4329
25ac13b5 4330(defun custom-group-reset-standard (widget)
d543e20b 4331 "Reset all modified, set, or saved group members."
5ae87ed4
MR
4332 (let ((custom-reset-standard-variables-list '(t))
4333 (custom-reset-standard-faces-list '(t)))
4334 (custom-group-mark-to-reset-standard widget)
4335 (custom-reset-standard-save-and-update)))
4336
4337(defun custom-group-mark-to-reset-standard (widget)
4338 "Mark to reset all modified, set, or saved group members."
9db1942d
CY
4339 (dolist (child (widget-get widget :children))
4340 (when (memq (widget-get child :custom-state)
4341 '(modified set saved))
5ae87ed4 4342 (widget-apply child :custom-mark-to-reset-standard))))
d543e20b
PA
4343
4344(defun custom-group-state-update (widget)
4345 "Update magic."
4346 (unless (eq (widget-get widget :custom-state) 'hidden)
4347 (let* ((children (widget-get widget :children))
4348 (states (mapcar (lambda (child)
4349 (widget-get child :custom-state))
4350 children))
25ac13b5
PA
4351 (magics custom-magic-alist)
4352 (found 'standard))
d543e20b
PA
4353 (while magics
4354 (let ((magic (car (car magics))))
4355 (if (and (not (eq magic 'hidden))
4356 (memq magic states))
4357 (setq found magic
4358 magics nil)
4359 (setq magics (cdr magics)))))
4360 (widget-put widget :custom-state found)))
4361 (custom-magic-reset widget))
f8d869d1
RS
4362\f
4363;;; Reading and writing the custom file.
d543e20b 4364
a1a4fa22 4365;;;###autoload
1e4ed6df 4366(defcustom custom-file nil
d543e20b 4367 "File used for storing customization information.
1e4ed6df 4368The default is nil, which means to use your init file
09b73f49
RS
4369as specified by `user-init-file'. If the value is not nil,
4370it should be an absolute file name.
4371
5aa971e3
LT
4372You can set this option through Custom, if you carefully read the
4373last paragraph below. However, usually it is simpler to write
4374something like the following in your init file:
4375
4376\(setq custom-file \"~/.emacs-custom.el\")
4377\(load custom-file)
4378
4379Note that both lines are necessary: the first line tells Custom to
4380save all customizations in this file, but does not load it.
4381
4382When you change this variable outside Custom, look in the
4383previous custom file \(usually your init file) for the
4384forms `(custom-set-variables ...)' and `(custom-set-faces ...)',
4385and copy them (whichever ones you find) to the new custom file.
4386This will preserve your existing customizations.
4387
4388If you save this option using Custom, Custom will write all
4389currently saved customizations, including the new one for this
4390option itself, into the file you specify, overwriting any
4391`custom-set-variables' and `custom-set-faces' forms already
4392present in that file. It will not delete any customizations from
4393the old custom file. You should do that manually if that is what you
4394want. You also have to put something like `\(load \"CUSTOM-FILE\")
4395in your init file, where CUSTOM-FILE is the actual name of the
4396file. Otherwise, Emacs will not load the file when it starts up,
4397and hence will not set `custom-file' to that file either."
4398 :type '(choice (const :tag "Your Emacs init file" nil)
4399 (file :format "%t:%v%d"
4400 :doc
4401 "Please read entire docstring below before setting \
4402this through Custom.
6cda144f 4403Click on \"More\" \(or position point there and press RETURN)
5aa971e3 4404if only the first line of the docstring is shown."))
d543e20b
PA
4405 :group 'customize)
4406
eab5dc07 4407(defun custom-file (&optional no-error)
176eb8cb 4408 "Return the file name for saving customizations."
98cd6c18
LMI
4409 (if (null user-init-file)
4410 ;; Started with -q, i.e. the file containing Custom settings
4411 ;; hasn't been read. Saving settings there won't make much
4412 ;; sense.
4413 (if no-error
4414 nil
4415 (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
4416 (file-chase-links (or custom-file user-init-file))))
176eb8cb 4417
b581d2ea
GM
4418;; If recentf-mode is non-nil, this is defined.
4419(declare-function recentf-expand-file-name "recentf" (name))
4420
f8d869d1
RS
4421;;;###autoload
4422(defun custom-save-all ()
4423 "Save all customizations in `custom-file'."
e29e9065
RS
4424 (when (and (null custom-file) init-file-had-error)
4425 (error "Cannot save customizations; init file was not fully loaded"))
f8d869d1 4426 (let* ((filename (custom-file))
c34a8a87
EZ
4427 (recentf-exclude
4428 (if recentf-mode
4429 (cons (concat "\\`"
4430 (regexp-quote
4431 (recentf-expand-file-name (custom-file)))
4432 "\\'")
4433 recentf-exclude)))
ac183163
CY
4434 (old-buffer (find-buffer-visiting filename))
4435 old-buffer-name)
4436
9e2f5050
RS
4437 (with-current-buffer (let ((find-file-visit-truename t))
4438 (or old-buffer (find-file-noselect filename)))
ac183163
CY
4439 ;; We'll save using file-precious-flag, so avoid destroying
4440 ;; symlinks. (If we're not already visiting the buffer, this is
4441 ;; handled by find-file-visit-truename, above.)
4442 (when old-buffer
4443 (setq old-buffer-name (buffer-file-name))
4444 (set-visited-file-name (file-chase-links filename)))
4445
31b7fa51
CY
4446 (unless (eq major-mode 'emacs-lisp-mode)
4447 (emacs-lisp-mode))
478834e6
TB
4448 (let ((inhibit-read-only t)
4449 (print-length nil)
4450 (print-level nil))
f8d869d1
RS
4451 (custom-save-variables)
4452 (custom-save-faces))
4453 (let ((file-precious-flag t))
4454 (save-buffer))
ac183163
CY
4455 (if old-buffer
4456 (progn
4457 (set-visited-file-name old-buffer-name)
4458 (set-buffer-modified-p nil))
f8d869d1 4459 (kill-buffer (current-buffer))))))
16ecd4c5
RS
4460
4461;;;###autoload
4462(defun customize-save-customized ()
4463 "Save all user options which have been set in this session."
4464 (interactive)
4465 (mapatoms (lambda (symbol)
4466 (let ((face (get symbol 'customized-face))
4467 (value (get symbol 'customized-value))
4468 (face-comment (get symbol 'customized-face-comment))
4469 (variable-comment
4470 (get symbol 'customized-variable-comment)))
4471 (when face
4472 (put symbol 'saved-face face)
4473 (custom-push-theme 'theme-face symbol 'user 'set value)
4474 (put symbol 'customized-face nil))
4475 (when value
4476 (put symbol 'saved-value value)
4477 (custom-push-theme 'theme-value symbol 'user 'set value)
4478 (put symbol 'customized-value nil))
4479 (when variable-comment
4480 (put symbol 'saved-variable-comment variable-comment)
4481 (put symbol 'customized-variable-comment nil))
4482 (when face-comment
4483 (put symbol 'saved-face-comment face-comment)
4484 (put symbol 'customized-face-comment nil)))))
4485 ;; We really should update all custom buffers here.
4486 (custom-save-all))
f8d869d1
RS
4487\f
4488;; Editing the custom file contents in a buffer.
4489
d543e20b 4490(defun custom-save-delete (symbol)
f8d869d1 4491 "Delete all calls to SYMBOL from the contents of the current buffer.
a34511a1 4492Leave point at the old location of the first such call,
f8d869d1
RS
4493or (if there were none) at the end of the buffer.
4494
4495This function does not save the buffer."
d543e20b 4496 (goto-char (point-min))
cbe8bb8e
KH
4497 ;; Skip all whitespace and comments.
4498 (while (forward-comment 1))
4499 (or (eobp)
4500 (save-excursion (forward-sexp (buffer-size)))) ; Test for scan errors.
a34511a1
RS
4501 (let (first)
4502 (catch 'found
4503 (while t ;; We exit this loop only via throw.
4504 ;; Skip all whitespace and comments.
4505 (while (forward-comment 1))
4506 (let ((start (point))
4507 (sexp (condition-case nil
4508 (read (current-buffer))
4509 (end-of-file (throw 'found nil)))))
4510 (when (and (listp sexp)
4511 (eq (car sexp) symbol))
4512 (delete-region start (point))
4513 (unless first
4514 (setq first (point)))))))
4515 (if first
4516 (goto-char first)
189638d5
GM
4517 ;; Move in front of local variables, otherwise long Custom
4518 ;; entries would make them ineffective.
4519 (let ((pos (point-max))
4520 (case-fold-search t))
4521 (save-excursion
4522 (goto-char (point-max))
4523 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
4524 'move)
4525 (when (search-forward "Local Variables:" nil t)
4526 (setq pos (line-beginning-position))))
4527 (goto-char pos)))))
d543e20b 4528
06b60517
JB
4529(defvar sort-fold-case) ; defined in sort.el
4530
d543e20b
PA
4531(defun custom-save-variables ()
4532 "Save all customized variables in `custom-file'."
4533 (save-excursion
4534 (custom-save-delete 'custom-set-variables)
d151422c
MR
4535 (let ((standard-output (current-buffer))
4536 (saved-list (make-list 1 0))
4537 sort-fold-case)
4538 ;; First create a sorted list of saved variables.
4539 (mapatoms
4540 (lambda (symbol)
d358aa10 4541 (if (and (get symbol 'saved-value)
2d656942
CY
4542 ;; ignore theme values
4543 (or (null (get symbol 'theme-value))
4544 (eq 'user (caar (get symbol 'theme-value)))))
d151422c
MR
4545 (nconc saved-list (list symbol)))))
4546 (setq saved-list (sort (cdr saved-list) 'string<))
d543e20b
PA
4547 (unless (bolp)
4548 (princ "\n"))
aec2bb63 4549 (princ "(custom-set-variables
61b6abbd
AL
4550 ;; custom-set-variables was added by Custom.
4551 ;; If you edit it by hand, you could mess it up, so be careful.
4552 ;; Your init file should contain only one such instance.
4553 ;; If there is more than one, they won't work right.\n")
d9f67134
SM
4554 (dolist (symbol saved-list)
4555 (let ((spec (car-safe (get symbol 'theme-value)))
4556 (value (get symbol 'saved-value))
4557 (requests (get symbol 'custom-requests))
adcc7a37
RS
4558 (now (and (not (custom-variable-p symbol))
4559 (or (boundp symbol)
4560 (eq (get symbol 'force-value)
4561 'rogue))))
40627755 4562 (comment (get symbol 'saved-variable-comment)))
c8c9333c 4563 ;; Check REQUESTS for validity.
d9f67134
SM
4564 (dolist (request requests)
4565 (when (and (symbolp request) (not (featurep request)))
4566 (message "Unknown requested feature: %s" request)
4567 (setq requests (delq request requests))))
adcc7a37 4568 ;; Is there anything customized about this variable?
d358aa10 4569 (when (or (and spec (eq (car spec) 'user))
d9f67134
SM
4570 comment
4571 (and (null spec) (get symbol 'saved-value)))
adcc7a37
RS
4572 ;; Output an element for this variable.
4573 ;; It has the form (SYMBOL VALUE-FORM NOW REQUESTS COMMENT).
4574 ;; SYMBOL is the variable name.
4575 ;; VALUE-FORM is an expression to return the customized value.
4576 ;; NOW if non-nil means always set the variable immediately
4577 ;; when the customizations are reloaded. This is used
4578 ;; for rogue variables
4579 ;; REQUESTS is a list of packages to load before setting the
4580 ;; variable. Each element of it will be passed to `require'.
4581 ;; COMMENT is whatever comment the user has specified
4582 ;; with the customize facility.
d9f67134
SM
4583 (unless (bolp)
4584 (princ "\n"))
4585 (princ " '(")
4586 (prin1 symbol)
4587 (princ " ")
4588 (prin1 (car value))
4589 (when (or now requests comment)
4590 (princ " ")
4591 (prin1 now)
4592 (when (or requests comment)
4593 (princ " ")
4594 (prin1 requests)
4595 (when comment
4596 (princ " ")
4597 (prin1 comment))))
4598 (princ ")"))))
a34511a1
RS
4599 (if (bolp)
4600 (princ " "))
d543e20b
PA
4601 (princ ")")
4602 (unless (looking-at "\n")
4603 (princ "\n")))))
4604
4605(defun custom-save-faces ()
4606 "Save all customized faces in `custom-file'."
4607 (save-excursion
c942535f 4608 (custom-save-delete 'custom-reset-faces)
d543e20b 4609 (custom-save-delete 'custom-set-faces)
d151422c
MR
4610 (let ((standard-output (current-buffer))
4611 (saved-list (make-list 1 0))
4612 sort-fold-case)
4613 ;; First create a sorted list of saved faces.
4614 (mapatoms
4615 (lambda (symbol)
d358aa10
CY
4616 (if (and (get symbol 'saved-face)
4617 (eq 'user (car (car-safe (get symbol 'theme-face)))))
d151422c
MR
4618 (nconc saved-list (list symbol)))))
4619 (setq saved-list (sort (cdr saved-list) 'string<))
4620 ;; The default face must be first, since it affects the others.
4621 (if (memq 'default saved-list)
4622 (setq saved-list (cons 'default (delq 'default saved-list))))
d543e20b
PA
4623 (unless (bolp)
4624 (princ "\n"))
aec2bb63 4625 (princ "(custom-set-faces
61b6abbd
AL
4626 ;; custom-set-faces was added by Custom.
4627 ;; If you edit it by hand, you could mess it up, so be careful.
4628 ;; Your init file should contain only one such instance.
4629 ;; If there is more than one, they won't work right.\n")
d9f67134
SM
4630 (dolist (symbol saved-list)
4631 (let ((spec (car-safe (get symbol 'theme-face)))
4632 (value (get symbol 'saved-face))
4633 (now (not (or (get symbol 'face-defface-spec)
4634 (and (not (custom-facep symbol))
4635 (not (get symbol 'force-face))))))
4636 (comment (get symbol 'saved-face-comment)))
d358aa10 4637 (when (or (and spec (eq (nth 0 spec) 'user))
d9f67134
SM
4638 comment
4639 (and (null spec) (get symbol 'saved-face)))
4640 ;; Don't print default face here.
4641 (unless (bolp)
4642 (princ "\n"))
4643 (princ " '(")
4644 (prin1 symbol)
4645 (princ " ")
4646 (prin1 value)
4647 (when (or now comment)
4648 (princ " ")
4649 (prin1 now)
4650 (when comment
4651 (princ " ")
4652 (prin1 comment)))
4653 (princ ")"))))
a34511a1
RS
4654 (if (bolp)
4655 (princ " "))
d543e20b
PA
4656 (princ ")")
4657 (unless (looking-at "\n")
08b4ae6c 4658 (princ "\n")))))
f8d869d1 4659\f
d543e20b
PA
4660;;; The Customize Menu.
4661
bd042c03
PA
4662;;; Menu support
4663
25ac13b5
PA
4664(defcustom custom-menu-nesting 2
4665 "Maximum nesting in custom menus."
4666 :type 'integer
6aaedd12 4667 :group 'custom-menu)
d543e20b 4668
06b60517 4669(defun custom-face-menu-create (_widget symbol)
d543e20b
PA
4670 "Ignoring WIDGET, create a menu entry for customization face SYMBOL."
4671 (vector (custom-unlispify-menu-entry symbol)
86bd10bc 4672 `(customize-face ',symbol)
d543e20b
PA
4673 t))
4674
06b60517 4675(defun custom-variable-menu-create (_widget symbol)
d543e20b
PA
4676 "Ignoring WIDGET, create a menu entry for customization variable SYMBOL."
4677 (let ((type (get symbol 'custom-type)))
4678 (unless (listp type)
4679 (setq type (list type)))
4680 (if (and type (widget-get type :custom-menu))
4681 (widget-apply type :custom-menu symbol)
4682 (vector (custom-unlispify-menu-entry symbol)
86bd10bc 4683 `(customize-variable ',symbol)
d543e20b
PA
4684 t))))
4685
bd042c03 4686;; Add checkboxes to boolean variable entries.
d543e20b 4687(widget-put (get 'boolean 'widget-type)
06b60517 4688 :custom-menu (lambda (_widget symbol)
d543e20b 4689 (vector (custom-unlispify-menu-entry symbol)
86bd10bc 4690 `(customize-variable ',symbol)
d543e20b
PA
4691 ':style 'toggle
4692 ':selected symbol)))
4693
06b60517 4694(defun custom-group-menu-create (_widget symbol)
d04a3972
DL
4695 "Ignoring WIDGET, create a menu entry for customization group SYMBOL."
4696 `( ,(custom-unlispify-menu-entry symbol t)
4697 :filter (lambda (&rest junk)
809f0c35 4698 (let* ((menu (custom-menu-create ',symbol)))
3b2f3d30 4699 (if (consp menu) (cdr menu) menu)))))
d543e20b 4700
bd042c03
PA
4701;;;###autoload
4702(defun custom-menu-create (symbol)
d543e20b 4703 "Create menu for customization group SYMBOL.
d543e20b 4704The menu is in a format applicable to `easy-menu-define'."
809f0c35
RS
4705 (let* ((deactivate-mark nil)
4706 (item (vector (custom-unlispify-menu-entry symbol)
86bd10bc 4707 `(customize-group ',symbol)
bd042c03
PA
4708 t)))
4709 (if (and (or (not (boundp 'custom-menu-nesting))
4710 (>= custom-menu-nesting 0))
2de2cb02
MR
4711 (progn
4712 (custom-load-symbol symbol)
4713 (< (length (get symbol 'custom-group)) widget-menu-max-size)))
d543e20b 4714 (let ((custom-prefix-list (custom-prefix-add symbol
25ac13b5 4715 custom-prefix-list))
da5ec617
PA
4716 (members (custom-sort-items (get symbol 'custom-group)
4717 custom-menu-sort-alphabetically
4718 custom-menu-order-groups)))
d543e20b
PA
4719 `(,(custom-unlispify-menu-entry symbol t)
4720 ,item
4721 "--"
4722 ,@(mapcar (lambda (entry)
4723 (widget-apply (if (listp (nth 1 entry))
4724 (nth 1 entry)
4725 (list (nth 1 entry)))
4726 :custom-menu (nth 0 entry)))
25ac13b5 4727 members)))
d543e20b
PA
4728 item)))
4729
4730;;;###autoload
bd042c03
PA
4731(defun customize-menu-create (symbol &optional name)
4732 "Return a customize menu for customization group SYMBOL.
d3d4df42 4733If optional NAME is given, use that as the name of the menu.
bd042c03
PA
4734Otherwise the menu will be named `Customize'.
4735The format is suitable for use with `easy-menu-define'."
4736 (unless name
4737 (setq name "Customize"))
d04a3972
DL
4738 `(,name
4739 :filter (lambda (&rest junk)
3b2f3d30
SM
4740 (let ((menu (custom-menu-create ',symbol)))
4741 (if (consp menu) (cdr menu) menu)))))
d543e20b 4742
9db1942d
CY
4743;;; Toolbar and menubar support
4744
4745(easy-menu-define
34cf517c 4746 Custom-mode-menu (list custom-mode-map custom-field-keymap)
9db1942d
CY
4747 "Menu used in customization buffers."
4748 (nconc (list "Custom"
4749 (customize-menu-create 'customize))
4750 (mapcar (lambda (arg)
4751 (let ((tag (nth 0 arg))
4752 (command (nth 1 arg))
4753 (active (nth 2 arg))
4754 (help (nth 3 arg)))
4755 (vector tag command :active (eval active) :help help)))
4756 custom-commands)))
4757
4758(defvar tool-bar-map)
2614ccc3
MR
4759
4760;;; `custom-tool-bar-map' used to be set up here. This will fail to
4761;;; DTRT when `display-graphic-p' returns nil during compilation. Hence
6aec3b9d 4762;;; we set this up lazily in `Custom-mode'.
2614ccc3
MR
4763(defvar custom-tool-bar-map nil
4764 "Keymap for toolbar in Custom mode.")
9db1942d 4765
bd042c03
PA
4766;;; The Custom Mode.
4767
06b60517 4768(defun Custom-no-edit (_pos &optional _event)
7eb944cf
RS
4769 "Invoke button at POS, or refuse to allow editing of Custom buffer."
4770 (interactive "@d")
a8da2abd 4771 (error "You can't edit this part of the Custom buffer"))
0ce026b1 4772
adcc7a37 4773(defun Custom-newline (pos &optional event)
19f0515a
RS
4774 "Invoke button at POS, or refuse to allow editing of Custom buffer."
4775 (interactive "@d")
4776 (let ((button (get-char-property pos 'button)))
5772caab
GM
4777 ;; If there is no button at point, then use the one at the start
4778 ;; of the line, if it is a custom-group-link (bug#2298).
4779 (or button
4780 (if (setq button (get-char-property (line-beginning-position) 'button))
4781 (or (eq (widget-type button) 'custom-group-link)
4782 (setq button nil))))
19f0515a
RS
4783 (if button
4784 (widget-apply-action button event)
4785 (error "You can't edit this part of the Custom buffer"))))
4786
b62c92bb
RS
4787(defun Custom-goto-parent ()
4788 "Go to the parent group listed at the top of this buffer.
4789If several parents are listed, go to the first of them."
4790 (interactive)
4791 (save-excursion
4792 (goto-char (point-min))
d84fcc30 4793 (if (search-forward "\nParent groups: " nil t)
b62c92bb
RS
4794 (let* ((button (get-char-property (point) 'button))
4795 (parent (downcase (widget-get button :tag))))
4796 (customize-group parent)))))
4797
6aec3b9d 4798(defcustom Custom-mode-hook nil
d3d4df42 4799 "Hook called when entering Custom mode."
bd042c03 4800 :type 'hook
6aec3b9d 4801 :group 'custom-buffer)
bd042c03 4802
b62c92bb
RS
4803(defun custom-state-buffer-message (widget)
4804 (if (eq (widget-get (widget-get widget :parent) :custom-state) 'modified)
4805 (message "To install your edits, invoke [State] and choose the Set operation")))
8691cfa7 4806
6b09b5d1
CY
4807(defun custom--initialize-widget-variables ()
4808 (set (make-local-variable 'widget-documentation-face) 'custom-documentation)
4809 (set (make-local-variable 'widget-button-face) custom-button)
4810 (set (make-local-variable 'widget-button-pressed-face) custom-button-pressed)
4811 (set (make-local-variable 'widget-mouse-face) custom-button-mouse)
4812 ;; We need this because of the "More" button on docstrings.
4813 ;; Otherwise clicking on "More" can push point offscreen, which
4814 ;; causes the window to recenter on point, which pushes the
4815 ;; newly-revealed docstring offscreen; which is annoying. -- cyd.
4816 (set (make-local-variable 'widget-button-click-moves-point) t)
4817 ;; When possible, use relief for buttons, not bracketing. This test
4818 ;; may not be optimal.
4819 (when custom-raised-buttons
4820 (set (make-local-variable 'widget-push-button-prefix) "")
4821 (set (make-local-variable 'widget-push-button-suffix) "")
4822 (set (make-local-variable 'widget-link-prefix) "")
4823 (set (make-local-variable 'widget-link-suffix) ""))
4824 (setq show-trailing-whitespace nil))
4825
6aec3b9d 4826(define-derived-mode Custom-mode nil "Custom"
bd042c03
PA
4827 "Major mode for editing customization buffers.
4828
4829The following commands are available:
4830
192e44fc
JL
4831\\<widget-keymap>\
4832Move to next button, link or editable field. \\[widget-forward]
fd40bad4 4833Move to previous button, link or editable field. \\[widget-backward]
192e44fc 4834\\<custom-field-keymap>\
4ee1cf9f
PA
4835Complete content of editable text field. \\[widget-complete]
4836\\<custom-mode-map>\
9ca66103 4837Invoke button under the mouse pointer. \\[widget-button-click]
192e44fc 4838Invoke button under point. \\[widget-button-press]
107736a2
RS
4839Set all options from current text. \\[Custom-set]
4840Make values in current text permanent. \\[Custom-save]
192e44fc
JL
4841Make text match actual option values. \\[Custom-reset-current]
4842Reset options to permanent settings. \\[Custom-reset-saved]
107736a2
RS
4843Erase customizations; set options
4844 and buffer text to the standard values. \\[Custom-reset-standard]
bd042c03 4845
6aec3b9d 4846Entry to this mode calls the value of `Custom-mode-hook'
bd042c03 4847if that value is non-nil."
bd042c03 4848 (use-local-map custom-mode-map)
ab678382 4849 (easy-menu-add Custom-mode-menu)
8db5a4fe
CY
4850 (set (make-local-variable 'tool-bar-map)
4851 (or custom-tool-bar-map
4852 ;; Set up `custom-tool-bar-map'.
4853 (let ((map (make-sparse-keymap)))
4854 (mapc
4855 (lambda (arg)
4856 (tool-bar-local-item-from-menu
f904c0f9
JD
4857 (nth 1 arg) (nth 4 arg) map custom-mode-map
4858 :label (nth 5 arg)))
8db5a4fe
CY
4859 custom-commands)
4860 (setq custom-tool-bar-map map))))
bd042c03 4861 (make-local-variable 'custom-options)
9b7826f4 4862 (make-local-variable 'custom-local-buffer)
6b09b5d1 4863 (custom--initialize-widget-variables)
d1a3873f 4864 (add-hook 'widget-edit-functions 'custom-state-buffer-message nil t))
d543e20b 4865
6aec3b9d
JL
4866(put 'Custom-mode 'mode-class 'special)
4867
4868;; backward-compatibility
4869(defun custom-mode ()
4870 "Non-interactive variant of `Custom-mode'."
4871 (Custom-mode))
82c02591 4872(make-obsolete 'custom-mode 'Custom-mode "23.1")
7f352f86 4873(put 'custom-mode 'mode-class 'special)
82c02591 4874(define-obsolete-variable-alias 'custom-mode-hook 'Custom-mode-hook "23.1")
7f352f86 4875
81711dba
EZ
4876(dolist (regexp
4877 '("^No user option defaults have been changed since Emacs "
4878 "^Invalid face:? "
4879 "^No \\(?:customized\\|rogue\\|saved\\) user options"
4880 "^No customizable items matching "
4881 "^There are unset changes"
4882 "^Cannot set hidden variable"
4883 "^No \\(?:saved\\|backup\\) value for "
4884 "^No standard setting known for "
4885 "^No standard setting for this face"
4886 "^Saving settings from \"emacs -q\" would overwrite existing customizations"))
4887 (add-to-list 'debug-ignored-errors regexp))
2365594b 4888
d543e20b
PA
4889;;; The End.
4890
4891(provide 'cus-edit)
4892
d3d4df42 4893;;; cus-edit.el ends here