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 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
//! World resource storage.
use std::{fmt::Debug, marker::PhantomData, sync::Arc};
use once_map::OnceMap;
use crate::prelude::*;
/// An untyped, atomic resource cell.
pub type AtomicUntypedResource = Arc<UntypedResource>;
/// An untyped resource that may be inserted into [`UntypedResources`].
///
/// This is fundamentally a [`Arc<AtomicCell<Option<SchemaBox>>>`] and thus represents
/// a cell that may or may not contain a resource of it's schema.
pub struct UntypedResource {
cell: AtomicCell<Option<SchemaBox>>,
schema: &'static Schema,
}
impl std::fmt::Debug for UntypedResource {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("UntypedResource").finish_non_exhaustive()
}
}
impl UntypedResource {
/// Initialize a new, empty [`UntypedResource`].
pub fn empty(schema: &'static Schema) -> Self {
Self {
cell: AtomicCell::new(None),
schema,
}
}
/// Creates a new [`UntypedResource`] storing the given data.
pub fn new(resource: SchemaBox) -> Self {
Self {
schema: resource.schema(),
cell: AtomicCell::new(Some(resource)),
}
}
/// Create a new [`UntypedResource`] for the given schema, initially populated with the default
/// value for the schema.
pub fn from_default(schema: &'static Schema) -> Self {
Self {
cell: AtomicCell::new(Some(SchemaBox::default(schema))),
schema,
}
}
/// Clone the inner data, creating a new copy instead of returning another handle the the same
/// data, as the normal `clone()` implementation does.
pub fn clone_data(&self) -> Option<SchemaBox> {
(*self.cell.borrow()).clone()
}
/// Insert resource data into the cell, returning the previous data.
/// # Errors
/// Errors if the schema of the data does not match that of this cell.
pub fn insert(&self, data: SchemaBox) -> Result<Option<SchemaBox>, SchemaMismatchError> {
self.schema.ensure_match(data.schema())?;
let mut data = Some(data);
std::mem::swap(&mut data, &mut *self.cell.borrow_mut());
Ok(data)
}
/// Remove the resource data, returning what was stored in it.
pub fn remove(&self) -> Option<SchemaBox> {
let mut data = None;
std::mem::swap(&mut data, &mut *self.cell.borrow_mut());
data
}
/// Borrow the resource.
#[track_caller]
pub fn borrow(&self) -> Ref<Option<SchemaBox>> {
self.cell.borrow()
}
/// Mutably borrow the resource.
#[track_caller]
pub fn borrow_mut(&self) -> RefMut<Option<SchemaBox>> {
self.cell.borrow_mut()
}
/// Get the schema of the resource.
pub fn schema(&self) -> &'static Schema {
self.schema
}
}
/// Storage for un-typed resources.
///
/// This is the backing data store used by [`Resources`].
///
/// Unless you are intending to do modding or otherwise need raw pointers to your resource data, you
/// should use [`Resources`] instead.
#[derive(Default)]
pub struct UntypedResources {
resources: OnceMap<SchemaId, AtomicUntypedResource>,
shared_resources: OnceMap<SchemaId, Box<()>>,
}
impl Clone for UntypedResources {
fn clone(&self) -> Self {
let binding = self.resources.read_only_view();
let resources = binding.iter().map(|(_, v)| (v.schema, v));
let new_resources = OnceMap::default();
let new_shared_resources = OnceMap::default();
for (schema, resource_cell) in resources {
let is_shared = self.shared_resources.contains_key(&schema.id());
if !is_shared {
let resource = resource_cell.clone_data();
new_resources.map_insert(
schema.id(),
|_| Arc::new(UntypedResource::empty(schema)),
|_, cell| {
if let Some(resource) = resource {
cell.insert(resource).unwrap();
}
},
);
} else {
new_shared_resources.insert(schema.id(), |_| Box::new(()));
new_resources.insert(schema.id(), |_| resource_cell.clone());
}
}
Self {
resources: new_resources,
shared_resources: new_shared_resources,
}
}
}
/// Error thrown when a resource cell cannot be inserted because it already exists.
#[derive(Debug, Clone, Copy)]
pub struct CellAlreadyPresentError;
impl std::fmt::Display for CellAlreadyPresentError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str("Resource cell already present")
}
}
impl std::error::Error for CellAlreadyPresentError {}
impl UntypedResources {
/// Create an empty [`UntypedResources`].
pub fn new() -> Self {
Self::default()
}
/// Check whether or not a cell for the given resource has been initialized yet.
pub fn contains_cell(&self, id: SchemaId) -> bool {
self.resources.contains_key(&id)
}
/// Check whether or not the resource with the given ID is present.
pub fn contains(&self, id: SchemaId) -> bool {
self.resources
.map_get(&id, |_, cell| cell.borrow().is_some())
.unwrap_or_default()
}
/// This is an advanced use-case function that allows you to insert a resource cell directly.
///
/// Normally this is completely unnecessary, because cells are automatically inserted lazily as
/// requested.
///
/// Inserting this manually is used internally for shared resources, by inserting the same
/// cell into multiple worlds.
///
/// # Errors
/// This will error if there is already a cell for the resource present. You cannot add a new
/// cell once one has already been inserted.
pub fn insert_cell(&self, cell: AtomicUntypedResource) -> Result<(), CellAlreadyPresentError> {
let schema = cell.schema;
if self.resources.contains_key(&schema.id()) {
Err(CellAlreadyPresentError)
} else {
self.resources.insert(schema.id(), |_| cell);
self.shared_resources.insert(schema.id(), |_| Box::new(()));
Ok(())
}
}
/// Borrow the resource for the given schema.
pub fn get(&self, schema: &'static Schema) -> &UntypedResource {
self.resources
.insert(schema.id(), |_| Arc::new(UntypedResource::empty(schema)))
}
/// Get a cell for the resource with the given schema.
pub fn get_cell(&self, schema: &'static Schema) -> AtomicUntypedResource {
self.resources.map_insert(
schema.id(),
|_| Arc::new(UntypedResource::empty(schema)),
|_, cell| cell.clone(),
)
}
/// Removes all resourcse that are not shared resources.
pub fn clear_owned_resources(&mut self) {
for (schema_id, resource_cell) in self.resources.iter_mut() {
let is_shared = self.shared_resources.contains_key(schema_id);
if !is_shared {
resource_cell.remove();
}
}
}
}
/// A collection of resources.
///
/// [`Resources`] is essentially a type-map
#[derive(Clone, Default)]
pub struct Resources {
untyped: UntypedResources,
}
impl Resources {
/// Create an empty [`Resources`].
pub fn new() -> Self {
Self::default()
}
/// Insert a resource.
pub fn insert<T: HasSchema>(&self, resource: T) -> Option<T> {
self.untyped
.get(T::schema())
.insert(SchemaBox::new(resource))
.unwrap()
.map(|x| x.cast_into())
}
/// Check whether or not a resource is in the store.
///
/// See [get()][Self::get]
pub fn contains<T: HasSchema>(&self) -> bool {
self.untyped.contains(T::schema().id())
}
/// Remove a resource from the store, if it is present.
pub fn remove<T: HasSchema>(&self) -> Option<T> {
self.untyped
.get(T::schema())
.remove()
// SOUND: we know the type matches because we retrieve it by it's schema.
.map(|x| unsafe { x.cast_into_unchecked() })
}
/// Borrow a resource.
#[track_caller]
pub fn get<T: HasSchema>(&self) -> Option<Ref<T>> {
let b = self.untyped.get(T::schema()).borrow();
if b.is_some() {
Some(Ref::map(b, |b| unsafe {
b.as_ref().unwrap().as_ref().cast_into_unchecked()
}))
} else {
None
}
}
/// Borrow a resource.
#[track_caller]
pub fn get_mut<T: HasSchema>(&self) -> Option<RefMut<T>> {
let b = self.untyped.get(T::schema()).borrow_mut();
if b.is_some() {
Some(RefMut::map(b, |b| unsafe {
b.as_mut().unwrap().as_mut().cast_into_mut_unchecked()
}))
} else {
None
}
}
/// Gets a clone of the resource cell for the resource of the given type.
pub fn get_cell<T: HasSchema>(&self) -> AtomicResource<T> {
let untyped = self.untyped.get_cell(T::schema()).clone();
AtomicResource {
untyped,
_phantom: PhantomData,
}
}
/// Borrow the underlying [`UntypedResources`] store.
pub fn untyped(&self) -> &UntypedResources {
&self.untyped
}
/// Consume [`Resources`] and extract the underlying [`UntypedResources`].
pub fn into_untyped(self) -> UntypedResources {
self.untyped
}
/// Removes all resources that are not shared. Shared resources are preserved.
pub fn clear_owned_resources(&mut self) {
self.untyped.clear_owned_resources();
}
}
/// A handle to a resource from a [`Resources`] collection.
///
/// This is not the resource itself, but a cheaply clonable handle to it.
///
/// To access the resource you must borrow it with either [`borrow()`][Self::borrow] or
/// [`borrow_mut()`][Self::borrow_mut].
#[derive(Clone)]
pub struct AtomicResource<T: HasSchema> {
untyped: AtomicUntypedResource,
_phantom: PhantomData<T>,
}
impl<T: HasSchema + Debug> Debug for AtomicResource<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str("AtomicResource(")?;
self.untyped
.cell
.borrow()
.as_ref()
.map(|x| x.cast_ref::<T>())
.fmt(f)?;
f.write_str(")")?;
Ok(())
}
}
impl<T: HasSchema + Default> Default for AtomicResource<T> {
fn default() -> Self {
Self {
untyped: Arc::new(UntypedResource::new(SchemaBox::new(T::default()))),
_phantom: Default::default(),
}
}
}
impl<T: HasSchema> AtomicResource<T> {
/// Create a new, empty resource cell.
pub fn empty() -> Self {
Self {
untyped: Arc::new(UntypedResource::empty(T::schema())),
_phantom: PhantomData,
}
}
/// Create a new resource cell with the given data.
pub fn new(data: T) -> Self {
AtomicResource {
untyped: Arc::new(UntypedResource::new(SchemaBox::new(data))),
_phantom: PhantomData,
}
}
/// Create from an [`UntypedResource`].
pub fn from_untyped(untyped: AtomicUntypedResource) -> Result<Self, SchemaMismatchError> {
T::schema().ensure_match(untyped.schema)?;
Ok(AtomicResource {
untyped,
_phantom: PhantomData,
})
}
/// Remove the resource from the cell, leaving the cell empty.
pub fn remove(&self) -> Option<T> {
self.untyped
.remove()
// SOUND: The untyped data of an atomic resource must always be `T`.
.map(|x| unsafe { x.cast_into_unchecked() })
}
/// Lock the resource for reading.
///
/// This returns a read guard, very similar to an [`RwLock`][std::sync::RwLock].
pub fn borrow(&self) -> Option<Ref<T>> {
let borrow = self.untyped.borrow();
if borrow.is_some() {
Some(Ref::map(borrow, |r| unsafe {
r.as_ref().unwrap().as_ref().cast_into_unchecked()
}))
} else {
None
}
}
/// Lock the resource for read-writing.
///
/// This returns a write guard, very similar to an [`RwLock`][std::sync::RwLock].
pub fn borrow_mut(&self) -> Option<RefMut<T>> {
let borrow = self.untyped.borrow_mut();
if borrow.is_some() {
Some(RefMut::map(borrow, |r| unsafe {
r.as_mut().unwrap().as_mut().cast_into_mut_unchecked()
}))
} else {
None
}
}
/// Convert into an untyped resource.
pub fn into_untyped(self) -> AtomicUntypedResource {
self.untyped
}
}
impl<T: HasSchema + FromWorld> AtomicResource<T> {
/// Initialize the resource using it's [`FromWorld`] implementation, if it is not present.
pub fn init(&self, world: &World) {
let mut borrow = self.untyped.borrow_mut();
if unlikely(borrow.is_none()) {
*borrow = Some(SchemaBox::new(T::from_world(world)))
}
}
/// Borrow the resource, initializing it if it doesn't exist.
#[track_caller]
pub fn init_borrow(&self, world: &World) -> Ref<T> {
let map_borrow = |borrow| {
// SOUND: we know the schema matches.
Ref::map(borrow, |b: &Option<SchemaBox>| unsafe {
b.as_ref().unwrap().as_ref().cast_into_unchecked()
})
};
let borrow = self.untyped.borrow();
if unlikely(borrow.is_none()) {
drop(borrow);
{
let mut borrow_mut = self.untyped.borrow_mut();
*borrow_mut = Some(SchemaBox::new(T::from_world(world)));
}
map_borrow(self.untyped.borrow())
} else {
map_borrow(borrow)
}
}
/// Borrow the resource, initializing it if it doesn't exist.
#[track_caller]
pub fn init_borrow_mut(&self, world: &World) -> RefMut<T> {
let mut borrow = self.untyped.borrow_mut();
if unlikely(borrow.is_none()) {
*borrow = Some(SchemaBox::new(T::from_world(world)));
}
RefMut::map(borrow, |b| unsafe {
b.as_mut().unwrap().as_mut().cast_into_mut_unchecked()
})
}
}
/// Utility container for storing set of [`UntypedResource`].
/// Cloning
#[derive(Default)]
pub struct UntypedResourceSet {
resources: Vec<UntypedResource>,
}
impl Clone for UntypedResourceSet {
fn clone(&self) -> Self {
Self {
resources: self
.resources
.iter()
.map(|res| {
if let Some(clone) = res.clone_data() {
UntypedResource::new(clone)
} else {
UntypedResource::empty(res.schema())
}
})
.collect(),
}
}
}
impl UntypedResourceSet {
/// Insert a startup resource. On stage / session startup (first step), will be inserted into [`World`].
///
/// If already exists, will be overwritten.
pub fn insert_resource<T: HasSchema>(&mut self, resource: T) {
// Update an existing resource of the same type.
for r in &mut self.resources {
if r.schema() == T::schema() {
let mut borrow = r.borrow_mut();
if let Some(b) = borrow.as_mut() {
*b.cast_mut() = resource;
} else {
*borrow = Some(SchemaBox::new(resource))
}
return;
}
}
// Or insert a new resource if we couldn't find one
self.resources
.push(UntypedResource::new(SchemaBox::new(resource)))
}
/// Init resource with default, and return mutable ref for modification.
/// If already exists, returns mutable ref to existing resource.
pub fn init_resource<T: HasSchema + Default>(&mut self) -> RefMut<T> {
if !self.resources.iter().any(|x| x.schema() == T::schema()) {
self.insert_resource(T::default());
}
self.resource_mut::<T>().unwrap()
}
/// Get mutable reference to startup resource if found.
#[track_caller]
pub fn resource_mut<T: HasSchema>(&self) -> Option<RefMut<T>> {
let res = self.resources.iter().find(|x| x.schema() == T::schema())?;
let borrow = res.borrow_mut();
if borrow.is_some() {
// SOUND: We know the type matches T
Some(RefMut::map(borrow, |b| unsafe {
b.as_mut().unwrap().as_mut().cast_into_mut_unchecked()
}))
} else {
None
}
}
/// Insert an [`UntypedResource`] with empty cell for [`Schema`] of `T`.
/// If resource already exists for this schema, overwrite it with empty.
pub fn insert_empty<T: HasSchema>(&mut self) {
for r in &mut self.resources {
if r.schema() == T::schema() {
let mut borrow = r.borrow_mut();
*borrow = None;
return;
}
}
// Or insert a new empty resource if we couldn't find one
self.resources.push(UntypedResource::empty(T::schema()));
}
/// Get immutable ref to Vec of resources
pub fn resources(&self) -> &Vec<UntypedResource> {
&self.resources
}
/// Insert resources in world. If resource already exists, overwrites it.
///
/// If `remove_empty` is set, if resource cell is empty, it will remove the
/// resource from cell on world.
pub fn insert_on_world(&self, world: &mut World, remove_empty: bool) {
for resource in self.resources.iter() {
let resource_cell = world.resources.untyped().get_cell(resource.schema());
// Deep copy resource and insert into world.
if let Some(resource_copy) = resource.clone_data() {
resource_cell
.insert(resource_copy)
.expect("Schema mismatch error");
} else if remove_empty {
// Remove the resource on world
resource_cell.remove();
}
}
}
}
#[cfg(test)]
mod test {
use std::sync::Arc;
use crate::prelude::*;
#[derive(HasSchema, Clone, Debug, Default)]
#[repr(C)]
struct A(String);
#[derive(HasSchema, Clone, Debug, Default)]
#[repr(C)]
struct B(u32);
#[test]
fn sanity_check() {
let r1 = Resources::new();
r1.insert(A(String::from("hi")));
let r1a = r1.get_cell::<A>();
assert_eq!(r1a.borrow().unwrap().0, "hi");
let r2 = r1.clone();
r1.insert(A(String::from("bye")));
r1.insert(A(String::from("world")));
assert_eq!(r1a.borrow().unwrap().0, "world");
let r2a = r2.get_cell::<A>();
assert_eq!(r2a.borrow().unwrap().0, "hi");
r1.insert(B(1));
let r1b = r1.get_cell::<B>();
assert_eq!(r1b.borrow().unwrap().0, 1);
r1.insert(B(2));
assert_eq!(r1b.borrow().unwrap().0, 2);
assert_eq!(r1a.borrow().unwrap().0, "world");
}
#[test]
fn resources_clear_owned_values() {
let mut r = Resources::new();
// insert A as non-shared resource
r.insert(A(String::from("foo")));
// Insert B as shared resource
r.untyped
.insert_cell(Arc::new(UntypedResource::new(SchemaBox::new(B(1)))))
.unwrap();
// Should only clear non-shared resources
r.clear_owned_resources();
// Verify non-shared was removed
let res_a = r.get::<A>();
assert!(res_a.is_none());
// Verify shared is still present
let res_b = r.get::<B>().unwrap();
assert_eq!(res_b.0, 1);
}
}