Skip to content

Commit 02cd944

Browse files
UrgauUrgau
committed
Add support for rustc --check-cfg well known names and values
1 parent 2ac382d commit 02cd944

File tree

7 files changed

+303
-4
lines changed

7 files changed

+303
-4
lines changed

‎src/cargo/core/compiler/context/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,7 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
225225
let mut args = compiler::extern_args(&self, unit, &mut unstable_opts)?;
226226
args.extend(compiler::lto_args(&self, unit));
227227
args.extend(compiler::features_args(&self, unit));
228+
args.extend(compiler::check_cfg_args(&self, unit));
228229

229230
let script_meta = self.find_build_script_metadata(unit);
230231
if let Some(meta) = script_meta {

‎src/cargo/core/compiler/mod.rs

+30-4
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,7 @@ fn rustdoc(cx: &mut Context<'_, '_>, unit: &Unit) -> CargoResult<Work> {
646646

647647
rustdoc.arg("-o").arg(&doc_dir);
648648
rustdoc.args(&features_args(cx, unit));
649+
rustdoc.args(&check_cfg_args(cx, unit));
649650

650651
add_error_format_and_color(cx, &mut rustdoc);
651652
add_allow_features(cx, &mut rustdoc);
@@ -966,6 +967,7 @@ fn build_base_args(
966967
}
967968

968969
cmd.args(&features_args(cx, unit));
970+
cmd.args(&check_cfg_args(cx, unit));
969971

970972
let meta = cx.files().metadata(unit);
971973
cmd.arg("-C").arg(&format!("metadata={}", meta));
@@ -1039,15 +1041,30 @@ fn build_base_args(
10391041
Ok(())
10401042
}
10411043

1042-
/// Features with --cfg and all features with --check-cfg
1043-
fn features_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
1044-
let mut args = Vec::with_capacity(unit.features.len() + 2);
1044+
/// All active features for the unit passed as --cfg
1045+
fn features_args(_cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
1046+
let mut args = Vec::with_capacity(unit.features.len() * 2);
10451047

10461048
for feat in &unit.features {
10471049
args.push(OsString::from("--cfg"));
10481050
args.push(OsString::from(format!("feature=\"{}\"", feat)));
10491051
}
10501052

1053+
args
1054+
}
1055+
1056+
/// Generate the --check-cfg arguments for the unit
1057+
fn check_cfg_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
1058+
if !cx.bcx.config.cli_unstable().check_cfg_features
1059+
&& !cx.bcx.config.cli_unstable().check_cfg_well_known_names
1060+
&& !cx.bcx.config.cli_unstable().check_cfg_well_known_values
1061+
{
1062+
return Vec::new();
1063+
}
1064+
1065+
let mut args = Vec::with_capacity(unit.pkg.summary().features().len() * 2 + 4);
1066+
args.push(OsString::from("-Zunstable-options"));
1067+
10511068
if cx.bcx.config.cli_unstable().check_cfg_features {
10521069
// This generate something like this:
10531070
// - values(feature)
@@ -1060,11 +1077,20 @@ fn features_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
10601077
}
10611078
arg.push(")");
10621079

1063-
args.push(OsString::from("-Zunstable-options"));
10641080
args.push(OsString::from("--check-cfg"));
10651081
args.push(arg);
10661082
}
10671083

1084+
if cx.bcx.config.cli_unstable().check_cfg_well_known_names {
1085+
args.push(OsString::from("--check-cfg"));
1086+
args.push(OsString::from("names()"));
1087+
}
1088+
1089+
if cx.bcx.config.cli_unstable().check_cfg_well_known_values {
1090+
args.push(OsString::from("--check-cfg"));
1091+
args.push(OsString::from("values()"));
1092+
}
1093+
10681094
args
10691095
}
10701096

‎src/cargo/core/features.rs

+4
Original file line numberDiff line numberDiff line change
@@ -639,6 +639,8 @@ unstable_cli_options!(
639639
config_include: bool = ("Enable the `include` key in config files"),
640640
credential_process: bool = ("Add a config setting to fetch registry authentication tokens by calling an external process"),
641641
check_cfg_features: bool = ("Enable compile-time checking of features in `cfg`"),
642+
check_cfg_well_known_names: bool = ("Enable compile-time checking of well known names in `cfg`"),
643+
check_cfg_well_known_values: bool = ("Enable compile-time checking of well known values in `cfg`"),
642644
doctest_in_workspace: bool = ("Compile doctests with paths relative to the workspace root"),
643645
doctest_xcompile: bool = ("Compile and run doctests for non-host target using runner config"),
644646
dual_proc_macros: bool = ("Build proc-macros for both the host and the target"),
@@ -837,6 +839,8 @@ impl CliUnstable {
837839
"advanced-env" => self.advanced_env = parse_empty(k, v)?,
838840
"config-include" => self.config_include = parse_empty(k, v)?,
839841
"check-cfg-features" => self.check_cfg_features = parse_empty(k, v)?,
842+
"check-cfg-well-known-names" => self.check_cfg_well_known_names = parse_empty(k, v)?,
843+
"check-cfg-well-known-values" => self.check_cfg_well_known_values = parse_empty(k, v)?,
840844
"dual-proc-macros" => self.dual_proc_macros = parse_empty(k, v)?,
841845
// can also be set in .cargo/config or with and ENV
842846
"mtime-on-use" => self.mtime_on_use = parse_empty(k, v)?,

‎src/doc/src/reference/unstable.md

+26
Original file line numberDiff line numberDiff line change
@@ -1161,6 +1161,32 @@ For instance:
11611161
cargo check -Z unstable-options -Z check-cfg-features
11621162
```
11631163

1164+
### check-cfg-well-known-names
1165+
1166+
* RFC: [#3013](https://github.com/rust-lang/rfcs/pull/3013)
1167+
1168+
The `-Z check-cfg-well-known-names` argument tells Cargo to activate `rustc` and `rustdoc` unstable
1169+
`--check-cfg` command line as `--check-cfg=names()`.
1170+
This enables compile time checking of well known names in `#[cfg]`, `cfg!` and `#[cfg_attr]`.
1171+
For instance:
1172+
1173+
```
1174+
cargo check -Z unstable-options -Z check-cfg-well-known-names
1175+
```
1176+
1177+
### check-cfg-well-known-values
1178+
1179+
* RFC: [#3013](https://github.com/rust-lang/rfcs/pull/3013)
1180+
1181+
The `-Z check-cfg-well-known-values` argument tells Cargo to activate `rustc` and `rustdoc` unstable
1182+
`--check-cfg` command line as `--check-cfg=values()`.
1183+
This enables compile time checking of well known values in `#[cfg]`, `cfg!` and `#[cfg_attr]`.
1184+
For instance:
1185+
1186+
```
1187+
cargo check -Z unstable-options -Z check-cfg-well-known-values
1188+
```
1189+
11641190
## Stabilized and removed features
11651191

11661192
### Compile progress

‎tests/testsuite/build.rs

+86
Original file line numberDiff line numberDiff line change
@@ -6389,3 +6389,89 @@ fn check_cfg_features_with_namespaced_features() {
63896389
)
63906390
.run();
63916391
}
6392+
6393+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
6394+
#[cargo_test]
6395+
fn check_cfg_well_known_names() {
6396+
if !is_nightly() {
6397+
// --check-cfg is a nightly only rustc command line
6398+
return;
6399+
}
6400+
6401+
let p = project()
6402+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
6403+
.file("src/main.rs", "fn main() {}")
6404+
.build();
6405+
6406+
p.cargo("build -v -Z check-cfg-well-known-names")
6407+
.masquerade_as_nightly_cargo()
6408+
.with_stderr(
6409+
"\
6410+
[COMPILING] foo v0.1.0 [..]
6411+
[RUNNING] `rustc [..] --check-cfg 'names()' [..]
6412+
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
6413+
",
6414+
)
6415+
.run();
6416+
}
6417+
6418+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
6419+
#[cargo_test]
6420+
fn check_cfg_well_known_values() {
6421+
if !is_nightly() {
6422+
// --check-cfg is a nightly only rustc command line
6423+
return;
6424+
}
6425+
6426+
let p = project()
6427+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
6428+
.file("src/main.rs", "fn main() {}")
6429+
.build();
6430+
6431+
p.cargo("build -v -Z check-cfg-well-known-values")
6432+
.masquerade_as_nightly_cargo()
6433+
.with_stderr(
6434+
"\
6435+
[COMPILING] foo v0.1.0 [..]
6436+
[RUNNING] `rustc [..] --check-cfg 'values()' [..]
6437+
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
6438+
",
6439+
)
6440+
.run();
6441+
}
6442+
6443+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
6444+
#[cargo_test]
6445+
fn check_cfg_all() {
6446+
if !is_nightly() {
6447+
// --check-cfg is a nightly only rustc command line
6448+
return;
6449+
}
6450+
6451+
let p = project()
6452+
.file(
6453+
"Cargo.toml",
6454+
r#"
6455+
[project]
6456+
name = "foo"
6457+
version = "0.1.0"
6458+
6459+
[features]
6460+
f_a = []
6461+
f_b = []
6462+
"#,
6463+
)
6464+
.file("src/main.rs", "fn main() {}")
6465+
.build();
6466+
6467+
p.cargo("build -v -Z check-cfg-features -Z check-cfg-well-known-names -Z check-cfg-well-known-values")
6468+
.masquerade_as_nightly_cargo()
6469+
.with_stderr(
6470+
"\
6471+
[COMPILING] foo v0.1.0 [..]
6472+
[RUNNING] `rustc [..] --check-cfg 'values(feature, \"f_a\", \"f_b\")' --check-cfg 'names()' --check-cfg 'values()' [..]
6473+
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
6474+
",
6475+
)
6476+
.run();
6477+
}

‎tests/testsuite/check.rs

+50
Original file line numberDiff line numberDiff line change
@@ -1034,3 +1034,53 @@ fn check_cfg_features() {
10341034
)
10351035
.run();
10361036
}
1037+
1038+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
1039+
#[cargo_test]
1040+
fn check_cfg_well_known_names() {
1041+
if !is_nightly() {
1042+
// --check-cfg is a nightly only rustc command line
1043+
return;
1044+
}
1045+
1046+
let p = project()
1047+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
1048+
.file("src/main.rs", "fn main() {}")
1049+
.build();
1050+
1051+
p.cargo("check -v -Z check-cfg-well-known-names")
1052+
.masquerade_as_nightly_cargo()
1053+
.with_stderr(
1054+
"\
1055+
[CHECKING] foo v0.1.0 [..]
1056+
[RUNNING] `rustc [..] --check-cfg 'names()' [..]
1057+
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
1058+
",
1059+
)
1060+
.run();
1061+
}
1062+
1063+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
1064+
#[cargo_test]
1065+
fn check_cfg_well_known_values() {
1066+
if !is_nightly() {
1067+
// --check-cfg is a nightly only rustc command line
1068+
return;
1069+
}
1070+
1071+
let p = project()
1072+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
1073+
.file("src/main.rs", "fn main() {}")
1074+
.build();
1075+
1076+
p.cargo("check -v -Z check-cfg-well-known-values")
1077+
.masquerade_as_nightly_cargo()
1078+
.with_stderr(
1079+
"\
1080+
[CHECKING] foo v0.1.0 [..]
1081+
[RUNNING] `rustc [..] --check-cfg 'values()' [..]
1082+
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
1083+
",
1084+
)
1085+
.run();
1086+
}

‎tests/testsuite/test.rs

+106
Original file line numberDiff line numberDiff line change
@@ -4575,3 +4575,109 @@ fn check_cfg_features_doc() {
45754575
)
45764576
.run();
45774577
}
4578+
4579+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
4580+
#[cargo_test]
4581+
fn check_cfg_well_known_names() {
4582+
if !is_nightly() {
4583+
// --check-cfg is a nightly only rustc command line
4584+
return;
4585+
}
4586+
4587+
let p = project()
4588+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
4589+
.file("src/main.rs", "fn main() {}")
4590+
.build();
4591+
4592+
p.cargo("test -v -Z check-cfg-well-known-names")
4593+
.masquerade_as_nightly_cargo()
4594+
.with_stderr(
4595+
"\
4596+
[COMPILING] foo v0.1.0 [..]
4597+
[RUNNING] `rustc [..] --check-cfg 'names()' [..]
4598+
[FINISHED] test [unoptimized + debuginfo] target(s) in [..]
4599+
[RUNNING] [..]
4600+
",
4601+
)
4602+
.run();
4603+
}
4604+
4605+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
4606+
#[cargo_test]
4607+
fn check_cfg_well_known_values() {
4608+
if !is_nightly() {
4609+
// --check-cfg is a nightly only rustc command line
4610+
return;
4611+
}
4612+
4613+
let p = project()
4614+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
4615+
.file("src/main.rs", "fn main() {}")
4616+
.build();
4617+
4618+
p.cargo("test -v -Z check-cfg-well-known-values")
4619+
.masquerade_as_nightly_cargo()
4620+
.with_stderr(
4621+
"\
4622+
[COMPILING] foo v0.1.0 [..]
4623+
[RUNNING] `rustc [..] --check-cfg 'values()' [..]
4624+
[FINISHED] test [unoptimized + debuginfo] target(s) in [..]
4625+
[RUNNING] [..]
4626+
",
4627+
)
4628+
.run();
4629+
}
4630+
4631+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
4632+
#[cargo_test]
4633+
fn check_cfg_well_known_names_doc() {
4634+
if !is_nightly() {
4635+
// --check-cfg is a nightly only rustc command line
4636+
return;
4637+
}
4638+
4639+
let p = project()
4640+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
4641+
.file("src/lib.rs", "#[allow(dead_code)] fn foo() {}")
4642+
.build();
4643+
4644+
p.cargo("test -v --doc -Z check-cfg-well-known-names")
4645+
.masquerade_as_nightly_cargo()
4646+
.with_stderr(
4647+
"\
4648+
[COMPILING] foo v0.1.0 [..]
4649+
[RUNNING] `rustc [..] --check-cfg 'names()' [..]
4650+
[FINISHED] test [unoptimized + debuginfo] target(s) in [..]
4651+
[DOCTEST] foo
4652+
[RUNNING] `rustdoc [..] --check-cfg 'names()' [..]
4653+
",
4654+
)
4655+
.run();
4656+
}
4657+
4658+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
4659+
#[cargo_test]
4660+
fn check_cfg_well_known_values_doc() {
4661+
if !is_nightly() {
4662+
// --check-cfg is a nightly only rustc command line
4663+
return;
4664+
}
4665+
4666+
let p = project()
4667+
.file("Cargo.toml", &basic_manifest("foo", "0.1.0"))
4668+
.file("src/lib.rs", "#[allow(dead_code)] fn foo() {}")
4669+
.build();
4670+
4671+
p.cargo("test -v --doc -Z check-cfg-well-known-values")
4672+
.masquerade_as_nightly_cargo()
4673+
.with_stderr(
4674+
"\
4675+
[COMPILING] foo v0.1.0 [..]
4676+
[RUNNING] `rustc [..] --check-cfg 'values()' [..]
4677+
[FINISHED] test [unoptimized + debuginfo] target(s) in [..]
4678+
[DOCTEST] foo
4679+
[RUNNING] `rustdoc [..] --check-cfg 'values()' [..]
4680+
",
4681+
)
4682+
.run();
4683+
}

0 commit comments

Comments
 (0)