diff --git a/crates/bevy_app/Cargo.toml b/crates/bevy_app/Cargo.toml index f46db94db36bc..7d9c257480c20 100644 --- a/crates/bevy_app/Cargo.toml +++ b/crates/bevy_app/Cargo.toml @@ -82,6 +82,7 @@ bevy_utils = { path = "../bevy_utils", version = "0.16.0-dev", default-features ] } bevy_tasks = { path = "../bevy_tasks", version = "0.16.0-dev", default-features = false } bevy_platform = { path = "../bevy_platform", version = "0.16.0-dev", default-features = false } +bevy_label = { path = "../bevy_label", version = "0.16.0-dev", default-features = false } # other downcast-rs = { version = "2", default-features = false } diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs index 81d7baeb4b520..68cae667b7a9e 100644 --- a/crates/bevy_app/src/app.rs +++ b/crates/bevy_app/src/app.rs @@ -12,7 +12,6 @@ use bevy_ecs::{ component::RequiredComponentsError, error::{DefaultErrorHandler, ErrorHandler}, event::{event_update_system, EventCursor}, - intern::Interned, prelude::*, schedule::{InternedSystemSet, ScheduleBuildSettings, ScheduleLabel}, system::{IntoObserverSystem, ScheduleSystem, SystemId, SystemInput}, @@ -30,7 +29,10 @@ use std::{ process::{ExitCode, Termination}, }; -bevy_ecs::define_label!( +use bevy_label::intern::Interned; +pub use bevy_label::DynEq; + +bevy_label::define_label!( /// A strongly-typed class of labels used to identify an [`App`]. #[diagnostic::on_unimplemented( note = "consider annotating `{Self}` with `#[derive(AppLabel)]`" @@ -39,8 +41,6 @@ bevy_ecs::define_label!( APP_LABEL_INTERNER ); -pub use bevy_ecs::label::DynEq; - /// A shorthand for `Interned`. pub type InternedAppLabel = Interned; diff --git a/crates/bevy_ecs/Cargo.toml b/crates/bevy_ecs/Cargo.toml index 28987f1413449..7ce22c79ec978 100644 --- a/crates/bevy_ecs/Cargo.toml +++ b/crates/bevy_ecs/Cargo.toml @@ -101,6 +101,7 @@ bevy_ecs_macros = { path = "macros", version = "0.16.0-dev" } bevy_platform = { path = "../bevy_platform", version = "0.16.0-dev", default-features = false, features = [ "alloc", ] } +bevy_label = { path = "../bevy_label", version = "0.16.0-dev", default-features = false } bitflags = { version = "2.3", default-features = false } disqualified = { version = "1.0", default-features = false } diff --git a/crates/bevy_ecs/src/lib.rs b/crates/bevy_ecs/src/lib.rs index 0a2e1862ddbf1..8b50070e8eedd 100644 --- a/crates/bevy_ecs/src/lib.rs +++ b/crates/bevy_ecs/src/lib.rs @@ -39,8 +39,6 @@ pub mod entity_disabling; pub mod error; pub mod event; pub mod hierarchy; -pub mod intern; -pub mod label; pub mod name; pub mod never; pub mod observer; diff --git a/crates/bevy_ecs/src/schedule/set.rs b/crates/bevy_ecs/src/schedule/set.rs index 896c7ed050ecc..112c3faa42dcc 100644 --- a/crates/bevy_ecs/src/schedule/set.rs +++ b/crates/bevy_ecs/src/schedule/set.rs @@ -6,18 +6,16 @@ use core::{ marker::PhantomData, }; -pub use crate::label::DynEq; pub use bevy_ecs_macros::{ScheduleLabel, SystemSet}; -use crate::{ - define_label, - intern::Interned, - system::{ - ExclusiveFunctionSystem, ExclusiveSystemParamFunction, FunctionSystem, - IsExclusiveFunctionSystem, IsFunctionSystem, SystemParamFunction, - }, +use crate::system::{ + ExclusiveFunctionSystem, ExclusiveSystemParamFunction, FunctionSystem, + IsExclusiveFunctionSystem, IsFunctionSystem, SystemParamFunction, }; +pub use bevy_label::DynEq; +use bevy_label::{define_label, intern::Interned}; + define_label!( /// A strongly-typed class of labels used to identify a [`Schedule`](crate::schedule::Schedule). #[diagnostic::on_unimplemented( diff --git a/crates/bevy_label/Cargo.toml b/crates/bevy_label/Cargo.toml new file mode 100644 index 0000000000000..2bfa063f1f872 --- /dev/null +++ b/crates/bevy_label/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name = "bevy_label" +version = "0.16.0-dev" +edition = "2024" +description = "Bevy Engine's labeling traits" +homepage = "https://bevyengine.org" +repository = "https://github.com/bevyengine/bevy" +license = "MIT OR Apache-2.0" +keywords = ["bevy"] +categories = [] +rust-version = "1.85.0" + +[dependencies] +bevy_platform = { path = "../bevy_platform", version = "0.16.0-dev", default-features = false, features = [ + "alloc", +] } + +[lints] +workspace = true + +[package.metadata.docs.rs] +rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"] +all-features = true diff --git a/crates/bevy_label/LICENSE-APACHE b/crates/bevy_label/LICENSE-APACHE new file mode 100644 index 0000000000000..d9a10c0d8e868 --- /dev/null +++ b/crates/bevy_label/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/crates/bevy_label/LICENSE-MIT b/crates/bevy_label/LICENSE-MIT new file mode 100644 index 0000000000000..9cf106272ac3b --- /dev/null +++ b/crates/bevy_label/LICENSE-MIT @@ -0,0 +1,19 @@ +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/crates/bevy_label/README.md b/crates/bevy_label/README.md new file mode 100644 index 0000000000000..498981aee4d46 --- /dev/null +++ b/crates/bevy_label/README.md @@ -0,0 +1,7 @@ +# Bevy Label + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_ecs.svg)](https://crates.io/crates/bevy_ecs) +[![Downloads](https://img.shields.io/crates/d/bevy_ecs.svg)](https://crates.io/crates/bevy_ecs) +[![Docs](https://docs.rs/bevy_ecs/badge.svg)](https://docs.rs/bevy_ecs/latest/bevy_ecs/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_ecs/src/intern.rs b/crates/bevy_label/src/intern.rs similarity index 99% rename from crates/bevy_ecs/src/intern.rs rename to crates/bevy_label/src/intern.rs index b10e6a2ac691b..d1d11735648dc 100644 --- a/crates/bevy_ecs/src/intern.rs +++ b/crates/bevy_label/src/intern.rs @@ -24,7 +24,7 @@ use core::{fmt::Debug, hash::Hash, ops::Deref}; /// the same [`Interner`] instance. // NOTE: This type must NEVER implement Borrow since it does not obey that trait's invariants. /// ``` -/// # use bevy_ecs::intern::*; +/// # use bevy_label::intern::*; /// #[derive(PartialEq, Eq, Hash, Debug)] /// struct Value(i32); /// impl Internable for Value { diff --git a/crates/bevy_ecs/src/label.rs b/crates/bevy_label/src/lib.rs similarity index 93% rename from crates/bevy_ecs/src/label.rs rename to crates/bevy_label/src/lib.rs index c404c563bdbec..0f3cbc0101e25 100644 --- a/crates/bevy_ecs/src/label.rs +++ b/crates/bevy_label/src/lib.rs @@ -1,5 +1,11 @@ //! Traits used by label implementations +#![no_std] + +pub mod intern; + +extern crate alloc; + use core::{ any::Any, hash::{Hash, Hasher}, @@ -73,7 +79,7 @@ where /// # Example /// /// ``` -/// # use bevy_ecs::define_label; +/// # use bevy_label::define_label; /// define_label!( /// /// Documentation of label trait /// MyNewLabelTrait, @@ -127,10 +133,10 @@ macro_rules! define_label { /// Clones this ` #[doc = stringify!($label_trait_name)] ///`. - fn dyn_clone(&self) -> $crate::label::Box; + fn dyn_clone(&self) -> $crate::Box; /// Casts this value to a form where it can be compared with other type-erased values. - fn as_dyn_eq(&self) -> &dyn $crate::label::DynEq; + fn as_dyn_eq(&self) -> &dyn $crate::DynEq; /// Feeds this value into the given [`Hasher`]. fn dyn_hash(&self, state: &mut dyn ::core::hash::Hasher); @@ -147,12 +153,12 @@ macro_rules! define_label { $($interned_extra_methods_impl)* - fn dyn_clone(&self) -> $crate::label::Box { + fn dyn_clone(&self) -> $crate::Box { (**self).dyn_clone() } /// Casts this value to a form where it can be compared with other type-erased values. - fn as_dyn_eq(&self) -> &dyn $crate::label::DynEq { + fn as_dyn_eq(&self) -> &dyn $crate::DynEq { (**self).as_dyn_eq() } @@ -181,7 +187,7 @@ macro_rules! define_label { impl $crate::intern::Internable for dyn $label_trait_name { fn leak(&self) -> &'static Self { - $crate::label::Box::leak(self.dyn_clone()) + $crate::Box::leak(self.dyn_clone()) } fn ref_eq(&self, other: &Self) -> bool { diff --git a/crates/bevy_render/Cargo.toml b/crates/bevy_render/Cargo.toml index aa6b6e239cbfd..dfb966068da26 100644 --- a/crates/bevy_render/Cargo.toml +++ b/crates/bevy_render/Cargo.toml @@ -59,6 +59,7 @@ bevy_derive = { path = "../bevy_derive", version = "0.16.0-dev" } bevy_diagnostic = { path = "../bevy_diagnostic", version = "0.16.0-dev" } bevy_ecs = { path = "../bevy_ecs", version = "0.16.0-dev" } bevy_encase_derive = { path = "../bevy_encase_derive", version = "0.16.0-dev" } +bevy_label = { path = "../bevy_label", version = "0.16.0-dev" } bevy_math = { path = "../bevy_math", version = "0.16.0-dev" } bevy_reflect = { path = "../bevy_reflect", version = "0.16.0-dev" } bevy_render_macros = { path = "macros", version = "0.16.0-dev" } diff --git a/crates/bevy_render/src/render_graph/context.rs b/crates/bevy_render/src/render_graph/context.rs index 4c6ecd30c1d67..e3bb881d86aa4 100644 --- a/crates/bevy_render/src/render_graph/context.rs +++ b/crates/bevy_render/src/render_graph/context.rs @@ -3,7 +3,8 @@ use crate::{ render_resource::{Buffer, Sampler, TextureView}, }; use alloc::borrow::Cow; -use bevy_ecs::{entity::Entity, intern::Interned}; +use bevy_ecs::entity::Entity; +use bevy_label::intern::Interned; use thiserror::Error; use super::{InternedRenderSubGraph, RenderLabel, RenderSubGraph}; diff --git a/crates/bevy_render/src/render_graph/graph.rs b/crates/bevy_render/src/render_graph/graph.rs index d1a7020bcfcab..dbb156b6720b9 100644 --- a/crates/bevy_render/src/render_graph/graph.rs +++ b/crates/bevy_render/src/render_graph/graph.rs @@ -5,7 +5,8 @@ use crate::{ }, renderer::RenderContext, }; -use bevy_ecs::{define_label, intern::Interned, prelude::World, resource::Resource}; +use bevy_ecs::{prelude::World, resource::Resource}; +use bevy_label::{define_label, intern::Interned}; use bevy_platform::collections::HashMap; use core::fmt::Debug; diff --git a/crates/bevy_render/src/render_graph/node.rs b/crates/bevy_render/src/render_graph/node.rs index 0a634c2598461..5d936d446c8b0 100644 --- a/crates/bevy_render/src/render_graph/node.rs +++ b/crates/bevy_render/src/render_graph/node.rs @@ -6,13 +6,13 @@ use crate::{ render_phase::DrawError, renderer::RenderContext, }; -pub use bevy_ecs::label::DynEq; use bevy_ecs::{ - define_label, - intern::Interned, query::{QueryItem, QueryState, ReadOnlyQueryData}, world::{FromWorld, World}, }; +pub use bevy_label::DynEq; +use bevy_label::{define_label, intern::Interned}; + use core::fmt::Debug; use downcast_rs::{impl_downcast, Downcast}; use thiserror::Error;