bug#24748: 26.0.50; Edebug fails to instrument subr-x-tests.el

bug#24748: 26.0.50; Edebug fails to instrument subr-x-tests.el

[Gemini Lasswell]

To reproduce, from the head of the emacs source tree:
1. emacs -Q
2. C-x C-f test/lisp/emacs-lisp/subr-x-tests.el RET
3. M-x edebug-all-defs RET
4. M-x eval-buffer RET

Result: Invalid read syntax error

Edebug is complaining when it gets to this:

(if-let (z (a 1) (b 2) (c 3))
    (list a b c)
  "no")

because it can't match it with if-let's Edebug specification.

I think that the Edebug spec is correct and that this use of if-let is
incorrect and that this form ought to be moved into
subr-x-test-if-let-malformed-binding.


In GNU Emacs 26.0.50.2 (x86_64-apple-darwin15.6.0, NS appkit-1404.47 Version 10.11.6 (Build 15G1004))
 of 2016-10-19 built on rainbow.local
Repository revision: 911ade134058c633ab9bec75f664d44aa1faaac3
Windowing system distributor 'Apple', version 10.3.1404
Recent messages:
Debug on Error disabled globally
You can run the command ‘toggle-debug-on-error’ with M-x t-er RET
Debug on Error disabled globally
Edebug: test@subr-x-test-if-let-single-binding-expansion
Edebug: test@subr-x-test-if-let-single-symbol-expansion
Edebug: test@subr-x-test-if-let-nil-related-expansion
Edebug: test@subr-x-test-if-let-malformed-binding
Edebug: test@subr-x-test-if-let-true
edebug-syntax-error: Invalid read syntax: "Expected one of", (&rest (symbolp form)), (symbolp form)
Text is read-only

Configured using:
 'configure --with-ns --disable-ns-self-contained'

Configured features:
JPEG RSVG IMAGEMAGICK NOTIFY ACL GNUTLS LIBXML2 ZLIB TOOLKIT_SCROLL_BARS
NS

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

Major mode: Emacs-Lisp

Minor modes in effect:
  magit-auto-revert-mode: t
  global-git-commit-mode: t
  async-bytecomp-package-mode: t
  global-undo-tree-mode: t
  undo-tree-mode: t
  diff-auto-refine-mode: t
  ivy-mode: t
  buffer-face-mode: t
  yas-global-mode: t
  yas-minor-mode: t
  pyvenv-mode: t
  shell-dirtrack-mode: t
  nameless-mode: t
  beacon-mode: t
  rainbow-mode: t
  column-enforce-mode: t
  volatile-highlights-mode: t
  region-state-mode: t
  ws-butler-global-mode: t
  ws-butler-mode: t
  show-smartparens-global-mode: t
  show-smartparens-mode: t
  smartparens-global-mode: t
  smartparens-global-strict-mode: t
  smartparens-strict-mode: t
  smartparens-mode: t
  which-key-mode: t
  modalka-mode: t
  recentf-mode: t
  global-auto-revert-mode: t
  auto-revert-mode: t
  winner-mode: t
  display-time-mode: t
  savehist-mode: t
  override-global-mode: t
  tooltip-mode: t
  global-eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  size-indication-mode: t
  column-number-mode: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow emacsbug highlight-symbol log-view vc vc-dispatcher windmove
goto-chg shrink-whitespace eieio-opt speedbar sb-image ezimage dframe
dash-at-point cc-engine cc-langs cc-vars cc-defs cc-bytecomp generator
linum magit-blame magit-stash magit-bisect magit-remote magit-commit
magit-sequence magit magit-apply magit-wip magit-log magit-diff
smerge-mode magit-core magit-autorevert magit-process magit-popup
magit-mode magit-git magit-section magit-utils git-commit log-edit
pcvs-util with-editor async-bytecomp async server zoom-window ert
find-func ewoc let-alist dabbrev expand-region text-mode-expansions
python-el-fgallina-expansions er-basic-expansions expand-region-core
expand-region-custom mailalias shr-color shr svg dom browse-url
two-column iso-transl nnir nndraft nnmh nnfolder utf-7 epa-file sort
smiley gnus-cite mail-extr qp gnus-async gnus-bcklg gnus-agent gnus-srvr
gnus-score score-mode nnvirtual nntp gnus-ml gnus-msg disp-table nndoc
gnus-cache gnus-dup gnus-art mm-uu mml2015 mm-view mml-smime smime dig
gnus-sum gnus-group gnus-undo gnus-start gnus-cloud nnimap nnmail
mail-source utf7 netrc nnoo parse-time gnus-spec gnus-int gnus-range
gnus-win gnus nnheader mm-archive message rfc822 mml mml-sec epa derived
epg gnus-util rmail rmail-loaddefs mailabbrev gmm-utils mailheader crm
debbugs-gnu add-log comment-dwim-2 undo-tree diff ielm pp debug
testcover edebug vc-git diff-mode colir flx dired dired-loaddefs counsel
esh-util swiper ivy delsel ffap face-remap guess-style smtpmail sendmail
mail-utils yasnippet highlight-indentation flymake company help-fns
radix-tree elpy pyvenv elpy-refactor smartparens-python python tramp-sh
tramp tramp-compat tramp-loaddefs trampver shell pcomplete format-spec
json map grep compile files-x cus-edit virtualenvwrapper gud comint
nameless lisp-mnt ace-window avy beacon smex ido deft debbugs
soap-client mm-decode mm-bodies mm-encode warnings rng-xsd rng-dt
rng-util xsd-regexp xml rainbow-mode ansi-color color s hydra lv
column-enforce-mode etags xref project volatile-highlights region-state
ws-butler smartparens-config smartparens thingatpt dash which-key
modalka quail smart-mode-line-dark-theme smart-mode-line advice
rich-minority whiteboard-theme classic-theme recentf tree-widget
wid-edit autorevert filenotify winner ring time cus-start cus-load
savehist cap-words superword subword use-package diminish bind-key
easy-mmode finder-inf edmacro kmacro info network-stream starttls
url-http tls gnutls mail-parse rfc2231 rfc2047 rfc2045 mm-util
ietf-drums mail-prsvr url-gw nsm subr-x puny url-cache url-auth url
url-proxy url-privacy url-expand url-methods url-history url-cookie
url-domsuf url-util mailcap cl package epg-config url-handlers url-parse
auth-source cl-seq eieio eieio-core cl-macs eieio-loaddefs
password-cache url-vars seq byte-opt gv bytecomp byte-compile cl-extra
help-mode easymenu cconv cl-loaddefs pcase cl-lib time-date mule-util
tooltip eldoc electric uniquify ediff-hook vc-hooks lisp-float-type
mwheel term/ns-win ns-win ucs-normalize term/common-win tool-bar dnd
fontset image regexp-opt fringe tabulated-list newcomment elisp-mode
lisp-mode prog-mode register page menu-bar rfn-eshadow timer select
scroll-bar mouse jit-lock font-lock syntax facemenu font-core
term/tty-colors frame 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 charscript case-table epa-hook jka-cmpr-hook help simple abbrev
obarray minibuffer cl-preloaded nadvice loaddefs button faces cus-face
macroexp files text-properties overlay sha1 md5 base64 format env
code-pages mule custom widget hashtable-print-readable backquote kqueue
cocoa ns multi-tty make-network-process emacs)

Memory information:
((conses 16 1836058 236199)
 (symbols 48 55494 0)
 (miscs 40 8400 8347)
 (strings 32 192697 74616)
 (string-bytes 1 5495243)
 (vectors 16 84753)
 (vector-slots 8 1452509 94455)
 (floats 8 5271 2267)
 (intervals 56 174606 5755)
 (buffers 976 87))

bug#24748: 26.0.50; Edebug fails to instrument subr-x-tests.el

[Gemini Lasswell]

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

Gemini Lasswell <gazally@runbox.com> writes:

> Edebug is complaining when it gets to this:
>
> (if-let (z (a 1) (b 2) (c 3))
>     (list a b c)
>   "no")
>
> because it can't match it with if-let's Edebug specification.

Now that Mark has fixed if-let's docstring to clarify the description of
its bindings list, here's a matching Edebug spec which accepts the form
above:


[-- Attachment #2: 0001-lisp-emacs-lisp-subr-x.el-if-let-Fix-Edebug-spec-Bug.patch --]
[-- Type: text/plain, Size: 925 bytes --]

From 192a5649fef5a686676b98340818b3f6ab4e5a47 Mon Sep 17 00:00:00 2001
From: Gemini Lasswell <gazally@runbox.com>
Date: Sat, 4 Feb 2017 16:16:11 -0800
Subject: [PATCH] * lisp/emacs-lisp/subr-x.el (if-let*): Fix Edebug spec
 (Bug#24748)

---
 lisp/emacs-lisp/subr-x.el | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lisp/emacs-lisp/subr-x.el b/lisp/emacs-lisp/subr-x.el
index f7a8469..1d729f9 100644
--- a/lisp/emacs-lisp/subr-x.el
+++ b/lisp/emacs-lisp/subr-x.el
@@ -126,7 +126,8 @@ if-let*
 VARLIST can just be a plain tuple.
 \n(fn VARLIST THEN ELSE...)"
   (declare (indent 2)
-           (debug ([&or (&rest (symbolp form)) (symbolp form)] form body)))
+           (debug ([&or (&rest [&or symbolp (symbolp form)]) (symbolp form)]
+                   form body)))
   (when (and (<= (length bindings) 2)
              (not (listp (car bindings))))
     ;; Adjust the single binding case
-- 
2.10.1

bug#24748: 26.0.50; Edebug fails to instrument subr-x-tests.el

[Mark Oteiza]

Gemini Lasswell <gazally@runbox.com> writes:

> Gemini Lasswell <gazally@runbox.com> writes:
>
>> Edebug is complaining when it gets to this:
>>
>> (if-let (z (a 1) (b 2) (c 3))
>>     (list a b c)
>>   "no")
>>
>> because it can't match it with if-let's Edebug specification.
>
> Now that Mark has fixed if-let's docstring to clarify the description of
> its bindings list, here's a matching Edebug spec which accepts the form
> above:

Pushed as 54018206, thanks.

bug#24748: 26.0.50; Edebug fails to instrument subr-x-tests.el

[Gemini Lasswell]

Hi Mark,

Your follow-up commit on this bug fix (fd4b83ca7c) breaks the case where
the variable list is just a tuple.

To reproduce, use C-u C-M-x on dom-previous-sibling in lisp/dom.el.
This results in:
edebug-syntax-error: Invalid read syntax: "Failed matching", (gate symbolp &optional form)

bug#24748: 26.0.50; Edebug fails to instrument subr-x-tests.el

[Mark Oteiza]

Gemini Lasswell <gazally@runbox.com> writes:

> Hi Mark,
>
> Your follow-up commit on this bug fix (fd4b83ca7c) breaks the case where
> the variable list is just a tuple.
>
> To reproduce, use C-u C-M-x on dom-previous-sibling in lisp/dom.el.
> This results in:
> edebug-syntax-error: Invalid read syntax: "Failed matching", (gate
> symbolp &optional form)

Darn.  Reverted in 4e0887556, thanks for the report Gemini.