src/libsyntax/config.rs

   1 use attr::HasAttrs;
   2 use feature_gate::{
   3     feature_err,
   4     EXPLAIN_STMT_ATTR_SYNTAX,
   5     Features,
   6     get_features,
   7     GateIssue,
   8 };
   9 use {fold, attr};
  10 use ast;
  11 use source_map::Spanned;
  12 use edition::Edition;
  13 use parse::{token, ParseSess};
  14 use smallvec::SmallVec;
  15 use errors::Applicability;
  16
  17 use ptr::P;
  18
  19 /// A folder that strips out items that do not belong in the current configuration.
  20 pub struct StripUnconfigured<'a> {
  21     pub sess: &'a ParseSess,
  22     pub features: Option<&'a Features>,
  23 }
  24
  25 // `cfg_attr`-process the crate's attributes and compute the crate's features.
  26 pub fn features(mut krate: ast::Crate, sess: &ParseSess, edition: Edition)
  27                 -> (ast::Crate, Features) {
  28     let features;
  29     {
  30         let mut strip_unconfigured = StripUnconfigured {
  31             sess,
  32             features: None,
  33         };
  34
  35         let unconfigured_attrs = krate.attrs.clone();
  36         let err_count = sess.span_diagnostic.err_count();
  37         if let Some(attrs) = strip_unconfigured.configure(krate.attrs) {
  38             krate.attrs = attrs;
  39         } else { // the entire crate is unconfigured
  40             krate.attrs = Vec::new();
  41             krate.module.items = Vec::new();
  42             return (krate, Features::new());
  43         }
  44
  45         features = get_features(&sess.span_diagnostic, &krate.attrs, edition);
  46
  47         // Avoid reconfiguring malformed `cfg_attr`s
  48         if err_count == sess.span_diagnostic.err_count() {
  49             strip_unconfigured.features = Some(&features);
  50             strip_unconfigured.configure(unconfigured_attrs);
  51         }
  52     }
  53
  54     (krate, features)
  55 }
  56
  57 macro_rules! configure {
  58     ($this:ident, $node:ident) => {
  59         match $this.configure($node) {
  60             Some(node) => node,
  61             None => return Default::default(),
  62         }
  63     }
  64 }
  65
  66 impl<'a> StripUnconfigured<'a> {
  67     pub fn configure<T: HasAttrs>(&mut self, node: T) -> Option<T> {
  68         let node = self.process_cfg_attrs(node);
  69         if self.in_cfg(node.attrs()) { Some(node) } else { None }
  70     }
  71
  72     /// Parse and expand all `cfg_attr` attributes into a list of attributes
  73     /// that are within each `cfg_attr` that has a true configuration predicate.
  74     ///
  75     /// Gives compiler warnigns if any `cfg_attr` does not contain any
  76     /// attributes and is in the original source code. Gives compiler errors if
  77     /// the syntax of any `cfg_attr` is incorrect.
  78     pub fn process_cfg_attrs<T: HasAttrs>(&mut self, node: T) -> T {
  79         node.map_attrs(|attrs| {
  80             attrs.into_iter().flat_map(|attr| self.process_cfg_attr(attr)).collect()
  81         })
  82     }
  83
  84     /// Parse and expand a single `cfg_attr` attribute into a list of attributes
  85     /// when the configuration predicate is true, or otherwise expand into an
  86     /// empty list of attributes.
  87     ///
  88     /// Gives a compiler warning when the `cfg_attr` contains no attributes and
  89     /// is in the original source file. Gives a compiler error if the syntax of
  90     /// the attribute is incorrect
  91     fn process_cfg_attr(&mut self, attr: ast::Attribute) -> Vec<ast::Attribute> {
  92         if !attr.check_name("cfg_attr") {
  93             return vec![attr];
  94         }
  95
  96         let (cfg_predicate, expanded_attrs) = match attr.parse(self.sess, |parser| {
  97             parser.expect(&token::OpenDelim(token::Paren))?;
  98
  99             let cfg_predicate = parser.parse_meta_item()?;
 100             parser.expect(&token::Comma)?;
 101
 102             // Presumably, the majority of the time there will only be one attr.
 103             let mut expanded_attrs = Vec::with_capacity(1);
 104
 105             while !parser.check(&token::CloseDelim(token::Paren)) {
 106                 let lo = parser.span.lo();
 107                 let (path, tokens) = parser.parse_meta_item_unrestricted()?;
 108                 expanded_attrs.push((path, tokens, parser.prev_span.with_lo(lo)));
 109                 parser.expect_one_of(&[token::Comma], &[token::CloseDelim(token::Paren)])?;
 110             }
 111
 112             parser.expect(&token::CloseDelim(token::Paren))?;
 113             Ok((cfg_predicate, expanded_attrs))
 114         }) {
 115             Ok(result) => result,
 116             Err(mut e) => {
 117                 e.emit();
 118                 return Vec::new();
 119             }
 120         };
 121
 122         // Check feature gate and lint on zero attributes in source. Even if the feature is gated,
 123         // we still compute as if it wasn't, since the emitted error will stop compilation further
 124         // along the compilation.
 125         if expanded_attrs.len() == 0 {
 126             // FIXME: Emit unused attribute lint here.
 127         }
 128
 129         if attr::cfg_matches(&cfg_predicate, self.sess, self.features) {
 130             // We call `process_cfg_attr` recursively in case there's a
 131             // `cfg_attr` inside of another `cfg_attr`. E.g.
 132             //  `#[cfg_attr(false, cfg_attr(true, some_attr))]`.
 133             expanded_attrs.into_iter()
 134             .flat_map(|(path, tokens, span)| self.process_cfg_attr(ast::Attribute {
 135                 id: attr::mk_attr_id(),
 136                 style: attr.style,
 137                 path,
 138                 tokens,
 139                 is_sugared_doc: false,
 140                 span,
 141             }))
 142             .collect()
 143         } else {
 144             Vec::new()
 145         }
 146     }
 147
 148     /// Determine if a node with the given attributes should be included in this configuration.
 149     pub fn in_cfg(&mut self, attrs: &[ast::Attribute]) -> bool {
 150         attrs.iter().all(|attr| {
 151             if !is_cfg(attr) {
 152                 return true;
 153             }
 154
 155             let error = |span, msg, suggestion: &str| {
 156                 let mut err = self.sess.span_diagnostic.struct_span_err(span, msg);
 157                 if !suggestion.is_empty() {
 158                     err.span_suggestion(
 159                         span,
 160                         "expected syntax is",
 161                         suggestion.into(),
 162                         Applicability::MaybeIncorrect,
 163                     );
 164                 }
 165                 err.emit();
 166                 true
 167             };
 168
 169             let meta_item = match attr.parse_meta(self.sess) {
 170                 Ok(meta_item) => meta_item,
 171                 Err(mut err) => { err.emit(); return true; }
 172             };
 173             let nested_meta_items = if let Some(nested_meta_items) = meta_item.meta_item_list() {
 174                 nested_meta_items
 175             } else {
 176                 return error(meta_item.span, "`cfg` is not followed by parentheses",
 177                                              "cfg(/* predicate */)");
 178             };
 179
 180             if nested_meta_items.is_empty() {
 181                 return error(meta_item.span, "`cfg` predicate is not specified", "");
 182             } else if nested_meta_items.len() > 1 {
 183                 return error(nested_meta_items.last().unwrap().span,
 184                              "multiple `cfg` predicates are specified", "");
 185             }
 186
 187             match nested_meta_items[0].meta_item() {
 188                 Some(meta_item) => attr::cfg_matches(meta_item, self.sess, self.features),
 189                 None => error(nested_meta_items[0].span,
 190                               "`cfg` predicate key cannot be a literal", ""),
 191             }
 192         })
 193     }
 194
 195     /// Visit attributes on expression and statements (but not attributes on items in blocks).
 196     fn visit_expr_attrs(&mut self, attrs: &[ast::Attribute]) {
 197         // flag the offending attributes
 198         for attr in attrs.iter() {
 199             self.maybe_emit_expr_attr_err(attr);
 200         }
 201     }
 202
 203     /// If attributes are not allowed on expressions, emit an error for `attr`
 204     pub fn maybe_emit_expr_attr_err(&self, attr: &ast::Attribute) {
 205         if !self.features.map(|features| features.stmt_expr_attributes).unwrap_or(true) {
 206             let mut err = feature_err(self.sess,
 207                                       "stmt_expr_attributes",
 208                                       attr.span,
 209                                       GateIssue::Language,
 210                                       EXPLAIN_STMT_ATTR_SYNTAX);
 211
 212             if attr.is_sugared_doc {
 213                 err.help("`///` is for documentation comments. For a plain comment, use `//`.");
 214             }
 215
 216             err.emit();
 217         }
 218     }
 219
 220     pub fn configure_foreign_mod(&mut self, foreign_mod: ast::ForeignMod) -> ast::ForeignMod {
 221         ast::ForeignMod {
 222             abi: foreign_mod.abi,
 223             items: foreign_mod.items.into_iter().filter_map(|item| self.configure(item)).collect(),
 224         }
 225     }
 226
 227     fn configure_variant_data(&mut self, vdata: ast::VariantData) -> ast::VariantData {
 228         match vdata {
 229             ast::VariantData::Struct(fields, id) => {
 230                 let fields = fields.into_iter().filter_map(|field| self.configure(field));
 231                 ast::VariantData::Struct(fields.collect(), id)
 232             }
 233             ast::VariantData::Tuple(fields, id) => {
 234                 let fields = fields.into_iter().filter_map(|field| self.configure(field));
 235                 ast::VariantData::Tuple(fields.collect(), id)
 236             }
 237             ast::VariantData::Unit(id) => ast::VariantData::Unit(id)
 238         }
 239     }
 240
 241     pub fn configure_item_kind(&mut self, item: ast::ItemKind) -> ast::ItemKind {
 242         match item {
 243             ast::ItemKind::Struct(def, generics) => {
 244                 ast::ItemKind::Struct(self.configure_variant_data(def), generics)
 245             }
 246             ast::ItemKind::Union(def, generics) => {
 247                 ast::ItemKind::Union(self.configure_variant_data(def), generics)
 248             }
 249             ast::ItemKind::Enum(def, generics) => {
 250                 let variants = def.variants.into_iter().filter_map(|v| {
 251                     self.configure(v).map(|v| {
 252                         Spanned {
 253                             node: ast::Variant_ {
 254                                 ident: v.node.ident,
 255                                 attrs: v.node.attrs,
 256                                 data: self.configure_variant_data(v.node.data),
 257                                 disr_expr: v.node.disr_expr,
 258                             },
 259                             span: v.span
 260                         }
 261                     })
 262                 });
 263                 ast::ItemKind::Enum(ast::EnumDef {
 264                     variants: variants.collect(),
 265                 }, generics)
 266             }
 267             item => item,
 268         }
 269     }
 270
 271     pub fn configure_expr_kind(&mut self, expr_kind: ast::ExprKind) -> ast::ExprKind {
 272         match expr_kind {
 273             ast::ExprKind::Match(m, arms) => {
 274                 let arms = arms.into_iter().filter_map(|a| self.configure(a)).collect();
 275                 ast::ExprKind::Match(m, arms)
 276             }
 277             ast::ExprKind::Struct(path, fields, base) => {
 278                 let fields = fields.into_iter()
 279                     .filter_map(|field| {
 280                         self.configure(field)
 281                     })
 282                     .collect();
 283                 ast::ExprKind::Struct(path, fields, base)
 284             }
 285             _ => expr_kind,
 286         }
 287     }
 288
 289     pub fn configure_expr(&mut self, expr: P<ast::Expr>) -> P<ast::Expr> {
 290         self.visit_expr_attrs(expr.attrs());
 291
 292         // If an expr is valid to cfg away it will have been removed by the
 293         // outer stmt or expression folder before descending in here.
 294         // Anything else is always required, and thus has to error out
 295         // in case of a cfg attr.
 296         //
 297         // N.B., this is intentionally not part of the fold_expr() function
 298         //     in order for fold_opt_expr() to be able to avoid this check
 299         if let Some(attr) = expr.attrs().iter().find(|a| is_cfg(a)) {
 300             let msg = "removing an expression is not supported in this position";
 301             self.sess.span_diagnostic.span_err(attr.span, msg);
 302         }
 303
 304         self.process_cfg_attrs(expr)
 305     }
 306
 307     pub fn configure_stmt(&mut self, stmt: ast::Stmt) -> Option<ast::Stmt> {
 308         self.configure(stmt)
 309     }
 310
 311     pub fn configure_struct_expr_field(&mut self, field: ast::Field) -> Option<ast::Field> {
 312         self.configure(field)
 313     }
 314
 315     pub fn configure_pat(&mut self, pattern: P<ast::Pat>) -> P<ast::Pat> {
 316         pattern.map(|mut pattern| {
 317             if let ast::PatKind::Struct(path, fields, etc) = pattern.node {
 318                 let fields = fields.into_iter()
 319                     .filter_map(|field| {
 320                         self.configure(field)
 321                     })
 322                     .collect();
 323                 pattern.node = ast::PatKind::Struct(path, fields, etc);
 324             }
 325             pattern
 326         })
 327     }
 328
 329     // deny #[cfg] on generic parameters until we decide what to do with it.
 330     // see issue #51279.
 331     pub fn disallow_cfg_on_generic_param(&mut self, param: &ast::GenericParam) {
 332         for attr in param.attrs() {
 333             let offending_attr = if attr.check_name("cfg") {
 334                 "cfg"
 335             } else if attr.check_name("cfg_attr") {
 336                 "cfg_attr"
 337             } else {
 338                 continue;
 339             };
 340             let msg = format!("#[{}] cannot be applied on a generic parameter", offending_attr);
 341             self.sess.span_diagnostic.span_err(attr.span, &msg);
 342         }
 343     }
 344 }
 345
 346 impl<'a> fold::Folder for StripUnconfigured<'a> {
 347     fn fold_foreign_mod(&mut self, foreign_mod: ast::ForeignMod) -> ast::ForeignMod {
 348         let foreign_mod = self.configure_foreign_mod(foreign_mod);
 349         fold::noop_fold_foreign_mod(foreign_mod, self)
 350     }
 351
 352     fn fold_item_kind(&mut self, item: ast::ItemKind) -> ast::ItemKind {
 353         let item = self.configure_item_kind(item);
 354         fold::noop_fold_item_kind(item, self)
 355     }
 356
 357     fn fold_expr(&mut self, expr: P<ast::Expr>) -> P<ast::Expr> {
 358         let mut expr = self.configure_expr(expr).into_inner();
 359         expr.node = self.configure_expr_kind(expr.node);
 360         P(fold::noop_fold_expr(expr, self))
 361     }
 362
 363     fn fold_opt_expr(&mut self, expr: P<ast::Expr>) -> Option<P<ast::Expr>> {
 364         let mut expr = configure!(self, expr).into_inner();
 365         expr.node = self.configure_expr_kind(expr.node);
 366         Some(P(fold::noop_fold_expr(expr, self)))
 367     }
 368
 369     fn fold_stmt(&mut self, stmt: ast::Stmt) -> SmallVec<[ast::Stmt; 1]> {
 370         match self.configure_stmt(stmt) {
 371             Some(stmt) => fold::noop_fold_stmt(stmt, self),
 372             None => return SmallVec::new(),
 373         }
 374     }
 375
 376     fn fold_item(&mut self, item: P<ast::Item>) -> SmallVec<[P<ast::Item>; 1]> {
 377         fold::noop_fold_item(configure!(self, item), self)
 378     }
 379
 380     fn fold_impl_item(&mut self, item: ast::ImplItem) -> SmallVec<[ast::ImplItem; 1]>
 381     {
 382         fold::noop_fold_impl_item(configure!(self, item), self)
 383     }
 384
 385     fn fold_trait_item(&mut self, item: ast::TraitItem) -> SmallVec<[ast::TraitItem; 1]> {
 386         fold::noop_fold_trait_item(configure!(self, item), self)
 387     }
 388
 389     fn fold_mac(&mut self, mac: ast::Mac) -> ast::Mac {
 390         // Don't configure interpolated AST (cf. issue #34171).
 391         // Interpolated AST will get configured once the surrounding tokens are parsed.
 392         mac
 393     }
 394
 395     fn fold_pat(&mut self, pattern: P<ast::Pat>) -> P<ast::Pat> {
 396         fold::noop_fold_pat(self.configure_pat(pattern), self)
 397     }
 398 }
 399
 400 fn is_cfg(attr: &ast::Attribute) -> bool {
 401     attr.check_name("cfg")
 402 }