Make the clipboard opt-in

Author: idanarye

Cargo.toml

@@ -33,13 +33,15 @@ serde = "^1"
 serde_json = "^1"
 thiserror = "^2"
 uuid = "1.9.1"
-arboard = "3.4"
+arboard = {version = "3.4", optional = true}
 
 [features]
 bevy_reflect = []
 vpeol = []
 vpeol_2d = ["vpeol", "bevy/bevy_text", "bevy/bevy_sprite", "bevy/png"]
 vpeol_3d = ["vpeol", "bevy/bevy_pbr"]
+# Support clipboard with the arboard crate.
+arboard = ["dep:arboard"]
 _example2d_full = ["vpeol_2d", "bevy/bevy_gizmos", "bevy/bevy_sprite_render"]
 _example3d_full = [
     "vpeol_3d",

src/vpeol_2d.rs

@@ -534,9 +534,13 @@ fn handle_copy_entity_key(
             .collect();
 
         if !entities.is_empty() {
+            #[allow(unused_variables)] // TODO: try to remove when the arboard alternative gets in
             if let Ok(json) = serde_json::to_string(&entities) {
-                let mut clipboard = arboard::Clipboard::new()?;
-                clipboard.set_text(json)?;
+                #[cfg(feature = "arboard")]
+                {
+                    let mut clipboard = arboard::Clipboard::new()?;
+                    clipboard.set_text(json)?;
+                }
             }
         }
     }
@@ -560,8 +564,18 @@ fn handle_paste_entity_key(
         || keyboard_input.pressed(KeyCode::ControlRight);
 
     if ctrl_pressed && keyboard_input.just_pressed(KeyCode::KeyV) {
-        let mut clipboard = arboard::Clipboard::new()?;
-        if let Ok(text) = clipboard.get_text() {
+        #[allow(unused_variables)] // TODO: try to remove when the arboard alternative gets in
+        let text_to_paste: Option<String> = None;
+
+        #[cfg(feature = "arboard")]
+        let text_to_paste = {
+            let mut clipboard = arboard::Clipboard::new()?;
+            clipboard.get_text().ok()
+        };
+
+        // TODO: add fallback when arboard is not enabled or doesn't work
+
+        if let Some(text) = text_to_paste {
             if let Ok(entities) = serde_json::from_str::<Vec<YoleckRawEntry>>(&text) {
                 if !entities.is_empty() {
                     for prev_selected in query.iter() {

src/vpeol_3d.rs

@@ -731,9 +731,13 @@ fn handle_copy_entity_key(
             .collect();
 
         if !entities.is_empty() {
+            #[allow(unused_variables)] // TODO: try to remove when the arboard alternative gets in
             if let Ok(json) = serde_json::to_string(&entities) {
-                let mut clipboard = arboard::Clipboard::new()?;
-                clipboard.set_text(json)?;
+                #[cfg(feature = "arboard")]
+                {
+                    let mut clipboard = arboard::Clipboard::new()?;
+                    clipboard.set_text(json)?;
+                }
             }
         }
     }
@@ -757,8 +761,18 @@ fn handle_paste_entity_key(
         || keyboard_input.pressed(KeyCode::ControlRight);
 
     if ctrl_pressed && keyboard_input.just_pressed(KeyCode::KeyV) {
-        let mut clipboard = arboard::Clipboard::new()?;
-        if let Ok(text) = clipboard.get_text() {
+        #[allow(unused_variables)] // TODO: try to remove when the arboard alternative gets in
+        let text_to_paste: Option<String> = None;
+
+        #[cfg(feature = "arboard")]
+        let text_to_paste = {
+            let mut clipboard = arboard::Clipboard::new()?;
+            clipboard.get_text().ok()
+        };
+
+        // TODO: add fallback when arboard is not enabled or doesn't work
+
+        if let Some(text) = text_to_paste {
             if let Ok(entities) = serde_json::from_str::<Vec<YoleckRawEntry>>(&text) {
                 if !entities.is_empty() {
                     for prev_selected in query.iter() {