zsh-syntax-highlighting.zsh.adoc

zsh-syntax-highlighting.zsh(1)

NAME

zsh-syntax-highlighting.zsh - a shell script

SYNOPSIS

Documentation automatically generated with `zsdoc'

FUNCTIONS

 _zsh_highlight
 _zsh_highlight_add_highlight
 _zsh_highlight_apply_zle_highlight
 _zsh_highlight_bind_widgets
 _zsh_highlight_buffer_modified
 _zsh_highlight_call_widget
 _zsh_highlight_cursor_moved
 _zsh_highlight_load_highlighters
AUTOLOAD add-zsh-hook
AUTOLOAD is-at-least
PREEXEC-HOOK _zsh_highlight_preexec_hook

DETAILS

Script Body

Has 36 line(s). Calls functions:

Script-Body
|-- _zsh_highlight_bind_widgets
|-- _zsh_highlight_load_highlighters
|-- add-zsh-hook
`-- is-at-least

_zsh_highlight

# Update ZLE buffer syntax highlighting.
#
# Invokes each highlighter that needs updating.
# This function is supposed to be called whenever the ZLE state changes.

Has 65 line(s). Calls functions:

_zsh_highlight
`-- _zsh_highlight_apply_zle_highlight

Uses feature(s): eval, type

Called by:

_zsh_highlight_call_widget

_zsh_highlight_add_highlight

# Add a highlight defined by ZSH_HIGHLIGHT_STYLES.
#
# Should be used by all highlighters aside from 'pattern' (cf. ZSH_HIGHLIGHT_PATTERN).
# Overwritten in tests/test-highlighting.zsh when testing.

Has 11 line(s). Doesn’t call other functions.

Not called by script or any function, may be a hook or Zle widget, etc.

_zsh_highlight_apply_zle_highlight

# Apply highlighting based on entries in the zle_highlight array.
# This function takes four arguments:
# 1. The exact entry (no patterns) in the zle_highlight array:
#    region, paste, isearch, or suffix
# 2. The default highlighting that should be applied if the entry is unset
# 3. and 4. Two integer values describing the beginning and end of the
#    range. The order does not matter.

Has 20 line(s). Doesn’t call other functions.

Called by:

_zsh_highlight

_zsh_highlight_bind_widgets

# Rebind all ZLE widgets to make them invoke _zsh_highlights.

Has 34 line(s). Doesn’t call other functions.

Uses feature(s): eval, zle, zmodload

Called by:

Script-Body

_zsh_highlight_buffer_modified

# Whether the command line buffer has been modified or not.
#
# Returns 0 if the buffer has changed since _zsh_highlight was last called.

Has 1 line(s). Doesn’t call other functions.

Not called by script or any function, may be a hook or Zle widget, etc.

_zsh_highlight_call_widget

# Helper for _zsh_highlight_bind_widgets
# $1 is name of widget to call

Has 2 line(s). Calls functions:

_zsh_highlight_call_widget
`-- _zsh_highlight
    `-- _zsh_highlight_apply_zle_highlight

Uses feature(s): zle

Not called by script or any function, may be a hook or Zle widget, etc.

_zsh_highlight_cursor_moved

# Whether the cursor has moved or not.
#
# Returns 0 if the cursor has moved since _zsh_highlight was last called.

Has 1 line(s). Doesn’t call other functions.

Not called by script or any function, may be a hook or Zle widget, etc.

_zsh_highlight_load_highlighters

# Load highlighters from directory.
#
# Arguments:
#   1) Path to the highlighters directory.

Has 25 line(s). Doesn’t call other functions.

Uses feature(s): eval, type

Called by:

Script-Body

_zsh_highlight_preexec_hook

# Reset scratch variables when commandline is done.

Has 2 line(s). Is a preexec hook. Doesn’t call other functions.

Not called by script or any function, may be a hook or Zle widget, etc.

add-zsh-hook

Has 93 line(s). Doesn’t call other functions.

Uses feature(s): autoload

Called by:

Script-Body

is-at-least

Has 56 line(s). Doesn’t call other functions.

Called by:

Script-Body