Implement getting HTML on X11

examples/get_html.rs

@@ -0,0 +1,9 @@
+use arboard::Clipboard;
+
+fn main() {
+	let mut ctx = Clipboard::new().unwrap();
+
+	let html_data = ctx.get_html().unwrap();
+
+	println!("HTML data is:\n{:?}\nAlt text is:\n{:?}", html_data.html, html_data.alt_text);
+}

examples/hello_html.rs

@@ -0,0 +1,15 @@
+use arboard::Clipboard;
+
+fn main() {
+	env_logger::init();
+	let mut clipboard = Clipboard::new().unwrap();
+	println!("Clipboard text was: {:?}", clipboard.get_html());
+
+	let html = "<h1>Hello, world!</h1><p>This is HTML.</p>";
+	let alt_text = "Hello, world!\nThis is HTML.";
+	clipboard.set_html(html, Some(alt_text)).unwrap();
+	println!(
+		"But now the clipboard text should be this HTML: \"{}\" with this alternate text: \"{}\"",
+		html, alt_text
+	);
+}

src/common.rs

@@ -146,6 +146,22 @@ impl<'a> ImageData<'a> {
 	}
 }
 
+#[derive(Debug, Default)]
+pub struct HTMLData {
+	pub html: String,
+	pub alt_text: String,
+}
+
+impl HTMLData {
+	pub fn from_html(html: String) -> Self {
+		Self { html, ..Default::default() }
+	}
+
+	pub fn from_alt_text(alt_text: String) -> Self {
+		Self { alt_text, ..Default::default() }
+	}
+}
+
 #[cfg(any(windows, all(unix, not(target_os = "macos"))))]
 pub(crate) struct ScopeGuard<F: FnOnce()> {
 	callback: Option<F>,

src/lib.rs

@@ -12,6 +12,7 @@ mod common;
 use std::borrow::Cow;
 
 pub use common::Error;
+use common::HTMLData;
 #[cfg(feature = "image-data")]
 pub use common::ImageData;
 
@@ -78,6 +79,11 @@ impl Clipboard {
 		self.set().text(text)
 	}
 
+	/// Fetches HTML from the clipboard and returns it.
+	pub fn get_html(&mut self) -> Result<HTMLData, Error> {
+		self.get().html()
+	}
+
 	/// Places the HTML as well as a plain-text alternative onto the clipboard.
 	///
 	/// Any valid UTF-8 string is accepted.
@@ -145,6 +151,11 @@ impl Get<'_> {
 		self.platform.text()
 	}
 
+	/// Completes the "get" operation by fetching HTML data from the clipboard.
+	pub fn html(self) -> Result<HTMLData, Error> {
+		self.platform.html()
+	}
+
 	/// Completes the "get" operation by fetching image data from the clipboard and returning the
 	/// decoded pixels.
 	///

src/platform/linux/mod.rs

@@ -1,5 +1,7 @@
 use std::borrow::Cow;
 
+use crate::HTMLData;
+
 #[cfg(feature = "wayland-data-control")]
 use log::{trace, warn};
 
@@ -114,6 +116,14 @@ impl<'clipboard> Get<'clipboard> {
 		}
 	}
 
+	pub(crate) fn html(self) -> Result<HTMLData, Error> {
+		match self.clipboard {
+			Clipboard::X11(clipboard) => clipboard.get_html(self.selection),
+			#[cfg(feature = "wayland-data-control")]
+			Clipboard::WlDataControl(clipboard) => Err("not implemented"),
+		}
+	}
+
 	#[cfg(feature = "image-data")]
 	pub(crate) fn image(self) -> Result<ImageData<'static>, Error> {
 		match self.clipboard {

src/platform/linux/x11.rs

@@ -48,7 +48,10 @@ use super::encode_as_png;
 use super::{into_unknown, LinuxClipboardKind};
 #[cfg(feature = "image-data")]
 use crate::ImageData;
-use crate::{common::ScopeGuard, Error};
+use crate::{
+	common::{HTMLData, ScopeGuard},
+	Error,
+};
 
 type Result<T, E = Error> = std::result::Result<T, E>;
 
@@ -884,6 +887,39 @@ impl Clipboard {
 		self.inner.write(data, selection, wait)
 	}
 
+	pub(crate) fn get_html(&self, selection: LinuxClipboardKind) -> Result<HTMLData> {
+		let html_format = [self.inner.atoms.HTML];
+		let alt_text_formats = [
+			self.inner.atoms.UTF8_STRING,
+			self.inner.atoms.UTF8_MIME_0,
+			self.inner.atoms.UTF8_MIME_1,
+			self.inner.atoms.STRING,
+			self.inner.atoms.TEXT,
+			self.inner.atoms.TEXT_MIME_UNKNOWN,
+		];
+
+		let mut data = HTMLData::default();
+
+		let html_result = self.inner.read(&html_format, selection);
+		if let Ok(html_data) = html_result {
+			let html: String = html_data.bytes.into_iter().map(|c| c as char).collect();
+			data.html = html;
+		}
+
+		let alt_text_result = self.inner.read(&alt_text_formats, selection);
+		if let Ok(alt_text_data) = alt_text_result {
+			data.alt_text = if alt_text_data.format == self.inner.atoms.STRING {
+				// ISO Latin-1
+				// See: https://stackoverflow.com/questions/28169745/what-are-the-options-to-convert-iso-8859-1-latin-1-to-a-string-utf-8
+				alt_text_data.bytes.into_iter().map(|c| c as char).collect::<String>()
+			} else {
+				String::from_utf8(alt_text_data.bytes).map_err(|_| Error::ConversionFailure)?
+			};
+		}
+
+		Ok(data)
+	}
+
 	pub(crate) fn set_html(
 		&self,
 		html: Cow<'_, str>,