cranpose 0.1.176

Cranpose runtime and UI facade
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use cranpose_core::{NodeId, collections::map::HashMap};

use crate::accessibility::AccessibilityElement;

#[derive(Debug, thiserror::Error, PartialEq, Eq)]
pub(crate) enum AccessibilityIdentityError {
    #[error("accessibility node IDs exhausted")]
    Exhausted,
    #[error("duplicate accessibility identity: node {0}, canvas key {1:?}")]
    Duplicate(NodeId, Option<u64>),
}

/// What [`AccessibilitySnapshot::update`] replaced: the elements and ids
/// published before, and for each new element the index its control had
/// among them.
#[cfg_attr(
    not(any(test, target_os = "android", target_os = "ios")),
    allow(
        dead_code,
        reason = "only the Android and iOS bridges diff against what an update replaced"
    )
)]
pub(crate) struct Replaced {
    pub(crate) elements: Vec<AccessibilityElement>,
    #[cfg_attr(
        not(any(test, target_os = "android")),
        allow(
            dead_code,
            reason = "only the Android wire resends an order that changed"
        )
    )]
    pub(crate) ids: Vec<i32>,
    pub(crate) was: Vec<Option<usize>>,
}

#[derive(Default)]
pub(crate) struct AccessibilitySnapshot {
    pub(crate) elements: Vec<AccessibilityElement>,
    pub(crate) ids: Vec<i32>,
    last_id: i32,
    indices: HashMap<i32, usize>,
}

impl AccessibilitySnapshot {
    /// Moves on to `elements`, keeping the ids of controls it already held,
    /// and hands back what it replaced.
    pub(crate) fn update(
        &mut self,
        elements: Vec<AccessibilityElement>,
    ) -> Result<Replaced, AccessibilityIdentityError> {
        let mut identities: HashMap<_, usize> =
            HashMap::with_capacity_and_hasher(elements.len(), Default::default());
        for (index, element) in elements.iter().enumerate() {
            let identity = (element.node_id, element.canvas_key);
            if identities.insert(identity, index).is_some() {
                return Err(AccessibilityIdentityError::Duplicate(
                    identity.0, identity.1,
                ));
            }
        }
        // A control keeps its id while it is the same node: same identity and
        // generation.
        let mut was = vec![None; elements.len()];
        let mut ids = vec![0; elements.len()];
        for (old, (element, id)) in self.elements.iter().zip(&self.ids).enumerate() {
            if let Some(&index) = identities.get(&(element.node_id, element.canvas_key))
                && elements[index].node_generation == element.node_generation
            {
                was[index] = Some(old);
                ids[index] = *id;
            }
        }
        let mut last_id = self.last_id;
        for (id, was) in ids.iter_mut().zip(&was) {
            if was.is_none() {
                last_id = last_id
                    .checked_add(1)
                    .ok_or(AccessibilityIdentityError::Exhausted)?;
                *id = last_id;
            }
        }
        self.indices = ids
            .iter()
            .enumerate()
            .map(|(index, id)| (*id, index))
            .collect();
        self.last_id = last_id;
        Ok(Replaced {
            elements: std::mem::replace(&mut self.elements, elements),
            ids: std::mem::replace(&mut self.ids, ids),
            was,
        })
    }

    pub(crate) fn element(&self, id: i32) -> Option<&AccessibilityElement> {
        self.elements.get(*self.indices.get(&id)?)
    }

    #[cfg(any(test, target_os = "android"))]
    pub(crate) fn identity(&self, id: i32) -> Option<(NodeId, Option<u64>)> {
        self.element(id)
            .map(|element| (element.node_id, element.canvas_key))
    }
}

#[cfg(test)]
#[path = "tests/accessibility_identity.rs"]
mod tests;