unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Philip Kaludercic <philipk@posteo.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: larsi@gnus.org, 57639@debbugs.gnu.org
Subject: bug#57639: [PATCH] Add new command 'toggle-theme'
Date: Sun, 18 Sep 2022 09:38:02 +0000	[thread overview]
Message-ID: <87h715dnut.fsf@posteo.net> (raw)
In-Reply-To: <83h715yxz2.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 18 Sep 2022 09:53:53 +0300")

[-- Attachment #1: Type: text/plain, Size: 3246 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Philip Kaludercic <philipk@posteo.net>
>> Cc: larsi@gnus.org,  57639@debbugs.gnu.org
>> Date: Sat, 17 Sep 2022 21:33:18 +0000
>> 
>> >> +  (let* ((theme (car custom-enabled-themes))
>> >> +         (family (plist-get (get theme 'theme-properties) :family)))
>> >> +    (unless family
>> >> +      (error "`%s' is not part of a family" theme))
>> >
>> > "Family"? this terminology was never mentioned in the manual or the
>> > doc string.  How about
>> >
>> >   Theme `%s' does not have any variants
>> >
>> > instead?
>> 
>> Strictly speaking that error message would be wrong at this point,
>> because we cannot say if a theme has no variants if it is not part of a
>> family.  This is because variants of a theme are all those that are part
>> of the same family.  I think it would be better to clarify this in the
>> documentation.
>
> But the documentation doesn't explain what it means for a theme to be
> part of a family.  Specifically, how does one tell, by looking at a
> theme, whether it is or isn't part of a family?
>
> An alternative for what I suggested above is to say
>
>   Theme `%s' does not have any known variants

I get what you mean... how about

    (error "Theme `%s' is not part of a family of variants" theme)

?

>> +(defun theme-choose-variant (&optional no-confirm no-enable)
>> +  "Prompt to switch from the current theme to a variant.
>                                               ^^^^^^^^^^^^
> "to one of its variants" is more clear.

Done.

>> +Themes only have variants if they are part of a family of themes.
>
> This should explain what it means to be part of a family, otherwise
> this sentence is not helpful.

My intention was for this to be an explanation.  The issue is that
variants and family are mutually recursive concepts:

- A variant of a theme are those which are part of the same family
- A family of themes is the set of all variants of a theme.

Perhaps it is just easier to collapse both concepts into either variant
of family and just "expose" by documenting it.  I've tried doing so
below.

>> +The current theme will be immediately disabled before variant is
>> +enabled.
>
> The "immediately" part should probably be removed, as it doesn't seem
> to convey anything of importance, does it?  Come to think of it, what
> exactly does this sentence try to say? isn't it obvious that the
> current theme will be disabled and then the variant will be enabled?

I guess it isn't necessary, the point was just to emphasise that nothing
happens between disabling the previous theme and enabling the variant.
There was something I had in mind when writing this initially, but I
cannot recall it anymore.

So I've removed it for now.

>>          In case the current theme has only one variant, it will
>> +be toggled without prompting.
>
> "toggled" is wrong here.  I suggest
>
>   If the current theme has only one variant, switch to that variant
>   without prompting, otherwise prompt for the variant to select.

Done.

>>                                 For NO-CONFIRM and NO-ENABLE, see
>> +`load-theme'."
>
> I suggest to say this the other way around:
>
>    See `load-theme' for the meaning of NO-CONFIRM and NO-ENABLE.

Done.

> Thanks.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Tag-themes-with-properties.patch --]
[-- Type: text/x-patch, Size: 11075 bytes --]

From 4aa11070669c4b7c802d54d7dd7dffbd41a1a409 Mon Sep 17 00:00:00 2001
From: Philip Kaludercic <philipk@posteo.net>
Date: Sat, 17 Sep 2022 20:11:42 +0200
Subject: [PATCH] Tag themes with properties

* doc/emacs/custom.texi (Custom Themes): Document 'theme-choose-variant'.
* doc/lispref/customize.texi (Custom Themes): Document the new
optional argument to 'deftheme'.
* etc/themes/leuven-dark-theme.el (leuven-dark): Add properties.
* etc/themes/leuven-theme.el (leuven): Add properties.
* etc/themes/tango-dark-theme.el (tango-dark): Add properties.
* etc/themes/tango-theme.el (tango): Add properties.
* etc/themes/tsdh-dark-theme.el (tsdh-dark): Add properties.
* etc/themes/tsdh-light-theme.el (tsdh-light): Add properties.
* lisp/custom.el (deftheme): Allow for optional arguments to set the
property list.
(custom-declare-theme): Accept the same optional arguments as 'deftheme'.
(theme-list-variants): Add new function.
(theme-choose-variant): Add new command for switching between members
of a theme family.
(toggle-theme): Add an alias for 'theme-choose-variant'.
---
 doc/emacs/custom.texi           | 10 ++++++
 doc/lispref/customize.texi      |  5 +--
 etc/themes/leuven-dark-theme.el |  6 ++--
 etc/themes/leuven-theme.el      |  6 ++--
 etc/themes/tango-dark-theme.el  |  4 ++-
 etc/themes/tango-theme.el       |  4 ++-
 etc/themes/tsdh-dark-theme.el   |  4 ++-
 etc/themes/tsdh-light-theme.el  |  4 ++-
 lisp/custom.el                  | 61 +++++++++++++++++++++++++++++----
 9 files changed, 88 insertions(+), 16 deletions(-)

diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi
index ff7ab83190..f98527bf9a 100644
--- a/doc/emacs/custom.texi
+++ b/doc/emacs/custom.texi
@@ -667,6 +667,16 @@ Custom Themes
 the @file{*Custom Themes*} buffer; or type @kbd{M-x describe-theme}
 anywhere in Emacs and enter the theme name.
 
+@findex theme-choose-variant
+Some themes have variants (most often just two: light and dark).  You
+can switch to another variant using @kbd{M-x theme-choose-variant}.
+If the currently active theme has only one other variant, it will be
+selected; if there are more variants, the command will prompt you
+which one to switch to.
+
+Note that @code{theme-choose-variant} only works if a single theme
+is active.
+
 @node Creating Custom Themes
 @subsection Creating Custom Themes
 @cindex custom themes, creating
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi
index 6ba35cffff..911b6c4d75 100644
--- a/doc/lispref/customize.texi
+++ b/doc/lispref/customize.texi
@@ -1428,12 +1428,13 @@ Custom Themes
 be a call to @code{deftheme}, and the last form should be a call to
 @code{provide-theme}.
 
-@defmac deftheme theme &optional doc
+@defmac deftheme theme &optional doc &rest properties
 This macro declares @var{theme} (a symbol) as the name of a Custom
 theme.  The optional argument @var{doc} should be a string describing
 the theme; this is the description shown when the user invokes the
 @code{describe-theme} command or types @kbd{?} in the @samp{*Custom
-Themes*} buffer.
+Themes*} buffer.  The remaining arguments @var{properties} are used
+pass a property list with theme attributes.
 
 Two special theme names are disallowed (using them causes an error):
 @code{user} is a dummy theme that stores the user's direct
diff --git a/etc/themes/leuven-dark-theme.el b/etc/themes/leuven-dark-theme.el
index 0e162c8bab..42ebd7b2d6 100644
--- a/etc/themes/leuven-dark-theme.el
+++ b/etc/themes/leuven-dark-theme.el
@@ -5,7 +5,7 @@
 ;; Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")>
 ;; Contributor: Thibault Polge <(concat "thibault" at-sign "thb.lt")>
 ;; URL: https://github.com/fniessen/emacs-leuven-dark-theme
-;; Version: 20220202.1126
+;; Version: 20220917.2332
 ;; Keywords: color theme
 
 ;; This file is part of GNU Emacs.
@@ -97,7 +97,9 @@ leuven-dark
   "Face colors with a light background.
 Basic, Font Lock, Isearch, Gnus, Message, Org mode, Diff, Ediff,
 Flyspell, Semantic, and Ansi-Color faces are included -- and much
-more...")
+more..."
+  :background-mode 'dark
+  :family 'leuven)
 
 (let ((class '((class color) (min-colors 89)))
 
diff --git a/etc/themes/leuven-theme.el b/etc/themes/leuven-theme.el
index d9a8d5391a..07c34e944c 100644
--- a/etc/themes/leuven-theme.el
+++ b/etc/themes/leuven-theme.el
@@ -4,7 +4,7 @@
 
 ;; Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")>
 ;; URL: https://github.com/fniessen/emacs-leuven-theme
-;; Version: 20200513.1928
+;; Version: 20220917.2332
 ;; Keywords: color theme
 
 ;; This file is part of GNU Emacs.
@@ -78,7 +78,9 @@ leuven
   "Face colors with a light background.
 Basic, Font Lock, Isearch, Gnus, Message, Org mode, Diff, Ediff,
 Flyspell, Semantic, and Ansi-Color faces are included -- and much
-more...")
+more..."
+  :background-mode 'light
+  :family 'leuven)
 
 (let ((class '((class color) (min-colors 89)))
 
diff --git a/etc/themes/tango-dark-theme.el b/etc/themes/tango-dark-theme.el
index ef00d2ac49..fb5a1b29eb 100644
--- a/etc/themes/tango-dark-theme.el
+++ b/etc/themes/tango-dark-theme.el
@@ -30,7 +30,9 @@
 (deftheme tango-dark
   "Face colors using the Tango palette (dark background).
 Basic, Font Lock, Isearch, Gnus, Message, Ediff, Flyspell,
-Semantic, and Ansi-Color faces are included.")
+Semantic, and Ansi-Color faces are included."
+  :background-mode 'dark
+  :family 'tango)
 
 (let ((class '((class color) (min-colors 89)))
       ;; Tango palette colors.
diff --git a/etc/themes/tango-theme.el b/etc/themes/tango-theme.el
index ecbbf03753..026718bf38 100644
--- a/etc/themes/tango-theme.el
+++ b/etc/themes/tango-theme.el
@@ -30,7 +30,9 @@
 (deftheme tango
   "Face colors using the Tango palette (light background).
 Basic, Font Lock, Isearch, Gnus, Message, Ediff, Flyspell,
-Semantic, and Ansi-Color faces are included.")
+Semantic, and Ansi-Color faces are included."
+  :background-mode 'light
+  :family 'tango)
 
 (let ((class '((class color) (min-colors 89)))
       ;; Tango palette colors.
diff --git a/etc/themes/tsdh-dark-theme.el b/etc/themes/tsdh-dark-theme.el
index a88ad75520..ddd710a16e 100644
--- a/etc/themes/tsdh-dark-theme.el
+++ b/etc/themes/tsdh-dark-theme.el
@@ -20,7 +20,9 @@
 ;;; Code:
 
 (deftheme tsdh-dark
-  "A dark theme used and created by Tassilo Horn.")
+  "A dark theme used and created by Tassilo Horn."
+  :background-mode 'dark
+  :family 'tsdh)
 
 (custom-theme-set-faces
  'tsdh-dark
diff --git a/etc/themes/tsdh-light-theme.el b/etc/themes/tsdh-light-theme.el
index d9d09b702b..724b081880 100644
--- a/etc/themes/tsdh-light-theme.el
+++ b/etc/themes/tsdh-light-theme.el
@@ -21,7 +21,9 @@
 
 (deftheme tsdh-light
   "A light Emacs theme.
-Used and created by Tassilo Horn.")
+Used and created by Tassilo Horn."
+  :background-mode 'light
+  :family 'tsdh)
 
 (custom-theme-set-faces
  'tsdh-light
diff --git a/lisp/custom.el b/lisp/custom.el
index 352b5b0e16..5a3d3b95e2 100644
--- a/lisp/custom.el
+++ b/lisp/custom.el
@@ -1152,9 +1152,11 @@ custom--sort-vars-1
 ;;   (provide-theme 'THEME)
 
 
-(defmacro deftheme (theme &optional doc)
+(defmacro deftheme (theme &optional doc &rest properties)
   "Declare THEME to be a Custom theme.
 The optional argument DOC is a doc string describing the theme.
+PROPERTIES are interpreted as a property list that will be stored
+in the `theme-properties' property for THEME.
 
 Any theme `foo' should be defined in a file called `foo-theme.el';
 see `custom-make-theme-feature' for more information."
@@ -1164,18 +1166,25 @@ deftheme
     ;; It is better not to use backquote in this file,
     ;; because that makes a bootstrapping problem
     ;; if you need to recompile all the Lisp files using interpreted code.
-    (list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc)))
+    (list 'custom-declare-theme (list 'quote theme) (list 'quote feature) doc
+          (cons 'list properties))))
 
-(defun custom-declare-theme (theme feature &optional doc)
+(defun custom-declare-theme (theme feature &optional doc properties)
   "Like `deftheme', but THEME is evaluated as a normal argument.
-FEATURE is the feature this theme provides.  Normally, this is a symbol
-created from THEME by `custom-make-theme-feature'."
+FEATURE is the feature this theme provides.  Normally, this is a
+symbol created from THEME by `custom-make-theme-feature'.  The
+optional argument DOC may contain the documentation for THEME.
+The optional argument PROPERTIES may contain a property list of
+attributes associated with THEME."
   (unless (custom-theme-name-valid-p theme)
     (error "Custom theme cannot be named %S" theme))
   (unless (memq theme custom-known-themes)
     (push theme custom-known-themes))
   (put theme 'theme-feature feature)
-  (when doc (put theme 'theme-documentation doc)))
+  (when doc
+    (put theme 'theme-documentation doc))
+  (when properties
+    (put theme 'theme-properties properties)))
 
 (defun custom-make-theme-feature (theme)
   "Given a symbol THEME, create a new symbol by appending \"-theme\".
@@ -1372,6 +1381,46 @@ load-theme
     (enable-theme theme))
   t)
 
+(defun theme-list-variants (theme &rest list)
+  "Return a list of theme variants for THEME.
+If the optional argument LIST is not given, "
+  (let* ((properties (get theme 'theme-properties))
+         (family (plist-get properties :family)))
+    (seq-filter
+     (lambda (variant)
+       (and (eq (plist-get (get variant 'theme-properties) :family)
+                family)
+            (not (eq variant theme))))
+     (or list (custom-available-themes)))))
+
+(defun theme-choose-variant (&optional no-confirm no-enable)
+  "Prompt to switch from the current theme to one of its a variants.
+The current theme will be disabled before variant is enabled.  If
+the current theme has only one variant, switch to that variant
+without prompting, otherwise prompt for the variant to select.
+See `load-theme' for the meaning of NO-CONFIRM and NO-ENABLE."
+  (interactive)
+  (cond
+   ((length= custom-enabled-themes 0)
+    (user-error "No theme is active, cannot toggle"))
+   ((length> custom-enabled-themes 1)
+    (user-error "More than one theme active, cannot unambiguously toggle")))
+  (let* ((theme (car custom-enabled-themes))
+         (family (plist-get (get theme 'theme-properties) :family)))
+    (unless family
+      (error "Theme `%s' does not have any known variants" theme))
+    (let* ((variants (theme-list-variants theme))
+           (choice (cond
+                    ((null variants)
+                     (error "`%s' has no variants" theme))
+                    ((length= variants 1)
+                     (car variants))
+                    ((intern (completing-read "Load custom theme: " variants))))))
+      (disable-theme theme)
+      (load-theme choice no-confirm no-enable))))
+
+(defalias 'toggle-theme #'theme-choose-variant)
+
 (defun custom-theme-load-confirm (hash)
   "Query the user about loading a Custom theme that may not be safe.
 The theme should be in the current buffer.  If the user agrees,
-- 
2.37.3


  reply	other threads:[~2022-09-18  9:38 UTC|newest]

Thread overview: 102+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-07  7:19 bug#57639: [PATCH] Add new command 'toggle-theme' Philip Kaludercic
2022-09-07  8:06 ` Stefan Kangas
2022-09-07  8:33   ` Philip Kaludercic
2022-09-07  8:51     ` Stefan Kangas
2022-09-07 13:03 ` Lars Ingebrigtsen
2022-09-07 13:31   ` Philip Kaludercic
2022-09-08 11:46     ` Lars Ingebrigtsen
2022-09-11  8:26       ` Philip Kaludercic
2022-09-11 11:11         ` Lars Ingebrigtsen
2022-09-11 11:22           ` Lars Ingebrigtsen
2022-09-11 11:42           ` Philip Kaludercic
2022-09-11 11:54             ` Lars Ingebrigtsen
2022-09-11 18:47               ` Philip Kaludercic
2022-09-12 10:10                 ` Lars Ingebrigtsen
2022-09-12 11:06                   ` Philip Kaludercic
2022-09-12 11:12                     ` Lars Ingebrigtsen
2022-09-12 13:11                   ` Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-09-12 14:51                     ` Michael Albinus
2022-09-13 12:09                       ` Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-09-12 15:26                     ` Philip Kaludercic
2022-09-13  2:25                       ` Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-09-13 11:10                     ` Lars Ingebrigtsen
2022-09-14 11:38                 ` Philip Kaludercic
2022-09-14 13:03                   ` Lars Ingebrigtsen
2022-09-14 14:37                     ` Philip Kaludercic
2022-09-14 15:21                       ` Lars Ingebrigtsen
2022-09-17 18:13                         ` Philip Kaludercic
2022-09-17 18:32                           ` Eli Zaretskii
2022-09-17 21:33                             ` Philip Kaludercic
2022-09-18  6:53                               ` Eli Zaretskii
2022-09-18  9:38                                 ` Philip Kaludercic [this message]
2022-09-18 10:39                                   ` Lars Ingebrigtsen
2022-09-18 11:39                                     ` Philip Kaludercic
2022-09-19  7:58                                       ` Lars Ingebrigtsen
2022-09-19  8:05                                         ` Philip Kaludercic
2022-09-19  8:15                                           ` Lars Ingebrigtsen
2022-09-19 10:13                                             ` Philip Kaludercic
2022-09-20 21:08                                               ` Philip Kaludercic
2022-09-20 21:11                                                 ` Lars Ingebrigtsen
2022-09-20 21:35                                                   ` Philip Kaludercic
2022-09-21 11:02                                                     ` Lars Ingebrigtsen
2022-09-21 11:30                                                       ` Philip Kaludercic
2022-09-21 11:38                                                         ` Lars Ingebrigtsen
2022-09-21 11:46                                                           ` Philip Kaludercic
2022-09-21 12:06                                                             ` Lars Ingebrigtsen
2022-09-21 12:26                                                               ` Philip Kaludercic
2022-10-09 12:58                                                                 ` Philip Kaludercic
2022-10-09 14:26                                                                   ` Lars Ingebrigtsen
2022-10-09 15:13                                                                     ` Philip Kaludercic
2022-10-09 20:32                                                                       ` Stefan Kangas
2022-10-09 21:02                                                                         ` Philip Kaludercic
2022-10-09 21:43                                                                           ` Philip Kaludercic
2022-10-10  0:56                                                                             ` Stefan Kangas
2022-10-10  1:17                                                                         ` Protesilaos Stavrou
2022-10-10  8:16                                                                           ` Philip Kaludercic
2022-10-10  8:14                                                                       ` Lars Ingebrigtsen
2022-10-10 11:02                                                                         ` Philip Kaludercic
2022-10-11  0:25                                                                           ` Lars Ingebrigtsen
2022-10-11  9:06                                                                             ` Philip Kaludercic
2022-10-11 19:43                                                                               ` Lars Ingebrigtsen
2022-10-11 19:51                                                                                 ` Philip Kaludercic
2022-10-11 20:04                                                                                   ` Lars Ingebrigtsen
2022-10-11 20:09                                                                                     ` Philip Kaludercic
2022-10-11 20:49                                                                                       ` Lars Ingebrigtsen
2022-10-13  8:50                                                                                         ` Philip Kaludercic
2022-10-13  9:10                                                                                           ` Philip Kaludercic
2022-10-13 10:34                                                                                           ` Eli Zaretskii
2022-10-13 10:35                                                                                             ` Philip Kaludercic
2022-10-13 14:03                                                                                               ` Stefan Kangas
2022-10-13 14:07                                                                                                 ` Philip Kaludercic
2022-10-19  2:46                                                                                                   ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-10-19  7:16                                                                                                     ` Philip Kaludercic
2022-10-19 12:21                                                                                                       ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
     [not found]                                                                                                         ` <87a65qla8d.fsf@posteo.net>
2022-10-20 17:04                                                                                                           ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-10-20 17:42                                                                                                             ` Philip Kaludercic
2022-10-20 20:01                                                                                                               ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-10-19  2:43                                                                                             ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-10-19  7:20                                                                                               ` Philip Kaludercic
2022-10-19 10:59                                                                                               ` Eli Zaretskii
2022-10-19 12:25                                                                                                 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-10-13 19:12                                                                                           ` Lars Ingebrigtsen
2022-10-13 20:21                                                                                             ` Philip Kaludercic
2022-09-21 13:08                                                             ` Protesilaos Stavrou
2022-09-21 13:13                                                               ` Philip Kaludercic
2022-09-21 13:21                                                                 ` Protesilaos Stavrou
2022-09-21 13:05                                                           ` Protesilaos Stavrou
2022-09-18 12:52                                   ` Eli Zaretskii
2022-09-18 12:56                                     ` Philip Kaludercic
2022-09-20  3:40                                       ` bug#57639: Toggling, in general Richard Stallman
2022-09-20  8:07                                         ` Philip Kaludercic
2022-09-21  2:47                                           ` Richard Stallman
2022-09-21  9:22                                             ` Robert Pluim
2022-09-20 12:20                                         ` Visuwesh
2022-10-13 20:46 ` bug#57639: [PATCH] Add new command 'toggle-theme' Mauro Aranda
2022-10-13 22:19   ` Philip Kaludercic
2022-10-13 22:53     ` Mauro Aranda
2022-10-14  7:28       ` Philip Kaludercic
2022-10-14 11:22         ` Mauro Aranda
2022-10-14 15:21           ` Philip Kaludercic
2022-10-14 18:20           ` Philip Kaludercic
2022-10-15 15:24             ` Philip Kaludercic
2022-10-14  6:11     ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87h715dnut.fsf@posteo.net \
    --to=philipk@posteo.net \
    --cc=57639@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=larsi@gnus.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).