Compare commits

...

35 Commits

Author SHA1 Message Date
Eric Freese
9d100f4f32 bump version v0.2.14 2016-02-23 20:12:16 -07:00
Eric Freese
ddb7284852 Fix backslash escaping problems with echo -E. 2016-02-23 20:11:56 -07:00
Eric Freese
2a5791710a bump version v0.2.13 2016-02-23 18:14:12 -07:00
Eric Freese
03fac1f0d7 Revert "Use zle -w flag to set WIDGET appropriately when calling orig widget"
This reverts commit 70438d233d.
2016-02-23 18:13:03 -07:00
Eric Freese
aa859a282d bump version v0.2.12 2016-02-23 10:37:57 -07:00
Eric Freese
f08a5a1baa [Formatting] Remove extra space in test script. 2016-02-23 10:24:35 -07:00
Eric Freese
70438d233d Use zle -w flag to set WIDGET appropriately when calling orig widget 2016-02-23 10:21:35 -07:00
Eric Freese
ba029e83d0 bump version v0.2.11 2016-02-17 13:44:52 -07:00
Eric Freese
acc129de6c Fix error when using autosuggest widgets 2016-02-17 13:44:52 -07:00
Eric Freese
aa5ceee256 Make asciinema a bit smaller. 2016-02-16 21:55:56 -07:00
Eric Freese
113ca0ad10 Add asciinema recording to README 2016-02-16 21:35:44 -07:00
Eric Freese
2b449a62f8 bump version v0.2.10 2016-02-16 20:59:31 -07:00
Eric Freese
6d25df6864 Revert usage of fc for suggestions and fix for sh_word_split.
Force field splitting on \0 to support sh_word_split option.
2016-02-16 10:51:01 -07:00
Eric Freese
0faa2b6584 bump version v0.2.9 2016-02-16 09:34:35 -07:00
Eric Freese
a2d8d91196 Actually fix suggestions when sh_split_words option is enabled. 2016-02-16 09:33:26 -07:00
Eric Freese
dd9a8789a7 bump version v0.2.8 2016-02-16 07:59:36 -07:00
Eric Freese
1b98af5b33 Fix suggestions when sh_split_words option is enabled 2016-02-16 07:57:44 -07:00
Eric Freese
45ab49d1f2 bump version v0.2.7 2016-02-15 08:46:23 -07:00
Eric Freese
41f15d5c9f Forgot a pesky backslash 2016-02-15 08:45:52 -07:00
Eric Freese
3ce1adb55d bump version v0.2.6 2016-02-15 08:31:50 -07:00
Eric Freese
2461a98857 Fix segfaults once and for all? 2016-02-15 08:31:00 -07:00
Eric Freese
76f415bf43 bump version v0.2.5 2016-02-14 08:55:20 -07:00
Eric Freese
5e419da326 Remove list of modify widgets and make 'modify' the default behavior. 2016-02-14 08:54:34 -07:00
Eric Freese
cd71081303 bump version v0.2.4 2016-02-14 01:08:21 -07:00
Eric Freese
9788c2ee49 Fix deprecation warnings. 2016-02-14 01:07:05 -07:00
Eric Freese
ebcfc46b72 Comment formatting 2016-02-14 00:29:43 -07:00
Eric Freese
b49d002888 [README] Add example of minimal .zshrc. 2016-02-13 23:53:32 -07:00
Eric Freese
266437c98a bump version v0.2.3 2016-02-13 23:47:24 -07:00
Eric Freese
51b39e210e Bound widgets now handle arguments correctly 2016-02-13 23:46:34 -07:00
Eric Freese
011f5420fc Version bump v0.2.2 2016-02-13 21:15:33 -07:00
Eric Freese
1a38fbf6a5 [README] Add note about workaround for bpm bug. 2016-02-13 21:14:59 -07:00
Eric Freese
31452887d2 [Test] Add tests widgets 2016-02-13 14:13:21 -07:00
Eric Freese
cf146b6696 [Test] Clean up highlight tests 2016-02-13 14:13:21 -07:00
Eric Freese
74197498fc [Test] Add stub.sh from ericfreese/stub.sh for stubbing/mocking. 2016-02-13 14:13:21 -07:00
Eric Freese
abe577d519 Fix build 2016-02-13 14:13:21 -07:00
13 changed files with 832 additions and 234 deletions

View File

@@ -26,7 +26,7 @@ ALL_TARGETS := \
all: $(ALL_TARGETS) all: $(ALL_TARGETS)
$(PLUGIN_TARGET): $(HEADER_FILES) $(SRC_FILES) $(PLUGIN_TARGET): $(HEADER_FILES) $(SRC_FILES)
cat $(HEADER_FILES) | sed -e 's/^/# /g' >> $@ cat $(HEADER_FILES) | sed -e 's/^/# /g' > $@
cat $(SRC_FILES) >> $@ cat $(SRC_FILES) >> $@
$(OH_MY_ZSH_LINK_TARGET): $(PLUGIN_TARGET) $(OH_MY_ZSH_LINK_TARGET): $(PLUGIN_TARGET)

View File

@@ -4,6 +4,7 @@ _[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh._
It suggests commands as you type, based on command history. It suggests commands as you type, based on command history.
<a href="https://asciinema.org/a/36578" target="_blank"><img src="https://asciinema.org/a/36578.png" width="520"/></a>
## Installation ## Installation
@@ -40,8 +41,6 @@ It suggests commands as you type, based on command history.
3. Start a new terminal session. 3. Start a new terminal session.
> **Note:** There is an open issue ([#102](https://github.com/tarruda/zsh-autosuggestions/issues/102)) when using this plugin with `bracketed-paste-magic`, which is enabled by default by Oh My Zsh.
## Usage ## Usage
@@ -69,10 +68,11 @@ Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion
This plugin works by triggering custom behavior when certain [zle widgets](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets) are invoked. You can add and remove widgets from these arrays to change the behavior of this plugin: This plugin works by triggering custom behavior when certain [zle widgets](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets) are invoked. You can add and remove widgets from these arrays to change the behavior of this plugin:
- `ZSH_AUTOSUGGEST_CLEAR_WIDGETS`: Widgets in this array will clear the suggestion when invoked. - `ZSH_AUTOSUGGEST_CLEAR_WIDGETS`: Widgets in this array will clear the suggestion when invoked.
- `ZSH_AUTOSUGGEST_MODIFY_WIDGETS`: Widgets in this array will modify the buffer and fetch a new suggestion when invoked.
- `ZSH_AUTOSUGGEST_ACCEPT_WIDGETS`: Widgets in this array will accept the suggestion when invoked. - `ZSH_AUTOSUGGEST_ACCEPT_WIDGETS`: Widgets in this array will accept the suggestion when invoked.
- `ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS`: Widgets in this array will partially accept the suggestion when invoked. - `ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS`: Widgets in this array will partially accept the suggestion when invoked.
Widgets not in any of these lists will update the suggestion when invoked.
**Note:** A widget shouldn't belong to more than one of the above arrays. **Note:** A widget shouldn't belong to more than one of the above arrays.
@@ -94,32 +94,13 @@ bindkey '^ ' autosuggest-accept
### [`zsh-history-substring-search`](https://github.com/zsh-users/zsh-history-substring-search) ### [`zsh-history-substring-search`](https://github.com/zsh-users/zsh-history-substring-search)
When the buffer is empty and one of the `history-substring-search-up/down` widgets is invoked, it will call the `up/down-line-or-history` widget. If the `up/down-line-or-history` widgets are in `ZSH_AUTOSUGGEST_CLEAR_WIDGETS` (the list of widgets that clear the suggestion), this can create an infinite recursion, crashing the shell session. The `history-substring-search-up` and `history-substring-search-down` widgets are not bound by default. You'll probably want to add them to `ZSH_AUTOSUGGEST_CLEAR_WIDGETS` so that the suggestion will be cleared when you start searching through history:
For best results, you'll want to remove `up-line-or-history` and `down-line-or-history` from `ZSH_AUTOSUGGEST_CLEAR_WIDGETS`:
```
# Remove *-line-or-history widgets from list of widgets that clear the autosuggestion to avoid conflict with history-substring-search-* widgets
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=("${(@)ZSH_AUTOSUGGEST_CLEAR_WIDGETS:#(up|down)-line-or-history}")
```
Additionally, the `history-substring-search-up` and `history-substring-search-down` widgets are not bound by default. You'll probably want to add them to `ZSH_AUTOSUGGEST_CLEAR_WIDGETS` so that the suggestion will be cleared when you start searching through history:
```sh ```sh
# Add history-substring-search-* widgets to list of widgets that clear the autosuggestion # Add history-substring-search-* widgets to list of widgets that clear the autosuggestion
ZSH_AUTOSUGGEST_CLEAR_WIDGETS+=(history-substring-search-up history-substring-search-down) ZSH_AUTOSUGGEST_CLEAR_WIDGETS+=(history-substring-search-up history-substring-search-down)
``` ```
For example:
```sh
source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh
source ~/Code/zsh-history-substring-search/zsh-history-substring-search.zsh
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=("${(@)ZSH_AUTOSUGGEST_CLEAR_WIDGETS:#(up|down)-line-or-history}")
ZSH_AUTOSUGGEST_CLEAR_WIDGETS+=(history-substring-search-up history-substring-search-down)
```
## Troubleshooting ## Troubleshooting
@@ -132,7 +113,7 @@ Before reporting an issue, please try temporarily disabling sections of your con
When reporting an issue, please include: When reporting an issue, please include:
- The smallest, simplest `.zshrc` configuration that will reproduce the problem - The smallest, simplest `.zshrc` configuration that will reproduce the problem. See [this comment](https://github.com/tarruda/zsh-autosuggestions/issues/102#issuecomment-180944764) for a good example of what this means.
- The version of zsh you're using (`zsh --version`) - The version of zsh you're using (`zsh --version`)
- Which operating system you're running - Which operating system you're running

View File

@@ -1 +1 @@
v0.2.0 v0.2.14

View File

@@ -4,9 +4,16 @@ SCRIPT_DIR=$(dirname "$0")
TEST_DIR=$SCRIPT_DIR/../test TEST_DIR=$SCRIPT_DIR/../test
DIST_DIR=$SCRIPT_DIR/../ DIST_DIR=$SCRIPT_DIR/../
# Use stub.sh for stubbing/mocking
source $TEST_DIR/stub-1.0.2.sh
source $DIST_DIR/zsh-autosuggestions.zsh source $DIST_DIR/zsh-autosuggestions.zsh
testDefaultHighlightStyle() { #--------------------------------------------------------------------#
# Highlighting #
#--------------------------------------------------------------------#
testHighlightDefaultStyle() {
assertEquals \ assertEquals \
"fg=8" \ "fg=8" \
"$ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" "$ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE"
@@ -23,12 +30,12 @@ testHighlightApplyWithSuggestion() {
_zsh_autosuggest_highlight_apply _zsh_autosuggest_highlight_apply
assertEquals \ assertEquals \
"adds to region_highlight with correct style" \ "highlight did not use correct style" \
"0 2 fg=1 2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \ "0 2 fg=1 2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \
"$region_highlight" "$region_highlight"
assertEquals \ assertEquals \
"saves the higlight to be removed later" \ "higlight was not saved to be removed later" \
"2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \ "2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
@@ -43,12 +50,12 @@ testHighlightApplyWithoutSuggestion() {
_zsh_autosuggest_highlight_apply _zsh_autosuggest_highlight_apply
assertEquals \ assertEquals \
"leaves region_highlight alone" \ "region_highlight was modified" \
"0 4 fg=1" \ "0 4 fg=1" \
"$region_highlight" "$region_highlight"
assertNull \ assertNull \
"clears the last highlight" \ "last highlight region was not cleared" \
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
} }
@@ -61,15 +68,256 @@ testHighlightReset() {
_zsh_autosuggest_highlight_reset _zsh_autosuggest_highlight_reset
assertEquals \ assertEquals \
"removes last highlight region" \ "last highlight region was not removed" \
"0 1 fg=1 1 2 fg=1" \ "0 1 fg=1 1 2 fg=1" \
"$region_highlight" "$region_highlight"
assertNull \ assertNull \
"clears the last highlight" \ "last highlight variable was not cleared" \
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
} }
#--------------------------------------------------------------------#
# Widgets #
#--------------------------------------------------------------------#
testWidgetFunctionClear() {
BUFFER="ec"
POSTDISPLAY="ho hello"
_zsh_autosuggest_clear "original-widget"
assertEquals \
"BUFFER was modified" \
"ec" \
"$BUFFER"
assertNull \
"POSTDISPLAY was not cleared" \
"$POSTDISPLAY"
}
testWidgetFunctionModify() {
BUFFER=""
POSTDISPLAY=""
stub_and_eval \
_zsh_autosuggest_invoke_original_widget \
'BUFFER+="e"'
stub_and_echo \
_zsh_autosuggest_suggestion \
"echo hello"
_zsh_autosuggest_modify "original-widget"
assertTrue \
"original widget not invoked" \
"stub_called _zsh_autosuggest_invoke_original_widget"
assertEquals \
"BUFFER was not modified" \
"e" \
"$BUFFER"
assertEquals \
"POSTDISPLAY does not contain suggestion" \
"cho hello" \
"$POSTDISPLAY"
restore _zsh_autosuggest_invoke_original_widget
restore _zsh_autosuggest_suggestion
}
testWidgetFunctionAcceptCursorAtEnd() {
BUFFER="echo"
POSTDISPLAY=" hello"
CURSOR=4
stub _zsh_autosuggest_invoke_original_widget
_zsh_autosuggest_accept "original-widget"
assertTrue \
"original widget not invoked" \
"stub_called _zsh_autosuggest_invoke_original_widget"
assertEquals \
"BUFFER was not modified" \
"echo hello" \
"$BUFFER"
assertEquals \
"POSTDISPLAY was not cleared" \
"" \
"$POSTDISPLAY"
}
testWidgetFunctionAcceptCursorNotAtEnd() {
BUFFER="echo"
POSTDISPLAY=" hello"
CURSOR=2
stub _zsh_autosuggest_invoke_original_widget
_zsh_autosuggest_accept "original-widget"
assertTrue \
"original widget not invoked" \
"stub_called _zsh_autosuggest_invoke_original_widget"
assertEquals \
"BUFFER was modified" \
"echo" \
"$BUFFER"
assertEquals \
"POSTDISPLAY was modified" \
" hello" \
"$POSTDISPLAY"
}
testWidgetFunctionPartialAcceptCursorMovesOutOfBuffer() {
BUFFER="ec"
POSTDISPLAY="ho hello"
CURSOR=1
stub_and_eval \
_zsh_autosuggest_invoke_original_widget \
'CURSOR=5; LBUFFER="echo "; RBUFFER="hello"'
_zsh_autosuggest_partial_accept "original-widget"
assertTrue \
"original widget not invoked" \
"stub_called _zsh_autosuggest_invoke_original_widget"
assertEquals \
"BUFFER was not modified correctly" \
"echo " \
"$BUFFER"
assertEquals \
"POSTDISPLAY was not modified correctly" \
"hello" \
"$POSTDISPLAY"
}
testWidgetFunctionPartialAcceptCursorStaysInBuffer() {
BUFFER="echo hello"
POSTDISPLAY=" world"
CURSOR=1
stub_and_eval \
_zsh_autosuggest_invoke_original_widget \
'CURSOR=5; LBUFFER="echo "; RBUFFER="hello"'
_zsh_autosuggest_partial_accept "original-widget"
assertTrue \
"original widget not invoked" \
"stub_called _zsh_autosuggest_invoke_original_widget"
assertEquals \
"BUFFER was modified" \
"echo hello" \
"$BUFFER"
assertEquals \
"POSTDISPLAY was modified" \
" world" \
"$POSTDISPLAY"
}
testWidgetAccept() {
stub _zsh_autosuggest_highlight_reset
stub _zsh_autosuggest_accept
stub _zsh_autosuggest_highlight_apply
# Call the function pointed to by the widget since we can't call
# the widget itself when zle is not active
${widgets[autosuggest-accept]#*:} "original-widget"
assertTrue \
"autosuggest-accept widget does not exist" \
"zle -l autosuggest-accept"
assertTrue \
"highlight_reset was not called" \
"stub_called _zsh_autosuggest_highlight_reset"
assertTrue \
"widget function was not called" \
"stub_called _zsh_autosuggest_accept"
assertTrue \
"highlight_apply was not called" \
"stub_called _zsh_autosuggest_highlight_apply"
}
testWidgetClear() {
stub _zsh_autosuggest_highlight_reset
stub _zsh_autosuggest_clear
stub _zsh_autosuggest_highlight_apply
# Call the function pointed to by the widget since we can't call
# the widget itself when zle is not active
${widgets[autosuggest-clear]#*:} "original-widget"
assertTrue \
"autosuggest-clear widget does not exist" \
"zle -l autosuggest-clear"
assertTrue \
"highlight_reset was not called" \
"stub_called _zsh_autosuggest_highlight_reset"
assertTrue \
"widget function was not called" \
"stub_called _zsh_autosuggest_clear"
assertTrue \
"highlight_apply was not called" \
"stub_called _zsh_autosuggest_highlight_apply"
}
testEscapeCommandPrefix() {
assertEquals \
"Did not escape single backslash" \
"\\\\" \
"$(_zsh_autosuggest_escape_command_prefix "\\")"
assertEquals \
"Did not escape two backslashes" \
"\\\\\\\\" \
"$(_zsh_autosuggest_escape_command_prefix "\\\\")"
assertEquals \
"Did not escape parentheses" \
"\\(\\)" \
"$(_zsh_autosuggest_escape_command_prefix "()")"
assertEquals \
"Did not escape square brackets" \
"\\[\\]" \
"$(_zsh_autosuggest_escape_command_prefix "[]")"
assertEquals \
"Did not escape pipe" \
"\\|" \
"$(_zsh_autosuggest_escape_command_prefix "|")"
assertEquals \
"Did not escape star" \
"\\*" \
"$(_zsh_autosuggest_escape_command_prefix "*")"
assertEquals \
"Did not escape question mark" \
"\\?" \
"$(_zsh_autosuggest_escape_command_prefix "?")"
}
# For zsh compatibility # For zsh compatibility
setopt shwordsplit setopt shwordsplit
SHUNIT_PARENT=$0 SHUNIT_PARENT=$0

View File

@@ -1,15 +1,15 @@
#----------------# #--------------------------------------------------------------------#
# Widget Helpers # # Widget Helpers #
#----------------# #--------------------------------------------------------------------#
# Bind a single widget to an autosuggest widget, saving a reference to the original widget # Bind a single widget to an autosuggest widget, saving a reference to the original widget
_zsh_autosuggest_bind_widget() { _zsh_autosuggest_bind_widget() {
local widget=$1 local widget=$1
local autosuggest_function=$2 local autosuggest_action=$2
local prefix=$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX local prefix=$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX
local action
# Save a reference to the original widget
case $widgets[$widget] in case $widgets[$widget] in
# Already bound # Already bound
user:_zsh_autosuggest_(bound|orig)_*);; user:_zsh_autosuggest_(bound|orig)_*);;
@@ -31,19 +31,14 @@ _zsh_autosuggest_bind_widget() {
;; ;;
esac esac
# Set up widget to call $autosuggest_function if it exists # Pass the original widget's name explicitly into the autosuggest
# Otherwise just call the original widget # function. Use this passed in widget name to call the original
if [ -n "$autosuggest_function" ]; then; # widget instead of relying on the $WIDGET variable being set
action=$autosuggest_function; # correctly. $WIDGET cannot be trusted because other plugins call
else; # zle without the `-w` flag (e.g. `zle self-insert` instead of
action="zle $prefix$widget \$@" # `zle self-insert -w`).
fi
# Create new function for the widget that highlights and calls the action
eval "_zsh_autosuggest_bound_$widget() { eval "_zsh_autosuggest_bound_$widget() {
_zsh_autosuggest_highlight_reset _zsh_autosuggest_widget_$autosuggest_action $prefix$widget \$@
$action
_zsh_autosuggest_highlight_apply
}" }"
# Create the bound widget # Create the bound widget
@@ -55,26 +50,30 @@ _zsh_autosuggest_bind_widgets() {
local widget; local widget;
# Find every widget we might want to bind and bind it appropriately # Find every widget we might want to bind and bind it appropriately
for widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|autosuggest-*|$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX*|run-help|which-command|beep|set-local-history|yank)}; do for widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|autosuggest-*|$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX*|zle-line-*|run-help|which-command|beep|set-local-history|yank)}; do
if [ ${ZSH_AUTOSUGGEST_MODIFY_WIDGETS[(r)$widget]} ]; then if [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_modify _zsh_autosuggest_bind_widget $widget clear
elif [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_clear
elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_accept _zsh_autosuggest_bind_widget $widget accept
elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_partial_accept _zsh_autosuggest_bind_widget $widget partial_accept
else else
_zsh_autosuggest_bind_widget $widget # Assume any unspecified widget might modify the buffer
_zsh_autosuggest_bind_widget $widget modify
fi fi
done done
} }
# Given the name of a widget, invoke the original we saved, if it exists # Given the name of an original widget and args, invoke it, if it exists
_zsh_autosuggest_invoke_original_widget() { _zsh_autosuggest_invoke_original_widget() {
local original_widget_name="$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX$1" # Do nothing unless called with at least one arg
[ $# -gt 0 ] || return
local original_widget_name=$1
shift
if [ $widgets[$original_widget_name] ]; then if [ $widgets[$original_widget_name] ]; then
zle $original_widget_name zle $original_widget_name -- $@
fi fi
} }

View File

@@ -1,7 +1,7 @@
#--------------------------------# #--------------------------------------------------------------------#
# Global Configuration Variables # # Global Configuration Variables #
#--------------------------------# #--------------------------------------------------------------------#
# Color to use when highlighting suggestion # Color to use when highlighting suggestion
# Uses format of `region_highlight` # Uses format of `region_highlight`
@@ -22,27 +22,6 @@ ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
accept-line accept-line
) )
# Widgets that modify the suggestion
ZSH_AUTOSUGGEST_MODIFY_WIDGETS=(
list-choices
complete-word
menu-complete
menu-expand-or-complete
reverse-menu-complete
expand-or-complete
expand-or-complete-prefix
self-insert
magic-space
bracketed-paste
expand-cmd-path
accept-and-menu-complete
backward-delete-char
vi-backward-delete-char
delete-char
vi-delete-char
delete-char-or-list
)
# Widgets that accept the entire suggestion # Widgets that accept the entire suggestion
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=( ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
forward-char forward-char

View File

@@ -1,9 +1,11 @@
#-------------------------------------# #--------------------------------------------------------------------#
# Handle Deprecated Variables/Widgets # # Handle Deprecated Variables/Widgets #
#-------------------------------------# #--------------------------------------------------------------------#
unset _ZSH_AUTOSUGGEST_DEPRECATED_START_WIDGET_WARNING_SHOWN _zsh_autosuggest_deprecated_warning() {
>&2 echo "zsh-autosuggestions: $@"
}
_zsh_autosuggest_check_deprecated_config() { _zsh_autosuggest_check_deprecated_config() {
if [ -n "$AUTOSUGGESTION_HIGHLIGHT_COLOR" ]; then if [ -n "$AUTOSUGGESTION_HIGHLIGHT_COLOR" ]; then
@@ -23,17 +25,12 @@ _zsh_autosuggest_check_deprecated_config() {
fi fi
} }
_zsh_autosuggest_deprecated_warning() {
>&2 echo "zsh-autosuggestions: $@"
}
_zsh_autosuggest_deprecated_start_widget() { _zsh_autosuggest_deprecated_start_widget() {
if [ -z "$_ZSH_AUTOSUGGEST_DEPRECATED_START_WIDGET_WARNING_SHOWN" ]; then _zsh_autosuggest_deprecated_warning "The autosuggest-start widget is deprecated. For more info, see the README at https://github.com/tarruda/zsh-autosuggestions."
_zsh_autosuggest_deprecated_warning "The autosuggest-start widget is deprecated. Use the autosuggest_start function instead. For more info, see README at https://github.com/tarruda/zsh-autosuggestions." zle -D autosuggest-start
_ZSH_AUTOSUGGEST_DEPRECATED_START_WIDGET_WARNING_SHOWN=true eval "zle-line-init() {
fi $(echo $functions[${widgets[zle-line-init]#*:}] | sed -e 's/zle autosuggest-start//g')
}"
autosuggest_start
} }
zle -N autosuggest-start _zsh_autosuggest_deprecated_start_widget zle -N autosuggest-start _zsh_autosuggest_deprecated_start_widget

View File

@@ -1,7 +1,7 @@
#--------------# #--------------------------------------------------------------------#
# Highlighting # # Highlighting #
#--------------# #--------------------------------------------------------------------#
# If there was a highlight, remove it # If there was a highlight, remove it
_zsh_autosuggest_highlight_reset() { _zsh_autosuggest_highlight_reset() {

View File

@@ -1,7 +1,7 @@
#-------# #--------------------------------------------------------------------#
# Start # # Start #
#-------# #--------------------------------------------------------------------#
# Start the autosuggestion widgets # Start the autosuggestion widgets
_zsh_autosuggest_start() { _zsh_autosuggest_start() {

View File

@@ -1,19 +1,23 @@
#------------# #--------------------------------------------------------------------#
# Suggestion # # Suggestion #
#------------# #--------------------------------------------------------------------#
# Get a suggestion from history that matches a given prefix # Get a suggestion from history that matches a given prefix
_zsh_autosuggest_suggestion() { _zsh_autosuggest_suggestion() {
setopt localoptions extendedglob local prefix=$(_zsh_autosuggest_escape_command_prefix "$1")
# Escape the prefix (requires EXTENDED_GLOB)
local prefix=${1//(#m)[\][()|\\*?#<>~^]/\\$MATCH}
# Get all history items (reversed) that match pattern $prefix* # Get all history items (reversed) that match pattern $prefix*
local history_matches local history_matches
history_matches=(${history[(R)$prefix*]}) history_matches=(${(j:\0:s:\0:)history[(R)$prefix*]})
# Echo the first item that matches # Echo the first item that matches
echo ${history_matches[1]} echo -E "$history_matches[1]"
}
_zsh_autosuggest_escape_command_prefix() {
setopt localoptions EXTENDED_GLOB
# Escape special chars in the string (requires EXTENDED_GLOB)
echo -E "${1//(#m)[\\()\[\]|*?]/\\$MATCH}"
} }

View File

@@ -1,25 +1,25 @@
#------------------------------------# #--------------------------------------------------------------------#
# Autosuggest Widget Implementations # # Autosuggest Widget Implementations #
#------------------------------------# #--------------------------------------------------------------------#
# Clear the suggestion # Clear the suggestion
_zsh_autosuggest_clear() { _zsh_autosuggest_clear() {
# Remove the suggestion # Remove the suggestion
unset POSTDISPLAY unset POSTDISPLAY
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
} }
# Modify the buffer and get a new suggestion # Modify the buffer and get a new suggestion
_zsh_autosuggest_modify() { _zsh_autosuggest_modify() {
# Original widget modifies the buffer # Original widget modifies the buffer
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
# Get a new suggestion if the buffer is not empty after modification # Get a new suggestion if the buffer is not empty after modification
local suggestion local suggestion
if [ $#BUFFER -gt 0 ]; then if [ $#BUFFER -gt 0 ]; then
suggestion=$(_zsh_autosuggest_suggestion $BUFFER) suggestion=$(_zsh_autosuggest_suggestion "$BUFFER")
fi fi
# Add the suggestion to the POSTDISPLAY # Add the suggestion to the POSTDISPLAY
@@ -44,7 +44,7 @@ _zsh_autosuggest_accept() {
CURSOR=${#BUFFER} CURSOR=${#BUFFER}
fi fi
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
} }
# Partially accept the suggestion # Partially accept the suggestion
@@ -56,7 +56,7 @@ _zsh_autosuggest_partial_accept() {
BUFFER="$BUFFER$POSTDISPLAY" BUFFER="$BUFFER$POSTDISPLAY"
# Original widget moves the cursor # Original widget moves the cursor
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
# If we've moved past the end of the original buffer # If we've moved past the end of the original buffer
if [ $CURSOR -gt $#original_buffer ]; then if [ $CURSOR -gt $#original_buffer ]; then
@@ -71,17 +71,13 @@ _zsh_autosuggest_partial_accept() {
fi fi
} }
_zsh_autosuggest_widget_accept() { for action in clear modify accept partial_accept; do
_zsh_autosuggest_highlight_reset eval "_zsh_autosuggest_widget_$action() {
_zsh_autosuggest_accept _zsh_autosuggest_highlight_reset
_zsh_autosuggest_highlight_apply _zsh_autosuggest_$action \$@
} _zsh_autosuggest_highlight_apply
}"
_zsh_autosuggest_widget_clear() { done
_zsh_autosuggest_highlight_reset
_zsh_autosuggest_clear
_zsh_autosuggest_highlight_apply
}
zle -N autosuggest-accept _zsh_autosuggest_widget_accept zle -N autosuggest-accept _zsh_autosuggest_widget_accept
zle -N autosuggest-clear _zsh_autosuggest_widget_clear zle -N autosuggest-clear _zsh_autosuggest_widget_clear

419
test/stub-1.0.2.sh Normal file
View File

@@ -0,0 +1,419 @@
# !/usr/bin/env bash
#
# stub.sh 1.0.2 - stubbing helpers for simplifying bash script tests.
# https://github.com/jimeh/stub.sh
#
# (The MIT License)
#
# Copyright (c) 2014 Jim Myhrberg.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# Public: Stub given command.
#
# Arguments:
# - $1: Name of command to stub.
# - $2: (optional) When set to "STDOUT", echo a default message to STDOUT.
# When set to "STDERR", echo default message to STDERR.
#
# Echoes nothing.
# Returns nothing.
stub() {
local redirect="null"
if [ "$2" = "stdout" ] || [ "$2" = "STDOUT" ]; then redirect=""; fi
if [ "$2" = "stderr" ] || [ "$2" = "STDERR" ]; then redirect="stderr"; fi
stub_and_echo "$1" "$1 stub: \$@" "$redirect"
}
# Public: Stub given command, and echo given string.
#
# Arguments:
# - $1: Name of command to stub.
# - $2: String to echo when stub is called.
# - $3: (optional) When set to "STDERR", echo to STDERR instead of STDOUT.
# When set to "null", all output is redirected to /dev/null.
#
# Echoes nothing.
# Returns nothing.
stub_and_echo() {
local redirect=""
if [ "$3" = "stderr" ] || [ "$3" = "STDERR" ]; then redirect=" 1>&2"; fi
if [ "$3" = "null" ]; then redirect=" &>/dev/null"; fi
stub_and_eval "$1" "echo \"$2\"$redirect"
}
# Public: Stub given command, and execute given string with eval.
#
# Arguments:
# - $1: Name of command to stub.
# - $2: String to eval when stub is called.
#
# Echoes nothing.
# Returns nothing.
stub_and_eval() {
local cmd="$1"
# Setup empty list of active stubs.
if [ -z "$STUB_ACTIVE_STUBS" ]; then STUB_ACTIVE_STUBS=(); fi
# If stubbing a function, store non-stubbed copy of it required for restore.
if [ -n "$(command -v "$cmd")" ]; then
if [ -z "$(command -v "non_stubbed_${cmd}")" ]; then
if [[ "$(type "$cmd" | head -1)" == *"is a function" ]]; then
local source="$(type "$cmd" | tail -n +2)"
source="${source/$cmd/non_stubbed_${cmd}}"
eval "$source"
fi
fi
fi
# Prepare stub index and call list for this stub.
__stub_register "$cmd"
# Keep track of what is currently stubbed to ensure restore only acts on
# actual stubs.
if [[ " ${STUB_ACTIVE_STUBS[@]} " != *" $cmd "* ]]; then
STUB_ACTIVE_STUBS+=("$cmd")
fi
# Create the stub.
eval "$( printf "%s" "${cmd}() { __stub_call \"${cmd}\" \$@; $2;}")"
}
# Public: Find out if stub has been called. Returns 0 if yes, 1 if no.
#
# Arguments:
# - $1: Name of stubbed command.
#
# Echoes nothing.
# Returns 0 (success) is stub has been called, 1 (error) otherwise.
stub_called() {
if [ "$(stub_called_times "$1")" -lt 1 ]; then
return 1
fi
}
# Public: Find out if stub has been called with specific arguments.
#
# Arguments:
# - $1: Name of stubbed command.
# - $@: Any/all additional arguments are used to specify what stub was
# called with.
#
# Examples:
# stub uname
# uname
# uname -r -a
# stub_called_with uname # Returns 0 (success).
# stub_called_with uname -r # Returns 1 (error).
# stub_called_with uname -r -a # Returns 0 (success).
#
# Echoes nothing.
# Returns 0 (success) if specified stub has been called with given arguments,
# otherwise returns 1 (error).
stub_called_with() {
local cmd="$1"
shift 1
if [ "$(stub_called_with_times "$cmd" $@)" -lt 1 ]; then
return 1
fi
}
# Public: Find out how many times a stub has been called.
#
# Arguments:
# - $1: Name of stubbed command.
#
# Echoes number of times stub has been called if $2 is not given, otherwise
# echoes nothing.
# Returns 0 (success) if $2 is not given, or if it is given and it matches the
# number of times the stub has been called. Otherwise 1 (error) is returned if
# it doesn't match..
stub_called_times() {
local cmd="$1"
local index="$(__stub_index "$1")"
local count=0
if [ -n "$index" ]; then
eval "count=\"\${#STUB_${index}_CALLS[@]}\""
fi
echo $count
}
# Public: Find out if stub has been called exactly the given number of times
# with specified arguments.
#
# Arguments:
# - $1: Name of stubbed command.
# - $2: Exact number of times stub has been called.
#
# Echoes nothing.
# Returns 0 (success) if stub has been called at least the given number of
# times with specified arguments, otherwise 1 (error) is returned.
stub_called_exactly_times() {
if [ "$(stub_called_times "$1")" != "$2" ]; then
return 1
fi
}
# Public: Find out if stub has been called at least the given number of times.
#
# Arguments:
# - $1: Name of stubbed command.
# - $2: Minimum required number of times stub has been called.
#
# Echoes nothing.
# Returns 0 (success) if stub has been called at least the given number of
# times, otherwise 1 (error) is returned.
stub_called_at_least_times() {
if [ "$(stub_called_times "$1")" -lt "$2" ]; then
return 1
fi
}
# Public: Find out if stub has been called no more than the given number of
# times.
#
# Arguments:
# - $1: Name of stubbed command.
# - $2: Maximum allowed number of times stub has been called.
#
# Echoes nothing.
# Returns 0 (success) if stub has been called no more than the given number of
# times, otherwise 1 (error) is returned.
stub_called_at_most_times() {
if [ "$(stub_called_times "$1")" -gt "$2" ]; then
return 1
fi
}
# Public: Find out how many times a stub has been called with specific
# arguments.
#
# Arguments:
# - $1: Name of stubbed command.
# - $@: Any/all additional arguments are used to specify what stub was
# called with.
#
# Echoes number of times stub has been called with given arguments.
# Return 0 (success).
stub_called_with_times() {
local cmd="$1"
shift 1
local args="$@"
if [ "$args" = "" ]; then args="<none>"; fi
local count=0
local index="$(__stub_index "$cmd")"
if [ -n "$index" ]; then
eval "local calls=(\"\${STUB_${index}_CALLS[@]}\")"
for call in "${calls[@]}"; do
if [ "$call" = "$args" ]; then ((count++)); fi
done
fi
echo $count
}
# Public: Find out if stub has been called exactly the given number of times
# with specified arguments.
#
# Arguments:
# - $1: Name of stubbed command.
# - $2: Exact number of times stub has been called.
# - $@: Any/all additional arguments are used to specify what stub was
# called with.
#
# Echoes nothing.
# Returns 0 (success) if stub has been called at least the given number of
# times with specified arguments, otherwise 1 (error) is returned.
stub_called_with_exactly_times() {
local cmd="$1"
local count="$2"
shift 2
if [ "$(stub_called_with_times "$cmd" $@)" != "$count" ]; then
return 1
fi
}
# Public: Find out if stub has been called at least the given number of times
# with specified arguments.
#
# Arguments:
# - $1: Name of stubbed command.
# - $2: Minimum required number of times stub has been called.
# - $@: Any/all additional arguments are used to specify what stub was
# called with.
#
# Echoes nothing.
# Returns 0 (success) if stub has been called at least the given number of
# times with specified arguments, otherwise 1 (error) is returned.
stub_called_with_at_least_times() {
local cmd="$1"
local count="$2"
shift 2
if [ "$(stub_called_with_times "$cmd" $@)" -lt "$count" ]; then
return 1
fi
}
# Public: Find out if stub has been called no more than the given number of
# times.
#
# Arguments:
# - $1: Name of stubbed command.
# - $2: Maximum allowed number of times stub has been called.
# - $@: Any/all additional arguments are used to specify what stub was
# called with.
#
# Echoes nothing.
# Returns 0 (success) if stub has been called no more than the given number of
# times with specified arguments, otherwise 1 (error) is returned.
stub_called_with_at_most_times() {
local cmd="$1"
local count="$2"
shift 2
if [ "$(stub_called_with_times "$cmd" $@)" -gt "$count" ]; then
return 1
fi
}
# Public: Restore the original command/function that was stubbed.
#
# Arguments:
# - $1: Name of command to restore.
#
# Echoes nothing.
# Returns nothing.
restore() {
local cmd="$1"
# Don't do anything if the command isn't currently stubbed.
if [[ " ${STUB_ACTIVE_STUBS[@]} " != *" $1 "* ]]; then
return 0
fi
# Remove stub functions.
unset -f "$cmd"
# Remove stub from list of active stubs.
STUB_ACTIVE_STUBS=(${STUB_ACTIVE_STUBS[@]/$cmd/})
# If stub was for a function, restore the original function.
if type "non_stubbed_${cmd}" &>/dev/null; then
local original_type="$(type "non_stubbed_${cmd}" | head -1)"
if [[ "$original_type" == *"is a function" ]]; then
local source="$(type "non_stubbed_$cmd" | tail -n +2)"
source="${source/non_stubbed_${cmd}/$cmd}"
eval "$source"
unset -f "non_stubbed_${cmd}"
fi
fi
}
#
# Internal functions
#
# Private: Used to keep track of which stubs have been called and how many
# times.
__stub_call() {
local cmd="$1"
shift 1
local args="$@"
if [ "$args" = "" ]; then args="<none>"; fi
local index="$(__stub_index "$cmd")"
if [ -n "$index" ]; then
eval "STUB_${index}_CALLS+=(\"\$args\")"
fi
}
# Private: Get index value of stub. Required to access list of stub calls.
__stub_index() {
local cmd="$1"
for item in ${STUB_INDEX[@]}; do
if [[ "$item" = "${cmd}="* ]]; then
local index="$item"
index="${index/${cmd}=/}"
echo "$index"
fi
done
}
# Private: Prepare for the creation of a new stub. Adds stub to index and
# sets up an empty call list.
__stub_register() {
local cmd="$1"
if [ -z "$STUB_NEXT_INDEX" ]; then STUB_NEXT_INDEX=0; fi
if [ -z "$STUB_INDEX" ]; then STUB_INDEX=(); fi
# Clean up after any previous stub for the same command.
__stub_clean "$cmd"
# Add stub to index.
STUB_INDEX+=("${cmd}=${STUB_NEXT_INDEX}")
eval "STUB_${STUB_NEXT_INDEX}_CALLS=()"
# Increment stub count.
((STUB_NEXT_INDEX++))
}
# Private: Cleans out and removes a stub's call list, and removes stub from
# index.
__stub_clean() {
local cmd="$1"
local index="$(__stub_index "$cmd")"
# Remove all relevant details from any previously existing stub for the same
# command.
if [ -n "$index" ]; then
eval "unset STUB_${index}_CALLS"
STUB_INDEX=(${STUB_INDEX[@]/${cmd}=*/})
fi
}

View File

@@ -1,6 +1,6 @@
# Fish-like fast/unobtrusive autosuggestions for zsh. # Fish-like fast/unobtrusive autosuggestions for zsh.
# https://github.com/tarruda/zsh-autosuggestions # https://github.com/tarruda/zsh-autosuggestions
# v0.2.0 # v0.2.14
# Copyright (c) 2013 Thiago de Arruda # Copyright (c) 2013 Thiago de Arruda
# Copyright (c) 2016 Eric Freese # Copyright (c) 2016 Eric Freese
# #
@@ -25,9 +25,9 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE. # OTHER DEALINGS IN THE SOFTWARE.
#--------------------------------# #--------------------------------------------------------------------#
# Global Configuration Variables # # Global Configuration Variables #
#--------------------------------# #--------------------------------------------------------------------#
# Color to use when highlighting suggestion # Color to use when highlighting suggestion
# Uses format of `region_highlight` # Uses format of `region_highlight`
@@ -48,27 +48,6 @@ ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
accept-line accept-line
) )
# Widgets that modify the suggestion
ZSH_AUTOSUGGEST_MODIFY_WIDGETS=(
list-choices
complete-word
menu-complete
menu-expand-or-complete
reverse-menu-complete
expand-or-complete
expand-or-complete-prefix
self-insert
magic-space
bracketed-paste
expand-cmd-path
accept-and-menu-complete
backward-delete-char
vi-backward-delete-char
delete-char
vi-delete-char
delete-char-or-list
)
# Widgets that accept the entire suggestion # Widgets that accept the entire suggestion
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=( ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
forward-char forward-char
@@ -86,11 +65,13 @@ ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
vi-forward-blank-word-end vi-forward-blank-word-end
) )
#-------------------------------------# #--------------------------------------------------------------------#
# Handle Deprecated Variables/Widgets # # Handle Deprecated Variables/Widgets #
#-------------------------------------# #--------------------------------------------------------------------#
unset _ZSH_AUTOSUGGEST_DEPRECATED_START_WIDGET_WARNING_SHOWN _zsh_autosuggest_deprecated_warning() {
>&2 echo "zsh-autosuggestions: $@"
}
_zsh_autosuggest_check_deprecated_config() { _zsh_autosuggest_check_deprecated_config() {
if [ -n "$AUTOSUGGESTION_HIGHLIGHT_COLOR" ]; then if [ -n "$AUTOSUGGESTION_HIGHLIGHT_COLOR" ]; then
@@ -110,32 +91,27 @@ _zsh_autosuggest_check_deprecated_config() {
fi fi
} }
_zsh_autosuggest_deprecated_warning() {
>&2 echo "zsh-autosuggestions: $@"
}
_zsh_autosuggest_deprecated_start_widget() { _zsh_autosuggest_deprecated_start_widget() {
if [ -z "$_ZSH_AUTOSUGGEST_DEPRECATED_START_WIDGET_WARNING_SHOWN" ]; then _zsh_autosuggest_deprecated_warning "The autosuggest-start widget is deprecated. For more info, see the README at https://github.com/tarruda/zsh-autosuggestions."
_zsh_autosuggest_deprecated_warning "The autosuggest-start widget is deprecated. Use the autosuggest_start function instead. For more info, see README at https://github.com/tarruda/zsh-autosuggestions." zle -D autosuggest-start
_ZSH_AUTOSUGGEST_DEPRECATED_START_WIDGET_WARNING_SHOWN=true eval "zle-line-init() {
fi $(echo $functions[${widgets[zle-line-init]#*:}] | sed -e 's/zle autosuggest-start//g')
}"
autosuggest_start
} }
zle -N autosuggest-start _zsh_autosuggest_deprecated_start_widget zle -N autosuggest-start _zsh_autosuggest_deprecated_start_widget
#----------------# #--------------------------------------------------------------------#
# Widget Helpers # # Widget Helpers #
#----------------# #--------------------------------------------------------------------#
# Bind a single widget to an autosuggest widget, saving a reference to the original widget # Bind a single widget to an autosuggest widget, saving a reference to the original widget
_zsh_autosuggest_bind_widget() { _zsh_autosuggest_bind_widget() {
local widget=$1 local widget=$1
local autosuggest_function=$2 local autosuggest_action=$2
local prefix=$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX local prefix=$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX
local action
# Save a reference to the original widget
case $widgets[$widget] in case $widgets[$widget] in
# Already bound # Already bound
user:_zsh_autosuggest_(bound|orig)_*);; user:_zsh_autosuggest_(bound|orig)_*);;
@@ -157,19 +133,14 @@ _zsh_autosuggest_bind_widget() {
;; ;;
esac esac
# Set up widget to call $autosuggest_function if it exists # Pass the original widget's name explicitly into the autosuggest
# Otherwise just call the original widget # function. Use this passed in widget name to call the original
if [ -n "$autosuggest_function" ]; then; # widget instead of relying on the $WIDGET variable being set
action=$autosuggest_function; # correctly. $WIDGET cannot be trusted because other plugins call
else; # zle without the `-w` flag (e.g. `zle self-insert` instead of
action="zle $prefix$widget \$@" # `zle self-insert -w`).
fi
# Create new function for the widget that highlights and calls the action
eval "_zsh_autosuggest_bound_$widget() { eval "_zsh_autosuggest_bound_$widget() {
_zsh_autosuggest_highlight_reset _zsh_autosuggest_widget_$autosuggest_action $prefix$widget \$@
$action
_zsh_autosuggest_highlight_apply
}" }"
# Create the bound widget # Create the bound widget
@@ -181,33 +152,37 @@ _zsh_autosuggest_bind_widgets() {
local widget; local widget;
# Find every widget we might want to bind and bind it appropriately # Find every widget we might want to bind and bind it appropriately
for widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|autosuggest-*|$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX*|run-help|which-command|beep|set-local-history|yank)}; do for widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|autosuggest-*|$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX*|zle-line-*|run-help|which-command|beep|set-local-history|yank)}; do
if [ ${ZSH_AUTOSUGGEST_MODIFY_WIDGETS[(r)$widget]} ]; then if [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_modify _zsh_autosuggest_bind_widget $widget clear
elif [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_clear
elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_accept _zsh_autosuggest_bind_widget $widget accept
elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then
_zsh_autosuggest_bind_widget $widget _zsh_autosuggest_partial_accept _zsh_autosuggest_bind_widget $widget partial_accept
else else
_zsh_autosuggest_bind_widget $widget # Assume any unspecified widget might modify the buffer
_zsh_autosuggest_bind_widget $widget modify
fi fi
done done
} }
# Given the name of a widget, invoke the original we saved, if it exists # Given the name of an original widget and args, invoke it, if it exists
_zsh_autosuggest_invoke_original_widget() { _zsh_autosuggest_invoke_original_widget() {
local original_widget_name="$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX$1" # Do nothing unless called with at least one arg
[ $# -gt 0 ] || return
local original_widget_name=$1
shift
if [ $widgets[$original_widget_name] ]; then if [ $widgets[$original_widget_name] ]; then
zle $original_widget_name zle $original_widget_name -- $@
fi fi
} }
#--------------# #--------------------------------------------------------------------#
# Highlighting # # Highlighting #
#--------------# #--------------------------------------------------------------------#
# If there was a highlight, remove it # If there was a highlight, remove it
_zsh_autosuggest_highlight_reset() { _zsh_autosuggest_highlight_reset() {
@@ -227,27 +202,27 @@ _zsh_autosuggest_highlight_apply() {
fi fi
} }
#------------------------------------# #--------------------------------------------------------------------#
# Autosuggest Widget Implementations # # Autosuggest Widget Implementations #
#------------------------------------# #--------------------------------------------------------------------#
# Clear the suggestion # Clear the suggestion
_zsh_autosuggest_clear() { _zsh_autosuggest_clear() {
# Remove the suggestion # Remove the suggestion
unset POSTDISPLAY unset POSTDISPLAY
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
} }
# Modify the buffer and get a new suggestion # Modify the buffer and get a new suggestion
_zsh_autosuggest_modify() { _zsh_autosuggest_modify() {
# Original widget modifies the buffer # Original widget modifies the buffer
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
# Get a new suggestion if the buffer is not empty after modification # Get a new suggestion if the buffer is not empty after modification
local suggestion local suggestion
if [ $#BUFFER -gt 0 ]; then if [ $#BUFFER -gt 0 ]; then
suggestion=$(_zsh_autosuggest_suggestion $BUFFER) suggestion=$(_zsh_autosuggest_suggestion "$BUFFER")
fi fi
# Add the suggestion to the POSTDISPLAY # Add the suggestion to the POSTDISPLAY
@@ -272,7 +247,7 @@ _zsh_autosuggest_accept() {
CURSOR=${#BUFFER} CURSOR=${#BUFFER}
fi fi
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
} }
# Partially accept the suggestion # Partially accept the suggestion
@@ -284,7 +259,7 @@ _zsh_autosuggest_partial_accept() {
BUFFER="$BUFFER$POSTDISPLAY" BUFFER="$BUFFER$POSTDISPLAY"
# Original widget moves the cursor # Original widget moves the cursor
_zsh_autosuggest_invoke_original_widget $WIDGET _zsh_autosuggest_invoke_original_widget $@
# If we've moved past the end of the original buffer # If we've moved past the end of the original buffer
if [ $CURSOR -gt $#original_buffer ]; then if [ $CURSOR -gt $#original_buffer ]; then
@@ -299,43 +274,43 @@ _zsh_autosuggest_partial_accept() {
fi fi
} }
_zsh_autosuggest_widget_accept() { for action in clear modify accept partial_accept; do
_zsh_autosuggest_highlight_reset eval "_zsh_autosuggest_widget_$action() {
_zsh_autosuggest_accept _zsh_autosuggest_highlight_reset
_zsh_autosuggest_highlight_apply _zsh_autosuggest_$action \$@
} _zsh_autosuggest_highlight_apply
}"
_zsh_autosuggest_widget_clear() { done
_zsh_autosuggest_highlight_reset
_zsh_autosuggest_clear
_zsh_autosuggest_highlight_apply
}
zle -N autosuggest-accept _zsh_autosuggest_widget_accept zle -N autosuggest-accept _zsh_autosuggest_widget_accept
zle -N autosuggest-clear _zsh_autosuggest_widget_clear zle -N autosuggest-clear _zsh_autosuggest_widget_clear
#------------# #--------------------------------------------------------------------#
# Suggestion # # Suggestion #
#------------# #--------------------------------------------------------------------#
# Get a suggestion from history that matches a given prefix # Get a suggestion from history that matches a given prefix
_zsh_autosuggest_suggestion() { _zsh_autosuggest_suggestion() {
setopt localoptions extendedglob local prefix=$(_zsh_autosuggest_escape_command_prefix "$1")
# Escape the prefix (requires EXTENDED_GLOB)
local prefix=${1//(#m)[\][()|\\*?#<>~^]/\\$MATCH}
# Get all history items (reversed) that match pattern $prefix* # Get all history items (reversed) that match pattern $prefix*
local history_matches local history_matches
history_matches=(${history[(R)$prefix*]}) history_matches=(${(j:\0:s:\0:)history[(R)$prefix*]})
# Echo the first item that matches # Echo the first item that matches
echo ${history_matches[1]} echo -E "$history_matches[1]"
} }
#-------# _zsh_autosuggest_escape_command_prefix() {
# Start # setopt localoptions EXTENDED_GLOB
#-------#
# Escape special chars in the string (requires EXTENDED_GLOB)
echo -E "${1//(#m)[\\()\[\]|*?]/\\$MATCH}"
}
#--------------------------------------------------------------------#
# Start #
#--------------------------------------------------------------------#
# Start the autosuggestion widgets # Start the autosuggestion widgets
_zsh_autosuggest_start() { _zsh_autosuggest_start() {