Subject: 25.1.50; incorrect edebug spec for cl-defstruct

From: Gemini Lasswell <[email-masked]>
Date: Tue, 13 Sep 2016 12:20:01 -0700

Edebug fails to instrument code which uses cl-defstruct. I found an example of the problem in Emacs’s source tree. Here are the steps to reproduce it:

1. emacs -Q
2. C-x C-f emacs/lisp/emacs-lisp/avl-tree.el RET
3. M-x toggle-debug-on-error RET
4. M-x edebug-all-defs RET
5. M-x eval-buffer RET

Result: invalid-read-syntax error.  See attachment for backtrace. The cursor is at :named in the code excerpt below:

(cl-defstruct (avl-tree-
            ;; A tagged list is the pre-defstruct representation.
            ;; (:type list)
            :named
            (:constructor nil)
            (:constructor avl-tree--create (cmpfun))
            (:predicate avl-tree-p)
            (:copier nil))
  (dummyroot (avl-tree--node-create nil nil nil 0))
  cmpfun)

In GNU Emacs 25.1.50.13 (x86_64-apple-darwin15.6.0, NS appkit-1404.47 Version 10.11.6 (Build 15G1004))
of 2016-09-13 built on rainbow.local
Windowing system distributor 'Apple', version 10.3.1404
Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.
Debug on Error enabled globally
You can run the command ‘toggle-debug-on-error’ with M-x t-er RET
Debug on Error enabled globally
Edebugging all definitions is on.
You can run the command ‘edebug-all-defs’ with M-x -defs RET
Edebugging all definitions is on.
Entering debugger...

Configured using:
'configure --with-ns --without-gnutls'

Configured features:
JPEG IMAGEMAGICK NOTIFY ACL LIBXML2 ZLIB TOOLKIT_SCROLL_BARS NS

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

Major mode: Debugger

Minor modes in effect:
  diff-auto-refine-mode: t
  tooltip-mode: t
  global-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
  buffer-read-only: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message subr-x puny dired dired-loaddefs
format-spec rfc822 mml mml-sec password-cache epa derived epg epg-config
gnus-util rmail rmail-loaddefs mm-decode mm-bodies mm-encode mail-parse
rfc2231 mailabbrev gmm-utils mailheader sendmail rfc2047 rfc2045
ietf-drums mm-util mail-prsvr mail-utils debug cl-macs edebug cus-start
cus-load vc-git diff-mode easy-mmode map 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 221064 8535)
(symbols 48 22186 0)
(miscs 40 64 176)
(strings 32 22570 6911)
(string-bytes 1 697139)
(vectors 16 35903)
(vector-slots 8 679780 5699)
(floats 8 188 29)
(intervals 56 412 0)
(buffers 976 13))