GNU bug report logs - #64283
29.0.91; js-mode's mark-defun does not work correctly when functions have a comment on top

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 64283 in the body.
You can then email your comments to 64283 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Daniel Martín <mardani29 <at> yahoo.es>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.91; js-mode's mark-defun does not work correctly when
 functions have a comment on top
Date: Sun, 25 Jun 2023 15:05:45 +0200

This is a regression from Emacs 28.2.

emacs -Q
C-x b sample.js RET
M-x js-mode
Paste the following code:

function foo() {
  var value = 1;
}

/* Hello */
function bar() {
  var value = 1;
}

Place the point inside function bar.
C-M-h

Expected result:

Function bar is marked.

Actual result:

Comment "/* Hello */" is marked.

This is probably related to the following regression:

When point is between function foo and function bar, C-M-e moves point
to the _beginning_ of bar, not to the end of bar.

In GNU Emacs 29.0.91 (build 8, aarch64-apple-darwin21.6.0, NS
 appkit-2113.60 Version 12.6 (Build 21G115)) of 2023-06-07 built on
 Daniels-MacBook-Pro.local
Repository revision: bcc222251e1a750a11e365f2faa641cc56c1169d
Repository branch: emacs-29
Windowing system distributor 'Apple', version 10.3.2113
System Description:  macOS 12.6.7

Configured using:
 'configure 'CFLAGS=-O0 -g3 -fsanitize=address'
 CPPFLAGS=-I/opt/homebrew/opt/openjdk <at> 11/include'

Configured features:
ACL GNUTLS JSON LCMS2 LIBXML2 MODULES NOTIFY KQUEUE NS PDUMPER PNG
SQLITE3 THREADS TOOLKIT_SCROLL_BARS WEBP ZLIB

Important settings:
  value of $LC_CTYPE: UTF-8
  locale-coding-system: utf-8-unix

Major mode: Shell

Minor modes in effect:
  shell-dirtrack-mode: t
  comint-fontify-input-mode: t
  tooltip-mode: t
  global-eldoc-mode: t
  show-paren-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
  blink-cursor-mode: t
  undelete-frame-mode: t
  line-number-mode: t
  indent-tabs-mode: t
  transient-mark-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t

Load-path shadows:
None found.

Features:
(shadow emacsbug ido cc-langs whitespace python pcase reposition edebug
gnus-msg sort find-dired kmacro cus-start cus-load info-look info
apropos display-line-numbers re-builder dabbrev pp mail-extr goto-addr
view smerge-mode diff log-view pcvs-util org-element org-persist org-id
org-refile avl-tree oc-basic ol-eww ol-rmail ol-mhe ol-irc ol-info
ol-gnus nnselect gnus-art mm-uu mml2015 mm-view mml-smime smime gnutls
dig gnus-sum gnus-group gnus-undo gnus-start gnus-dbus dbus gnus-cloud
nnimap nnmail mail-source utf7 nnoo parse-time gnus-spec gnus-int
gnus-range message sendmail rfc822 mml mml-sec epa derived epg rfc6068
epg-config mm-decode mm-bodies mm-encode mail-parse rfc2231 rfc2047
rfc2045 ietf-drums mailabbrev gmm-utils mailheader gnus-win ol-docview
ol-bibtex bibtex iso8601 ol-bbdb ol-w3m ol-doi org-link-doi org ob
ob-tangle ob-ref ob-lob ob-table ob-exp org-macro org-src ob-comint
org-pcomplete org-list org-footnote org-faces org-entities ob-emacs-lisp
ob-core ob-eval org-cycle org-table ol org-fold org-fold-core org-keys
oc org-loaddefs cal-menu calendar cal-loaddefs org-version org-compat
org-macs make-mode ffap grep pcmpl-gnu pcmpl-unix novice etags fileloop
generator pulse xref project shortdoc cl-extra proced noutline outline
icons add-log rng-xsd xsd-regexp rng-cmpct rng-nxml rng-valid rng-loc
rng-uri rng-parse nxml-parse rng-match rng-dt rng-util rng-pttrn nxml-ns
nxml-mode nxml-outln nxml-rap nxml-util nxml-enc xmltok yank-media
mhtml-mode css-mode eww xdg url-queue thingatpt shr pixel-fill kinsoku
url-file svg xml browse-url url url-proxy url-privacy url-expand
url-methods url-history url-cookie generate-lisp-file url-domsuf
url-util url-parse auth-source eieio eieio-core cl-macs password-cache
url-vars mailcap puny mm-url gnus nnheader gnus-util mail-utils range
wid-edit mm-util mail-prsvr color sgml-mode facemenu dom vc
bug-reference octave misearch multi-isearch js c-ts-common json map
cc-mode cc-fonts cc-guess cc-menus cc-cmds cc-styles cc-align cc-engine
cc-vars cc-defs ediff ediff-merg ediff-mult ediff-wind ediff-diff
ediff-help ediff-init ediff-util format-spec imenu doc-view filenotify
jka-compr image-mode exif vc-git diff-mode easy-mmode vc-dispatcher
sh-script rx smie treesit cl-seq executable files-x shell pcomplete
compile text-property-search comint ansi-osc ansi-color ring dired-aux
dired dired-loaddefs time-date subr-x help-fns radix-tree cl-print
byte-opt gv bytecomp byte-compile debug backtrace help-mode find-func
cl-loaddefs cl-lib rmc iso-transl tooltip cconv eldoc paren electric
uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel
term/ns-win ns-win ucs-normalize mule-util term/common-win tool-bar dnd
fontset image regexp-opt fringe tabulated-list replace newcomment
text-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 nadvice seq simple cl-generic
indonesian philippine 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 emoji-zwj charscript charprop case-table epa-hook
jka-cmpr-hook help abbrev obarray oclosure cl-preloaded button loaddefs
theme-loaddefs faces cus-face macroexp files window text-properties
overlay sha1 md5 base64 format env code-pages mule custom widget keymap
hashtable-print-readable backquote threads kqueue cocoa ns lcms2
multi-tty make-network-process emacs)

Memory information:
((conses 16 939191 235686)
 (symbols 48 45772 49)
 (strings 32 194496 17389)
 (string-bytes 1 6108451)
 (vectors 16 74154)
 (vector-slots 8 2095032 169146)
 (floats 8 489 580)
 (intervals 56 136872 727)
 (buffers 976 123))

Message #8 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Daniel Martín <mardani29 <at> yahoo.es>
To: Daniel Martín via "Bug reports for GNU Emacs, the Swiss
 army knife of text editors" <bug-gnu-emacs <at> gnu.org>
Cc: 64283 <at> debbugs.gnu.org
Subject: Re: bug#64283: 29.0.91; js-mode's mark-defun does not work
 correctly when functions have a comment on top
Date: Sun, 25 Jun 2023 15:38:12 +0200

Daniel Martín via "Bug reports for GNU Emacs, the Swiss army knife of
text editors" <bug-gnu-emacs <at> gnu.org> writes:

> This is a regression from Emacs 28.2.
>

This is the first commit where this bug happens:

commit 4489450f37deafb013b1f0fc00c89f0973fda14a
Author: Yuan Fu <casouri <at> gmail.com>
Date:   Thu Nov 10 15:00:29 2022 -0800

    In end-of-defun, terminate early if no further defun exists
    
    Before this change, end-of-defun calls end-of-defun-function even if
    point is not necessarily at the beginning of a defun (contrary to what
    end-of-defun-function's docstring claims).  Now it terminates early
    and doesn't call end-of-defun-function.
    
    * lisp/emacs-lisp/lisp.el (beginning-of-defun-raw): Update docstring
    clarifying the return value.
    (end-of-defun): Terminate early if beginning-of-defun-raw returns nil.

Message #14 received at 64283 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Daniel Martín <mardani29 <at> yahoo.es>, Yuan Fu
 <casouri <at> gmail.com>
Cc: Dmitry Gutov <dmitry <at> gutov.dev>, 64283 <at> debbugs.gnu.org
Subject: Re: bug#64283: 29.0.91;
 js-mode's mark-defun does not work correctly when functions have a
 comment on top
Date: Sun, 25 Jun 2023 18:05:07 +0300

> Date: Sun, 25 Jun 2023 15:38:12 +0200
> From:  Daniel Martín via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> Daniel Martín via "Bug reports for GNU Emacs, the Swiss army knife of
> text editors" <bug-gnu-emacs <at> gnu.org> writes:
> 
> > This is a regression from Emacs 28.2.
> >
> 
> This is the first commit where this bug happens:
> 
> commit 4489450f37deafb013b1f0fc00c89f0973fda14a
> Author: Yuan Fu <casouri <at> gmail.com>
> Date:   Thu Nov 10 15:00:29 2022 -0800
> 
>     In end-of-defun, terminate early if no further defun exists
>     
>     Before this change, end-of-defun calls end-of-defun-function even if
>     point is not necessarily at the beginning of a defun (contrary to what
>     end-of-defun-function's docstring claims).  Now it terminates early
>     and doesn't call end-of-defun-function.
>     
>     * lisp/emacs-lisp/lisp.el (beginning-of-defun-raw): Update docstring
>     clarifying the return value.
>     (end-of-defun): Terminate early if beginning-of-defun-raw returns nil.

Yuan, could you please look into this?

Message #17 received at 64283 <at> debbugs.gnu.org (full text, mbox):

From: Daniel Martín <mardani29 <at> yahoo.es>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Dmitry Gutov <dmitry <at> gutov.dev>, Yuan Fu <casouri <at> gmail.com>,
 64283 <at> debbugs.gnu.org
Subject: Re: bug#64283: 29.0.91; js-mode's mark-defun does not work
 correctly when functions have a comment on top
Date: Sun, 25 Jun 2023 22:49:36 +0200

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Date: Sun, 25 Jun 2023 15:38:12 +0200
>> From:  Daniel Martín via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
>> 
>> Daniel Martín via "Bug reports for GNU Emacs, the Swiss army knife of
>> text editors" <bug-gnu-emacs <at> gnu.org> writes:
>> 
>> > This is a regression from Emacs 28.2.
>> >
>> 
>> This is the first commit where this bug happens:
>> 
>> commit 4489450f37deafb013b1f0fc00c89f0973fda14a
>> Author: Yuan Fu <casouri <at> gmail.com>
>> Date:   Thu Nov 10 15:00:29 2022 -0800
>> 
>>     In end-of-defun, terminate early if no further defun exists
>>     
>>     Before this change, end-of-defun calls end-of-defun-function even if
>>     point is not necessarily at the beginning of a defun (contrary to what
>>     end-of-defun-function's docstring claims).  Now it terminates early
>>     and doesn't call end-of-defun-function.
>>     
>>     * lisp/emacs-lisp/lisp.el (beginning-of-defun-raw): Update docstring
>>     clarifying the return value.
>>     (end-of-defun): Terminate early if beginning-of-defun-raw returns nil.
>
> Yuan, could you please look into this?

What I see is that, after 4489450f37deafb013b1f0fc00c89f0973fda14a,
defun movement may be subtly broken if beginning-of-defun-function does
not return non-nil when it found the beginning of a defun.  One of the
affected modes is js-mode, but who knows if there are more out there.

We could either revert 4489450f37deafb013b1f0fc00c89f0973fda14a, because
of the incompatibilities it may cause (Yuan, what is the bug it tries to
fix?), or maybe adjust js-mode so that it follows the documentation of
beginning-of-defun-function and returns non-nil when it found the
beginning of a defun.  I've attached a patch that follows this second
approach, with some unit tests.  It fixes the bug on my side.

[0001-Make-js-beginning-of-defun-return-non-nil-on-success.patch (text/x-patch, attachment)]

Message #20 received at 64283 <at> debbugs.gnu.org (full text, mbox):

From: Yuan Fu <casouri <at> gmail.com>
To: Daniel Martín <mardani29 <at> yahoo.es>
Cc: Dmitry Gutov <dmitry <at> gutov.dev>, Eli Zaretskii <eliz <at> gnu.org>,
 64283 <at> debbugs.gnu.org
Subject: Re: bug#64283: 29.0.91; js-mode's mark-defun does not work correctly
 when functions have a comment on top
Date: Mon, 26 Jun 2023 18:42:41 -0700

> 
> What I see is that, after 4489450f37deafb013b1f0fc00c89f0973fda14a,
> defun movement may be subtly broken if beginning-of-defun-function does
> not return non-nil when it found the beginning of a defun.  One of the
> affected modes is js-mode, but who knows if there are more out there.
> 
> We could either revert 4489450f37deafb013b1f0fc00c89f0973fda14a, because
> of the incompatibilities it may cause (Yuan, what is the bug it tries to
> fix?), or maybe adjust js-mode so that it follows the documentation of
> beginning-of-defun-function and returns non-nil when it found the
> beginning of a defun.  I've attached a patch that follows this second
> approach, with some unit tests.  It fixes the bug on my side.
> 
> <0001-Make-js-beginning-of-defun-return-non-nil-on-success.patch>

The original problem that I tried to solve is that sometimes end-of-defun-function was called when point isn’t at the beginning of a defun, contrary to what the documentation claims. 

I first find out about it when writing defun movement functions for tree-sitter, but if you revert the commit now tree-sitter defun functions wouldn’t break: they have change quite a bit since then and treesit-end-of-defun don’t need to be called at the beginning of the defun anymore.

Yuan

Message #23 received at 64283 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Yuan Fu <casouri <at> gmail.com>
Cc: dmitry <at> gutov.dev, 64283 <at> debbugs.gnu.org, mardani29 <at> yahoo.es
Subject: Re: bug#64283: 29.0.91; js-mode's mark-defun does not work correctly
 when functions have a comment on top
Date: Tue, 27 Jun 2023 14:01:21 +0300

> From: Yuan Fu <casouri <at> gmail.com>
> Date: Mon, 26 Jun 2023 18:42:41 -0700
> Cc: Eli Zaretskii <eliz <at> gnu.org>,
>  Dmitry Gutov <dmitry <at> gutov.dev>,
>  64283 <at> debbugs.gnu.org
> 
> > 
> > What I see is that, after 4489450f37deafb013b1f0fc00c89f0973fda14a,
> > defun movement may be subtly broken if beginning-of-defun-function does
> > not return non-nil when it found the beginning of a defun.  One of the
> > affected modes is js-mode, but who knows if there are more out there.
> > 
> > We could either revert 4489450f37deafb013b1f0fc00c89f0973fda14a, because
> > of the incompatibilities it may cause (Yuan, what is the bug it tries to
> > fix?), or maybe adjust js-mode so that it follows the documentation of
> > beginning-of-defun-function and returns non-nil when it found the
> > beginning of a defun.  I've attached a patch that follows this second
> > approach, with some unit tests.  It fixes the bug on my side.
> > 
> > <0001-Make-js-beginning-of-defun-return-non-nil-on-success.patch>
> 
> The original problem that I tried to solve is that sometimes end-of-defun-function was called when point isn’t at the beginning of a defun, contrary to what the documentation claims. 
> 
> I first find out about it when writing defun movement functions for tree-sitter, but if you revert the commit now tree-sitter defun functions wouldn’t break: they have change quite a bit since then and treesit-end-of-defun don’t need to be called at the beginning of the defun anymore.

Thanks.

Do you (or anyone else) see a problem with the alternative proposed by
Daniel?  If not, I'd prefer not to revert at this stage, but instead
to apply the simple fix Daniel suggested.

Message #26 received at 64283 <at> debbugs.gnu.org (full text, mbox):

From: Yuan Fu <casouri <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Dmitry Gutov <dmitry <at> gutov.dev>, 64283 <at> debbugs.gnu.org,
 Daniel Martín <mardani29 <at> yahoo.es>
Subject: Re: bug#64283: 29.0.91; js-mode's mark-defun does not work correctly
 when functions have a comment on top
Date: Wed, 28 Jun 2023 13:11:43 -0700

> On Jun 27, 2023, at 4:01 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> From: Yuan Fu <casouri <at> gmail.com>
>> Date: Mon, 26 Jun 2023 18:42:41 -0700
>> Cc: Eli Zaretskii <eliz <at> gnu.org>,
>> Dmitry Gutov <dmitry <at> gutov.dev>,
>> 64283 <at> debbugs.gnu.org
>> 
>>> 
>>> What I see is that, after 4489450f37deafb013b1f0fc00c89f0973fda14a,
>>> defun movement may be subtly broken if beginning-of-defun-function does
>>> not return non-nil when it found the beginning of a defun.  One of the
>>> affected modes is js-mode, but who knows if there are more out there.
>>> 
>>> We could either revert 4489450f37deafb013b1f0fc00c89f0973fda14a, because
>>> of the incompatibilities it may cause (Yuan, what is the bug it tries to
>>> fix?), or maybe adjust js-mode so that it follows the documentation of
>>> beginning-of-defun-function and returns non-nil when it found the
>>> beginning of a defun.  I've attached a patch that follows this second
>>> approach, with some unit tests.  It fixes the bug on my side.
>>> 
>>> <0001-Make-js-beginning-of-defun-return-non-nil-on-success.patch>
>> 
>> The original problem that I tried to solve is that sometimes end-of-defun-function was called when point isn’t at the beginning of a defun, contrary to what the documentation claims. 
>> 
>> I first find out about it when writing defun movement functions for tree-sitter, but if you revert the commit now tree-sitter defun functions wouldn’t break: they have change quite a bit since then and treesit-end-of-defun don’t need to be called at the beginning of the defun anymore.
> 
> Thanks.
> 
> Do you (or anyone else) see a problem with the alternative proposed by
> Daniel?  If not, I'd prefer not to revert at this stage, but instead
> to apply the simple fix Daniel suggested.

I don’t see any problem :-)

Yuan

Message #31 received at 64283-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Yuan Fu <casouri <at> gmail.com>
Cc: dmitry <at> gutov.dev, 64283-done <at> debbugs.gnu.org, mardani29 <at> yahoo.es
Subject: Re: bug#64283: 29.0.91; js-mode's mark-defun does not work correctly
 when functions have a comment on top
Date: Thu, 29 Jun 2023 08:41:00 +0300

> From: Yuan Fu <casouri <at> gmail.com>
> Date: Wed, 28 Jun 2023 13:11:43 -0700
> Cc: Daniel Martín <mardani29 <at> yahoo.es>,
>  Dmitry Gutov <dmitry <at> gutov.dev>,
>  64283 <at> debbugs.gnu.org
> 
> 
> 
> > On Jun 27, 2023, at 4:01 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> > 
> >> From: Yuan Fu <casouri <at> gmail.com>
> >> Date: Mon, 26 Jun 2023 18:42:41 -0700
> >> Cc: Eli Zaretskii <eliz <at> gnu.org>,
> >> Dmitry Gutov <dmitry <at> gutov.dev>,
> >> 64283 <at> debbugs.gnu.org
> >> 
> >>> 
> >>> What I see is that, after 4489450f37deafb013b1f0fc00c89f0973fda14a,
> >>> defun movement may be subtly broken if beginning-of-defun-function does
> >>> not return non-nil when it found the beginning of a defun.  One of the
> >>> affected modes is js-mode, but who knows if there are more out there.
> >>> 
> >>> We could either revert 4489450f37deafb013b1f0fc00c89f0973fda14a, because
> >>> of the incompatibilities it may cause (Yuan, what is the bug it tries to
> >>> fix?), or maybe adjust js-mode so that it follows the documentation of
> >>> beginning-of-defun-function and returns non-nil when it found the
> >>> beginning of a defun.  I've attached a patch that follows this second
> >>> approach, with some unit tests.  It fixes the bug on my side.
> >>> 
> >>> <0001-Make-js-beginning-of-defun-return-non-nil-on-success.patch>
> >> 
> >> The original problem that I tried to solve is that sometimes end-of-defun-function was called when point isn’t at the beginning of a defun, contrary to what the documentation claims. 
> >> 
> >> I first find out about it when writing defun movement functions for tree-sitter, but if you revert the commit now tree-sitter defun functions wouldn’t break: they have change quite a bit since then and treesit-end-of-defun don’t need to be called at the beginning of the defun anymore.
> > 
> > Thanks.
> > 
> > Do you (or anyone else) see a problem with the alternative proposed by
> > Daniel?  If not, I'd prefer not to revert at this stage, but instead
> > to apply the simple fix Daniel suggested.
> 
> I don’t see any problem :-)

Thanks.  So I've now installed Daniel's patch on the released branch,
and I'm therefore closing this bug.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.