Intern entity paths for faster comparisons. #11711
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| //! Entity paths for referring to bones. | ||
|
|
||
| use std::{ | ||
| fmt::{self, Debug, Formatter, Write}, | ||
| hash::{Hash, Hasher}, | ||
| sync::{Arc, Mutex, OnceLock, Weak}, | ||
| }; | ||
|
|
||
| use bevy_core::Name; | ||
| use bevy_reflect::Reflect; | ||
| use bevy_utils::prelude::default; | ||
| use weak_table::WeakHashSet; | ||
|
|
||
| static ENTITY_PATH_STORE: OnceLock<Mutex<EntityPathStore>> = OnceLock::new(); | ||
|
|
||
| /// Path to an entity, with [`Name`]s. Each entity in a path must have a name. | ||
| #[derive(Clone, Reflect)] | ||
| #[reflect_value] | ||
| pub struct EntityPath(Arc<EntityPathNode>); | ||
|
|
||
| #[derive(PartialEq, Eq, Hash)] | ||
| struct EntityPathNode { | ||
| name: Name, | ||
| parent: Option<EntityPath>, | ||
| } | ||
|
|
||
| // This could use a `RwLock`, but we actually never read from this, so a mutex | ||
| // is actually slightly more efficient! | ||
| #[derive(Default)] | ||
| struct EntityPathStore(WeakHashSet<Weak<EntityPathNode>>); | ||
|
|
||
| pub struct EntityPathIter<'a>(Option<&'a EntityPath>); | ||
|
|
||
| impl EntityPathStore { | ||
| fn create_path(&mut self, node: EntityPathNode) -> EntityPath { | ||
| match self.0.get(&node) { | ||
| Some(node) => EntityPath(node), | ||
| None => { | ||
| let node = Arc::new(node); | ||
| self.0.insert(node.clone()); | ||
| EntityPath(node) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl EntityPath { | ||
| pub fn from_name(name: Name) -> EntityPath { | ||
| ENTITY_PATH_STORE | ||
| .get_or_init(|| default()) | ||
| .lock() | ||
| .unwrap() | ||
| .create_path(EntityPathNode { name, parent: None }) | ||
| } | ||
|
|
||
| pub fn from_names(names: &[Name]) -> EntityPath { | ||
| let mut store = ENTITY_PATH_STORE.get_or_init(|| default()).lock().unwrap(); | ||
|
|
||
| let mut names = names.iter(); | ||
| let root_name = names | ||
| .next() | ||
| .expect("Entity path must have at least one name in it"); | ||
|
|
||
| let mut path = store.create_path(EntityPathNode { | ||
| name: root_name.clone(), | ||
| parent: None, | ||
| }); | ||
| for name in names { | ||
| path = store.create_path(EntityPathNode { | ||
| name: name.clone(), | ||
| parent: Some(path), | ||
| }); | ||
| } | ||
|
|
||
| path | ||
| } | ||
|
|
||
| pub fn extend(&self, name: Name) -> EntityPath { | ||
| ENTITY_PATH_STORE | ||
| .get_or_init(|| default()) | ||
| .lock() | ||
| .unwrap() | ||
| .create_path(EntityPathNode { | ||
| name, | ||
| parent: Some(self.clone()), | ||
| }) | ||
| } | ||
|
|
||
| pub fn iter(&self) -> EntityPathIter { | ||
| EntityPathIter(Some(self)) | ||
| } | ||
|
|
||
| pub fn root(&self) -> &Name { | ||
| &self.iter().last().unwrap().0.name | ||
| } | ||
|
Comment on lines
+93
to
+95
There was a problem hiding this comment. It's kind of unfortunate that common operations like |
||
|
|
||
| pub fn len(&self) -> usize { | ||
| self.iter().count() | ||
| } | ||
|
|
||
| pub fn name(&self) -> &Name { | ||
| &self.0.name | ||
| } | ||
| } | ||
|
|
||
| impl PartialEq for EntityPath { | ||
| fn eq(&self, other: &Self) -> bool { | ||
| Arc::ptr_eq(&self.0, &other.0) | ||
| } | ||
| } | ||
|
|
||
| impl Eq for EntityPath {} | ||
|
|
||
| impl Hash for EntityPath { | ||
| fn hash<H: Hasher>(&self, state: &mut H) { | ||
| // Hash by address. This is safe because entity paths are unique. | ||
| (self.0.as_ref() as *const EntityPathNode).hash(state) | ||
|
There was a problem hiding this comment. Nit: this could be |
||
| } | ||
| } | ||
|
|
||
| impl Debug for EntityPath { | ||
| fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { | ||
| let mut names = vec![]; | ||
| let mut current_path = Some(self.clone()); | ||
| while let Some(path) = current_path { | ||
| names.push(path.0.name.clone()); | ||
| current_path = path.0.parent.clone(); | ||
| } | ||
|
|
||
| for (name_index, name) in names.iter().rev().enumerate() { | ||
| if name_index > 0 { | ||
| f.write_char('/')?; | ||
| } | ||
| f.write_str(name)?; | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| impl<'a> Iterator for EntityPathIter<'a> { | ||
| type Item = &'a EntityPath; | ||
|
|
||
| fn next(&mut self) -> Option<Self::Item> { | ||
| match self.0 { | ||
| None => None, | ||
| Some(node) => { | ||
| self.0 = node.0.parent.as_ref(); | ||
| Some(node) | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could make it clearer that the iterator is actually reversed.