From 074c0dbd09c7349ef41589e1b503247da1d716fc Mon Sep 17 00:00:00 2001 From: Justin Zhu Date: Tue, 19 Apr 2011 15:26:20 -0700 Subject: [PATCH] zsh highlight --- plugins/zsh-syntax-highlighting/COPYING.md | 23 ++ plugins/zsh-syntax-highlighting/GREETINGS.md | 17 + plugins/zsh-syntax-highlighting/README.md | 73 +++++ .../highlighters/brackets.zsh | 89 +++++ .../highlighters/keyword.zsh | 63 ++++ .../tests/data/multiple-redirections.zsh | 47 +++ .../tests/data/nested-parentheses.zsh | 35 ++ .../tests/data/simple-command.zsh | 35 ++ .../tests/data/simple-redirection.zsh | 39 +++ .../tests/data/unknown-command.zsh | 35 ++ .../tests/test-highlighting.zsh | 94 ++++++ .../tests/test-perfs.zsh | 54 ++++ .../zsh-syntax-highlighting.plugin.zsh | 1 + .../zsh-syntax-highlighting.zsh | 303 ++++++++++++++++++ 14 files changed, 908 insertions(+) create mode 100644 plugins/zsh-syntax-highlighting/COPYING.md create mode 100644 plugins/zsh-syntax-highlighting/GREETINGS.md create mode 100644 plugins/zsh-syntax-highlighting/README.md create mode 100644 plugins/zsh-syntax-highlighting/highlighters/brackets.zsh create mode 100644 plugins/zsh-syntax-highlighting/highlighters/keyword.zsh create mode 100644 plugins/zsh-syntax-highlighting/tests/data/multiple-redirections.zsh create mode 100644 plugins/zsh-syntax-highlighting/tests/data/nested-parentheses.zsh create mode 100644 plugins/zsh-syntax-highlighting/tests/data/simple-command.zsh create mode 100644 plugins/zsh-syntax-highlighting/tests/data/simple-redirection.zsh create mode 100644 plugins/zsh-syntax-highlighting/tests/data/unknown-command.zsh create mode 100755 plugins/zsh-syntax-highlighting/tests/test-highlighting.zsh create mode 100755 plugins/zsh-syntax-highlighting/tests/test-perfs.zsh create mode 120000 plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.plugin.zsh create mode 100644 plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh diff --git a/plugins/zsh-syntax-highlighting/COPYING.md b/plugins/zsh-syntax-highlighting/COPYING.md new file mode 100644 index 000000000..2aa64389e --- /dev/null +++ b/plugins/zsh-syntax-highlighting/COPYING.md @@ -0,0 +1,23 @@ +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. diff --git a/plugins/zsh-syntax-highlighting/GREETINGS.md b/plugins/zsh-syntax-highlighting/GREETINGS.md new file mode 100644 index 000000000..f75d4c113 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/GREETINGS.md @@ -0,0 +1,17 @@ +Authors / Greetings +=================== + + * [Roy Zuo](https://github.com/roylez) + * [Julien Nicoulaud](https://github.com/nicoulaj) + * [Dave Ingram](https://github.com/dingram) + * [Mounier Florian](https://github.com/paradoxxxzero) + * [Jonathan Dahan](https://github.com/jedahan) + * James Ahlborn + * [Andreas Jaggi](https://github.com/x-way) + * [Wayne Davison](https://github.com/WayneD) + * [Suraj N. Kurapati](https://github.com/sunaku) + * [Takeshi Banse](https://github.com/hchbaw) + * [Sorin Ionescu](https://github.com/sorin-ionescu) + * [Clayton Parker](https://github.com/claytron) + * [Arlen Cuss](https://github.com/celtic) + * [Nakamura Yoshitaka](https://github.com/nakamuray) diff --git a/plugins/zsh-syntax-highlighting/README.md b/plugins/zsh-syntax-highlighting/README.md new file mode 100644 index 000000000..d57441858 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/README.md @@ -0,0 +1,73 @@ +zsh-syntax-highlighting ![Project status](http://stillmaintained.com/nicoulaj/zsh-syntax-highlighting.png) +========================================================================================================== + +**[Fish shell](http://www.fishshell.com) like syntax highlighting for [Zsh](http://www.zsh.org).** + +*Requirements: zsh 4.3.9 or superior.* + + +## Try it + +Here is a one-liner to try it without installing or modifying anything: + + wget --no-check-certificate --output-document=/tmp/zsh-syntax-highlighting.zsh https://github.com/nicoulaj/zsh-syntax-highlighting/raw/master/zsh-syntax-highlighting.zsh && . /tmp/zsh-syntax-highlighting.zsh + + +## Install it + + +### In your ~/.zshrc + +* Download the script or clone this repository: + + git clone git://github.com/nicoulaj/zsh-syntax-highlighting.git + +* Source the script **at the end** of `~/.zshrc`: + + source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh + +* Source `~/.zshrc` to take changes into account: + + source ~/.zshrc + + +### With oh-my-zsh + +* Download the script or clone this repository in [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh) plugins directory: + + cd ~/.oh-my-zsh/plugins/ + git clone git://github.com/nicoulaj/zsh-syntax-highlighting.git + +* Activate the plugin in `~/.zshrc` (in **last** position): + + plugins=( [plugins...] zsh-syntax-highlighting) + +* Source `~/.zshrc` to take changes into account: + + source ~/.zshrc + + +## Tweak it + +Optionally, you can override the default styles used for highlighting. The styles are declared in the `ZSH_HIGHLIGHT_STYLES` array. You can override styles this way: + + # To differentiate aliases from other command types + ZSH_HIGHLIGHT_STYLES[alias]='fg=magenta,bold' + + # To have paths colored instead of underlined + ZSH_HIGHLIGHT_STYLES[path]='fg=cyan' + + # To disable highlighting of globbing expressions + ZSH_HIGHLIGHT_STYLES[globbing]='none' + +You can tweak the styles used to colorize matching brackets by overriding the `ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES`. + + ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES=( + 'fg=blue,bold' # Style for first level of imbrication + 'fg=green,bold' # Style for second level of imbrication + 'fg=magenta,bold' # etc... Put as many styles as you wish, or leave + 'fg=yellow,bold' # empty to disable brackets matching. + 'fg=cyan,bold' + ) + +This must be done **after** the script is sourced, otherwise your styles will be overwritten. The syntax for declaring styles is [documented here](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#SEC135). diff --git a/plugins/zsh-syntax-highlighting/highlighters/brackets.zsh b/plugins/zsh-syntax-highlighting/highlighters/brackets.zsh new file mode 100644 index 000000000..6af9ba281 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/highlighters/brackets.zsh @@ -0,0 +1,89 @@ +#!/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 +# ------------------------------------------------------------------------------------------------- + + +ZSH_HIGHLIGHT_STYLES+=( + bracket-error 'fg=red,bold' +) + +# Colors for bracket levels. +# Put as many color as you wish. +# Leave it as an empty array to disable. +ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES=( + 'fg=blue,bold' + 'fg=green,bold' + 'fg=magenta,bold' + 'fg=yellow,bold' + 'fg=cyan,bold' +) + +# Whether the bracket match highlighting shound be called or not. +_zsh_highlight_bracket-match-p() { + _zsh_highlight_cursor-moved-p || _zsh_highlight_buffer-modified-p +} + +# Bracket match highlighting. +_zsh_highlight_bracket-match() { + bracket_color_size=${#ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES} + if ((bracket_color_size > 0)); then + typeset -A levelpos lastoflevel matching revmatching + ((level = 0)) + for pos in {1..${#BUFFER}}; do + case $BUFFER[pos] in + "("|"["|"{") + levelpos[$pos]=$((++level)) + lastoflevel[$level]=$pos + ;; + ")"|"]"|"}") + matching[$lastoflevel[$level]]=$pos + revmatching[$pos]=$lastoflevel[$level] + levelpos[$pos]=$((level--)) + ;; + esac + done + for pos in ${(k)levelpos}; do + level=$levelpos[$pos] + if ((level < 1)); then + region_highlight+=("$((pos - 1)) $pos "$ZSH_HIGHLIGHT_STYLES[bracket-error]) + else + region_highlight+=("$((pos - 1)) $pos "$ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES[(( (level - 1) % bracket_color_size + 1 ))]) + fi + done + ((c = CURSOR + 1)) + if [[ -n $levelpos[$c] ]]; then + ((otherpos = -1)) + [[ -n $matching[$c] ]] && otherpos=$matching[$c] + [[ -n $revmatching[$c] ]] && otherpos=$revmatching[$c] + region_highlight+=("$((otherpos - 1)) $otherpos standout") + fi + fi +} + +_zsh_highlight_add-highlighter _zsh_highlight_bracket-match diff --git a/plugins/zsh-syntax-highlighting/highlighters/keyword.zsh b/plugins/zsh-syntax-highlighting/highlighters/keyword.zsh new file mode 100644 index 000000000..7302d158f --- /dev/null +++ b/plugins/zsh-syntax-highlighting/highlighters/keyword.zsh @@ -0,0 +1,63 @@ +#!/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 +# ------------------------------------------------------------------------------------------------- + + +# A simple keyword highlighting extension for zsh-syntax-highlighting. + +# To use this, please do the following steps. +# 1) Source this file after zsh-syntax-highlighting.zsh +# % source zsh-syntax-highlighting.zsh +# % source contrib/keyword.zsh +# 2) Add keyword and color pairs to `ZSH_HIGHLIGHT_KEYWORD_KEYWORDS`. +# % ZSH_HIGHLIGHT_KEYWORD_KEYWORDS+=('rm -rf *' 'fg=white,bold,bg=red') +# 3) Please see the effect. +# % ;# rm -rf /tmp/doesnotexist + +# List of keyword and color pairs. +typeset -gA ZSH_HIGHLIGHT_KEYWORD_KEYWORDS + +_zsh_highlight-keyword() { + setopt localoptions extendedglob + for pattern in ${(k)ZSH_HIGHLIGHT_KEYWORD_KEYWORDS}; do + _zsh_highlight-keyword-loop "$BUFFER" "$pattern" + done +} + +_zsh_highlight-keyword-loop() { + # This does *not* do its job syntactically, sorry. + local buf="$1" pat="$2" + local -a match mbegin mend + if [[ "$buf" == (#b)(*)(${~pat})* ]]; then + region_highlight+=("$((mbegin[2] - 1)) $mend[2] $ZSH_HIGHLIGHT_KEYWORD_KEYWORDS[$pat]") + "$0" "$match[1]" "$pat"; return $? + fi +} + +_zsh_highlight_add-highlighter _zsh_highlight-keyword _zsh_highlight_buffer-modified-p diff --git a/plugins/zsh-syntax-highlighting/tests/data/multiple-redirections.zsh b/plugins/zsh-syntax-highlighting/tests/data/multiple-redirections.zsh new file mode 100644 index 000000000..ac0606c9c --- /dev/null +++ b/plugins/zsh-syntax-highlighting/tests/data/multiple-redirections.zsh @@ -0,0 +1,47 @@ +#!/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='ps aux | grep java | sort | uniq | tail | head' + +expected_region_highlight=( + "1 2 $ZSH_HIGHLIGHT_STYLES[command]" # ps + "4 6 $ZSH_HIGHLIGHT_STYLES[default]" # aux + "8 8 $ZSH_HIGHLIGHT_STYLES[default]" # | + "10 13 $ZSH_HIGHLIGHT_STYLES[command]" # grep + "15 18 $ZSH_HIGHLIGHT_STYLES[default]" # java + "20 20 $ZSH_HIGHLIGHT_STYLES[default]" # | + "22 25 $ZSH_HIGHLIGHT_STYLES[command]" # sort + "27 27 $ZSH_HIGHLIGHT_STYLES[default]" # | + "29 32 $ZSH_HIGHLIGHT_STYLES[command]" # uniq + "34 34 $ZSH_HIGHLIGHT_STYLES[default]" # | + "36 39 $ZSH_HIGHLIGHT_STYLES[command]" # tail + "41 41 $ZSH_HIGHLIGHT_STYLES[default]" # | + "43 46 $ZSH_HIGHLIGHT_STYLES[command]" # head +) diff --git a/plugins/zsh-syntax-highlighting/tests/data/nested-parentheses.zsh b/plugins/zsh-syntax-highlighting/tests/data/nested-parentheses.zsh new file mode 100644 index 000000000..840628218 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/tests/data/nested-parentheses.zsh @@ -0,0 +1,35 @@ +#!/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='echo $(echo ${(z)array})' + +expected_region_highlight=( + # TODO +) diff --git a/plugins/zsh-syntax-highlighting/tests/data/simple-command.zsh b/plugins/zsh-syntax-highlighting/tests/data/simple-command.zsh new file mode 100644 index 000000000..4227c80e8 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/tests/data/simple-command.zsh @@ -0,0 +1,35 @@ +#!/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='ls' + +expected_region_highlight=( + "1 2 $ZSH_HIGHLIGHT_STYLES[command]" # ls +) diff --git a/plugins/zsh-syntax-highlighting/tests/data/simple-redirection.zsh b/plugins/zsh-syntax-highlighting/tests/data/simple-redirection.zsh new file mode 100644 index 000000000..055b1cb8b --- /dev/null +++ b/plugins/zsh-syntax-highlighting/tests/data/simple-redirection.zsh @@ -0,0 +1,39 @@ +#!/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='ps aux | grep java' + +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 +) diff --git a/plugins/zsh-syntax-highlighting/tests/data/unknown-command.zsh b/plugins/zsh-syntax-highlighting/tests/data/unknown-command.zsh new file mode 100644 index 000000000..74854d422 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/tests/data/unknown-command.zsh @@ -0,0 +1,35 @@ +#!/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='azertyuiop' + +expected_region_highlight=( + "1 10 $ZSH_HIGHLIGHT_STYLES[unknown-token]" # azertyuiop +) diff --git a/plugins/zsh-syntax-highlighting/tests/test-highlighting.zsh b/plugins/zsh-syntax-highlighting/tests/test-highlighting.zsh new file mode 100755 index 000000000..7166eaeb6 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/tests/test-highlighting.zsh @@ -0,0 +1,94 @@ +#!/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 +# ------------------------------------------------------------------------------------------------- + + +local -a errors highlight_zone +local -A observed_result + +# Load the main script. +. $(dirname $0)/../zsh-syntax-highlighting.zsh + +# Process each test data file in data/. +for data_file in $(dirname $0)/data/*.zsh; do + + # Load the data and prepare checking it. + BUFFER= ; expected_region_highlight=(); errors=() + echo -n "* ${data_file:t:r}: " + . $data_file + + # Check the data declares $BUFFER. + if [[ ${#BUFFER} -eq 0 ]]; then + errors+=("'BUFFER' is not declared or blank.") + else + + # Check the data declares $expected_region_highlight. + if [[ ${#expected_region_highlight} -eq 0 ]]; then + errors+=("'expected_region_highlight' is not declared or empty.") + else + + # Process the data. + region_highlight=() + _zsh_highlight-zle-buffer + + # Overlapping regions can be declared in region_highlight, so we first build an array of the + # observed highlighting. + 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 + observed_result[$j]=$highlight_zone[3] + done + done + + # Then we compare the observed result with the expected one. + for i in {1..${#expected_region_highlight}}; do + highlight_zone=${(z)expected_region_highlight[$i]} + for j in {$highlight_zone[1]..$highlight_zone[2]}; do + if [[ "$observed_result[$j]" != "$highlight_zone[3]" ]]; then + errors+=("'$BUFFER[$highlight_zone[1],$highlight_zone[2]]' [$highlight_zone[1],$highlight_zone[2]]: expected '$highlight_zone[3]', observed '$observed_result[$j]'.") + break + fi + done + done + + fi + fi + + # Format result/errors. + if [[ ${#errors} -eq 0 ]]; then + echo "OK" + else + echo "KO" + for error in $errors; do + echo " - $error" + done + fi + +done diff --git a/plugins/zsh-syntax-highlighting/tests/test-perfs.zsh b/plugins/zsh-syntax-highlighting/tests/test-perfs.zsh new file mode 100755 index 000000000..570bce606 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/tests/test-perfs.zsh @@ -0,0 +1,54 @@ +#!/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 +# ------------------------------------------------------------------------------------------------- + + +# Load the main script. +. $(dirname $0)/../zsh-syntax-highlighting.zsh + +# Process each test data file in data/. +for data_file in $(dirname $0)/data/*.zsh; do + + # Load the data and prepare checking it. + BUFFER= + echo -n "* ${data_file:t:r}: " + . $data_file + + # Check the data declares $BUFFER. + if [[ ${#BUFFER} -eq 0 ]]; then + echo "KO\n - 'BUFFER' is not declared or blank." + else + + # Measure the time taken by _zsh_highlight-zle-buffer. + TIMEFMT="%*Es" + time ( BUFFER="$BUFFER" && _zsh_highlight-zle-buffer) + + fi + +done diff --git a/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.plugin.zsh b/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.plugin.zsh new file mode 120000 index 000000000..cc95cd491 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.plugin.zsh @@ -0,0 +1 @@ +zsh-syntax-highlighting.zsh \ No newline at end of file diff --git a/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh b/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh new file mode 100644 index 000000000..b6ff04394 --- /dev/null +++ b/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh @@ -0,0 +1,303 @@ +#!/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 +# ------------------------------------------------------------------------------------------------- + + +# ------------------------------------------------------------------------------------------------- +# Core highlighting update system +# ------------------------------------------------------------------------------------------------- + +# Array used by highlighters to declare overridable styles. +typeset -gA ZSH_HIGHLIGHT_STYLES + +# An `object' implemented by below 3 arrays' elements could be called a +# `highlighter', registered by `_zsh_highlight_add-highlighter`. In other words, these +# arrays are indexed and tied by their own functionality. If they have been +# arranged inconsistently, things goes wrong. +# Please see `_zsh_highlight-zle-buffer` and `_zsh_highlight_add-highlighter`. + +# Actual recolorize functions to be called. +typeset -a zsh_highlight_functions; zsh_highlight_functions=() + +# Predicate functions whether its recolorize function should be called or not. +typeset -a zsh_highlight_predicates; zsh_highlight_predicates=() + +# Highlight storages for each recolorize functions. +typeset -a zsh_highlight_caches; zsh_highlight_caches=() + +_zsh_highlight-zle-buffer() { + if (( PENDING )); then + return + fi + + local ret=$? + { + local -a funinds + local -i rh_size=$#region_highlight + for i in {1..${#zsh_highlight_functions}}; do + local pred=${zsh_highlight_predicates[i]} cache_place=${zsh_highlight_caches[i]} + if _zsh_highlight-zle-buffer-p "$rh_size" "$pred"; then + if ((${#${(P)cache_place}} > 0)); then + region_highlight=(${region_highlight:#(${(P~j.|.)cache_place})}) + local -a empty; empty=(); : ${(PA)cache_place::=$empty} + fi + funinds+=$i + fi + done + for i in $funinds; do + local func=${zsh_highlight_functions[i]} cache_place=${zsh_highlight_caches[i]} + local -a rh; rh=($region_highlight) + { + "$func" + } always { + : ${(PA)cache_place::=${region_highlight:#(${(~j.|.)rh})}} + } + done + } always { + ZSH_PRIOR_CURSOR=$CURSOR + ZSH_PRIOR_HIGHLIGHTED_BUFFER=$BUFFER + return $ret + } +} + +# Whether supplied highlight_predicate satisfies or not. +_zsh_highlight-zle-buffer-p() { + local region_highlight_size="$1" highlight_predicate="$2" + # If any highlightings are not taken into account, asume it is needed. + # This holds for some up/down-history commands, for example. + ((region_highlight_size == 0)) || "$highlight_predicate" +} + +# Whether the command line buffer is modified or not. +_zsh_highlight_buffer-modified-p() { + [[ ${ZSH_PRIOR_HIGHLIGHTED_BUFFER:-} != $BUFFER ]] +} + +# Whether the cursor is moved or not. +_zsh_highlight_cursor-moved-p() { + ((ZSH_PRIOR_CURSOR != $CURSOR)) +} + +# Register an highlighter. +_zsh_highlight_add-highlighter() { + zsh_highlight_functions+="$1" + zsh_highlight_predicates+="${2-${1}-p}" + zsh_highlight_caches+="${3-${1//-/_}}" +} + + +# ------------------------------------------------------------------------------------------------- +# Main highlighter +# ------------------------------------------------------------------------------------------------- + +ZSH_HIGHLIGHT_STYLES+=( + default 'none' + unknown-token 'fg=red,bold' + reserved-word 'fg=yellow' + alias 'fg=green' + builtin 'fg=green' + function 'fg=green' + command 'fg=green' + hashed-command 'fg=green' + path 'underline' + globbing 'fg=blue' + history-expansion 'fg=blue' + single-hyphen-option 'none' + double-hyphen-option 'none' + back-quoted-argument 'none' + single-quoted-argument 'fg=yellow' + double-quoted-argument 'fg=yellow' + dollar-double-quoted-argument 'fg=cyan' + back-double-quoted-argument 'fg=cyan' + assign 'none' +) + +# Tokens that are always immediately followed by a command. +ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS=( + '|' '||' ';' '&' '&&' 'noglob' 'nocorrect' 'builtin' +) + +# Check if the argument is variable assignment +_zsh_highlight_check-assign() { + setopt localoptions extended_glob + [[ ${(Q)arg} == [[:alpha:]_]([[:alnum:]_])#=* ]] +} + +# Check if the argument is a path. +_zsh_highlight_check-path() { + [[ -z ${(Q)arg} ]] && return 1 + [[ -e ${(Q)arg} ]] && return 0 + [[ ! -e ${(Q)arg:h} ]] && return 1 + [[ ${#BUFFER} == $end_pos && -n $(print ${(Q)arg}*(N)) ]] && return 0 + return 1 +} + +# Highlight special chars inside double-quoted strings +_zsh_highlight_highlight_string() { + setopt localoptions noksharrays + local i j k style + # Starting quote is at 1, so start parsing at offset 2 in the string. + for (( i = 2 ; i < end_pos - start_pos ; i += 1 )) ; do + (( j = i + start_pos - 1 )) + (( k = j + 1 )) + case "$arg[$i]" in + '$') style=$ZSH_HIGHLIGHT_STYLES[dollar-double-quoted-argument];; + "\\") style=$ZSH_HIGHLIGHT_STYLES[back-double-quoted-argument] + (( k += 1 )) # Color following char too. + (( i += 1 )) # Skip parsing the escaped char. + ;; + *) continue;; + esac + region_highlight+=("$j $k $style") + done +} + +# Core syntax highlighting. +_zsh_main-highlight() { + setopt localoptions extendedglob bareglobqual + local start_pos=0 end_pos highlight_glob=true new_expression=true arg style + region_highlight=() + for arg in ${(z)BUFFER}; do + local substr_color=0 + [[ $start_pos -eq 0 && $arg = 'noglob' ]] && highlight_glob=false + ((start_pos+=${#BUFFER[$start_pos+1,-1]}-${#${BUFFER[$start_pos+1,-1]##[[:space:]]#}})) + ((end_pos=$start_pos+${#arg})) + if $new_expression; then + new_expression=false + res=$(LC_ALL=C builtin type -w $arg 2>/dev/null) + case $res in + *': reserved') style=$ZSH_HIGHLIGHT_STYLES[reserved-word];; + *': alias') style=$ZSH_HIGHLIGHT_STYLES[alias] + local aliased_command="${"$(alias $arg)"#*=}" + [[ -n ${(M)ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS:#"$aliased_command"} && -z ${(M)ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS:#"$arg"} ]] && ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS+=($arg) + ;; + *': builtin') style=$ZSH_HIGHLIGHT_STYLES[builtin];; + *': function') style=$ZSH_HIGHLIGHT_STYLES[function];; + *': command') style=$ZSH_HIGHLIGHT_STYLES[command];; + *': hashed') style=$ZSH_HIGHLIGHT_STYLES[hashed-command];; + *) if _zsh_highlight_check-assign; then + style=$ZSH_HIGHLIGHT_STYLES[assign] + new_expression=true + elif _zsh_highlight_check-path; then + style=$ZSH_HIGHLIGHT_STYLES[path] + elif [[ $arg[0,1] = $histchars[0,1] ]]; then + style=$ZSH_HIGHLIGHT_STYLES[history-expansion] + else + style=$ZSH_HIGHLIGHT_STYLES[unknown-token] + fi + ;; + esac + else + case $arg in + '--'*) style=$ZSH_HIGHLIGHT_STYLES[double-hyphen-option];; + '-'*) style=$ZSH_HIGHLIGHT_STYLES[single-hyphen-option];; + "'"*"'") style=$ZSH_HIGHLIGHT_STYLES[single-quoted-argument];; + '"'*'"') style=$ZSH_HIGHLIGHT_STYLES[double-quoted-argument] + region_highlight+=("$start_pos $end_pos $style") + _zsh_highlight_highlight_string + substr_color=1 + ;; + '`'*'`') style=$ZSH_HIGHLIGHT_STYLES[back-quoted-argument];; + *"*"*) $highlight_glob && style=$ZSH_HIGHLIGHT_STYLES[globbing] || style=$ZSH_HIGHLIGHT_STYLES[default];; + *) if _zsh_highlight_check-path; then + style=$ZSH_HIGHLIGHT_STYLES[path] + elif [[ $arg[0,1] = $histchars[0,1] ]]; then + style=$ZSH_HIGHLIGHT_STYLES[history-expansion] + else + style=$ZSH_HIGHLIGHT_STYLES[default] + fi + ;; + esac + fi + [[ $substr_color = 0 ]] && region_highlight+=("$start_pos $end_pos $style") + [[ -n ${(M)ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS:#"$arg"} ]] && new_expression=true + start_pos=$end_pos + done +} + + +# ------------------------------------------------------------------------------------------------- +# Setup functions +# ------------------------------------------------------------------------------------------------- + +# Intercept specified ZLE events to have highlighting triggered. +_zsh_highlight_bind-events() { + + # Resolve event names what have to be bound to. + zmodload zsh/zleparameter 2>/dev/null || { + echo 'zsh-syntax-highlighting:zmodload error. exiting.' >&2 + return -1 + } + local -a events; : ${(A)events::=${@:#(_*|orig-*|.run-help|.which-command)}} + + # Bind the events to _zsh_highlight-zle-buffer. + local clean_event + for event in $events; do + if [[ "$widgets[$event]" == completion:* ]]; then + eval "zle -C orig-$event ${${${widgets[$event]}#*:}/:/ } ; $event() { builtin zle orig-$event && _zsh_highlight-zle-buffer } ; zle -N $event" + else + case $event in + accept-and-menu-complete) + eval "$event() { builtin zle .$event && _zsh_highlight-zle-buffer } ; zle -N $event" + ;; + .*) + clean_event=$event[2,${#event}] # Remove the leading dot in the event name + case ${widgets[$clean_event]-} in + (completion|user):*) + ;; + *) + eval "$clean_event() { builtin zle $event && _zsh_highlight-zle-buffer } ; zle -N $clean_event" + ;; + esac + ;; + *) + ;; + esac + fi + done +} + +# Load highlighters from specified directory if it exists. +_zsh_highlight_load-highlighters() { + [[ -d $1 ]] && for highlighter_def ($1/*.zsh) . $highlighter_def +} + + +# ------------------------------------------------------------------------------------------------- +# Setup +# ------------------------------------------------------------------------------------------------- + +# Bind highlighting to all known events. +_zsh_highlight_bind-events "${(@f)"$(zle -la)"}" + +# Register the main highlighter. +_zsh_highlight_add-highlighter _zsh_main-highlight _zsh_highlight_buffer-modified-p + +# Load additional highlighters if available. +_zsh_highlight_load-highlighters "${${(%):-%N}:h}/highlighters"