xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update interfacing.asciidoc

Browse Source
This commit is contained in:
Maxime Coste 2015-05-07 13:42:58 +01:00
parent 449d835e8c
commit ecfb715145
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/interfacing.asciidoc
View File

@ -81,15 +81,23 @@ Completion candidates
Most of the time, filetype specific completion should be provided by Most of the time, filetype specific completion should be provided by
external programs. external programs.
external completions are provided using the +completions+ option, which external completions are provided using an option to store completion, which
have the following format. have the following format.
---- ----
line.column[+len]@timestamp:candidate1:candidate2:... line.column[+len]@timestamp:candidate1[@desc1]:candidate2[@desc2]:...
---- ----
the first element of this string list specify where and when this completions the first element of this string list specify where and when this completions
applies, the others are simply completion candidates. applies, the others are simply completion candidates, eventually containing
a descriptive text (after an `@` separator).
to effectively use that completion option, it should get added to the completers
option.
---
set -add buffer completers option=my_option_name
---
As a completion program may take some time to compute the candidates, it should As a completion program may take some time to compute the candidates, it should
run asynchronously. In order to do that, the following pattern may be used: run asynchronously. In order to do that, the following pattern may be used:
@ -98,6 +106,12 @@ run asynchronously. In order to do that, the following pattern may be used:
----- -----
# Declare the option which will store the temporary filename # Declare the option which will store the temporary filename
decl str plugin_filename decl str plugin_filename
# Declare the completion option
decl str plugin_completions
# Add plugin_completions to completers for files of good filetype
hook global BufSetOption filetype=my_filetype %{
set -add buff completers option=plugin_completions
}
%sh{ %sh{
# ask Kakoune to write current buffer to temporary file # ask Kakoune to write current buffer to temporary file
filename=$(mktemp -t kak-temp.XXXXXXXX) filename=$(mktemp -t kak-temp.XXXXXXXX)
@ -117,7 +131,7 @@ nop %sh{ ( # launch a detached shell
# generate completion option value # generate completion option value
completions="$line.$column@$kak_timestamp:$candidates" completions="$line.$column@$kak_timestamp:$candidates"
# write to Kakoune socket for the buffer that triggered the completion # write to Kakoune socket for the buffer that triggered the completion
echo "set buffer=${kak_bufname} completions '$completions'" | echo "set buffer=${kak_bufname} plugin_completions '$completions'" |
kak -p ${kak_session} kak -p ${kak_session}
) > /dev/null 2>&1 < /dev/null & } ) > /dev/null 2>&1 < /dev/null & }
----- -----