hobo 0.4.0

hobo is a Rust frontend framework
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
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

use crate::{prelude::*, query, storage::StorageGuard, storage::StorageGuardMut, StorageRef, StorageRefMut};
pub use hobo_derive::AsEntity;
use owning_ref::{OwningRef, OwningRefMut};
use std::any::type_name;

/// An opaque copyable identifier that is used to attach and fetch components
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct Entity(pub(crate) u64);

#[doc(hidden)]
#[derive(Default)]
pub struct FutureHandlesCollection(pub Vec<discard::DiscardOnDrop<futures_signals::CancelableFutureHandle>>);

impl Entity {
	pub(crate) fn root() -> Self { Self(0) }
}

pub trait AsEntity {
	fn as_entity(&self) -> Entity;
	#[inline]
	#[track_caller]
	fn try_get_cmp<'a, C: 'static>(&self) -> Option<OwningRef<StorageGuard<C, StorageRef<'a, C>>, C>> where Self: Sized {
		let entity = self.as_entity();
		let storage = WORLD.storage::<C>();
		if !storage.has(entity) {
			return None;
		}
		Some(OwningRef::new(storage).map(|x| x.get(entity).unwrap()))
	}
	#[inline]
	#[track_caller]
	fn try_get_cmp_mut<'a, C: 'static>(&self) -> Option<OwningRefMut<StorageGuardMut<C, StorageRefMut<'a, C>>, C>> where Self: Sized {
		let entity = self.as_entity();
		if !WORLD.storage::<C>().has(entity) {
			return None;
		}
		Some(OwningRefMut::new(WORLD.storage_mut::<C>()).map_mut(|x| x.get_mut(entity).unwrap()))
	}

	#[inline]
	#[track_caller]
	fn get_cmp<'a, C: 'static>(&self) -> OwningRef<StorageGuard<C, StorageRef<'a, C>>, C> {
		OwningRef::new(WORLD.storage::<C>()).try_map(|x| x.get(self.as_entity()).ok_or_else(|| type_name::<C>())).expect("entity does not have component")
	}
	#[inline]
	#[track_caller]
	fn get_cmp_mut<'a, C: 'static>(&self) -> OwningRefMut<StorageGuardMut<C, StorageRefMut<'a, C>>, C> {
		OwningRefMut::new(WORLD.storage_mut::<C>()).try_map_mut(|x| x.get_mut(self.as_entity()).ok_or_else(|| type_name::<C>())).expect("entity does not have component")
	}
	#[inline]
	#[track_caller]
	fn get_cmp_mut_or<'a, C: 'static>(&self, f: impl FnOnce() -> C) -> OwningRefMut<StorageGuardMut<C, StorageRefMut<'a, C>>, C> {
		OwningRefMut::new(WORLD.storage_mut::<C>()).map_mut(move |x| x.get_mut_or(self.as_entity(), f))
	}
	#[inline]
	#[track_caller]
	fn get_cmp_mut_or_default<'a, C: 'static + Default>(&self) -> OwningRefMut<StorageGuardMut<C, StorageRefMut<'a, C>>, C> {
		self.get_cmp_mut_or(Default::default)
	}

	#[inline]
	#[track_caller]
	fn remove_cmp<C: 'static>(&self) where Self: Sized {
		WORLD.storage_mut::<C>().remove(self);
	}
	fn find_in_ancestors<Q: query::Query>(&self) -> Vec<Q::Fetch> {
		let mut entities = Some(Parent::ancestors(self.as_entity()).into_iter().collect());
		Q::filter(&WORLD, &mut entities);
		entities.unwrap_or_default().into_iter().map(|entity| Q::fetch(&WORLD, entity)).collect::<Vec<_>>()
	}
	fn try_find_first_in_ancestors<Q: query::Query>(&self) -> Option<Q::Fetch> {
		let mut entities = Some(Parent::ancestors(self.as_entity()).into_iter().collect());
		Q::filter(&WORLD, &mut entities);
		entities.unwrap_or_default().into_iter().next().map(|e| Q::fetch(&WORLD, e))
	}
	#[inline]
	#[track_caller]
	fn find_first_in_ancestors<Q: query::Query>(&self) -> Q::Fetch { self.try_find_first_in_ancestors::<Q>().expect("could not find query in ancestor") }
	fn find_in_descendants<Q: query::Query>(&self) -> Vec<Q::Fetch> {
		let mut entities = Some(Children::descendants(self.as_entity()).into_iter().collect());
		Q::filter(&WORLD, &mut entities);
		entities.unwrap_or_default().into_iter().map(|entity| Q::fetch(&WORLD, entity)).collect::<Vec<_>>()
	}
	fn find_in_children<Q: query::Query>(&self) -> Vec<Q::Fetch> {
		let mut entities = Some(self.as_entity().try_get_cmp::<Children>().map_or_else(default, |x| x.0.iter().copied().collect()));
		Q::filter(&WORLD, &mut entities);
		entities.unwrap_or_default().into_iter().map(|entity| Q::fetch(&WORLD, entity)).collect::<Vec<_>>()
	}
	fn try_find_first_in_descendants<Q: query::Query>(&self) -> Option<Q::Fetch> {
		let mut entities = Some(Children::descendants(self.as_entity()).into_iter().collect());
		Q::filter(&WORLD, &mut entities);
		entities.unwrap_or_default().into_iter().next().map(|e| Q::fetch(&WORLD, e))
	}
	fn try_find_first_in_children<Q: query::Query>(&self) -> Option<Q::Fetch> {
		let mut entities = Some(self.as_entity().try_get_cmp::<Children>().map_or_else(default, |x| x.0.iter().copied().collect()));
		Q::filter(&WORLD, &mut entities);
		entities.unwrap_or_default().into_iter().next().map(|e| Q::fetch(&WORLD, e))
	}
	#[inline]
	#[track_caller]
	fn find_first_in_descendants<Q: query::Query>(&self) -> Q::Fetch { self.try_find_first_in_descendants::<Q>().expect("could not find query in descendant") }
	#[inline]
	#[track_caller]
	fn find_first_in_children<Q: query::Query>(&self) -> Q::Fetch { self.try_find_first_in_children::<Q>().expect("could not find child") }
	#[inline]
	#[track_caller]
	fn remove(&self) { WORLD.remove_entity(self.as_entity()) }
	#[inline]
	#[track_caller]
	fn add_component<T: 'static>(&self, component: T) { WORLD.storage_mut::<T>().add(self.as_entity(), component) }
	#[inline]
	#[track_caller]
	fn component<T: 'static>(self, component: T) -> Self where Self: Sized { self.add_component(component); self }
	#[inline] fn has_cmp<C: 'static>(&self) -> bool where Self: Sized { WORLD.storage::<C>().has(self.as_entity()) }
	#[inline] fn is_dead(&self)  -> bool { WORLD.is_dead(self.as_entity()) }

	fn spawn(&self, f: impl std::future::Future<Output = ()> + 'static) {
		let (handle, fut) = futures_signals::cancelable_future(f, Default::default);
		wasm_bindgen_futures::spawn_local(fut);
		self.get_cmp_mut_or_default::<FutureHandlesCollection>().0.push(handle);
	}

	fn spawn_in<F: FnOnce(&Self) -> Fut, Fut: std::future::Future<Output = ()> + 'static>(self, f: F) -> Self where Self: Sized { self.spawn(f(&self)); self }
}

impl AsEntity for Entity {
	fn as_entity(&self) -> Entity { *self }
}

impl<T: AsEntity> AsEntity for &T {
	fn as_entity(&self) -> Entity { T::as_entity(*self) }
}
impl<T: AsEntity> AsEntity for &mut T {
	fn as_entity(&self) -> Entity { T::as_entity(*self) }
}