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