From: Allen Li <darkfeline@felesatra.moe>
To: rgm@gnu.org
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: Re: master 3bbe9e6: Avoid writing empty abbrev tables
Date: Sat, 29 Sep 2018 22:28:52 +0000 [thread overview]
Message-ID: <CADbSrJy2K-BDPGo-nptdwHHMeu61sm1Vb+KO6eCVDhq1PaWEqg@mail.gmail.com> (raw)
In-Reply-To: <CADbSrJzpL58WTCaais+DO_wx4sqkJv=RRgAmYuOyzragn1HnZg@mail.gmail.com>
[-- Attachment #1: Type: text/plain, Size: 697 bytes --]
Attached patch reworking the feature which fixes the tests.
Explanation in patch.
On Sat, Sep 29, 2018 at 9:06 PM Allen Li <darkfeline@felesatra.moe> wrote:
>
> Oops, I'll take a look
> On Sat, Sep 29, 2018 at 5:52 PM Glenn Morris <rgm@gnu.org> wrote:
> >
> >
> > > branch: master
> > > commit 3bbe9e609138ae88a4c98bcee0da8fcf8b4a3e80
> > > Author: Allen Li <darkfeline@felesatra.moe>
> > > Commit: Eli Zaretskii <eliz@gnu.org>
> > >
> > > Avoid writing empty abbrev tables
> >
> > Hi, this causes some abbrev tests to fail.
> > Ref eg https://hydra.nixos.org/build/82163465
> >
> > In general, after changing lisp/foo.el, running the tests from
> > test/lisp/foo.el only takes a few seconds.
[-- Attachment #2: 0001-Rework-empty-abbrev-table-omitting.patch --]
[-- Type: text/x-patch, Size: 6334 bytes --]
From 8f3aadf85ef9d515f6140dad89be426128485981 Mon Sep 17 00:00:00 2001
From: Allen Li <darkfeline@felesatra.moe>
Date: Sat, 29 Sep 2018 15:19:04 -0700
Subject: [PATCH] Rework empty abbrev table omitting
There were two problems with the original implementation:
1. It changed the behavior of insert-abbrev-table-description when
READABLE is nil to sometimes insert one Emacs Lisp expression and
sometimes insert nothing.
2. It broke the tests.
This commit reworks this so that insert-abbrev-table-description
always inserts an expressions even if no abbrevs need to be saved and
making only write-abbrev-file check that a table has any abbrevs to
save before calling insert-abbrev-table-description. This duplicates
the work of filtering the table for savable abbrevs, but the benefit
of keeping the API is worth it.
* doc/lispref/abbrevs.texi (Abbrev Tables): Update documentation.
* lisp/abbrev.el (write-abbrev-file): Skip tables without user abbrevs
(insert-abbrev-table-description): Always insert the define
expression.
(abbrev--table-symbols): New function.
* test/lisp/abbrev-tests.el (abbrev--table-symbols-test):
Add test for abbrev--table-symbols.
---
doc/lispref/abbrevs.texi | 7 +++---
lisp/abbrev.el | 52 ++++++++++++++++++++++-----------------
test/lisp/abbrev-tests.el | 8 ++++++
3 files changed, 40 insertions(+), 27 deletions(-)
diff --git a/doc/lispref/abbrevs.texi b/doc/lispref/abbrevs.texi
index 4c9e653cb1..1e9471ba27 100644
--- a/doc/lispref/abbrevs.texi
+++ b/doc/lispref/abbrevs.texi
@@ -122,9 +122,7 @@ Abbrev Tables
description is a Lisp expression---a call to @code{define-abbrev-table}
that would define @var{name} as it is currently defined, but without
the system abbrevs. (The mode or package using @var{name} is supposed
-to add these to @var{name} separately.) If the Lisp expression would
-not define any abbrevs (i.e.@: it defines an empty abbrev table), this
-function inserts nothing.
+to add these to @var{name} separately.)
@end defun
@node Defining Abbrevs
@@ -234,7 +232,8 @@ Abbrev Files
Save all abbrev definitions (except system abbrevs), for all abbrev
tables listed in @code{abbrev-table-name-list}, in the file
@var{filename}, in the form of a Lisp program that when loaded will
-define the same abbrevs. If @var{filename} is @code{nil} or omitted,
+define the same abbrevs. Tables that do not have any abbrevs to save
+are omitted. If @var{filename} is @code{nil} or omitted,
@code{abbrev-file-name} is used. This function returns @code{nil}.
@end deffn
diff --git a/lisp/abbrev.el b/lisp/abbrev.el
index e1fd366ba9..20a967d7d6 100644
--- a/lisp/abbrev.el
+++ b/lisp/abbrev.el
@@ -251,7 +251,8 @@ write-abbrev-file
(lambda (s1 s2)
(string< (symbol-name s1)
(symbol-name s2)))))
- (insert-abbrev-table-description table nil))
+ (if (abbrev--table-symbols table)
+ (insert-abbrev-table-description table nil)))
(when (unencodable-char-position (point-min) (point-max) 'utf-8)
(setq coding-system-for-write
(if (> emacs-major-version 24)
@@ -937,33 +938,38 @@ insert-abbrev-table-description
If READABLE is nil, an expression is inserted. The expression is
a call to `define-abbrev-table' that when evaluated will define
the abbrev table NAME exactly as it is currently defined.
-Abbrevs marked as \"system abbrevs\" are ignored. If the
-resulting expression would not define any abbrevs, nothing is
-inserted."
+Abbrevs marked as \"system abbrevs\" are ignored."
+ (let ((table (symbol-value name))
+ (symbols (abbrev--table-symbols name readable)))
+ (setq symbols (sort symbols 'string-lessp))
+ (let ((standard-output (current-buffer)))
+ (if readable
+ (progn
+ (insert "(")
+ (prin1 name)
+ (insert ")\n\n")
+ (mapc 'abbrev--describe symbols)
+ (insert "\n\n"))
+ (insert "(define-abbrev-table '")
+ (prin1 name)
+ (if (null symbols)
+ (insert " '())\n\n")
+ (insert "\n '(\n")
+ (mapc 'abbrev--write symbols)
+ (insert " ))\n\n")))
+ nil)))
+
+(defun abbrev--table-symbols (name &optional system)
+ "Return the user abbrev symbols in the abbrev table named NAME.
+NAME is a symbol whose value is an abbrev table. System abbrevs
+are omitted unless SYSTEM is non-nil."
(let ((table (symbol-value name))
(symbols ()))
(mapatoms (lambda (sym)
- (if (and (symbol-value sym) (or readable (not (abbrev-get sym :system))))
+ (if (and (symbol-value sym) (or system (not (abbrev-get sym :system))))
(push sym symbols)))
table)
- (when symbols
- (setq symbols (sort symbols 'string-lessp))
- (let ((standard-output (current-buffer)))
- (if readable
- (progn
- (insert "(")
- (prin1 name)
- (insert ")\n\n")
- (mapc 'abbrev--describe symbols)
- (insert "\n\n"))
- (insert "(define-abbrev-table '")
- (prin1 name)
- (if (null symbols)
- (insert " '())\n\n")
- (insert "\n '(\n")
- (mapc 'abbrev--write symbols)
- (insert " ))\n\n")))
- nil))))
+ symbols))
(defun define-abbrev-table (tablename definitions
&optional docstring &rest props)
diff --git a/test/lisp/abbrev-tests.el b/test/lisp/abbrev-tests.el
index facf097815..e50f931cef 100644
--- a/test/lisp/abbrev-tests.el
+++ b/test/lisp/abbrev-tests.el
@@ -64,6 +64,14 @@ setup-test-abbrev-table-with-props
(should (= (length table) obarray-default-size))
(should (eq (abbrev-table-get table 'foo) 'bar))))
+(ert-deftest abbrev--table-symbols-test ()
+ (let ((ert-test-abbrevs (setup-test-abbrev-table)))
+ (define-abbrev ert-test-abbrevs "sys" "system abbrev" nil :system t)
+ (should (equal (mapcar #'symbol-name (abbrev--table-symbols 'ert-test-abbrevs))
+ '("a-e-t")))
+ (should (equal (mapcar #'symbol-name (abbrev--table-symbols 'ert-test-abbrevs t))
+ '("a-e-t" "sys")))))
+
(ert-deftest abbrev-table-get-put-test ()
(let ((table (make-abbrev-table)))
(should-not (abbrev-table-get table 'foo))
--
2.19.0
next prev parent reply other threads:[~2018-09-29 22:28 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20180929072840.28850.95999@vcs0.savannah.gnu.org>
[not found] ` <20180929072841.8E35B20455@vcs0.savannah.gnu.org>
2018-09-29 17:52 ` master 3bbe9e6: Avoid writing empty abbrev tables Glenn Morris
2018-09-29 21:06 ` Allen Li
2018-09-29 22:28 ` Allen Li [this message]
2018-09-30 5:36 ` Eli Zaretskii
2018-09-30 7:25 ` Allen Li
2018-09-30 7:44 ` Eli Zaretskii
2018-10-02 5:49 ` Allen Li
2018-10-12 8:45 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CADbSrJy2K-BDPGo-nptdwHHMeu61sm1Vb+KO6eCVDhq1PaWEqg@mail.gmail.com \
--to=darkfeline@felesatra.moe \
--cc=emacs-devel@gnu.org \
--cc=rgm@gnu.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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.