GNU bug report logs - #67569
29.1; ruby-mode syntax highlighting breaks with variable named "index" and "/" operator

Previous Next

Full log

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

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Michael Hoy <mjh <at> mjhoy.com>, 67569 <at> debbugs.gnu.org,
 Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#67569: 29.1; ruby-mode syntax highlighting breaks with
 variable named "index" and "/" operator
Date: Sat, 9 Dec 2023 16:13:02 +0200

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

On 01/12/2023 16:27, Michael Hoy wrote:
> In the standard ruby-mode, a variable named "index" followed by a "/"
> causes the syntax highlighting to break -- it appears that after the
> slash everything is interpreted as part of a regular expression until
> another "/" appears.
> 
> You can reproduce this fairly easily. using 'emacs -Q', go to the
> scratch buffer and clear it. Run 'M-x ruby-mode'. Enter something like
> the following:
> 
> def foo
>    index = 5
>    x = index / 3
>    puts "#{x}"
> end
> 
> Note that starting after the "/" until the end, syntax highlighting and
> indentation break (everything, in my color scheme, is purple). If you
> add a "/" for instance to the "puts" line, syntax highlighting and
> indentation will be restored after that.

Thanks for filing this. The reasons is our regexp detection mechanism, 
with a whitelist for methods that call accept regexps (of which 'index' 
is one), and could be called without parens.

Anyway, it looks like Ruby actually looks at whether there is a space 
after "/", and if so, interprets this as division (when there is nothing 
else to disambiguate, such as parens around the call). So we can follow 
suit, the attached patch seems to fix it.

Also, perhaps you'll want to try ruby-ts-mode which is in Emacs 29.1, 
and which uses a "real" (tree-sitter) grammar. Indentation-wise, it 
should behave more or less the same as ruby-mode.

Eli, should we put this in Emacs 29.2? It's not a regression (a fairly 
old problem), but the fix looks simple enough.

> There is a report here about the bug:
> https://emacs.stackexchange.com/questions/23802/division-sometimes-breaks-syntax-highlighting-in-ruby-mode
> The author says in the comments they used "M-x report-emacs-bug", but I
> couldn't find it (and the comments suggest that it may not have been
> sent correctly). Apologies if this is already reported!

I was hoping the author would follow through with investigating why the 
bug did not reach the tracker, but that didn't happen. I've seen this 
kind of feedback a few times, but not lately. Maybe whatever the issue 
was, got resolved in 2016. Or people still send reports into nowhere, 
and we just don't hear about it.

[ruby-index-slash-no-regexp.diff (text/x-patch, attachment)]

Previous Next

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