Enum enrichment

atspi-common/Cargo.toml

@@ -14,14 +14,16 @@ rust-version.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
+strum = ["dep:strum"]
 default = ["async-std"]
-async-std = ["zbus/async-io"]
-tokio = ["zbus/tokio"]
+async-std = ["zbus/async-io", "strum"]
+tokio = ["zbus/tokio", "strum"]
 
 [dependencies]
 enumflags2 = "0.7.7"
 serde = "1.0"
 static_assertions = "1.1.0"
+strum = { version = "0.26", features = ["derive"], optional = true }
 zbus-lockstep = "0.4.4"
 zbus-lockstep-macros = "0.4.4"
 zbus_names = "3.0"
@@ -30,10 +32,10 @@ zbus = { workspace = true, optional = true, default-features = false }
 
 [dev-dependencies]
 atspi-connection = { path = "../atspi-connection" }
-atspi-proxies = { path = "../atspi-proxies"  }
+atspi-proxies = { path = "../atspi-proxies" }
 rename-item = "0.1.0"
 serde_plain = "1.0.1"
-static_assertions = "1.1.0"
+strum = { version = "0.26", features = ["derive"] }
 tokio-stream = { version = "0.1", default-features = false, features = ["time"] }
 tokio = { version = "1", default-features = false, features = ["macros", "rt-multi-thread"] }
 tokio-test = "0.4.2"

atspi-common/src/events/mod.rs

@@ -9,7 +9,7 @@ pub mod window;
 // Unmarshalled event body signatures: These outline the event specific deserialized event types.
 // Safety: These are evaluated at compile time.
 // ----
-// The signal signature "(so)" (an Accessible) is ambiguous, because it is used in:
+// The signal signature "(so)" (`ObjectRef`) is ambiguous, because it is used in:
 // -  Cache : RemoveAccessible
 // -  Socket: Available  *( signals the availability of the `Registry` daemon.)
 //
@@ -227,6 +227,7 @@ pub enum Event {
 	Listener(EventListenerEvents),
 }
 
+#[cfg(feature = "strum")]
 impl EventTypeProperties for Event {
 	fn member(&self) -> &'static str {
 		match self {

atspi-common/src/events/object.rs

@@ -1,10 +1,10 @@
-use std::hash::Hash;
-
 use crate::{
 	error::AtspiError,
 	events::{BusProperties, EventBodyOwned, HasMatchRule, HasRegistryEventString, ObjectRef},
-	Event, EventProperties, EventTypeProperties, State,
+	Event, EventProperties, State,
 };
+#[cfg(feature = "strum")]
+use crate::{EventTypeProperties, Live};
 use zbus_names::BusName;
 use zvariant::{ObjectPath, OwnedValue, Value};
 
@@ -56,6 +56,7 @@
 	TextCaretMoved(TextCaretMovedEvent),
 }
 
+#[cfg(feature = "strum")]
 impl EventTypeProperties for ObjectEvents {
 	fn member(&self) -> &'static str {
 		match self {
@@ -236,7 +237,7 @@
 	pub value: Property,
 }
 
-impl Hash for PropertyChangeEvent {
+impl core::hash::Hash for PropertyChangeEvent {
 	fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
 		self.item.hash(state);
 		self.property.hash(state);
@@ -307,6 +308,7 @@
 	}
 }
 
+#[cfg(feature = "strum")]
 impl TryFrom<EventBodyOwned> for Property {
 	type Error = AtspiError;
 
@@ -329,9 +331,7 @@
 					.any_data
 					.try_into()
 					.map_err(|_| AtspiError::ParseError("accessible-role"))?;
-				let role: crate::Role = crate::Role::try_from(role_int)
-					.map_err(|_| AtspiError::ParseError("accessible-role"))?;
-				role
+				crate::Role::from_repr(role_int).ok_or(AtspiError::ParseError("accessible-role"))?
 			})),
 			"accessible-parent" => Ok(Self::Parent(
 				body.any_data
@@ -578,6 +578,7 @@
 	pub position: i32,
 }
 
+#[cfg(feature = "strum")]
 impl BusProperties for PropertyChangeEvent {
 	const DBUS_MEMBER: &'static str = "PropertyChange";
 	const DBUS_INTERFACE: &'static str = "org.a11y.atspi.Event.Object";
@@ -634,6 +635,7 @@
 	}
 }
 
+#[cfg(feature = "strum")]
 impl BusProperties for StateChangedEvent {
 	const DBUS_MEMBER: &'static str = "StateChanged";
 	const DBUS_INTERFACE: &'static str = "org.a11y.atspi.Event.Object";
@@ -747,6 +749,7 @@
 	}
 }
 
+#[cfg(feature = "strum")]
 impl BusProperties for AnnouncementEvent {
 	const DBUS_MEMBER: &'static str = "Announcement";
 	const DBUS_INTERFACE: &'static str = "org.a11y.atspi.Event.Object";
@@ -760,7 +763,8 @@
 		Ok(Self {
 			item,
 			text: body.any_data.try_into().map_err(|_| AtspiError::Conversion("text"))?,
-			live: body.detail1.try_into()?,
+			live: Live::from_repr(body.detail1)
+				.ok_or(AtspiError::Conversion("\"detail1\" not convertable to \"Live\""))?,
 		})
 	}
 	fn body(&self) -> Self::Body {
@@ -1039,6 +1043,7 @@
 	Event::Object
 );
 
+#[cfg(feature = "strum")]
 event_test_cases!(PropertyChangeEvent);
 impl_to_dbus_message!(PropertyChangeEvent);
 impl_from_dbus_message!(PropertyChangeEvent);
@@ -1121,10 +1126,12 @@
 	ObjectEvents::StateChanged,
 	Event::Object
 );
+#[cfg(feature = "strum")]
 event_test_cases!(StateChangedEvent);
 impl_to_dbus_message!(StateChangedEvent);
 impl_from_dbus_message!(StateChangedEvent);
 impl_event_properties!(StateChangedEvent);
+#[cfg(feature = "strum")]
 impl From<StateChangedEvent> for EventBodyOwned {
 	fn from(event: StateChangedEvent) -> Self {
 		EventBodyOwned {
@@ -1293,6 +1300,7 @@
 	ObjectEvents::Announcement,
 	Event::Object
 );
+#[cfg(feature = "strum")]
 event_test_cases!(AnnouncementEvent);
 impl_to_dbus_message!(AnnouncementEvent);
 impl_from_dbus_message!(AnnouncementEvent);