Skip to content

Commit 25c6726

Browse files
fmeasefmease
committed
Introduce proc_macro::DeriveExpansionOptions
1 parent a191610 commit 25c6726

File tree

11 files changed

+198
-23
lines changed

11 files changed

+198
-23
lines changed

‎compiler/rustc_expand/src/proc_macro.rs

+7-4
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ impl base::BangProcMacro for BangProcMacro {
5959

6060
let proc_macro_backtrace = ecx.ecfg.proc_macro_backtrace;
6161
let strategy = exec_strategy(ecx);
62-
let server = proc_macro_server::Rustc::new(ecx);
62+
let server = proc_macro_server::Rustc::new(ecx, Default::default());
6363
self.client.run(&strategy, server, input, proc_macro_backtrace).map_err(|e| {
6464
ecx.sess.emit_err(errors::ProcMacroPanicked {
6565
span,
@@ -90,7 +90,7 @@ impl base::AttrProcMacro for AttrProcMacro {
9090

9191
let proc_macro_backtrace = ecx.ecfg.proc_macro_backtrace;
9292
let strategy = exec_strategy(ecx);
93-
let server = proc_macro_server::Rustc::new(ecx);
93+
let server = proc_macro_server::Rustc::new(ecx, Default::default());
9494
self.client.run(&strategy, server, annotation, annotated, proc_macro_backtrace).map_err(
9595
|e| {
9696
let mut err = ecx.struct_span_err(span, "custom attribute panicked");
@@ -114,7 +114,7 @@ impl MultiItemModifier for DeriveProcMacro {
114114
span: Span,
115115
_meta_item: &ast::MetaItem,
116116
item: Annotatable,
117-
_is_derive_const: bool,
117+
is_derive_const: bool,
118118
) -> ExpandResult<Vec<Annotatable>, Annotatable> {
119119
// We need special handling for statement items
120120
// (e.g. `fn foo() { #[derive(Debug)] struct Bar; }`)
@@ -142,7 +142,10 @@ impl MultiItemModifier for DeriveProcMacro {
142142
});
143143
let proc_macro_backtrace = ecx.ecfg.proc_macro_backtrace;
144144
let strategy = exec_strategy(ecx);
145-
let server = proc_macro_server::Rustc::new(ecx);
145+
let server = proc_macro_server::Rustc::new(
146+
ecx,
147+
proc_macro_server::ExpansionOptions { is_derive_const },
148+
);
146149
match self.client.run(&strategy, server, input, proc_macro_backtrace) {
147150
Ok(stream) => stream,
148151
Err(e) => {

‎compiler/rustc_expand/src/proc_macro_server.rs

+12-1
Original file line numberDiff line numberDiff line change
@@ -370,17 +370,19 @@ pub(crate) struct Rustc<'a, 'b> {
370370
mixed_site: Span,
371371
krate: CrateNum,
372372
rebased_spans: FxHashMap<usize, Span>,
373+
options: ExpansionOptions,
373374
}
374375

375376
impl<'a, 'b> Rustc<'a, 'b> {
376-
pub fn new(ecx: &'a mut ExtCtxt<'b>) -> Self {
377+
pub fn new(ecx: &'a mut ExtCtxt<'b>, options: ExpansionOptions) -> Self {
377378
let expn_data = ecx.current_expansion.id.expn_data();
378379
Rustc {
379380
def_site: ecx.with_def_site_ctxt(expn_data.def_site),
380381
call_site: ecx.with_call_site_ctxt(expn_data.call_site),
381382
mixed_site: ecx.with_mixed_site_ctxt(expn_data.call_site),
382383
krate: expn_data.macro_def_id.unwrap().krate,
383384
rebased_spans: FxHashMap::default(),
385+
options,
384386
ecx,
385387
}
386388
}
@@ -390,6 +392,11 @@ impl<'a, 'b> Rustc<'a, 'b> {
390392
}
391393
}
392394

395+
#[derive(Default)]
396+
pub(crate) struct ExpansionOptions {
397+
pub(crate) is_derive_const: bool,
398+
}
399+
393400
impl server::Types for Rustc<'_, '_> {
394401
type FreeFunctions = FreeFunctions;
395402
type TokenStream = TokenStream;
@@ -477,6 +484,10 @@ impl server::FreeFunctions for Rustc<'_, '_> {
477484
}
478485
self.sess().span_diagnostic.emit_diagnostic(&mut diag);
479486
}
487+
488+
fn is_derive_const(&mut self) -> bool {
489+
self.options.is_derive_const
490+
}
480491
}
481492

482493
impl server::TokenStream for Rustc<'_, '_> {

‎compiler/rustc_passes/src/check_attr.rs

+51-15
Original file line numberDiff line numberDiff line change
@@ -2285,10 +2285,17 @@ impl CheckAttrVisitor<'_> {
22852285
}
22862286

22872287
let tcx = self.tcx;
2288-
let Some(token_stream_def_id) = tcx.get_diagnostic_item(sym::TokenStream) else {
2288+
2289+
let Some(token_stream) = tcx
2290+
.get_diagnostic_item(sym::TokenStream)
2291+
.and_then(|did| tcx.type_of(did).no_bound_vars())
2292+
else {
22892293
return;
22902294
};
2291-
let Some(token_stream) = tcx.type_of(token_stream_def_id).no_bound_vars() else {
2295+
let Some(derive_expansion_options) = tcx
2296+
.get_diagnostic_item(sym::DeriveExpansionOptions)
2297+
.and_then(|did| tcx.type_of(did).no_bound_vars())
2298+
else {
22922299
return;
22932300
};
22942301

@@ -2324,8 +2331,22 @@ impl CheckAttrVisitor<'_> {
23242331
Unsafety::Normal,
23252332
Abi::Rust,
23262333
);
2334+
let expected_options_sig = tcx.mk_fn_sig(
2335+
[token_stream, derive_expansion_options],
2336+
token_stream,
2337+
false,
2338+
Unsafety::Normal,
2339+
Abi::Rust,
2340+
);
2341+
2342+
let mut result = infcx.probe(|_| ocx.eq(&cause, param_env, expected_sig, sig));
2343+
if result.is_err()
2344+
&& let ProcMacroKind::Derive = kind
2345+
{
2346+
result = infcx.probe(|_| ocx.eq(&cause, param_env, expected_options_sig, sig));
2347+
}
23272348

2328-
if let Err(terr) = ocx.eq(&cause, param_env, expected_sig, sig) {
2349+
if let Err(terr) = result {
23292350
let mut diag = tcx.sess.create_err(errors::ProcMacroBadSig { span, kind });
23302351

23312352
let hir_sig = tcx.hir().fn_sig_by_hir_id(hir_id);
@@ -2360,18 +2381,33 @@ impl CheckAttrVisitor<'_> {
23602381
}
23612382
}
23622383

2363-
infcx.err_ctxt().note_type_err(
2364-
&mut diag,
2365-
&cause,
2366-
None,
2367-
Some(ValuePairs::PolySigs(ExpectedFound {
2368-
expected: ty::Binder::dummy(expected_sig),
2369-
found: ty::Binder::dummy(sig),
2370-
})),
2371-
terr,
2372-
false,
2373-
false,
2374-
);
2384+
let mut note_expected_found = |expected_sig| {
2385+
infcx.err_ctxt().note_type_err(
2386+
&mut diag,
2387+
&cause,
2388+
None,
2389+
Some(ValuePairs::PolySigs(ExpectedFound {
2390+
expected: ty::Binder::dummy(expected_sig),
2391+
found: ty::Binder::dummy(sig),
2392+
})),
2393+
terr,
2394+
false,
2395+
false,
2396+
)
2397+
};
2398+
2399+
note_expected_found(expected_sig);
2400+
2401+
if let ProcMacroKind::Derive = kind
2402+
&& tcx
2403+
.features()
2404+
.declared_lib_features
2405+
.iter()
2406+
.any(|&(feature, _)| feature == sym::derive_const)
2407+
{
2408+
note_expected_found(expected_options_sig);
2409+
}
2410+
23752411
diag.emit();
23762412
self.abort.set(true);
23772413
}

‎compiler/rustc_span/src/symbol.rs

+1
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ symbols! {
183183
DecorateLint,
184184
Default,
185185
Deref,
186+
DeriveExpansionOptions,
186187
DiagnosticMessage,
187188
DirBuilder,
188189
Display,

‎library/proc_macro/src/bridge/client.rs

+30-3
Original file line numberDiff line numberDiff line change
@@ -484,12 +484,16 @@ impl ProcMacro {
484484
}
485485
}
486486

487-
pub const fn custom_derive(
487+
pub const fn custom_derive<Discriminant>(
488488
trait_name: &'static str,
489489
attributes: &'static [&'static str],
490-
expand: impl Fn(crate::TokenStream) -> crate::TokenStream + Copy,
490+
expand: impl ~const ExpandCustomDerive<Discriminant>,
491491
) -> Self {
492-
ProcMacro::CustomDerive { trait_name, attributes, client: Client::expand1(expand) }
492+
ProcMacro::CustomDerive {
493+
trait_name,
494+
attributes,
495+
client: Client::expand1(expand.into_fn()),
496+
}
493497
}
494498

495499
pub const fn attr(
@@ -506,3 +510,26 @@ impl ProcMacro {
506510
ProcMacro::Bang { name, client: Client::expand1(expand) }
507511
}
508512
}
513+
514+
#[const_trait]
515+
pub trait ExpandCustomDerive<Discriminant> {
516+
fn into_fn(self) -> impl Fn(crate::TokenStream) -> crate::TokenStream + Copy;
517+
}
518+
519+
impl<F> const ExpandCustomDerive<()> for F
520+
where
521+
F: Fn(crate::TokenStream) -> crate::TokenStream + Copy,
522+
{
523+
fn into_fn(self) -> impl Fn(crate::TokenStream) -> crate::TokenStream + Copy {
524+
self
525+
}
526+
}
527+
528+
impl<F> const ExpandCustomDerive<crate::DeriveExpansionOptions> for F
529+
where
530+
F: Fn(crate::TokenStream, crate::DeriveExpansionOptions) -> crate::TokenStream + Copy,
531+
{
532+
fn into_fn(self) -> impl Fn(crate::TokenStream) -> crate::TokenStream + Copy {
533+
move |input| self(input, Default::default())
534+
}
535+
}

‎library/proc_macro/src/bridge/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ macro_rules! with_api {
5959
fn track_path(path: &str);
6060
fn literal_from_str(s: &str) -> Result<Literal<$S::Span, $S::Symbol>, ()>;
6161
fn emit_diagnostic(diagnostic: Diagnostic<$S::Span>);
62+
fn is_derive_const() -> bool;
6263
},
6364
TokenStream {
6465
fn drop($self: $S::TokenStream);

‎library/proc_macro/src/lib.rs

+28
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
#![feature(rustc_allow_const_fn_unstable)]
2626
#![feature(staged_api)]
2727
#![feature(allow_internal_unstable)]
28+
#![feature(const_trait_impl)]
2829
#![feature(decl_macro)]
30+
#![feature(effects)]
2931
#![feature(maybe_uninit_write_slice)]
3032
#![feature(negative_impls)]
3133
#![feature(new_uninit)]
@@ -85,6 +87,32 @@ impl !Send for TokenStream {}
8587
#[stable(feature = "proc_macro_lib", since = "1.15.0")]
8688
impl !Sync for TokenStream {}
8789

90+
/// Derive expansion options.
91+
#[rustc_diagnostic_item = "DeriveExpansionOptions"]
92+
#[unstable(feature = "derive_const", issue = "none")]
93+
#[derive(Default, Clone)]
94+
#[non_exhaustive]
95+
pub struct DeriveExpansionOptions;
96+
97+
impl DeriveExpansionOptions {
98+
/// Returns the default options.
99+
#[unstable(feature = "derive_const", issue = "none")]
100+
pub fn new() -> Self {
101+
Self::default()
102+
}
103+
104+
/// Whether this is a `#[derive_const]` or a `#[derive]`.
105+
#[unstable(feature = "derive_const", issue = "none")]
106+
pub fn is_const(&self) -> bool {
107+
bridge::client::FreeFunctions::is_derive_const()
108+
}
109+
}
110+
111+
#[unstable(feature = "derive_const", issue = "none")]
112+
impl !Send for DeriveExpansionOptions {}
113+
#[unstable(feature = "derive_const", issue = "none")]
114+
impl !Sync for DeriveExpansionOptions {}
115+
88116
/// Error returned from `TokenStream::from_str`.
89117
#[stable(feature = "proc_macro_lib", since = "1.15.0")]
90118
#[non_exhaustive]

‎tests/ui/rfcs/rfc-2632-const-trait-impl/const_derives/auxiliary/is-derive-const.rs

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// force-host
2+
// no-prefer-dynamic
3+
#![crate_type = "proc-macro"]
4+
#![feature(derive_const)]
5+
6+
extern crate proc_macro;
7+
8+
use proc_macro::{TokenStream, DeriveExpansionOptions};
9+
10+
#[proc_macro_derive(IsDeriveConst)]
11+
pub fn is_derive_const(_: TokenStream, options: DeriveExpansionOptions) -> TokenStream {
12+
format!("const IS_DERIVE_CONST: bool = {};", options.is_const()).parse().unwrap()
13+
}

‎tests/ui/rfcs/rfc-2632-const-trait-impl/const_derives/derive-const-custom.rs

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// check-pass
2+
// edition: 2021
3+
// aux-crate:is_derive_const=is-derive-const.rs
4+
#![feature(derive_const)]
5+
6+
const _: () = {
7+
#[derive(is_derive_const::IsDeriveConst)]
8+
struct _Type;
9+
10+
assert!(!IS_DERIVE_CONST);
11+
};
12+
13+
const _: () = {
14+
#[derive_const(is_derive_const::IsDeriveConst)]
15+
struct _Type;
16+
17+
assert!(IS_DERIVE_CONST);
18+
};
19+
20+
fn main() {}

‎tests/ui/rfcs/rfc-2632-const-trait-impl/const_derives/signature-proc-macro-derive.rs

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Check that we suggest *both* possible signatures of derive proc macros, namely
2+
// fn(TokenStream) -> TokenStream
3+
// and
4+
// fn(TokenStream, DeriveExpansionOptions) -> TokenStream
5+
// provided libs feature `derive_const` is enabled.
6+
7+
// force-host
8+
// no-prefer-dynamic
9+
10+
#![crate_type = "proc-macro"]
11+
#![feature(derive_const)]
12+
13+
extern crate proc_macro;
14+
15+
#[proc_macro_derive(Blah)]
16+
pub fn bad_input() -> proc_macro::TokenStream {
17+
//~^ ERROR derive proc macro has incorrect signature
18+
Default::default()
19+
}

‎tests/ui/rfcs/rfc-2632-const-trait-impl/const_derives/signature-proc-macro-derive.stderr

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
error: derive proc macro has incorrect signature
2+
--> $DIR/signature-proc-macro-derive.rs:16:1
3+
|
4+
LL | pub fn bad_input() -> proc_macro::TokenStream {
5+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6+
| |
7+
| incorrect number of function parameters
8+
| incorrect number of function parameters
9+
|
10+
= note: expected signature `fn(proc_macro::TokenStream) -> proc_macro::TokenStream`
11+
found signature `fn() -> proc_macro::TokenStream`
12+
= note: expected signature `fn(proc_macro::TokenStream, DeriveExpansionOptions) -> proc_macro::TokenStream`
13+
found signature `fn() -> proc_macro::TokenStream`
14+
15+
error: aborting due to 1 previous error
16+

0 commit comments

Comments
 (0)