;;; cus-theme.el -- custom theme creation user interface
;;
-;; Copyright (C) 2001, 2002, 2003, 2004, 2005,
-;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
;;
;; Author: Alex Schroeder <alex@gnu.org>
;; Maintainer: FSF
(put 'custom-new-theme-mode 'mode-class 'special)
(defvar custom-theme-name nil)
+;; Each element has the form (VAR CHECKBOX-WIDGET VAR-WIDGET)
(defvar custom-theme-variables nil)
+;; Each element has the form (FACE CHECKBOX-WIDGET FACE-WIDGET)
(defvar custom-theme-faces nil)
(defvar custom-theme-description nil)
+(defvar custom-theme--migrate-settings nil)
(defvar custom-theme-insert-variable-marker nil)
(defvar custom-theme-insert-face-marker nil)
;;;###autoload
(defun customize-create-theme (&optional theme buffer)
"Create or edit a custom theme.
-THEME, if non-nil, should be an existing theme to edit.
+THEME, if non-nil, should be an existing theme to edit. If THEME
+is `user', the resulting *Custom Theme* buffer also contains a
+checkbox for removing the theme settings specified in the buffer
+from the Custom save file.
BUFFER, if non-nil, should be a buffer to use; the default is
named *Custom Theme*."
(interactive)
(set (make-local-variable 'custom-theme-faces) nil)
(set (make-local-variable 'custom-theme-variables) nil)
(set (make-local-variable 'custom-theme-description) "")
+ (set (make-local-variable 'custom-theme--migrate-settings) nil)
(make-local-variable 'custom-theme-insert-face-marker)
(make-local-variable 'custom-theme-insert-variable-marker)
(make-local-variable 'custom-theme--listed-faces)
+ (when (called-interactively-p 'interactive)
+ (unless (y-or-n-p "Include basic face customizations in this theme? ")
+ (setq custom-theme--listed-faces nil)))
+
+ (if (eq theme 'user)
+ (widget-insert "This buffer contains all the Custom settings you have made.
+You can convert them into a new custom theme, and optionally
+remove them from your saved Custom file.\n\n"))
(widget-create 'push-button
:tag " Visit Theme "
:help-echo "Insert the settings of a pre-defined theme."
- :action (lambda (widget &optional event)
+ :action (lambda (_widget &optional _event)
(call-interactively 'custom-theme-visit-theme)))
(widget-insert " ")
(widget-create 'push-button
:tag " Merge Theme "
:help-echo "Merge in the settings of a pre-defined theme."
- :action (lambda (widget &optional event)
+ :action (lambda (_widget &optional _event)
(call-interactively 'custom-theme-merge-theme)))
(widget-insert " ")
- (widget-create 'push-button :notify 'revert-buffer " Revert ")
+ (widget-create 'push-button
+ :tag " Revert "
+ :help-echo "Revert this buffer to its original state."
+ :action (lambda (&rest ignored) (revert-buffer)))
(widget-insert "\n\nTheme name : ")
(setq custom-theme-name
(widget-create 'editable-field
- :value (if theme (symbol-name theme) "")))
+ :value (if (and theme (not (eq theme 'user)))
+ (symbol-name theme)
+ "")))
(widget-insert "Description: ")
(setq custom-theme-description
(widget-create 'text
:value (format-time-string "Created %Y-%m-%d.")))
- (widget-insert " ")
(widget-create 'push-button
:notify (function custom-theme-write)
" Save Theme ")
+ (when (eq theme 'user)
+ (setq custom-theme--migrate-settings t)
+ (widget-insert " ")
+ (widget-create 'checkbox
+ :value custom-theme--migrate-settings
+ :action (lambda (widget &optional event)
+ (when (widget-value widget)
+ (widget-toggle-action widget event)
+ (setq custom-theme--migrate-settings
+ (widget-value widget)))))
+ (widget-insert (propertize " Remove saved theme settings from Custom save file."
+ 'face '(variable-pitch (:height 0.9)))))
(let (vars values faces face-specs)
;; Load the theme settings.
(when theme
- (load-theme theme t)
+ (unless (eq theme 'user)
+ (load-theme theme nil t))
(dolist (setting (get theme 'theme-settings))
(if (eq (car setting) 'theme-value)
(progn (push (nth 1 setting) vars)
:button-face 'custom-link
:mouse-face 'highlight
:pressed-face 'highlight
- :action (lambda (widget &optional event)
+ :action (lambda (_widget &optional _event)
(call-interactively 'custom-theme-add-face)))
;; If THEME is non-nil, insert all of that theme's variables.
(widget-insert "\n\n Theme variables:\n ")
(if theme
(while vars
- (custom-theme-add-var-1 (pop vars) (pop values))))
+ (if (eq (car vars) 'custom-enabled-themes)
+ (progn (pop vars) (pop values))
+ (custom-theme-add-var-1 (pop vars) (eval (pop values))))))
(setq custom-theme-insert-variable-marker (point-marker))
(widget-insert " ")
(widget-create 'push-button
:button-face 'custom-link
:mouse-face 'highlight
:pressed-face 'highlight
- :action (lambda (widget &optional event)
+ :action (lambda (_widget &optional _event)
(call-interactively 'custom-theme-add-variable)))
(widget-insert ?\n)
(widget-setup)
(goto-char (point-min))
(message "")))
-(defun custom-theme-revert (ignore-auto noconfirm)
+(defun custom-theme-revert (_ignore-auto noconfirm)
+ "Revert the current *Custom Theme* buffer.
+This is the `revert-buffer-function' for `custom-new-theme-mode'."
(when (or noconfirm (y-or-n-p "Discard current changes? "))
(customize-create-theme custom-theme--save-name (current-buffer))))
(interactive
(let ((v (read-variable "Variable name: ")))
(list v (symbol-value v))))
- (let ((var-and-widget (assq var custom-theme-faces)))
- (cond ((null var-and-widget)
+ (let ((entry (assq var custom-theme-variables)))
+ (cond ((null entry)
;; If VAR is not yet in the buffer, add it.
(save-excursion
(goto-char custom-theme-insert-variable-marker)
(widget-setup)))
;; Otherwise, alter that var widget.
(t
- (let ((widget (cdr var-and-widget)))
+ (widget-value-set (nth 1 entry) t)
+ (let ((widget (nth 2 entry)))
(widget-put widget :shown-value (list value))
(custom-redraw widget))))))
(defun custom-theme-add-var-1 (symbol val)
(widget-insert " ")
- (push (cons symbol
+ (push (list symbol
+ (prog1 (widget-create 'checkbox
+ :value t
+ :help-echo "Enable/disable this variable.")
+ (widget-insert " "))
(widget-create 'custom-variable
:tag (custom-unlispify-tag-name symbol)
:value symbol
(interactive (list (read-face-name "Face name" nil nil) nil))
(unless (or (facep face) spec)
(error "`%s' has no face definition" face))
- (let ((face-and-widget (assq face custom-theme-faces)))
- (cond ((null face-and-widget)
+ (let ((entry (assq face custom-theme-faces)))
+ (cond ((null entry)
;; If FACE is not yet in the buffer, add it.
(save-excursion
(goto-char custom-theme-insert-face-marker)
(widget-setup)))
;; Otherwise, if SPEC is supplied, alter that face widget.
(spec
- (let ((widget (cdr face-and-widget)))
+ (widget-value-set (nth 1 entry) t)
+ (let ((widget (nth 2 entry)))
(widget-put widget :shown-value spec)
(custom-redraw widget)))
((called-interactively-p 'interactive)
(defun custom-theme-add-face-1 (symbol spec)
(widget-insert " ")
- (push (cons symbol
+ (push (list symbol
+ (prog1
+ (widget-create 'checkbox
+ :value t
+ :help-echo "Enable/disable this face.")
+ (widget-insert " "))
(widget-create 'custom-face
:tag (custom-unlispify-tag-name symbol)
:documentation-shown t
;;; Reading and writing
+;;;###autoload
(defun custom-theme-visit-theme (theme)
- "Load the custom theme THEME's settings into the current buffer."
+ "Set up a Custom buffer to edit custom theme THEME."
(interactive
(list
(intern (completing-read "Find custom theme: "
(unless (eq theme 'user)
(unless (custom-theme-name-valid-p theme)
(error "Invalid theme name `%s'" theme))
- (load-theme theme t))
+ (load-theme theme nil t))
(let ((settings (reverse (get theme 'theme-settings))))
(dolist (setting settings)
- (funcall (if (eq (car setting) 'theme-value)
- 'custom-theme-add-variable
- 'custom-theme-add-face)
- (nth 1 setting)
- (nth 3 setting))))
+ (let ((option (eq (car setting) 'theme-value))
+ (name (nth 1 setting))
+ (value (nth 3 setting)))
+ (unless (and option
+ (memq name '(custom-enabled-themes
+ custom-safe-themes)))
+ (funcall (if option
+ 'custom-theme-add-variable
+ 'custom-theme-add-face)
+ name value)))))
theme)
-(defun custom-theme-write (&rest ignore)
+;; From cus-edit.el
+(defvar custom-reset-standard-faces-list)
+(defvar custom-reset-standard-variables-list)
+
+(defun custom-theme-write (&rest _ignore)
"Write the current custom theme to its theme file."
(interactive)
(let* ((name (widget-value custom-theme-name))
- (doc (widget-value custom-theme-description))
- (vars custom-theme-variables)
+ (doc (widget-value custom-theme-description))
+ (vars custom-theme-variables)
(faces custom-theme-faces)
filename)
(when (string-equal name "")
(insert "(deftheme " name)
(if doc (insert "\n \"" doc "\""))
(insert ")\n")
- (custom-theme-write-variables name vars)
- (custom-theme-write-faces name faces)
+ (custom-theme-write-variables name (reverse vars))
+ (custom-theme-write-faces name (reverse faces))
(insert "\n(provide-theme '" name ")\n")
(save-buffer))
- (dolist (var vars)
- (when (widget-get (cdr var) :children)
- (widget-put (cdr var) :custom-state 'saved)
- (custom-redraw-magic (cdr var))))
- (dolist (face custom-theme-faces)
- (when (widget-get (cdr face) :children)
- (widget-put (cdr face) :custom-state 'saved)
- (custom-redraw-magic (cdr face))))
- (message "Theme written to %s" filename)))
+ (message "Theme written to %s" filename)
+
+ (when custom-theme--migrate-settings
+ ;; Remove these settings from the Custom file.
+ (let ((custom-reset-standard-variables-list '(t))
+ (custom-reset-standard-faces-list '(t)))
+ (dolist (var vars)
+ (when (and (not (eq (car var) 'custom-enabled-themes))
+ (widget-get (nth 1 var) :value))
+ (widget-apply (nth 2 var) :custom-mark-to-reset-standard)))
+ (dolist (face faces)
+ (when (widget-get (nth 1 face) :value)
+ (widget-apply (nth 2 face) :custom-mark-to-reset-standard)))
+ (custom-save-all))
+ (let ((custom-theme-load-path (list 'custom-theme-directory)))
+ (load-theme (intern name))))))
(defun custom-theme-write-variables (theme vars)
"Write a `custom-theme-set-variables' command for THEME.
(princ theme)
(princ "\n")
(dolist (spec vars)
- (let* ((symbol (car spec))
- (widget (cdr spec))
- (child (car-safe (widget-get widget :children)))
- (value (if child
- (widget-value child)
- ;; Child is null if the widget is closed (hidden).
- (car (widget-get widget :shown-value)))))
- (when (boundp symbol)
- (unless (bolp)
- (princ "\n"))
- (princ " '(")
- (prin1 symbol)
- (princ " ")
- (prin1 (custom-quote value))
- (princ ")"))))
+ (when (widget-get (nth 1 spec) :value)
+ (let* ((symbol (nth 0 spec))
+ (widget (nth 2 spec))
+ (child (car-safe (widget-get widget :children)))
+ (value (if child
+ (widget-value child)
+ ;; Child is null if the widget is closed (hidden).
+ (car (widget-get widget :shown-value)))))
+ (when (boundp symbol)
+ (unless (bolp)
+ (princ "\n"))
+ (princ " '(")
+ (prin1 symbol)
+ (princ " ")
+ (prin1 (custom-quote value))
+ (princ ")")))))
(if (bolp)
(princ " "))
(princ ")")
(princ theme)
(princ "\n")
(dolist (spec faces)
- (let* ((symbol (car spec))
- (widget (cdr spec))
- (value
- (if (car-safe (widget-get widget :children))
- (custom-face-widget-to-spec widget)
- ;; Child is null if the widget is closed (hidden).
- (widget-get widget :shown-value))))
- (when (and (facep symbol) value)
- (princ (if (bolp) " '(" "\n '("))
- (prin1 symbol)
- (princ " ")
- (prin1 value)
- (princ ")"))))
+ ;; Insert the face iff the checkbox widget is checked.
+ (when (widget-get (nth 1 spec) :value)
+ (let* ((symbol (nth 0 spec))
+ (widget (nth 2 spec))
+ (value
+ (cond
+ ((car-safe (widget-get widget :children))
+ (custom-face-widget-to-spec widget))
+ ;; Child is null if the widget is closed (hidden).
+ ((widget-get widget :shown-value))
+ (t (custom-face-get-current-spec symbol)))))
+ (when (and (facep symbol) value)
+ (princ (if (bolp) " '(" "\n '("))
+ (prin1 symbol)
+ (princ " ")
+ (prin1 value)
+ (princ ")")))))
(if (bolp) (princ " "))
(princ ")")
(unless (looking-at "\n")
'help-theme-def fn)
(princ "'"))
(princ ".\n")
- (if (not (memq theme custom-known-themes))
+ (if (custom-theme-p theme)
(progn
- (princ "It is not loaded.")
- ;; Attempt to grab the theme documentation
- (when fn
- (with-temp-buffer
- (insert-file-contents fn)
- (let ((sexp (let ((read-circle nil))
- (condition-case nil
- (read (current-buffer))
- (end-of-file nil)))))
- (and sexp (listp sexp)
- (eq (car sexp) 'deftheme)
- (setq doc (nth 2 sexp)))))))
- (if (custom-theme-enabled-p theme)
- (princ "It is loaded and enabled.")
- (princ "It is loaded but disabled."))
- (setq doc (get theme 'theme-documentation)))
-
+ (if (custom-theme-enabled-p theme)
+ (princ "It is loaded and enabled.")
+ (princ "It is loaded but disabled."))
+ (setq doc (get theme 'theme-documentation)))
+ (princ "It is not loaded.")
+ ;; Attempt to grab the theme documentation
+ (when fn
+ (with-temp-buffer
+ (insert-file-contents fn)
+ (let ((sexp (let ((read-circle nil))
+ (condition-case nil
+ (read (current-buffer))
+ (end-of-file nil)))))
+ (and sexp (listp sexp)
+ (eq (car sexp) 'deftheme)
+ (setq doc (nth 2 sexp)))))))
(princ "\n\nDocumentation:\n")
(princ (if (stringp doc)
doc
(defcustom custom-theme-allow-multiple-selections nil
"Whether to allow multi-selections in the *Custom Themes* buffer."
+ :version "24.1"
:type 'boolean
:group 'custom-buffer)
(defvar custom-theme-choose-mode-map
(let ((map (make-keymap)))
- (set-keymap-parent map widget-keymap)
+ (set-keymap-parent map (make-composed-keymap widget-keymap
+ special-mode-map))
(suppress-keymap map)
(define-key map "\C-x\C-s" 'custom-theme-save)
(define-key map "n" 'widget-forward)
map)
"Keymap for `custom-theme-choose-mode'.")
-(define-derived-mode custom-theme-choose-mode nil "Themes"
+(define-derived-mode custom-theme-choose-mode special-mode "Themes"
"Major mode for selecting Custom themes.
Do not call this mode function yourself. It is meant for internal use."
(use-local-map custom-theme-choose-mode-map)
(custom--initialize-widget-variables)
(set (make-local-variable 'revert-buffer-function)
- (lambda (ignore-auto noconfirm)
+ (lambda (_ignore-auto noconfirm)
(when (or noconfirm (y-or-n-p "Discard current choices? "))
(customize-themes (current-buffer))))))
(put 'custom-theme-choose-mode 'mode-class 'special)
When called from Lisp, BUFFER should be the buffer to use; if
omitted, a buffer named *Custom Themes* is used."
(interactive)
- (pop-to-buffer (get-buffer-create (or buffer "*Custom Themes*")))
+ (switch-to-buffer (get-buffer-create (or buffer "*Custom Themes*")))
(let ((inhibit-read-only t))
(erase-buffer))
(custom-theme-choose-mode)
:help-echo "Describe `custom-theme-load-path'."
:keymap custom-mode-link-map
:follow-link 'mouse-face
- :action (lambda (widget &rest ignore)
+ :action (lambda (_widget &rest _ignore)
(describe-variable 'custom-theme-load-path)))
(widget-insert "'.\n\n")
(and (null (cdr user-settings))
(eq (caar user-settings) 'theme-value)
(eq (cadr (car user-settings)) 'custom-enabled-themes)))
- (widget-insert "Note: Your custom settings take precedence over theme settings.\n\n")
- ;; FIXME: Provide some way to painlessly disable or migrate
- ;; these settings.
- ))
+ (widget-insert
+ (propertize
+ " Note: Your custom settings take precedence over theme settings.
+ To migrate your settings into a theme, click "
+ 'face 'font-lock-warning-face))
+ (widget-create 'link :value "here"
+ :button-face 'custom-link
+ :mouse-face 'highlight
+ :pressed-face 'highlight
+ :help-echo "Migrate."
+ :keymap custom-mode-link-map
+ :follow-link 'mouse-face
+ :action (lambda (_widget &rest _ignore)
+ (customize-create-theme 'user)))
+ (widget-insert ".\n\n")))
(widget-create 'push-button
:tag " Save Theme Settings "
(widget-create 'checkbox
:value custom-theme-allow-multiple-selections
:action 'custom-theme-selections-toggle)
- (widget-insert (propertize " Allow more than one theme at a time"
+ (widget-insert (propertize " Select more than one theme at a time"
'face '(variable-pitch (:height 0.9))))
(widget-insert "\n\nAvailable Custom Themes:\n")
- (let (widget)
+ (let ((help-echo "mouse-2: Enable this theme for this session")
+ widget)
(dolist (theme (custom-available-themes))
(setq widget (widget-create 'checkbox
:value (custom-theme-enabled-p theme)
:theme-name theme
+ :help-echo help-echo
:action 'custom-theme-checkbox-toggle))
(push (cons theme widget) custom--listed-themes)
(widget-create-child-and-convert widget 'push-button
:button-face-get 'ignore
:mouse-face-get 'ignore
:value (format " %s" theme)
- :action 'widget-parent-action)
- (widget-insert ?\n)))
+ :action 'widget-parent-action
+ :help-echo help-echo)
+ (widget-insert " -- "
+ (propertize (custom-theme-summary theme)
+ 'face 'shadow)
+ ?\n)))
(goto-char (point-min))
(widget-setup))
+(defun custom-theme-summary (theme)
+ "Return the summary line of THEME."
+ (let (doc)
+ (if (custom-theme-p theme)
+ (setq doc (get theme 'theme-documentation))
+ (let ((fn (locate-file (concat (symbol-name theme) "-theme.el")
+ (custom-theme--load-path)
+ '("" "c"))))
+ (when fn
+ (with-temp-buffer
+ (insert-file-contents fn)
+ (let ((sexp (let ((read-circle nil))
+ (condition-case nil
+ (read (current-buffer))
+ (end-of-file nil)))))
+ (and sexp (listp sexp)
+ (eq (car sexp) 'deftheme)
+ (setq doc (nth 2 sexp))))))))
+ (cond ((null doc)
+ "(no documentation available)")
+ ((string-match ".*" doc)
+ (match-string 0 doc))
+ (t doc))))
+
(defun custom-theme-checkbox-toggle (widget &optional event)
(let ((this-theme (widget-get widget :theme-name)))
(if (widget-value widget)
;; Disable the theme.
- (disable-theme this-theme)
+ (progn
+ (disable-theme this-theme)
+ (widget-toggle-action widget event))
;; Enable the theme.
(unless custom-theme-allow-multiple-selections
;; If only one theme is allowed, disable all other themes and
(unless (eq (car theme) this-theme)
(widget-value-set (cdr theme) nil)
(widget-apply (cdr theme) :notify (cdr theme) event))))
- (load-theme this-theme)))
- ;; Mark `custom-enabled-themes' as "set for current session".
- (put 'custom-enabled-themes 'customized-value
- (list (custom-quote custom-enabled-themes)))
- ;; Check/uncheck the widget.
- (widget-toggle-action widget event))
+ (when (load-theme this-theme)
+ (widget-toggle-action widget event)))
+ ;; Mark `custom-enabled-themes' as "set for current session".
+ (put 'custom-enabled-themes 'customized-value
+ (list (custom-quote custom-enabled-themes)))))
(defun custom-describe-theme ()
"Describe the Custom theme on the current line."
(and widget
(describe-theme (widget-get widget :theme-name)))))
-(defun custom-theme-save (&rest ignore)
+(defun custom-theme-save (&rest _ignore)
(interactive)
(customize-save-variable 'custom-enabled-themes custom-enabled-themes)
(message "Custom themes saved for future sessions."))
(defun custom-theme-selections-toggle (widget &optional event)
(when (widget-value widget)
;; Deactivate multiple-selections.
- (if (> (length (delq nil (mapcar (lambda (x) (widget-value (cdr x)))
- custom--listed-themes)))
- 1)
+ (if (< 1 (length (delq nil (mapcar (lambda (x) (widget-value (cdr x)))
+ custom--listed-themes))))
(error "More than one theme is currently selected")))
(widget-toggle-action widget event)
(setq custom-theme-allow-multiple-selections (widget-value widget)))
-;; arch-tag: cd6919bc-63af-410e-bae2-b6702e762344
+(provide 'cus-theme)
+
;;; cus-theme.el ends here