refactor: allow clipboard methods to take generic data

This commit is contained in:
Ashley Wulber 2024-02-29 14:30:53 -05:00
parent 4bd0f74db5
commit 8e7827ebbe
No known key found for this signature in database
GPG key ID: 5216D4F46A90A820
9 changed files with 100 additions and 82 deletions

View file

@ -1,3 +1,5 @@
pub mod mime;
#[cfg(all( #[cfg(all(
unix, unix,
not(any( not(any(
@ -49,49 +51,55 @@ mod platform;
use raw_window_handle::HasDisplayHandle; use raw_window_handle::HasDisplayHandle;
use std::error::Error; use std::error::Error;
pub struct Clipboard { pub struct Clipboard<C> {
raw: Box<dyn ClipboardProvider>, raw: C,
} }
impl Clipboard { impl Clipboard<platform::Clipboard> {
/// Safety: the display handle must be valid for the lifetime of `Clipboard` /// Safety: the display handle must be valid for the lifetime of `Clipboard`
pub unsafe fn connect<W: HasDisplayHandle>( pub unsafe fn connect<W: HasDisplayHandle>(
window: &W, window: &W,
) -> Result<Self, Box<dyn Error>> { ) -> Result<Self, Box<dyn Error>> {
let raw = platform::connect(window)?; Ok(Clipboard {
raw: platform::connect(window)?,
Ok(Clipboard { raw }) })
} }
pub fn read(&self) -> Result<String, Box<dyn Error>> { pub fn read(&self) -> Result<String, Box<dyn Error>> {
self.raw.read() self.raw.read_text()
} }
pub fn write(&mut self, contents: String) -> Result<(), Box<dyn Error>> { pub fn write(&mut self, contents: String) -> Result<(), Box<dyn Error>> {
self.raw.write(contents) self.raw.write_text(contents)
} }
} }
impl Clipboard { impl<C: ClipboardProvider> Clipboard<C> {
pub fn read_primary(&self) -> Option<Result<String, Box<dyn Error>>> { pub fn read_primary(&self) -> Option<Result<String, Box<dyn Error>>> {
self.raw.read_primary() self.raw.read_primary_text()
} }
pub fn write_primary(&mut self, contents: String) -> Option<Result<(), Box<dyn Error>>> { pub fn write_primary(
self.raw.write_primary(contents) &mut self,
contents: String,
) -> Option<Result<(), Box<dyn Error>>> {
self.raw.write_primary_text(contents)
} }
} }
pub trait ClipboardProvider { pub trait ClipboardProvider {
fn read(&self) -> Result<String, Box<dyn Error>>; fn read_text(&self) -> Result<String, Box<dyn Error>>;
fn write(&mut self, contents: String) -> Result<(), Box<dyn Error>>; fn write_text(&mut self, contents: String) -> Result<(), Box<dyn Error>>;
fn read_primary(&self) -> Option<Result<String, Box<dyn Error>>> { fn read_primary_text(&self) -> Option<Result<String, Box<dyn Error>>> {
None None
} }
fn write_primary(&mut self, _contents: String) -> Option<Result<(), Box<dyn Error>>> { fn write_primary_text(
&mut self,
_contents: String,
) -> Option<Result<(), Box<dyn Error>>> {
None None
} }
} }

View file

@ -5,8 +5,8 @@ use std::error::Error;
pub fn connect<W: HasDisplayHandle>( pub fn connect<W: HasDisplayHandle>(
_window: &W, _window: &W,
) -> Result<Box<dyn ClipboardProvider>, Box<dyn Error>> { ) -> Result<Clipboard, Box<dyn Error>> {
Ok(Box::new(Clipboard::new()?)) Ok(Clipboard::new())
} }
pub struct Clipboard; pub struct Clipboard;

View file

@ -2,15 +2,15 @@ use crate::ClipboardProvider;
use raw_window_handle::HasDisplayHandle; use raw_window_handle::HasDisplayHandle;
struct Dummy; struct Clipboard;
pub fn connect<W: HasDisplayHandle>( pub fn connect<W: HasDisplayHandle>(
_window: &W, _window: &W,
) -> Result<Box<dyn ClipboardProvider>, Box<dyn std::error::Error>> { ) -> Result<Clipboard, Box<dyn std::error::Error>> {
Ok(Box::new(Dummy)) Ok(Clipboard)
} }
impl ClipboardProvider for Dummy { impl ClipboardProvider for Clipboard {
fn read(&self) -> Result<String, Box<dyn std::error::Error>> { fn read(&self) -> Result<String, Box<dyn std::error::Error>> {
Err(Box::new(Error::Unimplemented)) Err(Box::new(Error::Unimplemented))
} }

View file

@ -5,8 +5,8 @@ use std::error::Error;
pub fn connect<W: HasDisplayHandle>( pub fn connect<W: HasDisplayHandle>(
_window: &W, _window: &W,
) -> Result<Box<dyn ClipboardProvider>, Box<dyn Error>> { ) -> Result<Clipboard, Box<dyn Error>> {
Ok(Box::new(Clipboard::new()?)) Clipboard::new()
} }
pub struct Clipboard; pub struct Clipboard;

View file

@ -6,51 +6,55 @@ use std::error::Error;
pub use clipboard_wayland as wayland; pub use clipboard_wayland as wayland;
pub use clipboard_x11 as x11; pub use clipboard_x11 as x11;
pub enum Clipboard {
Wayland(wayland::Clipboard),
X11(x11::Clipboard),
}
impl ClipboardProvider for Clipboard {
fn read_text(&self) -> Result<String, Box<dyn Error>> {
match self {
Clipboard::Wayland(c) => c.read_text(),
Clipboard::X11(c) => c.read().map_err(Box::from),
}
}
fn write_text(&mut self, contents: String) -> Result<(), Box<dyn Error>> {
match self {
Clipboard::Wayland(c) => c.write_text(contents),
Clipboard::X11(c) => c.write(contents).map_err(Box::from),
}
}
fn read_primary_text(&self) -> Option<Result<String, Box<dyn Error>>> {
match self {
Clipboard::Wayland(c) => Some(c.read_primary_text()),
Clipboard::X11(c) => Some(c.read_primary().map_err(Box::from)),
}
}
fn write_primary_text(
&mut self,
contents: String,
) -> Option<Result<(), Box<dyn Error>>> {
match self {
Clipboard::Wayland(c) => Some(c.write_primary_text(contents)),
Clipboard::X11(c) => {
Some(c.write_primary(contents).map_err(Box::from))
}
}
}
}
pub unsafe fn connect<W: HasDisplayHandle>( pub unsafe fn connect<W: HasDisplayHandle>(
window: &W, window: &W,
) -> Result<Box<dyn ClipboardProvider>, Box<dyn Error>> { ) -> Result<Clipboard, Box<dyn Error>> {
let clipboard = match window.display_handle()?.as_raw() { let clipboard = match window.display_handle()?.as_raw() {
RawDisplayHandle::Wayland(handle) => { RawDisplayHandle::Wayland(handle) => Clipboard::Wayland(
Box::new(wayland::Clipboard::connect(handle.display.as_ptr())) as _ wayland::Clipboard::connect(handle.display.as_ptr()),
} ) as _,
_ => Box::new(x11::Clipboard::connect()?) as _, _ => Clipboard::X11(x11::Clipboard::connect()?) as _,
}; };
Ok(clipboard) Ok(clipboard)
} }
impl ClipboardProvider for wayland::Clipboard {
fn read(&self) -> Result<String, Box<dyn Error>> {
self.read()
}
fn read_primary(&self) -> Option<Result<String, Box<dyn Error>>> {
Some(self.read_primary())
}
fn write(&mut self, contents: String) -> Result<(), Box<dyn Error>> {
self.write(contents)
}
fn write_primary(&mut self, contents: String) -> Option<Result<(), Box<dyn Error>>> {
Some(self.write_primary(contents))
}
}
impl ClipboardProvider for x11::Clipboard {
fn read(&self) -> Result<String, Box<dyn Error>> {
self.read().map_err(Box::from)
}
fn read_primary(&self) -> Option<Result<String, Box<dyn Error>>> {
Some(self.read_primary().map_err(Box::from))
}
fn write(&mut self, contents: String) -> Result<(), Box<dyn Error>> {
self.write(contents).map_err(Box::from)
}
fn write_primary(&mut self, contents: String) -> Option<Result<(), Box<dyn Error>>> {
Some(self.write_primary(contents).map_err(Box::from))
}
}

View file

@ -1,15 +1,16 @@
use crate::ClipboardProvider; use crate::ClipboardProvider;
pub(crate) use clipboard_macos::Clipboard;
use raw_window_handle::HasDisplayHandle; use raw_window_handle::HasDisplayHandle;
use std::error::Error; use std::error::Error;
pub fn connect<W: HasDisplayHandle>( pub fn connect<W: HasDisplayHandle>(
_window: &W, _window: &W,
) -> Result<Box<dyn ClipboardProvider>, Box<dyn Error>> { ) -> Result<Clipboard, Box<dyn Error>> {
Ok(Box::new(clipboard_macos::Clipboard::new()?)) Clipboard::new()
} }
impl ClipboardProvider for clipboard_macos::Clipboard { impl ClipboardProvider for Clipboard {
fn read(&self) -> Result<String, Box<dyn Error>> { fn read(&self) -> Result<String, Box<dyn Error>> {
self.read() self.read()
} }

View file

@ -7,8 +7,8 @@ use std::error::Error;
pub fn connect<W: HasDisplayHandle>( pub fn connect<W: HasDisplayHandle>(
_window: &W, _window: &W,
) -> Result<Box<dyn ClipboardProvider>, Box<dyn Error>> { ) -> Result<Clipboard, Box<dyn Error>> {
Ok(Box::new(Clipboard)) Ok(Clipboard)
} }
pub struct Clipboard; pub struct Clipboard;

View file

@ -10,4 +10,4 @@ documentation = "https://docs.rs/clipboard_wayland"
keywords = ["clipboard", "wayland"] keywords = ["clipboard", "wayland"]
[dependencies] [dependencies]
smithay-clipboard = "0.7" smithay-clipboard = { git = "https://github.com/wash2/smithay-clipboard", branch = "mime-types" }

View file

@ -12,9 +12,11 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
use std::error::Error; use std::{
use std::ffi::c_void; error::Error,
use std::sync::{Arc, Mutex}; ffi::c_void,
sync::{Arc, Mutex},
};
pub struct Clipboard { pub struct Clipboard {
context: Arc<Mutex<smithay_clipboard::Clipboard>>, context: Arc<Mutex<smithay_clipboard::Clipboard>>,
@ -29,22 +31,25 @@ impl Clipboard {
Clipboard { context } Clipboard { context }
} }
pub fn read(&self) -> Result<String, Box<dyn Error>> { pub fn read_text(&self) -> Result<String, Box<dyn Error>> {
Ok(self.context.lock().unwrap().load()?) Ok(self.context.lock().unwrap().load_text()?)
} }
pub fn read_primary(&self) -> Result<String, Box<dyn Error>> { pub fn read_primary_text(&self) -> Result<String, Box<dyn Error>> {
Ok(self.context.lock().unwrap().load_primary()?) Ok(self.context.lock().unwrap().load_primary_text()?)
} }
pub fn write(&mut self, data: String) -> Result<(), Box<dyn Error>> { pub fn write_text(&mut self, data: String) -> Result<(), Box<dyn Error>> {
self.context.lock().unwrap().store(data); self.context.lock().unwrap().store_text(data);
Ok(()) Ok(())
} }
pub fn write_primary(&mut self, data: String) -> Result<(), Box<dyn Error>> { pub fn write_primary_text(
self.context.lock().unwrap().store_primary(data); &mut self,
data: String,
) -> Result<(), Box<dyn Error>> {
self.context.lock().unwrap().store_primary_text(data);
Ok(()) Ok(())
} }