rustc_builtin_macros/
lib.rs

1//! This crate contains implementations of built-in macros and other code generating facilities
2//! injecting code into the crate before it is lowered to HIR.
3
4// tidy-alphabetical-start
5#![allow(internal_features)]
6#![allow(rustc::diagnostic_outside_of_impl)]
7#![allow(rustc::untranslatable_diagnostic)]
8#![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
9#![doc(rust_logo)]
10#![feature(assert_matches)]
11#![feature(autodiff)]
12#![feature(box_patterns)]
13#![feature(decl_macro)]
14#![feature(if_let_guard)]
15#![feature(proc_macro_internals)]
16#![feature(proc_macro_quote)]
17#![feature(rustdoc_internals)]
18#![feature(try_blocks)]
19#![recursion_limit = "256"]
20// tidy-alphabetical-end
21
22use std::sync::Arc;
23
24use rustc_expand::base::{MacroExpanderFn, ResolverExpand, SyntaxExtensionKind};
25use rustc_expand::proc_macro::BangProcMacro;
26use rustc_span::sym;
27
28use crate::deriving::*;
29
30mod alloc_error_handler;
31mod assert;
32mod autodiff;
33mod cfg;
34mod cfg_accessible;
35mod cfg_eval;
36mod compile_error;
37mod concat;
38mod concat_bytes;
39mod define_opaque;
40mod derive;
41mod deriving;
42mod edition_panic;
43mod env;
44mod errors;
45mod format;
46mod format_foreign;
47mod global_allocator;
48mod iter;
49mod log_syntax;
50mod pattern_type;
51mod source_util;
52mod test;
53mod trace_macros;
54
55pub mod asm;
56pub mod cmdline_attrs;
57pub mod contracts;
58pub mod proc_macro_harness;
59pub mod standard_library_imports;
60pub mod test_harness;
61pub mod util;
62
63rustc_fluent_macro::fluent_messages! { "../messages.ftl" }
64
65pub fn register_builtin_macros(resolver: &mut dyn ResolverExpand) {
66    let mut register = |name, kind| resolver.register_builtin_macro(name, kind);
67    macro register_bang($($name:ident: $f:expr,)*) {
68        $(register(sym::$name, SyntaxExtensionKind::LegacyBang(Arc::new($f as MacroExpanderFn)));)*
69    }
70    macro register_attr($($name:ident: $f:expr,)*) {
71        $(register(sym::$name, SyntaxExtensionKind::LegacyAttr(Arc::new($f)));)*
72    }
73    macro register_derive($($name:ident: $f:expr,)*) {
74        $(register(sym::$name, SyntaxExtensionKind::LegacyDerive(Arc::new(BuiltinDerive($f))));)*
75    }
76
77    register_bang! {
78        // tidy-alphabetical-start
79        asm: asm::expand_asm,
80        assert: assert::expand_assert,
81        cfg: cfg::expand_cfg,
82        column: source_util::expand_column,
83        compile_error: compile_error::expand_compile_error,
84        concat: concat::expand_concat,
85        concat_bytes: concat_bytes::expand_concat_bytes,
86        const_format_args: format::expand_format_args,
87        core_panic: edition_panic::expand_panic,
88        env: env::expand_env,
89        file: source_util::expand_file,
90        format_args: format::expand_format_args,
91        format_args_nl: format::expand_format_args_nl,
92        global_asm: asm::expand_global_asm,
93        include: source_util::expand_include,
94        include_bytes: source_util::expand_include_bytes,
95        include_str: source_util::expand_include_str,
96        iter: iter::expand,
97        line: source_util::expand_line,
98        log_syntax: log_syntax::expand_log_syntax,
99        module_path: source_util::expand_mod,
100        naked_asm: asm::expand_naked_asm,
101        option_env: env::expand_option_env,
102        pattern_type: pattern_type::expand,
103        std_panic: edition_panic::expand_panic,
104        stringify: source_util::expand_stringify,
105        trace_macros: trace_macros::expand_trace_macros,
106        unreachable: edition_panic::expand_unreachable,
107        // tidy-alphabetical-end
108    }
109
110    register_attr! {
111        // tidy-alphabetical-start
112        alloc_error_handler: alloc_error_handler::expand,
113        autodiff_forward: autodiff::expand_forward,
114        autodiff_reverse: autodiff::expand_reverse,
115        bench: test::expand_bench,
116        cfg_accessible: cfg_accessible::Expander,
117        cfg_eval: cfg_eval::expand,
118        define_opaque: define_opaque::expand,
119        derive: derive::Expander { is_const: false },
120        derive_const: derive::Expander { is_const: true },
121        global_allocator: global_allocator::expand,
122        test: test::expand_test,
123        test_case: test::expand_test_case,
124        // tidy-alphabetical-end
125    }
126
127    register_derive! {
128        Clone: clone::expand_deriving_clone,
129        Copy: bounds::expand_deriving_copy,
130        ConstParamTy: bounds::expand_deriving_const_param_ty,
131        UnsizedConstParamTy: bounds::expand_deriving_unsized_const_param_ty,
132        Debug: debug::expand_deriving_debug,
133        Default: default::expand_deriving_default,
134        Eq: eq::expand_deriving_eq,
135        Hash: hash::expand_deriving_hash,
136        Ord: ord::expand_deriving_ord,
137        PartialEq: partial_eq::expand_deriving_partial_eq,
138        PartialOrd: partial_ord::expand_deriving_partial_ord,
139        CoercePointee: coerce_pointee::expand_deriving_coerce_pointee,
140    }
141
142    let client = rustc_proc_macro::bridge::client::Client::expand1(rustc_proc_macro::quote);
143    register(sym::quote, SyntaxExtensionKind::Bang(Arc::new(BangProcMacro { client })));
144    let requires = SyntaxExtensionKind::Attr(Arc::new(contracts::ExpandRequires));
145    register(sym::contracts_requires, requires);
146    let ensures = SyntaxExtensionKind::Attr(Arc::new(contracts::ExpandEnsures));
147    register(sym::contracts_ensures, ensures);
148}