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 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
#![deny(warnings)] #![cfg_attr(feature="nightly", feature(const_fn))] #![cfg_attr(feature="nightly", feature(try_reserve))] #![cfg_attr(feature="nightly", feature(shrink_to))] #![cfg_attr(not(feature="std"), no_std)] #[cfg(feature="std")] extern crate core; extern crate alloc; #[cfg(feature="nightly")] use alloc::collections::TryReserveError; use core::fmt::Debug; use core::hash::Hash; use core::hint::unreachable_unchecked; use core::marker::PhantomData; use core::mem::replace; use core::num::{NonZeroUsize}; use core::ops::{Index, IndexMut}; #[cfg(feature="std")] use std::panic::{UnwindSafe, RefUnwindSafe}; use core::sync::atomic::{AtomicBool, Ordering}; use alloc::vec::Vec; use either::{Either, Left, Right}; use rand::rngs::SmallRng; use rand::{RngCore, SeedableRng}; #[cfg(all(feature="std", feature="nightly"))] use once_cell::sync::{self}; #[cfg(all(feature="std", feature="nightly"))] use std::sync::Mutex; #[cfg(all(feature="std", feature="nightly"))] use std::ops::Deref; use educe::Educe; #[doc(hidden)] pub use core::marker::PhantomData as std_marker_PhantomData; /// The return type of the [`ComponentClass::lock`](ComponentClass::lock) function. /// /// The [`ComponentClass::lock`](ComponentClass::lock) function /// is essential for components arena internal mechanic. pub struct ComponentClassLock(AtomicBool); impl ComponentClassLock { /// Creates new `ComponentClassLock` instance. /// /// The function is `const`, and can be used for static initialization. pub const fn new() -> Self { ComponentClassLock(AtomicBool::new(false)) } } impl Default for ComponentClassLock { fn default() -> Self { ComponentClassLock::new() } } /// An utility trait describing a specific component type. /// /// Normally for a non-generic component type /// the component type itself implements `ComponentClass`. /// /// For generic components it would be difficult to have /// an own [`ComponentClassLock`](ComponentClassLock) instance for every specialization because Rust /// does not have "generic statics" feature. /// /// So, if some component type `X` is generic, normally you should introduce /// common non-generic uninhabited type `XComponent` and implement /// `ComponentClass` for this synthetic type. /// /// Correct implementation should return reference to the one and same /// `ComponentClassLock` instance from the [`lock`](ComponentClass::lock) function. /// Also it should be guaranteed that no other `ComponentClass` implementation /// returns same `ComponentClassLock` instance. /// This requirements can be easily satisfied with private static: /// /// ```rust /// # use components_arena::{ComponentClass, ComponentClassLock}; /// # /// struct MyComponent { /* ... */ } /// /// impl ComponentClass for MyComponent { /// fn lock() -> &'static ComponentClassLock { /// static LOCK: ComponentClassLock = ComponentClassLock::new(); /// &LOCK /// } /// } /// ``` pub trait ComponentClass { /// Essential for components arena internal mechanic. fn lock() -> &'static ComponentClassLock where Self: Sized; } /// An implementer of the `Component` trait is a type, whose values can be placed into /// [`Arena`](Arena) container. /// /// Normally, the implementation of this trait is derived /// using the [`Component!`](Component!) macro. pub trait Component { /// Component class. /// /// Normally it is `Self` for non-generic types, and /// non-generic synthetic uninhabited type for generic ones. type Class: ComponentClass; } /// [`Arena`](Arena) item handle. #[derive(Educe)] #[educe(Debug, Copy, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)] pub struct Id<C: Component> { index: usize, guard: NonZeroUsize, phantom: PhantomData<C> } unsafe impl<C: Component> Send for Id<C> { } unsafe impl<C: Component> Sync for Id<C> { } impl<C: Component> Unpin for Id<C> { } #[cfg(feature="std")] impl<C: Component> RefUnwindSafe for Id<C> { } #[cfg(feature="std")] impl<C: Component> UnwindSafe for Id<C> { } /// Non-generic, FFI-friendly [`ComponentId`](ComponentId) representaion. pub type RawId = (usize, NonZeroUsize); /// An implementer of the `ComponentId` trait is a type behaves as [`Id`](Id). pub trait ComponentId: Debug + Copy + Eq + Ord + Hash { /// Forms an id from the [`into_raw`](ComponentId::into_raw) function result. fn from_raw(raw: RawId) -> Self; /// Transforms the id to primitive-typed parts, which can be easily passed through FFI /// and stored in non-generic context. /// /// Use [`from_raw`](ComponentId::from_raw) to get the source id back. fn into_raw(self) -> RawId; } impl ComponentId for RawId { fn from_raw(raw: RawId) -> Self { raw } fn into_raw(self) -> RawId { self } } impl<C: Component> ComponentId for Id<C> { fn from_raw(raw: RawId) -> Self { Id { index: raw.0, guard: raw.1, phantom: PhantomData } } fn into_raw(self) -> RawId { (self.index, self.guard) } } impl ComponentId for () { fn from_raw(raw: RawId) -> Self { if raw.0 != 49293544 && raw.1.get() != 846146046 { panic!("invalid empty tuple id"); } } fn into_raw(self) -> RawId { (49293544, unsafe { NonZeroUsize::new_unchecked(846146046) }) } } impl ComponentId for usize { fn from_raw(raw: RawId) -> Self { if raw.1.get() != 434908713 { panic!("invalid integer id"); } raw.0 } fn into_raw(self) -> RawId { (self, unsafe { NonZeroUsize::new_unchecked(434908713) }) } } /// Unordered container with random access. #[derive(Debug)] pub struct Arena<C: Component> { guard_rng: SmallRng, items: Vec<Either<Option<usize>, (NonZeroUsize, C)>>, vacancy: Option<usize>, } /// [Component class](ComponentClass) static shared data. /// /// In the no-`no_std` environment it can be stored inside static /// [`ComponentClassMutex`](ComponentClassMutex): /// /// ```rust /// # use macro_attr_2018::macro_attr; /// # use components_arena::{Component, ComponentClassMutex, Arena}; /// # /// macro_attr! { /// #[derive(Component!)] /// struct MyComponent { /* ... */ } /// } /// /// static MY_COMPONENT: ComponentClassMutex<MyComponent> = ComponentClassMutex::new(); /// /// // ... /// /// # fn main() { /// let mut arena = Arena::new(&mut MY_COMPONENT.lock().unwrap()); /// let id = arena.insert(|id| (MyComponent { /* ... */ }, id)); /// # } /// ``` /// /// In the `no_std` environment a custom solution should be used to store `ComponentClassToken`. pub struct ComponentClassToken<C: ComponentClass> { guard_seed_rng: SmallRng, phantom: PhantomData<C> } unsafe impl<C: ComponentClass> Send for ComponentClassToken<C> { } unsafe impl<C: ComponentClass> Sync for ComponentClassToken<C> { } impl<C: ComponentClass> Unpin for ComponentClassToken<C> { } #[cfg(feature="std")] impl<C: ComponentClass> RefUnwindSafe for ComponentClassToken<C> { } #[cfg(feature="std")] impl<C: ComponentClass> UnwindSafe for ComponentClassToken<C> { } impl<C: ComponentClass> ComponentClassToken<C> { /// Creates components shared data storage on first call for every component type `C`. /// All subsequent calls will return `None`. pub fn new() -> Option<ComponentClassToken<C>> { let lock = C::lock(); if lock.0.compare_and_swap(false, true, Ordering::Relaxed) { None } else { Some(ComponentClassToken { guard_seed_rng: SmallRng::seed_from_u64(42), phantom: PhantomData }) } } } impl<C: Component> Arena<C> { /// Creates an arena instance. pub fn new(class: &mut ComponentClassToken<C::Class>) -> Self { Arena { guard_rng: SmallRng::seed_from_u64(class.guard_seed_rng.next_u64()), items: Vec::new(), vacancy: None } } /// Creates an arena instance with the specified initial capacity. pub fn with_capacity(capacity: usize, class: &mut ComponentClassToken<C::Class>) -> Self { Arena { guard_rng: SmallRng::seed_from_u64(class.guard_seed_rng.next_u64()), items: Vec::with_capacity(capacity), vacancy: None } } /// Returns the number of elements the arena can hold without reallocating. pub fn capacity(&self) -> usize { self.items.capacity() } /// Returns the number of elements in the arena. /// /// This function has linear worst-case complexity. pub fn len(&self) -> usize { let mut vacancies = 0; let mut vacancy = self.vacancy; while let Some(i) = vacancy { vacancies += 1; vacancy = *self.items[i].as_ref().left().unwrap(); } self.items.len() - vacancies } /// Returns `true` if the arena contains no elements. /// /// This function has linear worst-case complexity. pub fn is_empty(&self) -> bool { self.items.iter().all(|x| x.is_left()) } /// Returns the maximum number of elements ever in the arena. /// The arena capacity cannot be less than `min_capacity`. /// /// Arena `min_capacity` never decreases. /// /// # Examples /// /// ```rust /// # use macro_attr_2018::macro_attr; /// # use components_arena::{Component, ComponentClassMutex, Arena}; /// # /// # macro_attr! { /// # #[derive(Component!)] /// # struct MyComponent { /* ... */ } /// # } /// # /// # static MY_COMPONENT: ComponentClassMutex<MyComponent> = ComponentClassMutex::new(); /// # /// # fn main() { /// let mut arena = Arena::new(&mut MY_COMPONENT.lock().unwrap()); /// assert_eq!(arena.min_capacity(), 0); /// let id_1 = arena.insert(|id| (MyComponent { /* ... */ }, id)); /// assert_eq!(arena.min_capacity(), 1); /// let id_2 = arena.insert(|id| (MyComponent { /* ... */ }, id)); /// assert_eq!(arena.min_capacity(), 2); /// arena.remove(id_1); /// assert_eq!(arena.min_capacity(), 2); /// let id_3 = arena.insert(|id| (MyComponent { /* ... */ }, id)); /// assert_eq!(arena.min_capacity(), 2); /// let id_4 = arena.insert(|id| (MyComponent { /* ... */ }, id)); /// assert_eq!(arena.min_capacity(), 3); /// # } /// ``` pub fn min_capacity(&self) -> usize { self.items.len() } /// Reserves capacity for at least `additional` more elements. /// The collection may reserve more space to avoid frequent reallocations. /// After calling `reserve`, capacity will be greater than or equal to /// `self.min_capacity() + additional`. Does nothing if capacity is already sufficient. /// /// # Panics /// /// Panics if the new capacity overflows usize. pub fn reserve(&mut self, additional: usize) { self.items.reserve(additional) } /// Reserves the minimum capacity for exactly `additional` more elements. /// After calling `reserve_exact`, capacity will be greater than or equal to /// `self.min_capacity() + additional`. Does nothing if the capacity is already sufficient. /// /// Note that the allocator may give the collection more space than it requests. /// Therefore, capacity can not be relied upon to be precisely minimal. /// Prefer [`reserve`](Arena::reserve) if future insertions are expected. /// /// # Panics /// /// Panics if the new capacity overflows usize. pub fn reserve_exact(&mut self, additional: usize) { self.items.reserve_exact(additional) } /// Shrinks the capacity of the arena with a lower bound. /// /// The capacity will remain at least as large as both the [`min_capacity`](Arena::min_capacity) /// and the supplied value. #[cfg(feature="nightly")] pub fn shrink_to(&mut self, min_capacity: usize) { self.items.shrink_to(min_capacity) } /// Shrinks the capacity of the vector as much as possible. /// /// It will drop down as close as possible to the [`min_capacity`](Arena::min_capacity) /// but the allocator may still inform the arena that there is space for a few more elements. pub fn shrink_to_fit(&mut self) { self.items.shrink_to_fit() } /// Tries to reserve capacity for at least additional more elements. /// The collection may reserve more space to avoid frequent reallocations. /// After calling `try_reserve`, capacity will be greater than or equal /// to `self.min_capacity() + additional`. Does nothing if capacity is already sufficient. /// /// # Errors /// /// If the capacity overflows, or the allocator reports a failure, then an error is returned. #[cfg(feature="nightly")] pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> { self.items.try_reserve(additional) } /// Tries to reserve capacity for exactly additional more elements. /// The collection may reserve more space to avoid frequent reallocations. /// After calling `try_reserve_exact`, capacity will be greater than or equal /// to `self.min_capacity() + additional`. Does nothing if capacity is already sufficient. /// /// Note that the allocator may give the collection more space than it requests. /// Therefore, capacity can not be relied upon to be precisely minimal. /// Prefer [`try_reserve`](Arena::try_reserve) if future insertions are expected. /// /// # Errors /// /// If the capacity overflows, or the allocator reports a failure, then an error is returned. #[cfg(feature="nightly")] pub fn try_reserve_exact(&mut self, additional: usize) -> Result<(), TryReserveError> { self.items.try_reserve_exact(additional) } /// Place new component into the arena. /// /// # Examples /// /// ```rust /// # use macro_attr_2018::macro_attr; /// # use components_arena::{Component, ComponentClassMutex, Arena}; /// # /// # macro_attr! { /// # #[derive(Component!)] /// # struct MyComponent { /* ... */ } /// # } /// # /// # static MY_COMPONENT: ComponentClassMutex<MyComponent> = ComponentClassMutex::new(); /// # /// # fn main() { /// let mut arena = Arena::new(&mut MY_COMPONENT.lock().unwrap()); /// let new_component_id = arena.insert(|id| (MyComponent { /* ... */ }, id)); /// # } /// ``` pub fn insert<T>(&mut self, component: impl FnOnce(Id<C>) -> (C, T)) -> T { let mut guard = 0usize.to_le_bytes(); self.guard_rng.fill_bytes(&mut guard[..]); let guard = NonZeroUsize::new(usize::from_le_bytes(guard)).unwrap_or(unsafe { NonZeroUsize::new_unchecked(42) }); if let Some(index) = self.vacancy { let id = Id { index, guard, phantom: PhantomData }; let (component, result) = component(id); let item = (guard, component); self.vacancy = replace(&mut self.items[index], Right(item)).left() .unwrap_or_else(|| unsafe { unreachable_unchecked() }); result } else { let index = self.items.len(); let id = Id { index, guard, phantom: PhantomData }; let (component, result) = component(id); let item = (guard, component); self.items.push(Right(item)); result } } /// Removes component with provided id. /// /// The arena tries to detect invalid provided id (i. e. foreign, or previously dropped), /// and panics if such detection hits. But it is important to pay respect to the fact /// there is small probability that invalid id will not be intercepted. pub fn remove(&mut self, id: Id<C>) -> C { match replace(&mut self.items[id.index], Left(self.vacancy)) { Left(vacancy) => { self.items[id.index] = Left(vacancy); panic!("invalid id"); }, Right((guard, component)) => { if guard == id.guard { self.vacancy = Some(id.index); component } else { self.items[id.index] = Right((guard, component)); panic!("invalid id"); } } } } } impl<C: Component> Index<Id<C>> for Arena<C> { type Output = C; fn index(&self, id: Id<C>) -> &C { let &(guard, ref component) = self.items[id.index].as_ref().right().expect("invalid id"); if guard != id.guard { panic!("invalid id"); } component } } impl<C: Component> IndexMut<Id<C>> for Arena<C> { fn index_mut(&mut self, id: Id<C>) -> &mut C { let &mut (guard, ref mut component) = self.items[id.index].as_mut().right().expect("invalid id"); if guard != id.guard { panic!("invalid id"); } component } } /// Helps to store [`ComponentClassToken`](ComponentClassToken) in a static. /// /// # Examples /// /// ```rust /// # use macro_attr_2018::macro_attr; /// # use components_arena::{Component, ComponentClassMutex, Arena}; /// # /// macro_attr! { /// #[derive(Component!)] /// struct MyComponent { /* ... */ } /// } /// /// static MY_COMPONENT: ComponentClassMutex<MyComponent> = ComponentClassMutex::new(); /// /// // ... /// /// # fn main() { /// let mut arena = Arena::new(&mut MY_COMPONENT.lock().unwrap()); /// # let id = arena.insert(|id| (MyComponent { /* ... */ }, id)); /// # } /// ``` #[cfg(all(feature="std", feature="nightly"))] pub struct ComponentClassMutex<C: ComponentClass>(sync::Lazy<Mutex<ComponentClassToken<C>>>); #[cfg(all(feature="std", feature="nightly"))] impl<C: ComponentClass> ComponentClassMutex<C> { /// Creates new `ComponentClassMutex` instance. /// /// The function is `const`, and can be used for static initialization. pub const fn new() -> Self { ComponentClassMutex(sync::Lazy::new(|| Mutex::new( ComponentClassToken::new().expect("component class token already crated") ))) } } #[cfg(all(feature="std", feature="nightly"))] impl<C: ComponentClass> Deref for ComponentClassMutex<C> { type Target = Mutex<ComponentClassToken<C>>; fn deref(&self) -> &Self::Target { self.0.deref() } } /// [Macro attribute](https://crates.io/crates/macro-attr-2018) for deriving [`Component`](trait@Component) trait. /// /// # Examples /// /// ## Non-generic component /// /// ```rust /// # use macro_attr_2018::macro_attr; /// # use components_arena::{Component, ComponentClassMutex, Arena}; /// # /// macro_attr! { /// #[derive(Component!)] /// struct Item { /* ... */ } /// } /// /// static ITEM: ComponentClassMutex<Item> = ComponentClassMutex::new(); /// /// // ... /// /// # fn main() { /// let mut arena = Arena::new(&mut ITEM.lock().unwrap()); /// let id = arena.insert(|id| (Item { /* ... */ }, id)); /// # } /// ``` /// /// ## Generic component /// /// ```rust /// # use macro_attr_2018::macro_attr; /// # use components_arena::{Component, ComponentClassMutex, Arena}; /// # /// macro_attr! { /// #[derive(Component!(class=ItemComponent))] /// struct Item<T> { /// context: T /// } /// } /// /// static ITEM: ComponentClassMutex<ItemComponent> = ComponentClassMutex::new(); /// /// // ... /// /// # fn main() { /// let mut arena_u8 = Arena::new(&mut ITEM.lock().unwrap()); /// let _ = arena_u8.insert(|id| (Item { context: 7u8 }, id)); /// /// let mut arena_u32 = Arena::new(&mut ITEM.lock().unwrap()); /// let _ = arena_u32.insert(|id| (Item { context: 7u32 }, id)); /// # } /// ``` #[macro_export] macro_rules! Component { ( () $vis:vis enum $name:ident $($body:tt)+ ) => { $crate::Component! { @impl [$name] } }; ( () $vis:vis struct $name:ident $($body:tt)+ ) => { $crate::Component! { @impl [$name] } }; ( (class=$class:ident) $vis:vis enum $name:ident < $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+ $(,)?> $($body:tt)+ ) => { $crate::Component! { @impl <> [$vis] [$name] [$class] [ < $( $lt ),+ > ] [ < $( $lt $( : $clt $(+ $dlt )* )? ),+ > ] } }; ( (class=$class:ident) $vis:vis struct $name:ident < $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+ $(,)?> $($body:tt)+ ) => { $crate::Component! { @impl <> [$vis] [$name] [$class] [ < $( $lt ),+ > ] [ < $( $lt $( : $clt $(+ $dlt )* )? ),+ > ] } }; ( @impl [$name:ident] ) => { impl $crate::ComponentClass for $name { fn lock() -> &'static $crate::ComponentClassLock { static LOCK: $crate::ComponentClassLock = $crate::ComponentClassLock::new(); &LOCK } } impl $crate::Component for $name { type Class = Self; } }; ( @impl <> [$vis:vis] [$name:ident] [$class:ident] [ $($g:tt)+ ] [ $($r:tt)+ ] ) => { $vis enum $class { } impl $crate::ComponentClass for $class { fn lock() -> &'static $crate::ComponentClassLock { static LOCK: $crate::ComponentClassLock = $crate::ComponentClassLock::new(); &LOCK } } impl $($g)+ $crate::Component for $name $($r)+ { type Class = $class; } }; } /// [Macro attribute](https://crates.io/crates/macro-attr-2018) for deriving [`ComponentId`](trait@ComponentId) trait. /// /// # Examples /// /// ```rust /// # use macro_attr_2018::macro_attr; /// # use educe::Educe; /// use std::marker::PhantomData; /// use components_arena::{Component, Id, ComponentId}; /// /// # macro_attr! { /// # #[derive(Component!(class=ItemNodeComponent))] /// # struct ItemNode<Tag> { /// # /* ... */ /// # tag: Tag /// # } /// # } /// # /// macro_attr! { /// #[derive(ComponentId!)] /// #[derive(Educe)] /// #[educe(Debug, Copy, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)] /// pub struct Item<Tag, X>(Id<ItemNode<Tag>>, PhantomData<X>); /// } /// ``` #[macro_export] macro_rules! ComponentId { ( () $vis:vis struct $name:ident $(< $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+ $(,)?>)? ($id:ty $(, $($phantom:ty),+ $(,)?)?); ) => { $crate::ComponentId! { @impl [$vis] [$name] [$(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?] [$(< $( $lt ),+ >)?] [] [$($($phantom),+)?] } }; ( @impl [$vis:vis] [$name:ident] [$($g:tt)*] [$($r:tt)*] [$($phantom_args:tt)*] [$phantom:ty $(, $($other_phantoms:tt)+)?] ) => { $crate::ComponentId! { @impl [$vis] [$name] [$($g)*] [$($r)*] [ $($phantom_args)* $crate::std_marker_PhantomData, ] [$($($other_phantoms)+)?] } }; ( @impl [$vis:vis] [$name:ident] [$($g:tt)*] [$($r:tt)*] [$($phantom_args:tt)*] [] ) => { impl $($g)* $crate::ComponentId for $name $($r)* { fn from_raw(raw: $crate::RawId) -> Self { $name($crate::Id::from_raw(raw), $($phantom_args)*) } fn into_raw(self) -> $crate::RawId { $crate::Id::into_raw(self.0) } } }; } #[cfg(test)] mod test { use macro_attr_2018::macro_attr; use quickcheck_macros::quickcheck; use std::sync::atomic::{Ordering, AtomicI8}; use crate::*; macro_attr! { #[derive(Component!(class=GenericOneArgComponent))] struct GenericOneArg<T>(T); } macro_attr! { #[derive(Component!(class=GenericTwoArgsComponent))] struct GenericTwoArgs<A, B>(A, B); } macro_attr! { #[derive(Component!)] struct Test { this: Id<Test>, value: i8 } } static TEST_DROP: AtomicI8 = AtomicI8::new(-1); impl Drop for Test { fn drop(&mut self) { TEST_DROP.store(self.value, Ordering::SeqCst); } } static TEST: ComponentClassMutex<Test> = ComponentClassMutex::new(); #[quickcheck] fn new_arena_min_capacity_is_zero(capacity: Option<usize>) -> bool { capacity.map_or_else( || <Arena::<Test>>::new(&mut TEST.lock().unwrap()), |capacity| <Arena::<Test>>::with_capacity(capacity, &mut TEST.lock().unwrap()) ).min_capacity() == 0 } #[quickcheck] fn arena_contains_inserted_item(capacity: Option<usize>, value: i8) -> bool { let mut arena = capacity.map_or_else( || Arena::new(&mut TEST.lock().unwrap()), |capacity| Arena::with_capacity(capacity, &mut TEST.lock().unwrap()) ); let id = arena.insert(|this| (Test { this, value }, this)); arena[id].this == id && arena[id].value == value } #[should_panic] #[test] fn foreign_id_cause_panic() { let mut arena = Arena::new(&mut TEST.lock().unwrap()); let id = arena.insert(|this| (Test { this, value: 7 }, this)).into_raw(); let id = Id::from_raw((id.0, unsafe { NonZeroUsize::new_unchecked(17) })); let _ = &arena[id]; } #[test] fn drop_components() { { let mut arena = Arena::new(&mut TEST.lock().unwrap()); arena.insert(|this| (Test { this, value: 7 }, this)).into_raw(); TEST_DROP.store(-1, Ordering::SeqCst); } assert_eq!(TEST_DROP.load(Ordering::SeqCst), 7); } macro_attr! { #[derive(ComponentId!)] #[derive(Educe)] #[educe(Debug, Copy, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)] struct IdWrap1(Id<Test>); } macro_attr! { #[derive(ComponentId!)] #[derive(Educe)] #[educe(Debug, Copy, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)] struct IdWrap2<X>(Id<Test>, PhantomData<X>); } macro_attr! { #[derive(ComponentId!)] #[derive(Educe)] #[educe(Debug, Copy, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)] struct IdWrap3<X, Y: Copy>(Id<Test>, PhantomData<X>, PhantomData<Y>); } }