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
//! Provides resource and deserialization for prototype data.
use std::any::{Any, TypeId};
use std::ffi::OsStr;
use std::ops::{Deref, DerefMut};
use bevy::asset::{Asset, HandleId, HandleUntyped};
use bevy::ecs::prelude::World;
use bevy::ecs::system::{EntityCommands, Resource};
use bevy::prelude::{FromWorld, Handle};
use bevy::reflect::Uuid;
use bevy::utils::HashMap;
use dyn_clone::DynClone;
use indexmap::IndexSet;
use serde::{Deserialize, Serialize};
use crate::plugin::DefaultProtoDeserializer;
use crate::{components::ProtoComponent, prototype::Prototypical, utils::handle_cycle};
/// A String newtype for a handle's asset path
#[derive(Serialize, Deserialize, Clone, Hash, Eq, PartialEq, Debug)]
pub struct HandlePath(pub String);
impl Deref for HandlePath {
type Target = String;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl From<&HandlePath> for HandleId {
fn from(p: &HandlePath) -> Self {
let slice: &str = &p.0;
slice.into()
}
}
type UuidHandleMap = HashMap<Uuid, HandleUntyped>;
/// A resource containing data for all prototypes that need data stored
#[derive(Resource)]
pub struct ProtoData {
/// Maps Prototype Name -> Component Type -> HandleId -> Asset Type -> HandleUntyped
handles: HashMap<
String, // Prototype Name
HashMap<
TypeId, // Component Type
HashMap<HandleId, UuidHandleMap>,
>,
>,
pub(crate) prototypes: HashMap<String, Box<dyn Prototypical>>,
}
impl ProtoData {
/// Creates a new, empty instance of [`ProtoData`].
pub fn empty() -> Self {
Self {
handles: HashMap::default(),
prototypes: HashMap::default(),
}
}
/// Get a loaded prototype with the given name
///
/// # Arguments
///
/// * `name`: The name of the prototype
///
/// returns: Option<&Prototype>
pub fn get_prototype(&self, name: &str) -> Option<&dyn Prototypical> {
self.prototypes.get(name).map(|b| b.as_ref())
}
/// Store a handle
///
/// # Arguments
///
/// * `protoytpe`: The Prototype this handle belongs to
/// * `component`: The ProtoComponent this handle belongs to
/// * `handle`: The handle
///
/// returns: ()
///
/// # Examples
///
/// ```
/// use bevy::prelude::*;
/// use bevy_proto_typetag::prelude::*;
/// use serde::{Deserialize, Serialize};
///
/// #[derive(Clone, Deserialize, Serialize, Component, ProtoComponent)]
/// struct MyComponent {
/// texture_path: HandlePath
/// }
///
/// fn some_loader(asset_server: Res<AssetServer>, mut data: ResMut<ProtoData>) {
/// let comp = MyComponent {
/// texture_path: HandlePath(String::from("path/to/texture.png"))
/// };
/// let proto = Prototype {
/// name: String::from("My Prototype"),
/// templates: Vec::default(),
/// components: vec![Box::new(comp.clone())]
/// };
///
/// let handle: Handle<Image> = asset_server.load(comp.texture_path.0.as_str());
///
/// data.insert_handle(&proto, &comp, handle);
/// }
/// ```
pub fn insert_handle<T: Asset>(
&mut self,
prototype: &dyn Prototypical,
component: &dyn ProtoComponent,
handle: Handle<T>,
) {
let proto_map = self
.handles
.entry(prototype.name().to_string())
.or_insert_with(HashMap::default);
let comp_map = proto_map
.entry(component.type_id())
.or_insert_with(HashMap::default);
let path_map = comp_map.entry(handle.id()).or_insert_with(HashMap::default);
path_map.insert(T::TYPE_UUID, handle.clone_untyped());
}
/// Get a cloned handle
///
/// # Arguments
///
/// * `protoytpe`: The Prototype this handle belongs to
/// * `component`: The ProtoComponent this handle belongs to
/// * `id`: The handle's id
///
/// returns: Option<Handle<T>>
pub fn get_handle<T, I>(
&self,
protoytpe: &dyn Prototypical,
component: &dyn ProtoComponent,
id: I,
) -> Option<Handle<T>>
where
T: Asset,
I: Into<HandleId>,
{
let handle = self.get_untyped_handle(protoytpe, component, id.into(), T::TYPE_UUID)?;
Some(handle.clone().typed::<T>())
}
/// Get a weakly cloned handle
///
/// # Arguments
///
/// * `protoytpe`: The Prototype this handle belongs to
/// * `component`: The ProtoComponent this handle belongs to
/// * `id`: The handle's id
///
/// returns: Option<Handle<T>>
pub fn get_handle_weak<T: Asset>(
&self,
protoytpe: &dyn Prototypical,
component: &dyn ProtoComponent,
id: HandleId,
) -> Option<Handle<T>> {
let handle = self.get_untyped_handle(protoytpe, component, id, T::TYPE_UUID)?;
Some(handle.clone_weak().typed::<T>())
}
/// Get a untyped handle reference
///
/// # Arguments
///
/// * `protoytpe`: The Prototype this handle belongs to
/// * `component`: The ProtoComponent this handle belongs to
/// * `id`: The handle's id
/// * `asset_type`: The asset type
///
/// returns: Option<&HandleUntyped>
pub fn get_untyped_handle(
&self,
protoytpe: &dyn Prototypical,
component: &dyn ProtoComponent,
id: HandleId,
asset_type: Uuid,
) -> Option<&HandleUntyped> {
let proto_map = self.handles.get(protoytpe.name())?;
let comp_map = proto_map.get(&component.type_id())?;
let path_map = comp_map.get(&id)?;
path_map.get(&asset_type)
}
/// Create a [`ProtoCommands`] object for the given prototype
///
/// # Arguments
///
/// * `prototype`: The associated prototype
/// * `commands`: The [`EntityCommands`]
///
/// returns: ProtoCommands
pub fn get_commands<'w, 's, 'a, 'p>(
&'p self,
prototype: &'p dyn Prototypical,
commands: EntityCommands<'w, 's, 'a>,
) -> ProtoCommands<'w, 's, 'a, 'p> {
ProtoCommands {
commands,
prototype,
data: self,
}
}
/// Get an iterator over all prototypes
pub fn iter(&self) -> impl Iterator<Item = &Box<dyn Prototypical>> {
self.prototypes.values()
}
/// Get a mutable iterator over all prototypes
pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Box<dyn Prototypical>> {
self.prototypes.values_mut()
}
}
impl FromWorld for ProtoData {
fn from_world(world: &mut World) -> Self {
let mut myself = Self {
handles: Default::default(),
prototypes: HashMap::default(),
};
let options = world
.get_resource::<ProtoDataOptions>()
.expect("Expected options for ProtoData")
.clone();
for directory in options.directories {
process_path(
world,
&options.extensions,
options.deserializer.as_ref(),
&mut myself,
&directory,
options.recursive_loading,
);
}
#[cfg(feature = "analysis")]
analyze_deps(&myself);
myself
}
}
/// Helper function to populate our ProtoData.
fn process_path(
world: &mut World,
extensions: &Option<Vec<&str>>,
deserializer: &(dyn ProtoDeserializer + Send + Sync),
myself: &mut ProtoData,
directory: &str,
recursive: bool,
) {
if let Ok(dir) = std::fs::read_dir(directory) {
for file_info in dir {
if file_info.is_err() {
continue;
}
let file_info = file_info.unwrap();
let path = file_info.path();
if recursive && path.is_dir() {
process_path(
world,
extensions,
deserializer,
myself,
&path.to_str().unwrap().to_string(),
recursive,
);
}
if let Some(filters) = &extensions {
if let Some(ext) = path.extension().and_then(OsStr::to_str) {
if !filters.iter().any(|filter| filter == &ext) {
continue;
}
}
}
if let Ok(data) = std::fs::read_to_string(path) {
if let Some(proto) = deserializer.deserialize(&data) {
for component in proto.iter_components() {
component.prepare(world, proto.as_ref(), myself);
}
myself.prototypes.insert(proto.name().to_string(), proto);
}
}
}
}
}
/// Performs some analysis on the given [`ProtoData`] resource
fn analyze_deps(data: &ProtoData) {
// === Perform Analysis === //
for proto in data.iter() {
check_for_cycles(proto.as_ref(), data, &mut IndexSet::default());
}
// === Analysis Functions === //
fn check_for_cycles<'a>(
proto: &'a dyn Prototypical,
data: &'a ProtoData,
traversed: &mut IndexSet<&'a str>,
) {
traversed.insert(proto.name());
for template in proto.templates_rev() {
if traversed.contains(template.as_str()) {
// ! --- Found Circular Dependency --- ! //
handle_cycle!(template, traversed);
continue;
}
if let Some(parent) = data.get_prototype(template) {
// --- Check Template --- //
check_for_cycles(parent, data, traversed);
}
}
}
}
/// A wrapper around [`EntityCommands`] and [`ProtoData`] for a specified prototype.
/// This allows [`ProtoData`] to be accessed with the underlying prototype directly,
/// and grants direct access to the [`EntityCommands`] that spawned that prototype in.
pub struct ProtoCommands<'w, 's, 'a, 'p> {
/// The associated [`EntityCommands`]
commands: EntityCommands<'w, 's, 'a>,
/// The associated prototype
prototype: &'p dyn Prototypical,
/// The [`ProtoData`] resource
data: &'p ProtoData,
}
impl<'w, 's, 'a, 'p> ProtoCommands<'w, 's, 'a, 'p> {
/// Get raw access to [`EntityCommands`]
pub fn raw_commands(&mut self) -> &mut EntityCommands<'w, 's, 'a> {
&mut self.commands
}
/// Get the associated prototype
pub fn protoype(&self) -> &dyn Prototypical {
self.prototype
}
/// Get raw access to the underlying [`ProtoData`] resource
pub fn raw_data(&self) -> &ProtoData {
self.data
}
/// Get a cloned handle
///
/// # Arguments
///
/// * `component`: The ProtoComponent this handle belongs to
/// * `id`: The handle's id
///
/// returns: Option<Handle<T>>
pub fn get_handle<T, I>(&self, component: &dyn ProtoComponent, id: I) -> Option<Handle<T>>
where
T: Asset,
I: Into<HandleId>,
{
self.data.get_handle(self.prototype, component, id)
}
/// Get a weakly cloned handle
///
/// # Arguments
///
/// * `component`: The ProtoComponent this handle belongs to
/// * `id`: The handle's id
///
/// returns: Option<Handle<T>>
pub fn get_handle_weak<T: Asset>(
&self,
component: &dyn ProtoComponent,
id: HandleId,
) -> Option<Handle<T>> {
self.data.get_handle_weak(self.prototype, component, id)
}
/// Get a untyped handle reference
///
/// # Arguments
///
/// * `component`: The ProtoComponent this handle belongs to
/// * `path`: The handle's path
/// * `asset_type`: The asset type
///
/// returns: Option<&HandleUntyped>
pub fn get_untyped_handle(
&self,
component: &dyn ProtoComponent,
id: HandleId,
asset_type: Uuid,
) -> Option<&HandleUntyped> {
self.data
.get_untyped_handle(self.prototype, component, id, asset_type)
}
}
impl<'w, 's, 'a, 'p> From<ProtoCommands<'w, 's, 'a, 'p>> for EntityCommands<'w, 's, 'a> {
fn from(cmds: ProtoCommands<'w, 's, 'a, 'p>) -> Self {
cmds.commands
}
}
impl<'w, 's, 'a, 'p> Deref for ProtoCommands<'w, 's, 'a, 'p> {
type Target = EntityCommands<'w, 's, 'a>;
fn deref(&self) -> &Self::Target {
&self.commands
}
}
impl<'w, 's, 'a, 'p> DerefMut for ProtoCommands<'w, 's, 'a, 'p> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.commands
}
}
/// Defines a method for deserializing a prototype file input.
pub trait ProtoDeserializer: DynClone {
/// Deserializes file input (as a string) into a [`Prototypical`] object
///
/// # Arguments
///
/// * `data`: The file data as a string
///
/// returns: Option<Box<dyn Prototypical, Global>>
///
/// # Examples
///
/// ```
/// // The default implementation:
/// use bevy_proto_typetag::{Prototype, Prototypical};
/// fn example_deserialize(data: &str) -> Option<Box<dyn Prototypical>> {
/// if let Ok(value) = serde_yaml::from_str::<Prototype>(data) {
/// Some(Box::new(value))
/// } else {
/// None
/// }
/// }
/// ```
fn deserialize(&self, data: &str) -> Option<Box<dyn Prototypical>>;
}
dyn_clone::clone_trait_object!(ProtoDeserializer);
/// Options for controlling how prototype data is handled.
#[derive(Clone, Resource)]
pub struct ProtoDataOptions {
/// Directories containing prototype data.
pub directories: Vec<String>,
/// Whether to load files recursively from the specified top-level directories.
///
/// # Examples
///
/// ```
/// use bevy_proto_typetag::data::ProtoDataOptions;
///
/// // Recursively loads all yaml files from the "assets/prototypes" directory.
/// let opts = ProtoDataOptions {
/// directories: vec![String::from("assets/prototypes")],
/// recursive_loading: true,
/// extensions: Some(vec!["yaml"]),
/// ..Default::default()
/// };
/// ```
pub recursive_loading: bool,
/// A custom deserializer for prototypes.
pub deserializer: Box<dyn ProtoDeserializer + Send + Sync>,
/// An optional collection of file extensions to filter prototypes. These do __not__
/// have a dot ('.') prepended to them.
///
/// A value of None allows all files to be read.
///
/// # Examples
///
/// ```
/// use bevy_proto_typetag::data::ProtoDataOptions;
///
/// let opts = ProtoDataOptions {
/// // Only allow .yaml or .json files
/// extensions: Some(vec!["yaml", "json"]),
/// ..Default::default()
/// };
/// ```
pub extensions: Option<Vec<&'static str>>,
}
impl Default for ProtoDataOptions {
fn default() -> Self {
Self {
directories: Default::default(),
recursive_loading: Default::default(),
deserializer: Box::new(DefaultProtoDeserializer),
extensions: Default::default(),
}
}
}