Add text granularity setting to screen reader

odilia-app · Nov 27, 2022 · bf094b4 · bf094b4
1 parent e01bad0
commit bf094b4
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 3 deletions.
diff --git a/common/Cargo.toml b/common/Cargo.toml
@@ -13,7 +13,7 @@ edition = "2021"
 publish = false
 
 [dependencies]
-atspi = { version = "^0.3.5", default-features = false, features = ["tokio"] }
+atspi = { version = "^0.3.6", default-features = false, features = ["tokio"] }
 bitflags = "1.3.2"
 serde = "1.0.147"
 smartstring = "1.0.1"

diff --git a/common/src/events.rs b/common/src/events.rs
@@ -3,7 +3,10 @@ use serde::{
   Deserialize,
 };
 
-use atspi::accessible::Role;
+use atspi::{
+  accessible::Role,
+  text::TextGranularity,
+};
 use crate::modes::ScreenReaderMode;
 
 #[derive(Eq, PartialEq, Clone, Hash, Serialize, Deserialize)]
@@ -28,5 +31,6 @@ pub enum ScreenReaderEvent {
     Enable(Feature),
     Disable(Feature),
     ChangeMode(ScreenReaderMode),
+    ChangeGranularity(TextGranularity),
     StructuralNavigation(Direction, Role),
 }
diff --git a/odilia/src/events/mod.rs b/odilia/src/events/mod.rs
@@ -77,6 +77,11 @@ pub async fn sr_event(
                         }
                     },
                     Some(ScreenReaderEvent::StopSpeech) => tracing::trace!("Stopping speech!"),
+                    Some(ScreenReaderEvent::ChangeGranularity(granularity)) => {
+                      tracing::debug!("Changing granularity of read text.");
+                      let mut sr_granularity = state.granularity.lock().await;
+                      *sr_granularity = granularity;
+                    },
                     Some(ScreenReaderEvent::ChangeMode(ScreenReaderMode { name })) => {
                         tracing::debug!("Changing mode to {:?}", name);
                         //let _ = mode_channel.send(ScreenReaderMode { name }).await;

diff --git a/odilia/src/state.rs b/odilia/src/state.rs
@@ -7,7 +7,7 @@ use tokio::sync::Mutex;
 use zbus::{fdo::DBusProxy, names::UniqueName, zvariant::ObjectPath};
 
 use crate::cache::Cache;
-use atspi::{accessible::AccessibleProxy, cache::CacheProxy, accessible_ext::AccessibleExt, convertable::Convertable};
+use atspi::{accessible::AccessibleProxy, cache::CacheProxy, accessible_ext::AccessibleExt, convertable::Convertable, text::TextGranularity};
 use odilia_common::{modes::ScreenReaderMode, settings::ApplicationConfig, types::{TextSelectionArea }};
 
 pub struct ScreenReaderState {
@@ -17,6 +17,7 @@ pub struct ScreenReaderState {
     pub config: ApplicationConfig,
     pub previous_caret_position: Cell<i32>,
     pub mode: Mutex<ScreenReaderMode>,
+    pub granularity: Mutex<TextGranularity>,
     pub accessible_history: Mutex<CircularQueue<(UniqueName<'static>, ObjectPath<'static>)>>,
     pub cache: Cache,
 }
@@ -67,13 +68,16 @@ impl ScreenReaderState {
         let previous_caret_position = Cell::new(0);
         let accessible_history = Mutex::new(CircularQueue::with_capacity(16));
         let cache = Cache::new();
+
+        let granularity = Mutex::new(TextGranularity::Line);
         Ok(Self {
             atspi,
             dbus,
             speaker,
             config,
             previous_caret_position,
             mode,
+            granularity,
             accessible_history,
             cache,
         })

diff --git a/sohkd/sohkdrc b/sohkd/sohkdrc
@@ -1,3 +1,18 @@
+# using arrow keys will change the granulairty of your text reading.
+~up
+	@odilia {"event":"changeGranularity","args":{"granularity":"line"}}
+~down
+	@odilia {"event":"changeGranularity","args":{"granularity":"line"}}
+~control + right
+	@odilia {"event":"changeGranularity","args":{"granularity":"word"}}
+~control + left
+	@odilia {"event":"changeGranularity","args":{"granularity":"word"}}
+~left
+	@odilia {"event":"changeGranularity","args":{"granularity":"char"}}
+~right
+	@odilia {"event":"changeGranularity","args":{"granularity":"char"}}
+# end of arrow keys
+
 capslock + b
 	@enter browse
 	@odilia {"event":"changeMode","args":{"name":"browse"}}