Implement completion suggestion strategy (#111)
Based on https://github.com/Valodim/zsh-capture-completion `zpty -r` with a pattern seems to have some funky behavior on older versions, giving unpredictable results Don't use `-s` option to `zmodload`. It is not available in zsh versions older than 5.3 If running in sync mode and a completion takes a long time, the user can ^C out of it. We need to use `always` in the strategy function or the pty will not be destroyed in this case and the next time we go to create it, it will fail, making the shell unusable. User can have many different completion styles set that will modify what they've already typed. These styles will result in suggestions that don't match what the user has already typed. We try our best to unset some of the more problematic ones, but add some code to fetch to invalidate suggestions that don't match what the user's already typed.pull/401/head
Eric Freese
7 years ago
parent
937d6fc241
commit
c1910348c7
@ -0,0 +1,14 @@
|
|||||||
|
describe 'a running zpty command' do
|
||||||
|
let(:before_sourcing) { -> { session.run_command('zmodload zsh/zpty && zpty -b kitty cat') } }
|
||||||
|
|
||||||
|
context 'when using `completion` strategy' do
|
||||||
|
let(:options) { ["ZSH_AUTOSUGGEST_STRATEGY=completion"] }
|
||||||
|
|
||||||
|
it 'is not affected' do
|
||||||
|
session.send_keys('a').send_keys('C-h')
|
||||||
|
session.run_command('zpty -t kitty; echo $?')
|
||||||
|
|
||||||
|
wait_for { session.content }.to end_with("\n0")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@ -0,0 +1,26 @@
|
|||||||
|
describe 'the `completion` suggestion strategy' do
|
||||||
|
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=completion'] }
|
||||||
|
let(:before_sourcing) do
|
||||||
|
-> do
|
||||||
|
session.
|
||||||
|
run_command('autoload compinit && compinit').
|
||||||
|
run_command('_foo() { compadd bar }').
|
||||||
|
run_command('compdef _foo baz')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'suggests the first completion result' do
|
||||||
|
session.send_string('baz ')
|
||||||
|
wait_for { session.content }.to eq('baz bar')
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when async mode is enabled' do
|
||||||
|
let(:options) { ['ZSH_AUTOSUGGEST_USE_ASYNC=true', 'ZSH_AUTOSUGGEST_STRATEGY=completion'] }
|
||||||
|
|
||||||
|
it 'suggests the first completion result' do
|
||||||
|
session.send_string('baz ')
|
||||||
|
wait_for { session.content }.to eq('baz bar')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# Setup #
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
|
|
||||||
# Precmd hooks for initializing the library and starting pty's
|
|
||||||
autoload -Uz add-zsh-hook
|
|
||||||
|
|
||||||
# Asynchronous suggestions are generated in a pty
|
|
||||||
zmodload zsh/zpty
|
|
||||||
@ -0,0 +1,109 @@
|
|||||||
|
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# Completion Suggestion Strategy #
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# Fetches a suggestion from the completion engine
|
||||||
|
#
|
||||||
|
|
||||||
|
_zsh_autosuggest_capture_postcompletion() {
|
||||||
|
# Always insert the first completion into the buffer
|
||||||
|
compstate[insert]=1
|
||||||
|
|
||||||
|
# Don't list completions
|
||||||
|
unset compstate[list]
|
||||||
|
}
|
||||||
|
|
||||||
|
_zsh_autosuggest_capture_completion_widget() {
|
||||||
|
local -a +h comppostfuncs
|
||||||
|
comppostfuncs=(_zsh_autosuggest_capture_postcompletion)
|
||||||
|
|
||||||
|
# Only capture completions at the end of the buffer
|
||||||
|
CURSOR=$#BUFFER
|
||||||
|
|
||||||
|
# Run the original widget wrapping `.complete-word` so we don't
|
||||||
|
# recursively try to fetch suggestions, since our pty is forked
|
||||||
|
# after autosuggestions is initialized.
|
||||||
|
zle -- ${(k)widgets[(r)completion:.complete-word:_main_complete]}
|
||||||
|
|
||||||
|
# The completion has been added, print the buffer as the suggestion
|
||||||
|
echo -nE - $'\0'$BUFFER$'\0'
|
||||||
|
}
|
||||||
|
|
||||||
|
zle -N autosuggest-capture-completion _zsh_autosuggest_capture_completion_widget
|
||||||
|
|
||||||
|
_zsh_autosuggest_capture_setup() {
|
||||||
|
# There is a bug in zpty module in older zsh versions by which a
|
||||||
|
# zpty that exits will kill all zpty processes that were forked
|
||||||
|
# before it. Here we set up a zsh exit hook to SIGKILL the zpty
|
||||||
|
# process immediately, before it has a chance to kill any other
|
||||||
|
# zpty processes.
|
||||||
|
if ! is-at-least 5.4; then
|
||||||
|
zshexit() {
|
||||||
|
kill -KILL $$
|
||||||
|
sleep 1 # Block for long enough for the signal to come through
|
||||||
|
}
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Try to avoid any suggestions that wouldn't match the prefix
|
||||||
|
zstyle ':completion:*' matcher-list ''
|
||||||
|
zstyle ':completion:*' path-completion false
|
||||||
|
zstyle ':completion:*' max-errors 0 not-numeric
|
||||||
|
|
||||||
|
bindkey '^I' autosuggest-capture-completion
|
||||||
|
}
|
||||||
|
|
||||||
|
_zsh_autosuggest_capture_completion_sync() {
|
||||||
|
_zsh_autosuggest_capture_setup
|
||||||
|
|
||||||
|
zle autosuggest-capture-completion
|
||||||
|
}
|
||||||
|
|
||||||
|
_zsh_autosuggest_capture_completion_async() {
|
||||||
|
_zsh_autosuggest_capture_setup
|
||||||
|
|
||||||
|
zmodload zsh/parameter 2>/dev/null || return # For `$functions`
|
||||||
|
|
||||||
|
# Make vared completion work as if for a normal command line
|
||||||
|
# https://stackoverflow.com/a/7057118/154703
|
||||||
|
autoload +X _complete
|
||||||
|
functions[_original_complete]=$functions[_complete]
|
||||||
|
_complete () {
|
||||||
|
unset 'compstate[vared]'
|
||||||
|
_original_complete "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Open zle with buffer set so we can capture completions for it
|
||||||
|
vared 1
|
||||||
|
}
|
||||||
|
|
||||||
|
_zsh_autosuggest_strategy_completion() {
|
||||||
|
typeset -g suggestion
|
||||||
|
local line REPLY
|
||||||
|
|
||||||
|
# Exit if we don't have completions
|
||||||
|
whence compdef >/dev/null || return
|
||||||
|
|
||||||
|
# Exit if we don't have zpty
|
||||||
|
zmodload zsh/zpty 2>/dev/null || return
|
||||||
|
|
||||||
|
# Zle will be inactive if we are in async mode
|
||||||
|
if zle; then
|
||||||
|
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_sync
|
||||||
|
else
|
||||||
|
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_async "\$1"
|
||||||
|
zpty -w $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME $'\t'
|
||||||
|
fi
|
||||||
|
|
||||||
|
{
|
||||||
|
# The completion result is surrounded by null bytes, so read the
|
||||||
|
# content between the first two null bytes.
|
||||||
|
zpty -r $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME line '*'$'\0''*'$'\0'
|
||||||
|
|
||||||
|
# On older versions of zsh, we sometimes get extra bytes after the
|
||||||
|
# second null byte, so trim those off the end
|
||||||
|
suggestion="${${${(M)line:#*$'\0'*$'\0'*}#*$'\0'}%%$'\0'*}"
|
||||||
|
} always {
|
||||||
|
# Destroy the pty
|
||||||
|
zpty -d $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue