src/libsyntax/feature_gate/active.rs

   1 //! List of the active feature gates.
   2
   3 use super::{State, Feature};
   4
   5 use crate::edition::Edition;
   6 use crate::symbol::{Symbol, sym};
   7
   8 use syntax_pos::Span;
   9
  10 macro_rules! set {
  11     ($field: ident) => {{
  12         fn f(features: &mut Features, _: Span) {
  13             features.$field = true;
  14         }
  15         f as fn(&mut Features, Span)
  16     }}
  17 }
  18
  19 macro_rules! declare_features {
  20     ($(
  21         $(#[doc = $doc:tt])* (active, $feature:ident, $ver:expr, $issue:expr, $edition:expr),
  22     )+) => {
  23         /// Represents active features that are currently being implemented or
  24         /// currently being considered for addition/removal.
  25         pub const ACTIVE_FEATURES:
  26             &[Feature] =
  27             &[$(
  28                 // (sym::$feature, $ver, $issue, $edition, set!($feature))
  29                 Feature {
  30                     state: State::Active { set: set!($feature) },
  31                     name: sym::$feature,
  32                     since: $ver,
  33                     issue: $issue,
  34                     edition: $edition,
  35                     description: concat!($($doc,)*),
  36                 }
  37             ),+];
  38
  39         /// A set of features to be used by later passes.
  40         #[derive(Clone)]
  41         pub struct Features {
  42             /// `#![feature]` attrs for language features, for error reporting.
  43             pub declared_lang_features: Vec<(Symbol, Span, Option<Symbol>)>,
  44             /// `#![feature]` attrs for non-language (library) features.
  45             pub declared_lib_features: Vec<(Symbol, Span)>,
  46             $(
  47                 $(#[doc = $doc])*
  48                 pub $feature: bool
  49             ),+
  50         }
  51
  52         impl Features {
  53             pub fn new() -> Features {
  54                 Features {
  55                     declared_lang_features: Vec::new(),
  56                     declared_lib_features: Vec::new(),
  57                     $($feature: false),+
  58                 }
  59             }
  60
  61             pub fn walk_feature_fields<F>(&self, mut f: F)
  62                 where F: FnMut(&str, bool)
  63             {
  64                 $(f(stringify!($feature), self.$feature);)+
  65             }
  66         }
  67     };
  68 }
  69
  70 impl Feature {
  71     /// Sets this feature in `Features`. Panics if called on a non-active feature.
  72     pub fn set(&self, features: &mut Features, span: Span) {
  73         match self.state {
  74             State::Active { set } => set(features, span),
  75             _ => panic!("called `set` on feature `{}` which is not `active`", self.name)
  76         }
  77     }
  78 }
  79
  80 // If you change this, please modify `src/doc/unstable-book` as well.
  81 //
  82 // Don't ever remove anything from this list; move them to `removed.rs`.
  83 //
  84 // The version numbers here correspond to the version in which the current status
  85 // was set. This is most important for knowing when a particular feature became
  86 // stable (active).
  87 //
  88 // Note that the features are grouped into internal/user-facing and then
  89 // sorted by version inside those groups. This is enforced with tidy.
  90 //
  91 // N.B., `tools/tidy/src/features.rs` parses this information directly out of the
  92 // source, so take care when modifying it.
  93
  94 declare_features! (
  95     // -------------------------------------------------------------------------
  96     // feature-group-start: internal feature gates
  97     // -------------------------------------------------------------------------
  98
  99     // no-tracking-issue-start
 100
 101     /// Allows using compiler's own crates.
 102     (active, rustc_private, "1.0.0", Some(27812), None),
 103
 104     /// Allows using the `rust-intrinsic`'s "ABI".
 105     (active, intrinsics, "1.0.0", None, None),
 106
 107     /// Allows using `#[lang = ".."]` attribute for linking items to special compiler logic.
 108     (active, lang_items, "1.0.0", None, None),
 109
 110     /// Allows using the `#[stable]` and `#[unstable]` attributes.
 111     (active, staged_api, "1.0.0", None, None),
 112
 113     /// Allows using `#[allow_internal_unstable]`. This is an
 114     /// attribute on `macro_rules!` and can't use the attribute handling
 115     /// below (it has to be checked before expansion possibly makes
 116     /// macros disappear).
 117     (active, allow_internal_unstable, "1.0.0", None, None),
 118
 119     /// Allows using `#[allow_internal_unsafe]`. This is an
 120     /// attribute on `macro_rules!` and can't use the attribute handling
 121     /// below (it has to be checked before expansion possibly makes
 122     /// macros disappear).
 123     (active, allow_internal_unsafe, "1.0.0", None, None),
 124
 125     /// Allows using `#[rustc_const_unstable(feature = "foo", ..)]` which
 126     /// lets a function to be `const` when opted into with `#![feature(foo)]`.
 127     (active, rustc_const_unstable, "1.0.0", None, None),
 128
 129     /// no-tracking-issue-end
 130
 131     /// Allows using `#[link_name="llvm.*"]`.
 132     (active, link_llvm_intrinsics, "1.0.0", Some(29602), None),
 133
 134     /// Allows using `rustc_*` attributes (RFC 572).
 135     (active, rustc_attrs, "1.0.0", Some(29642), None),
 136
 137     /// Allows using the `box $expr` syntax.
 138     (active, box_syntax, "1.0.0", Some(49733), None),
 139
 140     /// Allows using `#[main]` to replace the entrypoint `#[lang = "start"]` calls.
 141     (active, main, "1.0.0", Some(29634), None),
 142
 143     /// Allows using `#[start]` on a function indicating that it is the program entrypoint.
 144     (active, start, "1.0.0", Some(29633), None),
 145
 146     /// Allows using the `#[fundamental]` attribute.
 147     (active, fundamental, "1.0.0", Some(29635), None),
 148
 149     /// Allows using the `rust-call` ABI.
 150     (active, unboxed_closures, "1.0.0", Some(29625), None),
 151
 152     /// Allows using the `#[linkage = ".."]` attribute.
 153     (active, linkage, "1.0.0", Some(29603), None),
 154
 155     /// Allows features specific to OIBIT (auto traits).
 156     (active, optin_builtin_traits, "1.0.0", Some(13231), None),
 157
 158     /// Allows using `box` in patterns (RFC 469).
 159     (active, box_patterns, "1.0.0", Some(29641), None),
 160
 161     // no-tracking-issue-start
 162
 163     /// Allows using `#[prelude_import]` on glob `use` items.
 164     (active, prelude_import, "1.2.0", None, None),
 165
 166     // no-tracking-issue-end
 167
 168     // no-tracking-issue-start
 169
 170     /// Allows using `#[omit_gdb_pretty_printer_section]`.
 171     (active, omit_gdb_pretty_printer_section, "1.5.0", None, None),
 172
 173     /// Allows using the `vectorcall` ABI.
 174     (active, abi_vectorcall, "1.7.0", None, None),
 175
 176     // no-tracking-issue-end
 177
 178     /// Allows using `#[structural_match]` which indicates that a type is structurally matchable.
 179     (active, structural_match, "1.8.0", Some(31434), None),
 180
 181     /// Allows using the `may_dangle` attribute (RFC 1327).
 182     (active, dropck_eyepatch, "1.10.0", Some(34761), None),
 183
 184     /// Allows using the `#![panic_runtime]` attribute.
 185     (active, panic_runtime, "1.10.0", Some(32837), None),
 186
 187     /// Allows declaring with `#![needs_panic_runtime]` that a panic runtime is needed.
 188     (active, needs_panic_runtime, "1.10.0", Some(32837), None),
 189
 190     // no-tracking-issue-start
 191
 192     /// Allows identifying the `compiler_builtins` crate.
 193     (active, compiler_builtins, "1.13.0", None, None),
 194
 195     /// Allows using the `unadjusted` ABI; perma-unstable.
 196     (active, abi_unadjusted, "1.16.0", None, None),
 197
 198     /// Allows identifying crates that contain sanitizer runtimes.
 199     (active, sanitizer_runtime, "1.17.0", None, None),
 200
 201     /// Used to identify crates that contain the profiler runtime.
 202     (active, profiler_runtime, "1.18.0", None, None),
 203
 204     /// Allows using the `thiscall` ABI.
 205     (active, abi_thiscall, "1.19.0", None, None),
 206
 207     /// Allows using `#![needs_allocator]`, an implementation detail of `#[global_allocator]`.
 208     (active, allocator_internals, "1.20.0", None, None),
 209
 210     /// Added for testing E0705; perma-unstable.
 211     (active, test_2018_feature, "1.31.0", None, Some(Edition::Edition2018)),
 212
 213     // no-tracking-issue-end
 214
 215     // -------------------------------------------------------------------------
 216     // feature-group-end: internal feature gates
 217     // -------------------------------------------------------------------------
 218
 219     // -------------------------------------------------------------------------
 220     // feature-group-start: actual feature gates (target features)
 221     // -------------------------------------------------------------------------
 222
 223     // FIXME: Document these and merge with the list below.
 224
 225     // Unstable `#[target_feature]` directives.
 226     (active, arm_target_feature, "1.27.0", Some(44839), None),
 227     (active, aarch64_target_feature, "1.27.0", Some(44839), None),
 228     (active, hexagon_target_feature, "1.27.0", Some(44839), None),
 229     (active, powerpc_target_feature, "1.27.0", Some(44839), None),
 230     (active, mips_target_feature, "1.27.0", Some(44839), None),
 231     (active, avx512_target_feature, "1.27.0", Some(44839), None),
 232     (active, mmx_target_feature, "1.27.0", Some(44839), None),
 233     (active, sse4a_target_feature, "1.27.0", Some(44839), None),
 234     (active, tbm_target_feature, "1.27.0", Some(44839), None),
 235     (active, wasm_target_feature, "1.30.0", Some(44839), None),
 236     (active, adx_target_feature, "1.32.0", Some(44839), None),
 237     (active, cmpxchg16b_target_feature, "1.32.0", Some(44839), None),
 238     (active, movbe_target_feature, "1.34.0", Some(44839), None),
 239     (active, rtm_target_feature, "1.35.0", Some(44839), None),
 240     (active, f16c_target_feature, "1.36.0", Some(44839), None),
 241
 242     // -------------------------------------------------------------------------
 243     // feature-group-end: actual feature gates (target features)
 244     // -------------------------------------------------------------------------
 245
 246     // -------------------------------------------------------------------------
 247     // feature-group-start: actual feature gates
 248     // -------------------------------------------------------------------------
 249
 250     /// Allows using the `#[link_args]` attribute.
 251     (active, link_args, "1.0.0", Some(29596), None),
 252
 253     /// Allows defining identifiers beyond ASCII.
 254     (active, non_ascii_idents, "1.0.0", Some(55467), None),
 255
 256     /// Allows using `#[plugin_registrar]` on functions.
 257     (active, plugin_registrar, "1.0.0", Some(29597), None),
 258
 259     /// Allows using `#![plugin(myplugin)]`.
 260     (active, plugin, "1.0.0", Some(29597), None),
 261
 262     /// Allows using `#[thread_local]` on `static` items.
 263     (active, thread_local, "1.0.0", Some(29594), None),
 264
 265     /// Allows the use of SIMD types in functions declared in `extern` blocks.
 266     (active, simd_ffi, "1.0.0", Some(27731), None),
 267
 268     /// Allows using non lexical lifetimes (RFC 2094).
 269     (active, nll, "1.0.0", Some(43234), None),
 270
 271     /// Allows using slice patterns.
 272     (active, slice_patterns, "1.0.0", Some(62254), None),
 273
 274     /// Allows the definition of `const` functions with some advanced features.
 275     (active, const_fn, "1.2.0", Some(57563), None),
 276
 277     /// Allows associated type defaults.
 278     (active, associated_type_defaults, "1.2.0", Some(29661), None),
 279
 280     /// Allows `#![no_core]`.
 281     (active, no_core, "1.3.0", Some(29639), None),
 282
 283     /// Allows default type parameters to influence type inference.
 284     (active, default_type_parameter_fallback, "1.3.0", Some(27336), None),
 285
 286     /// Allows `repr(simd)` and importing the various simd intrinsics.
 287     (active, repr_simd, "1.4.0", Some(27731), None),
 288
 289     /// Allows `extern "platform-intrinsic" { ... }`.
 290     (active, platform_intrinsics, "1.4.0", Some(27731), None),
 291
 292     /// Allows `#[unwind(..)]`.
 293     ///
 294     /// Permits specifying whether a function should permit unwinding or abort on unwind.
 295     (active, unwind_attributes, "1.4.0", Some(58760), None),
 296
 297     /// Allows `#[no_debug]`.
 298     (active, no_debug, "1.5.0", Some(29721), None),
 299
 300     /// Allows attributes on expressions and non-item statements.
 301     (active, stmt_expr_attributes, "1.6.0", Some(15701), None),
 302
 303     /// Allows the use of type ascription in expressions.
 304     (active, type_ascription, "1.6.0", Some(23416), None),
 305
 306     /// Allows `cfg(target_thread_local)`.
 307     (active, cfg_target_thread_local, "1.7.0", Some(29594), None),
 308
 309     /// Allows specialization of implementations (RFC 1210).
 310     (active, specialization, "1.7.0", Some(31844), None),
 311
 312     /// Allows using `#[naked]` on functions.
 313     (active, naked_functions, "1.9.0", Some(32408), None),
 314
 315     /// Allows `cfg(target_has_atomic = "...")`.
 316     (active, cfg_target_has_atomic, "1.9.0", Some(32976), None),
 317
 318     /// Allows `X..Y` patterns.
 319     (active, exclusive_range_pattern, "1.11.0", Some(37854), None),
 320
 321     /// Allows exhaustive pattern matching on types that contain uninhabited types.
 322     (active, exhaustive_patterns, "1.13.0", Some(51085), None),
 323
 324     /// Allows `union`s to implement `Drop`. Moreover, `union`s may now include fields
 325     /// that don't implement `Copy` as long as they don't have any drop glue.
 326     /// This is checked recursively. On encountering type variable where no progress can be made,
 327     /// `T: Copy` is used as a substitute for "no drop glue".
 328     ///
 329     /// NOTE: A limited form of `union U { ... }` was accepted in 1.19.0.
 330     (active, untagged_unions, "1.13.0", Some(55149), None),
 331
 332     /// Allows `#[link(..., cfg(..))]`.
 333     (active, link_cfg, "1.14.0", Some(37406), None),
 334
 335     /// Allows `extern "ptx-*" fn()`.
 336     (active, abi_ptx, "1.15.0", Some(38788), None),
 337
 338     /// Allows the `#[repr(i128)]` attribute for enums.
 339     (active, repr128, "1.16.0", Some(35118), None),
 340
 341     /// Allows `#[link(kind="static-nobundle"...)]`.
 342     (active, static_nobundle, "1.16.0", Some(37403), None),
 343
 344     /// Allows `extern "msp430-interrupt" fn()`.
 345     (active, abi_msp430_interrupt, "1.16.0", Some(38487), None),
 346
 347     /// Allows declarative macros 2.0 (`macro`).
 348     (active, decl_macro, "1.17.0", Some(39412), None),
 349
 350     /// Allows `extern "x86-interrupt" fn()`.
 351     (active, abi_x86_interrupt, "1.17.0", Some(40180), None),
 352
 353     /// Allows overlapping impls of marker traits.
 354     (active, overlapping_marker_traits, "1.18.0", Some(29864), None),
 355
 356     /// Allows a test to fail without failing the whole suite.
 357     (active, allow_fail, "1.19.0", Some(46488), None),
 358
 359     /// Allows unsized tuple coercion.
 360     (active, unsized_tuple_coercion, "1.20.0", Some(42877), None),
 361
 362     /// Allows defining generators.
 363     (active, generators, "1.21.0", Some(43122), None),
 364
 365     /// Allows `#[doc(cfg(...))]`.
 366     (active, doc_cfg, "1.21.0", Some(43781), None),
 367
 368     /// Allows `#[doc(masked)]`.
 369     (active, doc_masked, "1.21.0", Some(44027), None),
 370
 371     /// Allows `#[doc(spotlight)]`.
 372     (active, doc_spotlight, "1.22.0", Some(45040), None),
 373
 374     /// Allows `#[doc(include = "some-file")]`.
 375     (active, external_doc, "1.22.0", Some(44732), None),
 376
 377     /// Allows using `crate` as visibility modifier, synonymous with `pub(crate)`.
 378     (active, crate_visibility_modifier, "1.23.0", Some(53120), None),
 379
 380     /// Allows defining `extern type`s.
 381     (active, extern_types, "1.23.0", Some(43467), None),
 382
 383     /// Allows trait methods with arbitrary self types.
 384     (active, arbitrary_self_types, "1.23.0", Some(44874), None),
 385
 386     /// Allows in-band quantification of lifetime bindings (e.g., `fn foo(x: &'a u8) -> &'a u8`).
 387     (active, in_band_lifetimes, "1.23.0", Some(44524), None),
 388
 389     /// Allows associated types to be generic, e.g., `type Foo<T>;` (RFC 1598).
 390     (active, generic_associated_types, "1.23.0", Some(44265), None),
 391
 392     /// Allows defining `trait X = A + B;` alias items.
 393     (active, trait_alias, "1.24.0", Some(41517), None),
 394
 395     /// Allows infering `'static` outlives requirements (RFC 2093).
 396     (active, infer_static_outlives_requirements, "1.26.0", Some(54185), None),
 397
 398     /// Allows accessing fields of unions inside `const` functions.
 399     (active, const_fn_union, "1.27.0", Some(51909), None),
 400
 401     /// Allows casting raw pointers to `usize` during const eval.
 402     (active, const_raw_ptr_to_usize_cast, "1.27.0", Some(51910), None),
 403
 404     /// Allows dereferencing raw pointers during const eval.
 405     (active, const_raw_ptr_deref, "1.27.0", Some(51911), None),
 406
 407     /// Allows comparing raw pointers during const eval.
 408     (active, const_compare_raw_pointers, "1.27.0", Some(53020), None),
 409
 410     /// Allows `#[doc(alias = "...")]`.
 411     (active, doc_alias, "1.27.0", Some(50146), None),
 412
 413     /// Allows inconsistent bounds in where clauses.
 414     (active, trivial_bounds, "1.28.0", Some(48214), None),
 415
 416     /// Allows `'a: { break 'a; }`.
 417     (active, label_break_value, "1.28.0", Some(48594), None),
 418
 419     /// Allows using `#[doc(keyword = "...")]`.
 420     (active, doc_keyword, "1.28.0", Some(51315), None),
 421
 422     /// Allows reinterpretation of the bits of a value of one type as another
 423     /// type during const eval.
 424     (active, const_transmute, "1.29.0", Some(53605), None),
 425
 426     /// Allows using `try {...}` expressions.
 427     (active, try_blocks, "1.29.0", Some(31436), None),
 428
 429     /// Allows defining an `#[alloc_error_handler]`.
 430     (active, alloc_error_handler, "1.29.0", Some(51540), None),
 431
 432     /// Allows using the `amdgpu-kernel` ABI.
 433     (active, abi_amdgpu_kernel, "1.29.0", Some(51575), None),
 434
 435     /// Allows panicking during const eval (producing compile-time errors).
 436     (active, const_panic, "1.30.0", Some(51999), None),
 437
 438     /// Allows `#[marker]` on certain traits allowing overlapping implementations.
 439     (active, marker_trait_attr, "1.30.0", Some(29864), None),
 440
 441     /// Allows macro invocations on modules expressions and statements and
 442     /// procedural macros to expand to non-items.
 443     (active, proc_macro_hygiene, "1.30.0", Some(54727), None),
 444
 445     /// Allows unsized rvalues at arguments and parameters.
 446     (active, unsized_locals, "1.30.0", Some(48055), None),
 447
 448     /// Allows custom test frameworks with `#![test_runner]` and `#[test_case]`.
 449     (active, custom_test_frameworks, "1.30.0", Some(50297), None),
 450
 451     /// Allows non-builtin attributes in inner attribute position.
 452     (active, custom_inner_attributes, "1.30.0", Some(54726), None),
 453
 454     /// Allows `impl Trait` in bindings (`let`, `const`, `static`).
 455     (active, impl_trait_in_bindings, "1.30.0", Some(63065), None),
 456
 457     /// Allows using `reason` in lint attributes and the `#[expect(lint)]` lint check.
 458     (active, lint_reasons, "1.31.0", Some(54503), None),
 459
 460     /// Allows exhaustive integer pattern matching on `usize` and `isize`.
 461     (active, precise_pointer_size_matching, "1.32.0", Some(56354), None),
 462
 463     /// Allows using `#[ffi_returns_twice]` on foreign functions.
 464     (active, ffi_returns_twice, "1.34.0", Some(58314), None),
 465
 466     /// Allows const generic types (e.g. `struct Foo<const N: usize>(...);`).
 467     (active, const_generics, "1.34.0", Some(44580), None),
 468
 469     /// Allows using `#[optimize(X)]`.
 470     (active, optimize_attribute, "1.34.0", Some(54882), None),
 471
 472     /// Allows using C-variadics.
 473     (active, c_variadic, "1.34.0", Some(44930), None),
 474
 475     /// Allows the user of associated type bounds.
 476     (active, associated_type_bounds, "1.34.0", Some(52662), None),
 477
 478     /// Allows `if/while p && let q = r && ...` chains.
 479     (active, let_chains, "1.37.0", Some(53667), None),
 480
 481     /// Allows #[repr(transparent)] on enums (RFC 2645).
 482     (active, transparent_enums, "1.37.0", Some(60405), None),
 483
 484     /// Allows #[repr(transparent)] on unions (RFC 2645).
 485     (active, transparent_unions, "1.37.0", Some(60405), None),
 486
 487     /// Allows explicit discriminants on non-unit enum variants.
 488     (active, arbitrary_enum_discriminant, "1.37.0", Some(60553), None),
 489
 490     /// Allows `impl Trait` with multiple unrelated lifetimes.
 491     (active, member_constraints, "1.37.0", Some(61977), None),
 492
 493     /// Allows `async || body` closures.
 494     (active, async_closure, "1.37.0", Some(62290), None),
 495
 496     /// Allows `[x; N]` where `x` is a constant (RFC 2203).
 497     (active, const_in_array_repeat_expressions, "1.37.0", Some(49147), None),
 498
 499     /// Allows `impl Trait` to be used inside type aliases (RFC 2515).
 500     (active, type_alias_impl_trait, "1.38.0", Some(63063), None),
 501
 502     /// Allows the use of or-patterns (e.g., `0 | 1`).
 503     (active, or_patterns, "1.38.0", Some(54883), None),
 504
 505     /// Allows the definition of `const extern fn` and `const unsafe extern fn`.
 506     (active, const_extern_fn, "1.40.0", Some(64926), None),
 507
 508     /// Allows the use of raw-dylibs (RFC 2627).
 509     (active, raw_dylib, "1.40.0", Some(58713), None),
 510
 511     /// Allows `#[track_caller]` to be used which provides
 512     /// accurate caller location reporting during panic (RFC 2091).
 513     (active, track_caller, "1.40.0", Some(47809), None),
 514
 515     /// Allows making `dyn Trait` well-formed even if `Trait` is not object safe.
 516     /// In that case, `dyn Trait: Trait` does not hold. Moreover, coercions and
 517     /// casts in safe Rust to `dyn Trait` for such a `Trait` is also forbidden.
 518     (active, object_safe_for_dispatch, "1.40.0", Some(43561), None),
 519
 520     /// Allows using the `efiapi` ABI.
 521     (active, abi_efiapi, "1.40.0", Some(65815), None),
 522
 523     /// Allows `&raw const $place_expr` and `&raw mut $place_expr` expressions.
 524     (active, raw_ref_op, "1.41.0", Some(64490), None),
 525
 526     /// Allows diverging expressions to fall back to `!` rather than `()`.
 527     (active, never_type_fallback, "1.41.0", Some(65992), None),
 528
 529     /// Allows using the `#[register_attr]` attribute.
 530     (active, register_attr, "1.41.0", Some(66080), None),
 531
 532     /// Allows using the `#[register_tool]` attribute.
 533     (active, register_tool, "1.41.0", Some(66079), None),
 534
 535     /// Allows the use of `if` and `match` in constants.
 536     (active, const_if_match, "1.41.0", Some(49146), None),
 537
 538     // -------------------------------------------------------------------------
 539     // feature-group-end: actual feature gates
 540     // -------------------------------------------------------------------------
 541 );
 542
 543 /// Some features are known to be incomplete and using them is likely to have
 544 /// unanticipated results, such as compiler crashes. We warn the user about these
 545 /// to alert them.
 546 pub const INCOMPLETE_FEATURES: &[Symbol] = &[
 547     sym::impl_trait_in_bindings,
 548     sym::generic_associated_types,
 549     sym::const_generics,
 550     sym::or_patterns,
 551     sym::let_chains,
 552     sym::raw_dylib,
 553     sym::track_caller,
 554 ];