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