use bevy_utils::all_tuples; use crate::{ schedule::{ condition::{BoxedCondition, Condition}, graph_utils::{Ambiguity, Dependency, DependencyKind, GraphInfo}, set::{BoxedSystemSet, IntoSystemSet, SystemSet}, ScheduleLabel, }, system::{BoxedSystem, IntoSystem, System}, }; fn new_condition(condition: impl Condition) -> BoxedCondition { let condition_system = IntoSystem::into_system(condition); assert!( condition_system.is_send(), "Condition `{}` accesses `NonSend` resources. This is not currently supported.", condition_system.name() ); Box::new(condition_system) } fn ambiguous_with(graph_info: &mut GraphInfo, set: BoxedSystemSet) { match &mut graph_info.ambiguous_with { detection @ Ambiguity::Check => { *detection = Ambiguity::IgnoreWithSet(vec![set]); } Ambiguity::IgnoreWithSet(ambiguous_with) => { ambiguous_with.push(set); } Ambiguity::IgnoreAll => (), } } impl IntoSystemConfigs for F where F: IntoSystem<(), (), Marker>, { fn into_configs(self) -> SystemConfigs { SystemConfigs::new_system(Box::new(IntoSystem::into_system(self))) } } impl IntoSystemConfigs<()> for BoxedSystem<(), ()> { fn into_configs(self) -> SystemConfigs { SystemConfigs::new_system(self) } } pub struct SystemConfig { pub(crate) system: BoxedSystem, pub(crate) graph_info: GraphInfo, pub(crate) conditions: Vec, } /// A collection of [`SystemConfig`]. pub enum SystemConfigs { SystemConfig(SystemConfig), Configs { configs: Vec, collective_conditions: Vec, /// If `true`, adds `before -> after` ordering constraints between the successive elements. chained: bool, }, } impl SystemConfigs { fn new_system(system: BoxedSystem) -> Self { // include system in its default sets let sets = system.default_system_sets().into_iter().collect(); Self::SystemConfig(SystemConfig { system, graph_info: GraphInfo { sets, ..Default::default() }, conditions: Vec::new(), }) } pub(crate) fn in_set_inner(&mut self, set: BoxedSystemSet) { match self { SystemConfigs::SystemConfig(config) => { config.graph_info.sets.push(set); } SystemConfigs::Configs { configs, .. } => { for config in configs { config.in_set_inner(set.dyn_clone()); } } } } fn before_inner(&mut self, set: BoxedSystemSet) { match self { SystemConfigs::SystemConfig(config) => { config .graph_info .dependencies .push(Dependency::new(DependencyKind::Before, set)); } SystemConfigs::Configs { configs, .. } => { for config in configs { config.before_inner(set.dyn_clone()); } } } } fn after_inner(&mut self, set: BoxedSystemSet) { match self { SystemConfigs::SystemConfig(config) => { config .graph_info .dependencies .push(Dependency::new(DependencyKind::After, set)); } SystemConfigs::Configs { configs, .. } => { for config in configs { config.after_inner(set.dyn_clone()); } } } } fn distributive_run_if_inner(&mut self, condition: impl Condition + Clone) { match self { SystemConfigs::SystemConfig(config) => { config.conditions.push(new_condition(condition)); } SystemConfigs::Configs { configs, .. } => { for config in configs { config.distributive_run_if_inner(condition.clone()); } } } } fn ambiguous_with_inner(&mut self, set: BoxedSystemSet) { match self { SystemConfigs::SystemConfig(config) => { ambiguous_with(&mut config.graph_info, set); } SystemConfigs::Configs { configs, .. } => { for config in configs { config.ambiguous_with_inner(set.dyn_clone()); } } } } fn ambiguous_with_all_inner(&mut self) { match self { SystemConfigs::SystemConfig(config) => { config.graph_info.ambiguous_with = Ambiguity::IgnoreAll; } SystemConfigs::Configs { configs, .. } => { for config in configs { config.ambiguous_with_all_inner(); } } } } pub(crate) fn run_if_inner(&mut self, condition: BoxedCondition) { match self { SystemConfigs::SystemConfig(config) => { config.conditions.push(condition); } SystemConfigs::Configs { collective_conditions, .. } => { collective_conditions.push(condition); } } } } /// Types that can convert into a [`SystemConfigs`]. pub trait IntoSystemConfigs where Self: Sized, { /// Convert into a [`SystemConfigs`]. #[doc(hidden)] fn into_configs(self) -> SystemConfigs; /// Add these systems to the provided `set`. #[track_caller] fn in_set(self, set: impl SystemSet) -> SystemConfigs { self.into_configs().in_set(set) } /// Run before all systems in `set`. fn before(self, set: impl IntoSystemSet) -> SystemConfigs { self.into_configs().before(set) } /// Run after all systems in `set`. fn after(self, set: impl IntoSystemSet) -> SystemConfigs { self.into_configs().after(set) } /// Add a run condition to each contained system. /// /// Each system will receive its own clone of the [`Condition`] and will only run /// if the `Condition` is true. /// /// Each individual condition will be evaluated at most once (per schedule run), /// right before the corresponding system prepares to run. /// /// This is equivalent to calling [`run_if`](IntoSystemConfigs::run_if) on each individual /// system, as shown below: /// /// ``` /// # use bevy_ecs::prelude::*; /// # let mut schedule = Schedule::new(); /// # fn a() {} /// # fn b() {} /// # fn condition() -> bool { true } /// schedule.add_systems((a, b).distributive_run_if(condition)); /// schedule.add_systems((a.run_if(condition), b.run_if(condition))); /// ``` /// /// # Note /// /// Because the conditions are evaluated separately for each system, there is no guarantee /// that all evaluations in a single schedule run will yield the same result. If another /// system is run inbetween two evaluations it could cause the result of the condition to change. /// /// Use [`run_if`](IntoSystemSetConfig::run_if) on a [`SystemSet`] if you want to make sure /// that either all or none of the systems are run, or you don't want to evaluate the run /// condition for each contained system separately. fn distributive_run_if(self, condition: impl Condition + Clone) -> SystemConfigs { self.into_configs().distributive_run_if(condition) } /// Run the systems only if the [`Condition`] is `true`. /// /// The `Condition` will be evaluated at most once (per schedule run), /// the first time a system in this set prepares to run. /// /// If this set contains more than one system, calling `run_if` is equivalent to adding each /// system to a common set and configuring the run condition on that set, as shown below: /// /// # Examples /// /// ``` /// # use bevy_ecs::prelude::*; /// # let mut schedule = Schedule::new(); /// # fn a() {} /// # fn b() {} /// # fn condition() -> bool { true } /// # #[derive(SystemSet, Debug, Eq, PartialEq, Hash, Clone, Copy)] /// # struct C; /// schedule.add_systems((a, b).run_if(condition)); /// schedule.add_systems((a, b).in_set(C)).configure_set(C.run_if(condition)); /// ``` /// /// # Note /// /// Because the condition will only be evaluated once, there is no guarantee that the condition /// is upheld after the first system has run. You need to make sure that no other systems that /// could invalidate the condition are scheduled inbetween the first and last run system. /// /// Use [`distributive_run_if`](IntoSystemConfigs::distributive_run_if) if you want the /// condition to be evaluated for each individual system, right before one is run. fn run_if(self, condition: impl Condition) -> SystemConfigs { self.into_configs().run_if(condition) } /// Suppress warnings and errors that would result from these systems having ambiguities /// (conflicting access but indeterminate order) with systems in `set`. fn ambiguous_with(self, set: impl IntoSystemSet) -> SystemConfigs { self.into_configs().ambiguous_with(set) } /// Suppress warnings and errors that would result from these systems having ambiguities /// (conflicting access but indeterminate order) with any other system. fn ambiguous_with_all(self) -> SystemConfigs { self.into_configs().ambiguous_with_all() } /// Treat this collection as a sequence of systems. /// /// Ordering constraints will be applied between the successive elements. fn chain(self) -> SystemConfigs { self.into_configs().chain() } /// This used to add the system to `CoreSchedule::Startup`. /// This was a shorthand for `self.in_schedule(CoreSchedule::Startup)`. /// /// # Panics /// /// Always panics. Please migrate to the new `App::add_systems` with the `Startup` schedule: /// Ex: `app.add_system(foo.on_startup())` -> `app.add_systems(Startup, foo)` #[deprecated( since = "0.11.0", note = "`app.add_system(foo.on_startup())` has been deprecated in favor of `app.add_systems(Startup, foo)`. Please migrate to that API." )] fn on_startup(self) -> SystemConfigs { panic!("`app.add_system(foo.on_startup())` has been deprecated in favor of `app.add_systems(Startup, foo)`. Please migrate to that API."); } /// This used to add the system to the provided `schedule`. /// /// # Panics /// /// Always panics. Please migrate to the new `App::add_systems`: /// Ex: `app.add_system(foo.in_schedule(SomeSchedule))` -> `app.add_systems(SomeSchedule, foo)` #[deprecated( since = "0.11.0", note = "`app.add_system(foo.in_schedule(SomeSchedule))` has been deprecated in favor of `app.add_systems(SomeSchedule, foo)`. Please migrate to that API." )] fn in_schedule(self, _schedule: impl ScheduleLabel) -> SystemConfigs { panic!("`app.add_system(foo.in_schedule(SomeSchedule))` has been deprecated in favor of `app.add_systems(SomeSchedule, foo)`. Please migrate to that API."); } } impl IntoSystemConfigs<()> for SystemConfigs { fn into_configs(self) -> Self { self } #[track_caller] fn in_set(mut self, set: impl SystemSet) -> Self { assert!( set.system_type().is_none(), "adding arbitrary systems to a system type set is not allowed" ); self.in_set_inner(set.dyn_clone()); self } fn before(mut self, set: impl IntoSystemSet) -> Self { let set = set.into_system_set(); self.before_inner(set.dyn_clone()); self } fn after(mut self, set: impl IntoSystemSet) -> Self { let set = set.into_system_set(); self.after_inner(set.dyn_clone()); self } fn distributive_run_if(mut self, condition: impl Condition + Clone) -> SystemConfigs { self.distributive_run_if_inner(condition); self } fn ambiguous_with(mut self, set: impl IntoSystemSet) -> Self { let set = set.into_system_set(); self.ambiguous_with_inner(set.dyn_clone()); self } fn ambiguous_with_all(mut self) -> Self { self.ambiguous_with_all_inner(); self } fn run_if(mut self, condition: impl Condition) -> SystemConfigs { self.run_if_inner(new_condition(condition)); self } fn chain(mut self) -> Self { match &mut self { SystemConfigs::SystemConfig(_) => { /* no op */ } SystemConfigs::Configs { chained, .. } => { *chained = true; } } self } } pub struct SystemConfigTupleMarker; macro_rules! impl_system_collection { ($(($param: ident, $sys: ident)),*) => { impl<$($param, $sys),*> IntoSystemConfigs<(SystemConfigTupleMarker, $($param,)*)> for ($($sys,)*) where $($sys: IntoSystemConfigs<$param>),* { #[allow(non_snake_case)] fn into_configs(self) -> SystemConfigs { let ($($sys,)*) = self; SystemConfigs::Configs { configs: vec![$($sys.into_configs(),)*], collective_conditions: Vec::new(), chained: false, } } } } } all_tuples!(impl_system_collection, 1, 20, P, S); /// A [`SystemSet`] with scheduling metadata. pub struct SystemSetConfig { pub(super) set: BoxedSystemSet, pub(super) graph_info: GraphInfo, pub(super) conditions: Vec, } impl SystemSetConfig { fn new(set: BoxedSystemSet) -> Self { // system type sets are automatically populated // to avoid unintentionally broad changes, they cannot be configured assert!( set.system_type().is_none(), "configuring system type sets is not allowed" ); Self { set, graph_info: GraphInfo::default(), conditions: Vec::new(), } } } /// Types that can be converted into a [`SystemSetConfig`]. /// /// This has been implemented for all types that implement [`SystemSet`] and boxed trait objects. pub trait IntoSystemSetConfig: Sized { /// Convert into a [`SystemSetConfig`]. #[doc(hidden)] fn into_config(self) -> SystemSetConfig; /// Add to the provided `set`. #[track_caller] fn in_set(self, set: impl SystemSet) -> SystemSetConfig { self.into_config().in_set(set) } /// Run before all systems in `set`. fn before(self, set: impl IntoSystemSet) -> SystemSetConfig { self.into_config().before(set) } /// Run after all systems in `set`. fn after(self, set: impl IntoSystemSet) -> SystemSetConfig { self.into_config().after(set) } /// Run the systems in this set only if the [`Condition`] is `true`. /// /// The `Condition` will be evaluated at most once (per schedule run), /// the first time a system in this set prepares to run. fn run_if(self, condition: impl Condition) -> SystemSetConfig { self.into_config().run_if(condition) } /// Suppress warnings and errors that would result from systems in this set having ambiguities /// (conflicting access but indeterminate order) with systems in `set`. fn ambiguous_with(self, set: impl IntoSystemSet) -> SystemSetConfig { self.into_config().ambiguous_with(set) } /// Suppress warnings and errors that would result from systems in this set having ambiguities /// (conflicting access but indeterminate order) with any other system. fn ambiguous_with_all(self) -> SystemSetConfig { self.into_config().ambiguous_with_all() } /// This used to configure the set in the `CoreSchedule::Startup` schedule. /// This was a shorthand for `self.in_schedule(CoreSchedule::Startup)`. /// /// # Panics /// /// Always panics. Please migrate to the new `App::configure_set` with the `Startup` schedule: /// Ex: `app.configure_set(MySet.on_startup())` -> `app.configure_set(Startup, MySet)` #[deprecated( since = "0.11.0", note = "`app.configure_set(MySet.on_startup())` has been deprecated in favor of `app.configure_set(Startup, MySet)`. Please migrate to that API." )] fn on_startup(self) -> SystemSetConfigs { panic!("`app.configure_set(MySet.on_startup())` has been deprecated in favor of `app.configure_set(Startup, MySet)`. Please migrate to that API."); } /// This used to configure the set in the provided `schedule`. /// /// # Panics /// /// Always panics. Please migrate to the new `App::configure_set`: /// Ex: `app.configure_set(MySet.in_schedule(SomeSchedule))` -> `app.configure_set(SomeSchedule, MySet)` #[deprecated( since = "0.11.0", note = "`app.configure_set(MySet.in_schedule(SomeSchedule))` has been deprecated in favor of `app.configure_set(SomeSchedule, MySet)`. Please migrate to that API." )] fn in_schedule(self, _schedule: impl ScheduleLabel) -> SystemSetConfigs { panic!("`app.configure_set(MySet.in_schedule(SomeSchedule))` has been deprecated in favor of `app.configure_set(SomeSchedule, MySet)`. Please migrate to that API."); } } impl IntoSystemSetConfig for S { fn into_config(self) -> SystemSetConfig { SystemSetConfig::new(Box::new(self)) } } impl IntoSystemSetConfig for BoxedSystemSet { fn into_config(self) -> SystemSetConfig { SystemSetConfig::new(self) } } impl IntoSystemSetConfig for SystemSetConfig { fn into_config(self) -> Self { self } #[track_caller] fn in_set(mut self, set: impl SystemSet) -> Self { assert!( set.system_type().is_none(), "adding arbitrary systems to a system type set is not allowed" ); self.graph_info.sets.push(Box::new(set)); self } fn before(mut self, set: impl IntoSystemSet) -> Self { self.graph_info.dependencies.push(Dependency::new( DependencyKind::Before, Box::new(set.into_system_set()), )); self } fn after(mut self, set: impl IntoSystemSet) -> Self { self.graph_info.dependencies.push(Dependency::new( DependencyKind::After, Box::new(set.into_system_set()), )); self } fn run_if(mut self, condition: impl Condition) -> Self { self.conditions.push(new_condition(condition)); self } fn ambiguous_with(mut self, set: impl IntoSystemSet) -> Self { ambiguous_with(&mut self.graph_info, Box::new(set.into_system_set())); self } fn ambiguous_with_all(mut self) -> Self { self.graph_info.ambiguous_with = Ambiguity::IgnoreAll; self } } /// A collection of [`SystemSetConfig`]. pub struct SystemSetConfigs { pub(super) sets: Vec, /// If `true`, adds `before -> after` ordering constraints between the successive elements. pub(super) chained: bool, } /// Types that can convert into a [`SystemSetConfigs`]. pub trait IntoSystemSetConfigs where Self: Sized, { /// Convert into a [`SystemSetConfigs`]. #[doc(hidden)] fn into_configs(self) -> SystemSetConfigs; /// Add these system sets to the provided `set`. #[track_caller] fn in_set(self, set: impl SystemSet) -> SystemSetConfigs { self.into_configs().in_set(set) } /// Run before all systems in `set`. fn before(self, set: impl IntoSystemSet) -> SystemSetConfigs { self.into_configs().before(set) } /// Run after all systems in `set`. fn after(self, set: impl IntoSystemSet) -> SystemSetConfigs { self.into_configs().after(set) } /// Suppress warnings and errors that would result from systems in these sets having ambiguities /// (conflicting access but indeterminate order) with systems in `set`. fn ambiguous_with(self, set: impl IntoSystemSet) -> SystemSetConfigs { self.into_configs().ambiguous_with(set) } /// Suppress warnings and errors that would result from systems in these sets having ambiguities /// (conflicting access but indeterminate order) with any other system. fn ambiguous_with_all(self) -> SystemSetConfigs { self.into_configs().ambiguous_with_all() } /// Treat this collection as a sequence of system sets. /// /// Ordering constraints will be applied between the successive elements. fn chain(self) -> SystemSetConfigs { self.into_configs().chain() } /// This used to configure the sets in the `CoreSchedule::Startup` schedule. /// This was a shorthand for `self.in_schedule(CoreSchedule::Startup)`. /// /// # Panics /// /// Always panics. Please migrate to the new `App::configure_sets` with the `Startup` schedule: /// Ex: `app.configure_sets((A, B).on_startup())` -> `app.configure_sets(Startup, (A, B))` #[deprecated( since = "0.11.0", note = "`app.configure_sets((A, B).on_startup())` has been deprecated in favor of `app.configure_sets(Startup, (A, B))`. Please migrate to that API." )] fn on_startup(self) -> SystemSetConfigs { panic!("`app.configure_sets((A, B).on_startup())` has been deprecated in favor of `app.configure_sets(Startup, (A, B))`. Please migrate to that API."); } /// This used to configure the sets in the provided `schedule`. /// /// # Panics /// /// Always panics. Please migrate to the new `App::configure_set`: /// Ex: `app.configure_sets((A, B).in_schedule(SomeSchedule))` -> `app.configure_sets(SomeSchedule, (A, B))` #[deprecated( since = "0.11.0", note = "`app.configure_sets((A, B).in_schedule(SomeSchedule))` has been deprecated in favor of `app.configure_sets(SomeSchedule, (A, B))`. Please migrate to that API." )] fn in_schedule(self, _schedule: impl ScheduleLabel) -> SystemSetConfigs { panic!("`app.configure_sets((A, B).in_schedule(SomeSchedule))` has been deprecated in favor of `app.configure_sets(SomeSchedule, (A, B))`. Please migrate to that API."); } } impl IntoSystemSetConfigs for SystemSetConfigs { fn into_configs(self) -> Self { self } #[track_caller] fn in_set(mut self, set: impl SystemSet) -> Self { assert!( set.system_type().is_none(), "adding arbitrary systems to a system type set is not allowed" ); for config in &mut self.sets { config.graph_info.sets.push(set.dyn_clone()); } self } fn before(mut self, set: impl IntoSystemSet) -> Self { let set = set.into_system_set(); for config in &mut self.sets { config .graph_info .dependencies .push(Dependency::new(DependencyKind::Before, set.dyn_clone())); } self } fn after(mut self, set: impl IntoSystemSet) -> Self { let set = set.into_system_set(); for config in &mut self.sets { config .graph_info .dependencies .push(Dependency::new(DependencyKind::After, set.dyn_clone())); } self } fn ambiguous_with(mut self, set: impl IntoSystemSet) -> Self { let set = set.into_system_set(); for config in &mut self.sets { ambiguous_with(&mut config.graph_info, set.dyn_clone()); } self } fn ambiguous_with_all(mut self) -> Self { for config in &mut self.sets { config.graph_info.ambiguous_with = Ambiguity::IgnoreAll; } self } fn chain(mut self) -> Self { self.chained = true; self } } macro_rules! impl_system_set_collection { ($($set: ident),*) => { impl<$($set: IntoSystemSetConfig),*> IntoSystemSetConfigs for ($($set,)*) { #[allow(non_snake_case)] fn into_configs(self) -> SystemSetConfigs { let ($($set,)*) = self; SystemSetConfigs { sets: vec![$($set.into_config(),)*], chained: false, } } } } } all_tuples!(impl_system_set_collection, 0, 15, S);