Separate state crate (#13216)
# Objective
Extracts the state mechanisms into a new crate called "bevy_state".
This comes with a few goals:
- state wasn't really an inherent machinery of the ecs system, and so
keeping it within bevy_ecs felt forced
- by mixing it in with bevy_ecs, the maintainability of our more robust
state system was significantly compromised
moving state into a new crate makes it easier to encapsulate as it's own
feature, and easier to read and understand since it's no longer a
single, massive file.
## Solution
move the state-related elements from bevy_ecs to a new crate
## Testing
- Did you test these changes? If so, how? all the automated tests
migrated and passed, ran the pre-existing examples without changes to
validate.
---
## Migration Guide
Since bevy_state is now gated behind the `bevy_state` feature, projects
that use state but don't use the `default-features` will need to add
that feature flag.
Since it is no longer part of bevy_ecs, projects that use bevy_ecs
directly will need to manually pull in `bevy_state`, trigger the
StateTransition schedule, and handle any of the elements that bevy_app
currently sets up.
---------
Co-authored-by: Kristoffer Søholm <k.soeholm@gmail.com>
2024-05-09 18:06:05 +00:00
|
|
|
use proc_macro::TokenStream;
|
|
|
|
use quote::{format_ident, quote};
|
|
|
|
use syn::{parse_macro_input, spanned::Spanned, DeriveInput, Pat, Path, Result};
|
|
|
|
|
|
|
|
use crate::bevy_state_path;
|
|
|
|
|
|
|
|
pub fn derive_states(input: TokenStream) -> TokenStream {
|
|
|
|
let ast = parse_macro_input!(input as DeriveInput);
|
|
|
|
|
|
|
|
let generics = ast.generics;
|
|
|
|
let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
|
|
|
|
|
|
|
|
let mut base_trait_path = bevy_state_path();
|
|
|
|
base_trait_path.segments.push(format_ident!("state").into());
|
|
|
|
|
|
|
|
let mut trait_path = base_trait_path.clone();
|
|
|
|
trait_path.segments.push(format_ident!("States").into());
|
|
|
|
|
|
|
|
let mut state_mutation_trait_path = base_trait_path.clone();
|
|
|
|
state_mutation_trait_path
|
|
|
|
.segments
|
|
|
|
.push(format_ident!("FreelyMutableState").into());
|
|
|
|
|
|
|
|
let struct_name = &ast.ident;
|
|
|
|
|
|
|
|
quote! {
|
|
|
|
impl #impl_generics #trait_path for #struct_name #ty_generics #where_clause {}
|
|
|
|
|
|
|
|
impl #impl_generics #state_mutation_trait_path for #struct_name #ty_generics #where_clause {
|
|
|
|
}
|
|
|
|
}
|
|
|
|
.into()
|
|
|
|
}
|
|
|
|
|
|
|
|
struct Source {
|
|
|
|
source_type: Path,
|
|
|
|
source_value: Pat,
|
|
|
|
}
|
|
|
|
|
|
|
|
fn parse_sources_attr(ast: &DeriveInput) -> Result<Source> {
|
|
|
|
let mut result = ast
|
|
|
|
.attrs
|
|
|
|
.iter()
|
|
|
|
.filter(|a| a.path().is_ident("source"))
|
|
|
|
.map(|meta| {
|
|
|
|
let mut source = None;
|
|
|
|
let value = meta.parse_nested_meta(|nested| {
|
|
|
|
let source_type = nested.path.clone();
|
|
|
|
let source_value = Pat::parse_multi(nested.value()?)?;
|
|
|
|
source = Some(Source {
|
|
|
|
source_type,
|
|
|
|
source_value,
|
|
|
|
});
|
|
|
|
Ok(())
|
|
|
|
});
|
|
|
|
match source {
|
|
|
|
Some(value) => Ok(value),
|
|
|
|
None => match value {
|
|
|
|
Ok(_) => Err(syn::Error::new(
|
|
|
|
ast.span(),
|
|
|
|
"Couldn't parse SubStates source",
|
|
|
|
)),
|
|
|
|
Err(e) => Err(e),
|
|
|
|
},
|
|
|
|
}
|
|
|
|
})
|
|
|
|
.collect::<Result<Vec<_>>>()?;
|
|
|
|
|
|
|
|
if result.len() > 1 {
|
|
|
|
return Err(syn::Error::new(
|
|
|
|
ast.span(),
|
|
|
|
"Only one source is allowed for SubStates",
|
|
|
|
));
|
|
|
|
}
|
|
|
|
|
|
|
|
let Some(result) = result.pop() else {
|
|
|
|
return Err(syn::Error::new(ast.span(), "SubStates require a source"));
|
|
|
|
};
|
|
|
|
|
|
|
|
Ok(result)
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn derive_substates(input: TokenStream) -> TokenStream {
|
|
|
|
let ast = parse_macro_input!(input as DeriveInput);
|
|
|
|
let sources = parse_sources_attr(&ast).expect("Failed to parse substate sources");
|
|
|
|
|
|
|
|
let generics = ast.generics;
|
|
|
|
let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
|
|
|
|
|
|
|
|
let mut base_trait_path = bevy_state_path();
|
|
|
|
base_trait_path.segments.push(format_ident!("state").into());
|
|
|
|
|
|
|
|
let mut trait_path = base_trait_path.clone();
|
|
|
|
trait_path.segments.push(format_ident!("SubStates").into());
|
|
|
|
|
|
|
|
let mut state_set_trait_path = base_trait_path.clone();
|
|
|
|
state_set_trait_path
|
|
|
|
.segments
|
|
|
|
.push(format_ident!("StateSet").into());
|
|
|
|
|
|
|
|
let mut state_trait_path = base_trait_path.clone();
|
|
|
|
state_trait_path
|
|
|
|
.segments
|
|
|
|
.push(format_ident!("States").into());
|
|
|
|
|
|
|
|
let mut state_mutation_trait_path = base_trait_path.clone();
|
|
|
|
state_mutation_trait_path
|
|
|
|
.segments
|
|
|
|
.push(format_ident!("FreelyMutableState").into());
|
|
|
|
|
|
|
|
let struct_name = &ast.ident;
|
|
|
|
|
|
|
|
let source_state_type = sources.source_type;
|
|
|
|
let source_state_value = sources.source_value;
|
|
|
|
|
|
|
|
let result = quote! {
|
|
|
|
impl #impl_generics #trait_path for #struct_name #ty_generics #where_clause {
|
|
|
|
type SourceStates = #source_state_type;
|
|
|
|
|
|
|
|
fn should_exist(sources: #source_state_type) -> Option<Self> {
|
2024-06-02 13:36:44 +00:00
|
|
|
matches!(sources, #source_state_value).then_some(Self::default())
|
Separate state crate (#13216)
# Objective
Extracts the state mechanisms into a new crate called "bevy_state".
This comes with a few goals:
- state wasn't really an inherent machinery of the ecs system, and so
keeping it within bevy_ecs felt forced
- by mixing it in with bevy_ecs, the maintainability of our more robust
state system was significantly compromised
moving state into a new crate makes it easier to encapsulate as it's own
feature, and easier to read and understand since it's no longer a
single, massive file.
## Solution
move the state-related elements from bevy_ecs to a new crate
## Testing
- Did you test these changes? If so, how? all the automated tests
migrated and passed, ran the pre-existing examples without changes to
validate.
---
## Migration Guide
Since bevy_state is now gated behind the `bevy_state` feature, projects
that use state but don't use the `default-features` will need to add
that feature flag.
Since it is no longer part of bevy_ecs, projects that use bevy_ecs
directly will need to manually pull in `bevy_state`, trigger the
StateTransition schedule, and handle any of the elements that bevy_app
currently sets up.
---------
Co-authored-by: Kristoffer Søholm <k.soeholm@gmail.com>
2024-05-09 18:06:05 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl #impl_generics #state_trait_path for #struct_name #ty_generics #where_clause {
|
|
|
|
const DEPENDENCY_DEPTH : usize = <Self as #trait_path>::SourceStates::SET_DEPENDENCY_DEPTH + 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
impl #impl_generics #state_mutation_trait_path for #struct_name #ty_generics #where_clause {
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
// panic!("Got Result\n{}", result.to_string());
|
|
|
|
|
|
|
|
result.into()
|
|
|
|
}
|