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 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
//! Reactive primitives for Sycamore.
#![warn(missing_docs)]
#![deny(missing_debug_implementations)]
mod arena;
mod context;
mod effect;
mod iter;
mod memo;
mod signal;
use std::any::{Any, TypeId};
use std::cell::RefCell;
use std::marker::PhantomData;
use std::mem;
use std::rc::{Rc, Weak};
use ahash::AHashMap;
use arena::*;
pub use context::*;
pub use effect::*;
use indexmap::IndexMap;
pub use iter::*;
pub use memo::*;
pub use signal::*;
use slotmap::{DefaultKey, SlotMap};
/// A wrapper type around a lifetime that forces the lifetime to be invariant.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
struct InvariantLifetime<'id>(PhantomData<&'id mut &'id ()>);
/// Internal representation for [`Scope`]. This allows only using a single top-level [`RefCell`]
/// instead of a [`RefCell`] for every field.
#[derive(Default)]
struct ScopeInner<'a> {
/// Cleanup functions.
cleanups: Vec<Box<dyn FnOnce() + 'a>>,
/// Child scopes.
///
/// The raw pointer is owned by this field.
child_scopes: SlotMap<DefaultKey, *mut ScopeRaw<'a>>,
/// Contexts that are allocated on the current [`Scope`].
/// See the [`mod@context`] module.
///
/// Note that the `AHashMap` is wrapped with an `Option<Box<_>>`. This is because contexts are
/// usually read and rarely created. Making this heap allocated when prevent blowing up the
/// size of the [`ScopeInner`] struct when most of the times, this field is unneeded.
#[allow(clippy::box_collection)]
contexts: Option<Box<AHashMap<TypeId, &'a dyn Any>>>,
// Make sure that 'a is invariant.
_phantom: InvariantLifetime<'a>,
}
/// What the [`BoundedScope`] points to.
struct ScopeRaw<'a> {
inner: RefCell<ScopeInner<'a>>,
/// An arena allocator for allocating refs and signals.
arena: ScopeArena<'a>,
/// A pointer to the parent scope.
/// # Safety
/// The parent scope does not actually have the right lifetime.
parent: Option<*const ScopeRaw<'a>>,
}
/// A reference to a reactive scope. This reference is `Copy`, allowing it to be copied into
/// closures without any clones.
///
/// The intended way to access a [`Scope`] is with the [`create_scope`] function.
///
/// # Lifetime
///
/// * `'a` - The lifetime of the scope and all data allocated on it. This allows passing in data
/// from an outer scope into an inner scope. This lifetime is invariant because it is used within
/// an cell.
/// * `'b` - The bounded lifetime of the scope. This ensures that the scope cannot live longer than
/// this lifetime. This lifetime is covariant because if the scope can outlive `'b1`, it can also
/// outlive `'b2` if `'b1: 'b2`.
///
/// As a convenience, the [`Scope`] type alias is provided that uses the same lifetime for both `'a`
/// and `'b`. Any [`BoundedScope`] can be casted to a [`Scope`] because the second lifetime
/// parameter is always longer than the first.
#[derive(Clone, Copy)]
pub struct BoundedScope<'a, 'b: 'a> {
raw: &'a ScopeRaw<'a>,
/// `&'b` for covariance!
_phantom: PhantomData<&'b ()>,
}
impl<'a, 'b: 'a> std::fmt::Debug for BoundedScope<'a, 'b> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("BoundedScope").finish()
}
}
impl<'a, 'b: 'a> BoundedScope<'a, 'b> {
fn new(raw: &'a ScopeRaw<'a>) -> Self {
Self {
raw,
_phantom: PhantomData,
}
}
/// Alias for `self.raw.arena.alloc`.
fn alloc<T>(&self, value: T) -> &'a mut T {
self.raw.arena.alloc(value)
}
}
/// A type-alias for [`BoundedScope`] where both lifetimes are the same.
pub type Scope<'a> = BoundedScope<'a, 'a>;
impl<'a> ScopeRaw<'a> {
/// Create a new [`ScopeRaw`]. This function is deliberately not `pub` because it should not be
/// possible to access a [`ScopeRaw`] directly on the stack.
pub(crate) fn new() -> Self {
// Even though the initialization code below is same as deriving Default::default(), we
// can't do that because accessing a raw Scope outside of a scope closure breaks
// safety contracts.
//
// Self::new() is intentionally pub(crate) only to prevent end-users from creating a Scope.
Self {
inner: RefCell::new(ScopeInner {
cleanups: Default::default(),
child_scopes: Default::default(),
contexts: None,
_phantom: Default::default(),
}),
arena: Default::default(),
parent: None,
}
}
}
/// A handle that allows cleaning up a [`Scope`].
pub struct ScopeDisposer<'a> {
f: Box<dyn FnOnce() + 'a>,
}
impl<'a> std::fmt::Debug for ScopeDisposer<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("ScopeDisposer").finish()
}
}
impl<'a> ScopeDisposer<'a> {
fn new(f: impl FnOnce() + 'a) -> Self {
Self { f: Box::new(f) }
}
/// Cleanup the resources owned by the [`Scope`].
///
/// This method will cleanup resources in a certain order such that it is impossible to access a
/// dangling-reference within cleanup callbacks and effects etc...
///
/// If a [`Scope`] has already been disposed, calling it again does nothing.
///
/// # Safety
///
/// `dispose` should not be called inside the `create_scope` or `create_child_scope` closure.
///
/// # Drop order
///
/// Fields are dropped in the following order:
/// * `child_scopes` - Run child scope drop first.
/// * `effects`
/// * `cleanups`
/// * `contexts` - Contexts can be refereed to inside a cleanup callback so they are dropped
/// after cleanups.
/// * `arena` - Signals and refs are dropped last because they can be refereed to in the other
/// fields (e.g. inside a cleanup callback). Refs are dropped in the opposite order in which
/// they are created, i.e. the first ref is dropped last. This ensures that if a closure that
/// references something allocated in the arena is allocated onto this same arena, it will not
/// be able to access the reference after it has been deallocated.
pub unsafe fn dispose(self) {
(self.f)();
}
}
/// Creates a reactive scope.
///
/// Returns a disposer function which will release the memory owned by the [`Scope`].
/// Failure to call the disposer function will result in a memory leak.
///
/// The callback closure is called in an [untracked](untrack) scope.
///
/// # Scope lifetime
///
/// The lifetime of the child scope is arbitrary. As such, it is impossible for anything allocated
/// in the scope to escape out of the scope because it is possible for the scope lifetime to be
/// longer than outside.
///
/// ```compile_fail
/// # use sycamore_reactive::*;
/// let mut outer = None;
/// # let disposer =
/// create_scope(|cx| {
/// outer = Some(cx);
/// });
/// # unsafe { disposer.dispose(); }
/// ```
///
/// # Examples
///
/// ```
/// # use sycamore_reactive::*;
/// let disposer = create_scope(|cx| {
/// // Use cx here.
/// });
/// unsafe { disposer.dispose(); }
/// ```
#[must_use = "not calling the disposer function will result in a memory leak"]
pub fn create_scope<'disposer>(f: impl for<'a> FnOnce(Scope<'a>)) -> ScopeDisposer<'disposer> {
let cx = ScopeRaw::new();
let boxed = Box::new(cx);
let ptr = Box::into_raw(boxed);
// SAFETY: Safe because heap allocated value has stable address.
// The reference passed to f cannot possible escape the closure. We know however, that ptr
// necessary outlives the closure call because it is only dropped in the returned disposer
// closure.
untrack(|| f(unsafe { Scope::new(&*ptr) }));
// ^^^ -> `ptr` is still accessible here after call to f.
// Ownership of `ptr` is passed into the closure.
ScopeDisposer::new(move || unsafe {
// SAFETY: Safe because ptr created using Box::into_raw.
let boxed = Box::from_raw(ptr);
// SAFETY: Outside of call to f.
boxed.dispose();
})
}
/// Create a child scope.
///
/// Returns a disposer function which will release the memory owned by the [`Scope`]. If the
/// disposer function is never called, the child scope will be disposed automatically when the
/// parent scope is disposed.
///
/// # Child scope lifetime
///
/// The lifetime of the child scope is strictly a subset of the lifetime of the parent scope.
/// ```txt
/// [------------'a-------------]
/// [---------'b--------]
/// 'a: lifetime of parent
/// 'b: lifetime of child
/// ```
/// If the disposer is never called, the lifetime `'b` lasts as long as `'a`.
/// As such, it is impossible for anything allocated in the child scope to escape into the
/// parent scope.
/// ```compile_fail
/// # use sycamore_reactive::*;
/// # create_scope_immediate(|cx| {
/// let mut outer = None;
/// let disposer = create_child_scope(cx, |cx| {
/// outer = Some(cx);
/// // ^^
/// });
/// disposer();
/// let _ = outer.unwrap();
/// # });
/// ```
/// However, the closure itself only needs to live as long as the call to this method because it
/// is called immediately. For example, the following compiles and is perfectly safe:
/// ```
/// # use sycamore_reactive::*;
/// # create_scope_immediate(|cx| {
/// let mut outer = String::new();
/// let disposer = create_child_scope(cx, |cx| {
/// // outer is accessible inside the closure.
/// outer = "Hello World!".to_string();
/// });
/// unsafe { disposer.dispose(); }
/// drop(outer);
/// // ^^^^^ -> and remains accessible outside the closure.
/// # });
/// ```
pub fn create_child_scope<'a, F>(cx: Scope<'a>, f: F) -> ScopeDisposer<'a>
where
F: for<'child_lifetime> FnOnce(BoundedScope<'child_lifetime, 'a>),
{
let mut child = ScopeRaw::new();
// SAFETY: The only fields that are accessed on self from child is `context` which does not
// have any lifetime annotations.
child.parent = Some(unsafe { std::mem::transmute(cx.raw as *const _) });
let boxed = Box::new(child);
let ptr = Box::into_raw(boxed);
let key = cx.raw.inner.borrow_mut().child_scopes.insert(ptr);
// SAFETY: the address of the cx lives as long as 'a because:
// - It is allocated on the heap and therefore has a stable address.
// - self.child_cx is append only. That means that the Box<cx> will not be dropped until Self is
// dropped.
f(unsafe { Scope::new(&*ptr) });
// ^^^ -> `ptr` is still accessible here after call to f.
ScopeDisposer::new(move || unsafe {
let cx = cx.raw.inner.borrow_mut().child_scopes.remove(key).unwrap();
// SAFETY: Safe because ptr created using Box::into_raw and closure cannot live longer
// than 'a.
let cx = Box::from_raw(cx);
// SAFETY: Outside of call to f.
cx.dispose();
})
}
/// Creates a reactive scope, runs the callback, and disposes the scope immediately.
///
/// Calling this is equivalent to writing:
/// ```
/// # use sycamore_reactive::*;
/// # unsafe {
/// (create_scope(|cx| {
/// // ...
/// })).dispose(); // Call the disposer function immediately
/// # }
/// ```
pub fn create_scope_immediate(f: impl for<'a> FnOnce(Scope<'a>)) {
let disposer = create_scope(f);
// SAFETY: We are not accessing the scope after calling the disposer function.
unsafe {
disposer.dispose();
}
}
/// Allocate a new arbitrary value under the current [`Scope`].
/// The allocated value lasts as long as the scope and cannot be used outside of the scope.
///
/// # Ref lifetime
///
/// The lifetime of the returned ref is the same as the [`Scope`].
/// As such, the reference cannot escape the [`Scope`].
/// ```compile_fail
/// # use sycamore_reactive::*;
/// # create_scope_immediate(|cx| {
/// let mut outer = None;
/// let disposer = create_child_scope(cx, |cx| {
/// let data = create_ref(cx, 0);
/// let raw: &i32 = &data;
/// outer = Some(raw);
/// // ^^^
/// });
/// disposer();
/// let _ = outer.unwrap();
/// # });
/// ```
pub fn create_ref<T>(cx: Scope, value: T) -> &T {
cx.raw.arena.alloc(value)
}
/// Adds a callback that is called when the scope is destroyed.
pub fn on_cleanup<'a>(cx: Scope<'a>, f: impl FnOnce() + 'a) {
cx.raw.inner.borrow_mut().cleanups.push(Box::new(f));
}
/// Returns a [`RcSignal`] that is `true` when the scope is still valid and `false` once it is
/// disposed.
pub fn use_scope_status(cx: Scope) -> RcSignal<bool> {
let status = create_rc_signal(true);
on_cleanup(cx, {
let status = status.clone();
move || status.set(false)
});
status
}
impl<'a> ScopeRaw<'a> {
/// Cleanup the resources owned by the [`Scope`]. For more details, see
/// [`ScopeDisposer::dispose`].
///
/// This is automatically called in [`Drop`]
/// However, [`dispose`](Self::dispose) only needs to take `&self` instead of `&mut self`.
/// Dropping a [`Scope`] will automatically call [`dispose`](Self::dispose).
pub(crate) unsafe fn dispose(&self) {
let mut inner = self.inner.borrow_mut();
// Drop child scopes.
for &child in mem::take(&mut inner.child_scopes).values() {
// SAFETY: These pointers were allocated in Self::create_child_scope.
let cx = Box::from_raw(child);
// Dispose of cx if it has not already been disposed.
cx.dispose();
}
// Call cleanup functions in an untracked scope.
untrack(|| {
for cb in mem::take(&mut inner.cleanups) {
cb();
}
});
// Cleanup signals and refs allocated on the arena.
self.arena.dispose();
}
}
impl Drop for ScopeRaw<'_> {
fn drop(&mut self) {
// SAFETY: scope cannot be dropped while it is borrowed inside closure.
unsafe { self.dispose() };
}
}
/// A helper function for making it explicit to define dependencies for an effect.
///
/// # Params
/// * `dependencies` - A list of [`ReadSignal`]s that are tracked.
/// * `f` - The callback function.
///
/// # Example
/// ```
/// # use sycamore_reactive::*;
/// # create_scope_immediate(|cx| {
/// let state = create_signal(cx, 0);
///
/// create_effect(cx, on([state], || {
/// println!("State changed. New state value = {}", state.get());
/// })); // Prints "State changed. New state value = 0"
///
/// state.set(1); // Prints "State changed. New state value = 1"
/// # });
/// ```
pub fn on<'a, U, const N: usize>(
dependencies: [&'a (dyn AnyReadSignal<'a> + 'a); N],
mut f: impl FnMut() -> U + 'a,
) -> impl FnMut() -> U + 'a {
move || {
for i in dependencies {
i.track();
}
untrack(&mut f)
}
}
#[cfg(test)]
mod tests {
use std::cell::Cell;
use super::*;
#[test]
fn refs() {
let disposer = create_scope(|cx| {
let r = create_ref(cx, 0);
on_cleanup(cx, move || {
let _ = r; // r can be accessed inside scope here.
dbg!(r);
})
});
unsafe {
disposer.dispose();
}
}
#[test]
fn cleanup() {
create_scope_immediate(|cx| {
let cleanup_called = create_signal(cx, false);
let disposer = create_child_scope(cx, |cx| {
on_cleanup(cx, || {
cleanup_called.set(true);
});
});
assert!(!*cleanup_called.get());
unsafe {
disposer.dispose();
}
assert!(*cleanup_called.get());
});
}
#[test]
fn cleanup_in_effect() {
create_scope_immediate(|cx| {
let trigger = create_signal(cx, ());
let counter = create_signal(cx, 0);
create_effect_scoped(cx, |cx| {
trigger.track();
on_cleanup(cx, || {
counter.set(*counter.get() + 1);
});
});
assert_eq!(*counter.get(), 0);
trigger.set(());
assert_eq!(*counter.get(), 1);
trigger.set(());
assert_eq!(*counter.get(), 2);
});
}
#[test]
fn cleanup_is_untracked() {
create_scope_immediate(|cx| {
let trigger = create_signal(cx, ());
let counter = create_signal(cx, 0);
create_effect_scoped(cx, |cx| {
counter.set(*counter.get_untracked() + 1);
on_cleanup(cx, || {
trigger.track(); // trigger should not be tracked
});
});
assert_eq!(*counter.get(), 1);
trigger.set(());
assert_eq!(*counter.get(), 1);
});
}
#[test]
fn can_store_disposer_in_own_signal() {
create_scope_immediate(|cx| {
let signal = create_signal(cx, None);
let disposer = create_child_scope(cx, |_cx| {});
signal.set(Some(disposer));
});
}
#[test]
fn refs_are_dropped_on_dispose() {
thread_local! {
static COUNTER: Cell<u32> = Cell::new(0);
}
struct IncOnDrop;
impl Drop for IncOnDrop {
fn drop(&mut self) {
COUNTER.with(|c| c.set(c.get() + 1));
}
}
struct AssertDropCount {
count: u32,
}
impl Drop for AssertDropCount {
fn drop(&mut self) {
assert_eq!(COUNTER.with(Cell::get), self.count);
}
}
assert_eq!(COUNTER.with(Cell::get), 0);
let disposer = create_scope(|cx| {
create_ref(cx, IncOnDrop);
});
assert_eq!(COUNTER.with(Cell::get), 0);
unsafe { disposer.dispose() };
assert_eq!(COUNTER.with(Cell::get), 1);
let disposer = create_scope(|cx| {
create_ref(cx, AssertDropCount { count: 2 }); // This is dropped last.
create_ref(cx, IncOnDrop);
create_ref(cx, AssertDropCount { count: 1 }); // This is dropped first.
// That's because if this were a closure,
// we could reference previous refs and
// access it in drop.
});
unsafe { disposer.dispose() };
}
#[test]
fn access_previous_ref_in_drop() {
struct ReadRefOnDrop<'a> {
r: &'a i32,
expect: i32,
}
impl<'a> Drop for ReadRefOnDrop<'a> {
fn drop(&mut self) {
assert_eq!(*self.r, self.expect);
}
}
let disposer = create_scope(|cx| {
let r = create_ref(cx, 123);
create_ref(cx, ReadRefOnDrop { r, expect: 123 });
});
unsafe { disposer.dispose() };
}
}