From c46b8d169e567ea465d4c1b06b14f950140ac023 Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@daniel.shahaf.name>
Date: Sat, 12 Sep 2015 20:29:04 +0000
Subject: [PATCH 1/2] test harness: Fix off-by-one discrepancy between observed
 and expected.

Fixes issue #195.
---
 .../brackets/test-data/mismatch-patentheses.zsh      |  8 ++++----
 .../brackets/test-data/nested-parentheses.zsh        | 12 ++++++------
 .../brackets/test-data/quoted-patentheses.zsh        |  2 +-
 .../brackets/test-data/simple-parentheses.zsh        |  8 ++++----
 .../brackets/test-data/unclosed-patentheses.zsh      |  6 +++---
 .../brackets/test-data/unclosed-patentheses2.zsh     |  6 +++---
 .../main/test-data/backslash-continuation.zsh        |  2 +-
 highlighters/main/test-data/multiline-string.zsh     |  2 +-
 highlighters/main/test-data/prefix-redirection.zsh   |  2 +-
 highlighters/main/test-data/simple-redirection.zsh   |  4 ++--
 highlighters/main/test-data/vanilla-newline.zsh      |  6 +++---
 tests/README.md                                      |  7 +++++++
 tests/test-highlighting.zsh                          |  5 ++++-
 13 files changed, 40 insertions(+), 30 deletions(-)

diff --git a/highlighters/brackets/test-data/mismatch-patentheses.zsh b/highlighters/brackets/test-data/mismatch-patentheses.zsh
index ad72f75..3e75292 100644
--- a/highlighters/brackets/test-data/mismatch-patentheses.zsh
+++ b/highlighters/brackets/test-data/mismatch-patentheses.zsh
@@ -31,8 +31,8 @@
 BUFFER='echo ({x}]'
 
 expected_region_highlight=(
-  "5  5  $ZSH_HIGHLIGHT_STYLES[bracket-error]" # (
-  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
-  "8  8  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
-  "9  9 $ZSH_HIGHLIGHT_STYLES[bracket-error]" # )
+  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-error]" # (
+  "7  7  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
+  "9  9  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
+  "10 10 $ZSH_HIGHLIGHT_STYLES[bracket-error]" # )
 )
diff --git a/highlighters/brackets/test-data/nested-parentheses.zsh b/highlighters/brackets/test-data/nested-parentheses.zsh
index 68683e5..1de6b3f 100644
--- a/highlighters/brackets/test-data/nested-parentheses.zsh
+++ b/highlighters/brackets/test-data/nested-parentheses.zsh
@@ -31,10 +31,10 @@
 BUFFER='echo $(echo ${(z)array})'
 
 expected_region_highlight=(
-  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # (
-  "13 13 $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
-  "14 14 $ZSH_HIGHLIGHT_STYLES[bracket-level-3]" # (
-  "16 16 $ZSH_HIGHLIGHT_STYLES[bracket-level-3]" # )
-  "22 22 $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
-  "23 23 $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # )
+  "7  7  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # (
+  "14 14 $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
+  "15 15 $ZSH_HIGHLIGHT_STYLES[bracket-level-3]" # (
+  "17 17 $ZSH_HIGHLIGHT_STYLES[bracket-level-3]" # )
+  "23 23 $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
+  "24 24 $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # )
 )
diff --git a/highlighters/brackets/test-data/quoted-patentheses.zsh b/highlighters/brackets/test-data/quoted-patentheses.zsh
index 2589010..60010b4 100644
--- a/highlighters/brackets/test-data/quoted-patentheses.zsh
+++ b/highlighters/brackets/test-data/quoted-patentheses.zsh
@@ -31,5 +31,5 @@
 BUFFER='echo "foo ( bar"'
 
 expected_region_highlight=(
-"1  15 $ZSH_HIGHLIGHT_STYLES[none]" # We expect the brackets highlighter to do nothing 
+"1  16 $ZSH_HIGHLIGHT_STYLES[none]" # We expect the brackets highlighter to do nothing 
 )
diff --git a/highlighters/brackets/test-data/simple-parentheses.zsh b/highlighters/brackets/test-data/simple-parentheses.zsh
index cd9a759..9ee1737 100644
--- a/highlighters/brackets/test-data/simple-parentheses.zsh
+++ b/highlighters/brackets/test-data/simple-parentheses.zsh
@@ -31,8 +31,8 @@
 BUFFER='echo ({x})'
 
 expected_region_highlight=(
-  "5  5  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # (
-  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
-  "8  8  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
-  "9  9 $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # )
+  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # (
+  "7  7  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
+  "9  9  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
+  "10 10 $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # )
 )
diff --git a/highlighters/brackets/test-data/unclosed-patentheses.zsh b/highlighters/brackets/test-data/unclosed-patentheses.zsh
index 879c618..b815541 100644
--- a/highlighters/brackets/test-data/unclosed-patentheses.zsh
+++ b/highlighters/brackets/test-data/unclosed-patentheses.zsh
@@ -31,7 +31,7 @@
 BUFFER='echo ({x}'
 
 expected_region_highlight=(
-  "5  5  $ZSH_HIGHLIGHT_STYLES[bracket-error]" # (
-  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
-  "8  8  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
+  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-error]" # (
+  "7  7  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # {
+  "9  9  $ZSH_HIGHLIGHT_STYLES[bracket-level-2]" # }
 )
diff --git a/highlighters/brackets/test-data/unclosed-patentheses2.zsh b/highlighters/brackets/test-data/unclosed-patentheses2.zsh
index c6534ef..7f2f324 100644
--- a/highlighters/brackets/test-data/unclosed-patentheses2.zsh
+++ b/highlighters/brackets/test-data/unclosed-patentheses2.zsh
@@ -31,7 +31,7 @@
 BUFFER='echo {x})'
 
 expected_region_highlight=(
-  "5  5  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # {
-  "7  7  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # }
-  "8  8 $ZSH_HIGHLIGHT_STYLES[bracket-error]" # )
+  "6  6  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # {
+  "8  8  $ZSH_HIGHLIGHT_STYLES[bracket-level-1]" # }
+  "9  9 $ZSH_HIGHLIGHT_STYLES[bracket-error]" # )
 )
diff --git a/highlighters/main/test-data/backslash-continuation.zsh b/highlighters/main/test-data/backslash-continuation.zsh
index f0b22f7..e9d6d20 100644
--- a/highlighters/main/test-data/backslash-continuation.zsh
+++ b/highlighters/main/test-data/backslash-continuation.zsh
@@ -32,5 +32,5 @@ PREBUFFER=$'echo \\\n'
 BUFFER='noglob'
 
 expected_region_highlight=(
-  "0 6 none" # 'noglob' highlighted as a string, not as a precomand
+  "1 6 none" # 'noglob' highlighted as a string, not as a precomand
 )
diff --git a/highlighters/main/test-data/multiline-string.zsh b/highlighters/main/test-data/multiline-string.zsh
index f2eb13e..450458c 100644
--- a/highlighters/main/test-data/multiline-string.zsh
+++ b/highlighters/main/test-data/multiline-string.zsh
@@ -32,6 +32,6 @@ PREBUFFER=$'echo "foo1\n'
 BUFFER='foo2" ./'
 
 expected_region_highlight=(
-  "0 5 $ZSH_HIGHLIGHT_STYLES[double-quoted-argument]" # 'foo2"'
+  "1 5 $ZSH_HIGHLIGHT_STYLES[double-quoted-argument]" # 'foo2"'
   "7 8 $ZSH_HIGHLIGHT_STYLES[path]" # './'
 )
diff --git a/highlighters/main/test-data/prefix-redirection.zsh b/highlighters/main/test-data/prefix-redirection.zsh
index c1152fb..29d91e2 100644
--- a/highlighters/main/test-data/prefix-redirection.zsh
+++ b/highlighters/main/test-data/prefix-redirection.zsh
@@ -32,7 +32,7 @@ BUFFER='>/tmp >/tmp sudo echo foo'
 
 expected_region_highlight=(
   "2  5  $ZSH_HIGHLIGHT_STYLES[path]"       # /tmp
-  "7  11 $ZSH_HIGHLIGHT_STYLES[path]"       # /tmp
+  "8  11 $ZSH_HIGHLIGHT_STYLES[path]"       # /tmp
   "13 16 $ZSH_HIGHLIGHT_STYLES[precommand]" # sudo
   "18 21 $ZSH_HIGHLIGHT_STYLES[builtin]"    # echo
   "23 25 $ZSH_HIGHLIGHT_STYLES[default]"    # foo
diff --git a/highlighters/main/test-data/simple-redirection.zsh b/highlighters/main/test-data/simple-redirection.zsh
index 055b1cb..b569c27 100644
--- a/highlighters/main/test-data/simple-redirection.zsh
+++ b/highlighters/main/test-data/simple-redirection.zsh
@@ -34,6 +34,6 @@ expected_region_highlight=(
   "1  2  $ZSH_HIGHLIGHT_STYLES[command]" # ps
   "4  6  $ZSH_HIGHLIGHT_STYLES[default]" # aux
   "8  8  $ZSH_HIGHLIGHT_STYLES[default]" # |
-  "9  12 $ZSH_HIGHLIGHT_STYLES[command]" # grep
-  "14 17 $ZSH_HIGHLIGHT_STYLES[default]" # java
+  "10 13 $ZSH_HIGHLIGHT_STYLES[command]" # grep
+  "15 18 $ZSH_HIGHLIGHT_STYLES[default]" # java
 )
diff --git a/highlighters/main/test-data/vanilla-newline.zsh b/highlighters/main/test-data/vanilla-newline.zsh
index f0c8eac..1aa3cc4 100644
--- a/highlighters/main/test-data/vanilla-newline.zsh
+++ b/highlighters/main/test-data/vanilla-newline.zsh
@@ -32,9 +32,9 @@ PREBUFFER=$'echo foo; echo bar\n\n\n'
 BUFFER=' echo baz; echo qux'
 
 expected_region_highlight=(
-  "1 5 $ZSH_HIGHLIGHT_STYLES[builtin]" # echo
-  "6 8 $ZSH_HIGHLIGHT_STYLES[default]" # baz
-  "9 10 $ZSH_HIGHLIGHT_STYLES[default]" # semicolon
+  "2 5 $ZSH_HIGHLIGHT_STYLES[builtin]" # echo
+  "7 9 $ZSH_HIGHLIGHT_STYLES[default]" # baz
+  "10 10 $ZSH_HIGHLIGHT_STYLES[default]" # semicolon
   "12 15 $ZSH_HIGHLIGHT_STYLES[builtin]" # echo
   "17 19 $ZSH_HIGHLIGHT_STYLES[default]" # qux
 )
diff --git a/tests/README.md b/tests/README.md
index f8cac48..676dd64 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -5,6 +5,13 @@ Utility scripts for testing zsh-syntax-highlighting highlighters.
 
 The tests expect the highlighter directory to contain a `test-data` directory with test data files. See the [main highlighter](../highlighters/main/test-data) for examples.
 
+Each test should define the array parameter `$expected_region_highlight`.
+The value of that parameter is a list of `"$i $j $style"` strings.
+Each string specifies the highlighting that `$BUFFER[$i,$j]` should have;
+that is, `$i` and `$j` specify a range, 1-indexed, inclusive of both endpoints.
+
+_Note_: `$region_highlight` uses the same `"$i $j $style"` syntax but interprets the indexes differently.
+
 
 highlighting test
 -----------------
diff --git a/tests/test-highlighting.zsh b/tests/test-highlighting.zsh
index 64655ee..83ce6a0 100755
--- a/tests/test-highlighting.zsh
+++ b/tests/test-highlighting.zsh
@@ -84,7 +84,10 @@ for data_file in ${0:h:h}/highlighters/$1/test-data/*; do
       observed_result=()
       for i in {1..${#region_highlight}}; do
         highlight_zone=${(z)region_highlight[$i]}
-        for j in {$highlight_zone[1]..$highlight_zone[2]}; do
+        integer start=$highlight_zone[1] end=$highlight_zone[2]
+        (( --end )) # region_highlight ranges are half-open
+        (( ++start, ++end )) # region_highlight is 0-indexed; expected_region_highlight is 1-indexed
+        for j in {$start..$end}; do
           observed_result[$j]=$highlight_zone[3]
         done
       done

From 80587e5419c1c0c80f58723989245bac734c98ab Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@daniel.shahaf.name>
Date: Sat, 12 Sep 2015 20:31:33 +0000
Subject: [PATCH 2/2] New test for dollar-double-quoted-argument.

This exercises the previous patch.
---
 highlighters/main/test-data/double-quoted.zsh | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 highlighters/main/test-data/double-quoted.zsh

diff --git a/highlighters/main/test-data/double-quoted.zsh b/highlighters/main/test-data/double-quoted.zsh
new file mode 100644
index 0000000..b200af0
--- /dev/null
+++ b/highlighters/main/test-data/double-quoted.zsh
@@ -0,0 +1,37 @@
+#!/usr/bin/env zsh
+# -------------------------------------------------------------------------------------------------
+# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, are permitted
+# provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice, this list of conditions
+#    and the following disclaimer.
+#  * Redistributions in binary form must reproduce the above copyright notice, this list of
+#    conditions and the following disclaimer in the documentation and/or other materials provided
+#    with the distribution.
+#  * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors
+#    may be used to endorse or promote products derived from this software without specific prior
+#    written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# -------------------------------------------------------------------------------------------------
+# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*-
+# vim: ft=zsh sw=2 ts=2 et
+# -------------------------------------------------------------------------------------------------
+
+BUFFER=': "foo$bar"'
+
+expected_region_highlight=(
+  "3 6 $ZSH_HIGHLIGHT_STYLES[double-quoted-argument]" # "foo
+  "7 10 $ZSH_HIGHLIGHT_STYLES[dollar-double-quoted-argument]" # $bar
+  "11 11 $ZSH_HIGHLIGHT_STYLES[double-quoted-argument]" # "
+)