1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
//! Implementation of the `build` keyword
use alloc::borrow::ToOwned;
use alloc::sync::Arc;
use alloc::vec::Vec;
use core::fmt::{Display, Formatter, Result};
use core::ops::{Deref, DerefMut};
use crate::util::{add_variable, implement_variables, Indented};
use crate::{implement_rule_variables, Build, Rule};
/// Wrapper for a [`Build`] that configure build edge with a reference
pub struct BuildRef<'a>(pub(crate) &'a mut Build);
impl AsRef<Build> for BuildRef<'_> {
#[inline]
fn as_ref(&self) -> &Build {
self.0
}
}
impl AsMut<Build> for BuildRef<'_> {
#[inline]
fn as_mut(&mut self) -> &mut Build {
self.0
}
}
impl Deref for BuildRef<'_> {
type Target = Build;
#[inline]
fn deref(&self) -> &Self::Target {
self.0
}
}
impl DerefMut for BuildRef<'_> {
#[inline]
fn deref_mut(&mut self) -> &mut Self::Target {
self.0
}
}
macro_rules! implement_build_variables {
($($x:tt)*) => {
/// Implementation for variables that are `build`-specific
/// *(generated with `implement_build_variables` macro)*
impl $($x)* {
/// Specify dynamic dependency file
/// # Example
/// ```rust
/// use ninja_writer::Ninja;
///
/// let mut ninja = Ninja::new();
/// let mut rule = ninja.rule("example", "...");
/// rule.build(["foo"]).dyndep("bar");
///
/// assert_eq!(ninja.to_string(), r###"
/// rule example
/// command = ...
///
/// build foo: example
/// dyndep = bar
/// "###);
/// ```
pub fn dyndep<SDyndep>(mut self, dyndep: SDyndep) -> Self
where
SDyndep: AsRef<str>,
{
add_variable!(self.variables, "dyndep", dyndep);
self
}
/// Add explicit dependencies (inputs)
///
/// # Example
/// ```rust
/// use ninja_writer::Ninja;
///
/// let mut ninja = Ninja::new();
/// let mut rule = ninja.rule("example", "...");
/// rule.build(["foo"]).with(["bar", "baz"]);
///
/// assert_eq!(ninja.to_string(), r###"
/// rule example
/// command = ...
///
/// build foo: example bar baz
/// "###);
pub fn with<SInputIter, SInput>(mut self, inputs: SInputIter) -> Self
where
SInputIter: IntoIterator<Item = SInput>,
SInput: AsRef<str>,
{
self.dependencies.extend(inputs.into_iter().map(|s| s.as_ref().to_owned()));
self
}
/// Add implicit dependencies
///
/// See <https://ninja-build.org/manual.html#ref_dependencies>
///
/// # Example
/// ```rust
/// use ninja_writer::Ninja;
///
/// let mut ninja = Ninja::new();
/// let mut rule = ninja.rule("example", "...");
/// rule.build(["foo"]).with(["bar", "baz"])
/// .with_implicit(["qux"]);
///
/// assert_eq!(ninja.to_string(), r###"
/// rule example
/// command = ...
///
/// build foo: example bar baz | qux
/// "###);
pub fn with_implicit<SInputIter, SInput>(mut self, inputs: SInputIter) -> Self
where
SInputIter: IntoIterator<Item = SInput>,
SInput: AsRef<str>,
{
self.implicit_dependencies.extend(inputs.into_iter().map(|s| s.as_ref().to_owned()));
self
}
/// Add order-only dependencies
///
/// See <https://ninja-build.org/manual.html#ref_dependencies>
///
/// # Example
/// ```rust
/// use ninja_writer::Ninja;
///
/// let mut ninja = Ninja::new();
/// let mut rule = ninja.rule("example", "...");
/// rule.build(["foo"]).with(["bar", "baz"])
/// .with_order_only(["oo"])
/// .with_implicit(["qux"]);
///
/// assert_eq!(ninja.to_string(), r###"
/// rule example
/// command = ...
///
/// build foo: example bar baz | qux || oo
/// "###);
pub fn with_order_only<SInputIter, SInput>(mut self, inputs: SInputIter) -> Self
where
SInputIter: IntoIterator<Item = SInput>,
SInput: AsRef<str>,
{
self.order_only_dependencies.extend(inputs.into_iter().map(|s| s.as_ref().to_owned()));
self
}
/// Add validations
///
/// See <https://ninja-build.org/manual.html#validations>
///
/// # Example
/// ```rust
/// use ninja_writer::Ninja;
///
/// let mut ninja = Ninja::new();
/// let mut rule = ninja.rule("example", "...");
/// rule.build(["foo"]).with(["bar", "baz"])
/// .with_order_only(["oo"])
/// .with_implicit(["qux"])
/// .validations(["quux"]);
///
/// assert_eq!(ninja.to_string(), r###"
/// rule example
/// command = ...
///
/// build foo: example bar baz | qux || oo |@ quux
/// "###);
pub fn validations<SValidationIter, SValidation>(mut self, validations: SValidationIter) -> Self
where
SValidationIter: IntoIterator<Item = SValidation>,
SValidation: AsRef<str>,
{
self.validations.extend(validations.into_iter().map(|s| s.as_ref().to_owned()));
self
}
/// Add validations
///
/// See <https://ninja-build.org/manual.html#validations>
///
/// # Example
/// ```rust
/// use ninja_writer::Ninja;
///
/// let mut ninja = Ninja::new();
/// let mut rule = ninja.rule("example", "...");
/// rule.build(["foo"]).with(["bar", "baz"])
/// .with_order_only(["oo"])
/// .with_implicit(["qux"])
/// .validations(["quux"])
/// .output_implicit(["iii"]);
///
/// assert_eq!(ninja.to_string(), r###"
/// rule example
/// command = ...
///
/// build foo | iii: example bar baz | qux || oo |@ quux
/// "###);
pub fn output_implicit<SOutputIter, SOutput>(mut self, outputs: SOutputIter) -> Self
where
SOutputIter: IntoIterator<Item = SOutput>,
SOutput: AsRef<str>,
{
self.implicit_outputs.extend(outputs.into_iter().map(|s| s.as_ref().to_owned()));
self
}
}
}
}
implement_build_variables!(<'a> BuildRef<'a>);
implement_variables!(<'a> BuildRef<'a>);
implement_rule_variables!(<'a> BuildRef<'a>);
impl Build {
/// Create a new build with the given explicit outputs and rule
pub fn new<SOutputIter, SOutput>(rule: &Rule, outputs: SOutputIter) -> Self
where
SOutputIter: IntoIterator<Item = SOutput>,
SOutput: AsRef<str>,
{
Self {
rule: Arc::clone(&rule.name),
outputs: outputs.into_iter().map(|s| s.as_ref().to_owned()).collect(),
implicit_outputs: Vec::new(),
dependencies: Vec::new(),
implicit_dependencies: Vec::new(),
order_only_dependencies: Vec::new(),
validations: Vec::new(),
variables: Vec::new(),
}
}
}
implement_build_variables!(Build);
implement_variables!(Build);
implement_rule_variables!(Build);
impl Display for Build {
fn fmt(&self, f: &mut Formatter<'_>) -> Result {
write!(f, "build")?;
for output in &self.outputs {
write!(f, " {}", output)?;
}
if !self.implicit_outputs.is_empty() {
write!(f, " |")?;
for output in &self.implicit_outputs {
write!(f, " {}", output)?;
}
}
write!(f, ": {}", self.rule)?;
for input in &self.dependencies {
write!(f, " {}", input)?;
}
if !self.implicit_dependencies.is_empty() {
write!(f, " |")?;
for input in &self.implicit_dependencies {
write!(f, " {}", input)?;
}
}
if !self.order_only_dependencies.is_empty() {
write!(f, " ||")?;
for input in &self.order_only_dependencies {
write!(f, " {}", input)?;
}
}
if !self.validations.is_empty() {
write!(f, " |@")?;
for input in &self.validations {
write!(f, " {}", input)?;
}
}
writeln!(f)?;
for variable in &self.variables {
Indented(variable).fmt(f)?;
writeln!(f)?;
}
Ok(())
}
}