-;;; cus-edit.el --- Tools for customizing Emacs and Lisp packages.
+;;; cus-edit.el --- tools for customizing Emacs and Lisp packages
;;
-;; Copyright (C) 1996, 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: help, faces
(defcustom custom-unlispify-remove-prefixes nil
"Non-nil means remove group prefixes from option names in buffer."
:group 'custom-menu
+ :group 'custom-buffer
:type 'boolean)
(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
(list var val))))
;;;###autoload
-(defun customize-set-value (var val &optional comment)
- "Set VARIABLE to VALUE. VALUE is a Lisp object.
+(defun customize-set-value (variable value &optional comment)
+ "Set VARIABLE to VALUE, and return VALUE. VALUE is a Lisp object.
If VARIABLE has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.
"Set %s to value: "
current-prefix-arg))
- (set var val)
(cond ((string= comment "")
- (put var 'variable-comment nil))
+ (put variable 'variable-comment nil))
(comment
- (put var 'variable-comment comment))))
+ (put variable 'variable-comment comment)))
+ (set variable value))
;;;###autoload
(defun customize-set-variable (variable value &optional comment)
- "Set the default for VARIABLE to VALUE. VALUE is a Lisp object.
+ "Set the default for VARIABLE to VALUE, and return VALUE.
+VALUE is a Lisp object.
If VARIABLE has a `custom-set' property, that is used for setting
VARIABLE, otherwise `set-default' is used.
(interactive (custom-prompt-variable "Set variable: "
"Set customized value for %s to: "
current-prefix-arg))
+ (custom-load-symbol variable)
(funcall (or (get variable 'custom-set) 'set-default) variable value)
(put variable 'customized-value (list (custom-quote value)))
(cond ((string= comment "")
(put variable 'customized-variable-comment nil))
(comment
(put variable 'variable-comment comment)
- (put variable 'customized-variable-comment comment))))
+ (put variable 'customized-variable-comment comment)))
+ value)
;;;###autoload
-(defun customize-save-variable (var value &optional comment)
+(defun customize-save-variable (variable value &optional comment)
"Set the default for VARIABLE to VALUE, and save it for future sessions.
+Return VALUE.
+
If VARIABLE has a `custom-set' property, that is used for setting
VARIABLE, otherwise `set-default' is used.
`:prompt-value' property of that widget will be used for reading the value.
If given a prefix (or a COMMENT argument), also prompt for a comment."
- (interactive (custom-prompt-variable "Set and ave variable: "
+ (interactive (custom-prompt-variable "Set and save variable: "
"Set and save value for %s as: "
current-prefix-arg))
- (funcall (or (get var 'custom-set) 'set-default) var value)
- (put var 'saved-value (list (custom-quote value)))
+ (funcall (or (get variable 'custom-set) 'set-default) variable value)
+ (put variable 'saved-value (list (custom-quote value)))
(cond ((string= comment "")
- (put var 'variable-comment nil)
- (put var 'saved-variable-comment nil))
+ (put variable 'variable-comment nil)
+ (put variable 'saved-variable-comment nil))
(comment
- (put var 'variable-comment comment)
- (put var 'saved-variable-comment comment)))
- (custom-save-all))
+ (put variable 'variable-comment comment)
+ (put variable 'saved-variable-comment comment)))
+ (custom-save-all)
+ value)
;;;###autoload
(defun customize ()
(format "*Customize Option: %s*" (custom-unlispify-tag-name symbol))))
;;;###autoload
-(defun customize-face (&optional symbol)
+(defun customize-face (&optional face)
"Customize SYMBOL, which should be a face name or nil.
-If SYMBOL is nil, customize all faces."
- (interactive (list (completing-read "Customize face: (default all) "
- obarray 'custom-facep t)))
- (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
+If SYMBOL is nil, customize all faces.
+
+Interactively, when point is on text which has a face specified,
+suggest to customized that face, if it's customizable."
+ (interactive
+ (list (read-face-name "Customize face" "all faces" t)))
+ (if (member face '(nil ""))
+ (setq face (face-list)))
+ (if (and (listp face) (null (cdr face)))
+ (setq face (car face)))
+ (if (listp face)
(custom-buffer-create (custom-sort-items
- (mapcar (lambda (symbol)
- (list symbol 'custom-face))
- (face-list))
+ (mapcar (lambda (s)
+ (list s 'custom-face))
+ face)
t nil)
"*Customize Faces*")
- (when (stringp symbol)
- (setq symbol (intern symbol)))
- (unless (symbolp symbol)
- (error "Should be a symbol %S" symbol))
- (custom-buffer-create (list (list symbol 'custom-face))
+ (unless (facep face)
+ (error "Invalid face %S"))
+ (custom-buffer-create (list (list face 'custom-face))
(format "*Customize Face: %s*"
- (custom-unlispify-tag-name symbol)))))
+ (custom-unlispify-tag-name face)))))
;;;###autoload
-(defun customize-face-other-window (&optional symbol)
- "Show customization buffer for face SYMBOL in other window."
- (interactive (list (completing-read "Customize face: "
- obarray 'custom-facep t)))
- (if (or (null symbol) (and (stringp symbol) (zerop (length symbol))))
- ()
- (if (stringp symbol)
- (setq symbol (intern symbol)))
- (unless (symbolp symbol)
- (error "Should be a symbol %S" symbol))
+(defun customize-face-other-window (&optional face)
+ "Show customization buffer for face SYMBOL in other window.
+
+Interactively, when point is on text which has a face specified,
+suggest to customized that face, if it's customizable."
+ (interactive
+ (list (read-face-name "Customize face" "all faces" t)))
+ (if (member face '(nil ""))
+ (setq face (face-list)))
+ (if (and (listp face) (null (cdr face)))
+ (setq face (car face)))
+ (if (listp face)
+ (custom-buffer-create-other-window
+ (custom-sort-items
+ (mapcar (lambda (s)
+ (list s 'custom-face))
+ face)
+ t nil)
+ "*Customize Faces*")
+ (unless (facep face)
+ (error "Invalid face %S"))
(custom-buffer-create-other-window
- (list (list symbol 'custom-face))
- (format "*Customize Face: %s*" (custom-unlispify-tag-name symbol)))))
+ (list (list face 'custom-face))
+ (format "*Customize Face: %s*"
+ (custom-unlispify-tag-name face)))))
;;;###autoload
(defun customize-customized ()
:type 'boolean
:group 'custom-buffer)
+(defcustom custom-buffer-verbose-help t
+ "If non-nil, include explanatory text in the customization buffer."
+ :type 'boolean
+ :group 'custom-buffer)
+
(defun Custom-buffer-done (&rest ignore)
"Remove current buffer by calling `custom-buffer-done-function'."
(interactive)
(defun custom-buffer-create-internal (options &optional description)
(message "Creating customization buffer...")
(custom-mode)
- (widget-insert "This is a customization buffer")
- (if description
- (widget-insert description))
- (widget-insert (format ".
+ (if custom-buffer-verbose-help
+ (progn
+ (widget-insert "This is a customization buffer")
+ (if description
+ (widget-insert description))
+ (widget-insert (format ".
%s show active fields; type RET or click mouse-1
on an active field to invoke its action. Editing an option value
changes the text in the buffer; invoke the State button and
Invoke " (if custom-raised-buttons
"`Raised' buttons"
"Square brackets")))
- (widget-create 'info-link
- :tag "Help"
- :help-echo "Read the online help."
- "(emacs)Easy Customization")
- (widget-insert " for more information.\n\n")
- (message "Creating customization buttons...")
- (widget-insert "Operate on everything in this buffer:\n ")
+ (widget-create 'info-link
+ :tag "Help"
+ :help-echo "Read the online help."
+ "(emacs)Easy Customization")
+ (widget-insert " for more information.\n\n")
+ (message "Creating customization buttons...")
+ (widget-insert "Operate on everything in this buffer:\n "))
+ (widget-insert " "))
(widget-create 'push-button
:tag "Set for Current Session"
:help-echo "\
:help-echo "\
Un-customize all values in this buffer. They get their standard settings."
:action 'Custom-reset-standard))
+ (if (not custom-buffer-verbose-help)
+ (progn
+ (widget-insert " ")
+ (widget-create 'info-link
+ :tag "Help"
+ :help-echo "Read the online help."
+ "(emacs)Easy Customization")))
(widget-insert " ")
(widget-create 'push-button
:tag "Finish"
options))))
(unless (eq (preceding-char) ?\n)
(widget-insert "\n"))
- (message "Creating customization items ...%2d%%done" 100)
+ (message "Creating customization items ...done")
(unless (eq custom-buffer-style 'tree)
(mapc 'custom-magic-reset custom-options))
(message "Creating customization setup...")
(defface custom-invalid-face '((((class color))
(:foreground "yellow" :background "red"))
(t
- (:bold t :italic t :underline t)))
+ (:weight bold :slant italic :underline t)))
"Face used when the customize item is invalid."
:group 'custom-magic-faces)
(defface custom-modified-face '((((class color))
(:foreground "white" :background "blue"))
(t
- (:italic t :bold)))
+ (:slant italic :bold)))
"Face used when the customize item has been modified."
:group 'custom-magic-faces)
(defface custom-set-face '((((class color))
(:foreground "blue" :background "white"))
(t
- (:italic t)))
+ (:slant italic)))
"Face used when the customize item has been set."
:group 'custom-magic-faces)
(defface custom-changed-face '((((class color))
(:foreground "white" :background "blue"))
(t
- (:italic t)))
+ (:slant italic)))
"Face used when the customize item has been changed."
:group 'custom-magic-faces)
(t
(funcall show widget value)))))
-(defvar custom-load-recursion nil
- "Hack to avoid recursive dependencies.")
-
-(defun custom-load-symbol (symbol)
- "Load all dependencies for SYMBOL."
- (unless custom-load-recursion
- (let ((custom-load-recursion t)
- (loads (get symbol 'custom-loads))
- load)
- (while loads
- (setq load (car loads)
- loads (cdr loads))
- (cond ((symbolp load)
- (condition-case nil
- (require load)
- (error nil)))
- ;; Don't reload a file already loaded.
- ((and (boundp 'preloaded-file-list)
- (member load preloaded-file-list)))
- ((assoc load load-history))
- ((assoc (locate-library load) load-history))
- (t
- (condition-case nil
- ;; Without this, we would load cus-edit recursively.
- ;; We are still loading it when we call this,
- ;; and it is not in load-history yet.
- (or (equal load "cus-edit")
- (load-library load))
- (error nil))))))))
-
(defun custom-load-widget (widget)
"Load all dependencies for WIDGET."
(custom-load-symbol (widget-value widget)))
(background dark))
(:background "dim gray"))
(t
- (:italic t)))
+ (:slant italic)))
"Face used for comments on variables or faces"
:version "21.1"
:group 'custom-faces)
'((((class color) (background dark)) (:foreground "gray80"))
(((class color) (background light)) (:foreground "blue4"))
(((class grayscale) (background light))
- (:foreground "DimGray" :bold t :italic t))
+ (:foreground "DimGray" :weight bold :slant italic))
(((class grayscale) (background dark))
- (:foreground "LightGray" :bold t :italic t))
- (t (:bold t)))
+ (:foreground "LightGray" :weight bold :slant italic))
+ (t (:weight bold)))
"Face used for variables or faces comment tags"
:group 'custom-faces)
(defface custom-variable-tag-face
`((((class color)
(background dark))
- (:foreground "light blue" :bold t :height 1.2 :inherit variable-pitch))
+ (:foreground "light blue" :weight bold :height 1.2 :inherit variable-pitch))
(((class color)
(background light))
- (:foreground "blue" :bold t :height 1.2 :inherit variable-pitch))
- (t (:bold t)))
+ (:foreground "blue" :weight bold :height 1.2 :inherit variable-pitch))
+ (t (:weight bold)))
"Face used for unpushable variable tags."
:group 'custom-faces)
-(defface custom-variable-button-face '((t (:underline t :bold t)))
+(defface custom-variable-button-face '((t (:underline t :weight bold)))
"Face used for pushable variable tags."
:group 'custom-faces)
:tag "Attributes"
:extra-offset 12
:button-args '(:help-echo "Control whether this attribute has any effect.")
+ :value-to-internal 'custom-face-edit-fix-value
+ :match (lambda (widget value)
+ (widget-checklist-match widget
+ (custom-face-edit-fix-value widget value)))
+ :convert-widget 'custom-face-edit-convert-widget
:args (mapcar (lambda (att)
(list 'group
:inline t
(nth 1 att)))
custom-face-attributes))
+(defun custom-face-edit-fix-value (widget value)
+ "Ignoring WIDGET, convert :bold and :italic in VALUE to new form."
+ (let (result)
+ (while value
+ (let ((key (car value))
+ (val (car (cdr value))))
+ (cond ((eq key :italic)
+ (push :slant result)
+ (push (if val 'italic 'normal) result))
+ ((eq key :bold)
+ (push :weight result)
+ (push (if val 'bold 'normal) result))
+ (t
+ (push key result)
+ (push val result))))
+ (setq value (cdr (cdr value))))
+ (setq result (nreverse result))
+ result))
+
+(defun custom-face-edit-convert-widget (widget)
+ "Convert :args as widget types in WIDGET."
+ (widget-put
+ widget
+ :args (mapcar (lambda (arg)
+ (widget-convert arg
+ :deactivate 'custom-face-edit-deactivate
+ :activate 'custom-face-edit-activate
+ :delete 'custom-face-edit-delete))
+ (widget-get widget :args)))
+ widget)
+
+(defun custom-face-edit-deactivate (widget)
+ "Make face widget WIDGET inactive for user modifications."
+ (unless (widget-get widget :inactive)
+ (let ((tag (custom-face-edit-attribute-tag widget))
+ (from (copy-marker (widget-get widget :from)))
+ (to (widget-get widget :to))
+ (value (widget-value widget))
+ (inhibit-read-only t)
+ (inhibit-modification-hooks t))
+ (save-excursion
+ (goto-char from)
+ (widget-default-delete widget)
+ (insert tag ": *\n")
+ (widget-put widget :inactive
+ (cons value (cons from (- (point) from))))))))
+
+(defun custom-face-edit-activate (widget)
+ "Make face widget WIDGET inactive for user modifications."
+ (let ((inactive (widget-get widget :inactive))
+ (inhibit-read-only t)
+ (inhibit-modification-hooks t))
+ (when (consp inactive)
+ (save-excursion
+ (goto-char (car (cdr inactive)))
+ (delete-region (point) (+ (point) (cdr (cdr inactive))))
+ (widget-put widget :inactive nil)
+ (widget-apply widget :create)
+ (widget-value-set widget (car inactive))
+ (widget-setup)))))
+
+(defun custom-face-edit-delete (widget)
+ "Remove widget from the buffer."
+ (let ((inactive (widget-get widget :inactive))
+ (inhibit-read-only t)
+ (inhibit-modification-hooks t))
+ (if (not inactive)
+ ;; Widget is alive, we don't have to do anything special
+ (widget-default-delete widget)
+ ;; WIDGET is already deleted because we did so to inactivate it;
+ ;; now just get rid of the label we put in its place.
+ (delete-region (car (cdr inactive))
+ (+ (car (cdr inactive)) (cdr (cdr inactive))))
+ (widget-put widget :inactive nil))))
+
+
+(defun custom-face-edit-attribute-tag (widget)
+ "Returns the first :tag property in WIDGET or one of its children."
+ (let ((tag (widget-get widget :tag)))
+ (or (and (not (equal tag "")) tag)
+ (let ((children (widget-get widget :children)))
+ (while (and (null tag) children)
+ (setq tag (custom-face-edit-attribute-tag (pop children))))
+ tag))))
+
;;; The `custom-display' Widget.
(define-widget 'custom-display 'menu-choice
(const :format "Dark\n"
:sibling-args (:help-echo "\
Match frames with dark backgrounds.")
- dark)))))))
+ dark)))
+ (group :sibling-args (:help-echo "\
+Only match frames that support the specified face attributes.")
+ (const :format "Supports attributes:" supports)
+ (custom-face-edit :inline t :format "%n%v"))))))
;;; The `custom-face' Widget.
(defface custom-face-tag-face
- `((t (:bold t :height 1.2 :inherit variable-pitch)))
+ `((t (:weight bold :height 1.2 :inherit variable-pitch)))
"Face used for face tags."
:group 'custom-faces)
(defconst custom-face-selected (widget-convert 'custom-face-selected)
"Converted version of the `custom-face-selected' widget.")
-(defun custom-filter-face-spec (spec filter-index default-filter)
+(defun custom-filter-face-spec (spec filter-index &optional default-filter)
"Return a canonicalized version of SPEC using.
FILTER-INDEX is the index in the entry for each attribute in
`custom-face-attributes' at which the appropriate filter function can be
(defun custom-pre-filter-face-spec (spec)
"Return SPEC changed as necessary for editing by the face customization widget.
SPEC must be a full face spec."
- (custom-filter-face-spec
- spec 2
- (lambda (value)
- (cond ((eq value 'unspecified) nil)
- ((eq value nil) 'off)
- (t value)))))
+ (custom-filter-face-spec spec 2))
(defun custom-post-filter-face-spec (spec)
"Return the customized SPEC in a form suitable for setting the face."
- (custom-filter-face-spec
- spec 3
- (lambda (value)
- (cond ((eq value nil) 'unspecified)
- ((eq value 'off) nil)
- (t value)))))
+ (custom-filter-face-spec spec 3))
(defun custom-face-value-create (widget)
"Create a list of the display specifications for WIDGET."
(unless (widget-get widget :custom-form)
(widget-put widget :custom-form custom-face-default-form))
(let* ((symbol (widget-value widget))
- (spec (or (get symbol 'saved-face)
+ (spec (or (get symbol 'customized-face)
+ (get symbol 'saved-face)
(get symbol 'face-defface-spec)
;; Attempt to construct it.
(list (list t (custom-face-attributes-get
(defface custom-group-tag-face-1
`((((class color)
(background dark))
- (:foreground "pink" :bold t :height 1.2 :inherit variable-pitch))
+ (:foreground "pink" :weight bold :height 1.2 :inherit variable-pitch))
(((class color)
(background light))
- (:foreground "red" :bold t :height 1.2 :inherit variable-pitch))
- (t (:bold t)))
+ (:foreground "red" :weight bold :height 1.2 :inherit variable-pitch))
+ (t (:weight bold)))
"Face used for group tags."
:group 'custom-faces)
(defface custom-group-tag-face
`((((class color)
(background dark))
- (:foreground "light blue" :bold t :height 1.2))
+ (:foreground "light blue" :weight bold :height 1.2))
(((class color)
(background light))
- (:foreground "blue" :bold t :height 1.2))
- (t (:bold t)))
+ (:foreground "blue" :weight bold :height 1.2))
+ (t (:weight bold)))
"Face used for low level group tags."
:group 'custom-faces)
(defun custom-file ()
"Return the file name for saving customizations."
- (if (null user-init-file)
- ;; Started with -q, i.e. the file containing Custom settings
- ;; hasn't been read. Saving settings there would overwrite
- ;; other settings.
- (error "Saving settings when running -q would overwrite existing settings")
- (setq custom-file (or custom-file user-init-file))))
+ (setq custom-file
+ (or custom-file
+ (let ((user-init-file user-init-file)
+ (default-init-file
+ (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs")))
+ (when (null user-init-file)
+ (if (or (file-exists-p default-init-file)
+ (and (eq system-type 'windows-nt)
+ (file-exists-p "~/_emacs")))
+ ;; Started with -q, i.e. the file containing
+ ;; Custom settings hasn't been read. Saving
+ ;; settings there would overwrite other settings.
+ (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
+ (setq user-init-file default-init-file))
+ user-init-file))))
(defun custom-save-delete (symbol)
"Visit `custom-file' and delete all calls to SYMBOL from it.
(save-excursion
(let ((default-major-mode nil))
(set-buffer (find-file-noselect (custom-file))))
- (save-buffer))))
+ (let ((file-precious-flag t))
+ (save-buffer)))))
;;; The Customize Menu.