From 41dd924d45f88cefc1de700f0bedb530b06167eb Mon Sep 17 00:00:00 2001 From: Urgau Date: Fri, 4 Oct 2024 15:23:06 +0200 Subject: [PATCH] Add support for boolean literals in target cfgs --- crates/cargo-platform/src/cfg.rs | 14 ++++- crates/cargo-platform/src/lib.rs | 1 + src/cargo/core/features.rs | 5 ++ src/cargo/util/context/target.rs | 12 ++++ src/cargo/util/toml/mod.rs | 8 ++- src/doc/src/reference/unstable.md | 24 +++++++ tests/testsuite/cargo/z_help/stdout.term.svg | 66 ++++++++++---------- tests/testsuite/cfg.rs | 41 ++++++++---- 8 files changed, 123 insertions(+), 48 deletions(-) diff --git a/crates/cargo-platform/src/cfg.rs b/crates/cargo-platform/src/cfg.rs index cf7826aa0e98..6f92f236fd8c 100644 --- a/crates/cargo-platform/src/cfg.rs +++ b/crates/cargo-platform/src/cfg.rs @@ -10,6 +10,8 @@ pub enum CfgExpr { All(Vec), Any(Vec), Value(Cfg), + True, + False, } /// A cfg value. @@ -87,6 +89,8 @@ impl CfgExpr { CfgExpr::All(ref e) => e.iter().all(|e| e.matches(cfg)), CfgExpr::Any(ref e) => e.iter().any(|e| e.matches(cfg)), CfgExpr::Value(ref e) => cfg.contains(e), + CfgExpr::True => true, + CfgExpr::False => false, } } @@ -106,7 +110,7 @@ impl CfgExpr { } Ok(()) } - CfgExpr::Value(_) => Ok(()), + CfgExpr::Value(_) | CfgExpr::True | CfgExpr::False => Ok(()), } } @@ -137,6 +141,8 @@ impl fmt::Display for CfgExpr { CfgExpr::All(ref e) => write!(f, "all({})", CommaSep(e)), CfgExpr::Any(ref e) => write!(f, "any({})", CommaSep(e)), CfgExpr::Value(ref e) => write!(f, "{}", e), + CfgExpr::True => write!(f, "true"), + CfgExpr::False => write!(f, "false"), } } } @@ -191,7 +197,11 @@ impl<'a> Parser<'a> { self.eat(&Token::RightParen)?; Ok(CfgExpr::Not(Box::new(e))) } - Some(Ok(..)) => self.cfg().map(CfgExpr::Value), + Some(Ok(..)) => self.cfg().map(|v| match v { + Cfg::Name(n) if n == "true" => CfgExpr::True, + Cfg::Name(n) if n == "false" => CfgExpr::False, + v => CfgExpr::Value(v), + }), Some(Err(..)) => Err(self.t.next().unwrap().err().unwrap()), None => Err(ParseError::new( self.t.orig, diff --git a/crates/cargo-platform/src/lib.rs b/crates/cargo-platform/src/lib.rs index 71e9140bae9c..ba93f7981abf 100644 --- a/crates/cargo-platform/src/lib.rs +++ b/crates/cargo-platform/src/lib.rs @@ -97,6 +97,7 @@ impl Platform { )) }, } + CfgExpr::True | CfgExpr::False => {}, } } diff --git a/src/cargo/core/features.rs b/src/cargo/core/features.rs index 51e26054c53b..1d92800d33ff 100644 --- a/src/cargo/core/features.rs +++ b/src/cargo/core/features.rs @@ -517,6 +517,9 @@ features! { /// Allow paths that resolve relatively to a base specified in the config. (unstable, path_bases, "", "reference/unstable.html#path-bases"), + + /// Allow boolean literals in `[target.'cfg()']` + (unstable, cfg_boolean_literals, "", "reference/unstable.html#cfg-boolean-literals"), } /// Status and metadata for a single unstable feature. @@ -761,6 +764,7 @@ unstable_cli_options!( build_std: Option> = ("Enable Cargo to compile the standard library itself as part of a crate graph compilation"), build_std_features: Option> = ("Configure features enabled for the standard library itself when building the standard library"), cargo_lints: bool = ("Enable the `[lints.cargo]` table"), + cfg_boolean_literals: bool = ("Allow boolean literals in `[target.'cfg()']`"), checksum_freshness: bool = ("Use a checksum to determine if output is fresh rather than filesystem mtime"), codegen_backend: bool = ("Enable the `codegen-backend` option in profiles in .cargo/config.toml file"), config_include: bool = ("Enable the `include` key in config files"), @@ -1258,6 +1262,7 @@ impl CliUnstable { } "build-std-features" => self.build_std_features = Some(parse_features(v)), "cargo-lints" => self.cargo_lints = parse_empty(k, v)?, + "cfg-boolean-literals" => self.cfg_boolean_literals = parse_empty(k, v)?, "codegen-backend" => self.codegen_backend = parse_empty(k, v)?, "config-include" => self.config_include = parse_empty(k, v)?, "direct-minimal-versions" => self.direct_minimal_versions = parse_empty(k, v)?, diff --git a/src/cargo/util/context/target.rs b/src/cargo/util/context/target.rs index f306ecc1731b..dbd5ad622c82 100644 --- a/src/cargo/util/context/target.rs +++ b/src/cargo/util/context/target.rs @@ -1,6 +1,7 @@ use super::{ConfigKey, ConfigRelativePath, GlobalContext, OptValue, PathAndArgs, StringList, CV}; use crate::core::compiler::{BuildOutput, LinkArgTarget}; use crate::util::CargoResult; +use cargo_platform::{CfgExpr, Platform}; use serde::Deserialize; use std::collections::{BTreeMap, HashMap}; use std::path::PathBuf; @@ -53,6 +54,17 @@ pub(super) fn load_target_cfgs( let target: BTreeMap = gctx.get("target")?; tracing::debug!("Got all targets {:#?}", target); for (key, cfg) in target { + // Feature gate `cfg(true)`/`cfg(false)` under `-Zcfg-boolean-literals` + if !gctx.cli_unstable().cfg_boolean_literals { + if let Ok(Platform::Cfg(cfg_expr)) = key.parse() { + cfg_expr.walk_expr(|e| match e { + CfgExpr::True | CfgExpr::False => { + anyhow::bail!("`-Zcfg-boolean-literals` should be used to enable cfg boolean literals in `.cargo/config.toml`") + }, + _ => Ok(()), + })?; + } + } if key.starts_with("cfg(") { // Unfortunately this is not able to display the location of the // unused key. Using config::Value doesn't work. One diff --git a/src/cargo/util/toml/mod.rs b/src/cargo/util/toml/mod.rs index 2c24d9ee3eec..c2e6afecca47 100644 --- a/src/cargo/util/toml/mod.rs +++ b/src/cargo/util/toml/mod.rs @@ -8,7 +8,7 @@ use std::str::{self, FromStr}; use crate::core::summary::MissingDependencyError; use crate::AlreadyPrintedError; use anyhow::{anyhow, bail, Context as _}; -use cargo_platform::Platform; +use cargo_platform::{CfgExpr, Platform}; use cargo_util::paths::{self, normalize_path}; use cargo_util_schemas::manifest::{ self, PackageName, PathBaseName, TomlDependency, TomlDetailedDependency, TomlManifest, @@ -1326,6 +1326,12 @@ pub fn to_real_manifest( for (name, platform) in original_toml.target.iter().flatten() { let platform_kind: Platform = name.parse()?; platform_kind.check_cfg_attributes(warnings); + if let Platform::Cfg(cfg_expr) = &platform_kind { + cfg_expr.walk_expr(|e| match e { + CfgExpr::True | CfgExpr::False => features.require(Feature::cfg_boolean_literals()), + _ => Ok(()), + })?; + } let platform_kind = Some(platform_kind); validate_dependencies( platform.dependencies.as_ref(), diff --git a/src/doc/src/reference/unstable.md b/src/doc/src/reference/unstable.md index 2062e13fe2c2..fa76d9287586 100644 --- a/src/doc/src/reference/unstable.md +++ b/src/doc/src/reference/unstable.md @@ -120,6 +120,7 @@ Each new feature described below should explain how to use it. * [lockfile-path](#lockfile-path) --- Allows to specify a path to lockfile other than the default path `/Cargo.lock`. * [package-workspace](#package-workspace) --- Allows for packaging and publishing multiple crates in a workspace. * [native-completions](#native-completions) --- Move cargo shell completions to native completions. + * [cfg-boolean-literals](#cfg-boolean-literals) --- Allows the use of boolean literals in `[target.'cfg()']` ## allow-features @@ -1745,6 +1746,29 @@ When in doubt, you can discuss this in [#14520](https://github.com/rust-lang/car - powershell: Add `CARGO_COMPLETE=powershell cargo +nightly | Invoke-Expression` to `$PROFILE`. +## cfg-boolean-literals + +* Tracking Issue: [#00000](https://github.com/rust-lang/cargo/issues/00000) + +This feature allows the use of boolean literals in `[target.'cfg()']`. + +Those boolean literals always evaluate to true and false respectively, they are **not** subject +to `RUSTFLAGS`. + +For example, in this example the `b` dependencies is always compiled, while `c` is never: + +```toml +cargo-features = ["cfg-boolean-literals"] + +[target.'cfg(true)'.dependencies] +b = { path = 'b' } + +[target.'cfg(false)'.dependencies] +c = { path = 'c' } +``` + +For cfgs in `.cargo/config.toml`, `-Zcfg-boolean-literals` must be used. + # Stabilized and removed features ## Compile progress diff --git a/tests/testsuite/cargo/z_help/stdout.term.svg b/tests/testsuite/cargo/z_help/stdout.term.svg index 993a456f1e5f..e064db3b8b7c 100644 --- a/tests/testsuite/cargo/z_help/stdout.term.svg +++ b/tests/testsuite/cargo/z_help/stdout.term.svg @@ -1,4 +1,4 @@ - +