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