bug#48351: 28.0.50; custom-theme-summary doesn't find theme summary line reliably

bug#48351: 28.0.50; custom-theme-summary doesn't find theme summary line reliably

[Mauro Aranda]

Starting from emacs -Q:
M-x customize-themes

Look for themes such as the leuven theme or the modus-* themes.  The
summary after the checkbox reads: "(no documentation available)"

However looking at the theme files, the deftheme form has a docstring,
so I think the *Custom Themes* buffer should be showing the summary
correctly.

IMO, the restriction imposed by `custom-theme-summary' is too strict:
the function currently requires that the deftheme form is the very first
one in the file.


In GNU Emacs 28.0.50 (build 2, i686-pc-linux-gnu, GTK+ Version 2.24.33, cairo version 1.16.0)
 of 2021-05-11 built on tbb
Repository revision: cd46972ee82d392cef8fa6e51c370d3d8f48777a
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12010000
System Description: Slackware 14.2 i586 (post 14.2 -current)

Configured using:
 'configure --with-mailutils
 PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/local/share/pkgconfig:/usr/lib/pkgconfig:/usr/share/pkgconfig'

Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GSETTINGS HARFBUZZ JPEG JSON
LCMS2 LIBXML2 MODULES NOTIFY INOTIFY PDUMPER PNG RSVG SECCOMP SOUND
THREADS TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XPM GTK2 ZLIB

Important settings:
  value of $LC_COLLATE: C
  value of $LANG: en_US.utf8
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message rmc puny dired dired-loaddefs
rfc822 mml mml-sec epa derived epg epg-config gnus-util rmail
rmail-loaddefs auth-source cl-seq eieio eieio-core cl-macs
eieio-loaddefs password-cache json map text-property-search time-date
subr-x seq byte-opt gv bytecomp byte-compile cconv mm-decode mm-bodies
mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader cl-loaddefs
cl-lib sendmail rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils
iso-transl tooltip eldoc electric uniquify ediff-hook vc-hooks
lisp-float-type mwheel term/x-win x-win term/common-win x-dnd tool-bar
dnd fontset image regexp-opt fringe tabulated-list replace newcomment
text-mode elisp-mode lisp-mode prog-mode register page tab-bar menu-bar
rfn-eshadow isearch easymenu timer select scroll-bar mouse jit-lock
font-lock syntax font-core term/tty-colors frame minibuffer cl-generic
cham georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao
korean japanese eucjp-ms cp51932 hebrew greek romanian slovak czech
european ethiopic indian cyrillic chinese composite charscript charprop
case-table epa-hook jka-cmpr-hook help simple abbrev obarray
cl-preloaded nadvice button loaddefs faces cus-face macroexp files
window text-properties overlay sha1 md5 base64 format env code-pages
mule custom widget hashtable-print-readable backquote threads dbusbind
inotify lcms2 dynamic-setting system-font-setting font-render-setting
cairo move-toolbar gtk x-toolkit x multi-tty make-network-process emacs)

Memory information:
((conses 8 50866 5885)
 (symbols 24 6591 1)
 (strings 16 18158 1687)
 (string-bytes 1 599925)
 (vectors 8 13197)
 (vector-slots 4 179810 14964)
 (floats 8 21 47)
 (intervals 28 197 4)
 (buffers 564 10))

bug#48351: 28.0.50; custom-theme-summary doesn't find theme summary line reliably

[Mauro Aranda]

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

tags 48351 patch
quit


Mauro Aranda <maurooaranda@gmail.com> writes:

> IMO, the restriction imposed by `custom-theme-summary' is too strict:
> the function currently requires that the deftheme form is the very first
> one in the file.

Here's a patch.  Any comments?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch --]
[-- Type: text/x-patch, Size: 1306 bytes --]

From dd65d7bf57e1cffc64af0f86282b0634b9216b20 Mon Sep 17 00:00:00 2001
From: Mauro Aranda <maurooaranda@gmail.com>
Date: Tue, 11 May 2021 09:14:57 -0300
Subject: [PATCH] Lift restriction for finding theme summary line

* lisp/cus-theme.el (custom-theme-summary): Don't limit the file to
having the deftheme form as the very first form, rather look for the
deftheme form explicitly.
---
 lisp/cus-theme.el | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/lisp/cus-theme.el b/lisp/cus-theme.el
index 13fb9f34fa..dfa2226403 100644
--- a/lisp/cus-theme.el
+++ b/lisp/cus-theme.el
@@ -657,10 +657,12 @@ custom-theme-summary
 	    (insert-file-contents fn)
 	    (let ((sexp (let ((read-circle nil))
 			  (condition-case nil
-			      (read (current-buffer))
-			    (end-of-file nil)))))
-              (and (eq (car-safe sexp) 'deftheme)
-		   (setq doc (nth 2 sexp))))))))
+                              (progn
+                                (re-search-forward "^(deftheme")
+                                (beginning-of-line)
+                                (read (current-buffer)))
+                            (error nil)))))
+              (setq doc (nth 2 sexp)))))))
     (cond ((null doc)
 	   "(no documentation available)")
 	  ((string-match ".*" doc)
-- 
2.31.1

bug#48351: 28.0.50; custom-theme-summary doesn't find theme summary line reliably

[Lars Ingebrigtsen]

Mauro Aranda <maurooaranda@gmail.com> writes:

>> IMO, the restriction imposed by `custom-theme-summary' is too strict:
>> the function currently requires that the deftheme form is the very first
>> one in the file.
>
> Here's a patch.  Any comments?

Looks good to me.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#48351: 28.0.50; custom-theme-summary doesn't find theme summary line reliably

[Mauro Aranda]

close 48351 28.1
quit


Lars Ingebrigtsen <larsi@gnus.org> writes:

> Mauro Aranda <maurooaranda@gmail.com> writes:
>
>>> IMO, the restriction imposed by `custom-theme-summary' is too strict:
>>> the function currently requires that the deftheme form is the very first
>>> one in the file.
>>
>> Here's a patch.  Any comments?
>
> Looks good to me.

Thanks for taking a look.  I pushed the patch, but forgot to add the bug
number to the commit message (I should've double checked, sorry!).

Anyway, closing the bug report.