(quail-start-conversion): Reset
[bpt/emacs.git] / lisp / cus-edit.el
CommitLineData
2365594b 1;;; cus-edit.el --- Tools for customizing Emacs and Lisp packages.
d543e20b 2;;
189638d5 3;; Copyright (C) 1996, 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
d543e20b
PA
4;;
5;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6;; Keywords: help, faces
d543e20b 7
f2b98a56
RS
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
12;; the Free Software Foundation; either version 2, or (at your option)
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs; see the file COPYING. If not, write to the
22;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23;; Boston, MA 02111-1307, USA.
24
d543e20b
PA
25;;; Commentary:
26;;
6d528fc5
PA
27;; This file implements the code to create and edit customize buffers.
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
d543e20b
PA
35;;; Code:
36
37(require 'cus-face)
38(require 'wid-edit)
164cfaeb 39(eval-when-compile
164cfaeb 40 (defvar custom-versions-load-alist)) ; from cus-load
6d528fc5
PA
41
42(condition-case nil
43 (require 'cus-load)
44 (error nil))
d543e20b 45
9097aeb7
PA
46(condition-case nil
47 (require 'cus-start)
48 (error nil))
49
bd042c03 50(put 'custom-define-hook 'custom-type 'hook)
25ac13b5 51(put 'custom-define-hook 'standard-value '(nil))
bd042c03
PA
52(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)
53
d543e20b
PA
54;;; Customization Groups.
55
56(defgroup emacs nil
57 "Customization of the One True Editor."
58 :link '(custom-manual "(emacs)Top"))
59
60;; Most of these groups are stolen from `finder.el',
61(defgroup editing nil
62 "Basic text editing facilities."
63 :group 'emacs)
64
65(defgroup abbrev nil
66 "Abbreviation handling, typing shortcuts, macros."
67 :tag "Abbreviations"
68 :group 'editing)
69
70(defgroup matching nil
71 "Various sorts of searching and matching."
72 :group 'editing)
73
74(defgroup emulations nil
75 "Emulations of other editors."
76 :group 'editing)
77
78(defgroup mouse nil
79 "Mouse support."
80 :group 'editing)
81
82(defgroup outlines nil
83 "Support for hierarchical outlining."
84 :group 'editing)
85
86(defgroup external nil
87 "Interfacing to external utilities."
88 :group 'emacs)
89
90(defgroup bib nil
91 "Code related to the `bib' bibliography processor."
92 :tag "Bibliography"
93 :group 'external)
94
95(defgroup processes nil
96 "Process, subshell, compilation, and job control support."
97 :group 'external
98 :group 'development)
99
4599e8cd
RS
100(defgroup convenience nil
101 "Convenience features for faster editing."
102 :group 'emacs)
103
d543e20b
PA
104(defgroup programming nil
105 "Support for programming in other languages."
106 :group 'emacs)
107
108(defgroup languages nil
109 "Specialized modes for editing programming languages."
110 :group 'programming)
111
112(defgroup lisp nil
113 "Lisp support, including Emacs Lisp."
114 :group 'languages
115 :group 'development)
116
117(defgroup c nil
118 "Support for the C language and related languages."
119 :group 'languages)
120
121(defgroup tools nil
122 "Programming tools."
123 :group 'programming)
124
125(defgroup oop nil
126 "Support for object-oriented programming."
127 :group 'programming)
128
129(defgroup applications nil
130 "Applications written in Emacs."
131 :group 'emacs)
132
133(defgroup calendar nil
134 "Calendar and time management support."
135 :group 'applications)
136
137(defgroup mail nil
138 "Modes for electronic-mail handling."
139 :group 'applications)
140
141(defgroup news nil
142 "Support for netnews reading and posting."
143 :group 'applications)
144
145(defgroup games nil
146 "Games, jokes and amusements."
147 :group 'applications)
148
149(defgroup development nil
150 "Support for further development of Emacs."
151 :group 'emacs)
152
153(defgroup docs nil
154 "Support for Emacs documentation."
155 :group 'development)
156
157(defgroup extensions nil
158 "Emacs Lisp language extensions."
159 :group 'development)
160
161(defgroup internal nil
162 "Code for Emacs internals, build process, defaults."
163 :group 'development)
164
165(defgroup maint nil
166 "Maintenance aids for the Emacs development group."
167 :tag "Maintenance"
168 :group 'development)
169
170(defgroup environment nil
171 "Fitting Emacs with its environment."
172 :group 'emacs)
173
174(defgroup comm nil
175 "Communications, networking, remote access to files."
176 :tag "Communication"
177 :group 'environment)
178
179(defgroup hardware nil
180 "Support for interfacing with exotic hardware."
181 :group 'environment)
182
183(defgroup terminals nil
184 "Support for terminal types."
185 :group 'environment)
186
187(defgroup unix nil
188 "Front-ends/assistants for, or emulators of, UNIX features."
189 :group 'environment)
190
191(defgroup vms nil
192 "Support code for vms."
193 :group 'environment)
194
195(defgroup i18n nil
196 "Internationalization and alternate character-set support."
197 :group 'environment
198 :group 'editing)
199
86bd10bc
PA
200(defgroup x nil
201 "The X Window system."
202 :group 'environment)
203
d543e20b
PA
204(defgroup frames nil
205 "Support for Emacs frames and window systems."
206 :group 'environment)
207
208(defgroup data nil
209 "Support editing files of data."
210 :group 'emacs)
211
482e54f3
RS
212(defgroup files nil
213 "Support editing files."
214 :group 'emacs)
215
d543e20b
PA
216(defgroup wp nil
217 "Word processing."
218 :group 'emacs)
219
220(defgroup tex nil
221 "Code related to the TeX formatter."
222 :group 'wp)
223
224(defgroup faces nil
225 "Support for multiple fonts."
226 :group 'emacs)
227
228(defgroup hypermedia nil
229 "Support for links between text or other media types."
230 :group 'emacs)
231
232(defgroup help nil
233 "Support for on-line help systems."
234 :group 'emacs)
235
d3d4df42
DL
236(defgroup multimedia nil
237 "Non-textual support, specifically images and sound."
238 :group 'emacs)
239
d543e20b
PA
240(defgroup local nil
241 "Code local to your site."
242 :group 'emacs)
243
244(defgroup customize '((widgets custom-group))
245 "Customization of the Customization support."
2a1c4b90 246 :link '(custom-manual "(elisp)Customization")
d3d4df42 247 :link '(url-link :tag "(Old?) Development Page"
d543e20b
PA
248 "http://www.dina.kvl.dk/~abraham/custom/")
249 :prefix "custom-"
bd042c03
PA
250 :group 'help)
251
252(defgroup custom-faces nil
253 "Faces used by customize."
254 :group 'customize
d543e20b
PA
255 :group 'faces)
256
da5ec617
PA
257(defgroup custom-browse nil
258 "Control customize browser."
259 :prefix "custom-"
260 :group 'customize)
261
6aaedd12 262(defgroup custom-buffer nil
da5ec617 263 "Control customize buffers."
6aaedd12
PA
264 :prefix "custom-"
265 :group 'customize)
266
267(defgroup custom-menu nil
da5ec617 268 "Control customize menus."
6aaedd12
PA
269 :prefix "custom-"
270 :group 'customize)
271
bd042c03
PA
272(defgroup abbrev-mode nil
273 "Word abbreviations mode."
274 :group 'abbrev)
275
276(defgroup alloc nil
277 "Storage allocation and gc for GNU Emacs Lisp interpreter."
278 :tag "Storage Allocation"
279 :group 'internal)
280
281(defgroup undo nil
282 "Undoing changes in buffers."
283 :group 'editing)
284
285(defgroup modeline nil
286 "Content of the modeline."
287 :group 'environment)
288
289(defgroup fill nil
290 "Indenting and filling text."
291 :group 'editing)
292
293(defgroup editing-basics nil
294 "Most basic editing facilities."
295 :group 'editing)
296
297(defgroup display nil
298 "How characters are displayed in buffers."
299 :group 'environment)
300
301(defgroup execute nil
302 "Executing external commands."
303 :group 'processes)
304
305(defgroup installation nil
306 "The Emacs installation."
307 :group 'environment)
308
309(defgroup dired nil
310 "Directory editing."
311 :group 'environment)
312
313(defgroup limits nil
314 "Internal Emacs limits."
315 :group 'internal)
316
317(defgroup debug nil
318 "Debugging Emacs itself."
319 :group 'development)
320
321(defgroup minibuffer nil
322 "Controling the behaviour of the minibuffer."
323 :group 'environment)
324
325(defgroup keyboard nil
326 "Input from the keyboard."
327 :group 'environment)
328
329(defgroup mouse nil
330 "Input from the mouse."
331 :group 'environment)
332
333(defgroup menu nil
334 "Input from the menus."
335 :group 'environment)
336
337(defgroup auto-save nil
338 "Preventing accidential loss of data."
482e54f3 339 :group 'files)
bd042c03
PA
340
341(defgroup processes-basics nil
342 "Basic stuff dealing with processes."
343 :group 'processes)
344
25ac13b5
PA
345(defgroup mule nil
346 "MULE Emacs internationalization."
70bc91bc 347 :group 'i18n)
25ac13b5 348
bd042c03
PA
349(defgroup windows nil
350 "Windows within a frame."
86bd10bc 351 :group 'environment)
bd042c03 352
d543e20b
PA
353;;; Utilities.
354
355(defun custom-quote (sexp)
356 "Quote SEXP iff it is not self quoting."
357 (if (or (memq sexp '(t nil))
2365594b 358 (keywordp sexp)
d543e20b
PA
359 (and (listp sexp)
360 (memq (car sexp) '(lambda)))
361 (stringp sexp)
362 (numberp sexp)
d3d4df42
DL
363 (vectorp sexp)
364;;; (and (fboundp 'characterp)
365;;; (characterp sexp))
366 )
d543e20b
PA
367 sexp
368 (list 'quote sexp)))
369
370(defun custom-split-regexp-maybe (regexp)
371 "If REGEXP is a string, split it to a list at `\\|'.
d3d4df42 372You can get the original back with from the result with:
d543e20b
PA
373 (mapconcat 'identity result \"\\|\")
374
375IF REGEXP is not a string, return it unchanged."
376 (if (stringp regexp)
377 (let ((start 0)
378 all)
379 (while (string-match "\\\\|" regexp start)
380 (setq all (cons (substring regexp start (match-beginning 0)) all)
381 start (match-end 0)))
382 (nreverse (cons (substring regexp start) all)))
383 regexp))
384
bd042c03 385(defun custom-variable-prompt ()
bd042c03
PA
386 "Prompt for a variable, defaulting to the variable at point.
387Return a list suitable for use in `interactive'."
388 (let ((v (variable-at-point))
389 (enable-recursive-minibuffers t)
390 val)
d3d4df42 391 (setq val (completing-read
5b5cdd97 392 (if (symbolp v)
64dde95b 393 (format "Customize option: (default %s) " v)
bd042c03 394 "Customize variable: ")
6d528fc5
PA
395 obarray (lambda (symbol)
396 (and (boundp symbol)
397 (or (get symbol 'custom-type)
fa08de96 398 (get symbol 'custom-loads)
01651f07 399 (get symbol 'standard-value)))) t))
bd042c03 400 (list (if (equal val "")
5b5cdd97
RS
401 (if (symbolp v) v nil)
402 (intern val)))))
bd042c03 403
6d528fc5
PA
404(defun custom-menu-filter (menu widget)
405 "Convert MENU to the form used by `widget-choose'.
406MENU should be in the same format as `custom-variable-menu'.
407WIDGET is the widget to apply the filter entries of MENU on."
408 (let ((result nil)
409 current name action filter)
d3d4df42 410 (while menu
6d528fc5
PA
411 (setq current (car menu)
412 name (nth 0 current)
413 action (nth 1 current)
414 filter (nth 2 current)
415 menu (cdr menu))
416 (if (or (null filter) (funcall filter widget))
417 (push (cons name action) result)
418 (push name result)))
419 (nreverse result)))
420
bd042c03
PA
421;;; Unlispify.
422
d543e20b 423(defvar custom-prefix-list nil
2365594b 424 "List of prefixes that should be ignored by `custom-unlispify'.")
d543e20b
PA
425
426(defcustom custom-unlispify-menu-entries t
427 "Display menu entries as words instead of symbols if non nil."
6aaedd12 428 :group 'custom-menu
d543e20b
PA
429 :type 'boolean)
430
cda987f4
RS
431(defcustom custom-unlispify-remove-prefixes nil
432 "Non-nil means remove group prefixes from option names in buffer."
433 :group 'custom-menu
434 :type 'boolean)
435
d543e20b 436(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
2365594b 437 "Convert SYMBOL into a menu entry."
d543e20b
PA
438 (cond ((not custom-unlispify-menu-entries)
439 (symbol-name symbol))
440 ((get symbol 'custom-tag)
441 (if no-suffix
442 (get symbol 'custom-tag)
443 (concat (get symbol 'custom-tag) "...")))
444 (t
445 (save-excursion
446 (set-buffer (get-buffer-create " *Custom-Work*"))
447 (erase-buffer)
448 (princ symbol (current-buffer))
449 (goto-char (point-min))
bd042c03
PA
450 (when (and (eq (get symbol 'custom-type) 'boolean)
451 (re-search-forward "-p\\'" nil t))
452 (replace-match "" t t)
453 (goto-char (point-min)))
cda987f4
RS
454 (if custom-unlispify-remove-prefixes
455 (let ((prefixes custom-prefix-list)
456 prefix)
457 (while prefixes
458 (setq prefix (car prefixes))
459 (if (search-forward prefix (+ (point) (length prefix)) t)
d3d4df42 460 (progn
cda987f4
RS
461 (setq prefixes nil)
462 (delete-region (point-min) (point)))
463 (setq prefixes (cdr prefixes))))))
d543e20b
PA
464 (subst-char-in-region (point-min) (point-max) ?- ?\ t)
465 (capitalize-region (point-min) (point-max))
d3d4df42 466 (unless no-suffix
d543e20b
PA
467 (goto-char (point-max))
468 (insert "..."))
469 (buffer-string)))))
470
471(defcustom custom-unlispify-tag-names t
472 "Display tag names as words instead of symbols if non nil."
6aaedd12 473 :group 'custom-buffer
d543e20b
PA
474 :type 'boolean)
475
476(defun custom-unlispify-tag-name (symbol)
2365594b 477 "Convert SYMBOL into a menu entry."
d543e20b
PA
478 (let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
479 (custom-unlispify-menu-entry symbol t)))
480
481(defun custom-prefix-add (symbol prefixes)
2365594b 482 "Add SYMBOL to list of ignored PREFIXES."
d543e20b
PA
483 (cons (or (get symbol 'custom-prefix)
484 (concat (symbol-name symbol) "-"))
485 prefixes))
486
bd042c03
PA
487;;; Guess.
488
489(defcustom custom-guess-name-alist
490 '(("-p\\'" boolean)
491 ("-hook\\'" hook)
492 ("-face\\'" face)
493 ("-file\\'" file)
494 ("-function\\'" function)
495 ("-functions\\'" (repeat function))
496 ("-list\\'" (repeat sexp))
497 ("-alist\\'" (repeat (cons sexp sexp))))
498 "Alist of (MATCH TYPE).
499
d3d4df42 500MATCH should be a regexp matching the name of a symbol, and TYPE should
bd042c03
PA
501be a widget suitable for editing the value of that symbol. The TYPE
502of the first entry where MATCH matches the name of the symbol will be
d3d4df42 503used.
bd042c03
PA
504
505This is used for guessing the type of variables not declared with
506customize."
507 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
d543e20b
PA
508 :group 'customize)
509
bd042c03
PA
510(defcustom custom-guess-doc-alist
511 '(("\\`\\*?Non-nil " boolean))
512 "Alist of (MATCH TYPE).
d543e20b 513
bd042c03
PA
514MATCH should be a regexp matching a documentation string, and TYPE
515should be a widget suitable for editing the value of a variable with
516that documentation string. The TYPE of the first entry where MATCH
517matches the name of the symbol will be used.
d543e20b 518
bd042c03
PA
519This is used for guessing the type of variables not declared with
520customize."
521 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
522 :group 'customize)
d543e20b 523
bd042c03
PA
524(defun custom-guess-type (symbol)
525 "Guess a widget suitable for editing the value of SYMBOL.
d3d4df42 526This is done by matching SYMBOL with `custom-guess-name-alist' and
bd042c03
PA
527if that fails, the doc string with `custom-guess-doc-alist'."
528 (let ((name (symbol-name symbol))
529 (names custom-guess-name-alist)
530 current found)
531 (while names
532 (setq current (car names)
533 names (cdr names))
534 (when (string-match (nth 0 current) name)
535 (setq found (nth 1 current)
536 names nil)))
537 (unless found
538 (let ((doc (documentation-property symbol 'variable-documentation))
539 (docs custom-guess-doc-alist))
d3d4df42 540 (when doc
bd042c03
PA
541 (while docs
542 (setq current (car docs)
543 docs (cdr docs))
544 (when (string-match (nth 0 current) doc)
545 (setq found (nth 1 current)
546 docs nil))))))
547 found))
d543e20b 548
25ac13b5
PA
549;;; Sorting.
550
da5ec617
PA
551(defcustom custom-browse-sort-alphabetically nil
552 "If non-nil, sort members of each customization group alphabetically."
553 :type 'boolean
554 :group 'custom-browse)
555
556(defcustom custom-browse-order-groups nil
557 "If non-nil, order group members within each customization group.
558If `first', order groups before non-groups.
559If `last', order groups after non-groups."
560 :type '(choice (const first)
561 (const last)
562 (const :tag "none" nil))
563 :group 'custom-browse)
564
c953515e
PA
565(defcustom custom-browse-only-groups nil
566 "If non-nil, show group members only within each customization group."
567 :type 'boolean
568 :group 'custom-browse)
569
944c91b6 570(defcustom custom-buffer-sort-alphabetically nil
da5ec617 571 "If non-nil, sort members of each customization group alphabetically."
944c91b6 572 :type 'boolean
6aaedd12 573 :group 'custom-buffer)
25ac13b5 574
da5ec617
PA
575(defcustom custom-buffer-order-groups 'last
576 "If non-nil, order group members within each customization group.
577If `first', order groups before non-groups.
578If `last', order groups after non-groups."
579 :type '(choice (const first)
580 (const last)
581 (const :tag "none" nil))
6aaedd12 582 :group 'custom-buffer)
25ac13b5 583
944c91b6 584(defcustom custom-menu-sort-alphabetically nil
da5ec617 585 "If non-nil, sort members of each customization group alphabetically."
944c91b6 586 :type 'boolean
6aaedd12 587 :group 'custom-menu)
25ac13b5 588
da5ec617
PA
589(defcustom custom-menu-order-groups 'first
590 "If non-nil, order group members within each customization group.
591If `first', order groups before non-groups.
592If `last', order groups after non-groups."
593 :type '(choice (const first)
594 (const last)
595 (const :tag "none" nil))
6aaedd12
PA
596 :group 'custom-menu)
597
b4854a23
KH
598;;;###autoload (add-hook 'same-window-regexps "\\`\\*Customiz.*\\*\\'")
599
da5ec617
PA
600(defun custom-sort-items (items sort-alphabetically order-groups)
601 "Return a sorted copy of ITEMS.
602ITEMS should be a `custom-group' property.
603If SORT-ALPHABETICALLY non-nil, sort alphabetically.
604If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
605groups after non-groups, if nil do not order groups at all."
606 (sort (copy-sequence items)
607 (lambda (a b)
608 (let ((typea (nth 1 a)) (typeb (nth 1 b))
359476e0 609 (namea (nth 0 a)) (nameb (nth 0 b)))
da5ec617
PA
610 (cond ((not order-groups)
611 ;; Since we don't care about A and B order, maybe sort.
612 (when sort-alphabetically
613 (string-lessp namea nameb)))
614 ((eq typea 'custom-group)
615 ;; If B is also a group, maybe sort. Otherwise, order A and B.
616 (if (eq typeb 'custom-group)
617 (when sort-alphabetically
618 (string-lessp namea nameb))
619 (eq order-groups 'first)))
620 ((eq typeb 'custom-group)
621 ;; Since A cannot be a group, order A and B.
622 (eq order-groups 'last))
623 (sort-alphabetically
624 ;; Since A and B cannot be groups, sort.
625 (string-lessp namea nameb)))))))
25ac13b5 626
d543e20b
PA
627;;; Custom Mode Commands.
628
bd042c03
PA
629(defvar custom-options nil
630 "Customization widgets in the current buffer.")
631
ab678382 632(defun Custom-set ()
d543e20b
PA
633 "Set changes in all modified options."
634 (interactive)
635 (let ((children custom-options))
fadbdfea
DL
636 (mapc (lambda (child)
637 (when (eq (widget-get child :custom-state) 'modified)
638 (widget-apply child :custom-set)))
d543e20b
PA
639 children)))
640
ab678382 641(defun Custom-save ()
d543e20b
PA
642 "Set all modified group members and save them."
643 (interactive)
644 (let ((children custom-options))
fadbdfea
DL
645 (mapc (lambda (child)
646 (when (memq (widget-get child :custom-state)
647 '(modified set changed rogue))
648 (widget-apply child :custom-save)))
d543e20b
PA
649 children))
650 (custom-save-all))
651
d3d4df42 652(defvar custom-reset-menu
ab678382
RS
653 '(("Current" . Custom-reset-current)
654 ("Saved" . Custom-reset-saved)
19d63704 655 ("Erase Customization (use standard settings)" . Custom-reset-standard))
d543e20b
PA
656 "Alist of actions for the `Reset' button.
657The key is a string containing the name of the action, the value is a
2365594b 658Lisp function taking the widget as an element which will be called
d543e20b
PA
659when the action is chosen.")
660
661(defun custom-reset (event)
662 "Select item from reset menu."
663 (let* ((completion-ignore-case t)
664 (answer (widget-choose "Reset to"
665 custom-reset-menu
666 event)))
667 (if answer
668 (funcall answer))))
669
ab678382 670(defun Custom-reset-current (&rest ignore)
d543e20b
PA
671 "Reset all modified group members to their current value."
672 (interactive)
673 (let ((children custom-options))
fadbdfea
DL
674 (mapc (lambda (widget)
675 (and (default-boundp (widget-value widget))
676 (if (memq (widget-get widget :custom-state)
677 '(modified changed))
678 (widget-apply widget :custom-reset-current))))
d543e20b
PA
679 children)))
680
ab678382 681(defun Custom-reset-saved (&rest ignore)
d543e20b
PA
682 "Reset all modified or set group members to their saved value."
683 (interactive)
684 (let ((children custom-options))
fadbdfea
DL
685 (mapc (lambda (widget)
686 (and (get (widget-value widget) 'saved-value)
687 (if (memq (widget-get widget :custom-state)
688 '(modified set changed rogue))
689 (widget-apply widget :custom-reset-saved))))
d543e20b
PA
690 children)))
691
ab678382 692(defun Custom-reset-standard (&rest ignore)
19d63704
RS
693 "Erase all customization (either current or saved) for the group members.
694The immediate result is to restore them to their standard settings.
695This operation eliminates any saved settings for the group members,
696making them as if they had never been customized at all."
d543e20b
PA
697 (interactive)
698 (let ((children custom-options))
fadbdfea
DL
699 (mapc (lambda (widget)
700 (and (get (widget-value widget) 'standard-value)
701 (if (memq (widget-get widget :custom-state)
702 '(modified set changed saved rogue))
703 (widget-apply widget :custom-reset-standard))))
d543e20b
PA
704 children)))
705
706;;; The Customize Commands
707
d3d4df42 708(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
6d528fc5
PA
709 "Prompt for a variable and a value and return them as a list.
710PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
711prompt for the value. The %s escape in PROMPT-VAL is replaced with
712the name of the variable.
713
714If the variable has a `variable-interactive' property, that is used as if
715it were the arg to `interactive' (which see) to interactively read the value.
716
717If the variable has a `custom-type' property, it must be a widget and the
d3d4df42
DL
718`:prompt-value' property of that widget will be used for reading the value.
719
720If optional COMMENT argument is non nil, also prompt for a comment and return
721it as the third element in the list."
6d528fc5 722 (let* ((var (read-variable prompt-var))
d3d4df42
DL
723 (minibuffer-help-form '(describe-variable var))
724 (val
6d528fc5
PA
725 (let ((prop (get var 'variable-interactive))
726 (type (get var 'custom-type))
727 (prompt (format prompt-val var)))
728 (unless (listp type)
729 (setq type (list type)))
730 (cond (prop
731 ;; Use VAR's `variable-interactive' property
732 ;; as an interactive spec for prompting.
733 (call-interactively (list 'lambda '(arg)
734 (list 'interactive prop)
735 'arg)))
736 (type
737 (widget-prompt-value type
738 prompt
739 (if (boundp var)
740 (symbol-value var))
741 (not (boundp var))))
742 (t
d3d4df42
DL
743 (eval-minibuffer prompt))))))
744 (if comment
745 (list var val
746 (read-string "Comment: " (get var 'variable-comment)))
747 (list var val))))
6d528fc5
PA
748
749;;;###autoload
d3d4df42 750(defun customize-set-value (var val &optional comment)
6d528fc5
PA
751 "Set VARIABLE to VALUE. VALUE is a Lisp object.
752
753If VARIABLE has a `variable-interactive' property, that is used as if
754it were the arg to `interactive' (which see) to interactively read the value.
755
756If VARIABLE has a `custom-type' property, it must be a widget and the
d3d4df42
DL
757`:prompt-value' property of that widget will be used for reading the value.
758
759If given a prefix (or a COMMENT argument), also prompt for a comment."
6d528fc5 760 (interactive (custom-prompt-variable "Set variable: "
d3d4df42
DL
761 "Set %s to value: "
762 current-prefix-arg))
6d528fc5 763
d3d4df42
DL
764 (set var val)
765 (cond ((string= comment "")
766 (put var 'variable-comment nil))
767 (comment
768 (put var 'variable-comment comment))))
6d528fc5
PA
769
770;;;###autoload
2365594b 771(defun customize-set-variable (variable value &optional comment)
6d528fc5
PA
772 "Set the default for VARIABLE to VALUE. VALUE is a Lisp object.
773
774If VARIABLE has a `custom-set' property, that is used for setting
775VARIABLE, otherwise `set-default' is used.
776
777The `customized-value' property of the VARIABLE will be set to a list
778with a quoted VALUE as its sole list member.
779
780If VARIABLE has a `variable-interactive' property, that is used as if
781it were the arg to `interactive' (which see) to interactively read the value.
782
783If VARIABLE has a `custom-type' property, it must be a widget and the
d3d4df42
DL
784`:prompt-value' property of that widget will be used for reading the value.
785
786If given a prefix (or a COMMENT argument), also prompt for a comment."
6d528fc5 787 (interactive (custom-prompt-variable "Set variable: "
d3d4df42
DL
788 "Set customized value for %s to: "
789 current-prefix-arg))
2365594b
DL
790 (funcall (or (get variable 'custom-set) 'set-default) variable value)
791 (put variable 'customized-value (list (custom-quote value)))
d3d4df42 792 (cond ((string= comment "")
2365594b
DL
793 (put variable 'variable-comment nil)
794 (put variable 'customized-variable-comment nil))
d3d4df42 795 (comment
2365594b
DL
796 (put variable 'variable-comment comment)
797 (put variable 'customized-variable-comment comment))))
6d528fc5 798
4ee1cf9f 799;;;###autoload
2365594b 800(defun customize-save-variable (var value &optional comment)
4ee1cf9f
PA
801 "Set the default for VARIABLE to VALUE, and save it for future sessions.
802If VARIABLE has a `custom-set' property, that is used for setting
803VARIABLE, otherwise `set-default' is used.
804
805The `customized-value' property of the VARIABLE will be set to a list
806with a quoted VALUE as its sole list member.
807
808If VARIABLE has a `variable-interactive' property, that is used as if
809it were the arg to `interactive' (which see) to interactively read the value.
810
811If VARIABLE has a `custom-type' property, it must be a widget and the
d3d4df42
DL
812`:prompt-value' property of that widget will be used for reading the value.
813
814If given a prefix (or a COMMENT argument), also prompt for a comment."
4ee1cf9f 815 (interactive (custom-prompt-variable "Set and ave variable: "
d3d4df42
DL
816 "Set and save value for %s as: "
817 current-prefix-arg))
2365594b
DL
818 (funcall (or (get var 'custom-set) 'set-default) var value)
819 (put var 'saved-value (list (custom-quote value)))
d3d4df42
DL
820 (cond ((string= comment "")
821 (put var 'variable-comment nil)
822 (put var 'saved-variable-comment nil))
823 (comment
824 (put var 'variable-comment comment)
825 (put var 'saved-variable-comment comment)))
4ee1cf9f
PA
826 (custom-save-all))
827
d543e20b 828;;;###autoload
5dd0cad0
RS
829(defun customize ()
830 "Select a customization buffer which you can use to set user options.
831User options are structured into \"groups\".
832Initially the top-level group `Emacs' and its immediate subgroups
833are shown; the contents of those subgroups are initially hidden."
834 (interactive)
dc2e979f 835 (customize-group 'emacs))
5dd0cad0
RS
836
837;;;###autoload
838(defun customize-group (group)
839 "Customize GROUP, which must be a customization group."
07e694f8
RS
840 (interactive (list (let ((completion-ignore-case t))
841 (completing-read "Customize group: (default emacs) "
d3d4df42 842 obarray
07e694f8 843 (lambda (symbol)
5aa3f181
RS
844 (or (get symbol 'custom-loads)
845 (get symbol 'custom-group)))
07e694f8 846 t))))
5dd0cad0
RS
847 (when (stringp group)
848 (if (string-equal "" group)
849 (setq group 'emacs)
850 (setq group (intern group))))
5aa3f181
RS
851 (or (get group 'custom-group)
852 (custom-load-symbol group))
241d3080
RS
853 (let ((name (format "*Customize Group: %s*"
854 (custom-unlispify-tag-name group))))
855 (if (get-buffer name)
b4854a23 856 (pop-to-buffer name)
241d3080 857 (custom-buffer-create (list (list group 'custom-group))
3aec85bf
RS
858 name
859 (concat " for group "
860 (custom-unlispify-tag-name group))))))
d543e20b 861
6d528fc5 862;;;###autoload
fd88fe73
RS
863(defun customize-group-other-window (group)
864 "Customize GROUP, which must be a customization group."
865 (interactive (list (let ((completion-ignore-case t))
866 (completing-read "Customize group: (default emacs) "
d3d4df42 867 obarray
fd88fe73
RS
868 (lambda (symbol)
869 (or (get symbol 'custom-loads)
870 (get symbol 'custom-group)))
871 t))))
872 (when (stringp group)
873 (if (string-equal "" group)
874 (setq group 'emacs)
875 (setq group (intern group))))
876 (or (get group 'custom-group)
877 (custom-load-symbol group))
878 (let ((name (format "*Customize Group: %s*"
879 (custom-unlispify-tag-name group))))
880 (if (get-buffer name)
881 (let ((window (selected-window)))
09da6520 882 (pop-to-buffer name)
fd88fe73
RS
883 (select-window window))
884 (custom-buffer-create-other-window
885 (list (list group 'custom-group))
886 name
887 (concat " for group "
888 (custom-unlispify-tag-name group))))))
6d528fc5 889
9097aeb7
PA
890;;;###autoload
891(defalias 'customize-variable 'customize-option)
38d58078 892
d543e20b 893;;;###autoload
38d58078
RS
894(defun customize-option (symbol)
895 "Customize SYMBOL, which must be a user option variable."
bd042c03 896 (interactive (custom-variable-prompt))
41b3e67c
KH
897 ;; If we don't have SYMBOL's real definition loaded,
898 ;; try to load it.
899 (unless (get symbol 'custom-type)
900 (let ((loaddefs-file (locate-library "loaddefs.el" t))
901 file)
902 ;; See if it is autoloaded from some library.
903 (when loaddefs-file
904 (with-temp-buffer
905 (insert-file-contents loaddefs-file)
906 (when (re-search-forward (concat "^(defvar " (symbol-name symbol))
907 nil t)
908 (search-backward "\n;;; Generated autoloads from ")
909 (goto-char (match-end 0))
910 (setq file (buffer-substring (point)
911 (progn (end-of-line) (point)))))))
912 ;; If it is, load that library.
913 (when file
914 (when (string-match "\\.el\\'" file)
915 (setq file (substring file 0 (match-beginning 0))))
916 (load file))))
917 (unless (get symbol 'custom-type)
918 (error "Variable %s cannot be customized" symbol))
86bd10bc 919 (custom-buffer-create (list (list symbol 'custom-variable))
38d58078 920 (format "*Customize Option: %s*"
86bd10bc 921 (custom-unlispify-tag-name symbol))))
d543e20b 922
e418be26
KH
923(defvar customize-changed-options-previous-release "20.2"
924 "Version for `customize-changed-options' to refer back to by default.")
925
c32de15e 926;;;###autoload
f50dc5d2 927(defun customize-changed-options (since-version)
e418be26
KH
928 "Customize all user option variables changed in Emacs itself.
929This includes new user option variables and faces, and new
930customization groups, as well as older options and faces whose default
931values have changed since the previous major Emacs release.
932
933With argument SINCE-VERSION (a string), customize all user option
934variables that were added (or their meanings were changed) since that
935version."
936
f50dc5d2
KH
937 (interactive "sCustomize options changed, since version (default all versions): ")
938 (if (equal since-version "")
26c67de8
DL
939 (setq since-version nil)
940 (unless (condition-case nil
941 (numberp (read since-version))
942 (error nil))
943 (signal 'wrong-type-argument (list 'numberp since-version))))
e418be26
KH
944 (unless since-version
945 (setq since-version customize-changed-options-previous-release))
1e484d64
DN
946 (let ((found nil)
947 (versions nil))
f50dc5d2 948 (mapatoms (lambda (symbol)
a55d9b3b 949 (and (or (boundp symbol)
1e484d64
DN
950 ;; For variables not yet loaded.
951 (get symbol 'standard-value)
a55d9b3b
DN
952 ;; For groups the previous test fails, this one
953 ;; could be used to determine if symbol is a
954 ;; group. Is there a better way for this?
955 (get symbol 'group-documentation))
f50dc5d2
KH
956 (let ((version (get symbol 'custom-version)))
957 (and version
958 (or (null since-version)
1e484d64 959 (customize-version-lessp since-version version))
d3d4df42 960 (if (member version versions)
1e484d64
DN
961 t
962 ;;; Collect all versions that we use.
963 (push version versions))))
f50dc5d2 964 (setq found
a55d9b3b
DN
965 ;; We have to set the right thing here,
966 ;; depending if we have a group or a
d3d4df42 967 ;; variable.
a55d9b3b
DN
968 (if (get symbol 'group-documentation)
969 (cons (list symbol 'custom-group) found)
970 (cons (list symbol 'custom-variable) found))))))
f50dc5d2 971 (if (not found)
e418be26
KH
972 (error "No user option defaults have been changed since Emacs %s"
973 since-version)
65f64d00
RS
974 (let ((flist nil))
975 (while versions
d3d4df42 976 (push (copy-sequence
65f64d00
RS
977 (cdr (assoc (car versions) custom-versions-load-alist)))
978 flist)
979 (setq versions (cdr versions)))
d3d4df42 980 (put 'custom-versions-load-alist 'custom-loads
65f64d00
RS
981 ;; Get all the files that correspond to element from the
982 ;; VERSIONS list. This could use some simplification.
1e484d64
DN
983 (apply 'nconc flist)))
984 ;; Because we set all the files needed to be loaded as a
985 ;; `custom-loads' property to `custom-versions-load-alist' this
986 ;; call will actually load them.
987 (custom-load-symbol 'custom-versions-load-alist)
988 ;; Clean up
989 (put 'custom-versions-load-alist 'custom-loads nil)
990 (custom-buffer-create (custom-sort-items found t 'first)
f50dc5d2
KH
991 "*Customize Changed Options*"))))
992
993(defun customize-version-lessp (version1 version2)
26c67de8
DL
994 ;; Why are the versions strings, and given that they are, why aren't
995 ;; they converted to numbers and compared as such here? -- fx
996
e418be26
KH
997 ;; In case someone made a mistake and left out the quotes
998 ;; in the :version value.
999 (if (numberp version2)
1000 (setq version2 (prin1-to-string version2)))
f50dc5d2 1001 (let (major1 major2 minor1 minor2)
26c67de8
DL
1002 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version1)
1003 (setq major1 (read (or (match-string 1 version1)
1004 "0")))
1005 (setq minor1 (read (or (match-string 3 version1)
1006 "0")))
1007 (string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version2)
1008 (setq major2 (read (or (match-string 1 version2)
1009 "0")))
1010 (setq minor2 (read (or (match-string 3 version2)
1011 "0")))
f50dc5d2
KH
1012 (or (< major1 major2)
1013 (and (= major1 major2)
1014 (< minor1 minor2)))))
1015
1016;;;###autoload
c32de15e
PA
1017(defalias 'customize-variable-other-window 'customize-option-other-window)
1018
bd042c03 1019;;;###autoload
38d58078
RS
1020(defun customize-option-other-window (symbol)
1021 "Customize SYMBOL, which must be a user option variable.
bd042c03
PA
1022Show the buffer in another window, but don't select it."
1023 (interactive (custom-variable-prompt))
86bd10bc
PA
1024 (custom-buffer-create-other-window
1025 (list (list symbol 'custom-variable))
38d58078 1026 (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
bd042c03 1027
d543e20b
PA
1028;;;###autoload
1029(defun customize-face (&optional symbol)
1030 "Customize SYMBOL, which should be a face name or nil.
1031If SYMBOL is nil, customize all faces."
d3d4df42 1032 (interactive (list (completing-read "Customize face: (default all) "
8d8ca350 1033 obarray 'custom-facep t)))
d543e20b 1034 (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
da5ec617
PA
1035 (custom-buffer-create (custom-sort-items
1036 (mapcar (lambda (symbol)
1037 (list symbol 'custom-face))
1038 (face-list))
1039 t nil)
1040 "*Customize Faces*")
1041 (when (stringp symbol)
1042 (setq symbol (intern symbol)))
d543e20b
PA
1043 (unless (symbolp symbol)
1044 (error "Should be a symbol %S" symbol))
86bd10bc
PA
1045 (custom-buffer-create (list (list symbol 'custom-face))
1046 (format "*Customize Face: %s*"
1047 (custom-unlispify-tag-name symbol)))))
d543e20b 1048
bd042c03
PA
1049;;;###autoload
1050(defun customize-face-other-window (&optional symbol)
2365594b 1051 "Show customization buffer for face SYMBOL in other window."
d3d4df42 1052 (interactive (list (completing-read "Customize face: "
8d8ca350 1053 obarray 'custom-facep t)))
bd042c03
PA
1054 (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
1055 ()
1056 (if (stringp symbol)
1057 (setq symbol (intern symbol)))
1058 (unless (symbolp symbol)
1059 (error "Should be a symbol %S" symbol))
d3d4df42 1060 (custom-buffer-create-other-window
86bd10bc
PA
1061 (list (list symbol 'custom-face))
1062 (format "*Customize Face: %s*" (custom-unlispify-tag-name symbol)))))
bd042c03 1063
d543e20b
PA
1064;;;###autoload
1065(defun customize-customized ()
6d528fc5
PA
1066 "Customize all user options set since the last save in this session."
1067 (interactive)
1068 (let ((found nil))
1069 (mapatoms (lambda (symbol)
d3d4df42
DL
1070 (and (or (get symbol 'customized-face)
1071 (get symbol 'customized-face-comment))
6d528fc5 1072 (custom-facep symbol)
a1a4fa22 1073 (push (list symbol 'custom-face) found))
d3d4df42
DL
1074 (and (or (get symbol 'customized-value)
1075 (get symbol 'customized-variable-comment))
6d528fc5 1076 (boundp symbol)
a1a4fa22 1077 (push (list symbol 'custom-variable) found))))
da5ec617
PA
1078 (if (not found)
1079 (error "No customized user options")
1080 (custom-buffer-create (custom-sort-items found t nil)
1081 "*Customize Customized*"))))
6d528fc5
PA
1082
1083;;;###autoload
1084(defun customize-saved ()
1085 "Customize all already saved user options."
d543e20b
PA
1086 (interactive)
1087 (let ((found nil))
1088 (mapatoms (lambda (symbol)
d3d4df42
DL
1089 (and (or (get symbol 'saved-face)
1090 (get symbol 'saved-face-comment))
d543e20b 1091 (custom-facep symbol)
a1a4fa22 1092 (push (list symbol 'custom-face) found))
d3d4df42
DL
1093 (and (or (get symbol 'saved-value)
1094 (get symbol 'saved-variable-comment))
d543e20b 1095 (boundp symbol)
a1a4fa22 1096 (push (list symbol 'custom-variable) found))))
da5ec617
PA
1097 (if (not found )
1098 (error "No saved user options")
1099 (custom-buffer-create (custom-sort-items found t nil)
1100 "*Customize Saved*"))))
d543e20b
PA
1101
1102;;;###autoload
1103(defun customize-apropos (regexp &optional all)
1104 "Customize all user options matching REGEXP.
a1a4fa22
PA
1105If ALL is `options', include only options.
1106If ALL is `faces', include only faces.
1107If ALL is `groups', include only groups.
1108If ALL is t (interactively, with prefix arg), include options which are not
1109user-settable, as well as faces and groups."
d543e20b
PA
1110 (interactive "sCustomize regexp: \nP")
1111 (let ((found nil))
1112 (mapatoms (lambda (symbol)
1113 (when (string-match regexp (symbol-name symbol))
a1a4fa22
PA
1114 (when (and (not (memq all '(faces options)))
1115 (get symbol 'custom-group))
1116 (push (list symbol 'custom-group) found))
1117 (when (and (not (memq all '(options groups)))
1118 (custom-facep symbol))
1119 (push (list symbol 'custom-face) found))
1120 (when (and (not (memq all '(groups faces)))
1121 (boundp symbol)
d543e20b 1122 (or (get symbol 'saved-value)
25ac13b5 1123 (get symbol 'standard-value)
a1a4fa22
PA
1124 (if (memq all '(nil options))
1125 (user-variable-p symbol)
1126 (get symbol 'variable-documentation))))
1127 (push (list symbol 'custom-variable) found)))))
1128 (if (not found)
1129 (error "No matches")
da5ec617
PA
1130 (custom-buffer-create (custom-sort-items found t
1131 custom-buffer-order-groups)
1132 "*Customize Apropos*"))))
a1a4fa22
PA
1133
1134;;;###autoload
1135(defun customize-apropos-options (regexp &optional arg)
1136 "Customize all user options matching REGEXP.
1137With prefix arg, include options which are not user-settable."
1138 (interactive "sCustomize regexp: \nP")
1139 (customize-apropos regexp (or arg 'options)))
1140
1141;;;###autoload
1142(defun customize-apropos-faces (regexp)
1143 "Customize all user faces matching REGEXP."
1144 (interactive "sCustomize regexp: \n")
1145 (customize-apropos regexp 'faces))
1146
1147;;;###autoload
1148(defun customize-apropos-groups (regexp)
1149 "Customize all user groups matching REGEXP."
1150 (interactive "sCustomize regexp: \n")
1151 (customize-apropos regexp 'groups))
d543e20b 1152
6d528fc5
PA
1153;;; Buffer.
1154
944c91b6
PA
1155(defcustom custom-buffer-style 'links
1156 "Control the presentation style for customization buffers.
1157The value should be a symbol, one of:
1158
1159brackets: groups nest within each other with big horizontal brackets.
1160links: groups have links to subgroups."
1161 :type '(radio (const brackets)
1162 (const links))
1163 :group 'custom-buffer)
1164
8d8ca350
DL
1165;; If we pass BUFFER to `bury-buffer', the buffer isn't removed from
1166;; the window.
62633a5f
DL
1167(defun custom-bury-buffer (buffer)
1168 (bury-buffer))
1169
8d8ca350 1170(defcustom custom-buffer-done-function 'custom-bury-buffer
d3d4df42
DL
1171 "*Function called to remove a Custom buffer when the user is done with it.
1172Called with one argument, the buffer to remove."
8d8ca350
DL
1173 :type '(choice (function-item :tag "Bury buffer" custom-bury-buffer)
1174 (function-item :tag "Kill buffer" kill-buffer)
d3d4df42
DL
1175 (function :tag "Other"))
1176 :version "21.1"
1177 :group 'custom-buffer)
1178
944c91b6
PA
1179(defcustom custom-buffer-indent 3
1180 "Number of spaces to indent nested groups."
1181 :type 'integer
1182 :group 'custom-buffer)
1183
d543e20b 1184;;;###autoload
3aec85bf 1185(defun custom-buffer-create (options &optional name description)
d543e20b 1186 "Create a buffer containing OPTIONS.
86bd10bc 1187Optional NAME is the name of the buffer.
d543e20b
PA
1188OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1189SYMBOL is a customization option, and WIDGET is a widget for editing
1190that option."
86bd10bc
PA
1191 (unless name (setq name "*Customization*"))
1192 (kill-buffer (get-buffer-create name))
b4854a23 1193 (pop-to-buffer (get-buffer-create name))
3aec85bf 1194 (custom-buffer-create-internal options description))
bd042c03 1195
6d528fc5 1196;;;###autoload
3aec85bf 1197(defun custom-buffer-create-other-window (options &optional name description)
bd042c03 1198 "Create a buffer containing OPTIONS.
86bd10bc 1199Optional NAME is the name of the buffer.
bd042c03
PA
1200OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1201SYMBOL is a customization option, and WIDGET is a widget for editing
1202that option."
86bd10bc
PA
1203 (unless name (setq name "*Customization*"))
1204 (kill-buffer (get-buffer-create name))
b4854a23
KH
1205 (let ((window (selected-window))
1206 (pop-up-windows t)
1207 (special-display-buffer-names nil)
1208 (special-display-regexps nil)
1209 (same-window-buffer-names nil)
1210 (same-window-regexps nil))
1211 (pop-to-buffer (get-buffer-create name))
3aec85bf 1212 (custom-buffer-create-internal options description)
bd042c03 1213 (select-window window)))
9097aeb7
PA
1214
1215(defcustom custom-reset-button-menu nil
1216 "If non-nil, only show a single reset button in customize buffers.
1217This button will have a menu with all three reset operations."
1218 :type 'boolean
6aaedd12 1219 :group 'custom-buffer)
bd042c03 1220
d3d4df42
DL
1221(defun Custom-buffer-done (&rest ignore)
1222 "Remove current buffer by calling `custom-buffer-done-function'."
1223 (interactive)
1224 (funcall custom-buffer-done-function (current-buffer)))
1225
1226(defcustom custom-raised-buttons (not (equal (face-valid-attribute-values :box)
1227 '(("unspecified" . unspecified))))
1228 "If non-nil, indicate active buttons in a `raised-button' style.
1229Otherwise use brackets."
1230 :type 'boolean
1231 :version "21.1"
1232 :group 'custom-buffer)
1233
3aec85bf 1234(defun custom-buffer-create-internal (options &optional description)
bd042c03 1235 (message "Creating customization buffer...")
d543e20b 1236 (custom-mode)
3aec85bf
RS
1237 (widget-insert "This is a customization buffer")
1238 (if description
1239 (widget-insert description))
d3d4df42
DL
1240 (widget-insert (format ".
1241%s show active fields; type RET or click mouse-1
3aec85bf
RS
1242on an active field to invoke its action. Editing an option value
1243changes the text in the buffer; invoke the State button and
1244choose the Set operation to set the option value.
d3d4df42
DL
1245Invoke " (if custom-raised-buttons
1246 "`Raised' buttons"
1247 "Square brackets")))
1248 (widget-create 'info-link
cd6c0940 1249 :tag "Help"
d543e20b 1250 :help-echo "Read the online help."
eedc2336 1251 "(emacs)Easy Customization")
d543e20b 1252 (widget-insert " for more information.\n\n")
25ac13b5 1253 (message "Creating customization buttons...")
0eef62d5 1254 (widget-insert "Operate on everything in this buffer:\n ")
25ac13b5 1255 (widget-create 'push-button
0f3335c0 1256 :tag "Set for Current Session"
b62c92bb
RS
1257 :help-echo "\
1258Make your editing in this buffer take effect for this session."
25ac13b5 1259 :action (lambda (widget &optional event)
ab678382 1260 (Custom-set)))
25ac13b5
PA
1261 (widget-insert " ")
1262 (widget-create 'push-button
0f3335c0 1263 :tag "Save for Future Sessions"
25ac13b5 1264 :help-echo "\
b62c92bb 1265Make your editing in this buffer take effect for future Emacs sessions."
25ac13b5 1266 :action (lambda (widget &optional event)
ab678382 1267 (Custom-save)))
9097aeb7 1268 (if custom-reset-button-menu
0f3335c0
RS
1269 (progn
1270 (widget-insert " ")
1271 (widget-create 'push-button
1272 :tag "Reset"
1273 :help-echo "Show a menu with reset operations."
1274 :mouse-down-action (lambda (&rest junk) t)
1275 :action (lambda (widget &optional event)
1276 (custom-reset event))))
1277 (widget-insert "\n ")
9097aeb7
PA
1278 (widget-create 'push-button
1279 :tag "Reset"
c32de15e 1280 :help-echo "\
b62c92bb 1281Reset all edited text in this buffer to reflect current values."
ab678382 1282 :action 'Custom-reset-current)
9097aeb7
PA
1283 (widget-insert " ")
1284 (widget-create 'push-button
1285 :tag "Reset to Saved"
c32de15e 1286 :help-echo "\
b62c92bb 1287Reset all values in this buffer to their saved settings."
ab678382 1288 :action 'Custom-reset-saved)
9097aeb7
PA
1289 (widget-insert " ")
1290 (widget-create 'push-button
19d63704 1291 :tag "Erase Customization"
c32de15e 1292 :help-echo "\
19d63704 1293Un-customize all values in this buffer. They get their standard settings."
ab678382 1294 :action 'Custom-reset-standard))
0eef62d5 1295 (widget-insert " ")
25ac13b5 1296 (widget-create 'push-button
d3d4df42 1297 :tag "Finish"
91a38db1
DL
1298 :help-echo
1299 (lambda (&rest ignore)
6b292312
DL
1300 (cond
1301 ((eq custom-buffer-done-function
1302 'custom-bury-buffer)
1303 "Bury this buffer")
1304 ((eq custom-buffer-done-function 'kill-buffer)
1305 "Kill this buffer")
1306 (t "Finish with this buffer")))
d3d4df42 1307 :action #'Custom-buffer-done)
25ac13b5
PA
1308 (widget-insert "\n\n")
1309 (message "Creating customization items...")
fadbdfea 1310 (buffer-disable-undo)
d3d4df42 1311 (setq custom-options
d543e20b
PA
1312 (if (= (length options) 1)
1313 (mapcar (lambda (entry)
1314 (widget-create (nth 1 entry)
c32de15e 1315 :documentation-shown t
d543e20b
PA
1316 :custom-state 'unknown
1317 :tag (custom-unlispify-tag-name
1318 (nth 0 entry))
1319 :value (nth 0 entry)))
1320 options)
1321 (let ((count 0)
1322 (length (length options)))
1323 (mapcar (lambda (entry)
6b292312
DL
1324 (prog2
1325 (message "Creating customization items ...%2d%%"
1326 (/ (* 100.0 count) length))
1327 (widget-create (nth 1 entry)
d543e20b
PA
1328 :tag (custom-unlispify-tag-name
1329 (nth 0 entry))
1330 :value (nth 0 entry))
6b292312
DL
1331 (setq count (1+ count))
1332 (unless (eq (preceding-char) ?\n)
1333 (widget-insert "\n"))
1334 (widget-insert "\n")))
1335 options))))
d543e20b
PA
1336 (unless (eq (preceding-char) ?\n)
1337 (widget-insert "\n"))
1e484d64 1338 (message "Creating customization items ...%2d%%done" 100)
944c91b6 1339 (unless (eq custom-buffer-style 'tree)
fadbdfea 1340 (mapc 'custom-magic-reset custom-options))
d543e20b
PA
1341 (message "Creating customization setup...")
1342 (widget-setup)
fadbdfea 1343 (buffer-enable-undo)
d543e20b
PA
1344 (goto-char (point-min))
1345 (message "Creating customization buffer...done"))
1346
944c91b6
PA
1347;;; The Tree Browser.
1348
1349;;;###autoload
4ee1cf9f 1350(defun customize-browse (&optional group)
944c91b6 1351 "Create a tree browser for the customize hierarchy."
cda987f4 1352 (interactive)
4ee1cf9f
PA
1353 (unless group
1354 (setq group 'emacs))
1355 (let ((name "*Customize Browser*"))
1356 (kill-buffer (get-buffer-create name))
b4854a23 1357 (pop-to-buffer (get-buffer-create name)))
4ee1cf9f
PA
1358 (custom-mode)
1359 (widget-insert "\
cda987f4
RS
1360Square brackets show active fields; type RET or click mouse-1
1361on an active field to invoke its action.
df816618 1362Invoke [+] below to expand a group, and [-] to collapse an expanded group.\n")
4ee1cf9f
PA
1363 (if custom-browse-only-groups
1364 (widget-insert "\
c953515e 1365Invoke the [Group] button below to edit that item in another window.\n\n")
d3d4df42
DL
1366 (widget-insert "Invoke the ")
1367 (widget-create 'item
4ee1cf9f
PA
1368 :format "%t"
1369 :tag "[Group]"
1370 :tag-glyph "folder")
1371 (widget-insert ", ")
d3d4df42 1372 (widget-create 'item
4ee1cf9f
PA
1373 :format "%t"
1374 :tag "[Face]"
1375 :tag-glyph "face")
1376 (widget-insert ", and ")
d3d4df42 1377 (widget-create 'item
4ee1cf9f
PA
1378 :format "%t"
1379 :tag "[Option]"
1380 :tag-glyph "option")
1381 (widget-insert " buttons below to edit that
c953515e 1382item in another window.\n\n"))
4ee1cf9f 1383 (let ((custom-buffer-style 'tree))
d3d4df42 1384 (widget-create 'custom-group
4ee1cf9f
PA
1385 :custom-last t
1386 :custom-state 'unknown
1387 :tag (custom-unlispify-tag-name group)
1388 :value group))
1389 (goto-char (point-min)))
944c91b6 1390
c953515e 1391(define-widget 'custom-browse-visibility 'item
1edec9cf 1392 "Control visibility of items in the customize tree browser."
da5ec617 1393 :format "%[[%t]%]"
c953515e 1394 :action 'custom-browse-visibility-action)
944c91b6 1395
c953515e 1396(defun custom-browse-visibility-action (widget &rest ignore)
944c91b6
PA
1397 (let ((custom-buffer-style 'tree))
1398 (custom-toggle-parent widget)))
1399
c953515e 1400(define-widget 'custom-browse-group-tag 'push-button
944c91b6 1401 "Show parent in other window when activated."
cd6c0940 1402 :tag "Group"
da5ec617 1403 :tag-glyph "folder"
c953515e 1404 :action 'custom-browse-group-tag-action)
944c91b6 1405
c953515e 1406(defun custom-browse-group-tag-action (widget &rest ignore)
944c91b6
PA
1407 (let ((parent (widget-get widget :parent)))
1408 (customize-group-other-window (widget-value parent))))
1409
c953515e 1410(define-widget 'custom-browse-variable-tag 'push-button
944c91b6 1411 "Show parent in other window when activated."
cd6c0940 1412 :tag "Option"
da5ec617 1413 :tag-glyph "option"
c953515e 1414 :action 'custom-browse-variable-tag-action)
944c91b6 1415
c953515e 1416(defun custom-browse-variable-tag-action (widget &rest ignore)
944c91b6
PA
1417 (let ((parent (widget-get widget :parent)))
1418 (customize-variable-other-window (widget-value parent))))
1419
c953515e 1420(define-widget 'custom-browse-face-tag 'push-button
944c91b6 1421 "Show parent in other window when activated."
cd6c0940 1422 :tag "Face"
da5ec617 1423 :tag-glyph "face"
c953515e 1424 :action 'custom-browse-face-tag-action)
944c91b6 1425
c953515e 1426(defun custom-browse-face-tag-action (widget &rest ignore)
944c91b6
PA
1427 (let ((parent (widget-get widget :parent)))
1428 (customize-face-other-window (widget-value parent))))
1429
c953515e 1430(defconst custom-browse-alist '((" " "space")
da5ec617
PA
1431 (" | " "vertical")
1432 ("-\\ " "top")
1433 (" |-" "middle")
1434 (" `-" "bottom")))
1435
c953515e 1436(defun custom-browse-insert-prefix (prefix)
da5ec617 1437 "Insert PREFIX. On XEmacs convert it to line graphics."
d3d4df42 1438 ;; Fixme: do graphics.
da5ec617 1439 (if nil ; (string-match "XEmacs" emacs-version)
d3d4df42 1440 (progn
da5ec617
PA
1441 (insert "*")
1442 (while (not (string-equal prefix ""))
1443 (let ((entry (substring prefix 0 3)))
1444 (setq prefix (substring prefix 3))
1445 (let ((overlay (make-overlay (1- (point)) (point) nil t nil))
c953515e 1446 (name (nth 1 (assoc entry custom-browse-alist))))
da5ec617
PA
1447 (overlay-put overlay 'end-glyph (widget-glyph-find name entry))
1448 (overlay-put overlay 'start-open t)
1449 (overlay-put overlay 'end-open t)))))
1450 (insert prefix)))
1451
d543e20b
PA
1452;;; Modification of Basic Widgets.
1453;;
1454;; We add extra properties to the basic widgets needed here. This is
1455;; fine, as long as we are careful to stay within out own namespace.
1456;;
1457;; We want simple widgets to be displayed by default, but complex
1458;; widgets to be hidden.
1459
1460(widget-put (get 'item 'widget-type) :custom-show t)
1461(widget-put (get 'editable-field 'widget-type)
1462 :custom-show (lambda (widget value)
1463 (let ((pp (pp-to-string value)))
1464 (cond ((string-match "\n" pp)
1465 nil)
1466 ((> (length pp) 40)
1467 nil)
1468 (t t)))))
1469(widget-put (get 'menu-choice 'widget-type) :custom-show t)
1470
1471;;; The `custom-manual' Widget.
1472
1473(define-widget 'custom-manual 'info-link
1474 "Link to the manual entry for this customization option."
1475 :help-echo "Read the manual entry for this option."
1476 :tag "Manual")
1477
1478;;; The `custom-magic' Widget.
1479
6aaedd12
PA
1480(defgroup custom-magic-faces nil
1481 "Faces used by the magic button."
1482 :group 'custom-faces
1483 :group 'custom-buffer)
1484
d543e20b
PA
1485(defface custom-invalid-face '((((class color))
1486 (:foreground "yellow" :background "red"))
1487 (t
1488 (:bold t :italic t :underline t)))
6aaedd12
PA
1489 "Face used when the customize item is invalid."
1490 :group 'custom-magic-faces)
d543e20b
PA
1491
1492(defface custom-rogue-face '((((class color))
1493 (:foreground "pink" :background "black"))
1494 (t
1495 (:underline t)))
6aaedd12
PA
1496 "Face used when the customize item is not defined for customization."
1497 :group 'custom-magic-faces)
d543e20b 1498
d3d4df42 1499(defface custom-modified-face '((((class color))
d543e20b
PA
1500 (:foreground "white" :background "blue"))
1501 (t
1502 (:italic t :bold)))
6aaedd12
PA
1503 "Face used when the customize item has been modified."
1504 :group 'custom-magic-faces)
d543e20b 1505
d3d4df42 1506(defface custom-set-face '((((class color))
d543e20b
PA
1507 (:foreground "blue" :background "white"))
1508 (t
1509 (:italic t)))
6aaedd12
PA
1510 "Face used when the customize item has been set."
1511 :group 'custom-magic-faces)
d543e20b 1512
d3d4df42 1513(defface custom-changed-face '((((class color))
d543e20b
PA
1514 (:foreground "white" :background "blue"))
1515 (t
1516 (:italic t)))
6aaedd12
PA
1517 "Face used when the customize item has been changed."
1518 :group 'custom-magic-faces)
d543e20b
PA
1519
1520(defface custom-saved-face '((t (:underline t)))
6aaedd12
PA
1521 "Face used when the customize item has been saved."
1522 :group 'custom-magic-faces)
d543e20b 1523
25ac13b5 1524(defconst custom-magic-alist '((nil "#" underline "\
d543e20b 1525uninitialized, you should not see this.")
25ac13b5 1526 (unknown "?" italic "\
d543e20b 1527unknown, you should not see this.")
25ac13b5 1528 (hidden "-" default "\
cbc7d892
RS
1529hidden, invoke \"Show\" in the previous line to show." "\
1530group now hidden, invoke \"Show\", above, to show contents.")
25ac13b5 1531 (invalid "x" custom-invalid-face "\
9097aeb7 1532the value displayed for this %c is invalid and cannot be set.")
25ac13b5 1533 (modified "*" custom-modified-face "\
1e850936
RS
1534you have edited the value as text, but you have not set the %c." "\
1535you have edited something in this group, but not set it.")
25ac13b5 1536 (set "+" custom-set-face "\
1e850936
RS
1537you have set this %c, but not saved it for future sessions." "\
1538something in this group has been set, but not saved.")
25ac13b5 1539 (changed ":" custom-changed-face "\
9097aeb7 1540this %c has been changed outside the customize buffer." "\
25ac13b5
PA
1541something in this group has been changed outside customize.")
1542 (saved "!" custom-saved-face "\
9097aeb7 1543this %c has been set and saved." "\
5dd0cad0 1544something in this group has been set and saved.")
25ac13b5 1545 (rogue "@" custom-rogue-face "\
9097aeb7 1546this %c has not been changed with customize." "\
25ac13b5
PA
1547something in this group is not prepared for customization.")
1548 (standard " " nil "\
9097aeb7 1549this %c is unchanged from its standard setting." "\
c32de15e 1550visible group members are all at standard settings."))
d543e20b 1551 "Alist of customize option states.
d3d4df42 1552Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where
d543e20b
PA
1553
1554STATE is one of the following symbols:
1555
1556`nil'
1557 For internal use, should never occur.
1558`unknown'
1559 For internal use, should never occur.
1560`hidden'
d3d4df42 1561 This item is not being displayed.
d543e20b
PA
1562`invalid'
1563 This item is modified, but has an invalid form.
1564`modified'
1565 This item is modified, and has a valid form.
1566`set'
1567 This item has been set but not saved.
1568`changed'
1569 The current value of this item has been changed temporarily.
1570`saved'
1571 This item is marked for saving.
1572`rogue'
1573 This item has no customization information.
25ac13b5 1574`standard'
5dd0cad0 1575 This item is unchanged from the standard setting.
d543e20b
PA
1576
1577MAGIC is a string used to present that state.
1578
1579FACE is a face used to present the state.
1580
25ac13b5
PA
1581ITEM-DESC is a string describing the state for options.
1582
1583GROUP-DESC is a string describing the state for groups. If this is
1584left out, ITEM-DESC will be used.
1585
9097aeb7
PA
1586The string %c in either description will be replaced with the
1587category of the item. These are `group'. `option', and `face'.
1588
25ac13b5 1589The list should be sorted most significant first.")
d543e20b
PA
1590
1591(defcustom custom-magic-show 'long
3acab5ef 1592 "If non-nil, show textual description of the state.
b62c92bb 1593If `long', show a full-line description, not just one word."
d543e20b 1594 :type '(choice (const :tag "no" nil)
c992338c
AS
1595 (const long)
1596 (other :tag "short" short))
6aaedd12 1597 :group 'custom-buffer)
d543e20b 1598
9097aeb7 1599(defcustom custom-magic-show-hidden '(option face)
b62c92bb
RS
1600 "Control whether the State button is shown for hidden items.
1601The value should be a list with the custom categories where the State
9097aeb7
PA
1602button should be visible. Possible categories are `group', `option',
1603and `face'."
1604 :type '(set (const group) (const option) (const face))
6aaedd12 1605 :group 'custom-buffer)
3acab5ef 1606
25ac13b5 1607(defcustom custom-magic-show-button nil
b62c92bb 1608 "Show a \"magic\" button indicating the state of each customization option."
d543e20b 1609 :type 'boolean
6aaedd12 1610 :group 'custom-buffer)
d543e20b
PA
1611
1612(define-widget 'custom-magic 'default
1613 "Show and manipulate state for a customization option."
1614 :format "%v"
86bd10bc 1615 :action 'widget-parent-action
6d528fc5 1616 :notify 'ignore
d543e20b
PA
1617 :value-get 'ignore
1618 :value-create 'custom-magic-value-create
1619 :value-delete 'widget-children-value-delete)
1620
86bd10bc
PA
1621(defun widget-magic-mouse-down-action (widget &optional event)
1622 ;; Non-nil unless hidden.
d3d4df42 1623 (not (eq (widget-get (widget-get (widget-get widget :parent) :parent)
86bd10bc
PA
1624 :custom-state)
1625 'hidden)))
1626
d543e20b 1627(defun custom-magic-value-create (widget)
2365594b 1628 "Create compact status report for WIDGET."
d543e20b
PA
1629 (let* ((parent (widget-get widget :parent))
1630 (state (widget-get parent :custom-state))
3acab5ef 1631 (hidden (eq state 'hidden))
25ac13b5 1632 (entry (assq state custom-magic-alist))
d543e20b
PA
1633 (magic (nth 1 entry))
1634 (face (nth 2 entry))
9097aeb7
PA
1635 (category (widget-get parent :custom-category))
1636 (text (or (and (eq category 'group)
25ac13b5
PA
1637 (nth 4 entry))
1638 (nth 3 entry)))
f985c5f7 1639 (form (widget-get parent :custom-form))
d543e20b 1640 children)
9097aeb7 1641 (while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text)
d3d4df42 1642 (setq text (concat (match-string 1 text)
9097aeb7
PA
1643 (symbol-name category)
1644 (match-string 2 text))))
3acab5ef 1645 (when (and custom-magic-show
9097aeb7
PA
1646 (or (not hidden)
1647 (memq category custom-magic-show-hidden)))
25ac13b5 1648 (insert " ")
26c7b3ef
RS
1649 (when (and (eq category 'group)
1650 (not (and (eq custom-buffer-style 'links)
1651 (> (widget-get parent :custom-level) 1))))
944c91b6
PA
1652 (insert-char ?\ (* custom-buffer-indent
1653 (widget-get parent :custom-level))))
d3d4df42
DL
1654 (push (widget-create-child-and-convert
1655 widget 'choice-item
d5c42d02 1656 :help-echo "Change the state of this item."
3acab5ef 1657 :format (if hidden "%t" "%[%t%]")
25ac13b5
PA
1658 :button-prefix 'widget-push-button-prefix
1659 :button-suffix 'widget-push-button-suffix
86bd10bc
PA
1660 :mouse-down-action 'widget-magic-mouse-down-action
1661 :tag "State")
d543e20b
PA
1662 children)
1663 (insert ": ")
b62c92bb
RS
1664 (let ((start (point)))
1665 (if (eq custom-magic-show 'long)
1666 (insert text)
1667 (insert (symbol-name state)))
f985c5f7
PA
1668 (cond ((eq form 'lisp)
1669 (insert " (lisp)"))
1670 ((eq form 'mismatch)
1671 (insert " (mismatch)")))
b62c92bb 1672 (put-text-property start (point) 'face 'custom-state-face))
d543e20b 1673 (insert "\n"))
26c7b3ef
RS
1674 (when (and (eq category 'group)
1675 (not (and (eq custom-buffer-style 'links)
1676 (> (widget-get parent :custom-level) 1))))
944c91b6
PA
1677 (insert-char ?\ (* custom-buffer-indent
1678 (widget-get parent :custom-level))))
d543e20b
PA
1679 (when custom-magic-show-button
1680 (when custom-magic-show
1681 (let ((indent (widget-get parent :indent)))
1682 (when indent
1683 (insert-char ? indent))))
d3d4df42
DL
1684 (push (widget-create-child-and-convert
1685 widget 'choice-item
86bd10bc
PA
1686 :mouse-down-action 'widget-magic-mouse-down-action
1687 :button-face face
3acab5ef
PA
1688 :button-prefix ""
1689 :button-suffix ""
86bd10bc 1690 :help-echo "Change the state."
3acab5ef 1691 :format (if hidden "%t" "%[%t%]")
f985c5f7 1692 :tag (if (memq form '(lisp mismatch))
86bd10bc
PA
1693 (concat "(" magic ")")
1694 (concat "[" magic "]")))
d543e20b
PA
1695 children)
1696 (insert " "))
1697 (widget-put widget :children children)))
1698
1699(defun custom-magic-reset (widget)
1700 "Redraw the :custom-magic property of WIDGET."
1701 (let ((magic (widget-get widget :custom-magic)))
1702 (widget-value-set magic (widget-value magic))))
1703
d543e20b
PA
1704;;; The `custom' Widget.
1705
d3d4df42 1706(defface custom-button-face
3060662f 1707 '((((type x w32 mac) (class color)) ; Like default modeline
1a578e9b
AC
1708 (:box (:line-width 2 :style released-button)
1709 :background "lightgrey" :foreground "black"))
d3d4df42
DL
1710 (t
1711 nil))
b62c92bb 1712 "Face used for buttons in customization buffers."
d3d4df42
DL
1713 :version "21.1"
1714 :group 'custom-faces)
1715
1716(defface custom-button-pressed-face
3060662f 1717 '((((type x w32 mac) (class color))
1a578e9b
AC
1718 (:box (:line-width 2 :style pressed-button)
1719 :background "lightgrey" :foreground "black"))
d3d4df42
DL
1720 (t
1721 (:inverse-video t)))
1722 "Face used for buttons in customization buffers."
1723 :version "21.1"
b62c92bb
RS
1724 :group 'custom-faces)
1725
1726(defface custom-documentation-face nil
1727 "Face used for documentation strings in customization buffers."
1728 :group 'custom-faces)
1729
1730(defface custom-state-face '((((class color)
1731 (background dark))
1732 (:foreground "lime green"))
1733 (((class color)
1734 (background light))
1735 (:foreground "dark green"))
1736 (t nil))
1737 "Face used for State descriptions in the customize buffer."
1738 :group 'custom-faces)
1739
d543e20b
PA
1740(define-widget 'custom 'default
1741 "Customize a user option."
944c91b6 1742 :format "%v"
d543e20b 1743 :convert-widget 'custom-convert-widget
d543e20b 1744 :notify 'custom-notify
944c91b6 1745 :custom-prefix ""
d543e20b
PA
1746 :custom-level 1
1747 :custom-state 'hidden
1748 :documentation-property 'widget-subclass-responsibility
1749 :value-create 'widget-subclass-responsibility
1750 :value-delete 'widget-children-value-delete
86bd10bc
PA
1751 :value-get 'widget-value-value-get
1752 :validate 'widget-children-validate
d543e20b
PA
1753 :match (lambda (widget value) (symbolp value)))
1754
1755(defun custom-convert-widget (widget)
2365594b 1756 "Initialize :value and :tag from :args in WIDGET."
d543e20b 1757 (let ((args (widget-get widget :args)))
d3d4df42 1758 (when args
d543e20b
PA
1759 (widget-put widget :value (widget-apply widget
1760 :value-to-internal (car args)))
1761 (widget-put widget :tag (custom-unlispify-tag-name (car args)))
1762 (widget-put widget :args nil)))
1763 widget)
1764
d543e20b
PA
1765(defun custom-notify (widget &rest args)
1766 "Keep track of changes."
0a3a0b56
PA
1767 (let ((state (widget-get widget :custom-state)))
1768 (unless (eq state 'modified)
1769 (unless (memq state '(nil unknown hidden))
1770 (widget-put widget :custom-state 'modified))
1771 (custom-magic-reset widget)
1772 (apply 'widget-default-notify widget args))))
d543e20b
PA
1773
1774(defun custom-redraw (widget)
1775 "Redraw WIDGET with current settings."
6d528fc5
PA
1776 (let ((line (count-lines (point-min) (point)))
1777 (column (current-column))
1778 (pos (point))
d543e20b
PA
1779 (from (marker-position (widget-get widget :from)))
1780 (to (marker-position (widget-get widget :to))))
1781 (save-excursion
1782 (widget-value-set widget (widget-value widget))
1783 (custom-redraw-magic widget))
1784 (when (and (>= pos from) (<= pos to))
6d528fc5 1785 (condition-case nil
d3d4df42 1786 (progn
86bd10bc
PA
1787 (if (> column 0)
1788 (goto-line line)
1789 (goto-line (1+ line)))
6d528fc5
PA
1790 (move-to-column column))
1791 (error nil)))))
d543e20b
PA
1792
1793(defun custom-redraw-magic (widget)
1794 "Redraw WIDGET state with current settings."
d3d4df42 1795 (while widget
d543e20b 1796 (let ((magic (widget-get widget :custom-magic)))
d3d4df42 1797 (cond (magic
944c91b6
PA
1798 (widget-value-set magic (widget-value magic))
1799 (when (setq widget (widget-get widget :group))
1800 (custom-group-state-update widget)))
1801 (t
1802 (setq widget nil)))))
d543e20b
PA
1803 (widget-setup))
1804
1805(defun custom-show (widget value)
1806 "Non-nil if WIDGET should be shown with VALUE by default."
1807 (let ((show (widget-get widget :custom-show)))
1808 (cond ((null show)
1809 nil)
1810 ((eq t show)
1811 t)
1812 (t
1813 (funcall show widget value)))))
1814
bd042c03
PA
1815(defvar custom-load-recursion nil
1816 "Hack to avoid recursive dependencies.")
1817
d543e20b
PA
1818(defun custom-load-symbol (symbol)
1819 "Load all dependencies for SYMBOL."
bd042c03 1820 (unless custom-load-recursion
d3d4df42 1821 (let ((custom-load-recursion t)
bd042c03
PA
1822 (loads (get symbol 'custom-loads))
1823 load)
1824 (while loads
1825 (setq load (car loads)
1826 loads (cdr loads))
1827 (cond ((symbolp load)
1828 (condition-case nil
1829 (require load)
1830 (error nil)))
85b78d5b 1831 ;; Don't reload a file already loaded.
f985c5f7
PA
1832 ((and (boundp 'preloaded-file-list)
1833 (member load preloaded-file-list)))
38d58078 1834 ((assoc load load-history))
85b78d5b 1835 ((assoc (locate-library load) load-history))
bd042c03
PA
1836 (t
1837 (condition-case nil
85b78d5b
RS
1838 ;; Without this, we would load cus-edit recursively.
1839 ;; We are still loading it when we call this,
1840 ;; and it is not in load-history yet.
1841 (or (equal load "cus-edit")
1842 (load-library load))
bd042c03 1843 (error nil))))))))
d543e20b
PA
1844
1845(defun custom-load-widget (widget)
1846 "Load all dependencies for WIDGET."
1847 (custom-load-symbol (widget-value widget)))
1848
c953515e
PA
1849(defun custom-unloaded-symbol-p (symbol)
1850 "Return non-nil if the dependencies of SYMBOL has not yet been loaded."
1851 (let ((found nil)
1852 (loads (get symbol 'custom-loads))
1853 load)
1854 (while loads
1855 (setq load (car loads)
1856 loads (cdr loads))
1857 (cond ((symbolp load)
1858 (unless (featurep load)
1859 (setq found t)))
1860 ((assoc load load-history))
1861 ((assoc (locate-library load) load-history)
1862 (message nil))
1863 (t
1864 (setq found t))))
1865 found))
1866
1867(defun custom-unloaded-widget-p (widget)
1868 "Return non-nil if the dependencies of WIDGET has not yet been loaded."
1869 (custom-unloaded-symbol-p (widget-value widget)))
1870
6d528fc5
PA
1871(defun custom-toggle-hide (widget)
1872 "Toggle visibility of WIDGET."
c953515e 1873 (custom-load-widget widget)
6d528fc5
PA
1874 (let ((state (widget-get widget :custom-state)))
1875 (cond ((memq state '(invalid modified))
1876 (error "There are unset changes"))
1877 ((eq state 'hidden)
1878 (widget-put widget :custom-state 'unknown))
d3d4df42 1879 (t
3acab5ef 1880 (widget-put widget :documentation-shown nil)
6d528fc5 1881 (widget-put widget :custom-state 'hidden)))
8697863a
PA
1882 (custom-redraw widget)
1883 (widget-setup)))
6d528fc5 1884
3acab5ef 1885(defun custom-toggle-parent (widget &rest ignore)
b62c92bb 1886 "Toggle visibility of parent of WIDGET."
3acab5ef
PA
1887 (custom-toggle-hide (widget-get widget :parent)))
1888
944c91b6
PA
1889(defun custom-add-see-also (widget &optional prefix)
1890 "Add `See also ...' to WIDGET if there are any links.
1891Insert PREFIX first if non-nil."
1892 (let* ((symbol (widget-get widget :value))
1893 (links (get symbol 'custom-links))
1894 (many (> (length links) 2))
1895 (buttons (widget-get widget :buttons))
1896 (indent (widget-get widget :indent)))
1897 (when links
1898 (when indent
1899 (insert-char ?\ indent))
1900 (when prefix
1901 (insert prefix))
1902 (insert "See also ")
1903 (while links
1904 (push (widget-create-child-and-convert widget (car links))
1905 buttons)
1906 (setq links (cdr links))
1907 (cond ((null links)
1908 (insert ".\n"))
1909 ((null (cdr links))
1910 (if many
1911 (insert ", and ")
1912 (insert " and ")))
d3d4df42 1913 (t
944c91b6
PA
1914 (insert ", "))))
1915 (widget-put widget :buttons buttons))))
1916
cd6c0940
RS
1917(defun custom-add-parent-links (widget &optional initial-string)
1918 "Add \"Parent groups: ...\" to WIDGET if the group has parents.
1919The value if non-nil if any parents were found.
1920If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
944c91b6
PA
1921 (let ((name (widget-value widget))
1922 (type (widget-type widget))
1923 (buttons (widget-get widget :buttons))
d377bee9 1924 (start (point))
944c91b6 1925 found)
cd6c0940 1926 (insert (or initial-string "Parent groups:"))
944c91b6 1927 (mapatoms (lambda (symbol)
da5ec617
PA
1928 (let ((entry (assq name (get symbol 'custom-group))))
1929 (when (eq (nth 1 entry) type)
1930 (insert " ")
d3d4df42
DL
1931 (push (widget-create-child-and-convert
1932 widget 'custom-group-link
da5ec617
PA
1933 :tag (custom-unlispify-tag-name symbol)
1934 symbol)
1935 buttons)
1936 (setq found t)))))
944c91b6 1937 (widget-put widget :buttons buttons)
d377bee9
RS
1938 (if found
1939 (insert "\n")
1940 (delete-region start (point)))
1941 found))
944c91b6 1942
d3d4df42
DL
1943;;; The `custom-comment' Widget.
1944
1945;; like the editable field
1946(defface custom-comment-face '((((class grayscale color)
1947 (background light))
1948 (:background "gray85"))
1949 (((class grayscale color)
1950 (background dark))
1951 (:background "dim gray"))
1952 (t
1953 (:italic t)))
1954 "Face used for comments on variables or faces"
1955 :version "21.1"
1956 :group 'custom-faces)
1957
1958;; like font-lock-comment-face
1959(defface custom-comment-tag-face
1960 '((((class color) (background dark)) (:foreground "gray80"))
1961 (((class color) (background light)) (:foreground "blue4"))
1962 (((class grayscale) (background light))
1963 (:foreground "DimGray" :bold t :italic t))
1964 (((class grayscale) (background dark))
1965 (:foreground "LightGray" :bold t :italic t))
1966 (t (:bold t)))
1967 "Face used for variables or faces comment tags"
1968 :group 'custom-faces)
1969
1970(define-widget 'custom-comment 'string
164cfaeb 1971 "User comment."
d3d4df42 1972 :tag "Comment"
164cfaeb 1973 :help-echo "Edit a comment here."
d3d4df42
DL
1974 :sample-face 'custom-comment-tag-face
1975 :value-face 'custom-comment-face
164cfaeb
DL
1976 :shown nil
1977 :create 'custom-comment-create)
d3d4df42
DL
1978
1979(defun custom-comment-create (widget)
164cfaeb 1980 (let* ((null-comment (equal "" (widget-value widget))))
6171a945
DL
1981 (if (or (widget-get (widget-get widget :parent) :comment-shown)
1982 (not null-comment))
1983 (widget-default-create widget)
1984 ;; `widget-default-delete' expects markers in these slots --
1985 ;; maybe it shouldn't.
1986 (widget-put widget :from (point-marker))
1987 (widget-put widget :to (point-marker)))))
164cfaeb
DL
1988
1989(defun custom-comment-hide (widget)
1990 (widget-put (widget-get widget :parent) :comment-shown nil))
d3d4df42
DL
1991
1992;; Those functions are for the menu. WIDGET is NOT the comment widget. It's
1993;; the global custom one
1994(defun custom-comment-show (widget)
164cfaeb
DL
1995 (widget-put widget :comment-shown t)
1996 (custom-redraw widget)
1997 (widget-setup))
d3d4df42
DL
1998
1999(defun custom-comment-invisible-p (widget)
164cfaeb
DL
2000 (let ((val (widget-value (widget-get widget :comment-widget))))
2001 (and (equal "" val)
2002 (not (widget-get widget :comment-shown)))))
d3d4df42 2003
d543e20b
PA
2004;;; The `custom-variable' Widget.
2005
2365594b
DL
2006;; When this was underlined blue, users confused it with a
2007;; Mosaic-style hyperlink...
16b20ed9
GM
2008(defface custom-variable-tag-face
2009 `((((class color)
2010 (background dark))
61fb10d0 2011 (:foreground "light blue" :bold t :height 1.2 :inherit variable-pitch))
16b20ed9
GM
2012 (((class color)
2013 (background light))
61fb10d0 2014 (:foreground "blue" :bold t :height 1.2 :inherit variable-pitch))
16b20ed9 2015 (t (:bold t)))
d543e20b 2016 "Face used for unpushable variable tags."
bd042c03 2017 :group 'custom-faces)
d543e20b
PA
2018
2019(defface custom-variable-button-face '((t (:underline t :bold t)))
2020 "Face used for pushable variable tags."
bd042c03 2021 :group 'custom-faces)
d543e20b 2022
d64478da
KH
2023(defcustom custom-variable-default-form 'edit
2024 "Default form of displaying variable values."
2025 :type '(choice (const edit)
2026 (const lisp))
cd32a7ba
DN
2027 :group 'custom-buffer
2028 :version "20.3")
d64478da 2029
d543e20b
PA
2030(define-widget 'custom-variable 'custom
2031 "Customize variable."
944c91b6 2032 :format "%v"
d543e20b
PA
2033 :help-echo "Set or reset this variable."
2034 :documentation-property 'variable-documentation
9097aeb7 2035 :custom-category 'option
d543e20b
PA
2036 :custom-state nil
2037 :custom-menu 'custom-variable-menu-create
d64478da 2038 :custom-form nil ; defaults to value of `custom-variable-default-form'
d543e20b
PA
2039 :value-create 'custom-variable-value-create
2040 :action 'custom-variable-action
2041 :custom-set 'custom-variable-set
2042 :custom-save 'custom-variable-save
2043 :custom-reset-current 'custom-redraw
2044 :custom-reset-saved 'custom-variable-reset-saved
25ac13b5 2045 :custom-reset-standard 'custom-variable-reset-standard)
d543e20b 2046
bd042c03
PA
2047(defun custom-variable-type (symbol)
2048 "Return a widget suitable for editing the value of SYMBOL.
d3d4df42 2049If SYMBOL has a `custom-type' property, use that.
bd042c03
PA
2050Otherwise, look up symbol in `custom-guess-type-alist'."
2051 (let* ((type (or (get symbol 'custom-type)
25ac13b5 2052 (and (not (get symbol 'standard-value))
bd042c03
PA
2053 (custom-guess-type symbol))
2054 'sexp))
2055 (options (get symbol 'custom-options))
2056 (tmp (if (listp type)
46fa5a83 2057 (copy-sequence type)
bd042c03
PA
2058 (list type))))
2059 (when options
2060 (widget-put tmp :options options))
2061 tmp))
2062
d543e20b 2063(defun custom-variable-value-create (widget)
164cfaeb 2064 "Here is where you edit the variable's value."
d543e20b 2065 (custom-load-widget widget)
d64478da
KH
2066 (unless (widget-get widget :custom-form)
2067 (widget-put widget :custom-form custom-variable-default-form))
d543e20b
PA
2068 (let* ((buttons (widget-get widget :buttons))
2069 (children (widget-get widget :children))
2070 (form (widget-get widget :custom-form))
2071 (state (widget-get widget :custom-state))
2072 (symbol (widget-get widget :value))
d543e20b 2073 (tag (widget-get widget :tag))
bd042c03 2074 (type (custom-variable-type symbol))
d543e20b 2075 (conv (widget-convert type))
6d528fc5 2076 (get (or (get symbol 'custom-get) 'default-value))
944c91b6
PA
2077 (prefix (widget-get widget :custom-prefix))
2078 (last (widget-get widget :custom-last))
d543e20b 2079 (value (if (default-boundp symbol)
6d528fc5 2080 (funcall get symbol)
d543e20b 2081 (widget-get conv :value))))
164cfaeb 2082 ;; If the widget is new, the child determines whether it is hidden.
d543e20b
PA
2083 (cond (state)
2084 ((custom-show type value)
2085 (setq state 'unknown))
2086 (t
2087 (setq state 'hidden)))
2088 ;; If we don't know the state, see if we need to edit it in lisp form.
2089 (when (eq state 'unknown)
2090 (unless (widget-apply conv :match value)
2091 ;; (widget-apply (widget-convert type) :match value)
f985c5f7 2092 (setq form 'mismatch)))
d543e20b 2093 ;; Now we can create the child widget.
944c91b6 2094 (cond ((eq custom-buffer-style 'tree)
da5ec617 2095 (insert prefix (if last " `--- " " |--- "))
944c91b6 2096 (push (widget-create-child-and-convert
c953515e 2097 widget 'custom-browse-variable-tag)
944c91b6
PA
2098 buttons)
2099 (insert " " tag "\n")
2100 (widget-put widget :buttons buttons))
2101 ((eq state 'hidden)
d543e20b 2102 ;; Indicate hidden value.
d3d4df42 2103 (push (widget-create-child-and-convert
d543e20b 2104 widget 'item
3acab5ef 2105 :format "%{%t%}: "
b62c92bb 2106 :sample-face 'custom-variable-tag-face
d543e20b
PA
2107 :tag tag
2108 :parent widget)
3acab5ef 2109 buttons)
d3d4df42 2110 (push (widget-create-child-and-convert
3acab5ef 2111 widget 'visibility
8697863a 2112 :help-echo "Show the value of this option."
3acab5ef
PA
2113 :action 'custom-toggle-parent
2114 nil)
2115 buttons))
f985c5f7 2116 ((memq form '(lisp mismatch))
d543e20b
PA
2117 ;; In lisp mode edit the saved value when possible.
2118 (let* ((value (cond ((get symbol 'saved-value)
2119 (car (get symbol 'saved-value)))
25ac13b5
PA
2120 ((get symbol 'standard-value)
2121 (car (get symbol 'standard-value)))
d543e20b 2122 ((default-boundp symbol)
6d528fc5 2123 (custom-quote (funcall get symbol)))
d543e20b
PA
2124 (t
2125 (custom-quote (widget-get conv :value))))))
3acab5ef 2126 (insert (symbol-name symbol) ": ")
d3d4df42 2127 (push (widget-create-child-and-convert
944c91b6
PA
2128 widget 'visibility
2129 :help-echo "Hide the value of this option."
2130 :action 'custom-toggle-parent
2131 t)
2132 buttons)
3acab5ef 2133 (insert " ")
d3d4df42
DL
2134 (push (widget-create-child-and-convert
2135 widget 'sexp
d543e20b 2136 :button-face 'custom-variable-button-face
3acab5ef 2137 :format "%v"
d543e20b
PA
2138 :tag (symbol-name symbol)
2139 :parent widget
2140 :value value)
2141 children)))
2142 (t
2143 ;; Edit mode.
3acab5ef
PA
2144 (let* ((format (widget-get type :format))
2145 tag-format value-format)
2146 (unless (string-match ":" format)
896a6a5d 2147 (error "Bad format"))
3acab5ef
PA
2148 (setq tag-format (substring format 0 (match-end 0)))
2149 (setq value-format (substring format (match-end 0)))
2150 (push (widget-create-child-and-convert
d3d4df42 2151 widget 'item
3acab5ef
PA
2152 :format tag-format
2153 :action 'custom-tag-action
8697863a 2154 :help-echo "Change value of this option."
3acab5ef
PA
2155 :mouse-down-action 'custom-tag-mouse-down-action
2156 :button-face 'custom-variable-button-face
b62c92bb 2157 :sample-face 'custom-variable-tag-face
3acab5ef
PA
2158 tag)
2159 buttons)
2160 (insert " ")
d3d4df42 2161 (push (widget-create-child-and-convert
164cfaeb
DL
2162 widget 'visibility
2163 :help-echo "Hide the value of this option."
2164 :action 'custom-toggle-parent
2165 t)
2166 buttons)
3acab5ef 2167 (push (widget-create-child-and-convert
d3d4df42 2168 widget type
3acab5ef
PA
2169 :format value-format
2170 :value value)
2171 children))))
944c91b6 2172 (unless (eq custom-buffer-style 'tree)
944c91b6
PA
2173 (unless (eq (preceding-char) ?\n)
2174 (widget-insert "\n"))
944c91b6
PA
2175 ;; Create the magic button.
2176 (let ((magic (widget-create-child-and-convert
2177 widget 'custom-magic nil)))
2178 (widget-put widget :custom-magic magic)
2179 (push magic buttons))
164cfaeb 2180 ;; ### NOTE: this is ugly!!!! I need to update the :buttons property
d3d4df42
DL
2181 ;; before the call to `widget-default-format-handler'. Otherwise, I
2182 ;; loose my current `buttons'. This function shouldn't be called like
2183 ;; this anyway. The doc string widget should be added like the others.
2184 ;; --dv
944c91b6 2185 (widget-put widget :buttons buttons)
944c91b6
PA
2186 ;; Insert documentation.
2187 (widget-default-format-handler widget ?h)
d3d4df42
DL
2188
2189 ;; The comment field
2190 (unless (eq state 'hidden)
2191 (let* ((comment (get symbol 'variable-comment))
2192 (comment-widget
2193 (widget-create-child-and-convert
2194 widget 'custom-comment
2195 :parent widget
2196 :value (or comment ""))))
2197 (widget-put widget :comment-widget comment-widget)
2198 ;; Don't push it !!! Custom assumes that the first child is the
2199 ;; value one.
2200 (setq children (append children (list comment-widget)))))
2201 ;; Update the rest of the properties properties.
2202 (widget-put widget :custom-form form)
2203 (widget-put widget :children children)
2204 ;; Now update the state.
2205 (if (eq state 'hidden)
2206 (widget-put widget :custom-state state)
2207 (custom-variable-state-set widget))
944c91b6
PA
2208 ;; See also.
2209 (unless (eq state 'hidden)
2210 (when (eq (widget-get widget :custom-level) 1)
2211 (custom-add-parent-links widget))
2212 (custom-add-see-also widget)))))
d543e20b 2213
3acab5ef
PA
2214(defun custom-tag-action (widget &rest args)
2215 "Pass :action to first child of WIDGET's parent."
2216 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2217 :action args))
2218
2219(defun custom-tag-mouse-down-action (widget &rest args)
2220 "Pass :mouse-down-action to first child of WIDGET's parent."
2221 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2222 :mouse-down-action args))
2223
d543e20b
PA
2224(defun custom-variable-state-set (widget)
2225 "Set the state of WIDGET."
2226 (let* ((symbol (widget-value widget))
6d528fc5 2227 (get (or (get symbol 'custom-get) 'default-value))
d543e20b 2228 (value (if (default-boundp symbol)
6d528fc5 2229 (funcall get symbol)
d543e20b 2230 (widget-get widget :value)))
d3d4df42 2231 (comment (get symbol 'variable-comment))
d543e20b 2232 tmp
d3d4df42
DL
2233 temp
2234 (state (cond ((progn (setq tmp (get symbol 'customized-value))
2235 (setq temp
2236 (get symbol 'customized-variable-comment))
2237 (or tmp temp))
d543e20b 2238 (if (condition-case nil
d3d4df42
DL
2239 (and (equal value (eval (car tmp)))
2240 (equal comment temp))
d543e20b
PA
2241 (error nil))
2242 'set
2243 'changed))
d3d4df42
DL
2244 ((progn (setq tmp (get symbol 'saved-value))
2245 (setq temp (get symbol 'saved-variable-comment))
2246 (or tmp temp))
d543e20b 2247 (if (condition-case nil
d3d4df42
DL
2248 (and (equal value (eval (car tmp)))
2249 (equal comment temp))
d543e20b
PA
2250 (error nil))
2251 'saved
2252 'changed))
25ac13b5 2253 ((setq tmp (get symbol 'standard-value))
d543e20b 2254 (if (condition-case nil
d3d4df42
DL
2255 (and (equal value (eval (car tmp)))
2256 (equal comment nil))
d543e20b 2257 (error nil))
25ac13b5 2258 'standard
d543e20b
PA
2259 'changed))
2260 (t 'rogue))))
2261 (widget-put widget :custom-state state)))
2262
d3d4df42 2263(defvar custom-variable-menu
0f3335c0 2264 '(("Set for Current Session" custom-variable-set
6d528fc5
PA
2265 (lambda (widget)
2266 (eq (widget-get widget :custom-state) 'modified)))
0f3335c0 2267 ("Save for Future Sessions" custom-variable-save
6d528fc5
PA
2268 (lambda (widget)
2269 (memq (widget-get widget :custom-state) '(modified set changed rogue))))
2270 ("Reset to Current" custom-redraw
2271 (lambda (widget)
2272 (and (default-boundp (widget-value widget))
86bd10bc 2273 (memq (widget-get widget :custom-state) '(modified changed)))))
6d528fc5
PA
2274 ("Reset to Saved" custom-variable-reset-saved
2275 (lambda (widget)
d3d4df42
DL
2276 (and (or (get (widget-value widget) 'saved-value)
2277 (get (widget-value widget) 'saved-variable-comment))
6d528fc5
PA
2278 (memq (widget-get widget :custom-state)
2279 '(modified set changed rogue)))))
19d63704 2280 ("Erase Customization" custom-variable-reset-standard
6d528fc5 2281 (lambda (widget)
25ac13b5 2282 (and (get (widget-value widget) 'standard-value)
6d528fc5 2283 (memq (widget-get widget :custom-state)
8697863a
PA
2284 '(modified set changed saved rogue)))))
2285 ("---" ignore ignore)
d3d4df42
DL
2286 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2287 ("---" ignore ignore)
2288 ("Don't show as Lisp expression" custom-variable-edit
8697863a 2289 (lambda (widget)
f985c5f7 2290 (eq (widget-get widget :custom-form) 'lisp)))
0db1ff23 2291 ("Show initial Lisp expression" custom-variable-edit-lisp
8697863a 2292 (lambda (widget)
f985c5f7 2293 (eq (widget-get widget :custom-form) 'edit))))
d543e20b 2294 "Alist of actions for the `custom-variable' widget.
6d528fc5
PA
2295Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2296the menu entry, ACTION is the function to call on the widget when the
2297menu is selected, and FILTER is a predicate which takes a `custom-variable'
2298widget as an argument, and returns non-nil if ACTION is valid on that
19d63704 2299widget. If FILTER is nil, ACTION is always valid.")
d543e20b
PA
2300
2301(defun custom-variable-action (widget &optional event)
2302 "Show the menu for `custom-variable' WIDGET.
2303Optional EVENT is the location for the menu."
2304 (if (eq (widget-get widget :custom-state) 'hidden)
6d528fc5 2305 (custom-toggle-hide widget)
86bd10bc
PA
2306 (unless (eq (widget-get widget :custom-state) 'modified)
2307 (custom-variable-state-set widget))
2308 (custom-redraw-magic widget)
d543e20b 2309 (let* ((completion-ignore-case t)
25ac13b5
PA
2310 (answer (widget-choose (concat "Operation on "
2311 (custom-unlispify-tag-name
2312 (widget-get widget :value)))
6d528fc5
PA
2313 (custom-menu-filter custom-variable-menu
2314 widget)
d543e20b
PA
2315 event)))
2316 (if answer
2317 (funcall answer widget)))))
2318
2319(defun custom-variable-edit (widget)
2320 "Edit value of WIDGET."
2321 (widget-put widget :custom-state 'unknown)
2322 (widget-put widget :custom-form 'edit)
2323 (custom-redraw widget))
2324
2325(defun custom-variable-edit-lisp (widget)
2365594b 2326 "Edit the Lisp representation of the value of WIDGET."
d543e20b
PA
2327 (widget-put widget :custom-state 'unknown)
2328 (widget-put widget :custom-form 'lisp)
2329 (custom-redraw widget))
2330
2331(defun custom-variable-set (widget)
2332 "Set the current value for the variable being edited by WIDGET."
6d528fc5
PA
2333 (let* ((form (widget-get widget :custom-form))
2334 (state (widget-get widget :custom-state))
2335 (child (car (widget-get widget :children)))
2336 (symbol (widget-value widget))
2337 (set (or (get symbol 'custom-set) 'set-default))
d3d4df42
DL
2338 (comment-widget (widget-get widget :comment-widget))
2339 (comment (widget-value comment-widget))
2340 val)
d543e20b 2341 (cond ((eq state 'hidden)
896a6a5d 2342 (error "Cannot set hidden variable"))
d543e20b
PA
2343 ((setq val (widget-apply child :validate))
2344 (goto-char (widget-get val :from))
2345 (error "%s" (widget-get val :error)))
f985c5f7 2346 ((memq form '(lisp mismatch))
d3d4df42
DL
2347 (when (equal comment "")
2348 (setq comment nil)
2349 ;; Make the comment invisible by hand if it's empty
164cfaeb 2350 (custom-comment-hide comment-widget))
6d528fc5 2351 (funcall set symbol (eval (setq val (widget-value child))))
d3d4df42
DL
2352 (put symbol 'customized-value (list val))
2353 (put symbol 'variable-comment comment)
2354 (put symbol 'customized-variable-comment comment))
d543e20b 2355 (t
d3d4df42
DL
2356 (when (equal comment "")
2357 (setq comment nil)
2358 ;; Make the comment invisible by hand if it's empty
164cfaeb 2359 (custom-comment-hide comment-widget))
6d528fc5 2360 (funcall set symbol (setq val (widget-value child)))
d3d4df42
DL
2361 (put symbol 'customized-value (list (custom-quote val)))
2362 (put symbol 'variable-comment comment)
2363 (put symbol 'customized-variable-comment comment)))
d543e20b
PA
2364 (custom-variable-state-set widget)
2365 (custom-redraw-magic widget)))
2366
2367(defun custom-variable-save (widget)
0db1ff23 2368 "Set and save the value for the variable being edited by WIDGET."
6d528fc5
PA
2369 (let* ((form (widget-get widget :custom-form))
2370 (state (widget-get widget :custom-state))
2371 (child (car (widget-get widget :children)))
2372 (symbol (widget-value widget))
2373 (set (or (get symbol 'custom-set) 'set-default))
d3d4df42
DL
2374 (comment-widget (widget-get widget :comment-widget))
2375 (comment (widget-value comment-widget))
6d528fc5 2376 val)
d543e20b 2377 (cond ((eq state 'hidden)
896a6a5d 2378 (error "Cannot set hidden variable"))
d543e20b
PA
2379 ((setq val (widget-apply child :validate))
2380 (goto-char (widget-get val :from))
6b292312 2381 (error "Saving %s: %s" symbol (widget-get val :error)))
f985c5f7 2382 ((memq form '(lisp mismatch))
d3d4df42
DL
2383 (when (equal comment "")
2384 (setq comment nil)
2385 ;; Make the comment invisible by hand if it's empty
164cfaeb 2386 (custom-comment-hide comment-widget))
d543e20b 2387 (put symbol 'saved-value (list (widget-value child)))
d3d4df42
DL
2388 (funcall set symbol (eval (widget-value child)))
2389 (put symbol 'variable-comment comment)
2390 (put symbol 'saved-variable-comment comment))
d543e20b 2391 (t
d3d4df42
DL
2392 (when (equal comment "")
2393 (setq comment nil)
2394 ;; Make the comment invisible by hand if it's empty
164cfaeb 2395 (custom-comment-hide comment-widget))
d3d4df42
DL
2396 (put symbol 'saved-value
2397 (list (custom-quote (widget-value child))))
2398 (funcall set symbol (widget-value child))
2399 (put symbol 'variable-comment comment)
2400 (put symbol 'saved-variable-comment comment)))
d543e20b 2401 (put symbol 'customized-value nil)
d3d4df42 2402 (put symbol 'customized-variable-comment nil)
d543e20b
PA
2403 (custom-save-all)
2404 (custom-variable-state-set widget)
2405 (custom-redraw-magic widget)))
2406
2407(defun custom-variable-reset-saved (widget)
2408 "Restore the saved value for the variable being edited by WIDGET."
6d528fc5 2409 (let* ((symbol (widget-value widget))
d3d4df42 2410 (set (or (get symbol 'custom-set) 'set-default))
d3d4df42
DL
2411 (value (get symbol 'saved-value))
2412 (comment (get symbol 'saved-variable-comment)))
2413 (cond ((or value comment)
2414 (put symbol 'variable-comment comment)
2415 (condition-case nil
2416 (funcall set symbol (eval (car value)))
2417 (error nil)))
2418 (t
2419 (error "No saved value for %s" symbol)))
d543e20b 2420 (put symbol 'customized-value nil)
d3d4df42 2421 (put symbol 'customized-variable-comment nil)
d543e20b 2422 (widget-put widget :custom-state 'unknown)
d3d4df42 2423 ;; This call will possibly make the comment invisible
d543e20b
PA
2424 (custom-redraw widget)))
2425
25ac13b5 2426(defun custom-variable-reset-standard (widget)
19d63704
RS
2427 "Restore the standard setting for the variable being edited by WIDGET.
2428This operation eliminates any saved setting for the variable,
2429restoring it to the state of a variable that has never been customized."
6d528fc5 2430 (let* ((symbol (widget-value widget))
ba8cb52d 2431 (set (or (get symbol 'custom-set) 'set-default)))
25ac13b5
PA
2432 (if (get symbol 'standard-value)
2433 (funcall set symbol (eval (car (get symbol 'standard-value))))
5dd0cad0 2434 (error "No standard setting known for %S" symbol))
164cfaeb 2435 (put symbol 'variable-comment nil)
d543e20b 2436 (put symbol 'customized-value nil)
d3d4df42
DL
2437 (put symbol 'customized-variable-comment nil)
2438 (when (or (get symbol 'saved-value) (get symbol 'saved-variable-comment))
d543e20b 2439 (put symbol 'saved-value nil)
d3d4df42 2440 (put symbol 'saved-variable-comment nil)
d543e20b
PA
2441 (custom-save-all))
2442 (widget-put widget :custom-state 'unknown)
d3d4df42 2443 ;; This call will possibly make the comment invisible
d543e20b
PA
2444 (custom-redraw widget)))
2445
2446;;; The `custom-face-edit' Widget.
2447
2448(define-widget 'custom-face-edit 'checklist
2449 "Edit face attributes."
2450 :format "%t: %v"
2451 :tag "Attributes"
2452 :extra-offset 12
d3d4df42 2453 :button-args '(:help-echo "Control whether this attribute has any effect.")
d543e20b 2454 :args (mapcar (lambda (att)
d3d4df42 2455 (list 'group
d543e20b
PA
2456 :inline t
2457 :sibling-args (widget-get (nth 1 att) :sibling-args)
d3d4df42 2458 (list 'const :format "" :value (nth 0 att))
d543e20b
PA
2459 (nth 1 att)))
2460 custom-face-attributes))
2461
2462;;; The `custom-display' Widget.
2463
2464(define-widget 'custom-display 'menu-choice
2465 "Select a display type."
2466 :tag "Display"
2467 :value t
2468 :help-echo "Specify frames where the face attributes should be used."
2469 :args '((const :tag "all" t)
2470 (checklist
2471 :offset 0
2472 :extra-offset 9
2473 :args ((group :sibling-args (:help-echo "\
2474Only match the specified window systems.")
2475 (const :format "Type: "
2476 type)
2477 (checklist :inline t
2478 :offset 0
2479 (const :format "X "
2480 :sibling-args (:help-echo "\
2481The X11 Window System.")
2482 x)
2483 (const :format "PM "
2484 :sibling-args (:help-echo "\
2485OS/2 Presentation Manager.")
2486 pm)
b97aca27 2487 (const :format "W32 "
d543e20b 2488 :sibling-args (:help-echo "\
b97aca27
GV
2489Windows NT/9X.")
2490 w32)
d543e20b
PA
2491 (const :format "DOS "
2492 :sibling-args (:help-echo "\
2493Plain MS-DOS.")
2494 pc)
2495 (const :format "TTY%n"
2496 :sibling-args (:help-echo "\
2497Plain text terminals.")
2498 tty)))
2499 (group :sibling-args (:help-echo "\
2500Only match the frames with the specified color support.")
2501 (const :format "Class: "
2502 class)
2503 (checklist :inline t
2504 :offset 0
2505 (const :format "Color "
2506 :sibling-args (:help-echo "\
2507Match color frames.")
2508 color)
2509 (const :format "Grayscale "
2510 :sibling-args (:help-echo "\
2511Match grayscale frames.")
2512 grayscale)
2513 (const :format "Monochrome%n"
2514 :sibling-args (:help-echo "\
2515Match frames with no color support.")
2516 mono)))
2517 (group :sibling-args (:help-echo "\
2518Only match frames with the specified intensity.")
2519 (const :format "\
2520Background brightness: "
2521 background)
2522 (checklist :inline t
2523 :offset 0
2524 (const :format "Light "
2525 :sibling-args (:help-echo "\
2526Match frames with light backgrounds.")
2527 light)
2528 (const :format "Dark\n"
2529 :sibling-args (:help-echo "\
2530Match frames with dark backgrounds.")
2531 dark)))))))
2532
2533;;; The `custom-face' Widget.
2534
16b20ed9 2535(defface custom-face-tag-face
61fb10d0 2536 `((t (:bold t :height 1.2 :inherit variable-pitch)))
d543e20b 2537 "Face used for face tags."
bd042c03 2538 :group 'custom-faces)
d543e20b 2539
d64478da
KH
2540(defcustom custom-face-default-form 'selected
2541 "Default form of displaying face definition."
2542 :type '(choice (const all)
2543 (const selected)
2544 (const lisp))
cd32a7ba
DN
2545 :group 'custom-buffer
2546 :version "20.3")
d64478da 2547
d543e20b
PA
2548(define-widget 'custom-face 'custom
2549 "Customize face."
d543e20b
PA
2550 :sample-face 'custom-face-tag-face
2551 :help-echo "Set or reset this face."
23c0fb21 2552 :documentation-property #'face-doc-string
d543e20b
PA
2553 :value-create 'custom-face-value-create
2554 :action 'custom-face-action
9097aeb7 2555 :custom-category 'face
d64478da 2556 :custom-form nil ; defaults to value of `custom-face-default-form'
d543e20b
PA
2557 :custom-set 'custom-face-set
2558 :custom-save 'custom-face-save
2559 :custom-reset-current 'custom-redraw
2560 :custom-reset-saved 'custom-face-reset-saved
25ac13b5 2561 :custom-reset-standard 'custom-face-reset-standard
d543e20b
PA
2562 :custom-menu 'custom-face-menu-create)
2563
d3d4df42 2564(define-widget 'custom-face-all 'editable-list
d543e20b
PA
2565 "An editable list of display specifications and attributes."
2566 :entry-format "%i %d %v"
2567 :insert-button-args '(:help-echo "Insert new display specification here.")
2568 :append-button-args '(:help-echo "Append new display specification here.")
2569 :delete-button-args '(:help-echo "Delete this display specification.")
2570 :args '((group :format "%v" custom-display custom-face-edit)))
2571
2572(defconst custom-face-all (widget-convert 'custom-face-all)
2573 "Converted version of the `custom-face-all' widget.")
2574
2575(define-widget 'custom-display-unselected 'item
2576 "A display specification that doesn't match the selected display."
2577 :match 'custom-display-unselected-match)
2578
2579(defun custom-display-unselected-match (widget value)
2580 "Non-nil if VALUE is an unselected display specification."
86bd10bc 2581 (not (face-spec-set-match-display value (selected-frame))))
d543e20b 2582
d3d4df42 2583(define-widget 'custom-face-selected 'group
d543e20b
PA
2584 "Edit the attributes of the selected display in a face specification."
2585 :args '((repeat :format ""
2586 :inline t
2587 (group custom-display-unselected sexp))
2588 (group (sexp :format "") custom-face-edit)
2589 (repeat :format ""
2590 :inline t
2591 sexp)))
2592
2593(defconst custom-face-selected (widget-convert 'custom-face-selected)
2594 "Converted version of the `custom-face-selected' widget.")
2595
f5b50baa
MB
2596(defun custom-filter-face-spec (spec filter-index default-filter)
2597 "Return a canonicalized version of SPEC using.
2598FILTER-INDEX is the index in the entry for each attribute in
2599`custom-face-attributes' at which the appropriate filter function can be
2600found, and DEFAULT-FILTER is the filter to apply for attributes that
2601don't specify one."
2602 (mapcar (lambda (entry)
2603 ;; Filter a single face-spec entry
2604 (let ((tests (car entry))
2605 (unfiltered-attrs
2606 ;; Handle both old- and new-style attribute syntax
2607 (if (listp (car (cdr entry)))
2608 (car (cdr entry))
2609 (cdr entry)))
2610 (filtered-attrs nil))
2611 ;; Filter each face attribute
2612 (while unfiltered-attrs
2613 (let* ((attr (pop unfiltered-attrs))
2614 (pre-filtered-value (pop unfiltered-attrs))
2615 (filter
2616 (or (nth filter-index (assq attr custom-face-attributes))
2617 default-filter))
2618 (filtered-value
2619 (if filter
2620 (funcall filter pre-filtered-value)
2621 pre-filtered-value)))
2622 (push filtered-value filtered-attrs)
2623 (push attr filtered-attrs)))
2624 ;;
2625 (list tests filtered-attrs)))
2626 spec))
2627
2628(defun custom-pre-filter-face-spec (spec)
2629 "Return SPEC changed as necessary for editing by the face customization widget.
2630SPEC must be a full face spec."
2631 (custom-filter-face-spec
2632 spec 2
2633 (lambda (value)
2634 (cond ((eq value 'unspecified) nil)
2635 ((eq value nil) 'off)
2636 (t value)))))
2637
2638(defun custom-post-filter-face-spec (spec)
2639 "Return the customized SPEC in a form suitable for setting the face."
2640 (custom-filter-face-spec
2641 spec 3
2642 (lambda (value)
2643 (cond ((eq value nil) 'unspecified)
2644 ((eq value 'off) nil)
2645 (t value)))))
2646
d543e20b 2647(defun custom-face-value-create (widget)
944c91b6
PA
2648 "Create a list of the display specifications for WIDGET."
2649 (let ((buttons (widget-get widget :buttons))
d3d4df42 2650 children
944c91b6
PA
2651 (symbol (widget-get widget :value))
2652 (tag (widget-get widget :tag))
2653 (state (widget-get widget :custom-state))
2654 (begin (point))
2655 (is-last (widget-get widget :custom-last))
2656 (prefix (widget-get widget :custom-prefix)))
2657 (unless tag
2658 (setq tag (prin1-to-string symbol)))
2659 (cond ((eq custom-buffer-style 'tree)
da5ec617 2660 (insert prefix (if is-last " `--- " " |--- "))
944c91b6 2661 (push (widget-create-child-and-convert
c953515e 2662 widget 'custom-browse-face-tag)
944c91b6
PA
2663 buttons)
2664 (insert " " tag "\n")
2665 (widget-put widget :buttons buttons))
2666 (t
2667 ;; Create tag.
2668 (insert tag)
c069a9d3 2669 (widget-specify-sample widget begin (point))
944c91b6
PA
2670 (if (eq custom-buffer-style 'face)
2671 (insert " ")
a62ebc52
MB
2672 (if (string-match "face\\'" tag)
2673 (insert ":")
2674 (insert " face: ")))
944c91b6 2675 ;; Sample.
944c91b6
PA
2676 (push (widget-create-child-and-convert widget 'item
2677 :format "(%{%t%})"
2678 :sample-face symbol
2679 :tag "sample")
2680 buttons)
2681 ;; Visibility.
2682 (insert " ")
d3d4df42 2683 (push (widget-create-child-and-convert
944c91b6
PA
2684 widget 'visibility
2685 :help-echo "Hide or show this face."
2686 :action 'custom-toggle-parent
2687 (not (eq state 'hidden)))
2688 buttons)
2689 ;; Magic.
2690 (insert "\n")
2691 (let ((magic (widget-create-child-and-convert
2692 widget 'custom-magic nil)))
2693 (widget-put widget :custom-magic magic)
2694 (push magic buttons))
2695 ;; Update buttons.
2696 (widget-put widget :buttons buttons)
2697 ;; Insert documentation.
2698 (widget-default-format-handler widget ?h)
d3d4df42
DL
2699 ;; The comment field
2700 (unless (eq state 'hidden)
2701 (let* ((comment (get symbol 'face-comment))
2702 (comment-widget
2703 (widget-create-child-and-convert
2704 widget 'custom-comment
2705 :parent widget
2706 :value (or comment ""))))
2707 (widget-put widget :comment-widget comment-widget)
2708 (push comment-widget children)))
944c91b6
PA
2709 ;; See also.
2710 (unless (eq state 'hidden)
2711 (when (eq (widget-get widget :custom-level) 1)
2712 (custom-add-parent-links widget))
2713 (custom-add-see-also widget))
2714 ;; Editor.
2715 (unless (eq (preceding-char) ?\n)
2716 (insert "\n"))
2717 (unless (eq state 'hidden)
2718 (message "Creating face editor...")
2719 (custom-load-widget widget)
d64478da
KH
2720 (unless (widget-get widget :custom-form)
2721 (widget-put widget :custom-form custom-face-default-form))
944c91b6
PA
2722 (let* ((symbol (widget-value widget))
2723 (spec (or (get symbol 'saved-face)
2724 (get symbol 'face-defface-spec)
2725 ;; Attempt to construct it.
d3d4df42 2726 (list (list t (custom-face-attributes-get
944c91b6
PA
2727 symbol (selected-frame))))))
2728 (form (widget-get widget :custom-form))
2729 (indent (widget-get widget :indent))
fa0b3d46
RS
2730 edit)
2731 ;; If the user has changed this face in some other way,
2732 ;; edit it as the user has specified it.
2733 (if (not (face-spec-match-p symbol spec (selected-frame)))
2734 (setq spec (list (list t (face-attr-construct symbol (selected-frame))))))
f5b50baa 2735 (setq spec (custom-pre-filter-face-spec spec))
fa0b3d46 2736 (setq edit (widget-create-child-and-convert
944c91b6
PA
2737 widget
2738 (cond ((and (eq form 'selected)
d3d4df42 2739 (widget-apply custom-face-selected
944c91b6
PA
2740 :match spec))
2741 (when indent (insert-char ?\ indent))
2742 'custom-face-selected)
2743 ((and (not (eq form 'lisp))
2744 (widget-apply custom-face-all
2745 :match spec))
2746 'custom-face-all)
d3d4df42 2747 (t
944c91b6
PA
2748 (when indent (insert-char ?\ indent))
2749 'sexp))
fa0b3d46 2750 :value spec))
944c91b6 2751 (custom-face-state-set widget)
d3d4df42
DL
2752 (push edit children)
2753 (widget-put widget :children children))
944c91b6 2754 (message "Creating face editor...done"))))))
d543e20b 2755
d3d4df42 2756(defvar custom-face-menu
3aec85bf 2757 '(("Set for Current Session" custom-face-set)
896a6a5d 2758 ("Save for Future Sessions" custom-face-save-command)
6d528fc5
PA
2759 ("Reset to Saved" custom-face-reset-saved
2760 (lambda (widget)
d3d4df42
DL
2761 (or (get (widget-value widget) 'saved-face)
2762 (get (widget-value widget) 'saved-face-comment))))
19d63704 2763 ("Erase Customization" custom-face-reset-standard
6d528fc5 2764 (lambda (widget)
8697863a
PA
2765 (get (widget-value widget) 'face-defface-spec)))
2766 ("---" ignore ignore)
d3d4df42
DL
2767 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2768 ("---" ignore ignore)
8697863a
PA
2769 ("Show all display specs" custom-face-edit-all
2770 (lambda (widget)
2771 (not (eq (widget-get widget :custom-form) 'all))))
2772 ("Just current attributes" custom-face-edit-selected
2773 (lambda (widget)
2774 (not (eq (widget-get widget :custom-form) 'selected))))
2775 ("Show as Lisp expression" custom-face-edit-lisp
2776 (lambda (widget)
2777 (not (eq (widget-get widget :custom-form) 'lisp)))))
d543e20b 2778 "Alist of actions for the `custom-face' widget.
6d528fc5
PA
2779Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2780the menu entry, ACTION is the function to call on the widget when the
2781menu is selected, and FILTER is a predicate which takes a `custom-face'
2782widget as an argument, and returns non-nil if ACTION is valid on that
19d63704 2783widget. If FILTER is nil, ACTION is always valid.")
d543e20b
PA
2784
2785(defun custom-face-edit-selected (widget)
2786 "Edit selected attributes of the value of WIDGET."
2787 (widget-put widget :custom-state 'unknown)
2788 (widget-put widget :custom-form 'selected)
2789 (custom-redraw widget))
2790
2791(defun custom-face-edit-all (widget)
2792 "Edit all attributes of the value of WIDGET."
2793 (widget-put widget :custom-state 'unknown)
2794 (widget-put widget :custom-form 'all)
2795 (custom-redraw widget))
2796
2797(defun custom-face-edit-lisp (widget)
2365594b 2798 "Edit the Lisp representation of the value of WIDGET."
d543e20b
PA
2799 (widget-put widget :custom-state 'unknown)
2800 (widget-put widget :custom-form 'lisp)
2801 (custom-redraw widget))
2802
2803(defun custom-face-state-set (widget)
2804 "Set the state of WIDGET."
d3d4df42
DL
2805 (let* ((symbol (widget-value widget))
2806 (comment (get symbol 'face-comment))
2807 tmp temp)
2808 (widget-put widget :custom-state
2809 (cond ((progn
2810 (setq tmp (get symbol 'customized-face))
2811 (setq temp (get symbol 'customized-face-comment))
2812 (or tmp temp))
2813 (if (equal temp comment)
2814 'set
2815 'changed))
2816 ((progn
2817 (setq tmp (get symbol 'saved-face))
2818 (setq temp (get symbol 'saved-face-comment))
2819 (or tmp temp))
2820 (if (equal temp comment)
2821 'saved
2822 'changed))
2823 ((get symbol 'face-defface-spec)
2824 (if (equal comment nil)
2825 'standard
2826 'changed))
2827 (t
2828 'rogue)))))
d543e20b
PA
2829
2830(defun custom-face-action (widget &optional event)
2831 "Show the menu for `custom-face' WIDGET.
2832Optional EVENT is the location for the menu."
2833 (if (eq (widget-get widget :custom-state) 'hidden)
6d528fc5 2834 (custom-toggle-hide widget)
d543e20b
PA
2835 (let* ((completion-ignore-case t)
2836 (symbol (widget-get widget :value))
25ac13b5
PA
2837 (answer (widget-choose (concat "Operation on "
2838 (custom-unlispify-tag-name symbol))
6d528fc5
PA
2839 (custom-menu-filter custom-face-menu
2840 widget)
2841 event)))
d543e20b
PA
2842 (if answer
2843 (funcall answer widget)))))
2844
2845(defun custom-face-set (widget)
2846 "Make the face attributes in WIDGET take effect."
2847 (let* ((symbol (widget-value widget))
2848 (child (car (widget-get widget :children)))
f5b50baa 2849 (value (custom-post-filter-face-spec (widget-value child)))
d3d4df42
DL
2850 (comment-widget (widget-get widget :comment-widget))
2851 (comment (widget-value comment-widget)))
2852 (when (equal comment "")
2853 (setq comment nil)
2854 ;; Make the comment invisible by hand if it's empty
164cfaeb 2855 (custom-comment-hide comment-widget))
d543e20b 2856 (put symbol 'customized-face value)
f5b50baa
MB
2857 (if (face-spec-choose value)
2858 (face-spec-set symbol value)
2859 ;; face-set-spec ignores empty attribute lists, so just give it
2860 ;; something harmless instead.
2861 (face-spec-set symbol '((t :foreground unspecified))))
d3d4df42
DL
2862 (put symbol 'customized-face-comment comment)
2863 (put symbol 'face-comment comment)
d543e20b
PA
2864 (custom-face-state-set widget)
2865 (custom-redraw-magic widget)))
2866
896a6a5d
RS
2867(defun custom-face-save-command (widget)
2868 "Save in `.emacs' the face attributes in WIDGET."
2869 (custom-face-save widget)
2870 (custom-save-all))
2871
d543e20b 2872(defun custom-face-save (widget)
896a6a5d 2873 "Prepare for saving WIDGET's face attributes, but don't write `.emacs'."
d543e20b
PA
2874 (let* ((symbol (widget-value widget))
2875 (child (car (widget-get widget :children)))
e475612a 2876 (value (custom-post-filter-face-spec (widget-value child)))
d3d4df42
DL
2877 (comment-widget (widget-get widget :comment-widget))
2878 (comment (widget-value comment-widget)))
2879 (when (equal comment "")
2880 (setq comment nil)
2881 ;; Make the comment invisible by hand if it's empty
164cfaeb 2882 (custom-comment-hide comment-widget))
e475612a
MB
2883 (if (face-spec-choose value)
2884 (face-spec-set symbol value)
2885 ;; face-set-spec ignores empty attribute lists, so just give it
2886 ;; something harmless instead.
2887 (face-spec-set symbol '((t :foreground unspecified))))
d543e20b
PA
2888 (put symbol 'saved-face value)
2889 (put symbol 'customized-face nil)
d3d4df42
DL
2890 (put symbol 'face-comment comment)
2891 (put symbol 'customized-face-comment nil)
2892 (put symbol 'saved-face-comment comment)
6321bddd 2893 (custom-save-all)
d543e20b
PA
2894 (custom-face-state-set widget)
2895 (custom-redraw-magic widget)))
2896
2897(defun custom-face-reset-saved (widget)
2898 "Restore WIDGET to the face's default attributes."
2899 (let* ((symbol (widget-value widget))
2900 (child (car (widget-get widget :children)))
d3d4df42
DL
2901 (value (get symbol 'saved-face))
2902 (comment (get symbol 'saved-face-comment))
2903 (comment-widget (widget-get widget :comment-widget)))
2904 (unless (or value comment)
d543e20b
PA
2905 (error "No saved value for this face"))
2906 (put symbol 'customized-face nil)
d3d4df42 2907 (put symbol 'customized-face-comment nil)
25ac13b5 2908 (face-spec-set symbol value)
d3d4df42 2909 (put symbol 'face-comment comment)
d543e20b 2910 (widget-value-set child value)
d3d4df42
DL
2911 ;; This call manages the comment visibility
2912 (widget-value-set comment-widget (or comment ""))
d543e20b
PA
2913 (custom-face-state-set widget)
2914 (custom-redraw-magic widget)))
2915
25ac13b5 2916(defun custom-face-reset-standard (widget)
19d63704
RS
2917 "Restore WIDGET to the face's standard settings.
2918This operation eliminates any saved setting for the face,
2919restoring it to the state of a face that has never been customized."
d543e20b
PA
2920 (let* ((symbol (widget-value widget))
2921 (child (car (widget-get widget :children)))
d3d4df42
DL
2922 (value (get symbol 'face-defface-spec))
2923 (comment-widget (widget-get widget :comment-widget)))
d543e20b 2924 (unless value
5dd0cad0 2925 (error "No standard setting for this face"))
d543e20b 2926 (put symbol 'customized-face nil)
d3d4df42
DL
2927 (put symbol 'customized-face-comment nil)
2928 (when (or (get symbol 'saved-face) (get symbol 'saved-face-comment))
d543e20b 2929 (put symbol 'saved-face nil)
d3d4df42 2930 (put symbol 'saved-face-comment nil)
d543e20b 2931 (custom-save-all))
25ac13b5 2932 (face-spec-set symbol value)
d3d4df42 2933 (put symbol 'face-comment nil)
d543e20b 2934 (widget-value-set child value)
d3d4df42
DL
2935 ;; This call manages the comment visibility
2936 (widget-value-set comment-widget "")
d543e20b
PA
2937 (custom-face-state-set widget)
2938 (custom-redraw-magic widget)))
2939
2940;;; The `face' Widget.
2941
2942(define-widget 'face 'default
2943 "Select and customize a face."
86bd10bc 2944 :convert-widget 'widget-value-convert-widget
944c91b6
PA
2945 :button-prefix 'widget-push-button-prefix
2946 :button-suffix 'widget-push-button-suffix
9c6a4107 2947 :format "%{%t%}: %[select face%] %v"
d543e20b
PA
2948 :tag "Face"
2949 :value 'default
2950 :value-create 'widget-face-value-create
2951 :value-delete 'widget-face-value-delete
86bd10bc
PA
2952 :value-get 'widget-value-value-get
2953 :validate 'widget-children-validate
d543e20b 2954 :action 'widget-face-action
8cfd634f 2955 :match (lambda (widget value) (symbolp value)))
d543e20b
PA
2956
2957(defun widget-face-value-create (widget)
2365594b 2958 "Create a `custom-face' child."
d543e20b 2959 (let* ((symbol (widget-value widget))
944c91b6 2960 (custom-buffer-style 'face)
d543e20b
PA
2961 (child (widget-create-child-and-convert
2962 widget 'custom-face
d543e20b
PA
2963 :custom-level nil
2964 :value symbol)))
2965 (custom-magic-reset child)
2966 (setq custom-options (cons child custom-options))
2967 (widget-put widget :children (list child))))
2968
2969(defun widget-face-value-delete (widget)
2365594b 2970 "Remove the child from the options."
d543e20b
PA
2971 (let ((child (car (widget-get widget :children))))
2972 (setq custom-options (delq child custom-options))
2973 (widget-children-value-delete widget)))
2974
2975(defvar face-history nil
2976 "History of entered face names.")
2977
2978(defun widget-face-action (widget &optional event)
2979 "Prompt for a face."
2980 (let ((answer (completing-read "Face: "
2981 (mapcar (lambda (face)
2982 (list (symbol-name face)))
2983 (face-list))
d3d4df42 2984 nil nil nil
d543e20b
PA
2985 'face-history)))
2986 (unless (zerop (length answer))
2987 (widget-value-set widget (intern answer))
2988 (widget-apply widget :notify widget event)
2989 (widget-setup))))
2990
2991;;; The `hook' Widget.
2992
2993(define-widget 'hook 'list
2994 "A emacs lisp hook"
f985c5f7 2995 :value-to-internal (lambda (widget value)
5aa3f181 2996 (if (and value (symbolp value))
f985c5f7
PA
2997 (list value)
2998 value))
2999 :match (lambda (widget value)
3000 (or (symbolp value)
4743fc91 3001 (widget-group-match widget value)))
2365594b
DL
3002 ;; Avoid adding undefined functions to the hook, especially for
3003 ;; things like `find-file-hook' or even more basic ones, to avoid
3004 ;; chaos.
3005 :set (lambda (symbol value)
d4881668
SM
3006 (dolist (elt value)
3007 (if (fboundp elt)
3008 (add-hook symbol elt))))
d543e20b
PA
3009 :convert-widget 'custom-hook-convert-widget
3010 :tag "Hook")
3011
3012(defun custom-hook-convert-widget (widget)
3c708e98 3013 ;; Handle `:options'.
d543e20b 3014 (let* ((options (widget-get widget :options))
d3d4df42 3015 (other `(editable-list :inline t
d543e20b
PA
3016 :entry-format "%i %d%v"
3017 (function :format " %v")))
3018 (args (if options
3019 (list `(checklist :inline t
3020 ,@(mapcar (lambda (entry)
3021 `(function-item ,entry))
3022 options))
3023 other)
3024 (list other))))
3025 (widget-put widget :args args)
3026 widget))
3027
944c91b6
PA
3028;;; The `custom-group-link' Widget.
3029
3030(define-widget 'custom-group-link 'link
3031 "Show parent in other window when activated."
b62c92bb 3032 :help-echo "Create customization buffer for this group."
944c91b6
PA
3033 :action 'custom-group-link-action)
3034
3035(defun custom-group-link-action (widget &rest ignore)
3036 (customize-group (widget-value widget)))
3037
d543e20b
PA
3038;;; The `custom-group' Widget.
3039
b62c92bb 3040(defcustom custom-group-tag-faces nil
d543e20b 3041 ;; In XEmacs, this ought to play games with font size.
d3d4df42 3042 ;; Fixme: make it do so in Emacs.
d543e20b
PA
3043 "Face used for group tags.
3044The first member is used for level 1 groups, the second for level 2,
3045and so forth. The remaining group tags are shown with
3046`custom-group-tag-face'."
3047 :type '(repeat face)
bd042c03 3048 :group 'custom-faces)
d543e20b 3049
16b20ed9
GM
3050(defface custom-group-tag-face-1
3051 `((((class color)
3052 (background dark))
61fb10d0 3053 (:foreground "pink" :bold t :height 1.2 :inherit variable-pitch))
16b20ed9
GM
3054 (((class color)
3055 (background light))
61fb10d0 3056 (:foreground "red" :bold t :height 1.2 :inherit variable-pitch))
16b20ed9
GM
3057 (t (:bold t)))
3058 "Face used for group tags."
3059 :group 'custom-faces)
3060
3061(defface custom-group-tag-face
3062 `((((class color)
3063 (background dark))
61fb10d0 3064 (:foreground "light blue" :bold t :height 1.2))
16b20ed9
GM
3065 (((class color)
3066 (background light))
61fb10d0 3067 (:foreground "blue" :bold t :height 1.2))
16b20ed9 3068 (t (:bold t)))
d543e20b 3069 "Face used for low level group tags."
bd042c03 3070 :group 'custom-faces)
d543e20b
PA
3071
3072(define-widget 'custom-group 'custom
3073 "Customize group."
944c91b6 3074 :format "%v"
d543e20b
PA
3075 :sample-face-get 'custom-group-sample-face-get
3076 :documentation-property 'group-documentation
3077 :help-echo "Set or reset all members of this group."
3078 :value-create 'custom-group-value-create
3079 :action 'custom-group-action
9097aeb7 3080 :custom-category 'group
d543e20b
PA
3081 :custom-set 'custom-group-set
3082 :custom-save 'custom-group-save
3083 :custom-reset-current 'custom-group-reset-current
3084 :custom-reset-saved 'custom-group-reset-saved
25ac13b5 3085 :custom-reset-standard 'custom-group-reset-standard
d543e20b
PA
3086 :custom-menu 'custom-group-menu-create)
3087
3088(defun custom-group-sample-face-get (widget)
3089 ;; Use :sample-face.
3090 (or (nth (1- (widget-get widget :custom-level)) custom-group-tag-faces)
3091 'custom-group-tag-face))
3092
8691cfa7
RS
3093(define-widget 'custom-group-visibility 'visibility
3094 "An indicator and manipulator for hidden group contents."
3095 :create 'custom-group-visibility-create)
3096
3097(defun custom-group-visibility-create (widget)
3098 (let ((visible (widget-value widget)))
3099 (if visible
3100 (insert "--------")))
3101 (widget-default-create widget))
3102
4ee1cf9f
PA
3103(defun custom-group-members (symbol groups-only)
3104 "Return SYMBOL's custom group members.
3105If GROUPS-ONLY non-nil, return only those members that are groups."
3106 (if (not groups-only)
3107 (get symbol 'custom-group)
3108 (let (members)
3109 (dolist (entry (get symbol 'custom-group))
3110 (when (eq (nth 1 entry) 'custom-group)
3111 (push entry members)))
3112 (nreverse members))))
3113
d543e20b 3114(defun custom-group-value-create (widget)
944c91b6 3115 "Insert a customize group for WIDGET in the current buffer."
4ee1cf9f
PA
3116 (let* ((state (widget-get widget :custom-state))
3117 (level (widget-get widget :custom-level))
f985c5f7 3118 ;; (indent (widget-get widget :indent))
4ee1cf9f
PA
3119 (prefix (widget-get widget :custom-prefix))
3120 (buttons (widget-get widget :buttons))
3121 (tag (widget-get widget :tag))
3122 (symbol (widget-value widget))
3123 (members (custom-group-members symbol
3124 (and (eq custom-buffer-style 'tree)
3125 custom-browse-only-groups))))
944c91b6 3126 (cond ((and (eq custom-buffer-style 'tree)
c953515e 3127 (eq state 'hidden)
4ee1cf9f 3128 (or members (custom-unloaded-widget-p widget)))
c953515e 3129 (custom-browse-insert-prefix prefix)
944c91b6 3130 (push (widget-create-child-and-convert
d3d4df42 3131 widget 'custom-browse-visibility
da5ec617 3132 ;; :tag-glyph "plus"
df816618 3133 :tag "+")
944c91b6
PA
3134 buttons)
3135 (insert "-- ")
da5ec617 3136 ;; (widget-glyph-insert nil "-- " "horizontal")
944c91b6 3137 (push (widget-create-child-and-convert
c953515e 3138 widget 'custom-browse-group-tag)
944c91b6
PA
3139 buttons)
3140 (insert " " tag "\n")
3141 (widget-put widget :buttons buttons))
3142 ((and (eq custom-buffer-style 'tree)
4ee1cf9f 3143 (zerop (length members)))
c953515e 3144 (custom-browse-insert-prefix prefix)
da5ec617
PA
3145 (insert "[ ]-- ")
3146 ;; (widget-glyph-insert nil "[ ]" "empty")
3147 ;; (widget-glyph-insert nil "-- " "horizontal")
d3d4df42 3148 (push (widget-create-child-and-convert
c953515e 3149 widget 'custom-browse-group-tag)
944c91b6
PA
3150 buttons)
3151 (insert " " tag "\n")
3152 (widget-put widget :buttons buttons))
3153 ((eq custom-buffer-style 'tree)
c953515e 3154 (custom-browse-insert-prefix prefix)
944c91b6 3155 (custom-load-widget widget)
4ee1cf9f 3156 (if (zerop (length members))
d3d4df42 3157 (progn
c953515e 3158 (custom-browse-insert-prefix prefix)
da5ec617
PA
3159 (insert "[ ]-- ")
3160 ;; (widget-glyph-insert nil "[ ]" "empty")
3161 ;; (widget-glyph-insert nil "-- " "horizontal")
d3d4df42 3162 (push (widget-create-child-and-convert
c953515e 3163 widget 'custom-browse-group-tag)
944c91b6
PA
3164 buttons)
3165 (insert " " tag "\n")
3166 (widget-put widget :buttons buttons))
d3d4df42
DL
3167 (push (widget-create-child-and-convert
3168 widget 'custom-browse-visibility
da5ec617
PA
3169 ;; :tag-glyph "minus"
3170 :tag "-")
944c91b6 3171 buttons)
da5ec617
PA
3172 (insert "-\\ ")
3173 ;; (widget-glyph-insert nil "-\\ " "top")
d3d4df42 3174 (push (widget-create-child-and-convert
c953515e 3175 widget 'custom-browse-group-tag)
944c91b6
PA
3176 buttons)
3177 (insert " " tag "\n")
3178 (widget-put widget :buttons buttons)
3179 (message "Creating group...")
4ee1cf9f 3180 (let* ((members (custom-sort-items members
da5ec617
PA
3181 custom-browse-sort-alphabetically
3182 custom-browse-order-groups))
944c91b6
PA
3183 (prefixes (widget-get widget :custom-prefixes))
3184 (custom-prefix-list (custom-prefix-add symbol prefixes))
944c91b6
PA
3185 (extra-prefix (if (widget-get widget :custom-last)
3186 " "
3187 " | "))
3188 (prefix (concat prefix extra-prefix))
3189 children entry)
3190 (while members
3191 (setq entry (car members)
3192 members (cdr members))
4ee1cf9f
PA
3193 (push (widget-create-child-and-convert
3194 widget (nth 1 entry)
3195 :group widget
3196 :tag (custom-unlispify-tag-name (nth 0 entry))
3197 :custom-prefixes custom-prefix-list
3198 :custom-level (1+ level)
3199 :custom-last (null members)
3200 :value (nth 0 entry)
3201 :custom-prefix prefix)
3202 children))
944c91b6
PA
3203 (widget-put widget :children (reverse children)))
3204 (message "Creating group...done")))
3205 ;; Nested style.
3206 ((eq state 'hidden)
3207 ;; Create level indicator.
26c7b3ef
RS
3208 (unless (eq custom-buffer-style 'links)
3209 (insert-char ?\ (* custom-buffer-indent (1- level)))
3210 (insert "-- "))
944c91b6
PA
3211 ;; Create tag.
3212 (let ((begin (point)))
3213 (insert tag)
3214 (widget-specify-sample widget begin (point)))
3215 (insert " group: ")
3216 ;; Create link/visibility indicator.
3217 (if (eq custom-buffer-style 'links)
3218 (push (widget-create-child-and-convert
d3d4df42 3219 widget 'custom-group-link
b62c92bb 3220 :tag "Go to Group"
944c91b6
PA
3221 symbol)
3222 buttons)
d3d4df42 3223 (push (widget-create-child-and-convert
98d5aafe 3224 widget 'custom-group-visibility
944c91b6
PA
3225 :help-echo "Show members of this group."
3226 :action 'custom-toggle-parent
3227 (not (eq state 'hidden)))
3228 buttons))
3229 (insert " \n")
3230 ;; Create magic button.
3231 (let ((magic (widget-create-child-and-convert
3232 widget 'custom-magic nil)))
3233 (widget-put widget :custom-magic magic)
3234 (push magic buttons))
3235 ;; Update buttons.
3236 (widget-put widget :buttons buttons)
3237 ;; Insert documentation.
26c7b3ef
RS
3238 (if (and (eq custom-buffer-style 'links) (> level 1))
3239 (widget-put widget :documentation-indent 0))
944c91b6
PA
3240 (widget-default-format-handler widget ?h))
3241 ;; Nested style.
3242 (t ;Visible.
d377bee9
RS
3243 ;; Add parent groups references above the group.
3244 (if t ;;; This should test that the buffer
3245 ;;; was made to display a group.
3246 (when (eq level 1)
cd6c0940
RS
3247 (if (custom-add-parent-links widget
3248 "Go to parent group:")
d377bee9 3249 (insert "\n"))))
944c91b6
PA
3250 ;; Create level indicator.
3251 (insert-char ?\ (* custom-buffer-indent (1- level)))
3252 (insert "/- ")
3253 ;; Create tag.
3254 (let ((start (point)))
3255 (insert tag)
3256 (widget-specify-sample widget start (point)))
3257 (insert " group: ")
3258 ;; Create visibility indicator.
3259 (unless (eq custom-buffer-style 'links)
3260 (insert "--------")
d3d4df42 3261 (push (widget-create-child-and-convert
944c91b6
PA
3262 widget 'visibility
3263 :help-echo "Hide members of this group."
3264 :action 'custom-toggle-parent
3265 (not (eq state 'hidden)))
3266 buttons)
3267 (insert " "))
3268 ;; Create more dashes.
3269 ;; Use 76 instead of 75 to compensate for the temporary "<"
d3d4df42 3270 ;; added by `widget-insert'.
944c91b6
PA
3271 (insert-char ?- (- 76 (current-column)
3272 (* custom-buffer-indent level)))
3273 (insert "\\\n")
3274 ;; Create magic button.
3275 (let ((magic (widget-create-child-and-convert
d3d4df42 3276 widget 'custom-magic
944c91b6
PA
3277 :indent 0
3278 nil)))
3279 (widget-put widget :custom-magic magic)
3280 (push magic buttons))
3281 ;; Update buttons.
3282 (widget-put widget :buttons buttons)
3283 ;; Insert documentation.
3284 (widget-default-format-handler widget ?h)
d377bee9
RS
3285 ;; Parent groups.
3286 (if nil ;;; This should test that the buffer
3287 ;;; was not made to display a group.
3288 (when (eq level 1)
3289 (insert-char ?\ custom-buffer-indent)
3290 (custom-add-parent-links widget)))
d3d4df42 3291 (custom-add-see-also widget
944c91b6
PA
3292 (make-string (* custom-buffer-indent level)
3293 ?\ ))
3294 ;; Members.
3295 (message "Creating group...")
3296 (custom-load-widget widget)
4ee1cf9f 3297 (let* ((members (custom-sort-items members
da5ec617
PA
3298 custom-buffer-sort-alphabetically
3299 custom-buffer-order-groups))
944c91b6
PA
3300 (prefixes (widget-get widget :custom-prefixes))
3301 (custom-prefix-list (custom-prefix-add symbol prefixes))
3302 (length (length members))
3303 (count 0)
3304 (children (mapcar (lambda (entry)
3305 (widget-insert "\n")
3306 (message "\
3307Creating group members... %2d%%"
3308 (/ (* 100.0 count) length))
3309 (setq count (1+ count))
3310 (prog1
3311 (widget-create-child-and-convert
3312 widget (nth 1 entry)
3313 :group widget
3314 :tag (custom-unlispify-tag-name
3315 (nth 0 entry))
3316 :custom-prefixes custom-prefix-list
3317 :custom-level (1+ level)
3318 :value (nth 0 entry))
3319 (unless (eq (preceding-char) ?\n)
3320 (widget-insert "\n"))))
3321 members)))
3322 (message "Creating group magic...")
fadbdfea 3323 (mapc 'custom-magic-reset children)
944c91b6
PA
3324 (message "Creating group state...")
3325 (widget-put widget :children children)
3326 (custom-group-state-update widget)
3327 (message "Creating group... done"))
3328 ;; End line
3329 (insert "\n")
3330 (insert-char ?\ (* custom-buffer-indent (1- level)))
3331 (insert "\\- " (widget-get widget :tag) " group end ")
3332 (insert-char ?- (- 75 (current-column) (* custom-buffer-indent level)))
3333 (insert "/\n")))))
d543e20b 3334
d3d4df42 3335(defvar custom-group-menu
3aec85bf 3336 '(("Set for Current Session" custom-group-set
6d528fc5
PA
3337 (lambda (widget)
3338 (eq (widget-get widget :custom-state) 'modified)))
3aec85bf 3339 ("Save for Future Sessions" custom-group-save
6d528fc5
PA
3340 (lambda (widget)
3341 (memq (widget-get widget :custom-state) '(modified set))))
3342 ("Reset to Current" custom-group-reset-current
3343 (lambda (widget)
86bd10bc 3344 (memq (widget-get widget :custom-state) '(modified))))
6d528fc5
PA
3345 ("Reset to Saved" custom-group-reset-saved
3346 (lambda (widget)
86bd10bc 3347 (memq (widget-get widget :custom-state) '(modified set))))
25ac13b5 3348 ("Reset to standard setting" custom-group-reset-standard
6d528fc5 3349 (lambda (widget)
86bd10bc 3350 (memq (widget-get widget :custom-state) '(modified set saved)))))
d543e20b 3351 "Alist of actions for the `custom-group' widget.
6d528fc5
PA
3352Each entry has the form (NAME ACTION FILTER) where NAME is the name of
3353the menu entry, ACTION is the function to call on the widget when the
3354menu is selected, and FILTER is a predicate which takes a `custom-group'
3355widget as an argument, and returns non-nil if ACTION is valid on that
d3d4df42 3356widget. If FILTER is nil, ACTION is always valid.")
d543e20b
PA
3357
3358(defun custom-group-action (widget &optional event)
3359 "Show the menu for `custom-group' WIDGET.
3360Optional EVENT is the location for the menu."
3361 (if (eq (widget-get widget :custom-state) 'hidden)
6d528fc5 3362 (custom-toggle-hide widget)
d543e20b 3363 (let* ((completion-ignore-case t)
25ac13b5
PA
3364 (answer (widget-choose (concat "Operation on "
3365 (custom-unlispify-tag-name
3366 (widget-get widget :value)))
6d528fc5
PA
3367 (custom-menu-filter custom-group-menu
3368 widget)
d543e20b
PA
3369 event)))
3370 (if answer
3371 (funcall answer widget)))))
3372
3373(defun custom-group-set (widget)
3374 "Set changes in all modified group members."
3375 (let ((children (widget-get widget :children)))
fadbdfea
DL
3376 (mapc (lambda (child)
3377 (when (eq (widget-get child :custom-state) 'modified)
3378 (widget-apply child :custom-set)))
d543e20b
PA
3379 children )))
3380
3381(defun custom-group-save (widget)
3382 "Save all modified group members."
3383 (let ((children (widget-get widget :children)))
fadbdfea
DL
3384 (mapc (lambda (child)
3385 (when (memq (widget-get child :custom-state) '(modified set))
3386 (widget-apply child :custom-save)))
d543e20b
PA
3387 children )))
3388
3389(defun custom-group-reset-current (widget)
3390 "Reset all modified group members."
3391 (let ((children (widget-get widget :children)))
fadbdfea
DL
3392 (mapc (lambda (child)
3393 (when (eq (widget-get child :custom-state) 'modified)
3394 (widget-apply child :custom-reset-current)))
d543e20b
PA
3395 children )))
3396
3397(defun custom-group-reset-saved (widget)
3398 "Reset all modified or set group members."
3399 (let ((children (widget-get widget :children)))
fadbdfea
DL
3400 (mapc (lambda (child)
3401 (when (memq (widget-get child :custom-state) '(modified set))
3402 (widget-apply child :custom-reset-saved)))
d543e20b
PA
3403 children )))
3404
25ac13b5 3405(defun custom-group-reset-standard (widget)
d543e20b
PA
3406 "Reset all modified, set, or saved group members."
3407 (let ((children (widget-get widget :children)))
fadbdfea
DL
3408 (mapc (lambda (child)
3409 (when (memq (widget-get child :custom-state)
3410 '(modified set saved))
3411 (widget-apply child :custom-reset-standard)))
d543e20b
PA
3412 children )))
3413
3414(defun custom-group-state-update (widget)
3415 "Update magic."
3416 (unless (eq (widget-get widget :custom-state) 'hidden)
3417 (let* ((children (widget-get widget :children))
3418 (states (mapcar (lambda (child)
3419 (widget-get child :custom-state))
3420 children))
25ac13b5
PA
3421 (magics custom-magic-alist)
3422 (found 'standard))
d543e20b
PA
3423 (while magics
3424 (let ((magic (car (car magics))))
3425 (if (and (not (eq magic 'hidden))
3426 (memq magic states))
3427 (setq found magic
3428 magics nil)
3429 (setq magics (cdr magics)))))
3430 (widget-put widget :custom-state found)))
3431 (custom-magic-reset widget))
3432
3433;;; The `custom-save-all' Function.
a1a4fa22 3434;;;###autoload
1e4ed6df 3435(defcustom custom-file nil
d543e20b 3436 "File used for storing customization information.
1e4ed6df
PA
3437The default is nil, which means to use your init file
3438as specified by `user-init-file'. If you specify some other file,
a34511a1
RS
3439you need to explicitly load that file for the settings to take effect.
3440
3441When you change this variable, look in the previous custom file
3442\(usually your init file) for the forms `(custom-set-variables ...)'
3443and `(custom-set-faces ...)', and copy them (whichever ones you find)
3444to the new custom file. This will preserve your existing customizations."
1e4ed6df 3445 :type '(choice (const :tag "Your Emacs init file" nil) file)
d543e20b
PA
3446 :group 'customize)
3447
176eb8cb
KH
3448(defun custom-file ()
3449 "Return the file name for saving customizations."
558771ba
EZ
3450 (setq custom-file
3451 (or custom-file
3452 (let ((user-init-file user-init-file)
3453 (default-init-file
3454 (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs")))
3455 (when (null user-init-file)
3456 (if (or (file-exists-p default-init-file)
3457 (and (eq system-type 'windows-nt)
3458 (file-exists-p "~/_emacs")))
3459 ;; Started with -q, i.e. the file containing
3460 ;; Custom settings hasn't been read. Saving
3461 ;; settings there would overwrite other settings.
3462 (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
3463 (setq user-init-file default-init-file))
3464 user-init-file))))
176eb8cb 3465
d543e20b 3466(defun custom-save-delete (symbol)
a34511a1
RS
3467 "Visit `custom-file' and delete all calls to SYMBOL from it.
3468Leave point at the old location of the first such call,
3469or (if there were none) at the end of the buffer."
fc4d62fe 3470 (let ((default-major-mode))
176eb8cb 3471 (set-buffer (find-file-noselect (custom-file))))
d543e20b 3472 (goto-char (point-min))
cbe8bb8e
KH
3473 ;; Skip all whitespace and comments.
3474 (while (forward-comment 1))
3475 (or (eobp)
3476 (save-excursion (forward-sexp (buffer-size)))) ; Test for scan errors.
a34511a1
RS
3477 (let (first)
3478 (catch 'found
3479 (while t ;; We exit this loop only via throw.
3480 ;; Skip all whitespace and comments.
3481 (while (forward-comment 1))
3482 (let ((start (point))
3483 (sexp (condition-case nil
3484 (read (current-buffer))
3485 (end-of-file (throw 'found nil)))))
3486 (when (and (listp sexp)
3487 (eq (car sexp) symbol))
3488 (delete-region start (point))
3489 (unless first
3490 (setq first (point)))))))
3491 (if first
3492 (goto-char first)
189638d5
GM
3493 ;; Move in front of local variables, otherwise long Custom
3494 ;; entries would make them ineffective.
3495 (let ((pos (point-max))
3496 (case-fold-search t))
3497 (save-excursion
3498 (goto-char (point-max))
3499 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3500 'move)
3501 (when (search-forward "Local Variables:" nil t)
3502 (setq pos (line-beginning-position))))
3503 (goto-char pos)))))
d543e20b
PA
3504
3505(defun custom-save-variables ()
3506 "Save all customized variables in `custom-file'."
3507 (save-excursion
3508 (custom-save-delete 'custom-set-variables)
d151422c
MR
3509 (let ((standard-output (current-buffer))
3510 (saved-list (make-list 1 0))
3511 sort-fold-case)
3512 ;; First create a sorted list of saved variables.
3513 (mapatoms
3514 (lambda (symbol)
3515 (if (get symbol 'saved-value)
3516 (nconc saved-list (list symbol)))))
3517 (setq saved-list (sort (cdr saved-list) 'string<))
d543e20b
PA
3518 (unless (bolp)
3519 (princ "\n"))
aec2bb63
DL
3520 (princ "(custom-set-variables
3521 ;; custom-set-variables was added by Custom -- don't edit or cut/paste it!
fda514f7 3522 ;; Your init file should contain only one such instance.\n")
d151422c
MR
3523 (mapcar
3524 (lambda (symbol)
3525 (let ((value (get symbol 'saved-value))
3526 (requests (get symbol 'custom-requests))
3527 (now (not (or (get symbol 'standard-value)
3528 (and (not (boundp symbol))
d3d4df42
DL
3529 (not (get symbol 'force-value))))))
3530 (comment (get symbol 'saved-variable-comment))
3531 sep)
3532 (when (or value comment)
a34511a1
RS
3533 (unless (bolp)
3534 (princ "\n"))
3535 (princ " '(")
d3d4df42
DL
3536 (prin1 symbol)
3537 (princ " ")
3538 (prin1 (car value))
3539 (cond ((or now requests comment)
3540 (princ " ")
3541 (if now
3542 (princ "t")
3543 (princ "nil"))
3544 (cond ((or requests comment)
3545 (princ " ")
3546 (if requests
3547 (prin1 requests)
3548 (princ "nil"))
3549 (cond (comment
3550 (princ " ")
3551 (prin1 comment)
3552 (princ ")"))
3553 (t
3554 (princ ")"))))
3555 (t
3556 (princ ")"))))
3557 (t
3558 (princ ")"))))))
d151422c 3559 saved-list)
a34511a1
RS
3560 (if (bolp)
3561 (princ " "))
d543e20b
PA
3562 (princ ")")
3563 (unless (looking-at "\n")
3564 (princ "\n")))))
3565
3566(defun custom-save-faces ()
3567 "Save all customized faces in `custom-file'."
3568 (save-excursion
3569 (custom-save-delete 'custom-set-faces)
d151422c
MR
3570 (let ((standard-output (current-buffer))
3571 (saved-list (make-list 1 0))
3572 sort-fold-case)
3573 ;; First create a sorted list of saved faces.
3574 (mapatoms
3575 (lambda (symbol)
3576 (if (get symbol 'saved-face)
3577 (nconc saved-list (list symbol)))))
3578 (setq saved-list (sort (cdr saved-list) 'string<))
3579 ;; The default face must be first, since it affects the others.
3580 (if (memq 'default saved-list)
3581 (setq saved-list (cons 'default (delq 'default saved-list))))
d543e20b
PA
3582 (unless (bolp)
3583 (princ "\n"))
aec2bb63
DL
3584 (princ "(custom-set-faces
3585 ;; custom-set-faces was added by Custom -- don't edit or cut/paste it!
fda514f7 3586 ;; Your init file should contain only one such instance.\n")
d151422c
MR
3587 (mapcar
3588 (lambda (symbol)
d3d4df42
DL
3589 (let ((value (get symbol 'saved-face))
3590 (now (not (or (get 'default 'face-defface-spec)
3591 (and (not (custom-facep 'default))
3592 (not (get 'default 'force-face))))))
3593 (comment (get 'default 'saved-face-comment)))
d151422c
MR
3594 (unless (eq symbol 'default))
3595 ;; Don't print default face here.
a34511a1
RS
3596 (unless (bolp)
3597 (princ "\n"))
3598 (princ " '(")
d3d4df42 3599 (prin1 symbol)
d151422c
MR
3600 (princ " ")
3601 (prin1 value)
d3d4df42
DL
3602 (cond ((or now comment)
3603 (princ " ")
3604 (if now
3605 (princ "t")
3606 (princ "nil"))
3607 (cond (comment
3608 (princ " ")
3609 (prin1 comment)
3610 (princ ")"))
3611 (t
3612 (princ ")"))))
3613 (t
3614 (princ ")")))))
d151422c 3615 saved-list)
a34511a1
RS
3616 (if (bolp)
3617 (princ " "))
d543e20b
PA
3618 (princ ")")
3619 (unless (looking-at "\n")
3620 (princ "\n")))))
3621
6d528fc5 3622;;;###autoload
f9dd586e 3623(defun customize-save-customized ()
6d528fc5
PA
3624 "Save all user options which have been set in this session."
3625 (interactive)
3626 (mapatoms (lambda (symbol)
3627 (let ((face (get symbol 'customized-face))
d3d4df42
DL
3628 (value (get symbol 'customized-value))
3629 (face-comment (get symbol 'customized-face-comment))
3630 (variable-comment
3631 (get symbol 'customized-variable-comment)))
3632 (when face
6d528fc5
PA
3633 (put symbol 'saved-face face)
3634 (put symbol 'customized-face nil))
d3d4df42 3635 (when value
6d528fc5 3636 (put symbol 'saved-value value)
d3d4df42
DL
3637 (put symbol 'customized-value nil))
3638 (when variable-comment
3639 (put symbol 'saved-variable-comment variable-comment)
3640 (put symbol 'customized-variable-comment nil))
3641 (when face-comment
3642 (put symbol 'saved-face-comment face-comment)
3643 (put symbol 'customized-face-comment nil)))))
6d528fc5
PA
3644 ;; We really should update all custom buffers here.
3645 (custom-save-all))
3646
d543e20b
PA
3647;;;###autoload
3648(defun custom-save-all ()
3649 "Save all customizations in `custom-file'."
4ee1cf9f
PA
3650 (let ((inhibit-read-only t))
3651 (custom-save-variables)
3652 (custom-save-faces)
3653 (save-excursion
fc4d62fe 3654 (let ((default-major-mode nil))
176eb8cb 3655 (set-buffer (find-file-noselect (custom-file))))
4ee1cf9f 3656 (save-buffer))))
d543e20b
PA
3657
3658;;; The Customize Menu.
3659
bd042c03
PA
3660;;; Menu support
3661
25ac13b5
PA
3662(defcustom custom-menu-nesting 2
3663 "Maximum nesting in custom menus."
3664 :type 'integer
6aaedd12 3665 :group 'custom-menu)
d543e20b
PA
3666
3667(defun custom-face-menu-create (widget symbol)
3668 "Ignoring WIDGET, create a menu entry for customization face SYMBOL."
3669 (vector (custom-unlispify-menu-entry symbol)
86bd10bc 3670 `(customize-face ',symbol)
d543e20b
PA
3671 t))
3672
3673(defun custom-variable-menu-create (widget symbol)
3674 "Ignoring WIDGET, create a menu entry for customization variable SYMBOL."
3675 (let ((type (get symbol 'custom-type)))
3676 (unless (listp type)
3677 (setq type (list type)))
3678 (if (and type (widget-get type :custom-menu))
3679 (widget-apply type :custom-menu symbol)
3680 (vector (custom-unlispify-menu-entry symbol)
86bd10bc 3681 `(customize-variable ',symbol)
d543e20b
PA
3682 t))))
3683
bd042c03 3684;; Add checkboxes to boolean variable entries.
d543e20b
PA
3685(widget-put (get 'boolean 'widget-type)
3686 :custom-menu (lambda (widget symbol)
3687 (vector (custom-unlispify-menu-entry symbol)
86bd10bc 3688 `(customize-variable ',symbol)
d543e20b
PA
3689 ':style 'toggle
3690 ':selected symbol)))
3691
d04a3972
DL
3692(defun custom-group-menu-create (widget symbol)
3693 "Ignoring WIDGET, create a menu entry for customization group SYMBOL."
3694 `( ,(custom-unlispify-menu-entry symbol t)
3695 :filter (lambda (&rest junk)
3696 (cdr (custom-menu-create ',symbol)))))
d543e20b 3697
bd042c03
PA
3698;;;###autoload
3699(defun custom-menu-create (symbol)
d543e20b 3700 "Create menu for customization group SYMBOL.
d543e20b 3701The menu is in a format applicable to `easy-menu-define'."
bd042c03 3702 (let* ((item (vector (custom-unlispify-menu-entry symbol)
86bd10bc 3703 `(customize-group ',symbol)
bd042c03
PA
3704 t)))
3705 (if (and (or (not (boundp 'custom-menu-nesting))
3706 (>= custom-menu-nesting 0))
d543e20b
PA
3707 (< (length (get symbol 'custom-group)) widget-menu-max-size))
3708 (let ((custom-prefix-list (custom-prefix-add symbol
25ac13b5 3709 custom-prefix-list))
da5ec617
PA
3710 (members (custom-sort-items (get symbol 'custom-group)
3711 custom-menu-sort-alphabetically
3712 custom-menu-order-groups)))
d543e20b
PA
3713 (custom-load-symbol symbol)
3714 `(,(custom-unlispify-menu-entry symbol t)
3715 ,item
3716 "--"
3717 ,@(mapcar (lambda (entry)
3718 (widget-apply (if (listp (nth 1 entry))
3719 (nth 1 entry)
3720 (list (nth 1 entry)))
3721 :custom-menu (nth 0 entry)))
25ac13b5 3722 members)))
d543e20b
PA
3723 item)))
3724
3725;;;###autoload
bd042c03
PA
3726(defun customize-menu-create (symbol &optional name)
3727 "Return a customize menu for customization group SYMBOL.
d3d4df42 3728If optional NAME is given, use that as the name of the menu.
bd042c03
PA
3729Otherwise the menu will be named `Customize'.
3730The format is suitable for use with `easy-menu-define'."
3731 (unless name
3732 (setq name "Customize"))
d04a3972
DL
3733 `(,name
3734 :filter (lambda (&rest junk)
1751c874 3735 (custom-menu-create ',symbol))))
d543e20b 3736
bd042c03
PA
3737;;; The Custom Mode.
3738
3739(defvar custom-mode-map nil
3740 "Keymap for `custom-mode'.")
b62c92bb 3741
bd042c03 3742(unless custom-mode-map
b92aaee0
SM
3743 ;; This keymap should be dense, but a dense keymap would prevent inheriting
3744 ;; "\r" bindings from the parent map.
3745 (setq custom-mode-map (make-sparse-keymap))
bd042c03 3746 (set-keymap-parent custom-mode-map widget-keymap)
c32de15e 3747 (suppress-keymap custom-mode-map)
b62c92bb
RS
3748 (define-key custom-mode-map " " 'scroll-up)
3749 (define-key custom-mode-map "\177" 'scroll-down)
d3d4df42 3750 (define-key custom-mode-map "q" 'Custom-buffer-done)
0f3335c0 3751 (define-key custom-mode-map "u" 'Custom-goto-parent)
766e15c6
RS
3752 (define-key custom-mode-map "n" 'widget-forward)
3753 (define-key custom-mode-map "p" 'widget-backward)
0f3335c0
RS
3754 (define-key custom-mode-map [mouse-1] 'Custom-move-and-invoke))
3755
3756(defun Custom-move-and-invoke (event)
3757 "Move to where you click, and if it is an active field, invoke it."
3758 (interactive "e")
3759 (mouse-set-point event)
3760 (if (widget-event-point event)
3761 (let* ((pos (widget-event-point event))
3762 (button (get-char-property pos 'button)))
3763 (if button
3764 (widget-button-click event)))))
bd042c03 3765
d3d4df42 3766(easy-menu-define Custom-mode-menu
bd042c03
PA
3767 custom-mode-map
3768 "Menu used in customization buffers."
3769 `("Custom"
944c91b6 3770 ,(customize-menu-create 'customize)
ab678382
RS
3771 ["Set" Custom-set t]
3772 ["Save" Custom-save t]
3773 ["Reset to Current" Custom-reset-current t]
3774 ["Reset to Saved" Custom-reset-saved t]
3775 ["Reset to Standard Settings" Custom-reset-standard t]
2a1c4b90 3776 ["Info" (Info-goto-node "(emacs)Easy Customization") t]))
bd042c03 3777
b62c92bb
RS
3778(defun Custom-goto-parent ()
3779 "Go to the parent group listed at the top of this buffer.
3780If several parents are listed, go to the first of them."
3781 (interactive)
3782 (save-excursion
3783 (goto-char (point-min))
3784 (if (search-forward "\nGo to parent group: " nil t)
3785 (let* ((button (get-char-property (point) 'button))
3786 (parent (downcase (widget-get button :tag))))
3787 (customize-group parent)))))
3788
bd042c03 3789(defcustom custom-mode-hook nil
d3d4df42 3790 "Hook called when entering Custom mode."
bd042c03 3791 :type 'hook
6aaedd12 3792 :group 'custom-buffer )
bd042c03 3793
b62c92bb
RS
3794(defun custom-state-buffer-message (widget)
3795 (if (eq (widget-get (widget-get widget :parent) :custom-state) 'modified)
3796 (message "To install your edits, invoke [State] and choose the Set operation")))
8691cfa7 3797
bd042c03
PA
3798(defun custom-mode ()
3799 "Major mode for editing customization buffers.
3800
3801The following commands are available:
3802
3803Move to next button or editable field. \\[widget-forward]
3804Move to previous button or editable field. \\[widget-backward]
4ee1cf9f
PA
3805\\<widget-field-keymap>\
3806Complete content of editable text field. \\[widget-complete]
3807\\<custom-mode-map>\
0f3335c0 3808Invoke button under the mouse pointer. \\[Custom-move-and-invoke]
25ac13b5 3809Invoke button under point. \\[widget-button-press]
ab678382
RS
3810Set all modifications. \\[Custom-set]
3811Make all modifications default. \\[Custom-save]
3812Reset all modified options. \\[Custom-reset-current]
3813Reset all modified or set options. \\[Custom-reset-saved]
3814Reset all options. \\[Custom-reset-standard]
bd042c03
PA
3815
3816Entry to this mode calls the value of `custom-mode-hook'
3817if that value is non-nil."
3818 (kill-all-local-variables)
3819 (setq major-mode 'custom-mode
3820 mode-name "Custom")
3821 (use-local-map custom-mode-map)
ab678382 3822 (easy-menu-add Custom-mode-menu)
bd042c03 3823 (make-local-variable 'custom-options)
b62c92bb
RS
3824 (make-local-variable 'widget-documentation-face)
3825 (setq widget-documentation-face 'custom-documentation-face)
3aec85bf
RS
3826 (make-local-variable 'widget-button-face)
3827 (setq widget-button-face 'custom-button-face)
d3d4df42
DL
3828 (set (make-local-variable 'widget-button-pressed-face)
3829 'custom-button-pressed-face)
3830 (set (make-local-variable 'widget-mouse-face)
3831 'custom-button-pressed-face) ; buttons `depress' when moused
3832 ;; When possible, use relief for buttons, not bracketing. This test
3833 ;; may not be optimal.
3834 (when custom-raised-buttons
3835 (set (make-local-variable 'widget-push-button-prefix) "")
3836 (set (make-local-variable 'widget-push-button-suffix) "")
3837 (set (make-local-variable 'widget-link-prefix) "")
3838 (set (make-local-variable 'widget-link-suffix) ""))
b62c92bb 3839 (add-hook 'widget-edit-functions 'custom-state-buffer-message nil t)
bd042c03 3840 (run-hooks 'custom-mode-hook))
d543e20b 3841
7f352f86
DL
3842(put 'custom-mode 'mode-class 'special)
3843
2365594b
DL
3844(add-to-list
3845 'debug-ignored-errors
3846 "^No user options have changed defaults in recent Emacs versions$")
3847
d543e20b
PA
3848;;; The End.
3849
3850(provide 'cus-edit)
3851
d3d4df42 3852;;; cus-edit.el ends here