//! The condition expression used in `#[cfg(..)]` attributes. //! //! See: use std::fmt; use intern::Symbol; /// A simple configuration value passed in from the outside. #[derive(Debug, Clone, PartialEq, Eq, Hash)] pub enum CfgAtom { /// eg. `#[cfg(test)]` Flag(Symbol), /// eg. `#[cfg(target_os = "linux")]` /// /// Note that a key can have multiple values that are all considered "active" at the same time. /// For example, `#[cfg(target_feature = "sse")]` and `#[cfg(target_feature = "sse2")]`. KeyValue { key: Symbol, value: Symbol }, } impl PartialOrd for CfgAtom { fn partial_cmp(&self, other: &Self) -> Option { Some(self.cmp(other)) } } impl Ord for CfgAtom { fn cmp(&self, other: &Self) -> std::cmp::Ordering { match (self, other) { (CfgAtom::Flag(a), CfgAtom::Flag(b)) => a.as_str().cmp(b.as_str()), (CfgAtom::Flag(_), CfgAtom::KeyValue { .. }) => std::cmp::Ordering::Less, (CfgAtom::KeyValue { .. }, CfgAtom::Flag(_)) => std::cmp::Ordering::Greater, (CfgAtom::KeyValue { key, value }, CfgAtom::KeyValue { key: key2, value: value2 }) => { key.as_str().cmp(key2.as_str()).then(value.as_str().cmp(value2.as_str())) } } } } impl fmt::Display for CfgAtom { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { CfgAtom::Flag(name) => name.fmt(f), CfgAtom::KeyValue { key, value } => write!(f, "{key} = {value:?}"), } } } #[derive(Debug, Clone, PartialEq, Eq, Hash)] #[cfg_attr(test, derive(arbitrary::Arbitrary))] pub enum CfgExpr { Invalid, Atom(CfgAtom), All(Box<[CfgExpr]>), Any(Box<[CfgExpr]>), Not(Box), } impl fmt::Display for CfgExpr { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { CfgExpr::Atom(atom) => atom.fmt(f), CfgExpr::All(exprs) => { write!(f, "all(")?; for (i, expr) in exprs.iter().enumerate() { if i > 0 { write!(f, ", ")?; } expr.fmt(f)?; } write!(f, ")") } CfgExpr::Any(exprs) => { write!(f, "any(")?; for (i, expr) in exprs.iter().enumerate() { if i > 0 { write!(f, ", ")?; } expr.fmt(f)?; } write!(f, ")") } CfgExpr::Not(expr) => write!(f, "not({})", expr), CfgExpr::Invalid => write!(f, "invalid"), } } } impl From for CfgExpr { fn from(atom: CfgAtom) -> Self { CfgExpr::Atom(atom) } } impl CfgExpr { // FIXME: Parsing from `tt` is only used in a handful of places, reconsider // if we should switch them to AST. #[cfg(feature = "tt")] pub fn parse(tt: &tt::TopSubtree) -> CfgExpr { next_cfg_expr(&mut tt.iter()).unwrap_or(CfgExpr::Invalid) } #[cfg(feature = "tt")] pub fn parse_from_iter(tt: &mut tt::iter::TtIter<'_>) -> CfgExpr { next_cfg_expr(tt).unwrap_or(CfgExpr::Invalid) } #[cfg(feature = "syntax")] pub fn parse_from_ast( ast: &mut std::iter::Peekable, ) -> CfgExpr { next_cfg_expr_from_ast(ast).unwrap_or(CfgExpr::Invalid) } /// Fold the cfg by querying all basic `Atom` and `KeyValue` predicates. pub fn fold(&self, query: &dyn Fn(&CfgAtom) -> bool) -> Option { match self { CfgExpr::Invalid => None, CfgExpr::Atom(atom) => Some(query(atom)), CfgExpr::All(preds) => { preds.iter().try_fold(true, |s, pred| Some(s && pred.fold(query)?)) } CfgExpr::Any(preds) => { preds.iter().try_fold(false, |s, pred| Some(s || pred.fold(query)?)) } CfgExpr::Not(pred) => pred.fold(query).map(|s| !s), } } } #[cfg(feature = "syntax")] fn next_cfg_expr_from_ast( it: &mut std::iter::Peekable, ) -> Option { use intern::sym; use syntax::{NodeOrToken, SyntaxKind, T, ast}; let name = match it.next() { None => return None, Some(NodeOrToken::Token(ident)) if ident.kind().is_any_identifier() => { Symbol::intern(ident.text()) } Some(_) => return Some(CfgExpr::Invalid), }; let ret = match it.peek() { Some(NodeOrToken::Token(eq)) if eq.kind() == T![=] => { it.next(); if let Some(NodeOrToken::Token(literal)) = it.peek() && matches!(literal.kind(), SyntaxKind::STRING) { let dummy_span = span::Span { range: span::TextRange::empty(span::TextSize::new(0)), anchor: span::SpanAnchor { file_id: span::EditionedFileId::from_raw(0), ast_id: span::FIXUP_ERASED_FILE_AST_ID_MARKER, }, ctx: span::SyntaxContext::root(span::Edition::Edition2015), }; let literal = Symbol::intern(tt::token_to_literal(literal.text(), dummy_span).text()); it.next(); CfgAtom::KeyValue { key: name, value: literal.clone() }.into() } else { return Some(CfgExpr::Invalid); } } Some(NodeOrToken::Node(subtree)) => { let mut subtree_iter = ast::TokenTreeChildren::new(subtree).peekable(); it.next(); let mut subs = std::iter::from_fn(|| next_cfg_expr_from_ast(&mut subtree_iter)); match name { s if s == sym::all => CfgExpr::All(subs.collect()), s if s == sym::any => CfgExpr::Any(subs.collect()), s if s == sym::not => { CfgExpr::Not(Box::new(subs.next().unwrap_or(CfgExpr::Invalid))) } _ => CfgExpr::Invalid, } } _ => CfgAtom::Flag(name).into(), }; // Eat comma separator while it.next().is_some_and(|it| it.as_token().is_none_or(|it| it.kind() != T![,])) {} Some(ret) } #[cfg(feature = "tt")] fn next_cfg_expr(it: &mut tt::iter::TtIter<'_>) -> Option { use intern::sym; use tt::iter::TtElement; let name = match it.next() { None => return None, Some(TtElement::Leaf(tt::Leaf::Ident(ident))) => ident.sym.clone(), Some(_) => return Some(CfgExpr::Invalid), }; let mut it_clone = it.clone(); let ret = match it_clone.next() { Some(TtElement::Leaf(tt::Leaf::Punct(punct))) // Don't consume on e.g. `=>`. if punct.char == '=' && (punct.spacing == tt::Spacing::Alone || it_clone.peek().is_none_or(|peek2| { !matches!(peek2, tt::TtElement::Leaf(tt::Leaf::Punct(_))) })) => { match it_clone.next() { Some(tt::TtElement::Leaf(tt::Leaf::Literal(literal))) => { it.next(); it.next(); CfgAtom::KeyValue { key: name, value: Symbol::intern(literal.text()) }.into() } _ => return Some(CfgExpr::Invalid), } } Some(TtElement::Subtree(_, mut sub_it)) => { it.next(); let mut subs = std::iter::from_fn(|| next_cfg_expr(&mut sub_it)); match name { s if s == sym::all => CfgExpr::All(subs.collect()), s if s == sym::any => CfgExpr::Any(subs.collect()), s if s == sym::not => { CfgExpr::Not(Box::new(subs.next().unwrap_or(CfgExpr::Invalid))) } _ => CfgExpr::Invalid, } } _ => CfgAtom::Flag(name).into(), }; // Eat comma separator if let Some(TtElement::Leaf(tt::Leaf::Punct(punct))) = it.peek() && punct.char == ',' { it.next(); } Some(ret) } #[cfg(test)] impl arbitrary::Arbitrary<'_> for CfgAtom { fn arbitrary(u: &mut arbitrary::Unstructured<'_>) -> arbitrary::Result { if u.arbitrary()? { Ok(CfgAtom::Flag(Symbol::intern(<_>::arbitrary(u)?))) } else { Ok(CfgAtom::KeyValue { key: Symbol::intern(<_>::arbitrary(u)?), value: Symbol::intern(<_>::arbitrary(u)?), }) } } }