bug#31146: 27.0.50; ielm via cl-prin1 infloops when printing circular object

bug#31146: 27.0.50; ielm via cl-prin1 infloops when printing circular object

[Basil L. Contovounesios]

(This is a repeat of a recipe I sent to bug#18012 as a separate report.)

The following change:

81b5131e11: 2018-01-15 17:04:05 -0500
  * lisp/ielm.el (ielm-eval-input): Use cl-print.
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=81b5131e11fa96d32a1718c6e2ebf40994d7d281

now results in the following behaviour:

1. emacs -Q
2. M-x ielm RET
3. (let ((l (make-list 2 0)))
     (nconc l (cdr l)))
4. C-m
     => infloop
5. C-g
     => *** IELM Error ***  Quit during pretty-printing

Evaluating (4) in *scratch* via C-j, by contrast, inserts (0 0 . #1)
without inflooping, presumably because pp is used instead of cl-prin1.

-- 
Basil

In GNU Emacs 27.0.50 (build 1, x86_64-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2018-04-12 built on thunk
Repository revision: 17174d3f77fe6d5103bfe7e858035a0038010522
Windowing system distributor 'The X.Org Foundation', version 11.0.11906000
System Description: Debian GNU/Linux buster/sid

Configured using:
 'configure --config-cache --prefix=/home/blc/.local --with-mailutils
 --with-x-toolkit=lucid --with-modules --with-file-notification=yes
 --with-x 'CFLAGS=-march=native -O2 -pipe''

Configured features:
XAW3D XPM JPEG TIFF GIF PNG RSVG IMAGEMAGICK SOUND GPM DBUS GSETTINGS
NOTIFY ACL LIBSELINUX GNUTLS LIBXML2 FREETYPE M17N_FLT LIBOTF XFT ZLIB
TOOLKIT_SCROLL_BARS LUCID X11 MODULES THREADS LIBSYSTEMD JSON LCMS2

bug#31146: 27.0.50; ielm via cl-prin1 infloops when printing circular object

[Noam Postavsky]

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

retitle 31146 cl-prin1 infloops when printing list with circularity in the tail
tags 31146 + patch
quit

"Basil L. Contovounesios" <contovob@tcd.ie> writes:

> 1. emacs -Q
> 2. M-x ielm RET
> 3. (let ((l (make-list 2 0)))
>      (nconc l (cdr l)))
> 4. C-m
>      => infloop

Right, though the bug is really about cl-prin1, ielm is just incidental.

Here's a patch.  Hmm, how should cl-defmethod changes be specified in
the ChangeLog?  I just put (cl-print-object), but is there some notation
to indicate it's this particular defmethod?

    (cl-defmethod cl-print-object ((object cons) stream)


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

From 57d1b421826b0b605abf2e9023e1a4f004b3502e Mon Sep 17 00:00:00 2001
From: Noam Postavsky <npostavs@gmail.com>
Date: Sat, 14 Apr 2018 01:02:25 -0400
Subject: [PATCH v1] Fix cl-print for circular sublists (Bug#31146)

* lisp/emacs-lisp/cl-print.el (cl-print-object): Push each element of
list being printed onto cl-print--currently-printing.
* test/lisp/emacs-lisp/cl-print-tests.el (cl-print-circle-2): New
test.
---
 lisp/emacs-lisp/cl-print.el            |  9 ++++++---
 test/lisp/emacs-lisp/cl-print-tests.el | 10 ++++++++++
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/lisp/emacs-lisp/cl-print.el b/lisp/emacs-lisp/cl-print.el
index 78cd6f9d9e..ada5923515 100644
--- a/lisp/emacs-lisp/cl-print.el
+++ b/lisp/emacs-lisp/cl-print.el
@@ -62,9 +62,12 @@ cl-print--currently-printing
       (princ "(" stream)
       (cl-print-object car stream)
       (while (and (consp object)
-                  (not (if cl-print--number-table
-                           (numberp (gethash object cl-print--number-table))
-                         (memq object cl-print--currently-printing))))
+                  (not (cond
+                        (cl-print--number-table
+                         (numberp (gethash object cl-print--number-table)))
+                        ((memq object cl-print--currently-printing))
+                        (t (push object cl-print--currently-printing)
+                           nil))))
         (princ " " stream)
         (cl-print-object (pop object) stream))
       (when object
diff --git a/test/lisp/emacs-lisp/cl-print-tests.el b/test/lisp/emacs-lisp/cl-print-tests.el
index 660d5c8069..d986c4015d 100644
--- a/test/lisp/emacs-lisp/cl-print-tests.el
+++ b/test/lisp/emacs-lisp/cl-print-tests.el
@@ -55,4 +55,14 @@
     (let ((print-circle t))
       (should (equal "(#1=(a . #1#) #1#)" (cl-prin1-to-string x))))))
 
+(ert-deftest cl-print-circle-2 ()
+  ;; Bug#31146.
+  (let ((x '(0 . #1=(0 . #1#))))
+    (let ((print-circle nil))
+      (should (string-match "\\`(0 0 . #[0-9])\\'"
+                            (cl-prin1-to-string x))))
+    (let ((print-circle t))
+      (should (equal "(0 . #1=(0 . #1#))" (cl-prin1-to-string x))))))
+
+
 ;;; cl-print-tests.el ends here.
-- 
2.11.0

bug#31146: 27.0.50; ielm via cl-prin1 infloops when printing circular object

[Basil L. Contovounesios]

Noam Postavsky <npostavs@gmail.com> writes:

> Right, though the bug is really about cl-prin1, ielm is just incidental.

Indeed.  The only significance of ielm I was alluding to in this case is
that, as a presumably popular interactive environment, it probably
shouldn't infloop, regardless of implementation.

> Here's a patch.

Thanks for working on this,

-- 
Basil

bug#31146: 27.0.50; ielm via cl-prin1 infloops when printing circular object

[Noam Postavsky]

found 31146 26.1
tags 31146 fixed
close 31146 27.1
quit

Noam Postavsky <npostavs@gmail.com> writes:

> Here's a patch.

Pushed to master.

> Hmm, how should cl-defmethod changes be specified in the ChangeLog?  I
> just put (cl-print-object), but is there some notation to indicate
> it's this particular defmethod?

It looks like <...> is (sometimes) used for this.

[1: b8aa7ecf54]: 2018-04-26 07:37:48 -0400
  Fix cl-print for circular sublists (Bug#31146)
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=b8aa7ecf54c9b164a59f1b0e9f9fe90531dadd20