feature_gate.rs 65.6 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

25
use self::AttributeType::*;
26
use self::AttributeGate::*;
27

N
Niko Matsakis 已提交
28
use abi::Abi;
29
use ast::{self, NodeId, PatKind, RangeEnd};
30
use attr;
31
use codemap::Spanned;
32
use syntax_pos::Span;
33
use errors::{DiagnosticBuilder, Handler, FatalError};
34
use visit::{self, FnKind, Visitor};
J
Jeffrey Seyfried 已提交
35
use parse::ParseSess;
36
use symbol::Symbol;
37

38
use std::ascii::AsciiExt;
T
Tim Neumann 已提交
39
use std::env;
40

41 42 43 44 45 46 47 48
macro_rules! setter {
    ($field: ident) => {{
        fn f(features: &mut Features) -> &mut bool {
            &mut features.$field
        }
        f as fn(&mut Features) -> &mut bool
    }}
}
49

50
macro_rules! declare_features {
51
    ($((active, $feature: ident, $ver: expr, $issue: expr),)+) => {
52 53 54 55 56 57 58 59 60
        /// Represents active features that are currently being implemented or
        /// currently being considered for addition/removal.
        const ACTIVE_FEATURES: &'static [(&'static str, &'static str,
                                          Option<u32>, fn(&mut Features) -> &mut bool)] = &[
            $((stringify!($feature), $ver, $issue, setter!($feature))),+
        ];

        /// A set of features to be used by later passes.
        pub struct Features {
61
            /// #![feature] attrs for stable language features, for error reporting
62
            pub declared_stable_lang_features: Vec<(Symbol, Span)>,
63
            /// #![feature] attrs for non-language (library) features
64
            pub declared_lib_features: Vec<(Symbol, Span)>,
65 66
            $(pub $feature: bool),+
        }
67

68 69 70 71 72 73 74 75 76 77 78
        impl Features {
            pub fn new() -> Features {
                Features {
                    declared_stable_lang_features: Vec::new(),
                    declared_lib_features: Vec::new(),
                    $($feature: false),+
                }
            }
        }
    };

79
    ($((removed, $feature: ident, $ver: expr, $issue: expr),)+) => {
80
        /// Represents unstable features which have since been removed (it was once Active)
81 82 83 84 85
        const REMOVED_FEATURES: &'static [(&'static str, &'static str, Option<u32>)] = &[
            $((stringify!($feature), $ver, $issue)),+
        ];
    };

86 87 88 89 90 91 92
    ($((stable_removed, $feature: ident, $ver: expr, $issue: expr),)+) => {
        /// Represents stable features which have since been removed (it was once Accepted)
        const STABLE_REMOVED_FEATURES: &'static [(&'static str, &'static str, Option<u32>)] = &[
            $((stringify!($feature), $ver, $issue)),+
        ];
    };

93
    ($((accepted, $feature: ident, $ver: expr, $issue: expr),)+) => {
94 95 96 97 98
        /// Those language feature has since been Accepted (it was once Active)
        const ACCEPTED_FEATURES: &'static [(&'static str, &'static str, Option<u32>)] = &[
            $((stringify!($feature), $ver, $issue)),+
        ];
    }
99 100
}

S
Steve Klabnik 已提交
101 102
// If you change this, please modify src/doc/unstable-book as well.
//
B
Brian Anderson 已提交
103
// Don't ever remove anything from this list; set them to 'Removed'.
S
Steve Klabnik 已提交
104
//
B
Brian Anderson 已提交
105 106 107
// 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).
S
Steve Klabnik 已提交
108
//
109 110 111 112 113 114 115 116 117 118 119 120
// NB: The featureck.py script parses this information directly out of the source
// so take care when modifying it.

declare_features! (
    (active, asm, "1.0.0", Some(29722)),
    (active, concat_idents, "1.0.0", Some(29599)),
    (active, link_args, "1.0.0", Some(29596)),
    (active, log_syntax, "1.0.0", Some(29598)),
    (active, non_ascii_idents, "1.0.0", Some(28979)),
    (active, plugin_registrar, "1.0.0", Some(29597)),
    (active, thread_local, "1.0.0", Some(29594)),
    (active, trace_macros, "1.0.0", Some(29598)),
A
Aaron Turon 已提交
121 122

    // rustc internal, for now:
123 124
    (active, intrinsics, "1.0.0", None),
    (active, lang_items, "1.0.0", None),
125

126 127 128 129
    (active, link_llvm_intrinsics, "1.0.0", Some(29602)),
    (active, linkage, "1.0.0", Some(29603)),
    (active, quote, "1.0.0", Some(29601)),
    (active, simd, "1.0.0", Some(27731)),
130 131


A
Aaron Turon 已提交
132
    // rustc internal
133 134 135 136 137
    (active, rustc_diagnostic_macros, "1.0.0", None),
    (active, advanced_slice_patterns, "1.0.0", Some(23121)),
    (active, box_syntax, "1.0.0", Some(27779)),
    (active, placement_in_syntax, "1.0.0", Some(27779)),
    (active, unboxed_closures, "1.0.0", Some(29625)),
A
Aaron Turon 已提交
138

139 140 141 142 143 144 145 146 147
    (active, allocator, "1.0.0", Some(27389)),
    (active, fundamental, "1.0.0", Some(29635)),
    (active, main, "1.0.0", Some(29634)),
    (active, needs_allocator, "1.4.0", Some(27389)),
    (active, on_unimplemented, "1.0.0", Some(29628)),
    (active, plugin, "1.0.0", Some(29597)),
    (active, simd_ffi, "1.0.0", Some(27731)),
    (active, start, "1.0.0", Some(29633)),
    (active, structural_match, "1.8.0", Some(31434)),
148 149
    (active, panic_runtime, "1.10.0", Some(32837)),
    (active, needs_panic_runtime, "1.10.0", Some(32837)),
150

151
    // OIBIT specific features
152
    (active, optin_builtin_traits, "1.0.0", Some(13231)),
153

J
Joseph Crail 已提交
154
    // macro reexport needs more discussion and stabilization
155
    (active, macro_reexport, "1.0.0", Some(29638)),
156 157

    // Allows use of #[staged_api]
A
Aaron Turon 已提交
158
    // rustc internal
159
    (active, staged_api, "1.0.0", None),
160

A
Alex Crichton 已提交
161
    // Allows using #![no_core]
162
    (active, no_core, "1.3.0", Some(29639)),
A
Alex Crichton 已提交
163

164
    // Allows using `box` in patterns; RFC 469
165
    (active, box_patterns, "1.0.0", Some(29641)),
166

167 168
    // Allows using the unsafe_destructor_blind_to_params attribute;
    // RFC 1238
169
    (active, dropck_parametricity, "1.3.0", Some(28498)),
170

171 172 173
    // Allows using the may_dangle attribute; RFC 1327
    (active, dropck_eyepatch, "1.10.0", Some(34761)),

174
    // Allows the use of custom attributes; RFC 572
175
    (active, custom_attribute, "1.0.0", Some(29642)),
M
Manish Goregaokar 已提交
176

177 178
    // Allows the use of #[derive(Anything)] as sugar for
    // #[derive_Anything].
179
    (active, custom_derive, "1.0.0", Some(29644)),
180

M
Manish Goregaokar 已提交
181
    // Allows the use of rustc_* attributes; RFC 572
182
    (active, rustc_attrs, "1.0.0", Some(29642)),
H
Huon Wilson 已提交
183

184 185 186 187
    // 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).
A
Aaron Turon 已提交
188 189
    //
    // rustc internal
190
    (active, allow_internal_unstable, "1.0.0", None),
191 192

    // #23121. Array patterns have some hazards yet.
193
    (active, slice_patterns, "1.0.0", Some(23121)),
194 195 196

    // Allows the definition of associated constants in `trait` or `impl`
    // blocks.
197
    (active, associated_consts, "1.0.0", Some(29646)),
N
Niko Matsakis 已提交
198 199

    // Allows the definition of `const fn` functions.
200
    (active, const_fn, "1.2.0", Some(24111)),
201

202
    // Allows indexing into constant arrays.
203
    (active, const_indexing, "1.4.0", Some(29947)),
204

205
    // Allows using #[prelude_import] on glob `use` items.
A
Aaron Turon 已提交
206 207
    //
    // rustc internal
208
    (active, prelude_import, "1.2.0", None),
209

B
Brian Anderson 已提交
210
    // Allows default type parameters to influence type inference.
211
    (active, default_type_parameter_fallback, "1.3.0", Some(27336)),
212 213

    // Allows associated type defaults
214
    (active, associated_type_defaults, "1.2.0", Some(29661)),
J
Jared Roesch 已提交
215

216
    // allow `repr(simd)`, and importing the various simd intrinsics
217
    (active, repr_simd, "1.4.0", Some(27731)),
218 219

    // Allows cfg(target_feature = "...").
220
    (active, cfg_target_feature, "1.4.0", Some(29717)),
221 222

    // allow `extern "platform-intrinsic" { ... }`
223
    (active, platform_intrinsics, "1.4.0", Some(27731)),
224 225

    // allow `#[unwind]`
A
Aaron Turon 已提交
226
    // rust runtime internal
227
    (active, unwind_attributes, "1.4.0", None),
V
Vadim Petrochenkov 已提交
228

T
Ticki 已提交
229
    // allow the use of `#[naked]` on functions.
230
    (active, naked_functions, "1.9.0", Some(32408)),
231 232

    // allow `#[no_debug]`
233
    (active, no_debug, "1.5.0", Some(29721)),
234 235

    // allow `#[omit_gdb_pretty_printer_section]`
A
Aaron Turon 已提交
236
    // rustc internal.
237
    (active, omit_gdb_pretty_printer_section, "1.5.0", None),
238 239

    // Allows cfg(target_vendor = "...").
240
    (active, cfg_target_vendor, "1.5.0", Some(29718)),
241 242

    // Allow attributes on expressions and non-item statements
243
    (active, stmt_expr_attributes, "1.6.0", Some(15701)),
244 245

    // allow using type ascription in expressions
246
    (active, type_ascription, "1.6.0", Some(23416)),
247 248

    // Allows cfg(target_thread_local)
249
    (active, cfg_target_thread_local, "1.7.0", Some(29594)),
250 251

    // rustc internal
252
    (active, abi_vectorcall, "1.7.0", None),
A
Alex Burka 已提交
253 254

    // a...b and ...b
255
    (active, inclusive_range_syntax, "1.7.0", Some(28237)),
J
Jorge Aparicio 已提交
256

257 258 259
    // X..Y patterns
    (active, exclusive_range_pattern, "1.11.0", Some(37854)),

A
Aaron Turon 已提交
260
    // impl specialization (RFC 1210)
261
    (active, specialization, "1.7.0", Some(31844)),
262

263 264 265 266
    // Allow Drop types in statics/const functions (RFC 1440)
    (active, drop_types_in_const, "1.9.0", Some(33156)),

    // Allows cfg(target_has_atomic = "...").
267 268
    (active, cfg_target_has_atomic, "1.9.0", Some(32976)),

269
    // Allows `impl Trait` in function return types.
270 271 272
    (active, conservative_impl_trait, "1.12.0", Some(34511)),

    // Permits numeric fields in struct expressions and patterns.
273 274 275
    (active, relaxed_adts, "1.12.0", Some(35626)),

    // The `!` type
276 277 278
    (active, never_type, "1.13.0", Some(35121)),

    // Allows all literals in attribute lists and values of key-value pairs.
279 280 281 282
    (active, attr_literals, "1.13.0", Some(34981)),

    // Allows the sysV64 ABI to be specified on all platforms
    // instead of just the platforms on which it is the C ABI
283 284
    (active, abi_sysv64, "1.13.0", Some(36167)),

285 286
    // Allows untagged unions `union U { ... }`
    (active, untagged_unions, "1.13.0", Some(32836)),
A
Andre Bogus 已提交
287

288 289 290
    // Used to identify the `compiler_builtins` crate
    // rustc internal
    (active, compiler_builtins, "1.13.0", None),
291 292 293

    // Allows attributes on lifetime/type formal parameters in generics (RFC 1327)
    (active, generic_param_attrs, "1.11.0", Some(34761)),
294

295 296
    // The #![windows_subsystem] attribute
    (active, windows_subsystem, "1.14.0", Some(37499)),
297

298 299
    // Allows #[link(..., cfg(..))]
    (active, link_cfg, "1.14.0", Some(37406)),
300 301

    (active, use_extern_macros, "1.15.0", Some(35896)),
302 303 304

    // Allows `break {expr}` with a value inside `loop`s.
    (active, loop_break_value, "1.14.0", Some(37339)),
305 306 307

    // Allows #[target_feature(...)]
    (active, target_feature, "1.15.0", None),
G
Guillaume Gomez 已提交
308

J
Jorge Aparicio 已提交
309 310
    // `extern "ptx-*" fn()`
    (active, abi_ptx, "1.15.0", None),
311 312

    // The `i128` type
E
est31 已提交
313
    (active, i128_type, "1.16.0", Some(35118)),
314 315 316

    // The `unadjusted` ABI. Perma unstable.
    (active, abi_unadjusted, "1.16.0", None),
317

318
    // Macros 1.1
319
    (active, proc_macro, "1.16.0", Some(38356)),
320

321 322
    // Allows attributes on struct literal fields.
    (active, struct_field_attributes, "1.16.0", Some(38814)),
323

V
Vadim Chugunov 已提交
324 325 326
    // Allows #[link(kind="static-nobundle"...]
    (active, static_nobundle, "1.16.0", Some(37403)),

327 328
    // `extern "msp430-interrupt" fn()`
    (active, abi_msp430_interrupt, "1.16.0", Some(38487)),
J
Jorge Aparicio 已提交
329

330
    // Coerces non capturing closures to function pointers
E
est31 已提交
331 332
    (active, closure_to_fn_coercion, "1.17.0", Some(39817)),

J
Jorge Aparicio 已提交
333 334 335
    // Used to identify crates that contain sanitizer runtimes
    // rustc internal
    (active, sanitizer_runtime, "1.17.0", None),
336 337 338

    // `extern "x86-interrupt" fn()`
    (active, abi_x86_interrupt, "1.17.0", Some(40180)),
339 340 341

    // Allows the `catch {...}` expression
    (active, catch_expr, "1.17.0", Some(31436)),
342 343 344

    // See rust-lang/rfcs#1414. Allows code like `let x: &'static u32 = &42` to work.
    (active, rvalue_static_promotion, "1.15.1", Some(38865)),
345 346 347 348 349 350 351
);

declare_features! (
    (removed, import_shadowing, "1.0.0", None),
    (removed, managed_boxes, "1.0.0", None),
    // Allows use of unary negate on unsigned integers, e.g. -e for e: u8
    (removed, negate_unsigned, "1.0.0", Some(29645)),
E
est31 已提交
352
    (removed, reflect, "1.0.0", Some(27749)),
353 354 355 356 357
    // A way to temporarily opt out of opt in copy. This will *never* be accepted.
    (removed, opt_out_copy, "1.0.0", None),
    (removed, quad_precision_float, "1.0.0", None),
    (removed, struct_inherit, "1.0.0", None),
    (removed, test_removed_feature, "1.0.0", None),
358
    (removed, visible_private_types, "1.0.0", None),
359
    (removed, unsafe_no_drop_flag, "1.0.0", None),
360 361 362
    // Allows using items which are missing stability attributes
    // rustc internal
    (removed, unmarked_api, "1.0.0", None),
363
    (removed, pushpop_unsafe, "1.2.0", None),
364 365
);

366 367
declare_features! (
    (stable_removed, no_stack_check, "1.0.0", None),
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
);

declare_features! (
    (accepted, associated_types, "1.0.0", None),
    // allow overloading augmented assignment operations like `a += b`
    (accepted, augmented_assignments, "1.8.0", Some(28235)),
    // allow empty structs and enum variants with braces
    (accepted, braced_empty_structs, "1.8.0", Some(29720)),
    (accepted, default_type_params, "1.0.0", None),
    (accepted, globs, "1.0.0", None),
    (accepted, if_let, "1.0.0", None),
    // A temporary feature gate used to enable parser extensions needed
    // to bootstrap fix for #5723.
    (accepted, issue_5723_bootstrap, "1.0.0", None),
    (accepted, macro_rules, "1.0.0", None),
    // Allows using #![no_std]
384
    (accepted, no_std, "1.6.0", None),
385 386 387 388 389 390
    (accepted, slicing_syntax, "1.0.0", None),
    (accepted, struct_variant, "1.0.0", None),
    // These are used to test this portion of the compiler, they don't actually
    // mean anything
    (accepted, test_accepted_feature, "1.0.0", None),
    (accepted, tuple_indexing, "1.0.0", None),
D
Daniele Baracchi 已提交
391 392
    // Allows macros to appear in the type position.
    (accepted, type_macros, "1.13.0", Some(27245)),
393 394
    (accepted, while_let, "1.0.0", None),
    // Allows `#[deprecated]` attribute
395
    (accepted, deprecated, "1.9.0", Some(29935)),
N
Nick Cameron 已提交
396
    // `expr?`
397
    (accepted, question_mark, "1.13.0", Some(31436)),
398 399
    // Allows `..` in tuple (struct) patterns
    (accepted, dotdot_in_tuple_patterns, "1.14.0", Some(33627)),
J
Jeffrey Seyfried 已提交
400
    (accepted, item_like_imports, "1.14.0", Some(35120)),
401
    // Allows using `Self` and associated types in struct expressions and patterns.
402
    (accepted, more_struct_aliases, "1.16.0", Some(37544)),
E
est31 已提交
403 404
    // elide `'static` lifetimes in `static`s and `const`s
    (accepted, static_in_const, "1.17.0", Some(35897)),
E
est31 已提交
405 406
    // Allows field shorthands (`x` meaning `x: x`) in struct literal expressions.
    (accepted, field_init_shorthand, "1.17.0", Some(37340)),
T
Taylor Cramer 已提交
407 408
    // Allows the definition recursive static items.
    (accepted, static_recursion, "1.17.0", Some(29719)),
T
Taylor Cramer 已提交
409 410 411
    // pub(restricted) visibilities (RFC 1422)
    (accepted, pub_restricted, "1.17.0", Some(32409)),

412
);
S
Steve Klabnik 已提交
413 414 415
// If you change this, please modify src/doc/unstable-book as well. You must
// move that documentation into the relevant place in the other docs, and
// remove the chapter on the flag.
416

417 418 419 420 421
#[derive(PartialEq, Copy, Clone, Debug)]
pub enum AttributeType {
    /// Normal, builtin attribute that is consumed
    /// by the compiler before the unused_attribute check
    Normal,
422

423 424 425 426
    /// 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,
427

428 429 430 431 432 433 434
    /// Builtin attribute that is only allowed at the crate level
    CrateLevel,
}

pub enum AttributeGate {
    /// Is gated by a given feature gate, reason
    /// and function to check if enabled
435
    Gated(Stability, &'static str, &'static str, fn(&Features) -> bool),
436 437 438 439 440

    /// Ungated attribute, can be used on all release channels
    Ungated,
}

N
Nick Cameron 已提交
441 442 443 444 445 446 447 448 449 450
impl AttributeGate {
    fn is_deprecated(&self) -> bool {
        match *self {
            Gated(Stability::Deprecated(_), ..) => true,
            _ => false,
        }
    }
}

#[derive(Copy, Clone, PartialEq, Eq, Debug)]
451 452
pub enum Stability {
    Unstable,
N
Nick Cameron 已提交
453 454
    // Argument is tracking issue link.
    Deprecated(&'static str),
455 456
}

457 458 459 460
// fn() is not Debug
impl ::std::fmt::Debug for AttributeGate {
    fn fmt(&self, fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
        match *self {
N
Nick Cameron 已提交
461 462
            Gated(ref stab, ref name, ref expl, _) =>
                write!(fmt, "Gated({:?}, {}, {})", stab, name, expl),
463 464 465 466 467 468 469 470 471 472 473 474
            Ungated => write!(fmt, "Ungated")
        }
    }
}

macro_rules! cfg_fn {
    ($field: ident) => {{
        fn f(features: &Features) -> bool {
            features.$field
        }
        f as fn(&Features) -> bool
    }}
475 476
}

N
Nick Cameron 已提交
477
pub fn deprecated_attributes() -> Vec<&'static (&'static str, AttributeType, AttributeGate)> {
478
    BUILTIN_ATTRIBUTES.iter().filter(|a| a.2.is_deprecated()).collect()
N
Nick Cameron 已提交
479 480
}

481 482 483 484
pub fn is_builtin_attr(attr: &ast::Attribute) -> bool {
    BUILTIN_ATTRIBUTES.iter().any(|&(builtin_name, _, _)| attr.check_name(builtin_name))
}

485
// Attributes that have a special meaning to rustc or rustdoc
486
pub const BUILTIN_ATTRIBUTES: &'static [(&'static str, AttributeType, AttributeGate)] = &[
487 488
    // Normal attributes

489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
    ("warn", Normal, Ungated),
    ("allow", Normal, Ungated),
    ("forbid", Normal, Ungated),
    ("deny", Normal, Ungated),

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

    ("cfg", Normal, Ungated),
    ("cfg_attr", Normal, Ungated),
    ("main", Normal, Ungated),
    ("start", Normal, Ungated),
    ("test", Normal, Ungated),
    ("bench", Normal, Ungated),
    ("simd", Normal, Ungated),
    ("repr", Normal, Ungated),
    ("path", Normal, Ungated),
    ("abi", Normal, Ungated),
    ("automatically_derived", Normal, Ungated),
    ("no_mangle", Normal, Ungated),
    ("no_link", Normal, Ungated),
    ("derive", Normal, Ungated),
    ("should_panic", Normal, Ungated),
    ("ignore", Normal, Ungated),
    ("no_implicit_prelude", Normal, Ungated),
    ("reexport_test_harness_main", Normal, Ungated),
    ("link_args", Normal, Ungated),
    ("macro_escape", Normal, Ungated),
519

520
    // RFC #1445.
521 522
    ("structural_match", Whitelisted, Gated(Stability::Unstable,
                                            "structural_match",
523
                                            "the semantics of constant patterns is \
524 525
                                             not yet settled",
                                            cfg_fn!(structural_match))),
526

527 528
    ("plugin", CrateLevel, Gated(Stability::Unstable,
                                 "plugin",
529
                                 "compiler plugins are experimental \
530 531 532
                                  and possibly buggy",
                                 cfg_fn!(plugin))),

533
    ("no_std", CrateLevel, Ungated),
534 535
    ("no_core", CrateLevel, Gated(Stability::Unstable,
                                  "no_core",
536 537
                                  "no_core is experimental",
                                  cfg_fn!(no_core))),
538 539
    ("lang", Normal, Gated(Stability::Unstable,
                           "lang_items",
540 541
                           "language items are subject to change",
                           cfg_fn!(lang_items))),
542 543
    ("linkage", Whitelisted, Gated(Stability::Unstable,
                                   "linkage",
544
                                   "the `linkage` attribute is experimental \
545 546
                                    and not portable across platforms",
                                   cfg_fn!(linkage))),
547 548
    ("thread_local", Whitelisted, Gated(Stability::Unstable,
                                        "thread_local",
549 550 551
                                        "`#[thread_local]` is an experimental feature, and does \
                                         not currently handle destructors. There is no \
                                         corresponding `#[task_local]` mapping to the task \
552 553
                                         model",
                                        cfg_fn!(thread_local))),
554

555 556
    ("rustc_on_unimplemented", Normal, Gated(Stability::Unstable,
                                             "on_unimplemented",
557
                                             "the `#[rustc_on_unimplemented]` attribute \
558 559
                                              is an experimental feature",
                                             cfg_fn!(on_unimplemented))),
560 561
    ("allocator", Whitelisted, Gated(Stability::Unstable,
                                     "allocator",
562 563
                                     "the `#[allocator]` attribute is an experimental feature",
                                     cfg_fn!(allocator))),
564 565
    ("needs_allocator", Normal, Gated(Stability::Unstable,
                                      "needs_allocator",
566 567
                                      "the `#[needs_allocator]` \
                                       attribute is an experimental \
568 569
                                       feature",
                                      cfg_fn!(needs_allocator))),
570 571
    ("panic_runtime", Whitelisted, Gated(Stability::Unstable,
                                         "panic_runtime",
572 573 574
                                         "the `#[panic_runtime]` attribute is \
                                          an experimental feature",
                                         cfg_fn!(panic_runtime))),
575 576
    ("needs_panic_runtime", Whitelisted, Gated(Stability::Unstable,
                                               "needs_panic_runtime",
577 578 579 580
                                               "the `#[needs_panic_runtime]` \
                                                attribute is an experimental \
                                                feature",
                                               cfg_fn!(needs_panic_runtime))),
581 582
    ("rustc_variance", Normal, Gated(Stability::Unstable,
                                     "rustc_attrs",
583
                                     "the `#[rustc_variance]` attribute \
N
Niko Matsakis 已提交
584
                                      is just used for rustc unit tests \
585 586
                                      and will never be stable",
                                     cfg_fn!(rustc_attrs))),
587 588
    ("rustc_error", Whitelisted, Gated(Stability::Unstable,
                                       "rustc_attrs",
589
                                       "the `#[rustc_error]` attribute \
N
Niko Matsakis 已提交
590
                                        is just used for rustc unit tests \
591 592
                                        and will never be stable",
                                       cfg_fn!(rustc_attrs))),
593 594
    ("rustc_if_this_changed", Whitelisted, Gated(Stability::Unstable,
                                                 "rustc_attrs",
595 596 597 598
                                                 "the `#[rustc_if_this_changed]` attribute \
                                                  is just used for rustc unit tests \
                                                  and will never be stable",
                                                 cfg_fn!(rustc_attrs))),
599 600
    ("rustc_then_this_would_need", Whitelisted, Gated(Stability::Unstable,
                                                      "rustc_attrs",
601 602 603 604
                                                      "the `#[rustc_if_this_changed]` attribute \
                                                       is just used for rustc unit tests \
                                                       and will never be stable",
                                                      cfg_fn!(rustc_attrs))),
605 606
    ("rustc_dirty", Whitelisted, Gated(Stability::Unstable,
                                       "rustc_attrs",
607 608
                                       "the `#[rustc_dirty]` attribute \
                                        is just used for rustc unit tests \
609 610
                                        and will never be stable",
                                       cfg_fn!(rustc_attrs))),
611 612
    ("rustc_clean", Whitelisted, Gated(Stability::Unstable,
                                       "rustc_attrs",
613 614
                                       "the `#[rustc_clean]` attribute \
                                        is just used for rustc unit tests \
615 616
                                        and will never be stable",
                                       cfg_fn!(rustc_attrs))),
617 618
    ("rustc_metadata_dirty", Whitelisted, Gated(Stability::Unstable,
                                                "rustc_attrs",
619 620 621 622
                                                "the `#[rustc_metadata_dirty]` attribute \
                                                 is just used for rustc unit tests \
                                                 and will never be stable",
                                                 cfg_fn!(rustc_attrs))),
623 624
    ("rustc_metadata_clean", Whitelisted, Gated(Stability::Unstable,
                                                "rustc_attrs",
625 626 627 628
                                                "the `#[rustc_metadata_clean]` attribute \
                                                 is just used for rustc unit tests \
                                                 and will never be stable",
                                                 cfg_fn!(rustc_attrs))),
629 630
    ("rustc_partition_reused", Whitelisted, Gated(Stability::Unstable,
                                                  "rustc_attrs",
631 632 633 634
                                                  "this attribute \
                                                   is just used for rustc unit tests \
                                                   and will never be stable",
                                                  cfg_fn!(rustc_attrs))),
635 636
    ("rustc_partition_translated", Whitelisted, Gated(Stability::Unstable,
                                                      "rustc_attrs",
637 638 639 640
                                                      "this attribute \
                                                       is just used for rustc unit tests \
                                                       and will never be stable",
                                                      cfg_fn!(rustc_attrs))),
641 642
    ("rustc_symbol_name", Whitelisted, Gated(Stability::Unstable,
                                             "rustc_attrs",
643 644
                                             "internal rustc attributes will never be stable",
                                             cfg_fn!(rustc_attrs))),
645 646
    ("rustc_item_path", Whitelisted, Gated(Stability::Unstable,
                                           "rustc_attrs",
647 648
                                           "internal rustc attributes will never be stable",
                                           cfg_fn!(rustc_attrs))),
649 650
    ("rustc_move_fragments", Normal, Gated(Stability::Unstable,
                                           "rustc_attrs",
651
                                           "the `#[rustc_move_fragments]` attribute \
N
Niko Matsakis 已提交
652
                                            is just used for rustc unit tests \
653 654
                                            and will never be stable",
                                           cfg_fn!(rustc_attrs))),
655 656
    ("rustc_mir", Whitelisted, Gated(Stability::Unstable,
                                     "rustc_attrs",
657 658
                                     "the `#[rustc_mir]` attribute \
                                      is just used for rustc unit tests \
659 660
                                      and will never be stable",
                                     cfg_fn!(rustc_attrs))),
661 662
    ("rustc_inherit_overflow_checks", Whitelisted, Gated(Stability::Unstable,
                                                         "rustc_attrs",
663 664 665 666 667 668
                                                         "the `#[rustc_inherit_overflow_checks]` \
                                                          attribute is just used to control \
                                                          overflow checking behavior of several \
                                                          libcore functions that are inlined \
                                                          across crates and will never be stable",
                                                          cfg_fn!(rustc_attrs))),
669 670
    ("compiler_builtins", Whitelisted, Gated(Stability::Unstable,
                                             "compiler_builtins",
671 672 673 674 675
                                             "the `#[compiler_builtins]` attribute is used to \
                                              identify the `compiler_builtins` crate which \
                                              contains compiler-rt intrinsics and will never be \
                                              stable",
                                          cfg_fn!(compiler_builtins))),
J
Jorge Aparicio 已提交
676 677 678 679 680 681
    ("sanitizer_runtime", Whitelisted, Gated(Stability::Unstable,
                                             "sanitizer_runtime",
                                             "the `#[sanitizer_runtime]` attribute is used to \
                                              identify crates that contain the runtime of a \
                                              sanitizer and will never be stable",
                                             cfg_fn!(sanitizer_runtime))),
682

683 684
    ("allow_internal_unstable", Normal, Gated(Stability::Unstable,
                                              "allow_internal_unstable",
685 686
                                              EXPLAIN_ALLOW_INTERNAL_UNSTABLE,
                                              cfg_fn!(allow_internal_unstable))),
687

688 689
    ("fundamental", Whitelisted, Gated(Stability::Unstable,
                                       "fundamental",
690
                                       "the `#[fundamental]` attribute \
691 692
                                        is an experimental feature",
                                       cfg_fn!(fundamental))),
693

694
    ("proc_macro_derive", Normal, Ungated),
695

696 697
    ("rustc_copy_clone_marker", Whitelisted, Gated(Stability::Unstable,
                                                   "rustc_attrs",
698 699 700
                                                   "internal implementation detail",
                                                   cfg_fn!(rustc_attrs))),

701
    // FIXME: #14408 whitelist docs since rustdoc looks at them
702
    ("doc", Whitelisted, Ungated),
703 704 705

    // FIXME: #14406 these are processed in trans, which happens after the
    // lint pass
706
    ("cold", Whitelisted, Ungated),
707 708
    ("naked", Whitelisted, Gated(Stability::Unstable,
                                 "naked_functions",
T
Ticki 已提交
709
                                 "the `#[naked]` attribute \
710
                                  is an experimental feature",
711
                                 cfg_fn!(naked_functions))),
712 713 714 715
    ("target_feature", Whitelisted, Gated(
        Stability::Unstable, "target_feature",
        "the `#[target_feature]` attribute is an experimental feature",
        cfg_fn!(target_feature))),
716 717 718 719 720 721 722
    ("export_name", Whitelisted, Ungated),
    ("inline", Whitelisted, Ungated),
    ("link", Whitelisted, Ungated),
    ("link_name", Whitelisted, Ungated),
    ("link_section", Whitelisted, Ungated),
    ("no_builtins", Whitelisted, Ungated),
    ("no_mangle", Whitelisted, Ungated),
N
Nick Cameron 已提交
723 724 725 726 727
    ("no_debug", Whitelisted, Gated(
        Stability::Deprecated("https://github.com/rust-lang/rust/issues/29721"),
        "no_debug",
        "the `#[no_debug]` attribute is an experimental feature",
        cfg_fn!(no_debug))),
728 729
    ("omit_gdb_pretty_printer_section", Whitelisted, Gated(Stability::Unstable,
                                                       "omit_gdb_pretty_printer_section",
730 731
                                                       "the `#[omit_gdb_pretty_printer_section]` \
                                                        attribute is just used for the Rust test \
732 733
                                                        suite",
                                                       cfg_fn!(omit_gdb_pretty_printer_section))),
734 735
    ("unsafe_destructor_blind_to_params",
     Normal,
736
     Gated(Stability::Deprecated("https://github.com/rust-lang/rust/issues/34761"),
737
           "dropck_parametricity",
738 739
           "unsafe_destructor_blind_to_params has been replaced by \
            may_dangle and will be removed in the future",
740
           cfg_fn!(dropck_parametricity))),
741 742
    ("may_dangle",
     Normal,
743 744
     Gated(Stability::Unstable,
           "dropck_eyepatch",
745 746
           "may_dangle has unstable semantics and may be removed in the future",
           cfg_fn!(dropck_eyepatch))),
747 748 749
    ("unwind", Whitelisted, Gated(Stability::Unstable,
                                  "unwind_attributes",
                                  "#[unwind] is experimental",
750
                                  cfg_fn!(unwind_attributes))),
751 752

    // used in resolve
753 754
    ("prelude_import", Whitelisted, Gated(Stability::Unstable,
                                          "prelude_import",
755 756
                                          "`#[prelude_import]` is for use by rustc only",
                                          cfg_fn!(prelude_import))),
757 758 759

    // FIXME: #14407 these are only looked at on-demand so we can't
    // guarantee they'll have already been checked
760
    ("rustc_deprecated", Whitelisted, Ungated),
761 762 763
    ("must_use", Whitelisted, Ungated),
    ("stable", Whitelisted, Ungated),
    ("unstable", Whitelisted, Ungated),
764
    ("deprecated", Normal, Ungated),
765

766 767
    ("rustc_paren_sugar", Normal, Gated(Stability::Unstable,
                                        "unboxed_closures",
768 769
                                        "unboxed_closures are still evolving",
                                        cfg_fn!(unboxed_closures))),
770

771 772 773
    ("windows_subsystem", Whitelisted, Gated(Stability::Unstable,
                                             "windows_subsystem",
                                             "the windows subsystem attribute \
A
Alex Crichton 已提交
774
                                              is currently unstable",
775 776
                                             cfg_fn!(windows_subsystem))),

777 778 779 780 781
    ("proc_macro_attribute", Normal, Gated(Stability::Unstable,
                                           "proc_macro",
                                           "attribute proc macros are currently unstable",
                                           cfg_fn!(proc_macro))),

782 783 784 785 786
    ("proc_macro", Normal, Gated(Stability::Unstable,
                                 "proc_macro",
                                 "function-like proc macros are currently unstable",
                                 cfg_fn!(proc_macro))),

787 788 789 790 791
    ("rustc_derive_registrar", Normal, Gated(Stability::Unstable,
                                             "rustc_derive_registrar",
                                             "used internally by rustc",
                                             cfg_fn!(rustc_attrs))),

792
    // Crate level attributes
793 794 795 796 797 798 799 800
    ("crate_name", CrateLevel, Ungated),
    ("crate_type", CrateLevel, Ungated),
    ("crate_id", CrateLevel, Ungated),
    ("feature", CrateLevel, Ungated),
    ("no_start", CrateLevel, Ungated),
    ("no_main", CrateLevel, Ungated),
    ("no_builtins", CrateLevel, Ungated),
    ("recursion_limit", CrateLevel, Ungated),
801
    ("type_length_limit", CrateLevel, Ungated),
802 803
];

804 805 806
// cfg(...)'s that are feature gated
const GATED_CFGS: &'static [(&'static str, &'static str, fn(&Features) -> bool)] = &[
    // (name in cfg, feature, function to check if the feature is enabled)
807 808 809
    ("target_feature", "cfg_target_feature", cfg_fn!(cfg_target_feature)),
    ("target_vendor", "cfg_target_vendor", cfg_fn!(cfg_target_vendor)),
    ("target_thread_local", "cfg_target_thread_local", cfg_fn!(cfg_target_thread_local)),
810
    ("target_has_atomic", "cfg_target_has_atomic", cfg_fn!(cfg_target_has_atomic)),
811 812 813 814 815 816 817
];

#[derive(Debug, Eq, PartialEq)]
pub struct GatedCfg {
    span: Span,
    index: usize,
}
818

819 820
impl GatedCfg {
    pub fn gate(cfg: &ast::MetaItem) -> Option<GatedCfg> {
821
        let name = cfg.name().as_str();
822 823 824 825 826 827 828 829 830
        GATED_CFGS.iter()
                  .position(|info| info.0 == name)
                  .map(|idx| {
                      GatedCfg {
                          span: cfg.span,
                          index: idx
                      }
                  })
    }
J
Jeffrey Seyfried 已提交
831 832

    pub fn check_and_emit(&self, sess: &ParseSess, features: &Features) {
833
        let (cfg, feature, has_feature) = GATED_CFGS[self.index];
834
        if !has_feature(features) && !self.span.allows_unstable() {
835
            let explain = format!("`cfg({})` is experimental and subject to change", cfg);
836
            emit_feature_err(sess, feature, self.span, GateIssue::Language, &explain);
837 838 839 840
        }
    }
}

E
Eduard Burtescu 已提交
841
struct Context<'a> {
L
Leo Testard 已提交
842
    features: &'a Features,
843
    parse_sess: &'a ParseSess,
844
    plugin_attributes: &'a [(String, AttributeType)],
845 846
}

847 848 849 850 851
macro_rules! gate_feature_fn {
    ($cx: expr, $has_feature: expr, $span: expr, $name: expr, $explain: expr) => {{
        let (cx, has_feature, span, name, explain) = ($cx, $has_feature, $span, $name, $explain);
        let has_feature: bool = has_feature(&$cx.features);
        debug!("gate_feature(feature = {:?}, span = {:?}); has? {}", name, span, has_feature);
852
        if !has_feature && !span.allows_unstable() {
853
            emit_feature_err(cx.parse_sess, name, span, GateIssue::Language, explain);
854
        }
855 856 857 858 859 860
    }}
}

macro_rules! gate_feature {
    ($cx: expr, $feature: ident, $span: expr, $explain: expr) => {
        gate_feature_fn!($cx, |x:&Features| x.$feature, $span, stringify!($feature), $explain)
861
    }
862
}
863

864
impl<'a> Context<'a> {
865
    fn check_attribute(&self, attr: &ast::Attribute, is_macro: bool) {
866
        debug!("check_attribute(attr = {:?})", attr);
867
        let name = unwrap_or!(attr.name(), return).as_str();
868
        for &(n, ty, ref gateage) in BUILTIN_ATTRIBUTES {
869
            if name == n {
870
                if let &Gated(_, ref name, ref desc, ref has_feature) = gateage {
871
                    gate_feature_fn!(self, has_feature, attr.span, name, desc);
872
                }
873
                debug!("check_attribute: {:?} is builtin, {:?}, {:?}", attr.path, ty, gateage);
874 875 876
                return;
            }
        }
877
        for &(ref n, ref ty) in self.plugin_attributes {
878
            if attr.path == &**n {
879
                // Plugins can't gate attributes, so we don't check for it
M
Manish Goregaokar 已提交
880 881
                // unlike the code above; we only use this loop to
                // short-circuit to avoid the checks below
882
                debug!("check_attribute: {:?} is registered by a plugin, {:?}", attr.path, ty);
883 884 885
                return;
            }
        }
886
        if name.starts_with("rustc_") {
887 888 889 890
            gate_feature!(self, rustc_attrs, attr.span,
                          "unless otherwise specified, attributes \
                           with the prefix `rustc_` \
                           are reserved for internal compiler diagnostics");
891
        } else if name.starts_with("derive_") {
L
Leo Testard 已提交
892
            gate_feature!(self, custom_derive, attr.span, EXPLAIN_DERIVE_UNDERSCORE);
893
        } else if !attr::is_known(attr) {
M
Manish Goregaokar 已提交
894 895 896 897
            // 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
898
            if !is_macro {
899 900 901 902 903
                gate_feature!(self, custom_attribute, attr.span,
                              &format!("The attribute `{}` is currently \
                                        unknown to the compiler and \
                                        may have meaning \
                                        added to it in the future",
904
                                       attr.path));
905
            }
906 907
        }
    }
908 909
}

910 911
pub fn check_attribute(attr: &ast::Attribute, parse_sess: &ParseSess, features: &Features) {
    let cx = Context { features: features, parse_sess: parse_sess, plugin_attributes: &[] };
L
Leo Testard 已提交
912 913 914
    cx.check_attribute(attr, true);
}

915 916 917 918
pub fn find_lang_feature_accepted_version(feature: &str) -> Option<&'static str> {
    ACCEPTED_FEATURES.iter().find(|t| t.0 == feature).map(|t| t.1)
}

919
fn find_lang_feature_issue(feature: &str) -> Option<u32> {
920 921
    if let Some(info) = ACTIVE_FEATURES.iter().find(|t| t.0 == feature) {
        let issue = info.2;
922 923
        // FIXME (#28244): enforce that active features have issue numbers
        // assert!(issue.is_some())
924 925
        issue
    } else {
926 927 928 929
        // search in Accepted, Removed, or Stable Removed features
        let found = ACCEPTED_FEATURES.iter().chain(REMOVED_FEATURES).chain(STABLE_REMOVED_FEATURES)
            .find(|t| t.0 == feature);
        match found {
930 931 932
            Some(&(_, _, issue)) => issue,
            None => panic!("Feature `{}` is not declared anywhere", feature),
        }
933 934 935 936 937 938 939 940
    }
}

pub enum GateIssue {
    Language,
    Library(Option<u32>)
}

941
pub fn emit_feature_err(sess: &ParseSess, feature: &str, span: Span, issue: GateIssue,
942
                        explain: &str) {
943 944 945 946 947
    feature_err(sess, feature, span, issue, explain).emit();
}

pub fn feature_err<'a>(sess: &'a ParseSess, feature: &str, span: Span, issue: GateIssue,
                   explain: &str) -> DiagnosticBuilder<'a> {
948 949
    let diag = &sess.span_diagnostic;

950 951 952 953 954
    let issue = match issue {
        GateIssue::Language => find_lang_feature_issue(feature),
        GateIssue::Library(lib) => lib,
    };

N
Nick Cameron 已提交
955 956
    let mut err = if let Some(n) = issue {
        diag.struct_span_err(span, &format!("{} (see issue #{})", explain, n))
957
    } else {
N
Nick Cameron 已提交
958 959
        diag.struct_span_err(span, explain)
    };
960 961

    // #23973: do not suggest `#![feature(...)]` if we are in beta/stable
T
Tim Neumann 已提交
962 963 964 965
    if sess.unstable_features.is_nightly_build() {
        err.help(&format!("add #![feature({})] to the \
                           crate attributes to enable",
                          feature));
N
Nick Cameron 已提交
966
    }
T
Tim Neumann 已提交
967

968
    err
969 970
}

L
Leo Testard 已提交
971 972 973
const EXPLAIN_BOX_SYNTAX: &'static str =
    "box expression syntax is experimental; you can call `Box::new` instead.";

J
Jeffrey Seyfried 已提交
974
pub const EXPLAIN_STMT_ATTR_SYNTAX: &'static str =
L
Leo Testard 已提交
975 976
    "attributes on non-item statements and expressions are experimental.";

977 978 979
pub const EXPLAIN_ASM: &'static str =
    "inline assembly is not stable enough for use and is subject to change";

980 981 982 983 984 985 986 987
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";
988 989
pub const EXPLAIN_ALLOW_INTERNAL_UNSTABLE: &'static str =
    "allow_internal_unstable side-steps feature gating and stability checks";
990

991
pub const EXPLAIN_CUSTOM_DERIVE: &'static str =
992
    "`#[derive]` for custom traits is deprecated and will be removed in the future.";
N
Nick Cameron 已提交
993 994

pub const EXPLAIN_DEPR_CUSTOM_DERIVE: &'static str =
995 996
    "`#[derive]` for custom traits is deprecated and will be removed in the future. \
    Prefer using procedural macro custom derive.";
997

L
Leo Testard 已提交
998 999
pub const EXPLAIN_DERIVE_UNDERSCORE: &'static str =
    "attributes of the form `#[derive_*]` are reserved for the compiler";
1000

L
Leo Testard 已提交
1001 1002
pub const EXPLAIN_PLACEMENT_IN: &'static str =
    "placement-in expression syntax is experimental and subject to change.";
C
Corey Richardson 已提交
1003

E
est31 已提交
1004 1005 1006
pub const CLOSURE_TO_FN_COERCION: &'static str =
    "non-capturing closure to fn coercion is experimental";

C
Corey Richardson 已提交
1007
struct PostExpansionVisitor<'a> {
N
Nick Cameron 已提交
1008
    context: &'a Context<'a>,
C
Corey Richardson 已提交
1009 1010
}

1011 1012 1013
macro_rules! gate_feature_post {
    ($cx: expr, $feature: ident, $span: expr, $explain: expr) => {{
        let (cx, span) = ($cx, $span);
1014
        if !span.allows_unstable() {
1015
            gate_feature!(cx.context, $feature, span, $explain)
C
Corey Richardson 已提交
1016
        }
1017
    }}
C
Corey Richardson 已提交
1018 1019
}

1020 1021 1022
impl<'a> PostExpansionVisitor<'a> {
    fn check_abi(&self, abi: Abi, span: Span) {
        match abi {
1023
            Abi::RustIntrinsic => {
1024
                gate_feature_post!(&self, intrinsics, span,
1025 1026
                                   "intrinsics are subject to change");
            },
1027 1028
            Abi::PlatformIntrinsic => {
                gate_feature_post!(&self, platform_intrinsics, span,
1029
                                   "platform intrinsics are experimental and possibly buggy");
1030 1031 1032
            },
            Abi::Vectorcall => {
                gate_feature_post!(&self, abi_vectorcall, span,
1033 1034
                                   "vectorcall is experimental and subject to change");
            },
1035 1036 1037
            Abi::RustCall => {
                gate_feature_post!(&self, unboxed_closures, span,
                                   "rust-call ABI is subject to change");
1038 1039 1040 1041 1042
            },
            Abi::SysV64 => {
                gate_feature_post!(&self, abi_sysv64, span,
                                   "sysv64 ABI is experimental and subject to change");
            },
J
Jorge Aparicio 已提交
1043 1044 1045
            Abi::PtxKernel => {
                gate_feature_post!(&self, abi_ptx, span,
                                   "PTX ABIs are experimental and subject to change");
1046 1047 1048 1049 1050
            },
            Abi::Unadjusted => {
                gate_feature_post!(&self, abi_unadjusted, span,
                                   "unadjusted ABI is an implementation detail and perma-unstable");
            },
1051 1052 1053 1054
            Abi::Msp430Interrupt => {
                gate_feature_post!(&self, abi_msp430_interrupt, span,
                                   "msp430-interrupt ABI is experimental and subject to change");
            },
1055 1056 1057 1058
            Abi::X86Interrupt => {
                gate_feature_post!(&self, abi_x86_interrupt, span,
                                   "x86-interrupt ABI is experimental and subject to change");
            },
J
Jorge Aparicio 已提交
1059 1060 1061 1062 1063 1064 1065 1066 1067
            // Stable
            Abi::Cdecl |
            Abi::Stdcall |
            Abi::Fastcall |
            Abi::Aapcs |
            Abi::Win64 |
            Abi::Rust |
            Abi::C |
            Abi::System => {}
1068 1069 1070 1071
        }
    }
}

1072 1073 1074 1075 1076
fn contains_novel_literal(item: &ast::MetaItem) -> bool {
    use ast::MetaItemKind::*;
    use ast::NestedMetaItemKind::*;

    match item.node {
1077 1078 1079
        Word => false,
        NameValue(ref lit) => !lit.node.is_str(),
        List(ref list) => list.iter().any(|li| {
1080
            match li.node {
1081
                MetaItem(ref mi) => contains_novel_literal(&mi),
1082 1083 1084 1085 1086 1087
                Literal(_) => true,
            }
        }),
    }
}

1088 1089 1090 1091
fn starts_with_digit(s: &str) -> bool {
    s.as_bytes().first().cloned().map_or(false, |b| b >= b'0' && b <= b'9')
}

1092
impl<'a> Visitor<'a> for PostExpansionVisitor<'a> {
1093
    fn visit_attribute(&mut self, attr: &ast::Attribute) {
1094
        if !attr.span.allows_unstable() {
1095
            // check for gated attributes
1096
            self.context.check_attribute(attr, false);
1097
        }
1098

J
Jeffrey Seyfried 已提交
1099 1100 1101 1102
        if self.context.features.proc_macro && attr::is_known(attr) {
            return
        }

1103 1104
        let meta = panictry!(attr.parse_meta(&self.context.parse_sess));
        if contains_novel_literal(&meta) {
1105 1106 1107 1108
            gate_feature_post!(&self, attr_literals, attr.span,
                               "non-string literals in attributes, or string \
                               literals in top-level positions, are experimental");
        }
1109 1110
    }

1111
    fn visit_name(&mut self, sp: Span, name: ast::Name) {
1112
        if !name.as_str().is_ascii() {
1113 1114
            gate_feature_post!(&self, non_ascii_idents, sp,
                               "non-ascii idents are not fully supported.");
1115 1116 1117
        }
    }

1118
    fn visit_item(&mut self, i: &'a ast::Item) {
1119
        match i.node {
1120
            ast::ItemKind::ExternCrate(_) => {
1121
                if attr::contains_name(&i.attrs[..], "macro_reexport") {
1122 1123 1124
                    gate_feature_post!(&self, macro_reexport, i.span,
                                       "macros reexports are experimental \
                                        and possibly buggy");
1125 1126 1127
                }
            }

1128
            ast::ItemKind::ForeignMod(ref foreign_module) => {
1129
                if attr::contains_name(&i.attrs[..], "link_args") {
1130
                    gate_feature_post!(&self, link_args, i.span,
1131 1132 1133 1134
                                      "the `link_args` attribute is not portable \
                                       across platforms, it is recommended to \
                                       use `#[link(name = \"foo\")]` instead")
                }
1135
                self.check_abi(foreign_module.abi, i.span);
1136 1137
            }

1138
            ast::ItemKind::Fn(..) => {
1139
                if attr::contains_name(&i.attrs[..], "plugin_registrar") {
1140 1141
                    gate_feature_post!(&self, plugin_registrar, i.span,
                                       "compiler plugins are experimental and possibly buggy");
1142
                }
1143
                if attr::contains_name(&i.attrs[..], "start") {
1144
                    gate_feature_post!(&self, start, i.span,
1145 1146 1147 1148
                                      "a #[start] function is an experimental \
                                       feature whose signature may change \
                                       over time");
                }
1149
                if attr::contains_name(&i.attrs[..], "main") {
1150 1151 1152 1153
                    gate_feature_post!(&self, main, i.span,
                                       "declaration of a nonstandard #[main] \
                                        function may change over time, for now \
                                        a top-level `fn main()` is required");
1154
                }
1155 1156
            }

1157
            ast::ItemKind::Struct(..) => {
1158
                if attr::contains_name(&i.attrs[..], "simd") {
1159 1160
                    gate_feature_post!(&self, simd, i.span,
                                       "SIMD types are experimental and possibly buggy");
1161 1162 1163 1164
                    self.context.parse_sess.span_diagnostic.span_warn(i.span,
                                                                      "the `#[simd]` attribute \
                                                                       is deprecated, use \
                                                                       `#[repr(simd)]` instead");
1165 1166
                }
                for attr in &i.attrs {
1167 1168
                    if attr.path == "repr" {
                        for item in attr.meta_item_list().unwrap_or_else(Vec::new) {
1169
                            if item.check_name("simd") {
1170 1171 1172
                                gate_feature_post!(&self, repr_simd, i.span,
                                                   "SIMD types are experimental \
                                                    and possibly buggy");
1173 1174 1175 1176

                            }
                        }
                    }
1177
                }
D
David Manescu 已提交
1178 1179
            }

1180 1181 1182
            ast::ItemKind::Union(..) => {
                gate_feature_post!(&self, untagged_unions,
                                   i.span,
V
Vadim Petrochenkov 已提交
1183
                                   "unions are unstable and possibly buggy");
1184 1185
            }

1186
            ast::ItemKind::DefaultImpl(..) => {
1187 1188 1189 1190
                gate_feature_post!(&self, optin_builtin_traits,
                                   i.span,
                                   "default trait implementations are experimental \
                                    and possibly buggy");
F
Flavio Percoco 已提交
1191 1192
            }

1193
            ast::ItemKind::Impl(_, polarity, _, _, _, _) => {
1194 1195
                match polarity {
                    ast::ImplPolarity::Negative => {
1196 1197 1198 1199
                        gate_feature_post!(&self, optin_builtin_traits,
                                           i.span,
                                           "negative trait bounds are not yet fully implemented; \
                                            use marker types for now");
1200 1201 1202
                    },
                    _ => {}
                }
1203 1204
            }

1205 1206 1207
            _ => {}
        }

1208
        visit::walk_item(self, i);
1209
    }
1210

1211
    fn visit_foreign_item(&mut self, i: &'a ast::ForeignItem) {
1212 1213
        let links_to_llvm = match attr::first_attr_value_str_by_name(&i.attrs, "link_name") {
            Some(val) => val.as_str().starts_with("llvm."),
1214 1215 1216
            _ => false
        };
        if links_to_llvm {
1217
            gate_feature_post!(&self, link_llvm_intrinsics, i.span,
1218 1219 1220
                              "linking to LLVM intrinsics is experimental");
        }

1221
        visit::walk_foreign_item(self, i)
1222 1223
    }

1224
    fn visit_ty(&mut self, ty: &'a ast::Ty) {
1225 1226 1227 1228
        match ty.node {
            ast::TyKind::BareFn(ref bare_fn_ty) => {
                self.check_abi(bare_fn_ty.abi, ty.span);
            }
1229 1230 1231 1232
            ast::TyKind::ImplTrait(..) => {
                gate_feature_post!(&self, conservative_impl_trait, ty.span,
                                   "`impl Trait` is experimental");
            }
A
Andrew Cann 已提交
1233 1234
            ast::TyKind::Never => {
                gate_feature_post!(&self, never_type, ty.span,
1235 1236
                                   "The `!` type is experimental");
            },
1237 1238 1239 1240 1241
            _ => {}
        }
        visit::walk_ty(self, ty)
    }

1242
    fn visit_fn_ret_ty(&mut self, ret_ty: &'a ast::FunctionRetTy) {
1243 1244
        if let ast::FunctionRetTy::Ty(ref output_ty) = *ret_ty {
            match output_ty.node {
A
Andrew Cann 已提交
1245
                ast::TyKind::Never => return,
1246 1247
                _ => (),
            };
A
Andrew Cann 已提交
1248
            self.visit_ty(output_ty)
1249 1250 1251
        }
    }

1252
    fn visit_expr(&mut self, e: &'a ast::Expr) {
1253
        match e.node {
1254
            ast::ExprKind::Box(_) => {
1255
                gate_feature_post!(&self, box_syntax, e.span, EXPLAIN_BOX_SYNTAX);
1256
            }
1257
            ast::ExprKind::Type(..) => {
1258
                gate_feature_post!(&self, type_ascription, e.span,
1259 1260
                                  "type ascription is experimental");
            }
1261
            ast::ExprKind::Range(_, _, ast::RangeLimits::Closed) => {
1262
                gate_feature_post!(&self, inclusive_range_syntax,
A
Alex Burka 已提交
1263 1264 1265
                                  e.span,
                                  "inclusive range syntax is experimental");
            }
1266 1267 1268
            ast::ExprKind::InPlace(..) => {
                gate_feature_post!(&self, placement_in_syntax, e.span, EXPLAIN_PLACEMENT_IN);
            }
1269 1270
            ast::ExprKind::Struct(_, ref fields, _) => {
                for field in fields {
1271 1272 1273 1274 1275
                    if starts_with_digit(&field.ident.node.name.as_str()) {
                        gate_feature_post!(&self, relaxed_adts,
                                          field.span,
                                          "numeric fields in struct expressions are unstable");
                    }
1276 1277
                }
            }
1278 1279 1280 1281
            ast::ExprKind::Break(_, Some(_)) => {
                gate_feature_post!(&self, loop_break_value, e.span,
                                   "`break` with a value is experimental");
            }
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
            ast::ExprKind::Lit(ref lit) => {
                if let ast::LitKind::Int(_, ref ty) = lit.node {
                    match *ty {
                        ast::LitIntType::Signed(ast::IntTy::I128) |
                        ast::LitIntType::Unsigned(ast::UintTy::U128) => {
                            gate_feature_post!(&self, i128_type, e.span,
                                               "128-bit integers are not stable");
                        }
                        _ => {}
                    }
                }
            }
1294 1295 1296
            ast::ExprKind::Catch(_) => {
                gate_feature_post!(&self, catch_expr, e.span, "`catch` expression is experimental");
            }
1297 1298
            _ => {}
        }
1299
        visit::walk_expr(self, e);
1300
    }
1301

1302
    fn visit_pat(&mut self, pattern: &'a ast::Pat) {
1303
        match pattern.node {
1304
            PatKind::Slice(_, Some(_), ref last) if !last.is_empty() => {
1305
                gate_feature_post!(&self, advanced_slice_patterns,
1306 1307 1308
                                  pattern.span,
                                  "multiple-element slice matches anywhere \
                                   but at the end of a slice (e.g. \
1309
                                   `[0, ..xs, 0]`) are experimental")
1310
            }
1311
            PatKind::Slice(..) => {
1312
                gate_feature_post!(&self, slice_patterns,
1313 1314 1315
                                  pattern.span,
                                  "slice pattern syntax is experimental");
            }
1316
            PatKind::Box(..) => {
1317
                gate_feature_post!(&self, box_patterns,
1318
                                  pattern.span,
1319
                                  "box pattern syntax is experimental");
1320
            }
1321 1322 1323 1324 1325 1326 1327 1328
            PatKind::Struct(_, ref fields, _) => {
                for field in fields {
                    if starts_with_digit(&field.node.ident.name.as_str()) {
                        gate_feature_post!(&self, relaxed_adts,
                                          field.span,
                                          "numeric fields in struct patterns are unstable");
                    }
                }
1329
            }
1330 1331 1332 1333
            PatKind::Range(_, _, RangeEnd::Excluded) => {
                gate_feature_post!(&self, exclusive_range_pattern, pattern.span,
                                   "exclusive range pattern syntax is experimental");
            }
1334 1335
            _ => {}
        }
1336
        visit::walk_pat(self, pattern)
1337 1338
    }

1339
    fn visit_fn(&mut self,
1340 1341
                fn_kind: FnKind<'a>,
                fn_decl: &'a ast::FnDecl,
1342
                span: Span,
1343
                _node_id: NodeId) {
N
Niko Matsakis 已提交
1344 1345
        // check for const fn declarations
        match fn_kind {
1346
            FnKind::ItemFn(_, _, _, Spanned { node: ast::Constness::Const, .. }, _, _, _) => {
1347
                gate_feature_post!(&self, const_fn, span, "const fn is unstable");
N
Niko Matsakis 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356
            }
            _ => {
                // 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.
            }
        }

1357
        match fn_kind {
1358 1359
            FnKind::ItemFn(_, _, _, _, abi, _, _) |
            FnKind::Method(_, &ast::MethodSig { abi, .. }, _, _) => {
1360 1361
                self.check_abi(abi, span);
            }
1362 1363
            _ => {}
        }
1364
        visit::walk_fn(self, fn_kind, fn_decl, span);
1365
    }
1366

1367
    fn visit_trait_item(&mut self, ti: &'a ast::TraitItem) {
1368
        match ti.node {
1369
            ast::TraitItemKind::Const(..) => {
1370
                gate_feature_post!(&self, associated_consts,
1371 1372 1373
                                  ti.span,
                                  "associated constants are experimental")
            }
1374 1375 1376 1377
            ast::TraitItemKind::Method(ref sig, ref block) => {
                if block.is_none() {
                    self.check_abi(sig.abi, ti.span);
                }
1378
                if sig.constness.node == ast::Constness::Const {
1379
                    gate_feature_post!(&self, const_fn, ti.span, "const fn is unstable");
N
Niko Matsakis 已提交
1380 1381
                }
            }
1382
            ast::TraitItemKind::Type(_, Some(_)) => {
1383
                gate_feature_post!(&self, associated_type_defaults, ti.span,
1384 1385
                                  "associated type defaults are unstable");
            }
1386 1387 1388 1389 1390
            _ => {}
        }
        visit::walk_trait_item(self, ti);
    }

1391
    fn visit_impl_item(&mut self, ii: &'a ast::ImplItem) {
A
Aaron Turon 已提交
1392
        if ii.defaultness == ast::Defaultness::Default {
1393
            gate_feature_post!(&self, specialization,
A
Aaron Turon 已提交
1394 1395 1396 1397
                              ii.span,
                              "specialization is unstable");
        }

1398
        match ii.node {
1399
            ast::ImplItemKind::Const(..) => {
1400
                gate_feature_post!(&self, associated_consts,
1401 1402 1403
                                  ii.span,
                                  "associated constants are experimental")
            }
1404
            ast::ImplItemKind::Method(ref sig, _) => {
1405
                if sig.constness.node == ast::Constness::Const {
1406
                    gate_feature_post!(&self, const_fn, ii.span, "const fn is unstable");
N
Niko Matsakis 已提交
1407 1408
                }
            }
1409 1410 1411 1412
            _ => {}
        }
        visit::walk_impl_item(self, ii);
    }
1413

1414
    fn visit_generics(&mut self, g: &'a ast::Generics) {
1415 1416 1417 1418 1419 1420 1421 1422 1423
        for t in &g.ty_params {
            if !t.attrs.is_empty() {
                gate_feature_post!(&self, generic_param_attrs, t.attrs[0].span,
                                   "attributes on type parameter bindings are experimental");
            }
        }
        visit::walk_generics(self, g)
    }

1424
    fn visit_lifetime_def(&mut self, lifetime_def: &'a ast::LifetimeDef) {
1425 1426 1427 1428 1429 1430
        if !lifetime_def.attrs.is_empty() {
            gate_feature_post!(&self, generic_param_attrs, lifetime_def.attrs[0].span,
                               "attributes on lifetime bindings are experimental");
        }
        visit::walk_lifetime_def(self, lifetime_def)
    }
1431 1432
}

J
Jeffrey Seyfried 已提交
1433
pub fn get_features(span_handler: &Handler, krate_attrs: &[ast::Attribute]) -> Features {
1434
    let mut features = Features::new();
N
Nick Cameron 已提交
1435

1436 1437
    let mut feature_checker = MutexFeatureChecker::default();

J
Jeffrey Seyfried 已提交
1438
    for attr in krate_attrs {
S
Steven Fackler 已提交
1439
        if !attr.check_name("feature") {
1440 1441
            continue
        }
1442 1443 1444

        match attr.meta_item_list() {
            None => {
G
ggomez 已提交
1445 1446
                span_err!(span_handler, attr.span, E0555,
                          "malformed feature attribute, expected #![feature(...)]");
1447 1448
            }
            Some(list) => {
1449
                for mi in list {
1450 1451 1452 1453 1454 1455 1456 1457
                    let name = if let Some(word) = mi.word() {
                        word.name()
                    } else {
                        span_err!(span_handler, mi.span, E0556,
                                  "malformed feature, expected just one word");
                        continue
                    };

1458 1459 1460
                    if let Some(&(_, _, _, setter)) = ACTIVE_FEATURES.iter()
                        .find(|& &(n, _, _, _)| name == n) {
                        *(setter(&mut features)) = true;
1461
                        feature_checker.collect(&features, mi.span);
1462 1463
                    }
                    else if let Some(&(_, _, _)) = REMOVED_FEATURES.iter()
1464 1465 1466
                            .find(|& &(n, _, _)| name == n)
                        .or_else(|| STABLE_REMOVED_FEATURES.iter()
                            .find(|& &(n, _, _)| name == n)) {
G
ggomez 已提交
1467
                        span_err!(span_handler, mi.span, E0557, "feature has been removed");
1468 1469 1470
                    }
                    else if let Some(&(_, _, _)) = ACCEPTED_FEATURES.iter()
                        .find(|& &(n, _, _)| name == n) {
1471
                        features.declared_stable_lang_features.push((name, mi.span));
1472 1473
                    } else {
                        features.declared_lib_features.push((name, mi.span));
1474 1475 1476 1477 1478 1479
                    }
                }
            }
        }
    }

1480 1481
    feature_checker.check(span_handler);

L
Leo Testard 已提交
1482
    features
C
Corey Richardson 已提交
1483 1484
}

1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
// A collector for mutually-exclusive features and their flag spans
#[derive(Default)]
struct MutexFeatureChecker {
    proc_macro: Option<Span>,
    custom_attribute: Option<Span>,
}

impl MutexFeatureChecker {
    // If this method turns out to be a hotspot due to branching,
    // the branching can be eliminated by modifying `setter!()` to set these spans
    // only for the features that need to be checked for mutual exclusion.
    fn collect(&mut self, features: &Features, span: Span) {
        if features.proc_macro {
            // If self.proc_macro is None, set to Some(span)
            self.proc_macro = self.proc_macro.or(Some(span));
        }

        if features.custom_attribute {
            self.custom_attribute = self.custom_attribute.or(Some(span));
        }
    }

    fn check(self, handler: &Handler) {
        if let (Some(pm_span), Some(ca_span)) = (self.proc_macro, self.custom_attribute) {
            handler.struct_span_err(pm_span, "Cannot use `#![feature(proc_macro)]` and \
                                              `#![feature(custom_attribute)] at the same time")
                .span_note(ca_span, "`#![feature(custom_attribute)]` declared here")
                .emit();

            panic!(FatalError);
        }
    }
}

J
Jeffrey Seyfried 已提交
1519 1520 1521
pub fn check_crate(krate: &ast::Crate,
                   sess: &ParseSess,
                   features: &Features,
1522
                   plugin_attributes: &[(String, AttributeType)],
J
Jeffrey Seyfried 已提交
1523 1524 1525 1526
                   unstable: UnstableFeatures) {
    maybe_stage_features(&sess.span_diagnostic, krate, unstable);
    let ctx = Context {
        features: features,
1527
        parse_sess: sess,
J
Jeffrey Seyfried 已提交
1528 1529 1530
        plugin_attributes: plugin_attributes,
    };
    visit::walk_crate(&mut PostExpansionVisitor { context: &ctx }, krate);
C
Corey Richardson 已提交
1531
}
1532

1533
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
1534 1535 1536 1537
pub enum UnstableFeatures {
    /// Hard errors for unstable features are active, as on
    /// beta/stable channels.
    Disallow,
J
John Hodge 已提交
1538
    /// Allow features to be activated, as on nightly.
1539 1540 1541 1542
    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
1543
    /// features. As a result, this is always required for building Rust itself.
1544 1545 1546
    Cheat
}

T
Tim Neumann 已提交
1547 1548 1549 1550
impl UnstableFeatures {
    pub fn from_environment() -> UnstableFeatures {
        // Whether this is a feature-staged build, i.e. on the beta or stable channel
        let disable_unstable_features = option_env!("CFG_DISABLE_UNSTABLE_FEATURES").is_some();
1551 1552 1553 1554 1555 1556
        // Whether we should enable unstable features for bootstrapping
        let bootstrap = env::var("RUSTC_BOOTSTRAP").is_ok();
        match (disable_unstable_features, bootstrap) {
            (_, true) => UnstableFeatures::Cheat,
            (true, _) => UnstableFeatures::Disallow,
            (false, _) => UnstableFeatures::Allow
T
Tim Neumann 已提交
1557 1558
        }
    }
1559 1560 1561 1562 1563 1564 1565

    pub fn is_nightly_build(&self) -> bool {
        match *self {
            UnstableFeatures::Allow | UnstableFeatures::Cheat => true,
            _ => false,
        }
    }
T
Tim Neumann 已提交
1566 1567
}

1568
fn maybe_stage_features(span_handler: &Handler, krate: &ast::Crate,
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
                        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)");
G
ggomez 已提交
1579
                span_err!(span_handler, attr.span, E0554,
G
ggomez 已提交
1580 1581
                          "#[feature] may not be used on the {} release channel",
                          release_channel);
1582 1583 1584 1585
            }
        }
    }
}