diff options
author | Josh Rahm <joshuarahm@gmail.com> | 2022-08-21 22:01:00 -0600 |
---|---|---|
committer | Josh Rahm <joshuarahm@gmail.com> | 2022-08-21 22:01:00 -0600 |
commit | 5b0e381a261b1450735f4eddac55aeb956c13713 (patch) | |
tree | c61f6f14f8b5dc9e2d2f8ed1f78f50179ae3b33a /test/functional/vimscript/api_functions_spec.lua | |
parent | d5cc161deac2371a39821c94fd2de4f1c41b6eb9 (diff) | |
download | rneovim-5b0e381a261b1450735f4eddac55aeb956c13713.tar.gz rneovim-5b0e381a261b1450735f4eddac55aeb956c13713.tar.bz2 rneovim-5b0e381a261b1450735f4eddac55aeb956c13713.zip |
feat(userreg): Add user-defined registers to Neovim.
This change unlocks additional registers for Neovim by allowing a user
to define their own behavior for non-builtin registers.
This is accopmlished through a new option 'userregfunc'
The 'userregfunc' defines the function to call when handling a register
for which there is no builtin functionality.
The 'userregfunc' function should take 3 arguments:
action - Either "yank" or "put"
register - The character corresponding to the register
content - In the case of action == "yank", the dictionary describing
the yanked content, with the following keys:
{type} - Either "char", "line" or "block"
{lines} - The lines being yanked as a list
{width} - The width in case of "block" mode.
{additional_data} - Additional data (can be returned in
"put" mode)
In case of "put" this function should return the content to put. This
content can be either:
* A dictionary in the same template as content above.
* A list of strings. This will be assumed to be "line" mode.
* A string. This will be assumed to be "char" mode.
An example of a "null" 'userregfunc' that provides an implementation
identical to traditional vim registers would be:
let s:contents = {}
function! MyUserregFunction(action, register, content) abort
if a:action == "put"
return get(s:contents, a:register, "")
else
let s:contents[a:register] = a:content
endif
endfunction
set userregfun=MyUserregFunction
It is important to note that any valid unicode character can now be a
register, including something like @☺.
This change also addresses the multibyte parsing issues surrounding
let @a = 'xyz'
let @🔨 = 'hammer'
Diffstat (limited to 'test/functional/vimscript/api_functions_spec.lua')
0 files changed, 0 insertions, 0 deletions