Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clipboard: Read channel id from nvim variable #1411

Merged
merged 1 commit into from Jul 22, 2022
Merged

Clipboard: Read channel id from nvim variable #1411

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 38 additions & 24 deletions src/bridge/setup.rs
View file
Open in desktop
Expand Up @@ -4,6 +4,38 @@ use rmpv::Value;

use crate::{bridge::TxWrapper, error_handling::ResultPanicExplanation};

const REGISTER_CLIPBOARD_PROVIDER_LUA: &str = r"
local function set_clipboard(register)
return function(lines, regtype)
vim.rpcnotify(
vim.g.neovide_channel_id,
'neovide.set_clipboard',
lines,
regtype,
register
)
end
end

local function get_clipboard(register)
return function()
return vim.rpcrequest(vim.g.neovide_channel_id, 'neovide.get_clipboard', register)
end
end

vim.g.clipboard = {
name = 'neovide',
copy = {
['+'] = set_clipboard('+'),
['*'] = set_clipboard('*'),
},
paste = {
['+'] = get_clipboard('+'),
['*'] = get_clipboard('*'),
},
cache_enabled = 0
}";

pub async fn setup_neovide_remote_clipboard(nvim: &Neovim<TxWrapper>, neovide_channel: u64) {
// users can opt-out with
// vim: `let g:neovide_no_custom_clipboard = v:true`
Expand All @@ -18,30 +50,12 @@ pub async fn setup_neovide_remote_clipboard(nvim: &Neovim<TxWrapper>, neovide_ch
return;
}

// don't know how to setup lambdas with Value, so use string as command
let custom_clipboard = r#"
let g:clipboard = {
'name': 'custom',
'copy': {
'+': {
lines,
regtype -> rpcnotify(neovide_channel, 'neovide.set_clipboard', lines, regtype, '+')
},
'*': {
lines,
regtype -> rpcnotify(neovide_channel, 'neovide.set_clipboard', lines, regtype, '*')
},
},
'paste': {
'+': {-> rpcrequest(neovide_channel, 'neovide.get_clipboard', '+')},
'*': {-> rpcrequest(neovide_channel, 'neovide.get_clipboard', '*')},
},
'cache_enabled': 0
}
"#
.replace('\n', "") // make one-liner, because multiline is not accepted (?)
.replace("neovide_channel", &neovide_channel.to_string());
nvim.command(&custom_clipboard).await.ok();
nvim.set_var("neovide_channel_id", Value::from(neovide_channel))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you set this var, shouldn't it be removed after executing the Lua code? Else someone could stumble across this and potentially rely on an outdated value.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, that won't work, since the variable is read whenever the + and * registers are accessed. Reading the channel from a variable allows us to use the same clipboard provider across multiple UI sessions.

Else someone could stumble across this and potentially rely on an outdated value.

A session has only one channel id in its lifetime, and the variable is updated whenever Neovide attaches to nvim, so this shouldn't be too much of an issue. (Unless the user starts multiple overlapping sessions, but we don't seem to support that at all).

While I'm generally strongly in favor of data encapsulation, having the channel id in a global variable makes debugging of channel issues a lot easier.

An alternative approach is to forcibly reload the clipboard provider whenever Neovide attaches to nvim. We might need something like that in order to fix #1331. This could also make it possible to mix different UI clients without breaking the clipboard. The drawbacks are that this seems like a hack, and it might break things for users who rely on the clipboard provider being loaded only once. I think the best approach is to make forcible reloading optional (can be disabled by setting a variable) and combining it with the present solution.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good idea, thanks for the extended explanation!

.await
.ok();
nvim.execute_lua(&REGISTER_CLIPBOARD_PROVIDER_LUA, vec![])
.await
.ok();
}

pub async fn setup_neovide_specific_state(nvim: &Neovim<TxWrapper>, is_remote: bool) {
Expand Down