aboutsummaryrefslogtreecommitdiff
path: root/copypasta/src
diff options
context:
space:
mode:
Diffstat (limited to 'copypasta/src')
-rw-r--r--copypasta/src/lib.rs88
-rw-r--r--copypasta/src/macos.rs329
-rw-r--r--copypasta/src/windows.rs64
-rw-r--r--copypasta/src/x11.rs144
4 files changed, 0 insertions, 625 deletions
diff --git a/copypasta/src/lib.rs b/copypasta/src/lib.rs
deleted file mode 100644
index d591a04f..00000000
--- a/copypasta/src/lib.rs
+++ /dev/null
@@ -1,88 +0,0 @@
-//! A cross-platform clipboard library
-
-#![deny(clippy::all, clippy::if_not_else, clippy::enum_glob_use, clippy::wrong_pub_self_convention)]
-
-// This has to be here due to macro_use
-#[cfg(target_os = "macos")]
-#[macro_use]
-extern crate objc;
-
-#[cfg(windows)]
-extern crate clipboard;
-
-/// An enumeration describing available clipboard buffers
-pub enum Buffer {
- Primary,
- Selection,
-}
-
-/// Types that can get the system clipboard contents
-pub trait Load: Sized {
- /// Errors encountered when working with a clipboard. Each implementation is
- /// allowed to define its own error type, but it must conform to std error.
- type Err: ::std::error::Error + Send + Sync + 'static;
-
- /// Create a clipboard
- fn new() -> Result<Self, Self::Err>;
-
- /// Get the primary clipboard contents.
- fn load_primary(&self) -> Result<String, Self::Err>;
-
- /// Get the clipboard selection contents.
- ///
- /// On most platforms, this doesn't mean anything. A default implementation
- /// is provided which uses the primary clipboard.
- #[inline]
- fn load_selection(&self) -> Result<String, Self::Err> {
- self.load_primary()
- }
-
- fn load(&self, buffer: Buffer) -> Result<String, Self::Err> {
- match buffer {
- Buffer::Selection => self.load_selection(),
- Buffer::Primary => self.load_primary(),
- }
- }
-}
-
-/// Types that can set the system clipboard contents
-///
-/// Note that some platforms require the clipboard context to stay active in
-/// order to load the contents from other applications.
-pub trait Store: Load {
- /// Sets the primary clipboard contents
- fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>;
-
- /// Sets the secondary clipboard contents
- fn store_selection<S>(&mut self, contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>;
-
- /// Store into the specified `buffer`.
- fn store<S>(&mut self, contents: S, buffer: Buffer) -> Result<(), Self::Err>
- where
- S: Into<String>,
- {
- match buffer {
- Buffer::Selection => self.store_selection(contents),
- Buffer::Primary => self.store_primary(contents),
- }
- }
-}
-
-#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))]
-mod x11;
-#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))]
-pub use x11::{Clipboard, Error};
-
-#[cfg(target_os = "macos")]
-mod macos;
-#[cfg(target_os = "macos")]
-pub use macos::{Clipboard, Error};
-
-#[cfg(windows)]
-mod windows;
-#[cfg(windows)]
-pub use crate::windows::{Clipboard, Error};
diff --git a/copypasta/src/macos.rs b/copypasta/src/macos.rs
deleted file mode 100644
index d0ccaec4..00000000
--- a/copypasta/src/macos.rs
+++ /dev/null
@@ -1,329 +0,0 @@
-//! Clipboard access on macOS
-//!
-//! Implemented according to
-//! https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PasteboardGuide106/Articles/pbReading.html#//apple_ref/doc/uid/TP40008123-SW1
-
-mod ns {
- extern crate objc_foundation;
- extern crate objc_id;
-
- #[link(name = "AppKit", kind = "framework")]
- extern "C" {}
-
- use std::mem;
-
- use self::objc_foundation::{INSArray, INSObject, INSString};
- use self::objc_foundation::{NSArray, NSDictionary, NSObject, NSString};
- use self::objc_id::{Id, Owned};
- use objc::runtime::{Class, Object};
-
- /// Rust API for NSPasteboard
- pub struct Pasteboard(Id<Object>);
-
- /// Errors occurring when creating a Pasteboard
- #[derive(Debug)]
- pub enum NewPasteboardError {
- GetPasteboardClass,
- LoadGeneralPasteboard,
- }
-
- /// Errors occurring when reading a string from the pasteboard
- #[derive(Debug)]
- pub enum ReadStringError {
- GetStringClass,
- ReadObjectsForClasses,
- }
-
- /// Errors from writing strings to the pasteboard
- #[derive(Debug)]
- pub struct WriteStringError;
-
- /// A trait for reading contents from the pasteboard
- ///
- /// This is intended to reflect the underlying objective C API
- /// `readObjectsForClasses:options:`.
- pub trait PasteboardReadObject<T> {
- type Err;
- fn read_object(&self) -> Result<T, Self::Err>;
- }
-
- /// A trait for writing contents to the pasteboard
- pub trait PasteboardWriteObject<T> {
- type Err;
- fn write_object(&mut self, T) -> Result<(), Self::Err>;
- }
-
- impl PasteboardReadObject<String> for Pasteboard {
- type Err = ReadStringError;
-
- fn read_object(&self) -> Result<String, ReadStringError> {
- // Get string class; need this for passing to readObjectsForClasses
- let ns_string_class = match Class::get("NSString") {
- Some(class) => class,
- None => return Err(ReadStringError::GetStringClass),
- };
-
- let ns_string: Id<Object> = unsafe {
- let ptr: *mut Object = msg_send![ns_string_class, class];
-
- if ptr.is_null() {
- return Err(ReadStringError::GetStringClass);
- } else {
- Id::from_ptr(ptr)
- }
- };
-
- let classes: Id<NSArray<NSObject, Owned>> = unsafe {
- // I think this transmute is valid. It's going from an
- // Id<Object> to an Id<NSObject>. From transmute's perspective,
- // the only thing that matters is that they both have the same
- // size (they do for now since the generic is phantom data). In
- // both cases, the underlying pointer is an id (from `[NSString
- // class]`), so again, this should be valid. There's just
- // nothing implemented in objc_id or objc_foundation to do this
- // "safely". By the way, the only reason this is necessary is
- // because INSObject isn't implemented for Id<Object>.
- //
- // And if that argument isn't convincing, my final reasoning is
- // that "it seems to work".
- NSArray::from_vec(vec![mem::transmute(ns_string)])
- };
-
- // No options
- //
- // Apparently this doesn't compile without a type hint, so it maps
- // objects to objects!
- let options: Id<NSDictionary<NSObject, NSObject>> = NSDictionary::new();
-
- // call [pasteboard readObjectsForClasses:options:]
- let copied_items = unsafe {
- let copied_items: *mut NSArray<NSString> = msg_send![
- self.0,
- readObjectsForClasses:&*classes
- options:&*options
- ];
-
- if copied_items.is_null() {
- return Err(ReadStringError::ReadObjectsForClasses);
- } else {
- Id::from_ptr(copied_items) as Id<NSArray<NSString>>
- }
- };
-
- // Ok, this is great. We have an NSArray<NSString>, and these have
- // decent bindings. Use the first item returned (if an item was
- // returned) or just return an empty string
- //
- // XXX Should this return an error if no items were returned?
- let contents = copied_items
- .first_object()
- .map(|ns_string| ns_string.as_str().to_owned())
- .unwrap_or_else(String::new);
-
- Ok(contents)
- }
- }
-
- impl PasteboardWriteObject<String> for Pasteboard {
- type Err = WriteStringError;
-
- fn write_object(&mut self, object: String) -> Result<(), Self::Err> {
- let objects = NSArray::from_vec(vec![NSString::from_str(&object)]);
-
- self.clear_contents();
-
- // The writeObjects method returns true in case of success, and
- // false otherwise.
- let ok: bool = unsafe { msg_send![self.0, writeObjects: objects] };
-
- if ok {
- Ok(())
- } else {
- Err(WriteStringError)
- }
- }
- }
-
- impl ::std::error::Error for WriteStringError {
- fn description(&self) -> &str {
- "Failed writing string to the NSPasteboard (writeContents returned false)"
- }
- }
-
- impl ::std::fmt::Display for WriteStringError {
- fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
- f.write_str(::std::error::Error::description(self))
- }
- }
-
- impl ::std::error::Error for ReadStringError {
- fn description(&self) -> &str {
- match *self {
- ReadStringError::GetStringClass => "NSString class not found",
- ReadStringError::ReadObjectsForClasses => "readObjectsForClasses:options: failed",
- }
- }
- }
-
- impl ::std::fmt::Display for ReadStringError {
- fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
- f.write_str(::std::error::Error::description(self))
- }
- }
-
- impl ::std::error::Error for NewPasteboardError {
- fn description(&self) -> &str {
- match *self {
- NewPasteboardError::GetPasteboardClass => "NSPasteboard class not found",
- NewPasteboardError::LoadGeneralPasteboard => {
- "[NSPasteboard generalPasteboard] failed"
- },
- }
- }
- }
-
- impl ::std::fmt::Display for NewPasteboardError {
- fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
- f.write_str(::std::error::Error::description(self))
- }
- }
-
- impl Pasteboard {
- pub fn new() -> Result<Pasteboard, NewPasteboardError> {
- // NSPasteboard *pasteboard = [NSPasteboard generalPasteboard];
- let ns_pasteboard_class = match Class::get("NSPasteboard") {
- Some(class) => class,
- None => return Err(NewPasteboardError::GetPasteboardClass),
- };
-
- let ptr = unsafe {
- let ptr: *mut Object = msg_send![ns_pasteboard_class, generalPasteboard];
-
- if ptr.is_null() {
- return Err(NewPasteboardError::LoadGeneralPasteboard);
- } else {
- ptr
- }
- };
-
- let id = unsafe { Id::from_ptr(ptr) };
-
- Ok(Pasteboard(id))
- }
-
- /// Clears the existing contents of the pasteboard, preparing it for new
- /// contents.
- ///
- /// This is the first step in providing data on the pasteboard. The
- /// return value is the change count of the pasteboard
- pub fn clear_contents(&mut self) -> usize {
- unsafe { msg_send![self.0, clearContents] }
- }
- }
-}
-
-#[derive(Debug)]
-pub enum Error {
- CreatePasteboard(ns::NewPasteboardError),
- ReadString(ns::ReadStringError),
- WriteString(ns::WriteStringError),
-}
-
-impl ::std::error::Error for Error {
- fn cause(&self) -> Option<&::std::error::Error> {
- match *self {
- Error::CreatePasteboard(ref err) => Some(err),
- Error::ReadString(ref err) => Some(err),
- Error::WriteString(ref err) => Some(err),
- }
- }
-
- fn description(&self) -> &str {
- match *self {
- Error::CreatePasteboard(ref _err) => "Failed to create pasteboard",
- Error::ReadString(ref _err) => "Failed to read string from pasteboard",
- Error::WriteString(ref _err) => "Failed to write string to pasteboard",
- }
- }
-}
-
-impl ::std::fmt::Display for Error {
- fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
- match *self {
- Error::CreatePasteboard(ref err) => write!(f, "Failed to create pasteboard: {}", err),
- Error::ReadString(ref err) => {
- write!(f, "Failed to read string from pasteboard: {}", err)
- },
- Error::WriteString(ref err) => {
- write!(f, "Failed to write string to pasteboard: {}", err)
- },
- }
- }
-}
-
-impl From<ns::NewPasteboardError> for Error {
- fn from(val: ns::NewPasteboardError) -> Error {
- Error::CreatePasteboard(val)
- }
-}
-
-impl From<ns::ReadStringError> for Error {
- fn from(val: ns::ReadStringError) -> Error {
- Error::ReadString(val)
- }
-}
-
-impl From<ns::WriteStringError> for Error {
- fn from(val: ns::WriteStringError) -> Error {
- Error::WriteString(val)
- }
-}
-
-pub struct Clipboard(ns::Pasteboard);
-
-impl super::Load for Clipboard {
- type Err = Error;
-
- fn new() -> Result<Self, Error> {
- Ok(Clipboard(ns::Pasteboard::new()?))
- }
-
- fn load_primary(&self) -> Result<String, Self::Err> {
- use self::ns::PasteboardReadObject;
-
- self.0.read_object().map_err(::std::convert::From::from)
- }
-}
-
-impl super::Store for Clipboard {
- fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>,
- {
- use self::ns::PasteboardWriteObject;
-
- self.0.write_object(contents.into()).map_err(::std::convert::From::from)
- }
-
- fn store_selection<S>(&mut self, _contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>,
- {
- // No such thing on macOS
- Ok(())
- }
-}
-
-#[cfg(test)]
-mod tests {
- use super::Clipboard;
- use {Load, Store};
-
- #[test]
- fn create_clipboard_save_load_contents() {
- let mut clipboard = Clipboard::new().unwrap();
- clipboard.store_primary("arst").unwrap();
- let loaded = clipboard.load_primary().unwrap();
- assert_eq!("arst", loaded);
- }
-}
diff --git a/copypasta/src/windows.rs b/copypasta/src/windows.rs
deleted file mode 100644
index 3bff6e59..00000000
--- a/copypasta/src/windows.rs
+++ /dev/null
@@ -1,64 +0,0 @@
-use clipboard::ClipboardContext;
-use clipboard::ClipboardProvider;
-
-use super::{Load, Store};
-
-pub struct Clipboard(ClipboardContext);
-
-#[derive(Debug)]
-pub enum Error {
- Clipboard(Box<::std::error::Error>),
-}
-
-impl ::std::error::Error for Error {
- fn description(&self) -> &str {
- match *self {
- Error::Clipboard(..) => "Error opening clipboard",
- }
- }
-}
-
-impl ::std::fmt::Display for Error {
- fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
- match *self {
- Error::Clipboard(ref err) => err.fmt(f),
- }
- }
-}
-
-unsafe impl Send for Error {}
-unsafe impl Sync for Error {}
-
-impl Load for Clipboard {
- type Err = Error;
-
- fn new() -> Result<Self, Error> {
- ClipboardContext::new().map(Clipboard).map_err(Error::Clipboard)
- }
-
- fn load_primary(&self) -> Result<String, Self::Err> {
- let mut ctx: ClipboardContext = ClipboardProvider::new().unwrap();
- ctx.get_contents().map_err(Error::Clipboard)
- }
-}
-
-impl Store for Clipboard {
- /// Sets the primary clipboard contents
- #[inline]
- fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>,
- {
- self.0.set_contents(contents.into()).map_err(Error::Clipboard)
- }
-
- /// Sets the secondary clipboard contents
- #[inline]
- fn store_selection<S>(&mut self, contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>,
- {
- // No such thing on Windows
- Ok(())
- }
-}
diff --git a/copypasta/src/x11.rs b/copypasta/src/x11.rs
deleted file mode 100644
index 0bb769a1..00000000
--- a/copypasta/src/x11.rs
+++ /dev/null
@@ -1,144 +0,0 @@
-//! X11 Clipboard implementation
-//!
-//! Note that the x11 implementation is really crap right now - we just depend
-//! on xclip being on the user's path. If x11 pasting doesn't work, it's
-//! probably because xclip is unavailable. There's currently no non-GPL x11
-//! clipboard library for Rust. Until then, we have this hack.
-//!
-//! FIXME: Implement actual X11 clipboard API using the ICCCM reference
-//! https://tronche.com/gui/x/icccm/
-use std::ffi::OsStr;
-use std::io;
-use std::process::{Command, Output};
-use std::string::FromUtf8Error;
-
-use super::{Load, Store};
-
-/// The x11 clipboard
-pub struct Clipboard;
-
-#[derive(Debug)]
-pub enum Error {
- Io(io::Error),
- Xclip(String),
- Utf8(FromUtf8Error),
-}
-
-impl ::std::error::Error for Error {
- fn cause(&self) -> Option<&::std::error::Error> {
- match *self {
- Error::Io(ref err) => Some(err),
- Error::Utf8(ref err) => Some(err),
- _ => None,
- }
- }
-
- fn description(&self) -> &str {
- match *self {
- Error::Io(..) => "Error calling xclip",
- Error::Xclip(..) => "Error reported by xclip",
- Error::Utf8(..) => "Clipboard contents not utf8",
- }
- }
-}
-
-impl ::std::fmt::Display for Error {
- fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
- match *self {
- Error::Io(ref err) => match err.kind() {
- io::ErrorKind::NotFound => {
- write!(f, "Please install `xclip` to enable clipboard support")
- },
- _ => write!(f, "Error calling xclip: {}", err),
- },
- Error::Xclip(ref s) => write!(f, "Error from xclip: {}", s),
- Error::Utf8(ref err) => write!(f, "Error parsing xclip output: {}", err),
- }
- }
-}
-
-impl From<io::Error> for Error {
- fn from(val: io::Error) -> Error {
- Error::Io(val)
- }
-}
-
-impl From<FromUtf8Error> for Error {
- fn from(val: FromUtf8Error) -> Error {
- Error::Utf8(val)
- }
-}
-
-impl Load for Clipboard {
- type Err = Error;
-
- fn new() -> Result<Self, Error> {
- Ok(Clipboard)
- }
-
- fn load_primary(&self) -> Result<String, Self::Err> {
- let output = Command::new("xclip").args(&["-o", "-selection", "clipboard"]).output()?;
-
- Clipboard::process_xclip_output(output)
- }
-
- fn load_selection(&self) -> Result<String, Self::Err> {
- let output = Command::new("xclip").args(&["-o"]).output()?;
-
- Clipboard::process_xclip_output(output)
- }
-}
-
-impl Store for Clipboard {
- /// Sets the primary clipboard contents
- #[inline]
- fn store_primary<S>(&mut self, contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>,
- {
- self.store(contents, &["-i", "-selection", "clipboard"])
- }
-
- /// Sets the secondary clipboard contents
- #[inline]
- fn store_selection<S>(&mut self, contents: S) -> Result<(), Self::Err>
- where
- S: Into<String>,
- {
- self.store(contents, &["-i"])
- }
-}
-
-impl Clipboard {
- fn process_xclip_output(output: Output) -> Result<String, Error> {
- if output.status.success() {
- String::from_utf8(output.stdout).map_err(::std::convert::From::from)
- } else {
- String::from_utf8(output.stderr).map_err(::std::convert::From::from)
- }
- }
-
- fn store<C, S>(&mut self, contents: C, args: &[S]) -> Result<(), Error>
- where
- C: Into<String>,
- S: AsRef<OsStr>,
- {
- use std::io::Write;
- use std::process::Stdio;
-
- let contents = contents.into();
- let mut child = Command::new("xclip").args(args).stdin(Stdio::piped()).spawn()?;
-
- if let Some(stdin) = child.stdin.as_mut() {
- stdin.write_all(contents.as_bytes())?;
- }
-
- // Return error if didn't exit cleanly
- let exit_status = child.wait()?;
- if exit_status.success() {
- Ok(())
- } else {
- Err(Error::Xclip("xclip returned non-zero exit code".into()))
- }
- }
-}
generated by cgit (git 2.34.1) at 2025-07-16 14:53:05 +0000