diff options
Diffstat (limited to 'helix-view/src/clipboard.rs')
| -rw-r--r-- | helix-view/src/clipboard.rs | 172 |
1 files changed, 110 insertions, 62 deletions
diff --git a/helix-view/src/clipboard.rs b/helix-view/src/clipboard.rs index ad6f621a..19fade69 100644 --- a/helix-view/src/clipboard.rs +++ b/helix-view/src/clipboard.rs @@ -3,6 +3,7 @@ use anyhow::Result; use std::borrow::Cow; +#[derive(Clone, Copy, Debug)] pub enum ClipboardType { Clipboard, Selection, @@ -72,45 +73,48 @@ pub fn get_clipboard_provider() -> Box<dyn ClipboardProvider> { #[cfg(target_os = "macos")] pub fn get_clipboard_provider() -> Box<dyn ClipboardProvider> { - use provider::command::exists; + use crate::env::binary_exists; - if exists("pbcopy") && exists("pbpaste") { + if binary_exists("pbcopy") && binary_exists("pbpaste") { command_provider! { paste => "pbpaste"; copy => "pbcopy"; } } else { - Box::new(provider::NopProvider::new()) + Box::new(provider::FallbackProvider::new()) } } #[cfg(target_os = "wasm32")] pub fn get_clipboard_provider() -> Box<dyn ClipboardProvider> { // TODO: - Box::new(provider::NopProvider::new()) + Box::new(provider::FallbackProvider::new()) } #[cfg(not(any(windows, target_os = "wasm32", target_os = "macos")))] pub fn get_clipboard_provider() -> Box<dyn ClipboardProvider> { - use provider::command::{env_var_is_set, exists, is_exit_success}; + use crate::env::{binary_exists, env_var_is_set}; + use provider::command::is_exit_success; // TODO: support for user-defined provider, probably when we have plugin support by setting a // variable? - if env_var_is_set("WAYLAND_DISPLAY") && exists("wl-copy") && exists("wl-paste") { + if env_var_is_set("WAYLAND_DISPLAY") && binary_exists("wl-copy") && binary_exists("wl-paste") { command_provider! { paste => "wl-paste", "--no-newline"; copy => "wl-copy", "--type", "text/plain"; primary_paste => "wl-paste", "-p", "--no-newline"; primary_copy => "wl-copy", "-p", "--type", "text/plain"; } - } else if env_var_is_set("DISPLAY") && exists("xclip") { + } else if env_var_is_set("DISPLAY") && binary_exists("xclip") { command_provider! { paste => "xclip", "-o", "-selection", "clipboard"; copy => "xclip", "-i", "-selection", "clipboard"; primary_paste => "xclip", "-o"; primary_copy => "xclip", "-i"; } - } else if env_var_is_set("DISPLAY") && exists("xsel") && is_exit_success("xsel", &["-o", "-b"]) + } else if env_var_is_set("DISPLAY") + && binary_exists("xsel") + && is_exit_success("xsel", &["-o", "-b"]) { // FIXME: check performance of is_exit_success command_provider! { @@ -119,43 +123,78 @@ pub fn get_clipboard_provider() -> Box<dyn ClipboardProvider> { primary_paste => "xsel", "-o"; primary_copy => "xsel", "-i"; } - } else if exists("win32yank.exe") { + } else if binary_exists("win32yank.exe") { command_provider! { paste => "win32yank.exe", "-o", "--lf"; copy => "win32yank.exe", "-i", "--crlf"; } - } else if exists("termux-clipboard-set") && exists("termux-clipboard-get") { + } else if binary_exists("termux-clipboard-set") && binary_exists("termux-clipboard-get") { command_provider! { paste => "termux-clipboard-get"; copy => "termux-clipboard-set"; } - } else if env_var_is_set("TMUX") && exists("tmux") { + } else if env_var_is_set("TMUX") && binary_exists("tmux") { command_provider! { paste => "tmux", "save-buffer", "-"; copy => "tmux", "load-buffer", "-"; } } else { - Box::new(provider::NopProvider::new()) + Box::new(provider::FallbackProvider::new()) } } +#[cfg(not(target_os = "windows"))] pub mod provider { use super::{ClipboardProvider, ClipboardType}; use anyhow::Result; use std::borrow::Cow; - #[cfg(not(target_os = "windows"))] + #[cfg(feature = "term")] + mod osc52 { + use {super::ClipboardType, crate::base64, crossterm}; + + #[derive(Debug)] + pub struct SetClipboardCommand { + encoded_content: String, + clipboard_type: ClipboardType, + } + + impl SetClipboardCommand { + pub fn new(content: &str, clipboard_type: ClipboardType) -> Self { + Self { + encoded_content: base64::encode(content.as_bytes()), + clipboard_type, + } + } + } + + impl crossterm::Command for SetClipboardCommand { + fn write_ansi(&self, f: &mut impl std::fmt::Write) -> std::fmt::Result { + let kind = match &self.clipboard_type { + ClipboardType::Clipboard => "c", + ClipboardType::Selection => "p", + }; + // Send an OSC 52 set command: https://terminalguide.namepad.de/seq/osc-52/ + write!(f, "\x1b]52;{};{}\x1b\\", kind, &self.encoded_content) + } + } + } + #[derive(Debug)] - pub struct NopProvider { + pub struct FallbackProvider { buf: String, primary_buf: String, } - #[cfg(not(target_os = "windows"))] - impl NopProvider { + impl FallbackProvider { pub fn new() -> Self { + #[cfg(feature = "term")] + log::debug!( + "No native clipboard provider found. Yanking by OSC 52 and pasting will be internal to Helix" + ); + #[cfg(not(feature = "term"))] log::warn!( - "No clipboard provider found! Yanking and pasting will be internal to Helix" + "No native clipboard provider found! Yanking and pasting will be internal to Helix" ); Self { buf: String::new(), @@ -164,20 +203,27 @@ pub mod provider { } } - #[cfg(not(target_os = "windows"))] - impl Default for NopProvider { + impl Default for FallbackProvider { fn default() -> Self { Self::new() } } - #[cfg(not(target_os = "windows"))] - impl ClipboardProvider for NopProvider { + impl ClipboardProvider for FallbackProvider { + #[cfg(feature = "term")] + fn name(&self) -> Cow<str> { + Cow::Borrowed("termcode") + } + + #[cfg(not(feature = "term"))] fn name(&self) -> Cow<str> { Cow::Borrowed("none") } fn get_contents(&self, clipboard_type: ClipboardType) -> Result<String> { + // This is the same noop if term is enabled or not. + // We don't use the get side of OSC 52 as it isn't often enabled, it's a security hole, + // and it would require this to be async to listen for the response let value = match clipboard_type { ClipboardType::Clipboard => self.buf.clone(), ClipboardType::Selection => self.primary_buf.clone(), @@ -187,6 +233,12 @@ pub mod provider { } fn set_contents(&mut self, content: String, clipboard_type: ClipboardType) -> Result<()> { + #[cfg(feature = "term")] + crossterm::execute!( + std::io::stdout(), + osc52::SetClipboardCommand::new(&content, clipboard_type) + )?; + // Set our internal variables to use in get_content regardless of using OSC 52 match clipboard_type { ClipboardType::Clipboard => self.buf = content, ClipboardType::Selection => self.primary_buf = content, @@ -195,52 +247,11 @@ pub mod provider { } } - #[cfg(target_os = "windows")] - #[derive(Default, Debug)] - pub struct WindowsProvider; - - #[cfg(target_os = "windows")] - impl ClipboardProvider for WindowsProvider { - fn name(&self) -> Cow<str> { - log::info!("Using clipboard-win to interact with the system clipboard"); - Cow::Borrowed("clipboard-win") - } - - fn get_contents(&self, clipboard_type: ClipboardType) -> Result<String> { - match clipboard_type { - ClipboardType::Clipboard => { - let contents = clipboard_win::get_clipboard(clipboard_win::formats::Unicode)?; - Ok(contents) - } - ClipboardType::Selection => Ok(String::new()), - } - } - - fn set_contents(&mut self, contents: String, clipboard_type: ClipboardType) -> Result<()> { - match clipboard_type { - ClipboardType::Clipboard => { - clipboard_win::set_clipboard(clipboard_win::formats::Unicode, contents)?; - } - ClipboardType::Selection => {} - }; - Ok(()) - } - } - #[cfg(not(target_arch = "wasm32"))] pub mod command { use super::*; use anyhow::{bail, Context as _, Result}; - pub fn exists(executable_name: &str) -> bool { - which::which(executable_name).is_ok() - } - - #[cfg(not(windows))] - pub fn env_var_is_set(env_var_name: &str) -> bool { - std::env::var_os(env_var_name).is_some() - } - #[cfg(not(any(windows, target_os = "macos")))] pub fn is_exit_success(program: &str, args: &[&str]) -> bool { std::process::Command::new(program) @@ -343,3 +354,40 @@ pub mod provider { } } } + +#[cfg(target_os = "windows")] +mod provider { + use super::{ClipboardProvider, ClipboardType}; + use anyhow::Result; + use std::borrow::Cow; + + #[derive(Default, Debug)] + pub struct WindowsProvider; + + impl ClipboardProvider for WindowsProvider { + fn name(&self) -> Cow<str> { + log::info!("Using clipboard-win to interact with the system clipboard"); + Cow::Borrowed("clipboard-win") + } + + fn get_contents(&self, clipboard_type: ClipboardType) -> Result<String> { + match clipboard_type { + ClipboardType::Clipboard => { + let contents = clipboard_win::get_clipboard(clipboard_win::formats::Unicode)?; + Ok(contents) + } + ClipboardType::Selection => Ok(String::new()), + } + } + + fn set_contents(&mut self, contents: String, clipboard_type: ClipboardType) -> Result<()> { + match clipboard_type { + ClipboardType::Clipboard => { + clipboard_win::set_clipboard(clipboard_win::formats::Unicode, contents)?; + } + ClipboardType::Selection => {} + }; + Ok(()) + } + } +} |