Highlight array assignments

[danielshahaf]

In x=(foo), highlight the parentheses as reserved words.

Compare #572 about scalar assignments.

[danielshahaf]

Good news: it's trivial to implement:

diff --git a/highlighters/main/main-highlighter.zsh b/highlighters/main/main-highlighter.zsh
index 0048147..5ab4767 100644
--- a/highlighters/main/main-highlighter.zsh
+++ b/highlighters/main/main-highlighter.zsh
@@ -934,6 +934,7 @@ _zsh_highlight_main_highlighter_highlight_list()
                           local i=$(( arg[(i)=] + 1 ))
                           if [[ $arg[i] == '(' ]]; then
                             in_array_assignment=true
+                            _zsh_highlight_main_add_region_highlight i-2 i reserved-word
                           else
                             # assignment to a scalar parameter.
                             # (For array assignments, the command doesn't start until the ")" token.)
@@ -1012,6 +1013,7 @@ _zsh_highlight_main_highlighter_highlight_list()
                  if $in_array_assignment; then
                    style=assign
                    in_array_assignment=false
+                   _zsh_highlight_main_add_region_highlight $start_pos $end_pos reserved-word
                    next_word+=':start:'
                  elif (( in_redirection )); then
                    style=unknown-token

Bad news: it breaks the expectations of every test that uses array assignments — there's 10 of them.

[danielshahaf]

Rebased patch:

diff --git a/highlighters/main/main-highlighter.zsh b/highlighters/main/main-highlighter.zsh
index 9bf0e3a..6661b19 100644
--- a/highlighters/main/main-highlighter.zsh
+++ b/highlighters/main/main-highlighter.zsh
@@ -1007,6 +1007,7 @@ _zsh_highlight_main_highlighter_highlight_list()
                           saw_assignment=true
                           if [[ $arg[i] == '(' ]]; then
                             in_array_assignment=true
+                            _zsh_highlight_main_add_region_highlight i-2 i reserved-word
                           else
                             # assignment to a scalar parameter.
                             # (For array assignments, the command doesn't start until the ")" token.)
@@ -1090,6 +1091,7 @@ _zsh_highlight_main_highlighter_highlight_list()
                   if $in_array_assignment; then
                     style=assign
                     in_array_assignment=false
+                    _zsh_highlight_main_add_region_highlight $start_pos $end_pos reserved-word
                     next_word+=':start:'
                   elif (( in_redirection )); then
                     style=unknown-token

[danielshahaf]

Exemplar failure:

## array-cmdsep2
# BUFFER=$'a=( foo ; bar )'
ok 1 - [1,3] «a=(»
not ok 2 - [2,3] «=(» - expected (5 7 "default"), observed (2 3 "reserved-word"). 
not ok 3 - [5,7] «foo» - expected (9 9 "unknown-token"), observed (5 7 "default"). 
not ok 4 - [9,9] «;» - expected (11 13 "default"), observed (9 9 "unknown-token"). 
not ok 5 - [11,13] «bar» - expected (15 15 "assign"), observed (11 13 "default"). 
not ok 6 - cardinality check - have 5 expectations and 7 region_highlight entries: «expected_region_highlight=( $'1 3 assign' $'5 7 default' $'9 9 unknown-token' $'11 13 default' $'15 15 assign' )» «region_highlight=( $'0 3 assign' $'1 3 reserved-word' $'4 7 default' $'8 9 unknown-token' $'10 13 default' $'14 15 reserved-word' $'14 15 assign' )»
# expected_region_highlight  region_highlight
# '1 3 assign'               '0 3 assign'
# '5 7 default'              '1 3 reserved-word'
# '9 9 unknown-token'        '4 7 default'
# '11 13 default'            '8 9 unknown-token'
# '15 15 assign'             '10 13 default'
# .                          '14 15 reserved-word'
# .                          '14 15 assign'

@phy1729 What should the expectations be here? In particular, is the actual highlighting of the closing parenthesis (14 15 *) correct?

[danielshahaf]

Triage: Incomplete, so deferring to 0.9.0. If we get it ready sooner, great.

[phy1729]

_zsh_highlight_main_add_region_highlight i-2 i reserved-word I presume this should be i-1 so that just the parenthesis is highlighted not the equals sign as well? I think for the second hunk just change style=assign to style=reserved-word so it isn't highlighted with assign after reserve-word.

[danielshahaf]

_zsh_highlight_main_add_region_highlight i-2 i reserved-word I presume this should be i-1 so that just the parenthesis is highlighted not the equals sign as well?

Hmm. I guess I'll make the change, if only to be consistent with scalar assignments. If we want to highlight the = as a reserved word, we should do that for both scalar and array assignments.

I think for the second hunk just change style=assign to style=reserved-word so it isn't highlighted with assign after reserve-word.

But the opening parenthesis is similarly highlighted with both assign and reserved-word (see the make test output). I assume the opening and closing parentheses should be highlighted the same way as each other, shouldn't they?

[phy1729]

For a scalar assignment, all of foo=bar is highlighted assign. Should all of foo=(bar baz) be highlighted as assign and layer the reserved-word highlighting on top for the parentheses? The assign style by default is none, so it wouldn't change anything for people who don't explicitly set assign.

I do agree the opening and closing should be highlighted the same way, so the other reasonable option would be foo=( assign, ( reserved-word, ) assign, ) reserved-word in that order (otherwise different styles could take precedence and the two parentheses be highlighted differently.