reactive_graph 0.2.4

//! Traits to reduce the boilerplate when implementing the [`ReactiveNode`], [`Source`], and
//! [`ToAnySource`] traits for signal types.
//!
//! These traits can be automatically derived for any type that
//! 1) is a root node in the reactive graph, with no sources (i.e., a signal, not a memo)
//! 2) contains an `Arc<RwLock<SubscriberSet>>`
//!
//! This makes it easy to implement a variety of different signal primitives, as long as they share
//! these characteristics.

use crate::{
    graph::{
        AnySource, AnySubscriber, ReactiveNode, Source, SubscriberSet,
        ToAnySource,
    },
    traits::{DefinedAt, IsDisposed},
    unwrap_signal,
};
use or_poisoned::OrPoisoned;
use std::{
    borrow::Borrow,
    sync::{Arc, RwLock, Weak},
};

pub(crate) trait AsSubscriberSet {
    type Output: Borrow<RwLock<SubscriberSet>>;

    fn as_subscriber_set(&self) -> Option<Self::Output>;
}

impl<'a> AsSubscriberSet for &'a RwLock<SubscriberSet> {
    type Output = &'a RwLock<SubscriberSet>;

    #[inline(always)]
    fn as_subscriber_set(&self) -> Option<Self::Output> {
        Some(self)
    }
}

impl DefinedAt for RwLock<SubscriberSet> {
    fn defined_at(&self) -> Option<&'static std::panic::Location<'static>> {
        None
    }
}

// Implement reactive types for RwLock<SubscriberSet>
// This is used so that Weak<RwLock<SubscriberSet>> is a Weak<dyn ReactiveNode> and Weak<dyn
// Source>
impl<T: AsSubscriberSet + DefinedAt> ReactiveNode for T {
    fn mark_dirty(&self) {
        self.mark_subscribers_check();
    }

    fn mark_check(&self) {}

    fn mark_subscribers_check(&self) {
        if let Some(inner) = self.as_subscriber_set() {
            let subs = inner.borrow().read().unwrap().clone();
            for sub in subs {
                sub.mark_dirty();
            }
        }
    }

    fn update_if_necessary(&self) -> bool {
        // a signal will always mark its dependents Dirty when it runs, so they know
        // that they may have changed and need to check themselves at least
        //
        // however, it's always possible that *another* signal or memo has triggered any
        // given effect/memo, and so this signal should *not* say that it is dirty, as it
        // may also be checked but has not changed
        false
    }
}

impl<T: AsSubscriberSet + DefinedAt> Source for T {
    fn clear_subscribers(&self) {
        if let Some(inner) = self.as_subscriber_set() {
            inner.borrow().write().unwrap().take();
        }
    }

    fn add_subscriber(&self, subscriber: AnySubscriber) {
        if let Some(inner) = self.as_subscriber_set() {
            inner.borrow().write().unwrap().subscribe(subscriber)
        }
    }

    fn remove_subscriber(&self, subscriber: &AnySubscriber) {
        if let Some(inner) = self.as_subscriber_set() {
            inner.borrow().write().unwrap().unsubscribe(subscriber)
        }
    }
}

impl<T: AsSubscriberSet + DefinedAt + IsDisposed> ToAnySource for T
where
    T::Output: Borrow<Arc<RwLock<SubscriberSet>>>,
{
    #[track_caller]
    fn to_any_source(&self) -> AnySource {
        self.as_subscriber_set()
            .map(|subs| {
                let subs = subs.borrow();
                AnySource(
                    Arc::as_ptr(subs) as usize,
                    Arc::downgrade(subs) as Weak<dyn Source + Send + Sync>,
                    #[cfg(any(debug_assertions, leptos_debuginfo))]
                    self.defined_at().expect("no DefinedAt in debug mode"),
                )
            })
            .unwrap_or_else(unwrap_signal!(self))
    }
}

impl ReactiveNode for RwLock<SubscriberSet> {
    fn mark_dirty(&self) {
        self.mark_subscribers_check();
    }

    fn mark_check(&self) {}

    fn mark_subscribers_check(&self) {
        let subs = self.write().unwrap().take();
        for sub in subs {
            sub.mark_dirty();
        }
    }

    fn update_if_necessary(&self) -> bool {
        // a signal will always mark its dependents Dirty when it runs, so they know
        // that they may have changed and need to check themselves at least
        //
        // however, it's always possible that *another* signal or memo has triggered any
        // given effect/memo, and so this signal should *not* say that it is dirty, as it
        // may also be checked but has not changed
        false
    }
}

impl Source for RwLock<SubscriberSet> {
    fn clear_subscribers(&self) {
        self.write().or_poisoned().take();
    }

    fn add_subscriber(&self, subscriber: AnySubscriber) {
        self.write().or_poisoned().subscribe(subscriber)
    }

    fn remove_subscriber(&self, subscriber: &AnySubscriber) {
        self.write().or_poisoned().unsubscribe(subscriber)
    }
}