Add fallback to internal clipboard when Arboard is disabled or fails to initiate

Author: idanarye

CHANGELOG.md

@@ -37,8 +37,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   selected entity from the level.
 - Copy/paste support for entities: Use `Ctrl+C` to copy and `Ctrl+V` to paste
   entities with all their components and values.
-  - Cross-level entity copying: Entities can be copied between different level
+  - Cross-editor entity copying: Entities can be copied between different level
     editors through system clipboard (opt in via the `arboard` feature)
+  - If `arboard` is not enabled the copy/paste will not be cross-editor
 - Entity deletion via keyboard in addition to the existing UI button.
 - Auto-selection of pasted entities: Newly pasted entities are automatically
   selected for immediate editing.

Cargo.toml

@@ -46,7 +46,7 @@ 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.
+# Support clipboard with the Arboard crate. Otherwise the clipboard will be internal.
 arboard = ["dep:arboard"]
 # Enable Wayland support in Arboard.
 arboard_wayland = ["arboard", "arboard/wayland-data-control"]

src/vpeol.rs

@@ -73,6 +73,7 @@ impl Plugin for VpeolBasePlugin {
             )
                 .chain(), // .run_if(in_state(YoleckEditorState::EditorActive)),
         );
+        app.init_resource::<VpeolClipboard>();
         app.add_systems(
             Update,
             (prepare_camera_state, update_camera_world_position)
@@ -757,11 +758,35 @@ fn handle_delete_entity_key(
     Ok(())
 }
 
+#[derive(Resource)]
+enum VpeolClipboard {
+    #[cfg(feature = "arboard")]
+    Arboard(arboard::Clipboard),
+    Internal(String),
+}
+
+impl FromWorld for VpeolClipboard {
+    fn from_world(_: &mut World) -> Self {
+        #[cfg(feature = "arboard")]
+        match arboard::Clipboard::new() {
+            Ok(clipboard) => {
+                debug!("Arboard clipbaord successfully initiated");
+                return VpeolClipboard::Arboard(clipboard);
+            }
+            Err(err) => {
+                warn!("Cannot initiate Arboard clipboard: {err}");
+            }
+        }
+        VpeolClipboard::Internal(String::new())
+    }
+}
+
 fn handle_copy_entity_key(
     mut egui_context: EguiContexts,
     keyboard_input: Res<ButtonInput<KeyCode>>,
     query: Query<&YoleckManaged, With<YoleckEditMarker>>,
     construction_specs: Res<YoleckEntityConstructionSpecs>,
+    mut clipboard: ResMut<VpeolClipboard>,
 ) -> Result {
     if egui_context.ctx_mut()?.wants_keyboard_input() {
         return Ok(());
@@ -800,14 +825,17 @@ 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) {
+        if !entities.is_empty()
+            && let Ok(json) = serde_json::to_string(&entities)
+        {
+            match clipboard.as_mut() {
                 #[cfg(feature = "arboard")]
-                {
-                    let mut clipboard = arboard::Clipboard::new()?;
+                VpeolClipboard::Arboard(clipboard) => {
                     clipboard.set_text(json)?;
                 }
+                VpeolClipboard::Internal(clipboard) => {
+                    *clipboard = json;
+                }
             }
         }
     }
@@ -822,6 +850,7 @@ fn handle_paste_entity_key(
     mut commands: Commands,
     mut writer: MessageWriter<YoleckEditorEvent>,
     query: Query<Entity, With<YoleckEditMarker>>,
+    mut clipboard: ResMut<VpeolClipboard>,
 ) -> Result {
     if egui_context.ctx_mut()?.wants_keyboard_input() {
         return Ok(());
@@ -831,19 +860,30 @@ fn handle_paste_entity_key(
         || keyboard_input.pressed(KeyCode::ControlRight);
 
     if ctrl_pressed && keyboard_input.just_pressed(KeyCode::KeyV) {
-        #[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()
+        let arboard_text_storage: String;
+        let text_to_paste: Option<&str> = match clipboard.as_mut() {
+            #[cfg(feature = "arboard")]
+            VpeolClipboard::Arboard(clipboard) => match clipboard.get_text() {
+                Ok(text) => {
+                    arboard_text_storage = text;
+                    Some(&arboard_text_storage)
+                }
+                Err(err) => {
+                    error!("Cannot load text from arboard: {err}");
+                    None
+                }
+            },
+            VpeolClipboard::Internal(clipboard) => {
+                Some(clipboard.as_str()).filter(|txt| !txt.is_empty())
+            }
         };
 
-        // TODO: add fallback when arboard is not enabled or doesn't work
-
         if let Some(text) = text_to_paste
-            && let Ok(entities) = serde_json::from_str::<Vec<YoleckRawEntry>>(&text)
+            && let Ok(entities) =
+                serde_json::from_str::<Vec<YoleckRawEntry>>(text).inspect_err(|err| {
+                    warn!("Cannot paste - failure to parse copied text: {err}");
+                })
             && !entities.is_empty()
         {
             for prev_selected in query.iter() {