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