refactor!: String indices are always in UTF-8 code units (#114)

common/src/lib.rs

@@ -571,16 +571,6 @@ pub enum TextDecoration {
     Wavy,
 }
 
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
-#[cfg_attr(feature = "schemars", derive(JsonSchema))]
-#[cfg_attr(feature = "serde", serde(crate = "serde"))]
-#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
-pub enum StringEncoding {
-    Utf8,
-    Utf16,
-}
-
 // This is NonZeroU128 because we regularly store Option<NodeId>.
 // 128-bit to handle UUIDs.
 pub type NodeIdContent = NonZeroU128;
@@ -607,8 +597,7 @@ impl From<NonZeroU64> for NodeId {
 #[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
 pub struct TextMarker {
     pub marker_type: MarkerType,
-    /// Indices are in code units for the encoding specified in
-    /// [`Tree::source_string_encoding`].
+    /// Indices are in UTF-8 code units.
     pub range: Range<usize>,
 }
 
@@ -639,8 +628,7 @@ fn is_empty<T>(slice: &[T]) -> bool {
     slice.is_empty()
 }
 
-/// Offsets are in code units for the encoding specified in
-/// [`Tree::source_string_encoding`].
+/// Offsets are in UTF-8 code units.
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "schemars", derive(JsonSchema))]
@@ -947,8 +935,7 @@ pub struct Node {
     #[cfg_attr(feature = "serde", serde(skip_serializing_if = "is_empty"))]
     pub character_offsets: Box<[f32]>,
 
-    /// For inline text. The indices of each word, in code units for
-    /// the encoding specified in [`Tree::source_string_encoding`].
+    /// For inline text. The indices of each word, in UTF-8 code units.
     #[cfg_attr(feature = "serde", serde(default))]
     #[cfg_attr(feature = "serde", serde(skip_serializing_if = "is_empty"))]
     pub words: Box<[Range<usize>]>,
@@ -1337,14 +1324,6 @@ impl Node {
 pub struct Tree {
     pub root: NodeId,
 
-    /// The string encoding used by the tree source. This is required
-    /// to disambiguate string indices, e.g. in [`Node::words`].
-    /// When the tree is serialized, the encoding specified by
-    /// the target serialization format is always used. But this way,
-    /// the tree source doesn't have to convert string indices;
-    /// the platform adapter will do this if needed.
-    pub source_string_encoding: StringEncoding,
-
     /// The node that's used as the root scroller, if any. On some platforms
     /// like Android we need to ignore accessibility scroll offsets for
     /// that node and get them from the viewport instead.
@@ -1353,10 +1332,9 @@ pub struct Tree {
 }
 
 impl Tree {
-    pub fn new(root: NodeId, source_string_encoding: StringEncoding) -> Tree {
+    pub fn new(root: NodeId) -> Tree {
         Tree {
             root,
-            source_string_encoding,
             root_scroller: None,
         }
     }

consumer/src/lib.rs

@@ -20,9 +20,7 @@ pub use iterators::{
 #[cfg(test)]
 mod tests {
     use accesskit::kurbo::{Affine, Rect, Vec2};
-    use accesskit::{
-        ActionHandler, ActionRequest, Node, NodeId, Role, StringEncoding, Tree, TreeUpdate,
-    };
+    use accesskit::{ActionHandler, ActionRequest, Node, NodeId, Role, Tree, TreeUpdate};
     use std::num::NonZeroU128;
     use std::sync::Arc;
 
@@ -145,7 +143,7 @@ mod tests {
                 button_3_2,
                 empty_container_3_3_ignored,
             ],
-            tree: Some(Tree::new(ROOT_ID, StringEncoding::Utf8)),
+            tree: Some(Tree::new(ROOT_ID)),
             focus: None,
         };
         crate::tree::Tree::new(initial_update, Box::new(NullActionHandler {}))

consumer/src/node.rs

@@ -533,7 +533,7 @@ impl Node<'_> {
 #[cfg(test)]
 mod tests {
     use accesskit::kurbo::{Point, Rect};
-    use accesskit::{Node, NodeId, Role, StringEncoding, Tree, TreeUpdate};
+    use accesskit::{Node, NodeId, Role, Tree, TreeUpdate};
     use std::num::NonZeroU128;
 
     use crate::tests::*;
@@ -792,7 +792,7 @@ mod tests {
                 },
                 Node::new(NODE_ID_2, Role::Button),
             ],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: None,
         };
         let tree = super::Tree::new(update, Box::new(NullActionHandler {}));
@@ -829,7 +829,7 @@ mod tests {
                     ..Node::new(NODE_ID_5, Role::StaticText)
                 },
             ],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: None,
         };
         let tree = super::Tree::new(update, Box::new(NullActionHandler {}));

consumer/src/tree.rs

@@ -345,7 +345,7 @@ impl Tree {
 
 #[cfg(test)]
 mod tests {
-    use accesskit::{Node, NodeId, Role, StringEncoding, Tree, TreeUpdate};
+    use accesskit::{Node, NodeId, Role, Tree, TreeUpdate};
     use std::num::NonZeroU128;
 
     use crate::tests::NullActionHandler;
@@ -358,7 +358,7 @@ mod tests {
     fn init_tree_with_root_node() {
         let update = TreeUpdate {
             nodes: vec![Node::new(NODE_ID_1, Role::Window)],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: None,
         };
         let tree = super::Tree::new(update, Box::new(NullActionHandler {}));
@@ -378,7 +378,7 @@ mod tests {
                 Node::new(NODE_ID_2, Role::Button),
                 Node::new(NODE_ID_3, Role::Button),
             ],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: None,
         };
         let tree = super::Tree::new(update, Box::new(NullActionHandler {}));
@@ -399,7 +399,7 @@ mod tests {
         let root_node = Node::new(NODE_ID_1, Role::Window);
         let first_update = TreeUpdate {
             nodes: vec![root_node.clone()],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: None,
         };
         let tree = super::Tree::new(first_update, Box::new(NullActionHandler {}));
@@ -457,7 +457,7 @@ mod tests {
                 },
                 Node::new(NODE_ID_2, Role::RootWebArea),
             ],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: None,
         };
         let tree = super::Tree::new(first_update, Box::new(NullActionHandler {}));
@@ -504,7 +504,7 @@ mod tests {
                 Node::new(NODE_ID_2, Role::Button),
                 Node::new(NODE_ID_3, Role::Button),
             ],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: Some(NODE_ID_2),
         };
         let tree = super::Tree::new(first_update, Box::new(NullActionHandler {}));
@@ -569,7 +569,7 @@ mod tests {
                     ..child_node.clone()
                 },
             ],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: None,
         };
         let tree = super::Tree::new(first_update, Box::new(NullActionHandler {}));
@@ -620,7 +620,7 @@ mod tests {
                 Node::new(NODE_ID_2, Role::Button),
                 Node::new(NODE_ID_3, Role::Button),
             ],
-            tree: Some(Tree::new(NODE_ID_1, StringEncoding::Utf8)),
+            tree: Some(Tree::new(NODE_ID_1)),
             focus: Some(NODE_ID_2),
         };
         let tree = super::Tree::new(update.clone(), Box::new(NullActionHandler {}));

platforms/windows/examples/hello_world.rs

@@ -4,8 +4,7 @@ use std::{cell::RefCell, convert::TryInto, mem::drop, num::NonZeroU128, rc::Rc};
 
 use accesskit::kurbo::Rect;
 use accesskit::{
-    Action, ActionHandler, ActionRequest, DefaultActionVerb, Node, NodeId, Role, StringEncoding,
-    Tree, TreeUpdate,
+    Action, ActionHandler, ActionRequest, DefaultActionVerb, Node, NodeId, Role, Tree, TreeUpdate,
 };
 use lazy_static::lazy_static;
 use windows::{
@@ -105,7 +104,7 @@ fn get_initial_state() -> TreeUpdate {
     let button_2 = make_button(BUTTON_2_ID, "Button 2");
     TreeUpdate {
         nodes: vec![root, button_1, button_2],
-        tree: Some(Tree::new(WINDOW_ID, StringEncoding::Utf8)),
+        tree: Some(Tree::new(WINDOW_ID)),
         focus: None,
     }
 }

platforms/windows/examples/winit.rs

@@ -1,6 +1,4 @@
-use accesskit::{
-    Action, ActionHandler, ActionRequest, Node, NodeId, Role, StringEncoding, Tree, TreeUpdate,
-};
+use accesskit::{Action, ActionHandler, ActionRequest, Node, NodeId, Role, Tree, TreeUpdate};
 use accesskit_windows::{Adapter, SubclassingAdapter};
 use std::{
     num::NonZeroU128,
@@ -67,7 +65,7 @@ fn initial_tree_update(state: &State) -> TreeUpdate {
     let button_2 = make_button(BUTTON_2_ID, "Button 2");
     TreeUpdate {
         nodes: vec![root, button_1, button_2],
-        tree: Some(Tree::new(WINDOW_ID, StringEncoding::Utf8)),
+        tree: Some(Tree::new(WINDOW_ID)),
         focus: state.is_window_focused.then_some(state.focus),
     }
 }

platforms/windows/src/tests/simple.rs

@@ -5,9 +5,7 @@
 
 use std::{convert::TryInto, num::NonZeroU128};
 
-use accesskit::{
-    ActionHandler, ActionRequest, Node, NodeId, Role, StringEncoding, Tree, TreeUpdate,
-};
+use accesskit::{ActionHandler, ActionRequest, Node, NodeId, Role, Tree, TreeUpdate};
 use windows::{core::*, Win32::UI::Accessibility::*};
 
 use super::*;
@@ -36,7 +34,7 @@ fn get_initial_state() -> TreeUpdate {
     let button_2 = make_button(BUTTON_2_ID, "Button 2");
     TreeUpdate {
         nodes: vec![root, button_1, button_2],
-        tree: Some(Tree::new(WINDOW_ID, StringEncoding::Utf8)),
+        tree: Some(Tree::new(WINDOW_ID)),
         focus: None,
     }
 }

platforms/windows/src/tests/subclassed.rs

@@ -5,9 +5,7 @@
 
 use std::num::NonZeroU128;
 
-use accesskit::{
-    ActionHandler, ActionRequest, Node, NodeId, Role, StringEncoding, Tree, TreeUpdate,
-};
+use accesskit::{ActionHandler, ActionRequest, Node, NodeId, Role, Tree, TreeUpdate};
 use windows::Win32::{Foundation::*, UI::Accessibility::*};
 use winit::{
     event_loop::EventLoop,
@@ -41,7 +39,7 @@ fn get_initial_state() -> TreeUpdate {
     let button_2 = make_button(BUTTON_2_ID, "Button 2");
     TreeUpdate {
         nodes: vec![root, button_1, button_2],
-        tree: Some(Tree::new(WINDOW_ID, StringEncoding::Utf8)),
+        tree: Some(Tree::new(WINDOW_ID)),
         focus: None,
     }
 }