-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create cfg aliases for bevy_app
#18170
Draft
hukasu
wants to merge
2
commits into
bevyengine:main
Choose a base branch
from
hukasu:cfg-aliases
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
//! Build script containing cfg aliases | ||
|
||
fn main() { | ||
// Collecting information that will be used to decide which cfg aliases | ||
// will be exported. | ||
// Using `cfg!(target_arch = "wasm32")` and such does not work because | ||
// `build.rs` uses the host architecture and other information, not the target's. | ||
// Cargo then defines environment variables for the information of the target | ||
let windows = std::env::var("CARGO_CFG_WINDOWS").is_ok(); | ||
let unix = std::env::var("CARGO_CFG_UNIX").is_ok(); | ||
|
||
let is_wasm32 = target_architecture("wasm32"); | ||
|
||
let feature_bevy_tasks = feature_present("bevy_tasks"); | ||
let feature_std = feature_present("std"); | ||
|
||
// Prevent warnings on uses of `#[cfg]` | ||
let cfgs = ["can_run_tasks", "std_windows_or_unix"]; | ||
println!("cargo::rustc-check-cfg=cfg({})", cfgs.join(",")); | ||
|
||
// Defining cfg aliases | ||
if !is_wasm32 && feature_bevy_tasks { | ||
println!("cargo::rustc-cfg=can_run_tasks"); | ||
} | ||
if (windows || unix) && feature_std { | ||
println!("cargo::rustc-cfg=std_windows_or_unix"); | ||
} | ||
} | ||
|
||
fn feature_present(feature: &str) -> bool { | ||
// This is very naive and may fail if there is `=`, `\0`, or unicode characters. | ||
let feature_name = format!("CARGO_FEATURE_{}", feature.to_uppercase().replace("-", "_")); | ||
std::env::var(feature_name.as_str()) | ||
.ok() | ||
.filter(|feature| feature == "1") | ||
.is_some() | ||
} | ||
|
||
fn target_architecture(target: &str) -> bool { | ||
std::env::var("CARGO_CFG_TARGET_ARCH") | ||
.ok() | ||
.filter(|arch| arch == target) | ||
.is_some() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The inclusion of a
build.rs
is definitely going to be the controversial component of this PR. Between security and build time concerns, I see this single-handedly being a show-stopper.Personally, I'm not against it, since we have many dependencies that use
cfg_aliases
already (which is effectively what you're doing here by hand). But I think this will be very hard to land.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh,
cfg_aliases
is already being used? i wanted to decrease the contentiousness by a little by not adding a new dependency, but if this is already present, maybe there won't be pushback on that pointThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's already brought in as a
build-dependency
bywinit
andwgpu
, so I wouldn't say it's a controversial inclusion in of itself. It's purely the use of abuild.rs
that I see as being controversial.