Compare commits

...

10 commits

Author SHA1 Message Date
319db02e52 yoda: gate clipboard_x11 behind an opt-in feature
Some checks failed
Test / all (windows-latest, beta) (push) Has been cancelled
Test / all (windows-latest, stable) (push) Has been cancelled
Test / all (macOS-latest, beta) (push) Has been cancelled
Test / all (macOS-latest, stable) (push) Has been cancelled
Test / all (ubuntu-latest, beta) (push) Has been cancelled
Test / all (ubuntu-latest, stable) (push) Has been cancelled
Upstream pulled clipboard_x11 unconditionally on unix, which drags
x11rb + x11rb-protocol and ~500 symbols of X11 clipboard code into
every Wayland-only iced build. Add an x11 feature (default-on for
compat) that gates:
- the clipboard_x11 workspace dep (now optional)
- `pub use clipboard_x11 as x11` re-export
- the Clipboard::X11 enum variant
- every match arm that handles it
- the fallback branch in `unsafe fn connect` (returns a helpful
  error when called with a non-Wayland display handle)

Wayland-only builds set `window_clipboard = { ..., default-features = false, features = ["wayland"] }` and skip the x11 backend entirely.
2026-04-24 06:50:48 +02:00
Ashley Wulber
f68595ee0e cleanup: dbg 2026-03-16 16:51:48 -04:00
Ashley Wulber
3a7af79e54 update smithay-clipboard and sctk 2026-03-02 12:32:18 -05:00
Ian Douglas Scott
6b9faab87b dnd: Don't call Arc::get_mut
The caller of `start_dnd` may also have a reference, so this can panic.
Either the public API shouldn't take an `Arc` or this should be avoided.

There doesn't seem to be any reason this is needed anyway.
2025-01-02 09:14:49 -08:00
Ashley Wulber
a83bf83784
refactor: remove Box 2024-10-21 11:14:55 -04:00
Ashley Wulber
68f111cfd0
fix: dummy 2024-10-21 11:13:59 -04:00
Ashley Wulber
1832d5637b
refactor: remove Sized bound 2024-09-20 15:10:45 -04:00
Ashley Wulber
7c59b07b91 fix: stubs for various platforms 2024-06-19 12:47:13 -04:00
Ian Douglas Scott
a5be704055 Update smithay-clipboard 2024-06-11 17:58:40 -07:00
Ashley Wulber
8a816d8f21
chore: update smithay-clipboard 2024-05-01 14:57:01 -04:00
14 changed files with 183 additions and 33 deletions

View file

@ -11,6 +11,16 @@ readme = "README.md"
keywords = ["clipboard", "window", "ui", "gui", "raw-window-handle"]
categories = ["gui"]
[features]
# Yoda: put the unix clipboard backends behind opt-in features. Upstream
# pulled both X11 + Wayland unconditionally on unix — pure bloat for
# Wayland-only builds (clipboard_x11 pulls x11rb + its protocol machinery).
# Default keeps both enabled to preserve upstream behaviour; yoda consumers
# pass default-features=false + "wayland" at the dep declaration.
default = ["x11", "wayland"]
x11 = ["dep:clipboard_x11"]
wayland = ["dep:clipboard_wayland"]
[dependencies]
raw-window-handle = { version = "0.6", features = ["std"] }
thiserror = "1.0"
@ -24,8 +34,8 @@ clipboard-win = { version = "5.0", features = ["std"] }
clipboard_macos = { version = "0.1", path = "./macos" }
[target.'cfg(all(unix, not(any(target_os="macos", target_os="android", target_os="emscripten", target_os="ios", target_os="redox"))))'.dependencies]
clipboard_x11 = { version = "0.4.2", path = "./x11" }
clipboard_wayland = { version = "0.2.2", path = "./wayland" }
clipboard_x11 = { version = "0.4.2", path = "./x11", optional = true }
clipboard_wayland = { version = "0.2.2", path = "./wayland", optional = true }
[dev-dependencies]
rand = "0.8"

View file

@ -9,9 +9,9 @@ bitflags = "2.5.0"
raw-window-handle = "0.6"
[target.'cfg(all(unix, not(any(target_os="macos", target_os="android", target_os="emscripten", target_os="ios", target_os="redox"))))'.dependencies]
smithay-clipboard = { git = "https://github.com/pop-os/smithay-clipboard", tag = "pop-dnd-3", features = [
smithay-clipboard = { git = "https://github.com/pop-os/smithay-clipboard", tag = "sctk-0.20", features = [
"dnd",
] }
sctk = { package = "smithay-client-toolkit", git = "https://github.com/Smithay/client-toolkit", default-features = false, features = [
sctk = { package = "smithay-client-toolkit", version = "0.20", default-features = false, features = [
"calloop",
], rev = "3bed072" }
] }

View file

@ -189,9 +189,7 @@ pub enum Icon {
}
#[derive(Clone)]
pub struct DndSurface(
pub Arc<Box<dyn HasWindowHandle + 'static + Send + Sync>>,
);
pub struct DndSurface(pub Arc<dyn HasWindowHandle + 'static + Send + Sync>);
impl Debug for DndSurface {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {

View file

@ -45,13 +45,7 @@ impl<T: mime::AsMimeTypes> AsMimeTypes for DataWrapper<T> {
impl smithay_clipboard::dnd::RawSurface for DndSurface {
unsafe fn get_ptr(&mut self) -> *mut c_void {
// XXX won't panic because this is only called once before it could be
// cloned
Arc::get_mut(&mut self.0)
.unwrap()
.window_handle()
.unwrap()
.get_ptr()
self.0.window_handle().unwrap().get_ptr()
}
}

View file

@ -6,4 +6,4 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[target.'cfg(all(unix, not(any(target_os="macos", target_os="android", target_os="emscripten", target_os="ios", target_os="redox"))))'.dependencies]
smithay-clipboard = { git = "https://github.com/pop-os/smithay-clipboard", tag = "pop-dnd-3" }
smithay-clipboard = { git = "https://github.com/pop-os/smithay-clipboard", tag = "sctk-0.20" }

View file

@ -62,7 +62,7 @@ pub struct PlatformClipboard<C> {
impl PlatformClipboard<platform::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 + ?Sized>(
window: &W,
) -> Result<Self, Box<dyn Error>> {
Ok(PlatformClipboard {

View file

@ -1,12 +1,15 @@
use crate::ClipboardProvider;
use crate::dnd::DndProvider;
use dnd::{DndAction, DndDestinationRectangle, DndSurface, Icon};
use mime::{AllowedMimeTypes, AsMimeTypes};
use raw_window_handle::HasDisplayHandle;
use std::error::Error;
use std::{borrow::Cow, error::Error};
pub fn connect<W: HasDisplayHandle>(
_window: &W,
) -> Result<Clipboard, Box<dyn Error>> {
Ok(Clipboard::new())
Clipboard::new()
}
pub struct Clipboard;
@ -36,7 +39,46 @@ impl ClipboardProvider for Clipboard {
Err(Box::new(AndroidClipboardError::Unimplemented))
}
fn write(&mut self, contents: String) -> Result<(), Box<dyn Error>> {
fn write(&mut self, _contents: String) -> Result<(), Box<dyn Error>> {
Err(Box::new(AndroidClipboardError::Unimplemented))
}
}
impl DndProvider for Clipboard {
fn init_dnd(
&self,
_tx: Box<dyn dnd::Sender<DndSurface> + Send + Sync + 'static>,
) {
}
fn start_dnd<D: AsMimeTypes + Send + 'static>(
&self,
_internal: bool,
_source_surface: DndSurface,
_icon_surface: Option<Icon>,
_content: D,
_actions: DndAction,
) {
}
fn end_dnd(&self) {}
fn register_dnd_destination(
&self,
_surface: DndSurface,
_rectangles: Vec<DndDestinationRectangle>,
) {
}
fn set_action(&self, _action: DndAction) {}
fn peek_offer<D: AllowedMimeTypes + 'static>(
&self,
_mime_type: Option<Cow<'static, str>>,
) -> std::io::Result<D> {
Err(std::io::Error::new(
std::io::ErrorKind::Other,
"DnD not supported",
))
}
}

View file

@ -7,7 +7,7 @@ use std::borrow::Cow;
pub struct Clipboard;
pub fn connect<W: HasDisplayHandle>(
pub fn connect<W: HasDisplayHandle + ?Sized>(
_window: &W,
) -> Result<Clipboard, Box<dyn std::error::Error>> {
Ok(Clipboard)

View file

@ -3,7 +3,7 @@ use crate::ClipboardProvider;
use raw_window_handle::HasDisplayHandle;
use std::error::Error;
pub fn connect<W: HasDisplayHandle>(
pub fn connect<W: HasDisplayHandle + ?Sized>(
_window: &W,
) -> Result<Clipboard, Box<dyn Error>> {
Clipboard::new()

View file

@ -11,10 +11,12 @@ use std::{borrow::Cow, error::Error, sync::Arc};
use wayland::DndSender;
pub use clipboard_wayland as wayland;
#[cfg(feature = "x11")]
pub use clipboard_x11 as x11;
pub enum Clipboard {
Wayland(wayland::Clipboard),
#[cfg(feature = "x11")]
X11(x11::Clipboard),
}
@ -22,6 +24,7 @@ impl ClipboardProvider for Clipboard {
fn read(&self) -> Result<String, Box<dyn Error>> {
match self {
Clipboard::Wayland(c) => c.read(),
#[cfg(feature = "x11")]
Clipboard::X11(c) => c.read().map_err(Box::from),
}
}
@ -29,6 +32,7 @@ impl ClipboardProvider for Clipboard {
fn write(&mut self, contents: String) -> Result<(), Box<dyn Error>> {
match self {
Clipboard::Wayland(c) => c.write(contents),
#[cfg(feature = "x11")]
Clipboard::X11(c) => c.write(contents).map_err(Box::from),
}
}
@ -36,6 +40,7 @@ impl ClipboardProvider for Clipboard {
fn read_primary(&self) -> Option<Result<String, Box<dyn Error>>> {
match self {
Clipboard::Wayland(c) => Some(c.read_primary()),
#[cfg(feature = "x11")]
Clipboard::X11(c) => Some(c.read_primary().map_err(Box::from)),
}
}
@ -46,6 +51,7 @@ impl ClipboardProvider for Clipboard {
) -> Option<Result<(), Box<dyn Error>>> {
match self {
Clipboard::Wayland(c) => Some(c.write_primary(contents)),
#[cfg(feature = "x11")]
Clipboard::X11(c) => {
Some(c.write_primary(contents).map_err(Box::from))
}
@ -61,6 +67,7 @@ impl ClipboardProvider for Clipboard {
let ret = c.read_data::<ClipboardLoadData<T>>();
Some(ret.map(|ret| ret.0))
}
#[cfg(feature = "x11")]
Clipboard::X11(_) => None,
}
}
@ -76,6 +83,7 @@ impl ClipboardProvider for Clipboard {
Clipboard::Wayland(c) => {
Some(c.write_data::<ClipboardStoreData<T>>(contents))
}
#[cfg(feature = "x11")]
Clipboard::X11(_) => None,
}
}
@ -89,6 +97,7 @@ impl ClipboardProvider for Clipboard {
let ret = c.read_primary_data::<ClipboardLoadData<T>>();
Some(ret.map(|ret| ret.0))
}
#[cfg(feature = "x11")]
Clipboard::X11(_) => None,
}
}
@ -99,6 +108,7 @@ impl ClipboardProvider for Clipboard {
) -> Option<Result<(Vec<u8>, String), Box<dyn Error>>> {
match self {
Clipboard::Wayland(c) => Some(c.read_primary_raw(allowed)),
#[cfg(feature = "x11")]
Clipboard::X11(_) => None,
}
}
@ -109,6 +119,7 @@ impl ClipboardProvider for Clipboard {
) -> Option<Result<(Vec<u8>, String), Box<dyn Error>>> {
match self {
Clipboard::Wayland(c) => Some(c.read_raw(allowed)),
#[cfg(feature = "x11")]
Clipboard::X11(_) => None,
}
}
@ -124,6 +135,7 @@ impl ClipboardProvider for Clipboard {
Clipboard::Wayland(c) => {
Some(c.write_primary_data::<ClipboardStoreData<T>>(contents))
}
#[cfg(feature = "x11")]
Clipboard::X11(_) => None,
}
}
@ -135,7 +147,8 @@ impl DndProvider for Clipboard {
tx: Box<dyn dnd::Sender<DndSurface> + Send + Sync + 'static>,
) {
match self {
Clipboard::Wayland(c) => c.init_dnd(DndSender(Arc::new(tx))),
Clipboard::Wayland(c) => c.init_dnd(DndSender(Arc::from(tx))),
#[cfg(feature = "x11")]
Clipboard::X11(_) => {}
}
}
@ -156,6 +169,7 @@ impl DndProvider for Clipboard {
content,
actions,
),
#[cfg(feature = "x11")]
Clipboard::X11(_) => {}
}
}
@ -163,6 +177,7 @@ impl DndProvider for Clipboard {
fn end_dnd(&self) {
match self {
Clipboard::Wayland(c) => c.end_dnd(),
#[cfg(feature = "x11")]
Clipboard::X11(_) => {}
}
}
@ -176,6 +191,7 @@ impl DndProvider for Clipboard {
Clipboard::Wayland(c) => {
c.register_dnd_destination(surface, rectangles)
}
#[cfg(feature = "x11")]
Clipboard::X11(_) => {}
}
}
@ -183,6 +199,7 @@ impl DndProvider for Clipboard {
fn set_action(&self, action: DndAction) {
match self {
Clipboard::Wayland(c) => c.set_action(action),
#[cfg(feature = "x11")]
Clipboard::X11(_) => {}
}
}
@ -193,6 +210,7 @@ impl DndProvider for Clipboard {
) -> std::io::Result<D> {
match self {
Clipboard::Wayland(c) => c.peek_offer::<D>(mime_type),
#[cfg(feature = "x11")]
Clipboard::X11(_) => Err(std::io::Error::new(
std::io::ErrorKind::Other,
"DnD not supported",
@ -201,14 +219,22 @@ impl DndProvider for Clipboard {
}
}
pub unsafe fn connect<W: HasDisplayHandle>(
pub unsafe fn connect<W: HasDisplayHandle + ?Sized>(
window: &W,
) -> Result<Clipboard, Box<dyn Error>> {
let clipboard = match window.display_handle()?.as_raw() {
RawDisplayHandle::Wayland(handle) => Clipboard::Wayland(
wayland::Clipboard::connect(handle.display.as_ptr()),
) as _,
#[cfg(feature = "x11")]
_ => Clipboard::X11(x11::Clipboard::connect()?) as _,
#[cfg(not(feature = "x11"))]
_ => {
return Err(Box::from(
"Yoda window_clipboard: X11 feature disabled; \
non-Wayland display handles are not supported",
))
}
};
Ok(clipboard)

View file

@ -1,15 +1,57 @@
use crate::ClipboardProvider;
use crate::dnd::DndProvider;
pub(crate) use clipboard_macos::Clipboard;
use dnd::{DndAction, DndDestinationRectangle, DndSurface, Icon};
use mime::{AllowedMimeTypes, AsMimeTypes};
use raw_window_handle::HasDisplayHandle;
use std::error::Error;
use std::{borrow::Cow, error::Error};
pub fn connect<W: HasDisplayHandle>(
pub fn connect<W: HasDisplayHandle + ?Sized>(
_window: &W,
) -> Result<Clipboard, Box<dyn Error>> {
Clipboard::new()
}
impl DndProvider for Clipboard {
fn init_dnd(
&self,
_tx: Box<dyn dnd::Sender<DndSurface> + Send + Sync + 'static>,
) {
}
fn start_dnd<D: AsMimeTypes + Send + 'static>(
&self,
_internal: bool,
_source_surface: DndSurface,
_icon_surface: Option<Icon>,
_content: D,
_actions: DndAction,
) {
}
fn end_dnd(&self) {}
fn register_dnd_destination(
&self,
_surface: DndSurface,
_rectangles: Vec<DndDestinationRectangle>,
) {
}
fn set_action(&self, _action: DndAction) {}
fn peek_offer<D: AllowedMimeTypes + 'static>(
&self,
_mime_type: Option<Cow<'static, str>>,
) -> std::io::Result<D> {
Err(std::io::Error::new(
std::io::ErrorKind::Other,
"DnD not supported",
))
}
}
impl ClipboardProvider for Clipboard {
fn read(&self) -> Result<String, Box<dyn Error>> {
self.read()

View file

@ -1,15 +1,55 @@
use crate::ClipboardProvider;
use crate::dnd::DndProvider;
use clipboard_win::{get_clipboard_string, set_clipboard_string};
use dnd::{DndAction, DndDestinationRectangle, DndSurface, Icon};
use mime::{AllowedMimeTypes, AsMimeTypes};
use raw_window_handle::HasDisplayHandle;
use std::{borrow::Cow, error::Error};
use std::error::Error;
pub fn connect<W: HasDisplayHandle>(
pub fn connect<W: HasDisplayHandle + ?Sized>(
_window: &W,
) -> Result<Clipboard, Box<dyn Error>> {
Ok(Clipboard)
}
impl DndProvider for Clipboard {
fn init_dnd(
&self,
_tx: Box<dyn dnd::Sender<DndSurface> + Send + Sync + 'static>,
) {
}
fn start_dnd<D: AsMimeTypes + Send + 'static>(
&self,
_internal: bool,
_source_surface: DndSurface,
_icon_surface: Option<Icon>,
_content: D,
_actions: DndAction,
) {
}
fn end_dnd(&self) {}
fn register_dnd_destination(
&self,
_surface: DndSurface,
_rectangles: Vec<DndDestinationRectangle>,
) {
}
fn set_action(&self, _action: DndAction) {}
fn peek_offer<D: AllowedMimeTypes + 'static>(
&self,
_mime_type: Option<Cow<'static, str>>,
) -> std::io::Result<D> {
Err(std::io::Error::new(
std::io::ErrorKind::Other,
"DnD not supported",
))
}
}
pub struct Clipboard;

View file

@ -11,7 +11,7 @@ keywords = ["clipboard", "wayland"]
[dependencies]
smithay-clipboard = { git = "https://github.com/pop-os/smithay-clipboard", tag = "pop-dnd-3", features = [
smithay-clipboard = { git = "https://github.com/pop-os/smithay-clipboard", tag = "sctk-0.20", features = [
"dnd",
] }
mime = { path = "../mime" }

View file

@ -27,9 +27,7 @@ use smithay_clipboard::dnd::{Icon, Rectangle};
pub use smithay_clipboard::mime::{AllowedMimeTypes, AsMimeTypes, MimeType};
#[derive(Clone)]
pub struct DndSender(
pub Arc<Box<dyn Sender<DndSurface> + 'static + Send + Sync>>,
);
pub struct DndSender(pub Arc<dyn Sender<DndSurface> + 'static + Send + Sync>);
impl smithay_clipboard::dnd::Sender<DndSurface> for DndSender {
fn send(