302 lines
7.3 KiB
Plaintext
302 lines
7.3 KiB
Plaintext
zplugin-side.zsh(1)
|
||
===================
|
||
:compat-mode!:
|
||
|
||
NAME
|
||
----
|
||
zplugin-side.zsh - a shell script
|
||
|
||
SYNOPSIS
|
||
--------
|
||
Documentation automatically generated with `zshelldoc'
|
||
|
||
FUNCTIONS
|
||
---------
|
||
|
||
-zplg-any-colorify-as-uspl2
|
||
-zplg-compute-ice
|
||
-zplg-countdown
|
||
-zplg-exists-physically
|
||
-zplg-exists-physically-message
|
||
-zplg-first
|
||
-zplg-get-plg-dir
|
||
-zplg-shands-exp
|
||
-zplg-store-ices
|
||
-zplg-two-paths
|
||
|
||
DETAILS
|
||
-------
|
||
|
||
Script Body
|
||
~~~~~~~~~~~
|
||
|
||
Has 1 line(s). No functions are called (may set up e.g. a hook, a Zle widget bound to a key, etc.).
|
||
|
||
-zplg-any-colorify-as-uspl2
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Returns ANSI-colorified "user/plugin" string, from any supported
|
||
plugin spec (user---plugin, user/plugin, user plugin, plugin).
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
$REPLY = ANSI-colorified "user/plugin" string
|
||
____
|
||
|
||
Has 11 line(s). Calls functions:
|
||
|
||
-zplg-any-colorify-as-uspl2
|
||
`-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
|
||
Called by:
|
||
|
||
-zplg-exists-physically-message
|
||
zplugin-autoload.zsh/-zplg-clear-completions
|
||
zplugin-autoload.zsh/-zplg-compiled
|
||
zplugin-autoload.zsh/-zplg-compile-uncompile-all
|
||
zplugin-autoload.zsh/-zplg-create
|
||
zplugin-autoload.zsh/-zplg-exists-message
|
||
zplugin-autoload.zsh/-zplg-get-completion-owner-uspl2col
|
||
zplugin-autoload.zsh/-zplg-list-bindkeys
|
||
zplugin-autoload.zsh/-zplg-recently
|
||
zplugin-autoload.zsh/-zplg-search-completions
|
||
zplugin-autoload.zsh/-zplg-show-completions
|
||
zplugin-autoload.zsh/-zplg-show-registered-plugins
|
||
zplugin-autoload.zsh/-zplg-show-times
|
||
zplugin-autoload.zsh/-zplg-uncompile-plugin
|
||
zplugin-autoload.zsh/-zplg-unload
|
||
zplugin-autoload.zsh/-zplg-update-or-status-all
|
||
zplugin-autoload.zsh/-zplg-update-or-status
|
||
zplugin-install.zsh/-zplg-install-completions
|
||
zplugin-install.zsh/-zplg-setup-plugin-dir
|
||
|
||
-zplg-compute-ice
|
||
~~~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Computes ZPLG_ICE array (default, it can be specified via $3) from a) input
|
||
ZPLG_ICE, b) static ice, c) saved ice, taking priorities into account. Also
|
||
returns path to snippet directory and optional name of snippet file (only
|
||
valid if ZPLG_ICE[svn] is not set).
|
||
|
||
Can also pack resulting ices into ZPLG_SICE (see $2).
|
||
|
||
$1 - URL (also plugin-spec)
|
||
$2 - "pack" or "nopack" or "pack-nf" - packing means ZPLG_ICE
|
||
wins with static ice; "pack-nf" means that disk-ices will
|
||
be ignored (no-file?)
|
||
$3 - name of output associative array, "ZPLG_ICE" is the default
|
||
$4 - name of output string parameter, to hold path to directory ("local_dir")
|
||
$5 - name of output string parameter, to hold filename ("filename")
|
||
$6 - name of output string parameter, to hold is-snippet 0/1-bool ("is_snippet")
|
||
____
|
||
|
||
Has 107 line(s). Calls functions:
|
||
|
||
-zplg-compute-ice
|
||
|-- -zplg-exists-physically-message
|
||
| |-- -zplg-any-colorify-as-uspl2
|
||
| | `-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
| |-- -zplg-exists-physically
|
||
| | |-- -zplg-shands-exp
|
||
| | `-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
| `-- -zplg-shands-exp
|
||
|-- -zplg-shands-exp
|
||
|-- -zplg-two-paths
|
||
|-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
`-- zplugin.zsh/-zplg-pack-ice
|
||
|
||
Uses feature(s): _setopt_, _wait_
|
||
|
||
Called by:
|
||
|
||
zplugin-autoload.zsh/-zplg-delete
|
||
zplugin-autoload.zsh/-zplg-edit
|
||
zplugin-autoload.zsh/-zplg-recall
|
||
zplugin-autoload.zsh/-zplg-update-or-status-snippet
|
||
zplugin-autoload.zsh/-zplg-update-or-status
|
||
zplugin-install.zsh/-zplg-compile-plugin
|
||
|
||
-zplg-countdown
|
||
~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Displays a countdown 5...4... etc. and returns 0 if it
|
||
sucessfully reaches 0, or 1 if Ctrl-C will be pressed.
|
||
____
|
||
|
||
Has 15 line(s). Doesn't call other functions.
|
||
|
||
Uses feature(s): _trap_
|
||
|
||
Called by:
|
||
|
||
zplugin-autoload.zsh/-zplg-run-delete-hooks
|
||
zplugin-autoload.zsh/-zplg-update-or-status
|
||
zplugin-install.zsh/-zplg-download-snippet
|
||
zplugin-install.zsh/-zplg-setup-plugin-dir
|
||
|
||
-zplg-exists-physically
|
||
~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Checks if directory of given plugin exists in PLUGIN_DIR.
|
||
|
||
Testable.
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
____
|
||
|
||
Has 10 line(s). Calls functions:
|
||
|
||
-zplg-exists-physically
|
||
|-- -zplg-shands-exp
|
||
`-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
|
||
Called by:
|
||
|
||
-zplg-exists-physically-message
|
||
zplugin-autoload.zsh/-zplg-create
|
||
zplugin-autoload.zsh/-zplg-get-path
|
||
|
||
-zplg-exists-physically-message
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Checks if directory of given plugin exists in PLUGIN_DIR,
|
||
and outputs error message if it doesn't.
|
||
|
||
Testable.
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
____
|
||
|
||
Has 11 line(s). Calls functions:
|
||
|
||
-zplg-exists-physically-message
|
||
|-- -zplg-any-colorify-as-uspl2
|
||
| `-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
|-- -zplg-exists-physically
|
||
| |-- -zplg-shands-exp
|
||
| `-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
`-- -zplg-shands-exp
|
||
|
||
Called by:
|
||
|
||
-zplg-compute-ice
|
||
zplugin-autoload.zsh/-zplg-changes
|
||
zplugin-autoload.zsh/-zplg-glance
|
||
zplugin-autoload.zsh/-zplg-stress
|
||
zplugin-autoload.zsh/-zplg-update-or-status
|
||
zplugin-install.zsh/-zplg-install-completions
|
||
|
||
-zplg-first
|
||
~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Finds the main file of plugin. There are multiple file name
|
||
formats, they are ordered in order starting from more correct
|
||
ones, and matched. -zplg-load-plugin() has similar code parts
|
||
and doesn't call -zplg-first() – for performance. Obscure matching
|
||
is done in -zplg-find-other-matches, here and in -zplg-load().
|
||
Obscure = non-standard main-file naming convention.
|
||
|
||
$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||
$2 - plugin (only when $1 - i.e. user - given)
|
||
____
|
||
|
||
Has 17 line(s). Calls functions:
|
||
|
||
-zplg-first
|
||
|-- -zplg-get-plg-dir
|
||
|-- zplugin.zsh/-zplg-any-to-user-plugin
|
||
`-- zplugin.zsh/-zplg-find-other-matches
|
||
|
||
Called by:
|
||
|
||
zplugin-autoload.zsh/-zplg-glance
|
||
zplugin-autoload.zsh/-zplg-stress
|
||
zplugin-install.zsh/-zplg-compile-plugin
|
||
|
||
-zplg-get-plg-dir
|
||
~~~~~~~~~~~~~~~~~
|
||
|
||
Has 9 line(s). Doesn't call other functions.
|
||
|
||
Called by:
|
||
|
||
-zplg-first
|
||
|
||
-zplg-shands-exp
|
||
~~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Does expansion of currently little unstandarized
|
||
shorthands like "%SNIPPETS", "%HOME", "OMZ::", "PZT::".
|
||
____
|
||
|
||
Has 3 line(s). Doesn't call other functions.
|
||
|
||
Called by:
|
||
|
||
-zplg-compute-ice
|
||
-zplg-exists-physically-message
|
||
-zplg-exists-physically
|
||
zplugin-autoload.zsh/-zplg-get-path
|
||
|
||
-zplg-store-ices
|
||
~~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Saves ice mods in given hash onto disk.
|
||
|
||
$1 - directory where to create / delete files
|
||
$2 - name of hash that holds values
|
||
$3 - additional keys of hash to store, space separated
|
||
$4 - additional keys of hash to store, empty-meaningful ices, space separated
|
||
$5 – the URL, if applicable
|
||
$6 – the mode (1 - svn, 0 - single file), if applicable
|
||
____
|
||
|
||
Has 41 line(s). Doesn't call other functions.
|
||
|
||
Uses feature(s): _wait_
|
||
|
||
Called by:
|
||
|
||
zplugin-autoload.zsh/-zplg-update-or-status
|
||
zplugin-install.zsh/-zplg-download-snippet
|
||
zplugin-install.zsh/-zplg-setup-plugin-dir
|
||
|
||
-zplg-two-paths
|
||
~~~~~~~~~~~~~~~
|
||
|
||
____
|
||
|
||
Obtains a snippet URL without specification if it is an SVN URL (points to
|
||
directory) or regular URL (points to file), returns 2 possible paths for
|
||
further examination
|
||
____
|
||
|
||
Has 19 line(s). Doesn't call other functions.
|
||
|
||
Uses feature(s): _setopt_
|
||
|
||
Called by:
|
||
|
||
-zplg-compute-ice
|
||
zplugin-autoload.zsh/-zplg-get-path
|
||
zplugin-autoload.zsh/-zplg-update-or-status
|
||
|