From 07588d2165e6fb334e190a4c54628c3983e0b3f8 Mon Sep 17 00:00:00 2001 From: Takeshi Banse Date: Sun, 16 Jan 2011 13:58:31 +0900 Subject: [PATCH 1/4] Make core syntax highlighting a function. Make `_zsh_highlight-zle-buffer` just a hands-off. Now, `_zsh_highlight-zle-buffer` calls each ZSH_HIGHLIGHT_FUNCTIONS in turn. The former `_zsh_highlight-zle-buffer` is renamed to `_zsh_main-highlight.` Signed-off-by: Takeshi Banse --- zsh-syntax-highlighting.zsh | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/zsh-syntax-highlighting.zsh b/zsh-syntax-highlighting.zsh index 4f8d144..1ebaf13 100644 --- a/zsh-syntax-highlighting.zsh +++ b/zsh-syntax-highlighting.zsh @@ -106,8 +106,22 @@ _zsh_highlight-string() { done } +# Functions to be called in _zsh_highlight-zle-buffer. +ZSH_HIGHLIGHT_FUNCTIONS=( + _zsh_main-highlight +) + # Recolorize the current ZLE buffer. _zsh_highlight-zle-buffer() { + local ret=$? + { + for func in ${ZSH_HIGHLIGHT_FUNCTIONS}; do "$func"; done + } always { + return $ret + } +} + +_zsh_main-highlight() { # Avoid doing the same work over and over [[ ${ZSH_PRIOR_HIGHLIGHTED_BUFFER:-} == $BUFFER ]] && [[ ${#region_highlight} -gt 0 ]] && (( ZSH_PRIOR_CURSOR == CURSOR )) && return ZSH_PRIOR_HIGHLIGHTED_BUFFER=$BUFFER From 6663c5647dd05e9edd7647bf4f6deab4918b26a8 Mon Sep 17 00:00:00 2001 From: Takeshi Banse Date: Sun, 16 Jan 2011 14:12:33 +0900 Subject: [PATCH 2/4] Make bracket match a function. Append it to ZSH_HIGHLIGHT_FUNCTIONS. Signed-off-by: Takeshi Banse --- zsh-syntax-highlighting.zsh | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/zsh-syntax-highlighting.zsh b/zsh-syntax-highlighting.zsh index 1ebaf13..95b8ca5 100644 --- a/zsh-syntax-highlighting.zsh +++ b/zsh-syntax-highlighting.zsh @@ -109,6 +109,7 @@ _zsh_highlight-string() { # Functions to be called in _zsh_highlight-zle-buffer. ZSH_HIGHLIGHT_FUNCTIONS=( _zsh_main-highlight + _zsh_highlight-bracket-match ) # Recolorize the current ZLE buffer. @@ -123,9 +124,8 @@ _zsh_highlight-zle-buffer() { _zsh_main-highlight() { # Avoid doing the same work over and over - [[ ${ZSH_PRIOR_HIGHLIGHTED_BUFFER:-} == $BUFFER ]] && [[ ${#region_highlight} -gt 0 ]] && (( ZSH_PRIOR_CURSOR == CURSOR )) && return + [[ ${ZSH_PRIOR_HIGHLIGHTED_BUFFER:-} == $BUFFER ]] && [[ ${#region_highlight} -gt 0 ]] && return ZSH_PRIOR_HIGHLIGHTED_BUFFER=$BUFFER - ZSH_PRIOR_CURSOR=$CURSOR setopt localoptions extendedglob bareglobqual local new_expression=true @@ -189,6 +189,11 @@ _zsh_main-highlight() { start_pos=$end_pos done +} + +_zsh_highlight-bracket-match() { + (( ZSH_PRIOR_CURSOR == CURSOR )) && return + ZSH_PRIOR_CURSOR=$CURSOR # Bracket matching bracket_color_size=${#ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES} if ((bracket_color_size > 0)); then From 0948c3d676a57ebb4102455c6c8f0087053ba25a Mon Sep 17 00:00:00 2001 From: Takeshi Banse Date: Sun, 16 Jan 2011 13:54:59 +0900 Subject: [PATCH 3/4] Introduce _zsh_add-highlighter. For easily extending the highlighting behavior, split the actual highlighting function into some pieces. For example "_zsh_main-highlight" transformed into, 1) An actual highlighting function which updates the `region_highlight` on its own. (_zsh_main-highlight) 2) A predicate which determines whether its highlighting function (in this case `_zsh_main-highlight`) should be called or not. (_zsh_buffer-modified-p) Likewise, `_zsh_highlight-bracket-match` and `_zsh_highlight-bracket-match-p` are born. Eventually, `_zsh_highlight-zle-buffer` coordinates above these functions and maintain some internal state variables. Finally, added `_zsh_add-highlighter` a little syntactic-sugar-ish function to register the highlighting functions in an appropriate manner. Signed-off-by: Takeshi Banse --- zsh-syntax-highlighting.zsh | 95 +++++++++++++++++++++++++++++++------ 1 file changed, 81 insertions(+), 14 deletions(-) diff --git a/zsh-syntax-highlighting.zsh b/zsh-syntax-highlighting.zsh index 95b8ca5..be9d542 100644 --- a/zsh-syntax-highlighting.zsh +++ b/zsh-syntax-highlighting.zsh @@ -106,27 +106,91 @@ _zsh_highlight-string() { done } -# Functions to be called in _zsh_highlight-zle-buffer. -ZSH_HIGHLIGHT_FUNCTIONS=( - _zsh_main-highlight - _zsh_highlight-bracket-match -) - # Recolorize the current ZLE buffer. + +# An `object' implemented by below 3 arrays' elements could be called a +# `highlighter', registered by `_zsh_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_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() { local ret=$? { - for func in ${ZSH_HIGHLIGHT_FUNCTIONS}; do "$func"; done + local -a funinds + local -i rh_size=$#region_highlight + for i in {1..${#zsh_highlight_functions}}; do + local pred=${zsh_highlight_predicates[i]} + local 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]} + local 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 } } -_zsh_main-highlight() { - # Avoid doing the same work over and over - [[ ${ZSH_PRIOR_HIGHLIGHTED_BUFFER:-} == $BUFFER ]] && [[ ${#region_highlight} -gt 0 ]] && return - ZSH_PRIOR_HIGHLIGHTED_BUFFER=$BUFFER +# Whether supplied highlight_predicate satisfies or not. +_zsh_highlight-zle-buffer-p() { + local region_highlight_size="$1" + local 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_buffer-modified-p() { + [[ ${ZSH_PRIOR_HIGHLIGHTED_BUFFER:-} != $BUFFER ]] +} + +# Whether the cursor is moved or not. +_zsh_cursor-moved-p() { + ((ZSH_PRIOR_CURSOR != $CURSOR)) +} + +# Register a highlighting function. +_zsh_add-highlighter() { + local func="$1" + local pred="${2-${1}-p}" + local cache_place="${3-${1//-/_}}" + zsh_highlight_functions+=$func + zsh_highlight_predicates+=$pred + zsh_highlight_caches+=$cache_place +} + +# Register the builtin highlighters. +_zsh_add-highlighter _zsh_main-highlight _zsh_buffer-modified-p +_zsh_add-highlighter _zsh_highlight-bracket-match + +# Core syntax highlighting. +_zsh_main-highlight() { setopt localoptions extendedglob bareglobqual local new_expression=true local start_pos=0 @@ -188,12 +252,15 @@ _zsh_main-highlight() { [[ ${${ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS[(r)${arg//|/\|}]:-}:+yes} = 'yes' ]] && new_expression=true start_pos=$end_pos done - } +# Whether the bracket match highlighting shound be called or not. +_zsh_highlight-bracket-match-p() { + _zsh_cursor-moved-p || _zsh_buffer-modified-p +} + +# Bracket match highlighting. _zsh_highlight-bracket-match() { - (( ZSH_PRIOR_CURSOR == CURSOR )) && return - ZSH_PRIOR_CURSOR=$CURSOR # Bracket matching bracket_color_size=${#ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES} if ((bracket_color_size > 0)); then From bb5f41ef6d1cfb6588db4fce5b580267a796697f Mon Sep 17 00:00:00 2001 From: Takeshi Banse Date: Sun, 16 Jan 2011 20:33:24 +0900 Subject: [PATCH 4/4] Add contrib/keyword.zsh Signed-off-by: Takeshi Banse --- contrib/keyword.zsh | 63 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 contrib/keyword.zsh diff --git a/contrib/keyword.zsh b/contrib/keyword.zsh new file mode 100644 index 0000000..ee0620c --- /dev/null +++ b/contrib/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" + local 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_add-highlighter _zsh_highlight-keyword _zsh_buffer-modified-p