cranpose-core 0.21.0

Composition runtime and reactive state for Cranpose
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

//! The state `derivedStateOf` keeps: the value it derives and how it derives
//! it again.

use std::{
    cell::{Cell, RefCell},
    rc::{Rc, Weak},
};

use super::{OwnedMutableState, State};
use crate::{RecomposeScope, RecomposeScopeInner, RuntimeHandle, StateId, runtime};

/// The value `derivedStateOf` derives, kept in a state cell its readers
/// subscribe to.
pub(crate) struct DerivedState<T: Clone + PartialEq + 'static> {
    core: Rc<DerivedCore<T>>,
}

struct DerivedCore<T: Clone + PartialEq + 'static> {
    compute: RefCell<Rc<dyn Fn() -> T>>,
    state: OwnedMutableState<T>,
    /// The scope whose recomposition derives the value: the states the
    /// derivation reads invalidate it.
    derivation: Weak<RecomposeScopeInner>,
    /// A read derives the value right now, so a read inside the derivation
    /// takes the last value.
    refreshing: Cell<bool>,
}

impl<T: Clone + PartialEq + 'static> DerivedState<T> {
    /// A derived state whose value `compute` derives, again whenever
    /// `derivation` recomposes and before a read once a state it read
    /// changed.
    pub(crate) fn new(
        runtime: RuntimeHandle,
        compute: Rc<dyn Fn() -> T>,
        derivation: Option<&RecomposeScope>,
    ) -> Self {
        let initial = compute();
        let core = Rc::new(DerivedCore {
            compute: RefCell::new(compute),
            state: OwnedMutableState::with_runtime_structural_eq(initial, runtime),
            derivation: derivation.map_or_else(Weak::new, RecomposeScope::downgrade),
            refreshing: Cell::new(false),
        });
        let cell = core.state.handle();
        let refresh: Weak<dyn runtime::DerivedRefresh> = Rc::downgrade(&core) as Weak<_>;
        runtime::with_state_arena_by_id(cell.runtime_id, |arena| {
            arena.register_derived(cell.id, refresh);
        });
        Self { core }
    }

    pub(crate) fn set_compute(&self, compute: Rc<dyn Fn() -> T>) {
        *self.core.compute.borrow_mut() = compute;
    }

    pub(crate) fn recompute(&self) {
        self.core.derive();
    }

    /// The recompose callback of the derivation's scope, which derives the
    /// value again from this state without reading a slot.
    pub(crate) fn rerun(&self) -> impl FnMut(&crate::Composer) + use<T> {
        let core = Rc::downgrade(&self.core);
        move |_| {
            if let Some(core) = core.upgrade() {
                core.derive();
            }
        }
    }

    /// The view readers read the value through.
    pub(crate) fn state(&self) -> State<T> {
        self.core.state.as_state().of_derived()
    }

    // The id a reader's scope notes when a new value invalidates it.
    pub(crate) fn state_id(&self) -> StateId {
        self.core.state.handle().runtime_state_id()
    }
}

impl<T: Clone + PartialEq + 'static> DerivedCore<T> {
    fn compute(&self) -> Rc<dyn Fn() -> T> {
        Rc::clone(&self.compute.borrow())
    }

    fn derive(&self) {
        let value = self.compute()();
        self.state.set_value(value);
    }
}

impl<T: Clone + PartialEq + 'static> runtime::DerivedRefresh for DerivedCore<T> {
    fn refresh(&self) {
        let stale =
            RecomposeScope::upgrade(&self.derivation).is_some_and(|scope| scope.is_invalid());
        if !stale || self.refreshing.replace(true) {
            return;
        }
        // No scope subscribes to what this derivation reads: the
        // derivation's own recomposition keeps that subscription.
        let value = crate::composer_context::without_composer(|| self.compute()());
        self.refreshing.set(false);
        self.state.set_value(value);
    }
}