zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

339 lines
13 KiB
Bash
Raw Normal View History

2010-12-25 12:33:08 -05:00
#!/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.
# -------------------------------------------------------------------------------------------------
2011-01-05 04:54:25 -05:00
# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*-
# vim: ft=zsh sw=2 ts=2 et
# -------------------------------------------------------------------------------------------------
2011-01-05 04:54:25 -05:00
2010-12-25 12:33:08 -05:00
# Token types styles.
typeset -gA ZSH_HIGHLIGHT_STYLES
ZSH_HIGHLIGHT_STYLES=(
default 'none'
isearch 'fg=magenta,standout'
special 'fg=magenta,standout'
unknown-token 'fg=red,bold'
2010-12-31 08:45:03 -05:00
reserved-word 'fg=yellow'
alias 'fg=green'
builtin 'fg=green'
function 'fg=green'
command 'fg=green'
2011-01-05 16:51:00 -05:00
hashed-command 'fg=green'
path 'underline'
2010-12-31 08:45:03 -05:00
globbing 'fg=blue'
history-expansion 'fg=blue'
2010-12-31 08:45:03 -05:00
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'
2010-12-31 08:45:03 -05:00
back-double-quoted-argument 'fg=cyan'
2011-01-05 07:48:23 -05:00
bracket-error 'fg=red,bold'
)
2010-12-25 12:33:08 -05:00
2011-01-05 17:07:56 -05:00
# 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'
)
# Tokens that are always immediately followed by a command.
ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS=(
'|' '||' ';' '&' '&&' 'noglob' 'nocorrect' 'builtin'
)
# ZLE highlight types.
zle_highlight=(
special:$ZSH_HIGHLIGHT_STYLES[special]
isearch:$ZSH_HIGHLIGHT_STYLES[isearch]
)
2010-12-25 12:33:08 -05:00
# Check if the argument is a path.
_zsh_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
2010-12-30 11:05:00 -05:00
return 1
}
# Highlight special chars inside double-quoted strings
_zsh_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
2010-12-30 11:05:00 -05:00
(( 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")
2010-12-30 11:05:00 -05:00
done
}
2010-12-25 12:33:08 -05:00
# 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=$?
{
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
}
}
# 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() {
2010-12-30 10:13:48 -05:00
setopt localoptions extendedglob bareglobqual
local new_expression=true
local start_pos=0
local highlight_glob=true
local end_pos arg style
2010-12-25 12:33:08 -05:00
region_highlight=()
for arg in ${(z)BUFFER}; do
local substr_color=0
[[ $start_pos -eq 0 && $arg = 'noglob' ]] && highlight_glob=false
2010-12-26 02:51:38 -05:00
((start_pos+=${#BUFFER[$start_pos+1,-1]}-${#${BUFFER[$start_pos+1,-1]##[[:space:]]#}}))
2010-12-25 12:33:08 -05:00
((end_pos=$start_pos+${#arg}))
if $new_expression; then
new_expression=false
res=$(LC_ALL=C builtin type -w $arg 2>/dev/null)
2010-12-25 12:33:08 -05:00
case $res in
*': reserved') style=$ZSH_HIGHLIGHT_STYLES[reserved-word];;
*': alias') style=$ZSH_HIGHLIGHT_STYLES[alias]
local aliased_command="${"$(alias $arg)"#*=}"
if [[ ${${ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS[(r)$aliased_command]:-}:+yes} = 'yes' && ${${ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS[(r)$arg]:-}:+yes} != 'yes' ]]; then
ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS+=($arg)
fi
;;
*': builtin') style=$ZSH_HIGHLIGHT_STYLES[builtin];;
*': function') style=$ZSH_HIGHLIGHT_STYLES[function];;
*': command') style=$ZSH_HIGHLIGHT_STYLES[command];;
2011-01-05 16:51:00 -05:00
*': hashed') style=$ZSH_HIGHLIGHT_STYLES[hashed-command];;
*) if _zsh_check-path; then
style=$ZSH_HIGHLIGHT_STYLES[path]
2011-01-01 13:17:02 -05:00
elif [[ $arg[0,1] = $histchars[0,1] ]]; then
style=$ZSH_HIGHLIGHT_STYLES[history-expansion]
else
style=$ZSH_HIGHLIGHT_STYLES[unknown-token]
2011-01-05 04:54:25 -05:00
fi
;;
2010-12-25 12:33:08 -05:00
esac
else
2010-12-30 11:05:00 -05:00
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]
2010-12-30 11:47:55 -05:00
region_highlight+=("$start_pos $end_pos $style")
_zsh_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_check-path; then
style=$ZSH_HIGHLIGHT_STYLES[path]
2011-01-01 13:17:02 -05:00
elif [[ $arg[0,1] = $histchars[0,1] ]]; then
style=$ZSH_HIGHLIGHT_STYLES[history-expansion]
else
style=$ZSH_HIGHLIGHT_STYLES[default]
2011-01-05 04:54:25 -05:00
fi
;;
2010-12-30 11:05:00 -05:00
esac
2010-12-25 12:33:08 -05:00
fi
[[ $substr_color = 0 ]] && region_highlight+=("$start_pos $end_pos $style")
[[ ${${ZSH_HIGHLIGHT_TOKENS_FOLLOWED_BY_COMMANDS[(r)${arg//|/\|}]:-}:+yes} = 'yes' ]] && new_expression=true
2010-12-25 12:33:08 -05:00
start_pos=$end_pos
done
}
2011-01-05 07:48:23 -05:00
# 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() {
# Bracket matching
2011-01-05 17:07:56 -05:00
bracket_color_size=${#ZSH_HIGHLIGHT_MATCHING_BRACKETS_STYLES}
2011-01-05 07:48:23 -05:00
if ((bracket_color_size > 0)); then
2011-01-05 16:51:00 -05:00
typeset -A levelpos lastoflevel matching revmatching
2011-01-05 07:48:23 -05:00
((level = 0))
for pos in {1..${#BUFFER}}; do
case $BUFFER[pos] in
"("|"["|"{")
levelpos[$pos]=$((++level))
lastoflevel[$level]=$pos
2011-01-05 07:48:23 -05:00
;;
")"|"]"|"}")
matching[$lastoflevel[$level]]=$pos
revmatching[$pos]=$lastoflevel[$level]
levelpos[$pos]=$((level--))
2011-01-05 07:48:23 -05:00
;;
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
2011-01-05 17:07:56 -05:00
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
2011-01-05 07:48:23 -05:00
fi
2010-12-25 12:33:08 -05:00
}
# Special treatment for completion/expansion events:
# For each *complete* function (except 'accept-and-menu-complete'),
# we create a widget which mimics the original
# and use this orig-* version inside the new colorized zle function (the dot
# idiom used for all others doesn't work right for these functions for some
# reason). You can see the default setup using "zle -l -L".
# Bind all ZLE events from zle -la to highlighting function.
_zsh_highlight-install() {
zmodload zsh/zleparameter 2>/dev/null || {
echo 'zsh-syntax-highlighting:zmoadload error. exiting.' >&2; return -1
}
local -a events; : ${(A)events::=${@:#(_*|orig-*|.run-help|.which-command)}}
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
}
_zsh_highlight-install "${(@f)"$(zle -la)"}"