1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
use std::borrow::Cow;
#[cfg(feature = "wayland-data-control")]
use log::{trace, warn};
#[cfg(feature = "image-data")]
use crate::ImageData;
use crate::{common::private, Error};
mod x11;
#[cfg(feature = "wayland-data-control")]
mod wayland;
fn into_unknown<E: std::fmt::Display>(error: E) -> Error {
Error::Unknown { description: error.to_string() }
}
#[cfg(feature = "image-data")]
fn encode_as_png(image: &ImageData) -> Result<Vec<u8>, Error> {
use image::ImageEncoder as _;
if image.bytes.is_empty() || image.width == 0 || image.height == 0 {
return Err(Error::ConversionFailure);
}
let mut png_bytes = Vec::new();
let encoder = image::codecs::png::PngEncoder::new(&mut png_bytes);
encoder
.write_image(
image.bytes.as_ref(),
image.width as u32,
image.height as u32,
image::ColorType::Rgba8,
)
.map_err(|_| Error::ConversionFailure)?;
Ok(png_bytes)
}
/// Clipboard selection
///
/// Linux has a concept of clipboard "selections" which tend to be used in different contexts. This
/// enum provides a way to get/set to a specific clipboard (the default
/// [`Clipboard`](Self::Clipboard) being used for the common platform API). You can choose which
/// clipboard to use with [`GetExtLinux::clipboard`] and [`SetExtLinux::clipboard`].
///
/// See <https://specifications.freedesktop.org/clipboards-spec/clipboards-0.1.txt> for a better
/// description of the different clipboards.
#[derive(Copy, Clone, Debug)]
pub enum LinuxClipboardKind {
/// Typically used selection for explicit cut/copy/paste actions (ie. windows/macos like
/// clipboard behavior)
Clipboard,
/// Typically used for mouse selections and/or currently selected text. Accessible via middle
/// mouse click.
///
/// *On Wayland, this may not be available for all systems (requires a compositor supporting
/// version 2 or above) and operations using this will return an error if unsupported.*
Primary,
/// The secondary clipboard is rarely used but theoretically available on X11.
///
/// *On Wayland, this is not be available and operations using this variant will return an
/// error.*
Secondary,
}
pub(crate) enum Clipboard {
X11(x11::Clipboard),
#[cfg(feature = "wayland-data-control")]
WlDataControl(wayland::Clipboard),
}
impl Clipboard {
pub(crate) fn new() -> Result<Self, Error> {
#[cfg(feature = "wayland-data-control")]
{
if std::env::var_os("WAYLAND_DISPLAY").is_some() {
// Wayland is available
match wayland::Clipboard::new() {
Ok(clipboard) => {
trace!("Successfully initialized the Wayland data control clipboard.");
return Ok(Self::WlDataControl(clipboard));
}
Err(e) => warn!(
"Tried to initialize the wayland data control protocol clipboard, but failed. Falling back to the X11 clipboard protocol. The error was: {}",
e
),
}
}
}
Ok(Self::X11(x11::Clipboard::new()?))
}
}
pub(crate) struct Get<'clipboard> {
clipboard: &'clipboard mut Clipboard,
selection: LinuxClipboardKind,
}
impl<'clipboard> Get<'clipboard> {
pub(crate) fn new(clipboard: &'clipboard mut Clipboard) -> Self {
Self { clipboard, selection: LinuxClipboardKind::Clipboard }
}
pub(crate) fn text(self) -> Result<String, Error> {
match self.clipboard {
Clipboard::X11(clipboard) => clipboard.get_text(self.selection),
#[cfg(feature = "wayland-data-control")]
Clipboard::WlDataControl(clipboard) => clipboard.get_text(self.selection),
}
}
#[cfg(feature = "image-data")]
pub(crate) fn image(self) -> Result<ImageData<'static>, Error> {
match self.clipboard {
Clipboard::X11(clipboard) => clipboard.get_image(self.selection),
#[cfg(feature = "wayland-data-control")]
Clipboard::WlDataControl(clipboard) => clipboard.get_image(self.selection),
}
}
}
/// Linux-specific extensions to the [`Get`](super::Get) builder.
pub trait GetExtLinux: private::Sealed {
/// Sets the clipboard the operation will retrieve data from.
///
/// If wayland support is enabled and available, attempting to use the Secondary clipboard will
/// return an error.
fn clipboard(self, selection: LinuxClipboardKind) -> Self;
}
impl GetExtLinux for crate::Get<'_> {
fn clipboard(mut self, selection: LinuxClipboardKind) -> Self {
self.platform.selection = selection;
self
}
}
pub(crate) struct Set<'clipboard> {
clipboard: &'clipboard mut Clipboard,
wait: bool,
selection: LinuxClipboardKind,
}
impl<'clipboard> Set<'clipboard> {
pub(crate) fn new(clipboard: &'clipboard mut Clipboard) -> Self {
Self { clipboard, wait: false, selection: LinuxClipboardKind::Clipboard }
}
pub(crate) fn text(self, text: Cow<'_, str>) -> Result<(), Error> {
match self.clipboard {
Clipboard::X11(clipboard) => clipboard.set_text(text, self.selection, self.wait),
#[cfg(feature = "wayland-data-control")]
Clipboard::WlDataControl(clipboard) => clipboard.set_text(text, self.selection, self.wait),
}
}
pub(crate) fn html(self, html: Cow<'_, str>, alt: Option<Cow<'_, str>>) -> Result<(), Error> {
match self.clipboard {
Clipboard::X11(clipboard) => clipboard.set_html(html, alt, self.selection, self.wait),
#[cfg(feature = "wayland-data-control")]
Clipboard::WlDataControl(clipboard) => clipboard.set_html(html, alt, self.selection, self.wait),
}
}
#[cfg(feature = "image-data")]
pub(crate) fn image(self, image: ImageData<'_>) -> Result<(), Error> {
match self.clipboard {
Clipboard::X11(clipboard) => clipboard.set_image(image, self.selection, self.wait),
#[cfg(feature = "wayland-data-control")]
Clipboard::WlDataControl(clipboard) => clipboard.set_image(image, self.selection, self.wait),
}
}
}
/// Linux specific extensions to the [`Set`](super::Set) builder.
pub trait SetExtLinux: private::Sealed {
/// Whether to wait for the clipboard's contents to be replaced after setting it.
///
/// The Wayland and X11 clipboards work by having the clipboard content being, at any given
/// time, "owned" by a single process, and that process is expected to reply to all the requests
/// from any other system process that wishes to access the clipboard's contents. As a
/// consequence, when that process exits the contents of the clipboard will effectively be
/// cleared since there is no longer anyone around to serve requests for it.
///
/// This poses a problem for short-lived programs that just want to copy to the clipboard and
/// then exit, since they don't want to wait until the user happens to copy something else just
/// to finish. To resolve that, whenever the user copies something you can offload the actual
/// work to a newly-spawned daemon process which will run in the background (potentially
/// outliving the current process) and serve all the requests. That process will then
/// automatically and silently exit once the user copies something else to their clipboard so it
/// doesn't take up too many resources.
///
/// To support that pattern, this method will not only have the contents of the clipboard be
/// set, but will also wait and continue to serve requests until the clipboard is overwritten.
/// As long as you don't exit the current process until that method has returned, you can avoid
/// all surprising situations where the clipboard's contents seemingly disappear from under your
/// feet.
///
/// See the [daemonize example] for a demo of how you could implement this.
///
/// [daemonize example]: https://github.com/1Password/arboard/blob/master/examples/daemonize.rs
fn wait(self) -> Self;
/// Sets the clipboard the operation will store its data to.
///
/// If wayland support is enabled and available, attempting to use the Secondary clipboard will
/// return an error.
///
/// # Examples
///
/// ```
/// use arboard::{Clipboard, SetExtLinux, LinuxClipboardKind};
/// # fn main() -> Result<(), arboard::Error> {
/// let mut ctx = Clipboard::new()?;
///
/// let clipboard = "This goes in the traditional (ex. Copy & Paste) clipboard.";
/// ctx.set().clipboard(LinuxClipboardKind::Clipboard).text(clipboard.to_owned())?;
///
/// let primary = "This goes in the primary keyboard. It's typically used via middle mouse click.";
/// ctx.set().clipboard(LinuxClipboardKind::Primary).text(primary.to_owned())?;
/// # Ok(())
/// # }
/// ```
fn clipboard(self, selection: LinuxClipboardKind) -> Self;
}
impl SetExtLinux for crate::Set<'_> {
fn wait(mut self) -> Self {
self.platform.wait = true;
self
}
fn clipboard(mut self, selection: LinuxClipboardKind) -> Self {
self.platform.selection = selection;
self
}
}
pub(crate) struct Clear<'clipboard> {
clipboard: &'clipboard mut Clipboard,
}
impl<'clipboard> Clear<'clipboard> {
pub(crate) fn new(clipboard: &'clipboard mut Clipboard) -> Self {
Self { clipboard }
}
pub(crate) fn clear(self) -> Result<(), Error> {
self.clear_inner(LinuxClipboardKind::Clipboard)
}
fn clear_inner(self, selection: LinuxClipboardKind) -> Result<(), Error> {
let mut set = Set::new(self.clipboard);
set.selection = selection;
set.text(Cow::Borrowed(""))
}
}
/// Linux specific extensions to the [Clear] builder.
pub trait ClearExtLinux: private::Sealed {
/// Performs the "clear" operation on the selected clipboard.
///
/// ### Example
///
/// ```no_run
/// # use arboard::{Clipboard, LinuxClipboardKind, ClearExtLinux, Error};
/// # fn main() -> Result<(), Error> {
/// let mut clipboard = Clipboard::new()?;
///
/// clipboard
/// .clear_with()
/// .clipboard(LinuxClipboardKind::Secondary)?;
/// # Ok(())
/// # }
/// ```
///
/// If wayland support is enabled and available, attempting to use the Secondary clipboard will
/// return an error.
fn clipboard(self, selection: LinuxClipboardKind) -> Result<(), Error>;
}
impl ClearExtLinux for crate::Clear<'_> {
fn clipboard(self, selection: LinuxClipboardKind) -> Result<(), Error> {
self.platform.clear_inner(selection)
}
}