[vim/vim] feat: Add way to add clipboard providers (PR #17998)
Foxe Chen
Should fix #12419. Since we already have the clipmethod option now, a new value called provider is added, which uses the value of the option clipfunc to copy/paste.
The first argument of the function would take the type of operation:
'p' for paste
'y' for yank/copy
... maybe more
The second argument is a dictionary containing operation specific key/value pairs.
For the paste operation, the function would return a tuple: (<flags>, <contents>), where could be what motion type to use, if the clipboard is cleared/empty, and maybe more. <contents> is just what to paste. It is up to the function/plugin to determine what encoding to use, and what mime type to use if there are ones, but it should be text.
One use case for this is obviously implementing an OSC 52 plugin (Maybe OSC 5522 too?).
This might change, I'll see as I work on this PR.
You can view, comment on, or merge this pull request online at:
https://github.com/vim/vim/pull/17998
Commit Summary
- 4c4677e initial commit
File Changes
(6 files)
- M src/clipboard.c (142)
- M src/option.h (1)
- M src/optiondefs.h (9)
- M src/optionstr.c (2)
- M src/proto/clipboard.pro (1)
- M src/vim.h (1)
Patch Links:
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Phạm Bình An
brianhuster left a comment (vim/vim#17998)Just in case Nvim compatibility is considered, this is the document of g:clipboard, which I think is equivalent with 'clipfunc' that you propose. https://neovim.io/doc/user/provider.html#g:clipboard
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Foxe Chen
64-bitman left a comment (vim/vim#17998)Just in case Nvim compatibility is considered, this is the document of
g:clipboardin Nvim, which I think is equivalent with'clipfunc'that you propose. https://neovim.io/doc/user/provider.html#g:clipboard
Looking at it, maybe there could be a v:clipboard vim var that is a list of dictionaries (providers), each with a paste, copy, and a function that checks if the provider is available + a name for the provider. Then those names of the providers can be used in clipmethod. Don't know if that is just overcomplicated but sounds straightforward enough
—
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 4 commits.
- 3dcb4a9 initial commit
- 5677500 Revert "initial commit"
- f88b186 add configure feature
- 929ee9f use v:clipproviders
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- ad362fb use v:clipproviders
You are receiving this because you are subscribed to this thread.
Maxim Kim
habamax left a comment (vim/vim#17998)and a function that checks if the provider is available
If you do so, please don't query for executable existence as it may slowdown vim startup on windows. It is quite slow there.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Foxe Chen
64-bitman left a comment (vim/vim#17998)and a function that checks if the provider is available
If you do so, please don't query for executable existence as it may slowdown vim startup on windows. It is quite slow there. I remember this was the issue with neovim back in a day I tried to use it on my windows box.
Thanks, I will take that into consideration
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Foxe Chen
Foxe Chen
@64-bitman pushed 1 commit.
- e7c3825 add provider to clipboard callbacks
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 5717320 add provider to clipboard callbacks
You are receiving this because you are subscribed to this thread.
Foxe Chen
Foxe Chen
@64-bitman pushed 1 commit.
- 9e6d643 add provider to clipboard callbacks
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 2706acf add provider to clipboard callbacks
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- ae6a5b4 add provider to clipboard callbacks
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- dc1d3b8 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- a48cef7 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 7fea023 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 8739c72 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 00dbe4f add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- dd1ac4c add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 8cadd9e add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 22837db add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 7203a00 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- ae5f9ac add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 104eb4e add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 6ad16d4 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 361add4 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- bbcba4e add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
64-bitman left a comment (vim/vim#17998)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.
Foxe Chen
@64-bitman pushed 1 commit.
- 3215d95 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- cb51082 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- f9cadf1 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
h_east
@h-east commented on this pull request.
In src/testdir/test_clipboard_provider.vim:
> +
+ " Check if texlock is working
+ call assert_fails("call setline(1, 'test')", "E565:")
+endfunc
+
+" Test if 'paste' callback works properly
+func Test_clipboard_provider_cb_paste()
+ new
+ let v:clipproviders["test"] = {
+ \ "available": {-> v:true},
+ \ "paste": function("Paste")
+ \ }
+ set clipmethod=test
+
+ if has('unnamedplus')
+ call assert_equal("reg: +", getreg('+'))
CI error has occurred.
From test_codestyle.vim:
Found errors in Test_test_files():
command line..script /home/runner/work/vim/vim/src/testdir/runtest.vim[636]..function RunTheTest[63]..Test_test_files[33]..<SNR>8_ReportError line 2: testdir/test_clipboard_provider.vim line 74: trailing white space
make[2]: *** [Makefile:187: opt_test.vim] Error 1
- call assert_equal("reg: +", getreg('+'))
+ call assert_equal("reg: +", getreg('+'))
—
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.
- 600ddf3 add clipboard provider feature
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 3fb2efe add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 6abc567 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 41518e9 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 9dcffb4 add clipboard provider feature
You are receiving this because you are subscribed to this thread.
h_east
@h-east commented on this pull request.
> Note: "other" is used on systems without X11/Wayland, such as MS-Windows or MacOS, when running Vim without the GUI. + Note that the name of the clipboard provider should be used when you + want to use a clipboard provider. See |clipboard-providers| for more⬇️ Suggested change
- want to use a clipboard provider. See |clipboard-providers| for more + want to use a clipboard provider. See |clipboard-providers| for more
—
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.
- f2905d9 add clipboard provider feature
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 16374cf add clipboard provider feature
You are receiving this because you are subscribed to this thread.
Christian Brabandt
chrisbra left a comment (vim/vim#17998)can you please regenerate configure script on latest HEAD?
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Foxe Chen
64-bitman left a comment (vim/vim#17998)Turning this into a draft again for now because I've decided to go a different direction with the design
—
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 2 commits.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- de77622 copy and paste callbacks working
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- dd07a7c copy and paste callbacks working
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 7ef6b31 copy and paste callbacks working
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- d82089f refactor more code
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- ba719af fix bugs
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- a380b11 fix bugs
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- abcfde4 fix bugs
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 162cfc8 make paste callback use list of strings not a string
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 9969b15 remove error message
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 6e9c754 don't request selecioon when getting regtype
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 0 commits.
You are receiving this because you are subscribed to this thread.
Foxe Chen
@64-bitman pushed 1 commit.
- 7621d0f update docs, refactor
You are receiving this because you are subscribed to this thread.