From f12e1620aa8e6b4ac39fa50461ed6b2542daaa9a Mon Sep 17 00:00:00 2001 From: disarmer mk Date: Mon, 17 Oct 2016 09:35:14 +0300 Subject: [PATCH] fixes after review --- docs/highlighters/regexp.md | 13 ++++--- highlighters/regexp/regexp-highlighter.zsh | 7 ++-- highlighters/regexp/test-data/complex.zsh | 37 +++++++++++++++++++ .../regexp/test-data/word-boundary.zsh | 36 ++++++++++++++++++ 4 files changed, 85 insertions(+), 8 deletions(-) create mode 100644 highlighters/regexp/test-data/complex.zsh create mode 100644 highlighters/regexp/test-data/word-boundary.zsh diff --git a/docs/highlighters/regexp.md b/docs/highlighters/regexp.md index 83a4b1d..3e7f968 100644 --- a/docs/highlighters/regexp.md +++ b/docs/highlighters/regexp.md @@ -1,8 +1,9 @@ zsh-syntax-highlighting / highlighters / regexp ------------------------------------------------ -This is the `regexp` highlighter, that highlights user-defined regular expressions. It's similar to pattern highlighter, but allows more complex patterns. - +This is the `regexp` highlighter, that highlights user-defined regular +expressions. It's similar to the [`pattern`](pattern.md) highlighter, but +allows more complex patterns. ### How to tweak it @@ -11,14 +12,16 @@ To use this highlighter, associate regular expressions with styles in the ZSH_HIGHLIGHT_REGEXP+=('\bsudo\b' fg=123,bold) -This will highlight "sudo" only if it's surrounded by word boundary, i.e. "sudo cmd", but not "sudoedit" +This will highlight "sudo" only as a complete word, i.e., "sudo cmd", but not +"sudoedit" The syntax for values is the same as the syntax of "types of highlighting" of the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)` manual page][zshzle-Character-Highlighting]. -See also: [regular expressions on wikipedia][regexp-wiki], zsh regexp operator `=~` in [zsh manual page][zsh-man-regexp] +See also: [regular expressions tutorial][perlretut], zsh regexp operator `=~` +in [the `zshmisc(1)` manual page][zsh-man-regexp] [zshzle-Character-Highlighting]: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting -[regexp-wiki]: https://en.wikipedia.org/wiki/Regular_expression +[perlretut]: http://perldoc.perl.org/perlretut.html [zsh-man-regexp]: http://zsh.sourceforge.net/Doc/Release/Conditional-Expressions.html#Conditional-Expressions diff --git a/highlighters/regexp/regexp-highlighter.zsh b/highlighters/regexp/regexp-highlighter.zsh index 52e0cbf..7c56bef 100644 --- a/highlighters/regexp/regexp-highlighter.zsh +++ b/highlighters/regexp/regexp-highlighter.zsh @@ -1,5 +1,5 @@ # ------------------------------------------------------------------------------------------------- -# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# Copyright (c) 2010-2016 zsh-syntax-highlighting contributors # All rights reserved. # # Redistribution and use in source and binary forms, with or without modification, are permitted @@ -45,9 +45,10 @@ _zsh_highlight_highlighter_regexp_paint(){ done } _zsh_highlight_regexp_highlighter_loop(){ - local buf="$1" pat="$2" OFFSET="$3" + local buf="$1" pat="$2" + integer OFFSET=0 local MATCH; integer MBEGIN MEND - while true;do + while true; do [[ "$buf" =~ "$pat" ]] || return; region_highlight+=("$((MBEGIN - 1 + OFFSET)) $((MEND + OFFSET)) $ZSH_HIGHLIGHT_REGEXP[$pat]") buf="$buf[$(($MEND+1)),-1]" diff --git a/highlighters/regexp/test-data/complex.zsh b/highlighters/regexp/test-data/complex.zsh new file mode 100644 index 0000000..4e0089b --- /dev/null +++ b/highlighters/regexp/test-data/complex.zsh @@ -0,0 +1,37 @@ +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2016 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_REGEXP+=('[0-9\+\-]+' 'fg=white,bold,bg=red') + +BUFFER='echo 1+9-3 7+2' + +expected_region_highlight=( + "6 10 fg=white,bold,bg=red" + "12 14 fg=white,bold,bg=red" +) diff --git a/highlighters/regexp/test-data/word-boundary.zsh b/highlighters/regexp/test-data/word-boundary.zsh new file mode 100644 index 0000000..f9fdc9d --- /dev/null +++ b/highlighters/regexp/test-data/word-boundary.zsh @@ -0,0 +1,36 @@ +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2016 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_REGEXP+=('\bsudo\b' 'fg=white,bold,bg=red') + +BUFFER='sudo ls' + +expected_region_highlight=( + "1 4 fg=white,bold,bg=red" +)