delegation: Implement glob delegation #124135

petrochenkov · 2024-04-18T20:20:20Z

Support delegating to all trait methods in one go.
Overriding globs with explicit definitions is also supported.

The implementation is generally based on the design from rust-lang/rfcs#3530 (comment), but unlike with list delegation in #123413 we cannot expand glob delegation eagerly.
We have to enqueue it into the queue of unexpanded macros (most other macros are processed this way too), and then a glob delegation waits in that queue until its trait path is resolved, and enough code expands to generate the identifier list produced from the glob.

Glob delegation is only allowed in impls, and can only point to traits.
Supporting it in other places gives very little practical benefit, but significantly raises the implementation complexity.

Part of #118212.

rustbot · 2024-04-18T20:20:29Z

r? @estebank

rustbot has assigned @estebank.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2024-04-19T18:54:32Z

Some changes occurred in src/tools/rustfmt

cc @rust-lang/rustfmt

fmease · 2024-04-23T20:52:18Z

I guess it makes the most sense if I review this one, too.

r? fmease

petrochenkov · 2024-04-23T22:04:17Z

This is basically blocked on #123413 now.
@rustbot blocked

delegation: Implement list delegation ```rust reuse prefix::{a, b, c}; ``` Using design described in rust-lang/rfcs#3530 (comment) (the lists are desugared at macro expansion time). List delegations are expanded eagerly when encountered, similarly to `#[cfg]`s, and not enqueued for later resolution/expansion like regular macros or glob delegation (rust-lang#124135). Part of rust-lang#118212.

petrochenkov · 2024-05-31T16:54:51Z

@rustbot ready

fmease

(partial review)

fmease · 2024-06-07T13:30:45Z

compiler/rustc_ast/src/ast.rs

@@ -3149,13 +3149,16 @@ pub struct Delegation {
    pub path: Path,
    pub rename: Option<Ident>,
    pub body: Option<P<Block>>,
+    /// The item was expanded from a glob delegation item.
+    pub from_glob: bool,


(not blocking) maybe even with enum FromGlob { Yes, No }

fmease · 2024-06-07T13:32:16Z

compiler/rustc_ast/src/ast.rs

 }

 #[derive(Clone, Encodable, Decodable, Debug)]
 pub struct DelegationMac {
    pub qself: Option<P<QSelf>>,
    pub prefix: Path,
-    pub suffixes: ThinVec<(Ident, Option<Ident>)>,
+    // Some for list delegation, and None for glob delegation.
+    pub suffixes: Option<ThinVec<(Ident, Option<Ident>)>>,


(not blocking) maybe even enum DelegationMacKind { List(/*...*/), Glob }

compiler/rustc_expand/src/base.rs

compiler/rustc_expand/src/expand.rs

compiler/rustc_resolve/src/macros.rs

compiler/rustc_expand/src/expand.rs

fmease · 2024-06-07T14:25:00Z

compiler/rustc_parse/src/parser/item.rs

Overriding globs with explicit definitions is also supported.

With that, I thought you meant sth. like reuse prefix::{*, src as dest}; which is obviously not the case. Do you plan on supporting that eventually?

Overriding typically means the function body is different, or at least the "target expression" is different.

reuse prefix::* { self.field } fn override1() { overridden_body() } reuse prefix::override2 { self.other_field }

In your example the body and the target expr are the same, only the name is different, which doesn't seem too useful.
But it can be supported, I guess, it should be pretty simple to do it as a part of list delegation expansion.

Nested lists could also be supported, but that's a significant complication for very little gain.
I sort of regret supporting them in use items.

compiler/rustc_expand/src/expand.rs

fmease

23/28 viewed (continuing in a sec)

fmease · 2024-06-13T03:32:34Z

tests/ui/delegation/empty-glob.rs

+
+struct S;
+impl S {
+    reuse Trait::*; //~ ERROR empty glob delegation is not supported


(non-blocking) we probably want to permit that at some point. might be useful for macro authors generating reuse (similar how we permit struct S<T:>(T);, struct S where String:,;, fn f<T: Copy +>(){} and the like for flexibility)

In this case it's annoying to support because Trait (and possible generic arguments in it), still needs to be checked for stability, privacy, etc.
So we'll have to keep an otherwise unnecessary dummy item after expansion, and even in HIR, to perform these checks.

tests/ui/delegation/glob-glob-conflict.rs

fmease · 2024-06-13T04:02:42Z

tests/ui/delegation/glob-non-fn.rs

+
+struct Bad(u8);
+impl Trait for Bad { //~ ERROR not all trait items implemented, missing: `CONST`, `Type`, `method`
+    reuse Trait::* { &self.0 }


(non-blocking) What do you think about skipping any non-fns? Not sure if that'd be less or more confusing for users. The diagnostics right now are certainly not helping the uninitiated ^^

The plan is to eventually support delegating non-function associated items too.
For now they are just supposed to report some kind of error (which they do).
I agree that the current error is suboptimal, but that's not very critical.

tests/ui/delegation/glob-non-impl.stderr

fmease · 2024-06-13T04:13:55Z

tests/ui/delegation/macro-inside-glob.rs

+macro_rules! u8 { () => { u8 } }
+macro_rules! self_0 { () => { &self.0 } }
+impl Trait for S {
+    reuse <u8!() as Trait>::* { self_0!() }


I'm surprised to see self_0 having access to the local binding self. Isn't this breaking hygiene rules? For comparison with normal functions, see this playground.

Yeah, looks like a hygiene bug.
We'll need to decide what the "expected" context for self should be inherited from (since there's no explicit definition for it, like in regular methods).
Perhaps from *, but we don't keep the *'s precise span right now.

This is a pre-existing issue with the way in which the self binding is created, not related to glob delegation, I'll fix this separately.
(Upd: I've pushed the fix into this PR, but I'll move it to a new PR with a test.)

PR - #126497

…rrors delegation: Fix hygiene for `self` And fix diagnostics for `self` from a macro. The missing rib caused `self` to be treated as a generic parameter and ignore `macro_rules` hygiene. Addresses this comment rust-lang#124135 (comment).

Rollup merge of rust-lang#126497 - petrochenkov:delehyg, r=compiler-errors delegation: Fix hygiene for `self` And fix diagnostics for `self` from a macro. The missing rib caused `self` to be treated as a generic parameter and ignore `macro_rules` hygiene. Addresses this comment rust-lang#124135 (comment).

fmease

Thanks a lot! Sorry for the long review times

fmease · 2024-06-18T19:37:09Z

compiler/rustc_expand/src/expand.rs

+) -> impl Iterator<Item = ast::Item<Node::ItemKind>> + 'a {
+    if suffixes.is_empty() {
+        // Report an error for now, to avoid keeping stem for resolution and
+        // stability checks.


fmease · 2024-06-18T20:16:44Z

I guess this doesn't require a rebase (despite #126497) 🤔
@bors r+

bors · 2024-06-18T20:16:47Z

📌 Commit 22d0b1e has been approved by fmease

It is now in the queue for this repository.

delegation: Implement glob delegation Support delegating to all trait methods in one go. Overriding globs with explicit definitions is also supported. The implementation is generally based on the design from rust-lang/rfcs#3530 (comment), but unlike with list delegation in rust-lang#123413 we cannot expand glob delegation eagerly. We have to enqueue it into the queue of unexpanded macros (most other macros are processed this way too), and then a glob delegation waits in that queue until its trait path is resolved, and enough code expands to generate the identifier list produced from the glob. Glob delegation is only allowed in impls, and can only point to traits. Supporting it in other places gives very little practical benefit, but significantly raises the implementation complexity. Part of rust-lang#118212.

Rollup of 10 pull requests Successful merges: - rust-lang#124135 (delegation: Implement glob delegation) - rust-lang#125078 (fix: break inside async closure has incorrect span for enclosing closure) - rust-lang#125293 (Place tail expression behind terminating scope) - rust-lang#126422 (Suggest using a standalone doctest for non-local impl defs) - rust-lang#126493 (safe transmute: support non-ZST, variantful, uninhabited enums) - rust-lang#126504 (Sync fuchsia test runner with clang test runner) - rust-lang#126558 (hir_typeck: be more conservative in making "note caller chooses ty param" note) - rust-lang#126586 (Add `@badboy` and `@BlackHoleFox` as Mac Catalyst maintainers) - rust-lang#126615 (Add `rustc-ice*` to `.gitignore`) - rust-lang#126632 (Replace `move||` with `move ||`) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#124135 - petrochenkov:deleglob, r=fmease delegation: Implement glob delegation Support delegating to all trait methods in one go. Overriding globs with explicit definitions is also supported. The implementation is generally based on the design from rust-lang/rfcs#3530 (comment), but unlike with list delegation in rust-lang#123413 we cannot expand glob delegation eagerly. We have to enqueue it into the queue of unexpanded macros (most other macros are processed this way too), and then a glob delegation waits in that queue until its trait path is resolved, and enough code expands to generate the identifier list produced from the glob. Glob delegation is only allowed in impls, and can only point to traits. Supporting it in other places gives very little practical benefit, but significantly raises the implementation complexity. Part of rust-lang#118212.

rustbot assigned estebank Apr 18, 2024

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Apr 18, 2024

petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 18, 2024

petrochenkov mentioned this pull request Apr 19, 2024

delegation: Implement list delegation #123413

Merged

petrochenkov force-pushed the deleglob branch from b6925fb to d365e9c Compare April 19, 2024 18:54

This comment has been minimized.

Sign in to view

rustbot assigned fmease and unassigned estebank Apr 23, 2024

rustbot added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 23, 2024

petrochenkov force-pushed the deleglob branch from 2737bcf to 4e6c21f Compare May 15, 2024 14:06

petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels May 15, 2024

petrochenkov force-pushed the deleglob branch 2 times, most recently from d4b3384 to c2af71a Compare May 31, 2024 16:42

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 31, 2024

fmease reviewed Jun 7, 2024

View reviewed changes

compiler/rustc_expand/src/expand.rs Show resolved Hide resolved

fmease reviewed Jun 13, 2024

View reviewed changes

delegation: Implement glob delegation

22d0b1e

petrochenkov force-pushed the deleglob branch from c2af71a to 22d0b1e Compare June 14, 2024 16:31

petrochenkov mentioned this pull request Jun 14, 2024

delegation: Fix hygiene for self #126497

Merged

fmease approved these changes Jun 18, 2024

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 18, 2024

This was referenced Jun 19, 2024

Rollup of 20 pull requests #126653

Closed

Rollup of 10 pull requests #126655

Merged

bors merged commit f8ce1cf into rust-lang:master Jun 19, 2024
6 checks passed

rustbot added this to the 1.81.0 milestone Jun 19, 2024

matthiaskrgr mentioned this pull request Jun 20, 2024

ICE: macros: entered unreachable code' #126742

Closed

petrochenkov added the F-fn_delegation `#![feature(fn_delegation)]` label Jun 24, 2024

petrochenkov mentioned this pull request Jun 24, 2024

Tracking Issue for function delegation (fn_delegation, RFC 3530) #118212

Open

25 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

delegation: Implement glob delegation #124135

delegation: Implement glob delegation #124135

petrochenkov commented Apr 18, 2024 •

edited

Loading

rustbot commented Apr 18, 2024

rustbot commented Apr 19, 2024

This comment has been minimized.

This comment has been minimized.

fmease commented Apr 23, 2024

petrochenkov commented Apr 23, 2024

petrochenkov commented May 31, 2024

fmease left a comment

fmease Jun 7, 2024

fmease Jun 7, 2024

fmease Jun 7, 2024

petrochenkov Jun 7, 2024 •

edited

Loading

petrochenkov Jun 7, 2024

fmease left a comment

fmease Jun 13, 2024 •

edited

Loading

petrochenkov Jun 13, 2024

fmease Jun 13, 2024 •

edited

Loading

petrochenkov Jun 13, 2024

fmease Jun 13, 2024 •

edited

Loading

petrochenkov Jun 13, 2024

petrochenkov Jun 14, 2024 •

edited

Loading

petrochenkov Jun 14, 2024

fmease left a comment

fmease Jun 18, 2024

fmease commented Jun 18, 2024

bors commented Jun 18, 2024

delegation: Implement glob delegation #124135

delegation: Implement glob delegation #124135

Conversation

petrochenkov commented Apr 18, 2024 • edited Loading

rustbot commented Apr 18, 2024

rustbot commented Apr 19, 2024

This comment has been minimized.

This comment has been minimized.

fmease commented Apr 23, 2024

petrochenkov commented Apr 23, 2024

petrochenkov commented May 31, 2024

fmease left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petrochenkov Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmease left a comment

Choose a reason for hiding this comment

fmease Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmease Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmease Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petrochenkov Jun 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmease left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmease commented Jun 18, 2024

bors commented Jun 18, 2024

petrochenkov commented Apr 18, 2024 •

edited

Loading

petrochenkov Jun 7, 2024 •

edited

Loading

fmease Jun 13, 2024 •

edited

Loading

fmease Jun 13, 2024 •

edited

Loading

fmease Jun 13, 2024 •

edited

Loading

petrochenkov Jun 14, 2024 •

edited

Loading