Add `IterableEnum` trait by DasLixou · Pull Request #7269 · bevyengine/bevy

DasLixou · 2023-01-18T19:48:55Z

Objective

Required from #7267

Solution

Add required things

Changelog

Add IterableEnum trait and derive
Add EnumIterator iterator

DasLixou · 2023-01-18T19:51:29Z

One thing i want to resolve before this gets merged:
Currently, an enum MUST have only Unit enum fields (so without any values). But @alice-i-cecile said i should try to implement it on bigger bevy_input enums. now, there are some but mostly they'll be like GamepadButtonType and have an ending Other(u32) variant which makes it not possible. Now my question: should i make it possible and then just iterate over the Unit variants?

crates/bevy_utils/macros/Cargo.toml

james7132 · 2023-01-18T19:50:36Z

crates/bevy_utils/macros/Cargo.toml

+[dependencies]
+syn = { version = "1.0", features = ["full", "parsing", "extra-traits"] }
+quote = "1.0"
+bevy_macro_utils = { version = "0.9.0", path = "../../bevy_macro_utils" }


This is really confusing to now have both bevy_macro_utils and bevy_utils_macros.

Already thought about that on discord. But no answer from Alice yet

crates/bevy_utils/src/iterable_enum.rs

crates/bevy_utils/macros/src/lib.rs

james7132 · 2023-01-18T19:54:09Z

crates/bevy_utils/macros/src/iterable_enum.rs

+
+use crate::paths;
+
+pub fn parse_iterable_enum_derive(input: TokenStream) -> TokenStream {


Instead of a get_at, could we not just generate a const SLICE: &[Self] in the trait?

Pretty smart idea. I’ll try

Could we lose the trait altogether and just generate an associated const on the type itself?

james7132 · 2023-01-18T19:54:34Z

crates/bevy_utils/Cargo.toml

 instant = { version = "0.1", features = ["wasm-bindgen"] }
 uuid = { version = "1.1", features = ["v4", "serde"] }
-hashbrown = { version = "0.12", features = ["serde"] }
+hashbrown = { version = "0.12.3", features = ["serde"] }


Suggested change

hashbrown = { version = "0.12.3", features = ["serde"] }

hashbrown = { version = "0.12", features = ["serde"] }

Co-authored-by: James Liu <contact@jamessliu.com>

james7132 · 2023-01-18T19:55:39Z

One thing i want to resolve before this gets merged: Currently, an enum MUST have only Unit enum fields (so without any values). But @alice-i-cecile said i should try to implement it on bigger bevy_input enums. now, there are some but mostly they'll be like GamepadButtonType and have an ending Other(u32) variant which makes it not possible. Now my question: should i make it possible and then just iterate over the Unit variants?

We could add a #[enum(ignore)] for the variants that should be skipped.

Co-authored-by: James Liu <contact@jamessliu.com>

alice-i-cecile · 2023-01-18T19:56:17Z

We could add a #[enum(ignore)] for the variants that should be skipped.

Yes please.

Co-authored-by: James Liu <contact@jamessliu.com>

DasLixou · 2023-01-18T19:57:32Z

We could add a #[enum(ignore)] for the variants that should be skipped.

Yes please.

I’ll try to understand how it works for bundles and then try it 😁

mockersf · 2023-01-18T20:16:46Z

Why not use an existing one? For example https://crates.io/crates/enum-iterator

DasLixou · 2023-01-18T20:20:02Z

Why not use an existing one? For example https://crates.io/crates/enum-iterator

That would be too easy 🤧

DasLixou · 2023-01-18T20:22:43Z

@alice-i-cecile what do you think? enum-iterator really looks... good 🥲

mockersf · 2023-01-18T20:26:37Z

That would be too easy 🤧

Then I'm definitely against this PR, even more so as it adds a new crate

DasLixou · 2023-01-18T20:30:25Z

That would be too easy 🤧

Then I'm definitely against this PR, even more so as it adds a new crate

Should i convert this PR to a import lib and put it in the input enums then?

mockersf · 2023-01-18T20:41:28Z

Should i convert this PR to a import lib and put it in the input enums then?

I don't know, there are no details on why this macro is needed 🤷

DasLixou · 2023-01-18T20:44:28Z

Should i convert this PR to a import lib and put it in the input enums then?

I don't know, there are no details on why this macro is needed 🤷

alice had it on her todos and i asked if i could do it. the macro was planned all the time. but a crate will be better yes. now should i just close the PR or migrate my "code" to the crate?

mockersf · 2023-01-18T20:54:50Z

alice had it on her todos and i asked if i could do it. the macro was planned all the time. but a crate will be better yes. now should i just close the PR or migrate my "code" to the crate?

I must say I don't see the link between stageless schedule and being able to iterate on KeyCodes... so I don't know...

DasLixou · 2023-01-18T20:55:24Z

alice had it on her todos and i asked if i could do it. the macro was planned all the time. but a crate will be better yes. now should i just close the PR or migrate my "code" to the crate?

I must say I don't see the link between stageless schedule and being able to iterate on KeyCodes... so I don't know...

alice just threw it out in the conversation

DasLixou · 2023-01-18T20:59:13Z

Closing in favor of enum-iterator

alice-i-cecile · 2023-01-18T21:24:57Z

Alright, I'm on board. We can use enum-iterator :)

DasLixou added 4 commits January 18, 2023 20:08

Add IterableEnum

329fc46

Add #[derive(IterableEnum)]

5eaeca5

Use BevyManifest

6fcc72b

Implement for KeyCode

8beb9ad

Merge branch 'main' into iterable-enum

31ced3b

james7132 requested changes Jan 18, 2023

View reviewed changes

Update crates/bevy_utils/macros/Cargo.toml

5bf736d

Co-authored-by: James Liu <contact@jamessliu.com>

alice-i-cecile added A-ECS Entities, components, systems, and events A-Utils Utility functions and types C-Feature A new feature, making something new possible labels Jan 18, 2023

Update crates/bevy_utils/src/iterable_enum.rs

e29579c

Co-authored-by: James Liu <contact@jamessliu.com>

Update crates/bevy_utils/macros/src/lib.rs

51d0433

Co-authored-by: James Liu <contact@jamessliu.com>

alice-i-cecile mentioned this pull request Jan 18, 2023

[Merged by Bors] - Migrate engine to Schedule v3 #7267

Closed

33 tasks

DasLixou closed this Jan 18, 2023

DasLixou deleted the iterable-enum branch January 18, 2023 20:59


		use crate::paths;

		pub fn parse_iterable_enum_derive(input: TokenStream) -> TokenStream {

	hashbrown = { version = "0.12.3", features = ["serde"] }
	hashbrown = { version = "0.12", features = ["serde"] }

Uh oh!

Conversation

DasLixou commented Jan 18, 2023

Objective

Solution

Changelog

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

Uh oh!

james7132 Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

DasLixou Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

james7132 Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

DasLixou Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

joseph-gio Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

james7132 Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

james7132 commented Jan 18, 2023

Uh oh!

alice-i-cecile commented Jan 18, 2023

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

mockersf commented Jan 18, 2023

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

mockersf commented Jan 18, 2023

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

mockersf commented Jan 18, 2023

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

mockersf commented Jan 18, 2023

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

DasLixou commented Jan 18, 2023

Uh oh!

alice-i-cecile commented Jan 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants