bash syntax highlighting broken with $ sign inside double quotes

[ifschulz]

There seems to be an issue with bash syntax highlighting when using a ‘$’ as the last character of a double quoted string. Up to notepad++-v8.5.3 everything was fine, but with v8.5.4 it breaks the syntax highlighting to the end of the document:

v8.5.3:

v8.5.4:

This can of course be fixed with escaping the ‘$’ sign:

Even though using an unescaped ‘$’ sign inside double quotes (when not referencing a variable) is not best practice, it should still not break the syntax highlighting.

[zufuliu]

It's due following code, which should be disabled for String, LString, and HereDoc:

lexilla/lexers/LexBash.cxx

Lines 331 to 336 in f157108

	} else if (sc.ch == '\'') {
	style = QuoteStyle::CString;
	sc.ChangeState(SCE_SH_STRING);
	} else if (sc.ch == '"') {
	style = QuoteStyle::LString;
	sc.ChangeState(SCE_SH_STRING);

it can be fixed by passing a parameter to Expand() or added a method to QuoteStackCls, not sure what would be a good name.

[zufuliu]

A simple fix:

diff --git a/lexers/LexBash.cxx b/lexers/LexBash.cxx
index 4945ef70..bc7cff71 100644
--- a/lexers/LexBash.cxx
+++ b/lexers/LexBash.cxx
@@ -864,7 +864,7 @@ void SCI_METHOD LexerBash::Lex(Sci_PositionU startPos, Sci_Position length, int
 							if (stylingInside) {
 								sc.SetState(SCE_SH_BACKTICKS | insideCommand);
 							}
-						} else if (sc.ch == '$') {
+						} else if (sc.ch == '$' && !AnyOf(sc.chNext, '\"', '\'')) {
 							QuoteStack.Expand(sc, cmdState, stylingInside);
 							continue;
 						}

[nyamatongwe]

Example as text:

egrep '^[A-Z]$'
test=foobar

egrep "^[A-Z]$"
test=foobar

egrep "^[A-Z]\$"
test=foobar

Check in Linux for:

echo '$'
echo "$"
echo "$"
echo "$"x""

Result:

>bash 180example.sh
$
$
$
$x
>Exit code: 0

[zufuliu]

C-String test case:

echo x$'\t'y
echo "x$'\t'y"
echo "x\ty"

[zufuliu]

It seems to fully fix this we need a list of all special variables (the && !AnyOf(sc.chNext, '\"', '\'') part is still needed for string/heredoc block), current code teat all punctuation and white spaces as single character special variable. there is another bug reported at zufuliu/notepad4#684:

Bash special variables are list at https://www.gnu.org/software/bash/manual/bash.html#Variable-Index

[zufuliu]

It seems to fully fix this we need a list of all special variables (the && !AnyOf(sc.chNext, '\"', '\'') part is still needed for string/heredoc block), current code teat all punctuation and white spaces as single character special variable. there is another bug reported at zufuliu/notepad2#684:

Created #184 as separate issue.