esp_build/

lib.rs

//! Build utilities for esp-hal.

#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/46717278")]

use std::io::Write as _;

use proc_macro::TokenStream;
use quote::ToTokens;
use syn::{LitStr, Token, parse_macro_input, punctuated::Punctuated};
use termcolor::{Color, ColorChoice, ColorSpec, StandardStream, WriteColor};

/// Print a build error and terminate the process.
///
/// It should be noted that the error will be printed BEFORE the main function
/// is called, and as such this should NOT be thought analogous to `println!` or
/// similar utilities.
///
/// ## Example
///
/// ```rust
/// esp_build::error! {"
/// ERROR: something really bad has happened!
/// "}
/// // Process exits with exit code 1
/// ```
#[proc_macro]
pub fn error(input: TokenStream) -> TokenStream {
    do_alert(Color::Red, input);
    panic!("Build failed");
}

/// Print a build warning.
///
/// It should be noted that the warning will be printed BEFORE the main function
/// is called, and as such this should NOT be thought analogous to `println!` or
/// similar utilities.
///
/// ## Example
///
/// ```rust
/// esp_build::warning! {"
/// WARNING: something unpleasant has happened!
/// "};
/// ```
#[proc_macro]
pub fn warning(input: TokenStream) -> TokenStream {
    do_alert(Color::Yellow, input)
}

/// Given some features, assert that **at most** one of the features is enabled.
///
/// ## Example
/// ```rust
/// assert_unique_features!("foo", "bar", "baz");
/// ```
#[proc_macro]
pub fn assert_unique_features(input: TokenStream) -> TokenStream {
    let features = parse_macro_input!(input with Punctuated<LitStr, Token![,]>::parse_terminated)
        .into_iter()
        .collect::<Vec<_>>();

    let unique = impl_unique_features(&features, "exactly zero or one");

    quote::quote! {
        #unique
    }
    .into()
}

/// Given some features, assert that **at least** one of the features is
/// enabled.
///
/// ## Example
/// ```rust
/// assert_used_features!("foo", "bar", "baz");
/// ```
#[proc_macro]
pub fn assert_used_features(input: TokenStream) -> TokenStream {
    let features = parse_macro_input!(input with Punctuated<LitStr, Token![,]>::parse_terminated)
        .into_iter()
        .collect::<Vec<_>>();

    let used = impl_used_features(&features, "at least one");

    quote::quote! {
        #used
    }
    .into()
}

/// Given some features, assert that **exactly** one of the features is enabled.
///
/// ## Example
/// ```rust
/// assert_unique_used_features!("foo", "bar", "baz");
/// ```
#[proc_macro]
pub fn assert_unique_used_features(input: TokenStream) -> TokenStream {
    let features = parse_macro_input!(input with Punctuated<LitStr, Token![,]>::parse_terminated)
        .into_iter()
        .collect::<Vec<_>>();

    let unique = impl_unique_features(&features, "exactly one");
    let used = impl_used_features(&features, "exactly one");

    quote::quote! {
        #unique
        #used
    }
    .into()
}

// ----------------------------------------------------------------------------
// Helper Functions

fn impl_unique_features(features: &[LitStr], expectation: &str) -> impl ToTokens + use<> {
    let pairs = unique_pairs(features);
    let unique_cfgs = pairs
        .iter()
        .map(|(a, b)| quote::quote! { all(feature = #a, feature = #b) });

    let message = format!(
        r#"
ERROR: expected {expectation} enabled feature from feature group:
  {:?}
"#,
        features.iter().map(|lit| lit.value()).collect::<Vec<_>>(),
    );

    quote::quote! {
        #[cfg(any(#(#unique_cfgs),*))]
        ::esp_build::error! { #message }
    }
}

fn impl_used_features(features: &[LitStr], expectation: &str) -> impl ToTokens + use<> {
    let message = format!(
        r#"
ERROR: expected {expectation} enabled feature from feature group:
  {:?}
    "#,
        features.iter().map(|lit| lit.value()).collect::<Vec<_>>()
    );

    quote::quote! {
        #[cfg(not(any(#(feature = #features),*)))]
        ::esp_build::error! { #message }
    }
}

// Adapted from:
// https://github.com/dtolnay/build-alert/blob/49d060e/src/lib.rs#L54-L93
fn do_alert(color: Color, input: TokenStream) -> TokenStream {
    let message = parse_macro_input!(input as LitStr).value();

    let stderr = &mut StandardStream::stderr(ColorChoice::Auto);
    let color_spec = ColorSpec::new().set_fg(Some(color)).clone();

    let mut has_nonspace = false;

    for mut line in message.lines() {
        if !has_nonspace {
            let (maybe_heading, rest) = split_heading(line);

            if let Some(heading) = maybe_heading {
                stderr.set_color(color_spec.clone().set_bold(true)).ok();
                write!(stderr, "\n{heading}").ok();
                has_nonspace = true;
            }

            line = rest;
        }

        if line.is_empty() {
            writeln!(stderr).ok();
        } else {
            stderr.set_color(&color_spec).ok();
            writeln!(stderr, "{line}").ok();

            has_nonspace = has_nonspace || line.contains(|ch: char| ch != ' ');
        }
    }

    stderr.reset().ok();
    writeln!(stderr).ok();

    TokenStream::new()
}

// Adapted from:
// https://github.com/dtolnay/build-alert/blob/49d060e/src/lib.rs#L95-L114
fn split_heading(s: &str) -> (Option<&str>, &str) {
    let mut end = 0;
    while end < s.len() && s[end..].starts_with(|ch: char| ch.is_ascii_uppercase()) {
        end += 1;
    }

    if end >= 3 && (end == s.len() || s[end..].starts_with(':')) {
        let (heading, rest) = s.split_at(end);
        (Some(heading), rest)
    } else {
        (None, s)
    }
}

fn unique_pairs(features: &[LitStr]) -> Vec<(&LitStr, &LitStr)> {
    let mut pairs = Vec::new();

    let mut i = 0;
    let mut j = 0;

    while i < features.len() {
        let a = &features[i];
        let b = &features[j];

        if a.value() != b.value() {
            pairs.push((a, b));
        }

        j += 1;

        if j >= features.len() {
            i += 1;
            j = i;
        }
    }

    pairs
}