feat(clipboard): add plugin (#323)

plugins/clipboard/src/commands.rs

@@ -0,0 +1,24 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use tauri::{command, AppHandle, Runtime, State};
+
+use crate::{ClipKind, Clipboard, ClipboardContents, Result};
+
+#[command]
+pub(crate) async fn write<R: Runtime>(
+    _app: AppHandle<R>,
+    clipboard: State<'_, Clipboard<R>>,
+    data: ClipKind,
+) -> Result<()> {
+    clipboard.write(data)
+}
+
+#[command]
+pub(crate) async fn read<R: Runtime>(
+    _app: AppHandle<R>,
+    clipboard: State<'_, Clipboard<R>>,
+) -> Result<ClipboardContents> {
+    clipboard.read()
+}

plugins/clipboard/src/desktop.rs

@@ -0,0 +1,47 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::de::DeserializeOwned;
+use tauri::{plugin::PluginApi, AppHandle, Runtime};
+
+use crate::models::*;
+
+use std::sync::Mutex;
+
+pub fn init<R: Runtime, C: DeserializeOwned>(
+    app: &AppHandle<R>,
+    _api: PluginApi<R, C>,
+) -> crate::Result<Clipboard<R>> {
+    Ok(Clipboard {
+        app: app.clone(),
+        clipboard: arboard::Clipboard::new().map(Mutex::new),
+    })
+}
+
+/// Access to the clipboard APIs.
+pub struct Clipboard<R: Runtime> {
+    #[allow(dead_code)]
+    app: AppHandle<R>,
+    clipboard: Result<Mutex<arboard::Clipboard>, arboard::Error>,
+}
+
+impl<R: Runtime> Clipboard<R> {
+    pub fn write(&self, kind: ClipKind) -> crate::Result<()> {
+        let ClipKind::PlainText { text, .. } = kind;
+        match &self.clipboard {
+            Ok(clipboard) => clipboard.lock().unwrap().set_text(text).map_err(Into::into),
+            Err(e) => Err(crate::Error::Clipboard(e.to_string())),
+        }
+    }
+
+    pub fn read(&self) -> crate::Result<ClipboardContents> {
+        match &self.clipboard {
+            Ok(clipboard) => {
+                let text = clipboard.lock().unwrap().get_text()?;
+                Ok(ClipboardContents::PlainText(text))
+            }
+            Err(e) => Err(crate::Error::Clipboard(e.to_string())),
+        }
+    }
+}

plugins/clipboard/src/error.rs

@@ -0,0 +1,33 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::{ser::Serializer, Serialize};
+
+pub type Result<T> = std::result::Result<T, Error>;
+
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+    #[cfg(mobile)]
+    #[error(transparent)]
+    PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),
+    #[cfg(desktop)]
+    #[error("{0}")]
+    Clipboard(String),
+}
+
+impl Serialize for Error {
+    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(self.to_string().as_ref())
+    }
+}
+
+#[cfg(desktop)]
+impl From<arboard::Error> for Error {
+    fn from(error: arboard::Error) -> Self {
+        Self::Clipboard(error.to_string())
+    }
+}

plugins/clipboard/src/lib.rs

@@ -0,0 +1,52 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use tauri::{
+    plugin::{Builder, TauriPlugin},
+    Manager, Runtime,
+};
+
+pub use models::*;
+
+#[cfg(desktop)]
+mod desktop;
+#[cfg(mobile)]
+mod mobile;
+
+mod commands;
+mod error;
+mod models;
+
+pub use error::{Error, Result};
+
+#[cfg(desktop)]
+use desktop::Clipboard;
+#[cfg(mobile)]
+use mobile::Clipboard;
+
+/// Extensions to [`tauri::App`], [`tauri::AppHandle`] and [`tauri::Window`] to access the clipboard APIs.
+pub trait ClipboardExt<R: Runtime> {
+    fn clipboard(&self) -> &Clipboard<R>;
+}
+
+impl<R: Runtime, T: Manager<R>> crate::ClipboardExt<R> for T {
+    fn clipboard(&self) -> &Clipboard<R> {
+        self.state::<Clipboard<R>>().inner()
+    }
+}
+
+/// Initializes the plugin.
+pub fn init<R: Runtime>() -> TauriPlugin<R> {
+    Builder::new("clipboard")
+        .invoke_handler(tauri::generate_handler![commands::write, commands::read])
+        .setup(|app, api| {
+            #[cfg(mobile)]
+            let clipboard = mobile::init(app, api)?;
+            #[cfg(desktop)]
+            let clipboard = desktop::init(app, api)?;
+            app.manage(clipboard);
+            Ok(())
+        })
+        .build()
+}

plugins/clipboard/src/mobile.rs

@@ -0,0 +1,42 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::de::DeserializeOwned;
+use tauri::{
+    plugin::{PluginApi, PluginHandle},
+    AppHandle, Runtime,
+};
+
+use crate::models::*;
+
+#[cfg(target_os = "android")]
+const PLUGIN_IDENTIFIER: &str = "app.tauri.clipboard";
+
+#[cfg(target_os = "ios")]
+tauri::ios_plugin_binding!(init_plugin_clipboard);
+
+// initializes the Kotlin or Swift plugin classes
+pub fn init<R: Runtime, C: DeserializeOwned>(
+    _app: &AppHandle<R>,
+    api: PluginApi<R, C>,
+) -> crate::Result<Clipboard<R>> {
+    #[cfg(target_os = "android")]
+    let handle = api.register_android_plugin(PLUGIN_IDENTIFIER, "ClipboardPlugin")?;
+    #[cfg(target_os = "ios")]
+    let handle = api.register_ios_plugin(init_plugin_clipboard)?;
+    Ok(Clipboard(handle))
+}
+
+/// Access to the clipboard APIs.
+pub struct Clipboard<R: Runtime>(PluginHandle<R>);
+
+impl<R: Runtime> Clipboard<R> {
+    pub fn write(&self, kind: ClipKind) -> crate::Result<()> {
+        self.0.run_mobile_plugin("write", kind).map_err(Into::into)
+    }
+
+    pub fn read(&self) -> crate::Result<ClipboardContents> {
+        self.0.run_mobile_plugin("read", ()).map_err(Into::into)
+    }
+}

plugins/clipboard/src/models.rs

@@ -0,0 +1,17 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(tag = "kind", content = "options")]
+pub enum ClipKind {
+    PlainText { label: Option<String>, text: String },
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(tag = "kind", content = "options")]
+pub enum ClipboardContents {
+    PlainText(String),
+}