feature_gate.rs 31.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Feature gating
//!
L
Luke Gallagher 已提交
13
//! This module implements the gating necessary for preventing certain compiler
14 15 16 17 18
//! features from being used by default. This module will crawl a pre-expanded
//! AST to ensure that there are no features which are used that are not
//! enabled.
//!
//! Features are enabled in programs via the crate-level attributes of
19
//! `#![feature(...)]` with a comma-separated list of features.
B
Brian Anderson 已提交
20 21 22 23
//!
//! For the purpose of future feature-tracking, once code for detection of feature
//! gate usage is added, *do not remove it again* even once the feature
//! becomes stable.
G
GuillaumeGomez 已提交
24

S
Steven Fackler 已提交
25
use self::Status::*;
26
use self::AttributeType::*;
27

N
Niko Matsakis 已提交
28
use abi::Abi;
N
Nick Cameron 已提交
29 30 31 32
use ast::NodeId;
use ast;
use attr;
use attr::AttrMetaMethods;
C
Corey Richardson 已提交
33
use codemap::{CodeMap, Span};
N
Nick Cameron 已提交
34 35 36
use diagnostic::SpanHandler;
use visit;
use visit::Visitor;
37
use parse::token::{self, InternedString};
38

39 40
use std::ascii::AsciiExt;

B
Brian Anderson 已提交
41 42 43 44 45 46 47
// If you change this list without updating src/doc/reference.md, @cmr will be sad
// Don't ever remove anything from this list; set them to 'Removed'.
// The version numbers here correspond to the version in which the current status
// was set. This is most important for knowing when a particular feature became
// stable (active).
// NB: The featureck.py script parses this information directly out of the source
// so take care when modifying it.
48
const KNOWN_FEATURES: &'static [(&'static str, &'static str, Status)] = &[
B
Brian Anderson 已提交
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
    ("globs", "1.0.0", Accepted),
    ("macro_rules", "1.0.0", Accepted),
    ("struct_variant", "1.0.0", Accepted),
    ("asm", "1.0.0", Active),
    ("managed_boxes", "1.0.0", Removed),
    ("non_ascii_idents", "1.0.0", Active),
    ("thread_local", "1.0.0", Active),
    ("link_args", "1.0.0", Active),
    ("plugin_registrar", "1.0.0", Active),
    ("log_syntax", "1.0.0", Active),
    ("trace_macros", "1.0.0", Active),
    ("concat_idents", "1.0.0", Active),
    ("intrinsics", "1.0.0", Active),
    ("lang_items", "1.0.0", Active),

    ("simd", "1.0.0", Active),
    ("default_type_params", "1.0.0", Accepted),
    ("quote", "1.0.0", Active),
    ("link_llvm_intrinsics", "1.0.0", Active),
    ("linkage", "1.0.0", Active),
    ("struct_inherit", "1.0.0", Removed),

    ("quad_precision_float", "1.0.0", Removed),

    ("rustc_diagnostic_macros", "1.0.0", Active),
    ("unboxed_closures", "1.0.0", Active),
75
    ("reflect", "1.0.0", Active),
76
    ("import_shadowing", "1.0.0", Removed),
B
Brian Anderson 已提交
77 78 79 80
    ("advanced_slice_patterns", "1.0.0", Active),
    ("tuple_indexing", "1.0.0", Accepted),
    ("associated_types", "1.0.0", Accepted),
    ("visible_private_types", "1.0.0", Active),
81
    ("slicing_syntax", "1.0.0", Accepted),
B
Brian Anderson 已提交
82 83 84
    ("box_syntax", "1.0.0", Active),
    ("on_unimplemented", "1.0.0", Active),
    ("simd_ffi", "1.0.0", Active),
85
    ("allocator", "1.0.0", Active),
B
Brian Anderson 已提交
86 87 88 89 90 91 92

    ("if_let", "1.0.0", Accepted),
    ("while_let", "1.0.0", Accepted),

    ("plugin", "1.0.0", Active),
    ("start", "1.0.0", Active),
    ("main", "1.0.0", Active),
93

94 95
    ("fundamental", "1.0.0", Active),

96 97
    // A temporary feature gate used to enable parser extensions needed
    // to bootstrap fix for #5723.
B
Brian Anderson 已提交
98
    ("issue_5723_bootstrap", "1.0.0", Accepted),
99

100
    // A way to temporarily opt out of opt in copy. This will *never* be accepted.
B
Brian Anderson 已提交
101
    ("opt_out_copy", "1.0.0", Removed),
102

103
    // OIBIT specific features
B
Brian Anderson 已提交
104
    ("optin_builtin_traits", "1.0.0", Active),
105

J
Joseph Crail 已提交
106
    // macro reexport needs more discussion and stabilization
A
Alex Crichton 已提交
107
    ("macro_reexport", "1.0.0", Active),
108

109 110
    // These are used to test this portion of the compiler, they don't actually
    // mean anything
B
Brian Anderson 已提交
111 112
    ("test_accepted_feature", "1.0.0", Accepted),
    ("test_removed_feature", "1.0.0", Removed),
113 114 115

    // Allows use of #[staged_api]
    ("staged_api", "1.0.0", Active),
116 117

    // Allows using items which are missing stability attributes
K
Keegan McAllister 已提交
118 119 120 121
    ("unmarked_api", "1.0.0", Active),

    // Allows using #![no_std]
    ("no_std", "1.0.0", Active),
122 123 124

    // Allows using `box` in patterns; RFC 469
    ("box_patterns", "1.0.0", Active),
125

126 127 128
    // Allows using the unsafe_no_drop_flag attribute (unlikely to
    // switch to Accepted; see RFC 320)
    ("unsafe_no_drop_flag", "1.0.0", Active),
129 130

    // Allows the use of custom attributes; RFC 572
M
Manish Goregaokar 已提交
131 132
    ("custom_attribute", "1.0.0", Active),

133 134 135 136
    // Allows the use of #[derive(Anything)] as sugar for
    // #[derive_Anything].
    ("custom_derive", "1.0.0", Active),

M
Manish Goregaokar 已提交
137 138
    // Allows the use of rustc_* attributes; RFC 572
    ("rustc_attrs", "1.0.0", Active),
H
Huon Wilson 已提交
139

140 141 142 143 144
    // Allows the use of #[allow_internal_unstable]. This is an
    // attribute on macro_rules! and can't use the attribute handling
    // below (it has to be checked before expansion possibly makes
    // macros disappear).
    ("allow_internal_unstable", "1.0.0", Active),
145 146 147

    // #23121. Array patterns have some hazards yet.
    ("slice_patterns", "1.0.0", Active),
148 149 150

    // Allows use of unary negate on unsigned integers, e.g. -e for e: u8
    ("negate_unsigned", "1.0.0", Active),
151 152 153 154

    // Allows the definition of associated constants in `trait` or `impl`
    // blocks.
    ("associated_consts", "1.0.0", Active),
N
Niko Matsakis 已提交
155 156 157

    // Allows the definition of `const fn` functions.
    ("const_fn", "1.2.0", Active),
158 159 160

    // Allows using #[prelude_import] on glob `use` items.
    ("prelude_import", "1.2.0", Active),
161
];
162
// (changing above list without updating src/doc/reference.md makes @cmr sad)
163 164 165 166 167 168 169 170 171 172 173 174 175

enum Status {
    /// Represents an active feature that is currently being implemented or
    /// currently being considered for addition/removal.
    Active,

    /// Represents a feature which has since been removed (it was once Active)
    Removed,

    /// This language feature has since been Accepted (it was once Active)
    Accepted,
}

176
// Attributes that have a special meaning to rustc or rustdoc
177
pub const KNOWN_ATTRIBUTES: &'static [(&'static str, AttributeType)] = &[
178 179 180 181 182 183 184 185 186 187 188 189 190
    // Normal attributes

    ("warn", Normal),
    ("allow", Normal),
    ("forbid", Normal),
    ("deny", Normal),

    ("macro_reexport", Normal),
    ("macro_use", Normal),
    ("macro_export", Normal),
    ("plugin_registrar", Normal),

    ("cfg", Normal),
191
    ("cfg_attr", Normal),
192 193 194 195 196 197 198 199 200 201 202 203
    ("main", Normal),
    ("start", Normal),
    ("test", Normal),
    ("bench", Normal),
    ("simd", Normal),
    ("repr", Normal),
    ("path", Normal),
    ("abi", Normal),
    ("automatically_derived", Normal),
    ("no_mangle", Normal),
    ("no_link", Normal),
    ("derive", Normal),
S
Steven Fackler 已提交
204
    ("should_panic", Normal),
205 206 207 208 209
    ("ignore", Normal),
    ("no_implicit_prelude", Normal),
    ("reexport_test_harness_main", Normal),
    ("link_args", Normal),
    ("macro_escape", Normal),
210

M
Manish Goregaokar 已提交
211 212 213 214 215 216 217 218 219
    ("staged_api", Gated("staged_api",
                         "staged_api is for use by rustc only")),
    ("plugin", Gated("plugin",
                     "compiler plugins are experimental \
                      and possibly buggy")),
    ("no_std", Gated("no_std",
                     "no_std is experimental")),
    ("lang", Gated("lang_items",
                     "language items are subject to change")),
220 221 222 223 224 225 226
    ("linkage", Gated("linkage",
                      "the `linkage` attribute is experimental \
                       and not portable across platforms")),
    ("thread_local", Gated("thread_local",
                            "`#[thread_local]` is an experimental feature, and does not \
                             currently handle destructors. There is no corresponding \
                             `#[task_local]` mapping to the task model")),
M
Manish Goregaokar 已提交
227

M
Manish Goregaokar 已提交
228 229 230
    ("rustc_on_unimplemented", Gated("on_unimplemented",
                                     "the `#[rustc_on_unimplemented]` attribute \
                                      is an experimental feature")),
231 232
    ("allocator", Gated("allocator",
                        "the `#[allocator]` attribute is an experimental feature")),
M
Manish Goregaokar 已提交
233 234 235 236 237 238 239 240 241 242
    ("rustc_variance", Gated("rustc_attrs",
                             "the `#[rustc_variance]` attribute \
                              is an experimental feature")),
    ("rustc_error", Gated("rustc_attrs",
                          "the `#[rustc_error]` attribute \
                           is an experimental feature")),
    ("rustc_move_fragments", Gated("rustc_attrs",
                                   "the `#[rustc_move_fragments]` attribute \
                                    is an experimental feature")),

243 244 245
    ("allow_internal_unstable", Gated("allow_internal_unstable",
                                      EXPLAIN_ALLOW_INTERNAL_UNSTABLE)),

246 247 248 249
    ("fundamental", Gated("fundamental",
                          "the `#[fundamental]` attribute \
                           is an experimental feature")),

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
    // FIXME: #14408 whitelist docs since rustdoc looks at them
    ("doc", Whitelisted),

    // FIXME: #14406 these are processed in trans, which happens after the
    // lint pass
    ("cold", Whitelisted),
    ("export_name", Whitelisted),
    ("inline", Whitelisted),
    ("link", Whitelisted),
    ("link_name", Whitelisted),
    ("link_section", Whitelisted),
    ("no_builtins", Whitelisted),
    ("no_mangle", Whitelisted),
    ("no_stack_check", Whitelisted),
    ("no_debug", Whitelisted),
    ("omit_gdb_pretty_printer_section", Whitelisted),
266 267 268
    ("unsafe_no_drop_flag", Gated("unsafe_no_drop_flag",
                                  "unsafe_no_drop_flag has unstable semantics \
                                   and may be removed in the future")),
269 270

    // used in resolve
271 272
    ("prelude_import", Gated("prelude_import",
                             "`#[prelude_import]` is for use by rustc only")),
273 274 275 276 277 278 279 280

    // FIXME: #14407 these are only looked at on-demand so we can't
    // guarantee they'll have already been checked
    ("deprecated", Whitelisted),
    ("must_use", Whitelisted),
    ("stable", Whitelisted),
    ("unstable", Whitelisted),

281 282 283 284
    ("rustc_paren_sugar", Gated("unboxed_closures",
                                "unboxed_closures are still evolving")),
    ("rustc_reflect_like", Gated("reflect",
                                 "defining reflective traits is still evolving")),
285 286 287 288

    // Crate level attributes
    ("crate_name", CrateLevel),
    ("crate_type", CrateLevel),
289
    ("crate_id", CrateLevel),
290 291 292 293
    ("feature", CrateLevel),
    ("no_start", CrateLevel),
    ("no_main", CrateLevel),
    ("no_builtins", CrateLevel),
294
    ("recursion_limit", CrateLevel),
295 296
];

N
Niko Matsakis 已提交
297
#[derive(PartialEq, Copy, Clone, Debug)]
298 299 300 301 302 303 304 305 306 307
pub enum AttributeType {
    /// Normal, builtin attribute that is consumed
    /// by the compiler before the unused_attribute check
    Normal,

    /// Builtin attribute that may not be consumed by the compiler
    /// before the unused_attribute check. These attributes
    /// will be ignored by the unused_attribute lint
    Whitelisted,

M
Manish Goregaokar 已提交
308 309 310 311
    /// Is gated by a given feature gate and reason
    /// These get whitelisted too
    Gated(&'static str, &'static str),

312 313 314 315
    /// Builtin attribute that is only allowed at the crate level
    CrateLevel,
}

316 317
/// A set of features to be used by later passes.
pub struct Features {
318
    pub unboxed_closures: bool,
N
Nick Cameron 已提交
319
    pub rustc_diagnostic_macros: bool,
320
    pub visible_private_types: bool,
321 322
    pub allow_quote: bool,
    pub allow_asm: bool,
323 324 325
    pub allow_log_syntax: bool,
    pub allow_concat_idents: bool,
    pub allow_trace_macros: bool,
326
    pub allow_internal_unstable: bool,
327
    pub allow_custom_derive: bool,
328
    pub simd_ffi: bool,
329
    pub unmarked_api: bool,
330
    pub negate_unsigned: bool,
331 332 333
    /// spans of #![feature] attrs for stable language features. for error reporting
    pub declared_stable_lang_features: Vec<Span>,
    /// #![feature] attrs for non-language (library) features
334 335
    pub declared_lib_features: Vec<(InternedString, Span)>,
    pub const_fn: bool,
336 337 338 339 340
}

impl Features {
    pub fn new() -> Features {
        Features {
341
            unboxed_closures: false,
N
Nick Cameron 已提交
342
            rustc_diagnostic_macros: false,
343
            visible_private_types: false,
344 345
            allow_quote: false,
            allow_asm: false,
346 347 348
            allow_log_syntax: false,
            allow_concat_idents: false,
            allow_trace_macros: false,
349
            allow_internal_unstable: false,
350
            allow_custom_derive: false,
351
            simd_ffi: false,
352
            unmarked_api: false,
353
            negate_unsigned: false,
354
            declared_stable_lang_features: Vec::new(),
355 356
            declared_lib_features: Vec::new(),
            const_fn: false,
357 358 359 360
        }
    }
}

E
Eduard Burtescu 已提交
361 362
struct Context<'a> {
    features: Vec<&'static str>,
N
Nick Cameron 已提交
363
    span_handler: &'a SpanHandler,
C
Corey Richardson 已提交
364
    cm: &'a CodeMap,
365
    plugin_attributes: &'a [(String, AttributeType)],
366 367
}

E
Eduard Burtescu 已提交
368
impl<'a> Context<'a> {
369
    fn gate_feature(&self, feature: &str, span: Span, explain: &str) {
370 371 372
        let has_feature = self.has_feature(feature);
        debug!("gate_feature(feature = {:?}, span = {:?}); has? {}", feature, span, has_feature);
        if !has_feature {
373
            emit_feature_err(self.span_handler, feature, span, explain);
374 375
        }
    }
376
    fn has_feature(&self, feature: &str) -> bool {
377
        self.features.iter().any(|&n| n == feature)
378
    }
379

380
    fn check_attribute(&self, attr: &ast::Attribute, is_macro: bool) {
381 382 383 384 385 386 387 388 389 390 391
        debug!("check_attribute(attr = {:?})", attr);
        let name = &*attr.name();
        for &(n, ty) in KNOWN_ATTRIBUTES {
            if n == name {
                if let Gated(gate, desc) = ty {
                    self.gate_feature(gate, attr.span, desc);
                }
                debug!("check_attribute: {:?} is known, {:?}", name, ty);
                return;
            }
        }
392
        for &(ref n, ref ty) in self.plugin_attributes {
393 394
            if &*n == name {
                // Plugins can't gate attributes, so we don't check for it
M
Manish Goregaokar 已提交
395 396
                // unlike the code above; we only use this loop to
                // short-circuit to avoid the checks below
397 398 399 400
                debug!("check_attribute: {:?} is registered by a plugin, {:?}", name, ty);
                return;
            }
        }
401 402 403 404 405
        if name.starts_with("rustc_") {
            self.gate_feature("rustc_attrs", attr.span,
                              "unless otherwise specified, attributes \
                               with the prefix `rustc_` \
                               are reserved for internal compiler diagnostics");
406 407
        } else if name.starts_with("derive_") {
            self.gate_feature("custom_derive", attr.span,
408
                              "attributes of the form `#[derive_*]` are reserved \
409
                               for the compiler");
410
        } else {
M
Manish Goregaokar 已提交
411 412 413 414
            // Only run the custom attribute lint during regular
            // feature gate checking. Macro gating runs
            // before the plugin attributes are registered
            // so we skip this then
415 416 417 418 419 420 421 422
            if !is_macro {
                self.gate_feature("custom_attribute", attr.span,
                           &format!("The attribute `{}` is currently \
                                    unknown to the compiler and \
                                    may have meaning \
                                    added to it in the future",
                                    name));
            }
423 424
        }
    }
425 426
}

427 428
pub fn emit_feature_err(diag: &SpanHandler, feature: &str, span: Span, explain: &str) {
    diag.span_err(span, explain);
429 430

    // #23973: do not suggest `#![feature(...)]` if we are in beta/stable
431
    if option_env!("CFG_DISABLE_UNSTABLE_FEATURES").is_some() { return; }
432
    diag.fileline_help(span, &format!("add #![feature({})] to the \
433
                                   crate attributes to enable",
434
                                  feature));
435 436
}

437 438 439
pub const EXPLAIN_ASM: &'static str =
    "inline assembly is not stable enough for use and is subject to change";

440 441 442 443 444 445 446 447
pub const EXPLAIN_LOG_SYNTAX: &'static str =
    "`log_syntax!` is not stable enough for use and is subject to change";

pub const EXPLAIN_CONCAT_IDENTS: &'static str =
    "`concat_idents` is not stable enough for use and is subject to change";

pub const EXPLAIN_TRACE_MACROS: &'static str =
    "`trace_macros` is not stable enough for use and is subject to change";
448 449
pub const EXPLAIN_ALLOW_INTERNAL_UNSTABLE: &'static str =
    "allow_internal_unstable side-steps feature gating and stability checks";
450

451 452 453
pub const EXPLAIN_CUSTOM_DERIVE: &'static str =
    "`#[derive]` for custom traits is not stable enough for use and is subject to change";

C
Corey Richardson 已提交
454 455 456 457 458
struct MacroVisitor<'a> {
    context: &'a Context<'a>
}

impl<'a, 'v> Visitor<'v> for MacroVisitor<'a> {
K
Keegan McAllister 已提交
459 460
    fn visit_mac(&mut self, mac: &ast::Mac) {
        let ast::MacInvocTT(ref path, _, _) = mac.node;
C
Corey Richardson 已提交
461 462
        let id = path.segments.last().unwrap().identifier;

463 464 465 466 467 468 469 470
        // Issue 22234: If you add a new case here, make sure to also
        // add code to catch the macro during or after expansion.
        //
        // We still keep this MacroVisitor (rather than *solely*
        // relying on catching cases during or after expansion) to
        // catch uses of these macros within conditionally-compiled
        // code, e.g. `#[cfg]`-guarded functions.

K
Keegan McAllister 已提交
471
        if id == token::str_to_ident("asm") {
472
            self.context.gate_feature("asm", path.span, EXPLAIN_ASM);
C
Corey Richardson 已提交
473 474 475
        }

        else if id == token::str_to_ident("log_syntax") {
476
            self.context.gate_feature("log_syntax", path.span, EXPLAIN_LOG_SYNTAX);
C
Corey Richardson 已提交
477 478 479
        }

        else if id == token::str_to_ident("trace_macros") {
480
            self.context.gate_feature("trace_macros", path.span, EXPLAIN_TRACE_MACROS);
C
Corey Richardson 已提交
481 482 483
        }

        else if id == token::str_to_ident("concat_idents") {
484
            self.context.gate_feature("concat_idents", path.span, EXPLAIN_CONCAT_IDENTS);
C
Corey Richardson 已提交
485 486
        }
    }
487 488

    fn visit_attribute(&mut self, attr: &'v ast::Attribute) {
489
        self.context.check_attribute(attr, true);
490
    }
C
Corey Richardson 已提交
491 492 493 494 495 496 497 498
}

struct PostExpansionVisitor<'a> {
    context: &'a Context<'a>
}

impl<'a> PostExpansionVisitor<'a> {
    fn gate_feature(&self, feature: &str, span: Span, explain: &str) {
499
        if !self.context.cm.span_allows_unstable(span) {
C
Corey Richardson 已提交
500 501 502 503 504 505
            self.context.gate_feature(feature, span, explain)
        }
    }
}

impl<'a, 'v> Visitor<'v> for PostExpansionVisitor<'a> {
506 507
    fn visit_attribute(&mut self, attr: &ast::Attribute) {
        if !self.context.cm.span_allows_unstable(attr.span) {
508
            self.context.check_attribute(attr, false);
509 510 511
        }
    }

512
    fn visit_name(&mut self, sp: Span, name: ast::Name) {
G
GuillaumeGomez 已提交
513
        if !token::get_name(name).is_ascii() {
514 515 516 517 518
            self.gate_feature("non_ascii_idents", sp,
                              "non-ascii idents are not fully supported.");
        }
    }

519
    fn visit_item(&mut self, i: &ast::Item) {
520
        match i.node {
521
            ast::ItemExternCrate(_) => {
522
                if attr::contains_name(&i.attrs[..], "macro_reexport") {
523 524 525
                    self.gate_feature("macro_reexport", i.span,
                                      "macros reexports are experimental \
                                       and possibly buggy");
526 527 528
                }
            }

529
            ast::ItemForeignMod(ref foreign_module) => {
530
                if attr::contains_name(&i.attrs[..], "link_args") {
531 532 533 534 535
                    self.gate_feature("link_args", i.span,
                                      "the `link_args` attribute is not portable \
                                       across platforms, it is recommended to \
                                       use `#[link(name = \"foo\")]` instead")
                }
N
Niko Matsakis 已提交
536
                if foreign_module.abi == Abi::RustIntrinsic {
537 538 539 540
                    self.gate_feature("intrinsics",
                                      i.span,
                                      "intrinsics are subject to change")
                }
541 542
            }

543
            ast::ItemFn(..) => {
544
                if attr::contains_name(&i.attrs[..], "plugin_registrar") {
545 546
                    self.gate_feature("plugin_registrar", i.span,
                                      "compiler plugins are experimental and possibly buggy");
547
                }
548
                if attr::contains_name(&i.attrs[..], "start") {
549 550 551 552 553
                    self.gate_feature("start", i.span,
                                      "a #[start] function is an experimental \
                                       feature whose signature may change \
                                       over time");
                }
554
                if attr::contains_name(&i.attrs[..], "main") {
555 556 557 558 559
                    self.gate_feature("main", i.span,
                                      "declaration of a nonstandard #[main] \
                                       function may change over time, for now \
                                       a top-level `fn main()` is required");
                }
560 561
            }

562
            ast::ItemStruct(..) => {
563
                if attr::contains_name(&i.attrs[..], "simd") {
D
David Manescu 已提交
564 565
                    self.gate_feature("simd", i.span,
                                      "SIMD types are experimental and possibly buggy");
566
                }
D
David Manescu 已提交
567 568
            }

F
Flavio Percoco 已提交
569 570 571 572 573 574 575
            ast::ItemDefaultImpl(..) => {
                self.gate_feature("optin_builtin_traits",
                                  i.span,
                                  "default trait implementations are experimental \
                                   and possibly buggy");
            }

A
Alex Crichton 已提交
576
            ast::ItemImpl(_, polarity, _, _, _, _) => {
577 578 579 580 581 582 583 584 585
                match polarity {
                    ast::ImplPolarity::Negative => {
                        self.gate_feature("optin_builtin_traits",
                                          i.span,
                                          "negative trait bounds are not yet fully implemented; \
                                          use marker types for now");
                    },
                    _ => {}
                }
586 587
            }

588 589 590
            _ => {}
        }

591
        visit::walk_item(self, i);
592
    }
593

594
    fn visit_foreign_item(&mut self, i: &ast::ForeignItem) {
595
        let links_to_llvm = match attr::first_attr_value_str_by_name(&i.attrs,
N
fallout  
Nick Cameron 已提交
596
                                                                     "link_name") {
G
GuillaumeGomez 已提交
597
            Some(val) => val.starts_with("llvm."),
598 599 600 601 602 603 604
            _ => false
        };
        if links_to_llvm {
            self.gate_feature("link_llvm_intrinsics", i.span,
                              "linking to LLVM intrinsics is experimental");
        }

605
        visit::walk_foreign_item(self, i)
606 607
    }

608
    fn visit_expr(&mut self, e: &ast::Expr) {
609
        match e.node {
610 611 612
            ast::ExprBox(..) | ast::ExprUnary(ast::UnOp::UnUniq, _) => {
                self.gate_feature("box_syntax",
                                  e.span,
613
                                  "box expression syntax is experimental; \
614 615
                                   you can call `Box::new` instead.");
            }
616 617
            _ => {}
        }
618
        visit::walk_expr(self, e);
619
    }
620

621
    fn visit_pat(&mut self, pattern: &ast::Pat) {
622 623 624 625 626 627
        match pattern.node {
            ast::PatVec(_, Some(_), ref last) if !last.is_empty() => {
                self.gate_feature("advanced_slice_patterns",
                                  pattern.span,
                                  "multiple-element slice matches anywhere \
                                   but at the end of a slice (e.g. \
628
                                   `[0, ..xs, 0]`) are experimental")
629
            }
630 631 632 633 634
            ast::PatVec(..) => {
                self.gate_feature("slice_patterns",
                                  pattern.span,
                                  "slice pattern syntax is experimental");
            }
635
            ast::PatBox(..) => {
636
                self.gate_feature("box_patterns",
637
                                  pattern.span,
638
                                  "box pattern syntax is experimental");
639
            }
640 641
            _ => {}
        }
642
        visit::walk_pat(self, pattern)
643 644
    }

645
    fn visit_fn(&mut self,
646 647 648
                fn_kind: visit::FnKind<'v>,
                fn_decl: &'v ast::FnDecl,
                block: &'v ast::Block,
649
                span: Span,
650
                _node_id: NodeId) {
N
Niko Matsakis 已提交
651 652 653 654 655 656 657 658 659 660 661 662 663
        // check for const fn declarations
        match fn_kind {
            visit::FkItemFn(_, _, _, ast::Constness::Const, _, _) => {
                self.gate_feature("const_fn", span, "const fn is unstable");
            }
            _ => {
                // stability of const fn methods are covered in
                // visit_trait_item and visit_impl_item below; this is
                // because default methods don't pass through this
                // point.
            }
        }

664
        match fn_kind {
665
            visit::FkItemFn(_, _, _, _, abi, _) if abi == Abi::RustIntrinsic => {
666 667 668 669
                self.gate_feature("intrinsics",
                                  span,
                                  "intrinsics are subject to change")
            }
670
            visit::FkItemFn(_, _, _, _, abi, _) |
671
            visit::FkMethod(_, &ast::MethodSig { abi, .. }, _) if abi == Abi::RustCall => {
N
Niko Matsakis 已提交
672 673 674 675
                self.gate_feature("unboxed_closures",
                                  span,
                                  "rust-call ABI is subject to change")
            }
676 677
            _ => {}
        }
678
        visit::walk_fn(self, fn_kind, fn_decl, block, span);
679
    }
680 681 682 683 684 685 686 687

    fn visit_trait_item(&mut self, ti: &'v ast::TraitItem) {
        match ti.node {
            ast::ConstTraitItem(..) => {
                self.gate_feature("associated_consts",
                                  ti.span,
                                  "associated constants are experimental")
            }
N
Niko Matsakis 已提交
688 689 690 691 692
            ast::MethodTraitItem(ref sig, _) => {
                if sig.constness == ast::Constness::Const {
                    self.gate_feature("const_fn", ti.span, "const fn is unstable");
                }
            }
693 694 695 696 697 698 699 700 701 702 703 704
            _ => {}
        }
        visit::walk_trait_item(self, ti);
    }

    fn visit_impl_item(&mut self, ii: &'v ast::ImplItem) {
        match ii.node {
            ast::ConstImplItem(..) => {
                self.gate_feature("associated_consts",
                                  ii.span,
                                  "associated constants are experimental")
            }
N
Niko Matsakis 已提交
705 706 707 708 709
            ast::MethodImplItem(ref sig, _) => {
                if sig.constness == ast::Constness::Const {
                    self.gate_feature("const_fn", ii.span, "const fn is unstable");
                }
            }
710 711 712 713
            _ => {}
        }
        visit::walk_impl_item(self, ii);
    }
714 715
}

716 717
fn check_crate_inner<F>(cm: &CodeMap, span_handler: &SpanHandler,
                        krate: &ast::Crate,
718
                        plugin_attributes: &[(String, AttributeType)],
C
Corey Richardson 已提交
719
                        check: F)
720
                       -> Features
C
Corey Richardson 已提交
721 722
    where F: FnOnce(&mut Context, &ast::Crate)
{
723
    let mut cx = Context {
724
        features: Vec::new(),
N
Nick Cameron 已提交
725
        span_handler: span_handler,
C
Corey Richardson 已提交
726
        cm: cm,
727
        plugin_attributes: plugin_attributes,
728 729
    };

730
    let mut accepted_features = Vec::new();
N
Nick Cameron 已提交
731 732
    let mut unknown_features = Vec::new();

733
    for attr in &krate.attrs {
S
Steven Fackler 已提交
734
        if !attr.check_name("feature") {
735 736
            continue
        }
737 738 739

        match attr.meta_item_list() {
            None => {
N
Nick Cameron 已提交
740 741
                span_handler.span_err(attr.span, "malformed feature attribute, \
                                                  expected #![feature(...)]");
742 743
            }
            Some(list) => {
744
                for mi in list {
745
                    let name = match mi.node {
746
                        ast::MetaWord(ref word) => (*word).clone(),
747
                        _ => {
N
Nick Cameron 已提交
748 749 750
                            span_handler.span_err(mi.span,
                                                  "malformed feature, expected just \
                                                   one word");
751 752 753
                            continue
                        }
                    };
754
                    match KNOWN_FEATURES.iter()
B
Brian Anderson 已提交
755 756
                                        .find(|& &(n, _, _)| name == n) {
                        Some(&(name, _, Active)) => {
757 758
                            cx.features.push(name);
                        }
B
Brian Anderson 已提交
759
                        Some(&(_, _, Removed)) => {
N
Nick Cameron 已提交
760
                            span_handler.span_err(mi.span, "feature has been removed");
761
                        }
B
Brian Anderson 已提交
762
                        Some(&(_, _, Accepted)) => {
763
                            accepted_features.push(mi.span);
764 765
                        }
                        None => {
766
                            unknown_features.push((name, mi.span));
767 768 769 770 771 772 773
                        }
                    }
                }
            }
        }
    }

C
Corey Richardson 已提交
774
    check(&mut cx, krate);
775

776 777 778
    // FIXME (pnkfelix): Before adding the 99th entry below, change it
    // to a single-pass (instead of N calls to `.has_feature`).

779
    Features {
780
        unboxed_closures: cx.has_feature("unboxed_closures"),
N
Nick Cameron 已提交
781
        rustc_diagnostic_macros: cx.has_feature("rustc_diagnostic_macros"),
782
        visible_private_types: cx.has_feature("visible_private_types"),
783 784
        allow_quote: cx.has_feature("quote"),
        allow_asm: cx.has_feature("asm"),
785 786 787
        allow_log_syntax: cx.has_feature("log_syntax"),
        allow_concat_idents: cx.has_feature("concat_idents"),
        allow_trace_macros: cx.has_feature("trace_macros"),
788
        allow_internal_unstable: cx.has_feature("allow_internal_unstable"),
789
        allow_custom_derive: cx.has_feature("custom_derive"),
790
        simd_ffi: cx.has_feature("simd_ffi"),
791
        unmarked_api: cx.has_feature("unmarked_api"),
792
        negate_unsigned: cx.has_feature("negate_unsigned"),
793
        declared_stable_lang_features: accepted_features,
794 795
        declared_lib_features: unknown_features,
        const_fn: cx.has_feature("const_fn"),
796
    }
797
}
C
Corey Richardson 已提交
798 799

pub fn check_crate_macros(cm: &CodeMap, span_handler: &SpanHandler, krate: &ast::Crate)
800
-> Features {
801
    check_crate_inner(cm, span_handler, krate, &[] as &'static [_],
C
Corey Richardson 已提交
802 803 804
                      |ctx, krate| visit::walk_crate(&mut MacroVisitor { context: ctx }, krate))
}

805
pub fn check_crate(cm: &CodeMap, span_handler: &SpanHandler, krate: &ast::Crate,
806 807
                   plugin_attributes: &[(String, AttributeType)],
                   unstable: UnstableFeatures) -> Features
808
{
809 810
    maybe_stage_features(span_handler, krate, unstable);

811
    check_crate_inner(cm, span_handler, krate, plugin_attributes,
C
Corey Richardson 已提交
812 813 814
                      |ctx, krate| visit::walk_crate(&mut PostExpansionVisitor { context: ctx },
                                                     krate))
}
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848

#[derive(Clone, Copy)]
pub enum UnstableFeatures {
    /// Hard errors for unstable features are active, as on
    /// beta/stable channels.
    Disallow,
    /// Allow features to me activated, as on nightly.
    Allow,
    /// Errors are bypassed for bootstrapping. This is required any time
    /// during the build that feature-related lints are set to warn or above
    /// because the build turns on warnings-as-errors and uses lots of unstable
    /// features. As a result, this this is always required for building Rust
    /// itself.
    Cheat
}

fn maybe_stage_features(span_handler: &SpanHandler, krate: &ast::Crate,
                        unstable: UnstableFeatures) {
    let allow_features = match unstable {
        UnstableFeatures::Allow => true,
        UnstableFeatures::Disallow => false,
        UnstableFeatures::Cheat => true
    };
    if !allow_features {
        for attr in &krate.attrs {
            if attr.check_name("feature") {
                let release_channel = option_env!("CFG_RELEASE_CHANNEL").unwrap_or("(unknown)");
                let ref msg = format!("#[feature] may not be used on the {} release channel",
                                      release_channel);
                span_handler.span_err(attr.span, msg);
            }
        }
    }
}