1 ;;; cus-edit.el --- Tools for customizating Emacs and Lisp packages.
3 ;; Copyright (C) 1996, 1997, 2000 Free Software Foundation, Inc.
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Maintainer: Hrvoje Niksic <hniksic@xemacs.org>
7 ;; Keywords: help, faces
9 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
11 ;; This file is part of XEmacs.
13 ;; XEmacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; XEmacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with XEmacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; This file implements the code to create and edit customize buffers.
34 ;; No commands should have names starting with `custom-' because
35 ;; that interferes with completion. Use `customize-' for commands
36 ;; that the user will run with M-x, and `Custom-' for interactive commands.
38 ;; NOTE: In many places within this file we use `mapatoms', which is
39 ;; very slow in an average XEmacs because of the large number of
40 ;; symbols requiring a large number of funcalls -- XEmacs with Gnus
41 ;; can grow to some 17000 symbols without ever doing anything fancy.
42 ;; It would probably pay off to make a hash table of symbols known to
43 ;; Custom, similar to custom-group-hash-table.
45 ;; This is not top priority, because none of the functions that do
46 ;; mapatoms are speed-critical (the one that was now uses
47 ;; custom-group-hash-table), but it would be nice to have.
59 ;; Huh? This looks dirty!
60 (put 'custom-define-hook 'custom-type 'hook)
61 (put 'custom-define-hook 'standard-value '(nil))
62 (custom-add-to-group 'customize 'custom-define-hook 'custom-variable)
64 ;;; Customization Groups.
67 "Customization of the One True Editor."
68 :link '(custom-manual "(XEmacs)Top"))
70 ;; Most of these groups are stolen from `finder.el',
72 "Basic text editing facilities."
75 (defgroup matching nil
76 "Various sorts of searching and matching."
79 (defgroup emulations nil
80 "Emulations of other editors."
83 (defgroup outlines nil
84 "Support for hierarchical outlining."
87 (defgroup external nil
88 "Interfacing to external utilities."
92 "Code related to the `bib' bibliography processor."
96 (defgroup programming nil
97 "Support for programming in other languages."
100 (defgroup languages nil
101 "Specialized modes for editing programming languages."
104 ;; #### This should be in cc-vars.el
106 "Support for the C language and related languages."
114 "Support for object-oriented programming."
117 (defgroup applications nil
118 "Applications written in Emacs."
121 ;; #### This should be in calendar.el
122 (defgroup calendar nil
123 "Calendar and time management support."
124 :group 'applications)
127 "Modes for electronic-mail handling."
128 :group 'applications)
131 "Support for netnews reading and posting."
132 :group 'applications)
135 "Games, jokes and amusements."
136 :group 'applications)
138 (defgroup development nil
139 "Support for further development of Emacs."
143 "Support for Emacs documentation."
146 (defgroup extensions nil
147 "Emacs Lisp language extensions."
150 (defgroup internal nil
151 "Code for Emacs internals, build process, defaults."
155 "Maintenance aids for the Emacs development group."
159 (defgroup environment nil
160 "Fitting Emacs with its environment."
164 "Communications, networking, remote access to files."
168 (defgroup hardware nil
169 "Support for interfacing with exotic hardware."
172 (defgroup terminals nil
173 "Support for terminal types."
177 "Front-ends/assistants for, or emulators of, UNIX features."
181 "Internationalization and alternate character-set support."
186 "Support editing files of data."
194 "Code related to the TeX formatter."
197 (defgroup hypermedia nil
198 "Support for links between text or other media types."
202 "Code local to your site."
205 (defgroup customize '((widgets custom-group))
206 "Customization of the Customization support."
207 :link '(custom-manual "(custom)Top")
208 :link '(url-link :tag "Development Page"
209 "http://www.dina.kvl.dk/~abraham/custom/")
213 (defgroup custom-faces nil
214 "Faces used by customize."
218 (defgroup custom-browse nil
219 "Control customize browser."
223 (defgroup custom-buffer nil
224 "Control customize buffers."
228 (defgroup custom-menu nil
229 "Control customize menus."
234 "Storage allocation and gc for GNU Emacs Lisp interpreter."
235 :tag "Storage Allocation"
239 "Undoing changes in buffers."
242 (defgroup editing-basics nil
243 "Most basic editing facilities."
246 (defgroup display nil
247 "How characters are displayed in buffers."
250 (defgroup installation nil
251 "The Emacs installation."
255 "Internal Emacs limits."
259 "Debugging Emacs itself."
263 "Mule XEmacs internationalization."
269 (defun custom-quote (sexp)
270 "Quote SEXP iff it is not self quoting."
271 (if (or (memq sexp '(t nil))
273 (eq (car-safe sexp) 'lambda)
282 (defun custom-split-regexp-maybe (regexp)
283 "If REGEXP is a string, split it to a list at `\\|'.
284 You can get the original back with from the result with:
285 (mapconcat #'identity result \"\\|\")
287 IF REGEXP is not a string, return it unchanged."
289 (split-string regexp "\\\\|")
292 (defun custom-variable-prompt ()
293 ;; Code stolen from `help.el'.
294 "Prompt for a variable, defaulting to the variable at point.
295 Return a list suitable for use in `interactive'."
296 (let ((v (variable-at-point))
297 (enable-recursive-minibuffers t)
299 (setq val (completing-read
301 (format "Customize variable: (default %s) " v)
302 "Customize variable: ")
303 obarray (lambda (symbol)
305 (or (get symbol 'custom-type)
306 (user-variable-p symbol)))) t))
307 (list (if (equal val "")
308 (if (symbolp v) v nil)
311 ;; Here we take not only the actual groups, but the loads, too.
312 (defun custom-group-prompt (prompt)
313 "Read group from minibuffer."
314 (let ((completion-ignore-case t))
315 (list (completing-read
318 (or (get symbol 'custom-group)
319 (get symbol 'custom-loads)))
322 (defun custom-menu-filter (menu widget)
323 "Convert MENU to the form used by `widget-choose'.
324 MENU should be in the same format as `custom-variable-menu'.
325 WIDGET is the widget to apply the filter entries of MENU on."
327 current name action filter)
329 (setq current (car menu)
331 action (nth 1 current)
332 filter (nth 2 current)
334 (if (or (null filter) (funcall filter widget))
335 (push (cons name action) result)
342 (defvar custom-prefix-list nil
343 "List of prefixes that should be ignored by `custom-unlispify'")
345 (defcustom custom-unlispify-menu-entries t
346 "Display menu entries as words instead of symbols if non nil."
350 (defcustom custom-unlispify-remove-prefixes t
351 "Non-nil means remove group prefixes from option names in buffers and menus.
352 This only has an effect when `custom-unlispify-tag-names' or
353 `custom-unlispify-menu-entries' is on."
357 (defun custom-unlispify-menu-entry (symbol &optional no-suffix)
358 "Convert symbol into a menu entry."
359 (cond ((not custom-unlispify-menu-entries)
360 (symbol-name symbol))
361 ((get symbol 'custom-tag)
363 (get symbol 'custom-tag)
364 (concat (get symbol 'custom-tag) "...")))
366 (with-current-buffer (get-buffer-create " *Custom-Work*")
368 (princ symbol (current-buffer))
369 (goto-char (point-min))
370 (when (and (eq (get symbol 'custom-type) 'boolean)
371 (re-search-forward "-p\\'" nil t))
372 (replace-match "" t t)
373 (goto-char (point-min)))
374 (when custom-unlispify-remove-prefixes
375 (let ((prefixes custom-prefix-list)
378 (setq prefix (car prefixes))
379 (if (search-forward prefix (+ (point) (length prefix)) t)
382 (delete-region (point-min) (point)))
383 (setq prefixes (cdr prefixes))))))
384 (subst-char-in-region (point-min) (point-max) ?- ?\ t)
385 (capitalize-region (point-min) (point-max))
387 (goto-char (point-max))
391 (defcustom custom-unlispify-tag-names t
392 "Display tag names as words instead of symbols if non nil."
393 :group 'custom-buffer
396 (defun custom-unlispify-tag-name (symbol)
397 "Convert symbol into a menu entry."
398 (let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
399 (custom-unlispify-menu-entry symbol t)))
401 (defun custom-prefix-add (symbol prefixes)
402 ;; Addd SYMBOL to list of ignored PREFIXES.
403 (cons (or (get symbol 'custom-prefix)
404 (concat (symbol-name symbol) "-"))
410 (defcustom custom-guess-name-alist
415 ("-function\\'" function)
416 ("-functions\\'" (repeat function))
417 ("-list\\'" (repeat sexp))
418 ("-alist\\'" (repeat (cons sexp sexp))))
419 "Alist of (MATCH TYPE).
421 MATCH should be a regexp matching the name of a symbol, and TYPE should
422 be a widget suitable for editing the value of that symbol. The TYPE
423 of the first entry where MATCH matches the name of the symbol will be
426 This is used for guessing the type of variables not declared with
428 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
431 (defcustom custom-guess-doc-alist
432 '(("\\`\\*?Non-nil " boolean))
433 "Alist of (MATCH TYPE).
435 MATCH should be a regexp matching a documentation string, and TYPE
436 should be a widget suitable for editing the value of a variable with
437 that documentation string. The TYPE of the first entry where MATCH
438 matches the name of the symbol will be used.
440 This is used for guessing the type of variables not declared with
442 :type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
445 (defun custom-guess-type (symbol)
446 "Guess a widget suitable for editing the value of SYMBOL.
447 This is done by matching SYMBOL with `custom-guess-name-alist' and
448 if that fails, the doc string with `custom-guess-doc-alist'."
449 (let ((name (symbol-name symbol))
450 (names custom-guess-name-alist)
453 (setq current (car names)
455 (when (string-match (nth 0 current) name)
456 (setq found (nth 1 current)
459 (let ((doc (documentation-property symbol 'variable-documentation))
460 (docs custom-guess-doc-alist))
463 (setq current (car docs)
465 (when (string-match (nth 0 current) doc)
466 (setq found (nth 1 current)
473 (defcustom custom-browse-sort-alphabetically nil
474 "If non-nil, sort members of each customization group alphabetically."
476 :group 'custom-browse)
478 (defcustom custom-browse-order-groups nil
479 "If non-nil, order group members within each customization group.
480 If `first', order groups before non-groups.
481 If `last', order groups after non-groups."
482 :type '(choice (const first)
484 (const :tag "none" nil))
485 :group 'custom-browse)
487 (defcustom custom-browse-only-groups nil
488 "If non-nil, show group members only within each customization group."
490 :group 'custom-browse)
492 (defcustom custom-buffer-sort-alphabetically nil
493 "If non-nil, sort members of each customization group alphabetically."
495 :group 'custom-buffer)
497 (defcustom custom-buffer-order-groups 'last
498 "If non-nil, order group members within each customization group.
499 If `first', order groups before non-groups.
500 If `last', order groups after non-groups."
501 :type '(choice (const first)
503 (const :tag "none" nil))
504 :group 'custom-buffer)
506 (defcustom custom-menu-sort-alphabetically nil
507 "If non-nil, sort members of each customization group alphabetically."
511 (defcustom custom-menu-order-groups 'first
512 "If non-nil, order group members within each customization group.
513 If `first', order groups before non-groups.
514 If `last', order groups after non-groups."
515 :type '(choice (const first)
517 (const :tag "none" nil))
520 (defun custom-sort-items (items sort-alphabetically order-groups)
521 "Return a sorted copy of ITEMS.
522 ITEMS should be a `custom-group' property.
523 If SORT-ALPHABETICALLY non-nil, sort alphabetically.
524 If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
525 groups after non-groups, if nil do not order groups at all."
526 (sort (copy-sequence items)
528 (let ((typea (nth 1 a)) (typeb (nth 1 b))
529 (namea (symbol-name (nth 0 a))) (nameb (symbol-name (nth 0 b))))
530 (cond ((not order-groups)
531 ;; Since we don't care about A and B order, maybe sort.
532 (when sort-alphabetically
533 (string-lessp namea nameb)))
534 ((eq typea 'custom-group)
535 ;; If B is also a group, maybe sort. Otherwise, order A and B.
536 (if (eq typeb 'custom-group)
537 (when sort-alphabetically
538 (string-lessp namea nameb))
539 (eq order-groups 'first)))
540 ((eq typeb 'custom-group)
541 ;; Since A cannot be a group, order A and B.
542 (eq order-groups 'last))
544 ;; Since A and B cannot be groups, sort.
545 (string-lessp namea nameb)))))))
548 ;;; Custom Mode Commands.
550 (defvar custom-options nil
551 "Customization widgets in the current buffer.")
554 "Set changes in all modified options."
556 (let ((children custom-options))
557 (mapc (lambda (child)
558 (when (eq (widget-get child :custom-state) 'modified)
559 (widget-apply child :custom-set)))
562 (defun Custom-save ()
563 "Set all modified group members and save them."
565 (let ((children custom-options))
566 (mapc (lambda (child)
567 (when (memq (widget-get child :custom-state) '(modified set))
568 (widget-apply child :custom-save)))
572 (defvar custom-reset-menu
573 '(("Current" . Custom-reset-current)
574 ("Saved" . Custom-reset-saved)
575 ("Standard Settings" . Custom-reset-standard))
576 "Alist of actions for the `Reset' button.
577 The key is a string containing the name of the action, the value is a
578 lisp function taking the widget as an element which will be called
579 when the action is chosen.")
581 (defun custom-reset (event)
582 "Select item from reset menu."
583 (let* ((completion-ignore-case t)
584 (answer (widget-choose "Reset to"
590 (defun Custom-reset-current (&rest ignore)
591 "Reset all modified group members to their current value."
593 (let ((children custom-options))
594 (mapc (lambda (child)
595 (when (eq (widget-get child :custom-state) 'modified)
596 (widget-apply child :custom-reset-current)))
599 (defun Custom-reset-saved (&rest ignore)
600 "Reset all modified or set group members to their saved value."
602 (let ((children custom-options))
603 (mapc (lambda (child)
604 (when (eq (widget-get child :custom-state) 'modified)
605 (widget-apply child :custom-reset-saved)))
608 (defun Custom-reset-standard (&rest ignore)
609 "Reset all modified, set, or saved group members to their standard settings."
611 (let ((children custom-options))
612 (mapc (lambda (child)
613 (when (eq (widget-get child :custom-state) 'modified)
614 (widget-apply child :custom-reset-standard)))
618 ;;; The Customize Commands
620 (defun custom-prompt-variable (prompt-var prompt-val &optional comment)
621 "Prompt for a variable and a value and return them as a list.
622 PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
623 prompt for the value. The %s escape in PROMPT-VAL is replaced with
624 the name of the variable.
626 If the variable has a `variable-interactive' property, that is used as if
627 it were the arg to `interactive' (which see) to interactively read the value.
629 If the variable has a `custom-type' property, it must be a widget and the
630 `:prompt-value' property of that widget will be used for reading the value.
632 If optional COMMENT argument is non nil, also prompt for a comment and return
633 it as the third element in the list."
634 (let* ((var (read-variable prompt-var))
635 (minibuffer-help-form '(describe-variable var))
637 (let ((prop (get var 'variable-interactive))
638 (type (get var 'custom-type))
639 (prompt (format prompt-val var)))
641 (setq type (list type)))
643 ;; Use VAR's `variable-interactive' property
644 ;; as an interactive spec for prompting.
645 (call-interactively (list 'lambda '(arg)
646 (list 'interactive prop)
649 (widget-prompt-value type
655 (eval-minibuffer prompt))))))
658 (read-string "Comment: " (get var 'variable-comment)))
663 (defun customize-set-value (var val &optional comment)
664 "Set VARIABLE to VALUE. VALUE is a Lisp object.
666 If VARIABLE has a `variable-interactive' property, that is used as if
667 it were the arg to `interactive' (which see) to interactively read the value.
669 If VARIABLE has a `custom-type' property, it must be a widget and the
670 `:prompt-value' property of that widget will be used for reading the value.
672 If given a prefix (or a COMMENT argument), also prompt for a comment."
673 (interactive (custom-prompt-variable "Set variable: "
678 (cond ((string= comment "")
679 (put var 'variable-comment nil))
681 (put var 'variable-comment comment))))
684 (defun customize-set-variable (var val &optional comment)
685 "Set the default for VARIABLE to VALUE. VALUE is a Lisp object.
687 If VARIABLE has a `custom-set' property, that is used for setting
688 VARIABLE, otherwise `set-default' is used.
690 The `customized-value' property of the VARIABLE will be set to a list
691 with a quoted VALUE as its sole list member.
693 If VARIABLE has a `variable-interactive' property, that is used as if
694 it were the arg to `interactive' (which see) to interactively read the value.
696 If VARIABLE has a `custom-type' property, it must be a widget and the
697 `:prompt-value' property of that widget will be used for reading the value.
699 If given a prefix (or a COMMENT argument), also prompt for a comment."
700 (interactive (custom-prompt-variable "Set variable: "
701 "Set customized value for %s to: "
703 (funcall (or (get var 'custom-set) 'set-default) var val)
704 (put var 'customized-value (list (custom-quote val)))
705 (cond ((string= comment "")
706 (put var 'variable-comment nil)
707 (put var 'customized-variable-comment nil))
709 (put var 'variable-comment comment)
710 (put var 'customized-variable-comment comment))))
714 (defun customize-save-variable (var val &optional comment)
715 "Set the default for VARIABLE to VALUE, and save it for future sessions.
716 If VARIABLE has a `custom-set' property, that is used for setting
717 VARIABLE, otherwise `set-default' is used.
719 The `customized-value' property of the VARIABLE will be set to a list
720 with a quoted VALUE as its sole list member.
722 If VARIABLE has a `variable-interactive' property, that is used as if
723 it were the arg to `interactive' (which see) to interactively read the value.
725 If VARIABLE has a `custom-type' property, it must be a widget and the
726 `:prompt-value' property of that widget will be used for reading the value.
728 If given a prefix (or a COMMENT argument), also prompt for a comment."
729 (interactive (custom-prompt-variable "Set and ave variable: "
730 "Set and save value for %s as: "
732 (funcall (or (get var 'custom-set) 'set-default) var val)
733 (put var 'saved-value (list (custom-quote val)))
734 (custom-push-theme 'theme-value var 'user 'set (list (custom-quote val)))
735 (cond ((string= comment "")
736 (put var 'variable-comment nil)
737 (put var 'saved-variable-comment nil))
739 (put var 'variable-comment comment)
740 (put var 'saved-variable-comment comment)))
744 (defun customize (group)
745 "Select a customization buffer which you can use to set user options.
746 User options are structured into \"groups\".
747 The default group is `Emacs'."
748 (interactive (custom-group-prompt
749 "Customize group: (default emacs) "))
750 (when (stringp group)
751 (if (string-equal "" group)
753 (setq group (intern group))))
754 (let ((name (format "*Customize Group: %s*"
755 (custom-unlispify-tag-name group))))
756 (if (get-buffer name)
757 (switch-to-buffer name)
758 (custom-buffer-create (list (list group 'custom-group))
760 (concat " for group "
761 (custom-unlispify-tag-name group))))))
764 (defalias 'customize-group 'customize)
767 (defun customize-other-window (symbol)
768 "Customize SYMBOL, which must be a customization group."
769 (interactive (custom-group-prompt
770 "Customize group: (default emacs) "))
771 (when (stringp symbol)
772 (if (string-equal "" symbol)
774 (setq symbol (intern symbol))))
775 (custom-buffer-create-other-window
776 (list (list symbol 'custom-group))
777 (format "*Customize Group: %s*" (custom-unlispify-tag-name symbol))))
780 (defalias 'customize-group-other-window 'customize-other-window)
783 (defalias 'customize-option 'customize-variable)
786 (defun customize-variable (symbol)
787 "Customize SYMBOL, which must be a user option variable."
788 (interactive (custom-variable-prompt))
789 (custom-buffer-create (list (list symbol 'custom-variable))
790 (format "*Customize Variable: %s*"
791 (custom-unlispify-tag-name symbol))))
794 (defun customize-changed-options (since-version)
795 "Customize all user option variables whose default values changed recently.
796 This means, in other words, variables defined with a `:version' keyword."
797 (interactive "sCustomize options changed, since version (default all versions): ")
798 (if (equal since-version "")
799 (setq since-version nil))
801 (mapatoms (lambda (symbol)
803 (let ((version (get symbol 'custom-version)))
805 (or (null since-version)
806 (customize-version-lessp since-version version))))
807 (push (list symbol 'custom-variable) found))))
809 (error "No user options have changed defaults %s"
811 (format "since XEmacs %s" since-version)
812 "in recent Emacs versions")))
813 (custom-buffer-create (custom-sort-items found t nil)
814 "*Customize Changed Options*")))
816 (defun customize-version-lessp (version1 version2)
817 (let (major1 major2 minor1 minor2)
818 (string-match "\\([0-9]+\\)[.]\\([0-9]+\\)" version1)
819 (setq major1 (read (match-string 1 version1)))
820 (setq minor1 (read (match-string 2 version1)))
821 (string-match "\\([0-9]+\\)[.]\\([0-9]+\\)" version2)
822 (setq major2 (read (match-string 1 version2)))
823 (setq minor2 (read (match-string 2 version2)))
824 (or (< major1 major2)
825 (and (= major1 major2)
826 (< minor1 minor2)))))
829 (defalias 'customize-variable-other-window 'customize-option-other-window)
832 (defun customize-option-other-window (symbol)
833 "Customize SYMBOL, which must be a user option variable.
834 Show the buffer in another window, but don't select it."
835 (interactive (custom-variable-prompt))
836 (custom-buffer-create-other-window
837 (list (list symbol 'custom-variable))
838 (format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
841 (defun customize-face (&optional symbol)
842 "Customize SYMBOL, which should be a face name or nil.
843 If SYMBOL is nil, customize all faces."
844 (interactive (list (completing-read "Customize face: (default all) "
845 obarray 'find-face)))
846 (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
847 (custom-buffer-create (custom-sort-items
848 (mapcar (lambda (symbol)
849 (list symbol 'custom-face))
853 (when (stringp symbol)
854 (setq symbol (intern symbol)))
855 (check-argument-type 'symbolp symbol)
856 (custom-buffer-create (list (list symbol 'custom-face))
857 (format "*Customize Face: %s*"
858 (custom-unlispify-tag-name symbol)))))
861 (defun customize-face-other-window (&optional symbol)
862 "Show customization buffer for FACE in other window."
863 (interactive (list (completing-read "Customize face: "
864 obarray 'find-face)))
865 (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
868 (setq symbol (intern symbol)))
869 (check-argument-type 'symbolp symbol)
870 (custom-buffer-create-other-window
871 (list (list symbol 'custom-face))
872 (format "*Customize Face: %s*" (custom-unlispify-tag-name symbol)))))
875 (defun customize-customized ()
876 "Customize all user options set since the last save in this session."
879 (mapatoms (lambda (symbol)
880 (and (or (get symbol 'customized-face)
881 (get symbol 'customized-face-comment))
883 (push (list symbol 'custom-face) found))
884 (and (or (get symbol 'customized-value)
885 (get symbol 'customized-variable-comment))
887 (push (list symbol 'custom-variable) found))))
889 (error "No customized user options")
890 (custom-buffer-create (custom-sort-items found t nil)
891 "*Customize Customized*"))))
894 (defun customize-saved ()
895 "Customize all already saved user options."
898 (mapatoms (lambda (symbol)
899 (and (or (get symbol 'saved-face)
900 (get symbol 'saved-face-comment))
902 (push (list symbol 'custom-face) found))
903 (and (or (get symbol 'saved-value)
904 (get symbol 'saved-variable-comment))
906 (push (list symbol 'custom-variable) found))))
908 (error "No saved user options")
909 (custom-buffer-create (custom-sort-items found t nil)
910 "*Customize Saved*"))))
913 (defun customize-apropos (regexp &optional all)
914 "Customize all user options matching REGEXP.
915 If ALL is `options', include only options.
916 If ALL is `faces', include only faces.
917 If ALL is `groups', include only groups.
918 If ALL is t (interactively, with prefix arg), include options which are not
919 user-settable, as well as faces and groups."
920 (interactive "sCustomize regexp: \nP")
922 (mapatoms (lambda (symbol)
923 (when (string-match regexp (symbol-name symbol))
924 (when (and (not (memq all '(faces options)))
925 (get symbol 'custom-group))
926 (push (list symbol 'custom-group) found))
927 (when (and (not (memq all '(options groups)))
929 (push (list symbol 'custom-face) found))
930 (when (and (not (memq all '(groups faces)))
932 (or (get symbol 'saved-value)
933 (get symbol 'standard-value)
934 (if (memq all '(nil options))
935 (user-variable-p symbol)
936 (get symbol 'variable-documentation))))
937 (push (list symbol 'custom-variable) found)))))
940 (custom-buffer-create (custom-sort-items found t
941 custom-buffer-order-groups)
942 "*Customize Apropos*"))))
945 (defun customize-apropos-options (regexp &optional arg)
946 "Customize all user options matching REGEXP.
947 With prefix arg, include options which are not user-settable."
948 (interactive "sCustomize regexp: \nP")
949 (customize-apropos regexp (or arg 'options)))
952 (defun customize-apropos-faces (regexp)
953 "Customize all user faces matching REGEXP."
954 (interactive "sCustomize regexp: \n")
955 (customize-apropos regexp 'faces))
958 (defun customize-apropos-groups (regexp)
959 "Customize all user groups matching REGEXP."
960 (interactive "sCustomize regexp: \n")
961 (customize-apropos regexp 'groups))
966 (defcustom custom-buffer-style 'links
967 "*Control the presentation style for customization buffers.
968 The value should be a symbol, one of:
970 brackets: groups nest within each other with big horizontal brackets.
971 links: groups have links to subgroups."
972 :type '(radio (const :tag "brackets: Groups nest within each others" brackets)
973 (const :tag "links: Group have links to subgroups" links))
974 :group 'custom-buffer)
976 (defcustom custom-buffer-done-function 'kill-buffer
977 "*Function to be used to remove the buffer when the user is done with it.
978 Choices include `kill-buffer' (the default) and `bury-buffer'.
979 The function will be called with one argument, the buffer to remove."
980 :type '(radio (function-item kill-buffer)
981 (function-item bury-buffer)
982 (function :tag "Other" nil))
983 :group 'custom-buffer)
985 (defcustom custom-buffer-indent 3
986 "Number of spaces to indent nested groups."
988 :group 'custom-buffer)
991 (defun custom-buffer-create (options &optional name description)
992 "Create a buffer containing OPTIONS.
993 Optional NAME is the name of the buffer.
994 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
995 SYMBOL is a customization option, and WIDGET is a widget for editing
997 (unless name (setq name "*Customization*"))
998 (kill-buffer (get-buffer-create name))
999 (switch-to-buffer (get-buffer-create name))
1000 (custom-buffer-create-internal options description))
1003 (defun custom-buffer-create-other-window (options &optional name description)
1004 "Create a buffer containing OPTIONS.
1005 Optional NAME is the name of the buffer.
1006 OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
1007 SYMBOL is a customization option, and WIDGET is a widget for editing
1009 (unless name (setq name "*Customization*"))
1010 (kill-buffer (get-buffer-create name))
1011 (let ((window (selected-window)))
1012 (switch-to-buffer-other-window (get-buffer-create name))
1013 (custom-buffer-create-internal options description)
1014 (select-window window)))
1016 (defcustom custom-reset-button-menu t
1017 "If non-nil, only show a single reset button in customize buffers.
1018 This button will have a menu with all three reset operations."
1020 :group 'custom-buffer)
1022 (defconst custom-skip-messages 5)
1024 (defun Custom-buffer-done ()
1025 "Remove current buffer.
1026 This works by calling the function specified by
1027 `custom-buffer-done-function'."
1029 (funcall custom-buffer-done-function (current-buffer)))
1031 (defun custom-buffer-create-buttons ()
1032 (message "Creating customization buttons...")
1033 (widget-insert "\nOperate on everything in this buffer:\n ")
1034 (widget-create 'push-button
1037 Make your editing in this buffer take effect for this session"
1038 :action (lambda (widget &optional event)
1041 (widget-create 'push-button
1044 Make your editing in this buffer take effect for future Emacs sessions"
1045 :action (lambda (widget &optional event)
1047 (if custom-reset-button-menu
1050 (widget-create 'push-button
1052 :tag-glyph '("reset-up" "reset-down")
1053 :help-echo "Show a menu with reset operations"
1054 :mouse-down-action (lambda (&rest junk) t)
1055 :action (lambda (widget &optional event)
1056 (custom-reset event))))
1058 (widget-create 'push-button
1061 Reset all edited text in this buffer to reflect current values"
1062 :action 'Custom-reset-current)
1064 (widget-create 'push-button
1065 :tag "Reset to Saved"
1067 Reset all values in this buffer to their saved settings"
1068 :action 'Custom-reset-saved)
1070 (widget-create 'push-button
1071 :tag "Reset to Standard"
1073 Reset all values in this buffer to their standard settings"
1074 :action 'Custom-reset-standard))
1076 (widget-create 'push-button
1078 :help-echo "Remove the buffer"
1079 :action (lambda (widget &optional event)
1080 (Custom-buffer-done)))
1081 (widget-insert "\n"))
1083 (defcustom custom-novice t
1084 "If non-nil, show help message at top of customize buffers."
1086 :group 'custom-buffer)
1088 (defcustom custom-display-global-buttons 'top
1089 "If `nil' don't display the global buttons. If `top' display at the
1090 beginning of custom buffers. If `bottom', display at the end."
1091 :type '(choice (const top)
1093 (const :tag "don't" nil))
1094 :group 'custom-buffer)
1096 (defun custom-buffer-create-internal (options &optional description)
1097 (message "Creating customization buffer...")
1099 (widget-insert "This is a customization buffer")
1101 (widget-insert description))
1103 (widget-insert ".\n\
1104 Type RET or click button2 on an active field to invoke its action.
1106 (widget-create 'info-link
1108 :help-echo "Read the online help"
1109 "(XEmacs)Easy Customization")
1110 (widget-insert " for more information."))
1111 (widget-insert "\n")
1112 (if (equal custom-display-global-buttons 'top)
1113 (custom-buffer-create-buttons))
1114 (widget-insert "\n")
1115 (message "Creating customization items...")
1116 (setq custom-options
1117 (if (= (length options) 1)
1118 (mapcar (lambda (entry)
1119 (widget-create (nth 1 entry)
1120 :documentation-shown t
1121 :custom-state 'unknown
1122 :tag (custom-unlispify-tag-name
1124 :value (nth 0 entry)))
1127 (length (length options)))
1128 (mapcar (lambda (entry)
1132 (format "Creating customization items %2d%%..."
1133 (/ (* 100.0 count) length)))
1134 (widget-create (nth 1 entry)
1135 :tag (custom-unlispify-tag-name
1137 :value (nth 0 entry))
1139 (unless (eq (preceding-char) ?\n)
1140 (widget-insert "\n"))
1141 (widget-insert "\n")))
1143 (unless (eq (preceding-char) ?\n)
1144 (widget-insert "\n"))
1145 (if (equal custom-display-global-buttons 'bottom)
1146 (custom-buffer-create-buttons))
1147 (display-message 'progress
1149 "Creating customization items %2d%%...done" 100))
1150 (unless (eq custom-buffer-style 'tree)
1151 (mapc 'custom-magic-reset custom-options))
1152 (message "Creating customization setup...")
1154 (goto-char (point-min))
1155 (message "Creating customization buffer...done"))
1158 ;;; The Tree Browser.
1161 (defun customize-browse (&optional group)
1162 "Create a tree browser for the customize hierarchy."
1165 (setq group 'emacs))
1166 (let ((name "*Customize Browser*"))
1167 (kill-buffer (get-buffer-create name))
1168 (switch-to-buffer (get-buffer-create name)))
1171 Square brackets show active fields; type RET or click button2
1172 on an active field to invoke its action.
1173 Invoke [+] below to expand a group, and [-] to collapse an expanded group.\n")
1174 (if custom-browse-only-groups
1176 Invoke the [Group] button below to edit that item in another window.\n\n")
1177 (widget-insert "Invoke the ")
1178 (widget-create 'item
1181 :tag-glyph "folder")
1182 (widget-insert ", ")
1183 (widget-create 'item
1187 (widget-insert ", and ")
1188 (widget-create 'item
1191 :tag-glyph "option")
1192 (widget-insert " buttons below to edit that
1193 item in another window.\n\n"))
1194 (let ((custom-buffer-style 'tree))
1195 (widget-create 'custom-group
1197 :custom-state 'unknown
1198 :tag (custom-unlispify-tag-name group)
1201 (goto-char (point-min)))
1203 (define-widget 'custom-browse-visibility 'item
1204 "Control visibility of of items in the customize tree browser."
1206 :action 'custom-browse-visibility-action)
1208 (defun custom-browse-visibility-action (widget &rest ignore)
1209 (let ((custom-buffer-style 'tree))
1210 (custom-toggle-parent widget)))
1212 (define-widget 'custom-browse-group-tag 'push-button
1213 "Show parent in other window when activated."
1216 :action 'custom-browse-group-tag-action)
1218 (defun custom-browse-group-tag-action (widget &rest ignore)
1219 (let ((parent (widget-get widget :parent)))
1220 (customize-group-other-window (widget-value parent))))
1222 (define-widget 'custom-browse-variable-tag 'push-button
1223 "Show parent in other window when activated."
1226 :action 'custom-browse-variable-tag-action)
1228 (defun custom-browse-variable-tag-action (widget &rest ignore)
1229 (let ((parent (widget-get widget :parent)))
1230 (customize-variable-other-window (widget-value parent))))
1232 (define-widget 'custom-browse-face-tag 'push-button
1233 "Show parent in other window when activated."
1236 :action 'custom-browse-face-tag-action)
1238 (defun custom-browse-face-tag-action (widget &rest ignore)
1239 (let ((parent (widget-get widget :parent)))
1240 (customize-face-other-window (widget-value parent))))
1242 (defconst custom-browse-alist '((" " "space")
1248 (defun custom-browse-insert-prefix (prefix)
1249 "Insert PREFIX. On XEmacs convert it to line graphics."
1251 (if nil ; (string-match "XEmacs" emacs-version)
1254 (while (not (string-equal prefix ""))
1255 (let ((entry (substring prefix 0 3)))
1256 (setq prefix (substring prefix 3))
1257 (let ((overlay (make-overlay (1- (point)) (point) nil t nil))
1258 (name (nth 1 (assoc entry custom-browse-alist))))
1259 (overlay-put overlay 'end-glyph (widget-glyph-find name entry))
1260 (overlay-put overlay 'start-open t)
1261 (overlay-put overlay 'end-open t)))))
1265 ;;; Modification of Basic Widgets.
1267 ;; We add extra properties to the basic widgets needed here. This is
1268 ;; fine, as long as we are careful to stay within out own namespace.
1270 ;; We want simple widgets to be displayed by default, but complex
1271 ;; widgets to be hidden.
1273 (widget-put (get 'item 'widget-type) :custom-show t)
1274 (widget-put (get 'editable-field 'widget-type)
1275 :custom-show (lambda (widget value)
1276 ;; This used to call pp-to-string
1277 (let ((pp (widget-prettyprint-to-string value)))
1278 (cond ((string-match "\n" pp)
1283 (widget-put (get 'menu-choice 'widget-type) :custom-show t)
1285 ;;; The `custom-manual' Widget.
1287 (define-widget 'custom-manual 'info-link
1288 "Link to the manual entry for this customization option."
1291 ;;; The `custom-magic' Widget.
1293 (defgroup custom-magic-faces nil
1294 "Faces used by the magic button."
1295 :group 'custom-faces
1296 :group 'custom-buffer)
1298 (defface custom-invalid-face '((((class color))
1299 (:foreground "yellow" :background "red"))
1301 (:bold t :italic t :underline t)))
1302 "Face used when the customize item is invalid."
1303 :group 'custom-magic-faces)
1305 (defface custom-rogue-face '((((class color))
1306 (:foreground "pink" :background "black"))
1309 "Face used when the customize item is not defined for customization."
1310 :group 'custom-magic-faces)
1312 (defface custom-modified-face '((((class color))
1313 (:foreground "white" :background "blue"))
1316 "Face used when the customize item has been modified."
1317 :group 'custom-magic-faces)
1319 (defface custom-set-face '((((class color))
1320 (:foreground "blue" :background "white"))
1323 "Face used when the customize item has been set."
1324 :group 'custom-magic-faces)
1326 (defface custom-changed-face '((((class color))
1327 (:foreground "white" :background "blue"))
1330 "Face used when the customize item has been changed."
1331 :group 'custom-magic-faces)
1333 (defface custom-saved-face '((t (:underline t)))
1334 "Face used when the customize item has been saved."
1335 :group 'custom-magic-faces)
1337 (defconst custom-magic-alist '((nil "#" underline "\
1338 uninitialized, you should not see this.")
1339 (unknown "?" italic "\
1340 unknown, you should not see this.")
1341 (hidden "-" default "\
1342 hidden, invoke \"Show\" button in the previous line to show." "\
1343 group now hidden, invoke the above \"Show\" button to show contents.")
1344 (invalid "x" custom-invalid-face "\
1345 the value displayed for this %c is invalid and cannot be set.")
1346 (modified "*" custom-modified-face "\
1347 you have edited the value as text, but you have not set the %c." "\
1348 you have edited something in this group, but not set it.")
1349 (set "+" custom-set-face "\
1350 you have set this %c, but not saved it for future sessions." "\
1351 something in this group has been set, but not saved.")
1352 (changed ":" custom-changed-face "\
1353 this %c has been changed outside the customize buffer." "\
1354 something in this group has been changed outside customize.")
1355 (saved "!" custom-saved-face "\
1356 this %c has been set and saved." "\
1357 something in this group has been set and saved.")
1358 (rogue "@" custom-rogue-face "\
1359 this %c has not been changed with customize." "\
1360 something in this group is not prepared for customization.")
1361 (standard " " nil "\
1362 this %c is unchanged from its standard setting." "\
1363 visible group members are all at standard settings."))
1364 "Alist of customize option states.
1365 Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where
1367 STATE is one of the following symbols:
1370 For internal use, should never occur.
1372 For internal use, should never occur.
1374 This item is not being displayed.
1376 This item is modified, but has an invalid form.
1378 This item is modified, and has a valid form.
1380 This item has been set but not saved.
1382 The current value of this item has been changed temporarily.
1384 This item is marked for saving.
1386 This item has no customization information.
1388 This item is unchanged from the standard setting.
1390 MAGIC is a string used to present that state.
1392 FACE is a face used to present the state.
1394 ITEM-DESC is a string describing the state for options.
1396 GROUP-DESC is a string describing the state for groups. If this is
1397 left out, ITEM-DESC will be used.
1399 The string %c in either description will be replaced with the
1400 category of the item. These are `group'. `option', and `face'.
1402 The list should be sorted most significant first.")
1404 (defcustom custom-magic-show 'long
1405 "If non-nil, show textual description of the state.
1406 If `long', show a full-line description, not just one word."
1407 :type '(choice (const :tag "no" nil)
1410 :group 'custom-buffer)
1412 (defcustom custom-magic-show-hidden '(option face)
1413 "Control whether the State button is shown for hidden items.
1414 The value should be a list with the custom categories where the State
1415 button should be visible. Possible categories are `group', `option',
1417 :type '(set (const group) (const option) (const face))
1418 :group 'custom-buffer)
1420 (defcustom custom-magic-show-button nil
1421 "Show a \"magic\" button indicating the state of each customization option."
1423 :group 'custom-buffer)
1425 (define-widget 'custom-magic 'default
1426 "Show and manipulate state for a customization option."
1428 :action 'widget-parent-action
1431 :value-create 'custom-magic-value-create
1432 :value-delete 'widget-children-value-delete)
1434 (defun widget-magic-mouse-down-action (widget &optional event)
1435 ;; Non-nil unless hidden.
1436 (not (eq (widget-get (widget-get (widget-get widget :parent) :parent)
1440 (defun custom-magic-value-create (widget)
1441 ;; Create compact status report for WIDGET.
1442 (let* ((parent (widget-get widget :parent))
1443 (state (widget-get parent :custom-state))
1444 (hidden (eq state 'hidden))
1445 (entry (assq state custom-magic-alist))
1446 (magic (nth 1 entry))
1447 (face (nth 2 entry))
1448 (category (widget-get parent :custom-category))
1449 (text (or (and (eq category 'group)
1452 (form (widget-get parent :custom-form))
1454 (while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text)
1455 (setq text (concat (match-string 1 text)
1456 (symbol-name category)
1457 (match-string 2 text))))
1458 (when (and custom-magic-show
1460 (memq category custom-magic-show-hidden)))
1462 (when (and (eq category 'group)
1463 (not (and (eq custom-buffer-style 'links)
1464 (> (widget-get parent :custom-level) 1))))
1465 (insert-char ?\ (* custom-buffer-indent
1466 (widget-get parent :custom-level))))
1467 (push (widget-create-child-and-convert
1469 :help-echo "Change the state of this item"
1470 :format (if hidden "%t" "%[%t%]")
1471 :button-prefix 'widget-push-button-prefix
1472 :button-suffix 'widget-push-button-suffix
1473 :mouse-down-action 'widget-magic-mouse-down-action
1475 ;;:tag-glyph (or hidden '("state-up" "state-down"))
1479 (let ((start (point)))
1480 (if (eq custom-magic-show 'long)
1482 (insert (symbol-name state)))
1483 (cond ((eq form 'lisp)
1485 ((eq form 'mismatch)
1486 (insert " (mismatch)")))
1487 (put-text-property start (point) 'face 'custom-state-face))
1489 (when (and (eq category 'group)
1490 (not (and (eq custom-buffer-style 'links)
1491 (> (widget-get parent :custom-level) 1))))
1492 (insert-char ?\ (* custom-buffer-indent
1493 (widget-get parent :custom-level))))
1494 (when custom-magic-show-button
1495 (when custom-magic-show
1496 (let ((indent (widget-get parent :indent)))
1498 (insert-char ?\ indent))))
1499 (push (widget-create-child-and-convert
1501 :mouse-down-action 'widget-magic-mouse-down-action
1505 :help-echo "Change the state"
1506 :format (if hidden "%t" "%[%t%]")
1507 :tag (if (memq form '(lisp mismatch))
1508 (concat "(" magic ")")
1509 (concat "[" magic "]")))
1512 (widget-put widget :children children)))
1514 (defun custom-magic-reset (widget)
1515 "Redraw the :custom-magic property of WIDGET."
1516 (let ((magic (widget-get widget :custom-magic)))
1517 (widget-value-set magic (widget-value magic))))
1519 ;;; The `custom' Widget.
1521 (defface custom-button-face '((t (:bold t)))
1522 "Face used for buttons in customization buffers."
1523 :group 'custom-faces)
1525 (defface custom-documentation-face nil
1526 "Face used for documentation strings in customization buffers."
1527 :group 'custom-faces)
1529 (defface custom-state-face '((((class color)
1531 (:foreground "lime green"))
1534 (:foreground "dark green"))
1536 "Face used for State descriptions in the customize buffer."
1537 :group 'custom-faces)
1539 (define-widget 'custom 'default
1540 "Customize a user option."
1542 :convert-widget 'custom-convert-widget
1543 :notify 'custom-notify
1546 :custom-state 'hidden
1547 :documentation-property 'widget-subclass-responsibility
1548 :value-create 'widget-subclass-responsibility
1549 :value-delete 'widget-children-value-delete
1550 :value-get 'widget-value-value-get
1551 :validate 'widget-children-validate
1552 :match (lambda (widget value) (symbolp value)))
1554 (defun custom-convert-widget (widget)
1555 ;; Initialize :value and :tag from :args in WIDGET.
1556 (let ((args (widget-get widget :args)))
1558 (widget-put widget :value (widget-apply widget
1559 :value-to-internal (car args)))
1560 (widget-put widget :tag (custom-unlispify-tag-name (car args)))
1561 (widget-put widget :args nil)))
1564 (defun custom-notify (widget &rest args)
1565 "Keep track of changes."
1566 (let ((state (widget-get widget :custom-state)))
1567 (unless (eq state 'modified)
1568 (unless (memq state '(nil unknown hidden))
1569 (widget-put widget :custom-state 'modified))
1570 (custom-magic-reset widget)
1571 (apply 'widget-default-notify widget args))))
1573 (defun custom-redraw (widget)
1574 "Redraw WIDGET with current settings."
1575 (let ((line (count-lines (point-min) (point)))
1576 (column (current-column))
1578 (from (marker-position (widget-get widget :from)))
1579 (to (marker-position (widget-get widget :to))))
1581 (widget-value-set widget (widget-value widget))
1582 (custom-redraw-magic widget))
1583 (when (and (>= pos from) (<= pos to))
1588 (goto-line (1+ line)))
1589 (move-to-column column))
1592 (defun custom-redraw-magic (widget)
1593 "Redraw WIDGET state with current settings."
1595 (let ((magic (widget-get widget :custom-magic)))
1597 (widget-value-set magic (widget-value magic))
1598 (when (setq widget (widget-get widget :group))
1599 (custom-group-state-update widget)))
1601 (setq widget nil)))))
1604 (defun custom-show (widget value)
1605 "Non-nil if WIDGET should be shown with VALUE by default."
1606 (let ((show (widget-get widget :custom-show)))
1612 (funcall show widget value)))))
1614 (defvar custom-load-recursion nil
1615 "Hack to avoid recursive dependencies.")
1617 (defun custom-load-symbol (symbol)
1618 "Load all dependencies for SYMBOL."
1619 (unless custom-load-recursion
1620 (let ((custom-load-recursion t)
1621 (loads (get symbol 'custom-loads))
1624 (setq load (car loads)
1626 (cond ((symbolp load)
1630 ;; Don't reload a file already loaded.
1631 ((and (boundp 'preloaded-file-list)
1632 (member load preloaded-file-list)))
1633 ((assoc load load-history))
1634 ((assoc (locate-library load) load-history))
1637 ;; Without this, we would load cus-edit recursively.
1638 ;; We are still loading it when we call this,
1639 ;; and it is not in load-history yet.
1640 (or (equal load "cus-edit")
1641 (load-library load))
1644 (defun custom-load-widget (widget)
1645 "Load all dependencies for WIDGET."
1646 (custom-load-symbol (widget-value widget)))
1648 (defun custom-unloaded-symbol-p (symbol)
1649 "Return non-nil if the dependencies of SYMBOL has not yet been loaded."
1651 (loads (get symbol 'custom-loads))
1654 (setq load (car loads)
1656 (cond ((symbolp load)
1657 (unless (featurep load)
1659 ((assoc load load-history))
1660 ((assoc (locate-library load) load-history)
1667 (defun custom-unloaded-widget-p (widget)
1668 "Return non-nil if the dependencies of WIDGET has not yet been loaded."
1669 (custom-unloaded-symbol-p (widget-value widget)))
1671 (defun custom-toggle-hide (widget)
1672 "Toggle visibility of WIDGET."
1673 (custom-load-widget widget)
1674 (let ((state (widget-get widget :custom-state)))
1675 (cond ((memq state '(invalid modified))
1676 (error "There are unset changes"))
1678 (widget-put widget :custom-state 'unknown))
1680 (widget-put widget :documentation-shown nil)
1681 (widget-put widget :custom-state 'hidden)))
1682 (custom-redraw widget)
1685 (defun custom-toggle-parent (widget &rest ignore)
1686 "Toggle visibility of parent of WIDGET."
1687 (custom-toggle-hide (widget-get widget :parent)))
1689 (defun custom-add-see-also (widget &optional prefix)
1690 "Add `See also ...' to WIDGET if there are any links.
1691 Insert PREFIX first if non-nil."
1692 (let* ((symbol (widget-get widget :value))
1693 (links (get symbol 'custom-links))
1694 (many (> (length links) 2))
1695 (buttons (widget-get widget :buttons))
1696 (indent (widget-get widget :indent)))
1699 (insert-char ?\ indent))
1702 (insert "See also ")
1704 (push (widget-create-child-and-convert widget (car links))
1706 (setq links (cdr links))
1715 (widget-put widget :buttons buttons))))
1717 (defun custom-add-parent-links (widget &optional initial-string)
1718 "Add \"Parent groups: ...\" to WIDGET if the group has parents.
1719 The value if non-nil if any parents were found.
1720 If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
1721 (let ((name (widget-value widget))
1722 (type (widget-type widget))
1723 (buttons (widget-get widget :buttons))
1726 (insert (or initial-string "Parent groups:"))
1727 (maphash (lambda (group ignore)
1728 (let ((entry (assq name (get group 'custom-group))))
1729 (when (eq (nth 1 entry) type)
1731 (push (widget-create-child-and-convert
1732 widget 'custom-group-link
1733 :tag (custom-unlispify-tag-name group)
1737 custom-group-hash-table)
1738 (widget-put widget :buttons buttons)
1741 (delete-region start (point)))
1744 ;;; The `custom-comment' Widget.
1746 ;; like the editable field
1747 (defface custom-comment-face '((((class grayscale color)
1749 (:background "gray85"))
1750 (((class grayscale color)
1752 (:background "dim gray"))
1755 "Face used for comments on variables or faces"
1756 :group 'custom-faces)
1758 ;; like font-lock-comment-face
1759 (defface custom-comment-tag-face
1760 '((((class color) (background dark)) (:foreground "gray80"))
1761 (((class color) (background light)) (:foreground "blue4"))
1762 (((class grayscale) (background light))
1763 (:foreground "DimGray" :bold t :italic t))
1764 (((class grayscale) (background dark))
1765 (:foreground "LightGray" :bold t :italic t))
1767 "Face used for variables or faces comment tags"
1768 :group 'custom-faces)
1770 (define-widget 'custom-comment 'string
1773 :help-echo "Edit a comment here"
1774 :sample-face 'custom-comment-tag-face
1775 :value-face 'custom-comment-face
1776 :value-set 'custom-comment-value-set
1777 :create 'custom-comment-create
1778 :delete 'custom-comment-delete)
1780 (defun custom-comment-create (widget)
1782 (widget-default-create widget)
1783 (widget-put widget :comment-extent
1784 (setq ext (make-extent (widget-get widget :from)
1785 (widget-get widget :to))))
1786 (set-extent-property ext 'start-open t)
1787 (when (equal (widget-get widget :value) "")
1788 (set-extent-property ext 'invisible t))
1791 (defun custom-comment-delete (widget)
1792 (widget-default-delete widget)
1793 (delete-extent (widget-get widget :comment-extent)))
1795 (defun custom-comment-value-set (widget value)
1796 (widget-default-value-set widget value)
1797 (if (equal value "")
1798 (set-extent-property (widget-get widget :comment-extent)
1800 (set-extent-property (widget-get widget :comment-extent)
1803 ;; Those functions are for the menu. WIDGET is NOT the comment widget. It's
1804 ;; the global custom one
1805 (defun custom-comment-show (widget)
1806 (set-extent-property
1807 (widget-get (widget-get widget :comment-widget) :comment-extent)
1810 (defun custom-comment-invisible-p (widget)
1812 (widget-get (widget-get widget :comment-widget) :comment-extent)
1815 ;;; The `custom-variable' Widget.
1817 (defface custom-variable-tag-face '((((class color)
1819 (:foreground "light blue" :underline t))
1822 (:foreground "blue" :underline t))
1824 "Face used for unpushable variable tags."
1825 :group 'custom-faces)
1827 (defface custom-variable-button-face '((t (:underline t :bold t)))
1828 "Face used for pushable variable tags."
1829 :group 'custom-faces)
1831 (defcustom custom-variable-default-form 'edit
1832 "Default form of displaying variable values."
1833 :type '(choice (const edit)
1835 :group 'custom-buffer)
1837 (define-widget 'custom-variable 'custom
1838 "Customize variable."
1840 :help-echo "Set or reset this variable"
1841 :documentation-property 'variable-documentation
1842 :custom-category 'option
1844 :custom-menu 'custom-variable-menu-create
1845 :custom-form nil ; defaults to value of `custom-variable-default-form'
1846 :value-create 'custom-variable-value-create
1847 :action 'custom-variable-action
1848 :custom-set 'custom-variable-set
1849 :custom-save 'custom-variable-save
1850 :custom-reset-current 'custom-redraw
1851 :custom-reset-saved 'custom-variable-reset-saved
1852 :custom-reset-standard 'custom-variable-reset-standard)
1854 (defun custom-variable-type (symbol)
1855 "Return a widget suitable for editing the value of SYMBOL.
1856 If SYMBOL has a `custom-type' property, use that.
1857 Otherwise, look up symbol in `custom-guess-type-alist'."
1858 (let* ((type (or (get symbol 'custom-type)
1859 (and (not (get symbol 'standard-value))
1860 (custom-guess-type symbol))
1862 (options (get symbol 'custom-options))
1863 (tmp (if (listp type)
1864 (copy-sequence type)
1867 (widget-put tmp :options options))
1870 (defun custom-variable-value-create (widget)
1871 "Here is where you edit the variables value."
1872 (custom-load-widget widget)
1873 (unless (widget-get widget :custom-form)
1874 (widget-put widget :custom-form custom-variable-default-form))
1875 (let* ((buttons (widget-get widget :buttons))
1876 (children (widget-get widget :children))
1877 (form (widget-get widget :custom-form))
1878 (state (widget-get widget :custom-state))
1879 (symbol (widget-get widget :value))
1880 (tag (widget-get widget :tag))
1881 (type (custom-variable-type symbol))
1882 (conv (widget-convert type))
1883 (get (or (get symbol 'custom-get) 'default-value))
1884 (prefix (widget-get widget :custom-prefix))
1885 (last (widget-get widget :custom-last))
1886 (value (if (default-boundp symbol)
1887 (funcall get symbol)
1888 (widget-get conv :value))))
1889 ;; If the widget is new, the child determine whether it is hidden.
1891 ((custom-show type value)
1892 (setq state 'unknown))
1894 (setq state 'hidden)))
1895 ;; If we don't know the state, see if we need to edit it in lisp form.
1896 (when (eq state 'unknown)
1897 (unless (widget-apply conv :match value)
1898 ;; (widget-apply (widget-convert type) :match value)
1899 (setq form 'mismatch)))
1900 ;; Now we can create the child widget.
1901 (cond ((eq custom-buffer-style 'tree)
1902 (insert prefix (if last " `--- " " |--- "))
1903 (push (widget-create-child-and-convert
1904 widget 'custom-browse-variable-tag)
1906 (insert " " tag "\n")
1907 (widget-put widget :buttons buttons))
1909 ;; Indicate hidden value.
1910 (push (widget-create-child-and-convert
1913 :sample-face 'custom-variable-tag-face
1917 (push (widget-create-child-and-convert
1919 :help-echo "Show the value of this option"
1920 :action 'custom-toggle-parent
1923 ((memq form '(lisp mismatch))
1924 ;; In lisp mode edit the saved value when possible.
1925 (let* ((value (cond ((get symbol 'saved-value)
1926 (car (get symbol 'saved-value)))
1927 ((get symbol 'standard-value)
1928 (car (get symbol 'standard-value)))
1929 ((default-boundp symbol)
1930 (custom-quote (funcall get symbol)))
1932 (custom-quote (widget-get conv :value))))))
1933 (insert (symbol-name symbol) ": ")
1934 (push (widget-create-child-and-convert
1936 :help-echo "Hide the value of this option"
1937 :action 'custom-toggle-parent
1941 (push (widget-create-child-and-convert
1943 :button-face 'custom-variable-button-face
1945 :tag (symbol-name symbol)
1951 (let* ((format (widget-get type :format))
1952 tag-format value-format)
1953 (while (not (string-match ":" format))
1954 (setq format (signal 'error (list "Bad format" format))))
1955 (setq tag-format (substring format 0 (match-end 0)))
1956 (setq value-format (substring format (match-end 0)))
1957 (push (widget-create-child-and-convert
1960 :action 'custom-tag-action
1961 :help-echo "Change value of this option"
1962 :mouse-down-action 'custom-tag-mouse-down-action
1963 :button-face 'custom-variable-button-face
1964 :sample-face 'custom-variable-tag-face
1968 (push (widget-create-child-and-convert
1970 :help-echo "Hide the value of this option"
1971 :action 'custom-toggle-parent
1974 (push (widget-create-child-and-convert
1976 :format value-format
1979 (unless (eq custom-buffer-style 'tree)
1980 (unless (eq (preceding-char) ?\n)
1981 (widget-insert "\n"))
1982 ;; Create the magic button.
1983 (let ((magic (widget-create-child-and-convert
1984 widget 'custom-magic nil)))
1985 (widget-put widget :custom-magic magic)
1986 (push magic buttons))
1987 ;; Insert documentation.
1988 ;; ### NOTE: this is ugly!!!! I need to do update the :buttons property
1989 ;; before the call to `widget-default-format-handler'. Otherwise, I
1990 ;; loose my current `buttons'. This function shouldn't be called like
1991 ;; this anyway. The doc string widget should be added like the others.
1993 (widget-put widget :buttons buttons)
1994 (widget-default-format-handler widget ?h)
1995 ;; The comment field
1996 (unless (eq state 'hidden)
1997 (let* ((comment (get symbol 'variable-comment))
1999 (widget-create-child-and-convert
2000 widget 'custom-comment
2002 :value (or comment ""))))
2003 (widget-put widget :comment-widget comment-widget)
2004 ;; Don't push it !!! Custom assumes that the first child is the
2006 (setq children (append children (list comment-widget)))))
2007 ;; Update the rest of the properties properties.
2008 (widget-put widget :custom-form form)
2009 (widget-put widget :children children)
2010 ;; Now update the state.
2011 (if (eq state 'hidden)
2012 (widget-put widget :custom-state state)
2013 (custom-variable-state-set widget))
2015 (unless (eq state 'hidden)
2016 (when (eq (widget-get widget :custom-level) 1)
2017 (custom-add-parent-links widget))
2018 (custom-add-see-also widget)))))
2020 (defun custom-tag-action (widget &rest args)
2021 "Pass :action to first child of WIDGET's parent."
2022 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2025 (defun custom-tag-mouse-down-action (widget &rest args)
2026 "Pass :mouse-down-action to first child of WIDGET's parent."
2027 (apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
2028 :mouse-down-action args))
2030 (defun custom-variable-state-set (widget)
2031 "Set the state of WIDGET."
2032 (let* ((symbol (widget-value widget))
2033 (get (or (get symbol 'custom-get) 'default-value))
2034 (value (if (default-boundp symbol)
2035 (funcall get symbol)
2036 (widget-get widget :value)))
2037 (comment (get symbol 'variable-comment))
2040 (state (cond ((progn (setq tmp (get symbol 'customized-value))
2042 (get symbol 'customized-variable-comment))
2044 (if (condition-case nil
2045 (and (equal value (eval (car tmp)))
2046 (equal comment temp))
2050 ((progn (setq tmp (get symbol 'saved-value))
2051 (setq temp (get symbol 'saved-variable-comment))
2053 (if (condition-case nil
2054 (and (equal value (eval (car tmp)))
2055 (equal comment temp))
2059 ((setq tmp (get symbol 'standard-value))
2060 (if (condition-case nil
2061 (and (equal value (eval (car tmp)))
2062 (equal comment nil))
2067 (widget-put widget :custom-state state)))
2069 (defvar custom-variable-menu
2070 '(("Set for Current Session" custom-variable-set
2072 (eq (widget-get widget :custom-state) 'modified)))
2073 ("Save for Future Sessions" custom-variable-save
2075 (memq (widget-get widget :custom-state) '(modified set changed rogue))))
2076 ("Reset to Current" custom-redraw
2078 (and (default-boundp (widget-value widget))
2079 (memq (widget-get widget :custom-state) '(modified changed)))))
2080 ("Reset to Saved" custom-variable-reset-saved
2082 (and (or (get (widget-value widget) 'saved-value)
2083 (get (widget-value widget) 'saved-variable-comment))
2084 (memq (widget-get widget :custom-state)
2085 '(modified set changed rogue)))))
2086 ("Reset to Standard Settings" custom-variable-reset-standard
2088 (and (get (widget-value widget) 'standard-value)
2089 (memq (widget-get widget :custom-state)
2090 '(modified set changed saved rogue)))))
2091 ("---" ignore ignore)
2092 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2093 ("---" ignore ignore)
2094 ("Don't show as Lisp expression" custom-variable-edit
2096 (eq (widget-get widget :custom-form) 'lisp)))
2097 ("Show as Lisp expression" custom-variable-edit-lisp
2099 (eq (widget-get widget :custom-form) 'edit))))
2100 "Alist of actions for the `custom-variable' widget.
2101 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2102 the menu entry, ACTION is the function to call on the widget when the
2103 menu is selected, and FILTER is a predicate which takes a `custom-variable'
2104 widget as an argument, and returns non-nil if ACTION is valid on that
2105 widget. If FILTER is nil, ACTION is always valid.")
2107 (defun custom-variable-action (widget &optional event)
2108 "Show the menu for `custom-variable' WIDGET.
2109 Optional EVENT is the location for the menu."
2110 (if (eq (widget-get widget :custom-state) 'hidden)
2111 (custom-toggle-hide widget)
2112 (unless (eq (widget-get widget :custom-state) 'modified)
2113 (custom-variable-state-set widget))
2114 ;; Redrawing magic also depresses the state glyph.
2115 ;(custom-redraw-magic widget)
2116 (let* ((completion-ignore-case t)
2117 (answer (widget-choose (concat "Operation on "
2118 (custom-unlispify-tag-name
2119 (widget-get widget :value)))
2120 (custom-menu-filter custom-variable-menu
2124 (funcall answer widget)))))
2126 (defun custom-variable-edit (widget)
2127 "Edit value of WIDGET."
2128 (widget-put widget :custom-state 'unknown)
2129 (widget-put widget :custom-form 'edit)
2130 (custom-redraw widget))
2132 (defun custom-variable-edit-lisp (widget)
2133 "Edit the lisp representation of the value of WIDGET."
2134 (widget-put widget :custom-state 'unknown)
2135 (widget-put widget :custom-form 'lisp)
2136 (custom-redraw widget))
2138 (defun custom-variable-set (widget)
2139 "Set the current value for the variable being edited by WIDGET."
2140 (let* ((form (widget-get widget :custom-form))
2141 (state (widget-get widget :custom-state))
2142 (child (car (widget-get widget :children)))
2143 (symbol (widget-value widget))
2144 (set (or (get symbol 'custom-set) 'set-default))
2145 (comment-widget (widget-get widget :comment-widget))
2146 (comment (widget-value comment-widget))
2148 (cond ((eq state 'hidden)
2149 (error "Cannot set hidden variable"))
2150 ((setq val (widget-apply child :validate))
2151 (goto-char (widget-get val :from))
2152 (error "%s" (widget-get val :error)))
2153 ((memq form '(lisp mismatch))
2154 (when (equal comment "")
2156 ;; Make the comment invisible by hand if it's empty
2157 (set-extent-property (widget-get comment-widget :comment-extent)
2159 (funcall set symbol (eval (setq val (widget-value child))))
2160 (put symbol 'customized-value (list val))
2161 (put symbol 'variable-comment comment)
2162 (put symbol 'customized-variable-comment comment))
2164 (when (equal comment "")
2166 ;; Make the comment invisible by hand if it's empty
2167 (set-extent-property (widget-get comment-widget :comment-extent)
2169 (funcall set symbol (setq val (widget-value child)))
2170 (put symbol 'customized-value (list (custom-quote val)))
2171 (put symbol 'variable-comment comment)
2172 (put symbol 'customized-variable-comment comment)))
2173 (custom-variable-state-set widget)
2174 (custom-redraw-magic widget)))
2176 (defun custom-variable-save (widget)
2177 "Set and save the value for the variable being edited by WIDGET."
2178 (let* ((form (widget-get widget :custom-form))
2179 (state (widget-get widget :custom-state))
2180 (child (car (widget-get widget :children)))
2181 (symbol (widget-value widget))
2182 (set (or (get symbol 'custom-set) 'set-default))
2183 (comment-widget (widget-get widget :comment-widget))
2184 (comment (widget-value comment-widget))
2186 (cond ((eq state 'hidden)
2187 (error "Cannot set hidden variable"))
2188 ((setq val (widget-apply child :validate))
2189 (goto-char (widget-get val :from))
2190 (error "%s" (widget-get val :error)))
2191 ((memq form '(lisp mismatch))
2192 (when (equal comment "")
2194 ;; Make the comment invisible by hand if it's empty
2195 (set-extent-property (widget-get comment-widget :comment-extent)
2197 (put symbol 'saved-value (list (widget-value child)))
2198 (custom-push-theme 'theme-value symbol 'user
2199 'set (list (widget-value child)))
2200 (funcall set symbol (eval (widget-value child)))
2201 (put symbol 'variable-comment comment)
2202 (put symbol 'saved-variable-comment comment))
2204 (when (equal comment "")
2206 ;; Make the comment invisible by hand if it's empty
2207 (set-extent-property (widget-get comment-widget :comment-extent)
2210 'saved-value (list (custom-quote (widget-value
2212 (custom-push-theme 'theme-value symbol 'user
2213 'set (list (custom-quote (widget-value
2215 (funcall set symbol (widget-value child))
2216 (put symbol 'variable-comment comment)
2217 (put symbol 'saved-variable-comment comment)))
2218 (put symbol 'customized-value nil)
2219 (put symbol 'customized-variable-comment nil)
2221 (custom-variable-state-set widget)
2222 (custom-redraw-magic widget)))
2224 (defun custom-variable-reset-saved (widget)
2225 "Restore the saved value for the variable being edited by WIDGET."
2226 (let* ((symbol (widget-value widget))
2227 (set (or (get symbol 'custom-set) 'set-default))
2228 (comment-widget (widget-get widget :comment-widget))
2229 (value (get symbol 'saved-value))
2230 (comment (get symbol 'saved-variable-comment)))
2231 (cond ((or value comment)
2232 (put symbol 'variable-comment comment)
2234 (funcall set symbol (eval (car value)))
2237 (signal 'error (list "No saved value for variable" symbol))))
2238 (put symbol 'customized-value nil)
2239 (put symbol 'customized-variable-comment nil)
2240 (widget-put widget :custom-state 'unknown)
2241 ;; This call will possibly make the comment invisible
2242 (custom-redraw widget)))
2244 (defun custom-variable-reset-standard (widget)
2245 "Restore the standard setting for the variable being edited by WIDGET."
2246 (let* ((symbol (widget-value widget))
2247 (set (or (get symbol 'custom-set) 'set-default))
2248 (comment-widget (widget-get widget :comment-widget)))
2249 (if (get symbol 'standard-value)
2250 (funcall set symbol (eval (car (get symbol 'standard-value))))
2251 (signal 'error (list "No standard setting known for variable" symbol)))
2252 (put symbol 'variable-comment nil)
2253 (put symbol 'customized-value nil)
2254 (put symbol 'customized-variable-comment nil)
2255 (when (or (get symbol 'saved-value) (get symbol 'saved-variable-comment))
2256 (put symbol 'saved-value nil)
2257 (custom-push-theme 'theme-value symbol 'user 'reset 'standard)
2258 ;; As a special optimizations we do not (explictly)
2259 ;; save resets to standard when no theme set the value.
2260 (if (null (cdr (get symbol 'theme-value)))
2261 (put symbol 'theme-value nil))
2262 (put symbol 'saved-variable-comment nil)
2264 (widget-put widget :custom-state 'unknown)
2265 ;; This call will possibly make the comment invisible
2266 (custom-redraw widget)))
2268 ;;; The `custom-face-edit' Widget.
2270 (define-widget 'custom-face-edit 'checklist
2271 "Edit face attributes."
2275 :button-args '(:help-echo "Control whether this attribute has any effect")
2276 :args (mapcar (lambda (att)
2279 :sibling-args (widget-get (nth 1 att) :sibling-args)
2280 (list 'const :format "" :value (nth 0 att))
2282 custom-face-attributes))
2284 ;;; The `custom-display' Widget.
2286 (define-widget 'custom-display 'menu-choice
2287 "Select a display type."
2290 :help-echo "Specify frames where the face attributes should be used"
2291 :args '((const :tag "all" t)
2295 :args ((group :sibling-args (:help-echo "\
2296 Only match the specified window systems")
2297 (const :format "Type: "
2299 (checklist :inline t
2302 :sibling-args (:help-echo "\
2303 The X11 Window System")
2305 (const :format "PM "
2306 :sibling-args (:help-echo "\
2307 OS/2 Presentation Manager")
2309 (const :format "MSWindows "
2310 :sibling-args (:help-echo "\
2313 (const :format "DOS "
2314 :sibling-args (:help-echo "\
2317 (const :format "TTY%n"
2318 :sibling-args (:help-echo "\
2319 Plain text terminals")
2321 (group :sibling-args (:help-echo "\
2322 Only match the frames with the specified color support")
2323 (const :format "Class: "
2325 (checklist :inline t
2327 (const :format "Color "
2328 :sibling-args (:help-echo "\
2329 Match color frames")
2331 (const :format "Grayscale "
2332 :sibling-args (:help-echo "\
2333 Match grayscale frames")
2335 (const :format "Monochrome%n"
2336 :sibling-args (:help-echo "\
2337 Match frames with no color support")
2339 (group :sibling-args (:help-echo "\
2340 Only match frames with the specified intensity")
2342 Background brightness: "
2344 (checklist :inline t
2346 (const :format "Light "
2347 :sibling-args (:help-echo "\
2348 Match frames with light backgrounds")
2350 (const :format "Dark\n"
2351 :sibling-args (:help-echo "\
2352 Match frames with dark backgrounds")
2355 ;;; The `custom-face' Widget.
2357 (defface custom-face-tag-face '((t (:underline t)))
2358 "Face used for face tags."
2359 :group 'custom-faces)
2361 (defcustom custom-face-default-form 'selected
2362 "Default form of displaying face definition."
2363 :type '(choice (const all)
2366 :group 'custom-buffer)
2368 (define-widget 'custom-face 'custom
2370 :sample-face 'custom-face-tag-face
2371 :help-echo "Set or reset this face"
2372 :documentation-property '(lambda (face)
2373 (face-doc-string face))
2374 :value-create 'custom-face-value-create
2375 :action 'custom-face-action
2376 :custom-category 'face
2377 :custom-form nil ; defaults to value of `custom-face-default-form'
2378 :custom-set 'custom-face-set
2379 :custom-save 'custom-face-save
2380 :custom-reset-current 'custom-redraw
2381 :custom-reset-saved 'custom-face-reset-saved
2382 :custom-reset-standard 'custom-face-reset-standard
2383 :custom-menu 'custom-face-menu-create)
2385 (define-widget 'custom-face-all 'editable-list
2386 "An editable list of display specifications and attributes."
2387 :entry-format "%i %d %v"
2388 :insert-button-args '(:help-echo "Insert new display specification here")
2389 :append-button-args '(:help-echo "Append new display specification here")
2390 :delete-button-args '(:help-echo "Delete this display specification")
2391 :args '((group :format "%v" custom-display custom-face-edit)))
2393 (defconst custom-face-all (widget-convert 'custom-face-all)
2394 "Converted version of the `custom-face-all' widget.")
2396 (define-widget 'custom-display-unselected 'item
2397 "A display specification that doesn't match the selected display."
2398 :match 'custom-display-unselected-match)
2400 (defun custom-display-unselected-match (widget value)
2401 "Non-nil if VALUE is an unselected display specification."
2402 (not (face-spec-set-match-display value (selected-frame))))
2404 (define-widget 'custom-face-selected 'group
2405 "Edit the attributes of the selected display in a face specification."
2406 :args '((repeat :format ""
2408 (group custom-display-unselected sexp))
2409 (group (sexp :format "") custom-face-edit)
2414 (defconst custom-face-selected (widget-convert 'custom-face-selected)
2415 "Converted version of the `custom-face-selected' widget.")
2417 (defun custom-face-value-create (widget)
2418 "Create a list of the display specifications for WIDGET."
2419 (let ((buttons (widget-get widget :buttons))
2421 (symbol (widget-get widget :value))
2422 (tag (widget-get widget :tag))
2423 (state (widget-get widget :custom-state))
2425 (is-last (widget-get widget :custom-last))
2426 (prefix (widget-get widget :custom-prefix)))
2428 (setq tag (prin1-to-string symbol)))
2429 (cond ((eq custom-buffer-style 'tree)
2430 (insert prefix (if is-last " `--- " " |--- "))
2431 (push (widget-create-child-and-convert
2432 widget 'custom-browse-face-tag)
2434 (insert " " tag "\n")
2435 (widget-put widget :buttons buttons))
2439 (if (eq custom-buffer-style 'face)
2441 (widget-specify-sample widget begin (point))
2444 (and (not (find-face symbol))
2445 ;; XEmacs cannot display uninitialized faces.
2447 (push (widget-create-child-and-convert widget 'item
2454 (push (widget-create-child-and-convert
2456 :help-echo "Hide or show this face"
2457 :action 'custom-toggle-parent
2458 (not (eq state 'hidden)))
2462 (let ((magic (widget-create-child-and-convert
2463 widget 'custom-magic nil)))
2464 (widget-put widget :custom-magic magic)
2465 (push magic buttons))
2467 (widget-put widget :buttons buttons)
2468 ;; Insert documentation.
2469 (widget-default-format-handler widget ?h)
2470 ;; The comment field
2471 (unless (eq state 'hidden)
2472 (let* ((comment (get symbol 'face-comment))
2474 (widget-create-child-and-convert
2475 widget 'custom-comment
2477 :value (or comment ""))))
2478 (widget-put widget :comment-widget comment-widget)
2479 (push comment-widget children)))
2481 (unless (eq state 'hidden)
2482 (when (eq (widget-get widget :custom-level) 1)
2483 (custom-add-parent-links widget))
2484 (custom-add-see-also widget))
2486 (unless (eq (preceding-char) ?\n)
2488 (unless (eq state 'hidden)
2489 (message "Creating face editor...")
2490 (custom-load-widget widget)
2491 (unless (widget-get widget :custom-form)
2492 (widget-put widget :custom-form custom-face-default-form))
2493 (let* ((symbol (widget-value widget))
2494 (spec (custom-face-get-spec symbol))
2495 (form (widget-get widget :custom-form))
2496 (indent (widget-get widget :indent))
2497 (edit (widget-create-child-and-convert
2499 (cond ((and (eq form 'selected)
2500 (widget-apply custom-face-selected
2502 (when indent (insert-char ?\ indent))
2503 'custom-face-selected)
2504 ((and (not (eq form 'lisp))
2505 (widget-apply custom-face-all
2509 (when indent (insert-char ?\ indent))
2512 (custom-face-state-set widget)
2513 (push edit children)
2514 (widget-put widget :children children))
2515 (message "Creating face editor...done"))))))
2517 (defvar custom-face-menu
2518 '(("Set for Current Session" custom-face-set)
2519 ("Save for Future Sessions" custom-face-save)
2520 ("Reset to Saved" custom-face-reset-saved
2522 (or (get (widget-value widget) 'saved-face)
2523 (get (widget-value widget) 'saved-face-comment))))
2524 ("Reset to Standard Setting" custom-face-reset-standard
2526 (get (widget-value widget) 'face-defface-spec)))
2527 ("---" ignore ignore)
2528 ("Add Comment" custom-comment-show custom-comment-invisible-p)
2529 ("---" ignore ignore)
2530 ("Show all display specs" custom-face-edit-all
2532 (not (eq (widget-get widget :custom-form) 'all))))
2533 ("Just current attributes" custom-face-edit-selected
2535 (not (eq (widget-get widget :custom-form) 'selected))))
2536 ("Show as Lisp expression" custom-face-edit-lisp
2538 (not (eq (widget-get widget :custom-form) 'lisp)))))
2539 "Alist of actions for the `custom-face' widget.
2540 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
2541 the menu entry, ACTION is the function to call on the widget when the
2542 menu is selected, and FILTER is a predicate which takes a `custom-face'
2543 widget as an argument, and returns non-nil if ACTION is valid on that
2544 widget. If FILTER is nil, ACTION is always valid.")
2546 (defun custom-face-edit-selected (widget)
2547 "Edit selected attributes of the value of WIDGET."
2548 (widget-put widget :custom-state 'unknown)
2549 (widget-put widget :custom-form 'selected)
2550 (custom-redraw widget))
2552 (defun custom-face-edit-all (widget)
2553 "Edit all attributes of the value of WIDGET."
2554 (widget-put widget :custom-state 'unknown)
2555 (widget-put widget :custom-form 'all)
2556 (custom-redraw widget))
2558 (defun custom-face-edit-lisp (widget)
2559 "Edit the lisp representation of the value of WIDGET."
2560 (widget-put widget :custom-state 'unknown)
2561 (widget-put widget :custom-form 'lisp)
2562 (custom-redraw widget))
2564 (defun custom-face-state-set (widget)
2565 "Set the state of WIDGET."
2566 (let* ((symbol (widget-value widget))
2567 (comment (get symbol 'face-comment))
2569 (widget-put widget :custom-state
2571 (setq tmp (get symbol 'customized-face))
2572 (setq temp (get symbol 'customized-face-comment))
2574 (if (equal temp comment)
2578 (setq tmp (get symbol 'saved-face))
2579 (setq temp (get symbol 'saved-face-comment))
2581 (if (equal temp comment)
2584 ((get symbol 'face-defface-spec)
2585 (if (equal comment nil)
2591 (defun custom-face-action (widget &optional event)
2592 "Show the menu for `custom-face' WIDGET.
2593 Optional EVENT is the location for the menu."
2594 (if (eq (widget-get widget :custom-state) 'hidden)
2595 (custom-toggle-hide widget)
2596 (let* ((completion-ignore-case t)
2597 (symbol (widget-get widget :value))
2598 (answer (widget-choose (concat "Operation on "
2599 (custom-unlispify-tag-name symbol))
2600 (custom-menu-filter custom-face-menu
2604 (funcall answer widget)))))
2606 (defun custom-face-set (widget)
2607 "Make the face attributes in WIDGET take effect."
2608 (let* ((symbol (widget-value widget))
2609 (child (car (widget-get widget :children)))
2610 (value (widget-value child))
2611 (comment-widget (widget-get widget :comment-widget))
2612 (comment (widget-value comment-widget)))
2613 (when (equal comment "")
2615 ;; Make the comment invisible by hand if it's empty
2616 (set-extent-property (widget-get comment-widget :comment-extent)
2618 (put symbol 'customized-face value)
2619 (face-spec-set symbol value nil '(custom))
2620 (put symbol 'customized-face-comment comment)
2621 (put symbol 'face-comment comment)
2622 (custom-face-state-set widget)
2623 (custom-redraw-magic widget)))
2625 (defun custom-face-save (widget)
2626 "Make the face attributes in WIDGET default."
2627 (let* ((symbol (widget-value widget))
2628 (child (car (widget-get widget :children)))
2629 (value (widget-value child))
2630 (comment-widget (widget-get widget :comment-widget))
2631 (comment (widget-value comment-widget)))
2632 (when (equal comment "")
2634 ;; Make the comment invisible by hand if it's empty
2635 (set-extent-property (widget-get comment-widget :comment-extent)
2637 (face-spec-set symbol value nil '(custom))
2638 (put symbol 'saved-face value)
2639 (custom-push-theme 'theme-face symbol 'user 'set value)
2640 (put symbol 'customized-face nil)
2641 (put symbol 'face-comment comment)
2642 (put symbol 'customized-face-comment nil)
2643 (put symbol 'saved-face-comment comment)
2645 (custom-face-state-set widget)
2646 (custom-redraw-magic widget)))
2648 (defun custom-face-reset-saved (widget)
2649 "Restore WIDGET to the face's default attributes."
2650 (let* ((symbol (widget-value widget))
2651 (child (car (widget-get widget :children)))
2652 (value (get symbol 'saved-face))
2653 (comment (get symbol 'saved-face-comment))
2654 (comment-widget (widget-get widget :comment-widget)))
2655 (unless (or value comment)
2656 (signal 'error (list "No saved value for this face" symbol)))
2657 (put symbol 'customized-face nil)
2658 (put symbol 'customized-face-comment nil)
2659 (face-spec-set symbol value nil '(custom))
2660 (put symbol 'face-comment comment)
2661 (widget-value-set child value)
2662 ;; This call manages the comment visibility
2663 (widget-value-set comment-widget (or comment ""))
2664 (custom-face-state-set widget)
2665 (custom-redraw-magic widget)))
2667 (defun custom-face-reset-standard (widget)
2668 "Restore WIDGET to the face's standard settings."
2669 (let* ((symbol (widget-value widget))
2670 (child (car (widget-get widget :children)))
2671 (value (get symbol 'face-defface-spec))
2672 (comment-widget (widget-get widget :comment-widget)))
2674 (signal 'error (list "No standard setting for this face" symbol)))
2675 (put symbol 'customized-face nil)
2676 (put symbol 'customized-face-comment nil)
2677 (when (or (get symbol 'saved-face) (get symbol 'saved-face-comment))
2678 (put symbol 'saved-face nil)
2679 (custom-push-theme 'theme-face symbol 'user 'reset 'standard)
2680 ;; Do not explictly save resets to standards without themes.
2681 (if (null (cdr (get symbol 'theme-face)))
2682 (put symbol 'theme-face nil))
2683 (put symbol 'saved-face-comment nil)
2685 (face-spec-set symbol value nil '(custom))
2686 (put symbol 'face-comment nil)
2687 (widget-value-set child value)
2688 ;; This call manages the comment visibility
2689 (widget-value-set comment-widget "")
2690 (custom-face-state-set widget)
2691 (custom-redraw-magic widget)))
2693 ;;; The `face' Widget.
2695 (define-widget 'face 'default
2696 "Select and customize a face."
2697 :convert-widget 'widget-value-convert-widget
2698 :button-prefix 'widget-push-button-prefix
2699 :button-suffix 'widget-push-button-suffix
2700 :format "%t: %[select face%] %v"
2703 :value-create 'widget-face-value-create
2704 :value-delete 'widget-face-value-delete
2705 :value-get 'widget-value-value-get
2706 :validate 'widget-children-validate
2707 :action 'widget-face-action
2708 :match (lambda (widget value) (symbolp value)))
2710 (defun widget-face-value-create (widget)
2711 ;; Create a `custom-face' child.
2712 (let* ((symbol (widget-value widget))
2713 (custom-buffer-style 'face)
2714 (child (widget-create-child-and-convert
2718 (custom-magic-reset child)
2719 (setq custom-options (cons child custom-options))
2720 (widget-put widget :children (list child))))
2722 (defun widget-face-value-delete (widget)
2723 ;; Remove the child from the options.
2724 (let ((child (car (widget-get widget :children))))
2725 (setq custom-options (delq child custom-options))
2726 (widget-children-value-delete widget)))
2728 (defvar face-history nil
2729 "History of entered face names.")
2731 (defun widget-face-action (widget &optional event)
2732 "Prompt for a face."
2733 (let ((answer (completing-read "Face: "
2734 (mapcar (lambda (face)
2735 (list (symbol-name face)))
2739 (unless (zerop (length answer))
2740 (widget-value-set widget (intern answer))
2741 (widget-apply widget :notify widget event)
2744 ;;; The `hook' Widget.
2746 (define-widget 'hook 'list
2748 :value-to-internal (lambda (widget value)
2752 :match (lambda (widget value)
2754 (widget-group-match widget value)))
2755 :convert-widget 'custom-hook-convert-widget
2758 (defun custom-hook-convert-widget (widget)
2759 ;; Handle `:options'.
2760 (let* ((options (widget-get widget :options))
2761 (other `(editable-list :inline t
2762 :entry-format "%i %d%v"
2763 (function :format " %v")))
2765 (list `(checklist :inline t
2766 ,@(mapcar (lambda (entry)
2767 `(function-item ,entry))
2771 (widget-put widget :args args)
2774 ;;; The `plist' Widget.
2776 (define-widget 'plist 'list
2778 :match (lambda (widget value)
2779 (valid-plist-p value))
2780 :convert-widget 'custom-plist-convert-widget
2781 :tag "Property List")
2783 ;; #### Should handle options better.
2784 (defun custom-plist-convert-widget (widget)
2785 (let* ((options (widget-get widget :options))
2786 (other `(editable-list :inline t
2788 (symbol :format "%t: %v "
2791 (sexp :tag "Value"))))
2794 `((checklist :inline t
2795 ,@(mapcar 'custom-plist-process-option options))
2798 (widget-put widget :args args)
2801 (defun custom-plist-process-option (entry)
2803 (const :tag "Property"
2807 (sexp :tag "Value")))
2809 ;;; The `custom-group-link' Widget.
2811 (define-widget 'custom-group-link 'link
2812 "Show parent in other window when activated."
2813 :help-echo 'custom-group-link-help-echo
2814 :action 'custom-group-link-action)
2816 (defun custom-group-link-help-echo (widget)
2817 (concat "Create customization buffer for the `"
2818 (custom-unlispify-tag-name (widget-value widget))
2821 (defun custom-group-link-action (widget &rest ignore)
2822 (customize-group (widget-value widget)))
2824 ;;; The `custom-group' Widget.
2826 (defcustom custom-group-tag-faces nil
2827 ;; In XEmacs, this ought to play games with font size.
2828 "Face used for group tags.
2829 The first member is used for level 1 groups, the second for level 2,
2830 and so forth. The remaining group tags are shown with
2831 `custom-group-tag-face'."
2832 :type '(repeat face)
2833 :group 'custom-faces)
2835 (defface custom-group-tag-face-1 '((((class color)
2837 (:foreground "pink" :underline t))
2840 (:foreground "red" :underline t))
2842 "Face used for group tags.")
2844 (defface custom-group-tag-face '((((class color)
2846 (:foreground "light blue" :underline t))
2849 (:foreground "blue" :underline t))
2851 "Face used for low level group tags."
2852 :group 'custom-faces)
2854 (define-widget 'custom-group 'custom
2857 :sample-face-get 'custom-group-sample-face-get
2858 :documentation-property 'group-documentation
2859 :help-echo "Set or reset all members of this group"
2860 :value-create 'custom-group-value-create
2861 :action 'custom-group-action
2862 :custom-category 'group
2863 :custom-set 'custom-group-set
2864 :custom-save 'custom-group-save
2865 :custom-reset-current 'custom-group-reset-current
2866 :custom-reset-saved 'custom-group-reset-saved
2867 :custom-reset-standard 'custom-group-reset-standard
2868 :custom-menu 'custom-group-menu-create)
2870 (defun custom-group-sample-face-get (widget)
2871 ;; Use :sample-face.
2872 (or (nth (1- (widget-get widget :custom-level)) custom-group-tag-faces)
2873 'custom-group-tag-face))
2875 (define-widget 'custom-group-visibility 'visibility
2876 "An indicator and manipulator for hidden group contents."
2877 :create 'custom-group-visibility-create)
2879 (defun custom-group-visibility-create (widget)
2880 (let ((visible (widget-value widget)))
2882 (insert "--------")))
2883 (widget-default-create widget))
2885 (defun custom-group-members (symbol groups-only)
2886 "Return SYMBOL's custom group members.
2887 If GROUPS-ONLY non-nil, return only those members that are groups."
2888 (if (not groups-only)
2889 (get symbol 'custom-group)
2891 (dolist (entry (get symbol 'custom-group) (nreverse members))
2892 (when (eq (nth 1 entry) 'custom-group)
2893 (push entry members))))))
2895 (defun custom-group-value-create (widget)
2896 "Insert a customize group for WIDGET in the current buffer."
2897 (let* ((state (widget-get widget :custom-state))
2898 (level (widget-get widget :custom-level))
2899 ;; (indent (widget-get widget :indent))
2900 (prefix (widget-get widget :custom-prefix))
2901 (buttons (widget-get widget :buttons))
2902 (tag (widget-get widget :tag))
2903 (symbol (widget-value widget))
2904 (members (custom-group-members symbol
2905 (and (eq custom-buffer-style 'tree)
2906 custom-browse-only-groups))))
2907 (cond ((and (eq custom-buffer-style 'tree)
2909 (or members (custom-unloaded-widget-p widget)))
2910 (custom-browse-insert-prefix prefix)
2911 (push (widget-create-child-and-convert
2912 widget 'custom-browse-visibility
2913 ;; :tag-glyph "plus"
2917 ;; (widget-glyph-insert nil "-- " "horizontal")
2918 (push (widget-create-child-and-convert
2919 widget 'custom-browse-group-tag)
2921 (insert " " tag "\n")
2922 (widget-put widget :buttons buttons))
2923 ((and (eq custom-buffer-style 'tree)
2924 (zerop (length members)))
2925 (custom-browse-insert-prefix prefix)
2927 ;; (widget-glyph-insert nil "[ ]" "empty")
2928 ;; (widget-glyph-insert nil "-- " "horizontal")
2929 (push (widget-create-child-and-convert
2930 widget 'custom-browse-group-tag)
2932 (insert " " tag "\n")
2933 (widget-put widget :buttons buttons))
2934 ((eq custom-buffer-style 'tree)
2935 (custom-browse-insert-prefix prefix)
2936 (custom-load-widget widget)
2937 (if (zerop (length members))
2939 (custom-browse-insert-prefix prefix)
2941 ;; (widget-glyph-insert nil "[ ]" "empty")
2942 ;; (widget-glyph-insert nil "-- " "horizontal")
2943 (push (widget-create-child-and-convert
2944 widget 'custom-browse-group-tag)
2946 (insert " " tag "\n")
2947 (widget-put widget :buttons buttons))
2948 (push (widget-create-child-and-convert
2949 widget 'custom-browse-visibility
2950 ;; :tag-glyph "minus"
2954 ;; (widget-glyph-insert nil "-\\ " "top")
2955 (push (widget-create-child-and-convert
2956 widget 'custom-browse-group-tag)
2958 (insert " " tag "\n")
2959 (widget-put widget :buttons buttons)
2960 (message "Creating group...")
2961 (let* ((members (custom-sort-items members
2962 custom-browse-sort-alphabetically
2963 custom-browse-order-groups))
2964 (prefixes (widget-get widget :custom-prefixes))
2965 (custom-prefix-list (custom-prefix-add symbol prefixes))
2966 (extra-prefix (if (widget-get widget :custom-last)
2969 (prefix (concat prefix extra-prefix))
2972 (setq entry (car members)
2973 members (cdr members))
2974 (push (widget-create-child-and-convert
2975 widget (nth 1 entry)
2977 :tag (custom-unlispify-tag-name (nth 0 entry))
2978 :custom-prefixes custom-prefix-list
2979 :custom-level (1+ level)
2980 :custom-last (null members)
2981 :value (nth 0 entry)
2982 :custom-prefix prefix)
2984 (widget-put widget :children (reverse children)))
2985 (message "Creating group...done")))
2988 ;; Create level indicator.
2989 (unless (eq custom-buffer-style 'links)
2990 (insert-char ?\ (* custom-buffer-indent (1- level)))
2992 ;; Create link indicator.
2993 (when (eq custom-buffer-style 'links)
2995 (push (widget-create-child-and-convert
2996 widget 'custom-group-link
2998 :tag-glyph '("open-up" "open-down")
3003 (let ((begin (point)))
3005 (widget-specify-sample widget begin (point)))
3007 ;; Create visibility indicator.
3008 (unless (eq custom-buffer-style 'links)
3010 (push (widget-create-child-and-convert
3011 widget 'custom-group-visibility
3012 :help-echo "Show members of this group"
3013 :action 'custom-toggle-parent
3014 (not (eq state 'hidden)))
3017 ;; Create magic button.
3018 (let ((magic (widget-create-child-and-convert
3019 widget 'custom-magic nil)))
3020 (widget-put widget :custom-magic magic)
3021 (push magic buttons))
3023 (widget-put widget :buttons buttons)
3024 ;; Insert documentation.
3025 (if (and (eq custom-buffer-style 'links) (> level 1))
3026 (widget-put widget :documentation-indent 0))
3027 (widget-default-format-handler widget ?h))
3030 (custom-load-widget widget)
3032 (setq members (custom-group-members
3033 symbol (and (eq custom-buffer-style 'tree)
3034 custom-browse-only-groups)))
3035 ;; Add parent groups references above the group.
3036 (if t ;;; This should test that the buffer
3037 ;;; was made to display a group.
3039 (if (custom-add-parent-links widget
3040 "Go to parent group:")
3042 ;; Create level indicator.
3043 (insert-char ?\ (* custom-buffer-indent (1- level)))
3046 (let ((start (point)))
3048 (widget-specify-sample widget start (point)))
3050 ;; Create visibility indicator.
3051 (unless (eq custom-buffer-style 'links)
3053 (push (widget-create-child-and-convert
3055 :help-echo "Hide members of this group"
3056 :action 'custom-toggle-parent
3057 (not (eq state 'hidden)))
3060 ;; Create more dashes.
3061 ;; Use 76 instead of 75 to compensate for the temporary "<"
3062 ;; added by `widget-insert'.
3063 (insert-char ?- (- 76 (current-column)
3064 (* custom-buffer-indent level)))
3066 ;; Create magic button.
3067 (let ((magic (widget-create-child-and-convert
3068 widget 'custom-magic
3071 (widget-put widget :custom-magic magic)
3072 (push magic buttons))
3074 (widget-put widget :buttons buttons)
3075 ;; Insert documentation.
3076 (widget-default-format-handler widget ?h)
3078 (if nil ;;; This should test that the buffer
3079 ;;; was not made to display a group.
3081 (insert-char ?\ custom-buffer-indent)
3082 (custom-add-parent-links widget)))
3083 (custom-add-see-also widget
3084 (make-string (* custom-buffer-indent level)
3087 (message "Creating group...")
3088 (let* ((members (custom-sort-items members
3089 custom-buffer-sort-alphabetically
3090 custom-buffer-order-groups))
3091 (prefixes (widget-get widget :custom-prefixes))
3092 (custom-prefix-list (custom-prefix-add symbol prefixes))
3093 (length (length members))
3097 (widget-insert "\n")
3098 (when (zerop (% count custom-skip-messages))
3102 Creating group members... %2d%%"
3103 (/ (* 100.0 count) length))))
3106 (widget-create-child-and-convert
3107 widget (nth 1 entry)
3109 :tag (custom-unlispify-tag-name
3111 :custom-prefixes custom-prefix-list
3112 :custom-level (1+ level)
3113 :value (nth 0 entry))
3114 (unless (eq (preceding-char) ?\n)
3115 (widget-insert "\n"))))
3117 (message "Creating group magic...")
3118 (mapc 'custom-magic-reset children)
3119 (message "Creating group state...")
3120 (widget-put widget :children children)
3121 (custom-group-state-update widget)
3122 (message "Creating group... done"))
3125 (insert-char ?\ (* custom-buffer-indent (1- level)))
3126 (insert "\\- " (widget-get widget :tag) " group end ")
3127 (insert-char ?- (- 75 (current-column) (* custom-buffer-indent level)))
3130 (defvar custom-group-menu
3131 '(("Set for Current Session" custom-group-set
3133 (eq (widget-get widget :custom-state) 'modified)))
3134 ("Save for Future Sessions" custom-group-save
3136 (memq (widget-get widget :custom-state) '(modified set))))
3137 ("Reset to Current" custom-group-reset-current
3139 (memq (widget-get widget :custom-state) '(modified))))
3140 ("Reset to Saved" custom-group-reset-saved
3142 (memq (widget-get widget :custom-state) '(modified set))))
3143 ("Reset to standard setting" custom-group-reset-standard
3145 (memq (widget-get widget :custom-state) '(modified set saved)))))
3146 "Alist of actions for the `custom-group' widget.
3147 Each entry has the form (NAME ACTION FILTER) where NAME is the name of
3148 the menu entry, ACTION is the function to call on the widget when the
3149 menu is selected, and FILTER is a predicate which takes a `custom-group'
3150 widget as an argument, and returns non-nil if ACTION is valid on that
3151 widget. If FILTER is nil, ACTION is always valid.")
3153 (defun custom-group-action (widget &optional event)
3154 "Show the menu for `custom-group' WIDGET.
3155 Optional EVENT is the location for the menu."
3156 (if (eq (widget-get widget :custom-state) 'hidden)
3157 (custom-toggle-hide widget)
3158 (let* ((completion-ignore-case t)
3159 (answer (widget-choose (concat "Operation on "
3160 (custom-unlispify-tag-name
3161 (widget-get widget :value)))
3162 (custom-menu-filter custom-group-menu
3166 (funcall answer widget)))))
3168 (defun custom-group-set (widget)
3169 "Set changes in all modified group members."
3170 (let ((children (widget-get widget :children)))
3171 (mapc (lambda (child)
3172 (when (eq (widget-get child :custom-state) 'modified)
3173 (widget-apply child :custom-set)))
3176 (defun custom-group-save (widget)
3177 "Save all modified group members."
3178 (let ((children (widget-get widget :children)))
3179 (mapc (lambda (child)
3180 (when (memq (widget-get child :custom-state) '(modified set))
3181 (widget-apply child :custom-save)))
3184 (defun custom-group-reset-current (widget)
3185 "Reset all modified group members."
3186 (let ((children (widget-get widget :children)))
3187 (mapc (lambda (child)
3188 (when (eq (widget-get child :custom-state) 'modified)
3189 (widget-apply child :custom-reset-current)))
3192 (defun custom-group-reset-saved (widget)
3193 "Reset all modified or set group members."
3194 (let ((children (widget-get widget :children)))
3195 (mapc (lambda (child)
3196 (when (memq (widget-get child :custom-state) '(modified set))
3197 (widget-apply child :custom-reset-saved)))
3200 (defun custom-group-reset-standard (widget)
3201 "Reset all modified, set, or saved group members."
3202 (let ((children (widget-get widget :children)))
3203 (mapc (lambda (child)
3204 (when (memq (widget-get child :custom-state)
3205 '(modified set saved))
3206 (widget-apply child :custom-reset-standard)))
3209 (defun custom-group-state-update (widget)
3211 (unless (eq (widget-get widget :custom-state) 'hidden)
3212 (let* ((children (widget-get widget :children))
3213 (states (mapcar (lambda (child)
3214 (widget-get child :custom-state))
3216 (magics custom-magic-alist)
3219 (let ((magic (car (car magics))))
3220 (if (and (not (eq magic 'hidden))
3221 (memq magic states))
3224 (setq magics (cdr magics)))))
3225 (widget-put widget :custom-state found)))
3226 (custom-magic-reset widget))
3228 ;;; The `custom-save-all' Function.
3230 (defcustom custom-file "~/.emacs"
3231 "File used for storing customization information.
3232 If you change this from the default \"~/.emacs\" you need to
3233 explicitly load that file for the settings to take effect."
3237 (defun custom-save-delete (symbol)
3238 "Delete the call to SYMBOL form in `custom-file'.
3239 Leave point at the location of the call, or after the last expression."
3240 (let ((find-file-hooks nil)
3241 (auto-mode-alist nil))
3242 (set-buffer (find-file-noselect custom-file)))
3243 (goto-char (point-min))
3246 (let ((sexp (condition-case nil
3247 (read (current-buffer))
3248 (end-of-file (throw 'found nil)))))
3249 (when (and (listp sexp)
3250 (eq (car sexp) symbol))
3251 (delete-region (save-excursion
3255 (throw 'found nil))))))
3257 (defun custom-save-variables ()
3258 "Save all customized variables in `custom-file'."
3260 (custom-save-delete 'custom-load-themes)
3261 (custom-save-delete 'custom-reset-variables)
3262 (custom-save-delete 'custom-set-variables)
3263 (custom-save-loaded-themes)
3264 (custom-save-resets 'theme-value 'custom-reset-variables nil)
3265 (let ((standard-output (current-buffer)))
3268 (princ "(custom-set-variables")
3269 (mapatoms (lambda (symbol)
3270 (let ((spec (car-safe (get symbol 'theme-value)))
3271 (requests (get symbol 'custom-requests))
3272 (now (not (or (get symbol 'standard-value)
3273 (and (not (boundp symbol))
3274 (not (eq (get symbol 'force-value)
3276 (comment (get symbol 'saved-variable-comment)))
3277 (when (or (and spec (eq (car spec) 'user)
3278 (eq (second spec) 'set)) comment)
3282 ;; This comment stuf is in the way ####
3283 ;; Is (eq (third spec) (car saved-value)) ????
3284 ;; (prin1 (third spec))
3285 (prin1 (car (get symbol 'saved-value)))
3286 (when (or now requests comment)
3287 (princ (if now " t" " nil")))
3288 (when (or comment requests)
3296 (unless (looking-at "\n")
3299 (defvar custom-save-face-ignoring nil)
3301 (defun custom-save-face-internal (symbol)
3302 (let ((theme-spec (car-safe (get symbol 'theme-face)))
3303 (comment (get symbol 'saved-face-comment))
3304 (now (not (or (get symbol 'face-defface-spec)
3305 (and (not (find-face symbol))
3306 (not (eq (get symbol 'force-face) 'rogue)))))))
3307 (when (or (and (not (memq symbol custom-save-face-ignoring))
3308 ;; Don't print default face here.
3310 (eq (car theme-spec) 'user)
3311 (eq (second theme-spec) 'set)) comment)
3315 (prin1 (get symbol 'saved-face))
3316 (if (or comment now)
3317 (princ (if now " t" " nil")))
3323 (defun custom-save-faces ()
3324 "Save all customized faces in `custom-file'."
3326 (custom-save-delete 'custom-reset-faces)
3327 (custom-save-delete 'custom-set-faces)
3328 (custom-save-resets 'theme-face 'custom-reset-faces '(default))
3329 (let ((standard-output (current-buffer)))
3332 (princ "(custom-set-faces")
3333 ;; The default face must be first, since it affects the others.
3334 (custom-save-face-internal 'default)
3335 (let ((custom-save-face-ignoring '(default)))
3336 (mapatoms #'custom-save-face-internal))
3338 (unless (looking-at "\n")
3341 (defun custom-save-resets (property setter special)
3342 (let (started-writing ignored-special)
3343 ;; (custom-save-delete setter) Done by caller
3344 (let ((standard-output (current-buffer))
3345 (mapper `(lambda (object)
3346 (let ((spec (car-safe (get object (quote ,property)))))
3347 (when (and (not (memq object ignored-special))
3348 (eq (car spec) 'user)
3349 (eq (second spec) 'reset))
3350 ;; Do not write reset statements unless necessary.
3351 (unless started-writing
3352 (setq started-writing t)
3356 (princ (quote ,setter))
3360 (prin1 (third spec))
3362 (mapc mapper special)
3363 (setq ignored-special special)
3365 (when started-writing
3369 (defun custom-save-loaded-themes ()
3370 (let ((themes (reverse (get 'user 'theme-loads-themes)))
3371 (standard-output (current-buffer)))
3373 (unless (bolp) (princ "\n"))
3374 (princ "(custom-load-themes")
3375 (mapc (lambda (theme)
3377 (prin1 theme)) themes)
3381 (defun customize-save-customized ()
3382 "Save all user options which have been set in this session."
3384 (mapatoms (lambda (symbol)
3385 (let ((face (get symbol 'customized-face))
3386 (value (get symbol 'customized-value))
3387 (face-comment (get symbol 'customized-face-comment))
3389 (get symbol 'customized-variable-comment)))
3391 (put symbol 'saved-face face)
3392 (custom-push-theme 'theme-face symbol 'user 'set value)
3393 (put symbol 'customized-face nil))
3395 (put symbol 'saved-value value)
3396 (custom-push-theme 'theme-value symbol 'user 'set value)
3397 (put symbol 'customized-value nil))
3398 (when variable-comment
3399 (put symbol 'saved-variable-comment variable-comment)
3400 (put symbol 'customized-variable-comment nil))
3402 (put symbol 'saved-face-comment face-comment)
3403 (put symbol 'customized-face-comment nil)))))
3404 ;; We really should update all custom buffers here.
3408 (defun custom-save-all ()
3409 "Save all customizations in `custom-file'."
3410 (let ((inhibit-read-only t))
3411 (custom-save-variables)
3413 (let ((find-file-hooks nil)
3415 (with-current-buffer (find-file-noselect custom-file)
3419 ;;; The Customize Menu.
3423 (defun custom-face-menu-create (widget symbol)
3424 "Ignoring WIDGET, create a menu entry for customization face SYMBOL."
3425 (vector (custom-unlispify-menu-entry symbol)
3426 `(customize-face ',symbol)
3429 (defun custom-variable-menu-create (widget symbol)
3430 "Ignoring WIDGET, create a menu entry for customization variable SYMBOL."
3431 (let ((type (get symbol 'custom-type)))
3432 (unless (listp type)
3433 (setq type (list type)))
3434 (if (and type (widget-get type :custom-menu))
3435 (widget-apply type :custom-menu symbol)
3436 (vector (custom-unlispify-menu-entry symbol)
3437 `(customize-variable ',symbol)
3440 ;; Add checkboxes to boolean variable entries.
3441 (widget-put (get 'boolean 'widget-type)
3442 :custom-menu (lambda (widget symbol)
3443 `[,(custom-unlispify-menu-entry symbol)
3444 (customize-variable ',symbol)
3446 :selected ,symbol]))
3448 ;; XEmacs can create menus dynamically.
3449 (defun custom-group-menu-create (widget symbol)
3450 "Ignoring WIDGET, create a menu entry for customization group SYMBOL."
3451 `( ,(custom-unlispify-menu-entry symbol t)
3452 :filter (lambda (&rest junk)
3453 (let ((item (custom-menu-create ',symbol)))
3459 (defun custom-menu-create (symbol)
3460 "Create menu for customization group SYMBOL.
3461 The menu is in a format applicable to `easy-menu-define'."
3462 (let* ((item (vector (custom-unlispify-menu-entry symbol)
3463 `(customize-group ',symbol)
3465 ;; Item is the entry for creating a menu buffer for SYMBOL.
3466 ;; We may nest, if the menu is not too big.
3467 (custom-load-symbol symbol)
3468 (if (< (length (get symbol 'custom-group)) widget-menu-max-size)
3469 ;; The menu is not too big.
3470 (let ((custom-prefix-list (custom-prefix-add symbol
3471 custom-prefix-list))
3472 (members (custom-sort-items (get symbol 'custom-group)
3473 custom-menu-sort-alphabetically
3474 custom-menu-order-groups)))
3476 `(,(custom-unlispify-menu-entry symbol t)
3479 ,@(mapcar (lambda (entry)
3480 (widget-apply (if (listp (nth 1 entry))
3482 (list (nth 1 entry)))
3483 :custom-menu (nth 0 entry)))
3485 ;; The menu was too big.
3489 (defun customize-menu-create (symbol &optional name)
3490 "Return a customize menu for customization group SYMBOL.
3491 If optional NAME is given, use that as the name of the menu.
3492 Otherwise the menu will be named `Customize'.
3493 The format is suitable for use with `easy-menu-define'."
3495 (setq name "Customize"))
3497 :filter (lambda (&rest junk)
3498 (cdr (custom-menu-create ',symbol)))))
3500 ;;; The Custom Mode.
3502 (defvar custom-mode-map nil
3503 "Keymap for `custom-mode'.")
3505 (unless custom-mode-map
3506 (setq custom-mode-map (make-sparse-keymap))
3507 (set-keymap-parents custom-mode-map widget-keymap)
3508 (suppress-keymap custom-mode-map)
3509 (define-key custom-mode-map " " 'scroll-up)
3510 (define-key custom-mode-map [delete] 'scroll-down)
3511 (define-key custom-mode-map "q" 'Custom-buffer-done)
3512 (define-key custom-mode-map "u" 'Custom-goto-parent)
3513 (define-key custom-mode-map "n" 'widget-forward)
3514 (define-key custom-mode-map "p" 'widget-backward))
3516 (easy-menu-define Custom-mode-menu
3518 "Menu used in customization buffers."
3520 ,(customize-menu-create 'customize)
3521 ["Set" Custom-set t]
3522 ["Save" Custom-save t]
3523 ["Reset to Current" Custom-reset-current t]
3524 ["Reset to Saved" Custom-reset-saved t]
3525 ["Reset to Standard Settings" Custom-reset-standard t]
3526 ["Info" (Info-goto-node "(xemacs)Easy Customization") t]))
3528 (defun Custom-goto-parent ()
3529 "Go to the parent group listed at the top of this buffer.
3530 If several parents are listed, go to the first of them."
3533 (goto-char (point-min))
3534 (if (search-forward "\nGo to parent group: " nil t)
3535 (let* ((button (get-char-property (point) 'button))
3536 (parent (downcase (widget-get button :tag))))
3537 (customize-group parent)))))
3539 (defcustom custom-mode-hook nil
3540 "Hook called when entering custom-mode."
3542 :group 'custom-buffer )
3544 (defun custom-state-buffer-message (widget)
3545 (if (eq (widget-get (widget-get widget :parent) :custom-state) 'modified)
3547 "To install your edits, invoke [State] and choose the Set operation")))
3549 (defun custom-mode ()
3550 "Major mode for editing customization buffers.
3552 The following commands are available:
3554 Move to next button or editable field. \\[widget-forward]
3555 Move to previous button or editable field. \\[widget-backward]
3556 \\<widget-field-keymap>\
3557 Complete content of editable text field. \\[widget-complete]
3558 \\<custom-mode-map>\
3559 Invoke button under point. \\[widget-button-press]
3560 Set all modifications. \\[Custom-set]
3561 Make all modifications default. \\[Custom-save]
3562 Reset all modified options. \\[Custom-reset-current]
3563 Reset all modified or set options. \\[Custom-reset-saved]
3564 Reset all options. \\[Custom-reset-standard]
3566 Entry to this mode calls the value of `custom-mode-hook'
3567 if that value is non-nil."
3568 (kill-all-local-variables)
3569 (setq major-mode 'custom-mode
3571 (use-local-map custom-mode-map)
3572 (easy-menu-add Custom-mode-menu)
3573 (make-local-variable 'custom-options)
3574 (make-local-variable 'widget-documentation-face)
3575 (setq widget-documentation-face 'custom-documentation-face)
3576 (make-local-variable 'widget-button-face)
3577 (setq widget-button-face 'custom-button-face)
3578 (make-local-hook 'widget-edit-functions)
3579 (add-hook 'widget-edit-functions 'custom-state-buffer-message nil t)
3580 (run-hooks 'custom-mode-hook))
3587 ;; cus-edit.el ends here