[vim/vim] Add new "custom" register (PR #18642)
Foxe Chen
This is based off of the now defunct clipboard provider feature. I've decided on "&" being the custom register, which can be controlled via the 'regputfunc' and 'regyankfunc' options. This is based in register.c, instead of clipboard.c, so it shouldn't break any clipboard code.
I didn't use the existing "+" or "*" registers since I think this and those registers should handle different things, instead of trying to fit them together. Also makes things a bit simpler
You can view, comment on, or merge this pull request online at:
https://github.com/vim/vim/pull/18642
Commit Summary
- 9f6338d initial commit
File Changes
(4 files)
- M src/option.h (2)
- M src/optiondefs.h (6)
- M src/proto/register.pro (1)
- M src/register.c (23)
Patch Links:
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- d12cdea add "&" register
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 0825a1c rename to 'regreqfunc' and 'regsetfunc'
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 13d64d5 handle 'regreqfunc'
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 3a4a86d handle 'regreqfunc'
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- a612b4c handle 'regreqfunc'
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- afe7e8b handle 'regreqfunc'
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 5df943b handle 'regsetfunc'
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 37c4f03 handle 'regsetfunc'
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 68c6791 don't save custom register in viminfo
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- facbbd4 don't save custom register in viminfo
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 2b05722 don't save custom register in viminfo
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- a655ef2 don't save custom register in viminfo
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 8f5730f don't save custom register in viminfo
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- a85528a don't save custom register in viminfo
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- f462aa6 don't save custom register in viminfo
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- dad8fca add docs
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 2f4f987 don't set reg after put
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- d6e9ab6 document how register type is automatically chosen
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 1f1eda0 fix segfault
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 863533a document that +eval feature is required
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 3e2b9d0 add tests
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 12 commits.
- 23786df initial commit
- caef59d add "&" register
- 0606ed0 rename to 'regreqfunc' and 'regsetfunc'
- 4b1ebf0 handle 'regreqfunc'
- 3ee6286 handle 'regsetfunc'
- 9a776d7 don't save custom register in viminfo
- eeb5c69 add docs
- 3f8315b don't set reg after put
- 403caf4 document how register type is automatically chosen
- 9e8834d fix segfault
- 49cd7fa document that +eval feature is required
- 91f23e8 add tests
You are receiving this because you are subscribed to this thread.
Foxe Chen
64-bitman left a comment (vim/vim#18642)I think this is ready
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
dkearns
@dkearns commented on this pull request.
Thanks. I just left a few comments after a quick read through the help.
> @@ -1401,6 +1402,15 @@ register. The search direction is available in |v:searchforward|. Note that the value is restored when returning from a function |function-search-undo|. +11. Custom register "& *quote_&* *quote&* +Acts like a numbered or named register, but when the register is yanked to,⬇️ Suggested change
-Acts like a numbered or named register, but when the register is yanked to, +Acts like a named register, but when writing to the register
- Numbered registers are different and I don't think mentioning them here adds anything.
- I'm not too keen on the existing language but "fill" seems to be the term used for setting a register value, though "write" is also used.
> @@ -1401,6 +1402,15 @@ register. The search direction is available in |v:searchforward|. Note that the value is restored when returning from a function |function-search-undo|. +11. Custom register "& *quote_&* *quote&* +Acts like a numbered or named register, but when the register is yanked to, +the callback specified in 'regsetfunc' is called, and when it is put, the⬇️ Suggested change
-the callback specified in 'regsetfunc' is called, and when it is put, the +the callback specified in 'regsetfunc' is called, and when it is read, the
> +specified (empty), then the register simply acts like another numbered or +named register. This register is not saved in the |viminfo| file and the⬇️ Suggested change
-specified (empty), then the register simply acts like another numbered or -named register. This register is not saved in the |viminfo| file and the +specified (empty), then the register simply acts like another +named register. This register is not saved in the |viminfo| file and the
> @@ -7033,6 +7033,64 @@ A jump table for the options with a short description can be found at |Q_op|. many states. This should prevent Vim from hanging on a combination of a complex pattern with long text. + *'regreqfunc* *'rrf'* +'regreqfunc' 'rrf' string (default "")
Shouldn't this be named 'reggetfunc'?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
dkearns
@dkearns commented on this pull request.
> @@ -7033,6 +7033,64 @@ A jump table for the options with a short description can be found at |Q_op|. many states. This should prevent Vim from hanging on a combination of a complex pattern with long text. + *'regreqfunc* *'rrf'*
- *'regreqfunc* *'rrf'* + *'regreqfunc'* *'rrf'*
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman commented on this pull request.
> @@ -7033,6 +7033,64 @@ A jump table for the options with a short description can be found at |Q_op|. many states. This should prevent Vim from hanging on a combination of a complex pattern with long text. + *'regreqfunc* *'rrf'* +'regreqfunc' 'rrf' string (default "")
In the clipboard source code Vim uses "request" as the keyword for accessing the clipboard, so I did the same for here
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
dkearns
@dkearns commented on this pull request.
> @@ -7033,6 +7033,64 @@ A jump table for the options with a short description can be found at |Q_op|. many states. This should prevent Vim from hanging on a combination of a complex pattern with long text. + *'regreqfunc* *'rrf'* +'regreqfunc' 'rrf' string (default "")
The feature isn't related to the clipboard anymore is it? Irrespective, I think it's more important to be consistent with setreg()/getreg() naming.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman commented on this pull request.
> @@ -7033,6 +7033,64 @@ A jump table for the options with a short description can be found at |Q_op|. many states. This should prevent Vim from hanging on a combination of a complex pattern with long text. + *'regreqfunc* *'rrf'* +'regreqfunc' 'rrf' string (default "")
I suppose so, I'll change it. thanks
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 0cba958 fix docs
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- ae792b8 fix docs
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 909b92b fix docs
You are receiving this because you are subscribed to this thread.
Foxe Chen
64-bitman left a comment (vim/vim#18642)I think this is ready
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
zeertzjq
@zeertzjq commented on this pull request.
> + set reggetfunc=GetFunc
+<
+ The value can be the name of a function, a |lambda| or a |Funcref|. See
+ |option-value-function| for more information.
+ This option cannot be set from a |modeline| or in the |sandbox|, for
+ security reasons.
+ Additionally it is not allowed to change the buffer
+ text in the function, see |textlock|.
+
+ *'regsetfunc* *'rsf'*
+'regsetfunc' 'rsf' string (default "")
+ global
+ {not available when compiled without the |+eval|
+ feature}
+ This option specifies a function to be used whenever the custom
+ register |quote_&| is written inclusing |setreg()|. The function
What is "inclusing"?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
zeertzjq
@zeertzjq commented on this pull request.
In src/register.c:
> +}
+
+/*
+ * Call the function specified in 'reggetfunc'. Should be called to update the
+ * custom register before being accessed.
+ */
+ static void
+call_reggetfunc(void)
+{
+ typval_T rettv;
+ typval_T argvars[1];
+ int ret;
+ char_u *reg_type;
+ list_T *lines;
+
+ // If 'reqreqfunc' option is empty, then do nothing and treat the register
⬇️ Suggested change
- // If 'reqreqfunc' option is empty, then do nothing and treat the register + // If 'reqgetfunc' option is empty, then do nothing and treat the register
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman commented on this pull request.
> + set reggetfunc=GetFunc
+<
+ The value can be the name of a function, a |lambda| or a |Funcref|. See
+ |option-value-function| for more information.
+ This option cannot be set from a |modeline| or in the |sandbox|, for
+ security reasons.
+ Additionally it is not allowed to change the buffer
+ text in the function, see |textlock|.
+
+ *'regsetfunc* *'rsf'*
+'regsetfunc' 'rsf' string (default "")
+ global
+ {not available when compiled without the |+eval|
+ feature}
+ This option specifies a function to be used whenever the custom
+ register |quote_&| is written inclusing |setreg()|. The function
typo
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 33d3a62 fix typos
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
zeertzjq
@zeertzjq commented on this pull request.
> + set reggetfunc=GetFunc
+<
+ The value can be the name of a function, a |lambda| or a |Funcref|. See
+ |option-value-function| for more information.
+ This option cannot be set from a |modeline| or in the |sandbox|, for
+ security reasons.
+ Additionally it is not allowed to change the buffer
+ text in the function, see |textlock|.
+
+ *'regsetfunc* *'rsf'*
+'regsetfunc' 'rsf' string (default "")
+ global
+ {not available when compiled without the |+eval|
+ feature}
+ This option specifies a function to be used whenever the custom
+ register |quote_&| is written including |setreg()|. The function
⬇️ Suggested change
- register |quote_&| is written including |setreg()|. The function + register |quote_&| is written including |setreg()|. The function
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 897c79a fix typos
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
zeertzjq
> + Additionally it is not allowed to change the buffer + text in the function, see |textlock|.⬇️ Suggested change
- Additionally it is not allowed to change the buffer - text in the function, see |textlock|. + Additionally it is not allowed to change the buffer text in the + function, see |textlock|.
> + Additionally it is not allowed to change the buffer + text in the function, see |textlock|.
- Additionally it is not allowed to change the buffer - text in the function, see |textlock|. + Additionally it is not allowed to change the buffer text in the + function, see |textlock|.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 0b94d1e fix typos
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 15 commits.
- 72d82e4 initial commit
- 6944357 add "&" register
- d4f595c rename to 'regreqfunc' and 'regsetfunc'
- e000aa1 handle 'regreqfunc'
- 982e210 handle 'regsetfunc'
- a56df20 don't save custom register in viminfo
- 0153762 add docs
- 629e83b don't set reg after put
- 254a4bf document how register type is automatically chosen
- d3e4e37 fix segfault
- 523f58f document that +eval feature is required
- 9a3dc52 add tests
- e8e385c fix docs
- 01359a5 fix typos
- 8dabf65 add ^ register
You are receiving this because you are subscribed to this thread.
Foxe Chen
64-bitman left a comment (vim/vim#18642)Made it so that there are two custom registers ("^" and "&"). Did this since OSC 52 supports multiple selections on X11/Wayland on some terminals.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
D. Ben Knoble
@benknoble commented on this pull request.
> + This options specifies a function to be used whenever the custom
+ registers |quote_&|, |quote_^| are read. The function takes no
+ arguments, and should return a |tuple| or |list| containing the
+ following elements in order:
+ 1. The register name.
+ 2. The register type, conforming to |setreg()|, that the
+ register will be set to.
+ 3. A |list| containing a list of strings to set the register
+ to.
+ Note that this function is not called on |:registers| or |:display|.
+
+ The following is a possible example use of this option:
+>vim
+ function GetFunc(reg)
+ echom "Updating register " .. a:reg
+ return ('l', readfile('stuff.txt'))
+ endfunction
+
+ set reggetfunc=GetFunc
I'm lost: how does reggetfunc know which register it's reading if it takes no argument? And yet the examples does… And why does the example only return 3 elements instead of 2? TIL that tuples are available in Vimscript, though.
It might help to see an actual use case for this.
In particular, why is that reading "& will mutate a different register? That seems… icky. I would prefer that reading it simply executes the callback and gives that value to whatever needs the register (a put or expression, presumably).
The docs seem to indicate that reading one of these will mutate another register, but that's not what happens at all. The docs really need to accurately describe the behavior, and a motivating use makes a much better example.
> + nothing and takes two arguments: + 1. The register name. + 2. The register type being used, conforming to |getregtype()|. + 3. A list of strings being written.
Similar counting comments, of course.
In src/register.c:
> + if ((long *)args->os_varp == (long *)&p_rgf) + ret = option_set_callback_func(p_rgf, &rgf_cb); + else + ret = option_set_callback_func(p_rsf, &rsf_cb);
nit: indentation looks inconsistent in changes here.
In src/structs.h:
> + #ifdef FEAT_DND -# define TILDE_REGISTER (PLUS_REGISTER + 1) +# define TILDE_REGISTER (PLUS_REGISTER + 1)
nit: unnecessary whitespace changes?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman commented on this pull request.
> + This options specifies a function to be used whenever the custom
+ registers |quote_&|, |quote_^| are read. The function takes no
+ arguments, and should return a |tuple| or |list| containing the
+ following elements in order:
+ 1. The register name.
+ 2. The register type, conforming to |setreg()|, that the
+ register will be set to.
+ 3. A |list| containing a list of strings to set the register
+ to.
+ Note that this function is not called on |:registers| or |:display|.
+
+ The following is a possible example use of this option:
+>vim
+ function GetFunc(reg)
+ echom "Updating register " .. a:reg
+ return ('l', readfile('stuff.txt'))
+ endfunction
+
+ set reggetfunc=GetFunc
I'm lost: how does
reggetfuncknow which register it's reading if it takes no argument? And yet the examples does… And why does the example only return 3 elements instead of 2? TIL that tuples are available in Vimscript, though.
I just messed up the documentation, I'll fix this later. Thanks for catching
The docs seem to indicate that reading one of these will mutate another register, but that's not what happens at all. The docs really need to accurately describe the behavior, and a motivating use makes a much better example.
I'm not sure what you mean by "mutate another register". If the "&yy is pressed, then it'll yank to the & register, same for the ^ register. I created this PR for the OSC52 feature, but from what ChatGPT said, there seems to be a bunch of other uses as well. I don't think we need to documentate it though, the user will find their way to this feature likely
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman commented on this pull request.
In src/register.c:
> + if ((long *)args->os_varp == (long *)&p_rgf) + ret = option_set_callback_func(p_rgf, &rgf_cb); + else + ret = option_set_callback_func(p_rsf, &rsf_cb);
I believe thats just Github doing weird things
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 15 commits.
- decea7a initial commit
- 6f8a6b8 add "&" register
- 6aec16a rename to 'regreqfunc' and 'regsetfunc'
- 156bfd7 handle 'regreqfunc'
- e806c49 handle 'regsetfunc'
- b4015d5 don't save custom register in viminfo
- a7d53f0 add docs
- 4beef0f don't set reg after put
- 22258e9 document how register type is automatically chosen
- cb1e8b5 fix segfault
- 1301ba3 document that +eval feature is required
- 2c7611d add tests
- 1eacc48 fix docs
- 7671f6f fix typos
- 31409a8 add ^ register
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 1a434aa add ^ register
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 7ccc329 add ^ register
You are receiving this because you are subscribed to this thread.
dkearns
dkearns left a comment (vim/vim#18642)I have not yet found the time to have a good look at this PR but I think that some considerable thought should be given to the names used for these registers before they're cast in stone.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.