| //! Conditional compilation stripping. |
| |
| use crate::errors::{ |
| FeatureIncludedInEdition, FeatureNotAllowed, FeatureRemoved, FeatureRemovedReason, InvalidCfg, |
| MalformedFeatureAttribute, MalformedFeatureAttributeHelp, RemoveExprNotSupported, |
| }; |
| use rustc_ast::ptr::P; |
| use rustc_ast::token::{Delimiter, Token, TokenKind}; |
| use rustc_ast::tokenstream::{AttrTokenStream, AttrTokenTree}; |
| use rustc_ast::tokenstream::{DelimSpan, Spacing}; |
| use rustc_ast::tokenstream::{LazyAttrTokenStream, TokenTree}; |
| use rustc_ast::NodeId; |
| use rustc_ast::{self as ast, AttrStyle, Attribute, HasAttrs, HasTokens, MetaItem}; |
| use rustc_attr as attr; |
| use rustc_data_structures::flat_map_in_place::FlatMapInPlace; |
| use rustc_data_structures::fx::FxHashSet; |
| use rustc_feature::Features; |
| use rustc_feature::{ACCEPTED_FEATURES, REMOVED_FEATURES, UNSTABLE_FEATURES}; |
| use rustc_parse::validate_attr; |
| use rustc_session::parse::feature_err; |
| use rustc_session::Session; |
| use rustc_span::edition::ALL_EDITIONS; |
| use rustc_span::symbol::{sym, Symbol}; |
| use rustc_span::Span; |
| use thin_vec::ThinVec; |
| |
| /// A folder that strips out items that do not belong in the current configuration. |
| pub struct StripUnconfigured<'a> { |
| pub sess: &'a Session, |
| pub features: Option<&'a Features>, |
| /// If `true`, perform cfg-stripping on attached tokens. |
| /// This is only used for the input to derive macros, |
| /// which needs eager expansion of `cfg` and `cfg_attr` |
| pub config_tokens: bool, |
| pub lint_node_id: NodeId, |
| } |
| |
| pub fn features(sess: &Session, krate_attrs: &[Attribute], crate_name: Symbol) -> Features { |
| fn feature_list(attr: &Attribute) -> ThinVec<ast::NestedMetaItem> { |
| if attr.has_name(sym::feature) |
| && let Some(list) = attr.meta_item_list() |
| { |
| list |
| } else { |
| ThinVec::new() |
| } |
| } |
| |
| let mut features = Features::default(); |
| |
| // The edition from `--edition`. |
| let crate_edition = sess.edition(); |
| |
| // The maximum of (a) the edition from `--edition` and (b) any edition |
| // umbrella feature-gates declared in the code. |
| // - E.g. if `crate_edition` is 2015 but `rust_2018_preview` is present, |
| // `feature_edition` is 2018 |
| let mut features_edition = crate_edition; |
| for attr in krate_attrs { |
| for mi in feature_list(attr) { |
| if mi.is_word() { |
| let name = mi.name_or_empty(); |
| let edition = ALL_EDITIONS.iter().find(|e| name == e.feature_name()).copied(); |
| if let Some(edition) = edition |
| && edition > features_edition |
| { |
| features_edition = edition; |
| } |
| } |
| } |
| } |
| |
| // Enable edition-dependent features based on `features_edition`. |
| // - E.g. enable `test_2018_feature` if `features_edition` is 2018 or higher |
| let mut edition_enabled_features = FxHashSet::default(); |
| for f in UNSTABLE_FEATURES { |
| if let Some(edition) = f.feature.edition && edition <= features_edition { |
| // FIXME(Manishearth) there is currently no way to set lib features by |
| // edition. |
| edition_enabled_features.insert(f.feature.name); |
| (f.set_enabled)(&mut features); |
| } |
| } |
| |
| // Process all features declared in the code. |
| for attr in krate_attrs { |
| for mi in feature_list(attr) { |
| let name = match mi.ident() { |
| Some(ident) if mi.is_word() => ident.name, |
| Some(ident) => { |
| sess.emit_err(MalformedFeatureAttribute { |
| span: mi.span(), |
| help: MalformedFeatureAttributeHelp::Suggestion { |
| span: mi.span(), |
| suggestion: ident.name, |
| }, |
| }); |
| continue; |
| } |
| None => { |
| sess.emit_err(MalformedFeatureAttribute { |
| span: mi.span(), |
| help: MalformedFeatureAttributeHelp::Label { span: mi.span() }, |
| }); |
| continue; |
| } |
| }; |
| |
| // If the declared feature is an edition umbrella feature-gate, |
| // warn if it was redundant w.r.t. `crate_edition`. |
| // - E.g. warn if `rust_2018_preview` is declared when |
| // `crate_edition` is 2018 |
| // - E.g. don't warn if `rust_2018_preview` is declared when |
| // `crate_edition` is 2015. |
| if let Some(&edition) = ALL_EDITIONS.iter().find(|e| name == e.feature_name()) { |
| if edition <= crate_edition { |
| sess.emit_warning(FeatureIncludedInEdition { |
| span: mi.span(), |
| feature: name, |
| edition, |
| }); |
| } |
| features.set_declared_lang_feature(name, mi.span(), None); |
| continue; |
| } |
| |
| // If the declared feature is edition-dependent and was already |
| // enabled due to `feature_edition`, give a warning. |
| // - E.g. warn if `test_2018_feature` is declared when |
| // `feature_edition` is 2018 or higher. |
| if edition_enabled_features.contains(&name) { |
| sess.emit_warning(FeatureIncludedInEdition { |
| span: mi.span(), |
| feature: name, |
| edition: features_edition, |
| }); |
| features.set_declared_lang_feature(name, mi.span(), None); |
| continue; |
| } |
| |
| // If the declared feature has been removed, issue an error. |
| if let Some(f) = REMOVED_FEATURES.iter().find(|f| name == f.feature.name) { |
| sess.emit_err(FeatureRemoved { |
| span: mi.span(), |
| reason: f.reason.map(|reason| FeatureRemovedReason { reason }), |
| }); |
| continue; |
| } |
| |
| // If the declared feature is stable, record it. |
| if let Some(f) = ACCEPTED_FEATURES.iter().find(|f| name == f.name) { |
| let since = Some(Symbol::intern(f.since)); |
| features.set_declared_lang_feature(name, mi.span(), since); |
| continue; |
| } |
| |
| // If `-Z allow-features` is used and the declared feature is |
| // unstable and not also listed as one of the allowed features, |
| // issue an error. |
| if let Some(allowed) = sess.opts.unstable_opts.allow_features.as_ref() { |
| if allowed.iter().all(|f| name.as_str() != f) { |
| sess.emit_err(FeatureNotAllowed { span: mi.span(), name }); |
| continue; |
| } |
| } |
| |
| // If the declared feature is unstable, record it. |
| if let Some(f) = UNSTABLE_FEATURES.iter().find(|f| name == f.feature.name) { |
| (f.set_enabled)(&mut features); |
| // When the ICE comes from core, alloc or std (approximation of the standard library), there's a chance |
| // that the person hitting the ICE may be using -Zbuild-std or similar with an untested target. |
| // The bug is probably in the standard library and not the compiler in that case, but that doesn't |
| // really matter - we want a bug report. |
| if features.internal(name) |
| && ![sym::core, sym::alloc, sym::std].contains(&crate_name) |
| { |
| sess.using_internal_features.store(true, std::sync::atomic::Ordering::Relaxed); |
| } |
| features.set_declared_lang_feature(name, mi.span(), None); |
| continue; |
| } |
| |
| // Otherwise, the feature is unknown. Record it as a lib feature. |
| // It will be checked later. |
| features.set_declared_lib_feature(name, mi.span()); |
| } |
| } |
| |
| features |
| } |
| |
| pub fn pre_configure_attrs(sess: &Session, attrs: &[Attribute]) -> ast::AttrVec { |
| let strip_unconfigured = StripUnconfigured { |
| sess, |
| features: None, |
| config_tokens: false, |
| lint_node_id: ast::CRATE_NODE_ID, |
| }; |
| attrs |
| .iter() |
| .flat_map(|attr| strip_unconfigured.process_cfg_attr(attr)) |
| .take_while(|attr| !is_cfg(attr) || strip_unconfigured.cfg_true(attr).0) |
| .collect() |
| } |
| |
| #[macro_export] |
| macro_rules! configure { |
| ($this:ident, $node:ident) => { |
| match $this.configure($node) { |
| Some(node) => node, |
| None => return Default::default(), |
| } |
| }; |
| } |
| |
| impl<'a> StripUnconfigured<'a> { |
| pub fn configure<T: HasAttrs + HasTokens>(&self, mut node: T) -> Option<T> { |
| self.process_cfg_attrs(&mut node); |
| self.in_cfg(node.attrs()).then(|| { |
| self.try_configure_tokens(&mut node); |
| node |
| }) |
| } |
| |
| fn try_configure_tokens<T: HasTokens>(&self, node: &mut T) { |
| if self.config_tokens { |
| if let Some(Some(tokens)) = node.tokens_mut() { |
| let attr_stream = tokens.to_attr_token_stream(); |
| *tokens = LazyAttrTokenStream::new(self.configure_tokens(&attr_stream)); |
| } |
| } |
| } |
| |
| /// Performs cfg-expansion on `stream`, producing a new `AttrTokenStream`. |
| /// This is only used during the invocation of `derive` proc-macros, |
| /// which require that we cfg-expand their entire input. |
| /// Normal cfg-expansion operates on parsed AST nodes via the `configure` method |
| fn configure_tokens(&self, stream: &AttrTokenStream) -> AttrTokenStream { |
| fn can_skip(stream: &AttrTokenStream) -> bool { |
| stream.0.iter().all(|tree| match tree { |
| AttrTokenTree::Attributes(_) => false, |
| AttrTokenTree::Token(..) => true, |
| AttrTokenTree::Delimited(_, _, inner) => can_skip(inner), |
| }) |
| } |
| |
| if can_skip(stream) { |
| return stream.clone(); |
| } |
| |
| let trees: Vec<_> = stream |
| .0 |
| .iter() |
| .flat_map(|tree| { |
| match tree.clone() { |
| AttrTokenTree::Attributes(mut data) => { |
| data.attrs.flat_map_in_place(|attr| self.process_cfg_attr(&attr)); |
| |
| if self.in_cfg(&data.attrs) { |
| data.tokens = LazyAttrTokenStream::new( |
| self.configure_tokens(&data.tokens.to_attr_token_stream()), |
| ); |
| Some(AttrTokenTree::Attributes(data)).into_iter() |
| } else { |
| None.into_iter() |
| } |
| } |
| AttrTokenTree::Delimited(sp, delim, mut inner) => { |
| inner = self.configure_tokens(&inner); |
| Some(AttrTokenTree::Delimited(sp, delim, inner)).into_iter() |
| } |
| AttrTokenTree::Token(ref token, _) |
| if let TokenKind::Interpolated(nt) = &token.kind => |
| { |
| panic!("Nonterminal should have been flattened at {:?}: {:?}", token.span, nt); |
| } |
| AttrTokenTree::Token(token, spacing) => { |
| Some(AttrTokenTree::Token(token, spacing)).into_iter() |
| } |
| } |
| }) |
| .collect(); |
| AttrTokenStream::new(trees) |
| } |
| |
| /// Parse and expand all `cfg_attr` attributes into a list of attributes |
| /// that are within each `cfg_attr` that has a true configuration predicate. |
| /// |
| /// Gives compiler warnings if any `cfg_attr` does not contain any |
| /// attributes and is in the original source code. Gives compiler errors if |
| /// the syntax of any `cfg_attr` is incorrect. |
| fn process_cfg_attrs<T: HasAttrs>(&self, node: &mut T) { |
| node.visit_attrs(|attrs| { |
| attrs.flat_map_in_place(|attr| self.process_cfg_attr(&attr)); |
| }); |
| } |
| |
| fn process_cfg_attr(&self, attr: &Attribute) -> Vec<Attribute> { |
| if attr.has_name(sym::cfg_attr) { |
| self.expand_cfg_attr(attr, true) |
| } else { |
| vec![attr.clone()] |
| } |
| } |
| |
| /// Parse and expand a single `cfg_attr` attribute into a list of attributes |
| /// when the configuration predicate is true, or otherwise expand into an |
| /// empty list of attributes. |
| /// |
| /// Gives a compiler warning when the `cfg_attr` contains no attributes and |
| /// is in the original source file. Gives a compiler error if the syntax of |
| /// the attribute is incorrect. |
| pub(crate) fn expand_cfg_attr(&self, attr: &Attribute, recursive: bool) -> Vec<Attribute> { |
| let Some((cfg_predicate, expanded_attrs)) = |
| rustc_parse::parse_cfg_attr(attr, &self.sess.parse_sess) |
| else { |
| return vec![]; |
| }; |
| |
| // Lint on zero attributes in source. |
| if expanded_attrs.is_empty() { |
| self.sess.parse_sess.buffer_lint( |
| rustc_lint_defs::builtin::UNUSED_ATTRIBUTES, |
| attr.span, |
| ast::CRATE_NODE_ID, |
| "`#[cfg_attr]` does not expand to any attributes", |
| ); |
| } |
| |
| if !attr::cfg_matches( |
| &cfg_predicate, |
| &self.sess.parse_sess, |
| self.lint_node_id, |
| self.features, |
| ) { |
| return vec![]; |
| } |
| |
| if recursive { |
| // We call `process_cfg_attr` recursively in case there's a |
| // `cfg_attr` inside of another `cfg_attr`. E.g. |
| // `#[cfg_attr(false, cfg_attr(true, some_attr))]`. |
| expanded_attrs |
| .into_iter() |
| .flat_map(|item| self.process_cfg_attr(&self.expand_cfg_attr_item(attr, item))) |
| .collect() |
| } else { |
| expanded_attrs.into_iter().map(|item| self.expand_cfg_attr_item(attr, item)).collect() |
| } |
| } |
| |
| fn expand_cfg_attr_item( |
| &self, |
| attr: &Attribute, |
| (item, item_span): (ast::AttrItem, Span), |
| ) -> Attribute { |
| let orig_tokens = attr.tokens(); |
| |
| // We are taking an attribute of the form `#[cfg_attr(pred, attr)]` |
| // and producing an attribute of the form `#[attr]`. We |
| // have captured tokens for `attr` itself, but we need to |
| // synthesize tokens for the wrapper `#` and `[]`, which |
| // we do below. |
| |
| // Use the `#` in `#[cfg_attr(pred, attr)]` as the `#` token |
| // for `attr` when we expand it to `#[attr]` |
| let mut orig_trees = orig_tokens.trees(); |
| let TokenTree::Token(pound_token @ Token { kind: TokenKind::Pound, .. }, _) = |
| orig_trees.next().unwrap().clone() |
| else { |
| panic!("Bad tokens for attribute {attr:?}"); |
| }; |
| let pound_span = pound_token.span; |
| |
| let mut trees = vec![AttrTokenTree::Token(pound_token, Spacing::Alone)]; |
| if attr.style == AttrStyle::Inner { |
| // For inner attributes, we do the same thing for the `!` in `#![some_attr]` |
| let TokenTree::Token(bang_token @ Token { kind: TokenKind::Not, .. }, _) = |
| orig_trees.next().unwrap().clone() |
| else { |
| panic!("Bad tokens for attribute {attr:?}"); |
| }; |
| trees.push(AttrTokenTree::Token(bang_token, Spacing::Alone)); |
| } |
| // We don't really have a good span to use for the synthesized `[]` |
| // in `#[attr]`, so just use the span of the `#` token. |
| let bracket_group = AttrTokenTree::Delimited( |
| DelimSpan::from_single(pound_span), |
| Delimiter::Bracket, |
| item.tokens |
| .as_ref() |
| .unwrap_or_else(|| panic!("Missing tokens for {item:?}")) |
| .to_attr_token_stream(), |
| ); |
| trees.push(bracket_group); |
| let tokens = Some(LazyAttrTokenStream::new(AttrTokenStream::new(trees))); |
| let attr = attr::mk_attr_from_item( |
| &self.sess.parse_sess.attr_id_generator, |
| item, |
| tokens, |
| attr.style, |
| item_span, |
| ); |
| if attr.has_name(sym::crate_type) { |
| self.sess.parse_sess.buffer_lint( |
| rustc_lint_defs::builtin::DEPRECATED_CFG_ATTR_CRATE_TYPE_NAME, |
| attr.span, |
| ast::CRATE_NODE_ID, |
| "`crate_type` within an `#![cfg_attr] attribute is deprecated`", |
| ); |
| } |
| if attr.has_name(sym::crate_name) { |
| self.sess.parse_sess.buffer_lint( |
| rustc_lint_defs::builtin::DEPRECATED_CFG_ATTR_CRATE_TYPE_NAME, |
| attr.span, |
| ast::CRATE_NODE_ID, |
| "`crate_name` within an `#![cfg_attr] attribute is deprecated`", |
| ); |
| } |
| attr |
| } |
| |
| /// Determines if a node with the given attributes should be included in this configuration. |
| fn in_cfg(&self, attrs: &[Attribute]) -> bool { |
| attrs.iter().all(|attr| !is_cfg(attr) || self.cfg_true(attr).0) |
| } |
| |
| pub(crate) fn cfg_true(&self, attr: &Attribute) -> (bool, Option<MetaItem>) { |
| let meta_item = match validate_attr::parse_meta(&self.sess.parse_sess, attr) { |
| Ok(meta_item) => meta_item, |
| Err(mut err) => { |
| err.emit(); |
| return (true, None); |
| } |
| }; |
| ( |
| parse_cfg(&meta_item, &self.sess).map_or(true, |meta_item| { |
| attr::cfg_matches( |
| &meta_item, |
| &self.sess.parse_sess, |
| self.lint_node_id, |
| self.features, |
| ) |
| }), |
| Some(meta_item), |
| ) |
| } |
| |
| /// If attributes are not allowed on expressions, emit an error for `attr` |
| #[instrument(level = "trace", skip(self))] |
| pub(crate) fn maybe_emit_expr_attr_err(&self, attr: &Attribute) { |
| if self.features.is_some_and(|features| !features.stmt_expr_attributes) { |
| let mut err = feature_err( |
| &self.sess.parse_sess, |
| sym::stmt_expr_attributes, |
| attr.span, |
| "attributes on expressions are experimental", |
| ); |
| |
| if attr.is_doc_comment() { |
| err.help("`///` is for documentation comments. For a plain comment, use `//`."); |
| } |
| |
| err.emit(); |
| } |
| } |
| |
| #[instrument(level = "trace", skip(self))] |
| pub fn configure_expr(&self, expr: &mut P<ast::Expr>, method_receiver: bool) { |
| if !method_receiver { |
| for attr in expr.attrs.iter() { |
| self.maybe_emit_expr_attr_err(attr); |
| } |
| } |
| |
| // If an expr is valid to cfg away it will have been removed by the |
| // outer stmt or expression folder before descending in here. |
| // Anything else is always required, and thus has to error out |
| // in case of a cfg attr. |
| // |
| // N.B., this is intentionally not part of the visit_expr() function |
| // in order for filter_map_expr() to be able to avoid this check |
| if let Some(attr) = expr.attrs().iter().find(|a| is_cfg(a)) { |
| self.sess.emit_err(RemoveExprNotSupported { span: attr.span }); |
| } |
| |
| self.process_cfg_attrs(expr); |
| self.try_configure_tokens(&mut *expr); |
| } |
| } |
| |
| pub fn parse_cfg<'a>(meta_item: &'a MetaItem, sess: &Session) -> Option<&'a MetaItem> { |
| let span = meta_item.span; |
| match meta_item.meta_item_list() { |
| None => { |
| sess.emit_err(InvalidCfg::NotFollowedByParens { span }); |
| None |
| } |
| Some([]) => { |
| sess.emit_err(InvalidCfg::NoPredicate { span }); |
| None |
| } |
| Some([_, .., l]) => { |
| sess.emit_err(InvalidCfg::MultiplePredicates { span: l.span() }); |
| None |
| } |
| Some([single]) => match single.meta_item() { |
| Some(meta_item) => Some(meta_item), |
| None => { |
| sess.emit_err(InvalidCfg::PredicateLiteral { span: single.span() }); |
| None |
| } |
| }, |
| } |
| } |
| |
| fn is_cfg(attr: &Attribute) -> bool { |
| attr.has_name(sym::cfg) |
| } |