Add spacing to DelimArgs.

nnethercote · nnethercote · commit 86b55f1e6d2a · 2025-04-26T05:41:45.000+10:00
This improves pretty printing. Most notably, the `FIXME` for suboptimal
printing of `use` groups in `tests/ui/macros/stringify.rs` is fixed.
And all other test output changes result in pretty printed output being
closer to the original formatting in the source code.
diff --git a/compiler/rustc_ast/src/ast.rs b/compiler/rustc_ast/src/ast.rs
@@ -38,7 +38,7 @@ use thin_vec::{ThinVec, thin_vec};
 pub use crate::format::*;
 use crate::ptr::P;
 use crate::token::{self, CommentKind, Delimiter};
-use crate::tokenstream::{DelimSpan, LazyAttrTokenStream, TokenStream};
+use crate::tokenstream::{DelimSpan, LazyAttrTokenStream, Spacing, TokenStream};
 use crate::util::parser::{ExprPrecedence, Fixity};
 
 /// A "Label" is an identifier of some point in sources,
@@ -1930,6 +1930,10 @@ impl AttrArgs {
 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
 pub struct DelimArgs {
     pub dspan: DelimSpan,
+    // The spacing after the open delimiter. Used when pretty-printing to
+    // decide whether to put a space after the opening delim and a space before
+    // the closing delim.
+    pub open_spacing: Spacing,
     pub delim: Delimiter, // Note: `Delimiter::Invisible` never occurs
     pub tokens: TokenStream,
 }
diff --git a/compiler/rustc_ast/src/attr/mod.rs b/compiler/rustc_ast/src/attr/mod.rs
@@ -483,9 +483,12 @@ impl MetaItemKind {
     fn from_attr_args(args: &AttrArgs) -> Option<MetaItemKind> {
         match args {
             AttrArgs::Empty => Some(MetaItemKind::Word),
-            AttrArgs::Delimited(DelimArgs { dspan: _, delim: Delimiter::Parenthesis, tokens }) => {
-                MetaItemKind::list_from_tokens(tokens.clone()).map(MetaItemKind::List)
-            }
+            AttrArgs::Delimited(DelimArgs {
+                dspan: _,
+                open_spacing: _,
+                delim: Delimiter::Parenthesis,
+                tokens,
+            }) => MetaItemKind::list_from_tokens(tokens.clone()).map(MetaItemKind::List),
             AttrArgs::Delimited(..) => None,
             AttrArgs::Eq { expr, .. } => match expr.kind {
                 ExprKind::Lit(token_lit) => {
@@ -679,6 +682,7 @@ pub fn mk_attr_nested_word(
     let path = Path::from_ident(outer_ident);
     let attr_args = AttrArgs::Delimited(DelimArgs {
         dspan: DelimSpan::from_single(span),
+        open_spacing: Spacing::Joint,
         delim: Delimiter::Parenthesis,
         tokens: inner_tokens,
     });
diff --git a/compiler/rustc_ast/src/mut_visit.rs b/compiler/rustc_ast/src/mut_visit.rs
@@ -473,7 +473,7 @@ fn visit_attr_args<T: MutVisitor>(vis: &mut T, args: &mut AttrArgs) {
 
 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 fn visit_delim_args<T: MutVisitor>(vis: &mut T, args: &mut DelimArgs) {
-    let DelimArgs { dspan, delim: _, tokens } = args;
+    let DelimArgs { dspan, open_spacing: _, delim: _, tokens } = args;
     visit_tts(vis, tokens);
     visit_delim_span(vis, dspan);
 }
diff --git a/compiler/rustc_ast_pretty/src/pprust/state.rs b/compiler/rustc_ast_pretty/src/pprust/state.rs
@@ -629,15 +629,17 @@ pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::Dere
             ast::Safety::Default | ast::Safety::Safe(_) => {}
         }
         match &item.args {
-            AttrArgs::Delimited(DelimArgs { dspan: _, delim, tokens }) => self.print_mac_common(
-                Some(MacHeader::Path(&item.path)),
-                false,
-                None,
-                *delim,
-                tokens,
-                true,
-                span,
-            ),
+            AttrArgs::Delimited(DelimArgs { dspan: _, open_spacing, delim, tokens }) => self
+                .print_mac_common(
+                    Some(MacHeader::Path(&item.path)),
+                    false,
+                    None,
+                    *delim,
+                    *open_spacing,
+                    tokens,
+                    true,
+                    span,
+                ),
             AttrArgs::Empty => {
                 self.print_path(&item.path, false, 0);
             }
@@ -679,6 +681,7 @@ pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::Dere
                     false,
                     None,
                     *delim,
+                    spacing.open,
                     tts,
                     convert_dollar_crate,
                     dspan.entire(),
@@ -735,6 +738,7 @@ pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::Dere
         has_bang: bool,
         ident: Option<Ident>,
         delim: Delimiter,
+        open_spacing: Spacing,
         tts: &TokenStream,
         convert_dollar_crate: bool,
         span: Span,
@@ -760,16 +764,25 @@ pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::Dere
                     self.nbsp();
                 }
                 self.word("{");
-                if !tts.is_empty() {
+
+                // Respect `Alone` and print a space, unless the list is empty.
+                let open_space = open_spacing == Spacing::Alone && !tts.is_empty();
+                if open_space {
                     self.space();
                 }
                 self.ibox(0);
                 self.print_tts(tts, convert_dollar_crate);
                 self.end();
-                let empty = tts.is_empty();
-                self.bclose(span, empty);
+
+                // Use `spacing.open` for the spacing *before* the closing
+                // delim. Because spacing on delimiters is lost when going
+                // through proc macros, and otherwise we can end up with ugly
+                // cases like `{ x}`. Symmetry is better.
+                self.bclose(span, !open_space);
             }
             delim => {
+                // `open_spacing` is ignored. We never print spaces after
+                // non-brace opening delims or before non-brace closing delims.
                 let token_str = self.token_kind_to_string(&delim.as_open_token_kind());
                 self.word(token_str);
                 self.ibox(0);
@@ -799,6 +812,7 @@ pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::Dere
             has_bang,
             Some(*ident),
             macro_def.body.delim,
+            macro_def.body.open_spacing,
             &macro_def.body.tokens,
             true,
             sp,
@@ -845,9 +859,9 @@ pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::Dere
         self.end(); // Close the head-box.
     }
 
-    fn bclose_maybe_open(&mut self, span: rustc_span::Span, empty: bool, close_box: bool) {
+    fn bclose_maybe_open(&mut self, span: rustc_span::Span, no_space: bool, close_box: bool) {
         let has_comment = self.maybe_print_comment(span.hi());
-        if !empty || has_comment {
+        if !no_space || has_comment {
             self.break_offset_if_not_bol(1, -INDENT_UNIT);
         }
         self.word("}");
@@ -856,9 +870,9 @@ pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::Dere
         }
     }
 
-    fn bclose(&mut self, span: rustc_span::Span, empty: bool) {
+    fn bclose(&mut self, span: rustc_span::Span, no_space: bool) {
         let close_box = true;
-        self.bclose_maybe_open(span, empty, close_box)
+        self.bclose_maybe_open(span, no_space, close_box)
     }
 
     fn break_offset_if_not_bol(&mut self, n: usize, off: isize) {
@@ -1420,8 +1434,8 @@ impl<'a> State<'a> {
             }
         }
 
-        let empty = !has_attrs && blk.stmts.is_empty();
-        self.bclose_maybe_open(blk.span, empty, close_box);
+        let no_space = !has_attrs && blk.stmts.is_empty();
+        self.bclose_maybe_open(blk.span, no_space, close_box);
         self.ann.post(self, AnnNode::Block(blk))
     }
 
@@ -1468,6 +1482,7 @@ impl<'a> State<'a> {
             true,
             None,
             m.args.delim,
+            m.args.open_spacing,
             &m.args.tokens,
             true,
             m.span(),
diff --git a/compiler/rustc_builtin_macros/src/assert.rs b/compiler/rustc_builtin_macros/src/assert.rs
@@ -2,7 +2,7 @@ mod context;
 
 use rustc_ast::ptr::P;
 use rustc_ast::token::Delimiter;
-use rustc_ast::tokenstream::{DelimSpan, TokenStream};
+use rustc_ast::tokenstream::{DelimSpan, Spacing, TokenStream};
 use rustc_ast::{DelimArgs, Expr, ExprKind, MacCall, Path, PathSegment, UnOp, token};
 use rustc_ast_pretty::pprust;
 use rustc_errors::PResult;
@@ -59,6 +59,7 @@ pub(crate) fn expand_assert<'cx>(
                 path: panic_path(),
                 args: P(DelimArgs {
                     dspan: DelimSpan::from_single(call_site_span),
+                    open_spacing: Spacing::Joint,
                     delim: Delimiter::Parenthesis,
                     tokens,
                 }),
diff --git a/compiler/rustc_builtin_macros/src/assert/context.rs b/compiler/rustc_builtin_macros/src/assert/context.rs
@@ -1,6 +1,6 @@
 use rustc_ast::ptr::P;
 use rustc_ast::token::{self, Delimiter, IdentIsRaw};
-use rustc_ast::tokenstream::{DelimSpan, TokenStream, TokenTree};
+use rustc_ast::tokenstream::{DelimSpan, Spacing, TokenStream, TokenTree};
 use rustc_ast::{
     BinOpKind, BorrowKind, DUMMY_NODE_ID, DelimArgs, Expr, ExprKind, ItemKind, MacCall, MethodCall,
     Mutability, Path, PathSegment, Stmt, StructRest, UnOp, UseTree, UseTreeKind,
@@ -180,6 +180,7 @@ impl<'cx, 'a> Context<'cx, 'a> {
                 path: panic_path,
                 args: P(DelimArgs {
                     dspan: DelimSpan::from_single(self.span),
+                    open_spacing: Spacing::Joint,
                     delim: Delimiter::Parenthesis,
                     tokens: initial.into_iter().chain(captures).collect::<TokenStream>(),
                 }),
diff --git a/compiler/rustc_builtin_macros/src/autodiff.rs b/compiler/rustc_builtin_macros/src/autodiff.rs
@@ -323,9 +323,10 @@ mod llvm_enzyme {
             Spacing::Joint,
         )];
         let never_arg = ast::DelimArgs {
-            dspan: ast::tokenstream::DelimSpan::from_single(span),
+            dspan: DelimSpan::from_single(span),
+            open_spacing: Spacing::Joint,
             delim: ast::token::Delimiter::Parenthesis,
-            tokens: ast::tokenstream::TokenStream::from_iter(ts2),
+            tokens: TokenStream::from_iter(ts2),
         };
         let inline_item = ast::AttrItem {
             unsafety: ast::Safety::Default,
@@ -395,6 +396,7 @@ mod llvm_enzyme {
         // Now update for d_fn
         rustc_ad_attr.item.args = rustc_ast::AttrArgs::Delimited(rustc_ast::DelimArgs {
             dspan: DelimSpan::dummy(),
+            open_spacing: Spacing::Joint,
             delim: rustc_ast::token::Delimiter::Parenthesis,
             tokens: ts,
         });
diff --git a/compiler/rustc_builtin_macros/src/edition_panic.rs b/compiler/rustc_builtin_macros/src/edition_panic.rs
@@ -1,6 +1,6 @@
 use rustc_ast::ptr::P;
 use rustc_ast::token::Delimiter;
-use rustc_ast::tokenstream::{DelimSpan, TokenStream};
+use rustc_ast::tokenstream::{DelimSpan, Spacing, TokenStream};
 use rustc_ast::*;
 use rustc_expand::base::*;
 use rustc_span::edition::Edition;
@@ -60,6 +60,7 @@ fn expand<'cx>(
                 },
                 args: P(DelimArgs {
                     dspan: DelimSpan::from_single(sp),
+                    open_spacing: Spacing::Joint,
                     delim: Delimiter::Parenthesis,
                     tokens: tts,
                 }),
diff --git a/compiler/rustc_expand/src/build.rs b/compiler/rustc_expand/src/build.rs
@@ -2,7 +2,7 @@ use rustc_ast::ptr::P;
 use rustc_ast::util::literal;
 use rustc_ast::{
     self as ast, AnonConst, AttrVec, BlockCheckMode, Expr, LocalKind, MatchKind, PatKind, UnOp,
-    attr, token,
+    attr, token, tokenstream,
 };
 use rustc_span::source_map::Spanned;
 use rustc_span::{DUMMY_SP, Ident, Span, Symbol, kw, sym};
@@ -54,14 +54,16 @@ impl<'a> ExtCtxt<'a> {
     pub fn macro_call(
         &self,
         span: Span,
+        open_spacing: tokenstream::Spacing,
         path: ast::Path,
-        delim: ast::token::Delimiter,
-        tokens: ast::tokenstream::TokenStream,
+        delim: token::Delimiter,
+        tokens: tokenstream::TokenStream,
     ) -> P<ast::MacCall> {
         P(ast::MacCall {
             path,
             args: P(ast::DelimArgs {
-                dspan: ast::tokenstream::DelimSpan { open: span, close: span },
+                dspan: tokenstream::DelimSpan { open: span, close: span },
+                open_spacing,
                 delim,
                 tokens,
             }),
@@ -476,12 +478,13 @@ impl<'a> ExtCtxt<'a> {
             span,
             self.macro_call(
                 span,
+                tokenstream::Spacing::Joint,
                 self.path_global(
                     span,
                     [sym::std, sym::unreachable].map(|s| Ident::new(s, span)).to_vec(),
                 ),
-                ast::token::Delimiter::Parenthesis,
-                ast::tokenstream::TokenStream::default(),
+                token::Delimiter::Parenthesis,
+                tokenstream::TokenStream::default(),
             ),
         )
     }
diff --git a/compiler/rustc_expand/src/placeholders.rs b/compiler/rustc_expand/src/placeholders.rs
@@ -1,6 +1,7 @@
 use rustc_ast::mut_visit::*;
 use rustc_ast::ptr::P;
 use rustc_ast::token::Delimiter;
+use rustc_ast::tokenstream::Spacing;
 use rustc_ast::visit::AssocCtxt;
 use rustc_ast::{self as ast, Safety};
 use rustc_data_structures::fx::FxHashMap;
@@ -20,6 +21,7 @@ pub(crate) fn placeholder(
             path: ast::Path { span: DUMMY_SP, segments: ThinVec::new(), tokens: None },
             args: P(ast::DelimArgs {
                 dspan: ast::tokenstream::DelimSpan::dummy(),
+                open_spacing: Spacing::Joint,
                 delim: Delimiter::Parenthesis,
                 tokens: ast::tokenstream::TokenStream::new(Vec::new()),
             }),
diff --git a/compiler/rustc_hir_pretty/src/lib.rs b/compiler/rustc_hir_pretty/src/lib.rs
@@ -140,12 +140,13 @@ impl<'a> State<'a> {
         };
 
         match &item.args {
-            hir::AttrArgs::Delimited(DelimArgs { dspan: _, delim, tokens }) => self
+            hir::AttrArgs::Delimited(DelimArgs { dspan: _, open_spacing, delim, tokens }) => self
                 .print_mac_common(
                     Some(MacHeader::Path(&path)),
                     false,
                     None,
                     *delim,
+                    *open_spacing,
                     &tokens,
                     true,
                     span,
diff --git a/compiler/rustc_parse/src/lib.rs b/compiler/rustc_parse/src/lib.rs
@@ -225,7 +225,7 @@ pub fn parse_cfg_attr(
         <https://doc.rust-lang.org/reference/conditional-compilation.html#the-cfg_attr-attribute>";
 
     match cfg_attr.get_normal_item().args {
-        ast::AttrArgs::Delimited(ast::DelimArgs { dspan, delim, ref tokens })
+        ast::AttrArgs::Delimited(ast::DelimArgs { dspan, open_spacing: _, delim, ref tokens })
             if !tokens.is_empty() =>
         {
             crate::validate_attr::check_cfg_attr_bad_delim(psess, dspan, delim);
diff --git a/compiler/rustc_parse/src/parser/item.rs b/compiler/rustc_parse/src/parser/item.rs
@@ -5,7 +5,7 @@ use ast::token::IdentIsRaw;
 use rustc_ast::ast::*;
 use rustc_ast::ptr::P;
 use rustc_ast::token::{self, Delimiter, InvisibleOrigin, MetaVarKind, TokenKind};
-use rustc_ast::tokenstream::{DelimSpan, TokenStream, TokenTree};
+use rustc_ast::tokenstream::{DelimSpan, Spacing, TokenStream, TokenTree};
 use rustc_ast::util::case::Case;
 use rustc_ast::{self as ast};
 use rustc_ast_pretty::pprust;
@@ -2198,7 +2198,7 @@ impl<'a> Parser<'a> {
             let arrow = TokenTree::token_alone(token::FatArrow, pspan.between(bspan)); // `=>`
             let tokens = TokenStream::new(vec![params, arrow, body]);
             let dspan = DelimSpan::from_pair(pspan.shrink_to_lo(), bspan.shrink_to_hi());
-            P(DelimArgs { dspan, delim: Delimiter::Brace, tokens })
+            P(DelimArgs { dspan, open_spacing: Spacing::Alone, delim: Delimiter::Brace, tokens })
         } else {
             self.unexpected_any()?
         };
diff --git a/compiler/rustc_parse/src/parser/mod.rs b/compiler/rustc_parse/src/parser/mod.rs
@@ -1464,10 +1464,11 @@ impl<'a> Parser<'a> {
             || self.check(exp!(OpenBrace));
 
         delimited.then(|| {
-            let TokenTree::Delimited(dspan, _, delim, tokens) = self.parse_token_tree() else {
+            let TokenTree::Delimited(dspan, spacing, delim, tokens) = self.parse_token_tree()
+            else {
                 unreachable!()
             };
-            DelimArgs { dspan, delim, tokens }
+            DelimArgs { dspan, open_spacing: spacing.open, delim, tokens }
         })
     }
 
diff --git a/compiler/rustc_parse/src/validate_attr.rs b/compiler/rustc_parse/src/validate_attr.rs
@@ -64,7 +64,7 @@ pub fn parse_meta<'a>(psess: &'a ParseSess, attr: &Attribute) -> PResult<'a, Met
         path: item.path.clone(),
         kind: match &item.args {
             AttrArgs::Empty => MetaItemKind::Word,
-            AttrArgs::Delimited(DelimArgs { dspan, delim, tokens }) => {
+            AttrArgs::Delimited(DelimArgs { dspan, open_spacing: _, delim, tokens }) => {
                 check_meta_bad_delim(psess, *dspan, *delim);
                 let nmis =
                     parse_in(psess, tokens.clone(), "meta list", |p| p.parse_meta_seq_top())?;
diff --git a/tests/ui/macros/stringify.rs b/tests/ui/macros/stringify.rs
@@ -356,7 +356,7 @@ fn test_item() {
     c1!(item, [ pub extern crate self as std; ], "pub extern crate self as std;");
 
     // ItemKind::Use
-    c1!(item, [ pub use crate::{a, b::c}; ], "pub use crate::{ a, b::c };"); // FIXME
+    c1!(item, [ pub use crate::{a, b::c}; ], "pub use crate::{a, b::c};");
     c1!(item, [ pub use crate::{ e, ff }; ], "pub use crate::{ e, ff };");
     c1!(item, [ pub use A::*; ], "pub use A::*;");
 
@@ -491,7 +491,7 @@ fn test_item() {
     c1!(item, [ mac! {} ], "mac! {}");
     c1!(item, [ mac!(...); ], "mac!(...);");
     c1!(item, [ mac![...]; ], "mac![...];");
-    c1!(item, [ mac! {...} ], "mac! { ... }");
+    c1!(item, [ mac! {...} ], "mac! {...}");
 
     // ItemKind::MacroDef
     c1!(item,
diff --git a/tests/ui/macros/trace_faulty_macros.stderr b/tests/ui/macros/trace_faulty_macros.stderr
diff --git a/tests/ui/proc-macro/attr-complex-fn.stdout b/tests/ui/proc-macro/attr-complex-fn.stdout
diff --git a/tests/ui/proc-macro/weird-braces.stdout b/tests/ui/proc-macro/weird-braces.stdout
diff --git a/tests/ui/unpretty/expanded-exhaustive.stdout b/tests/ui/unpretty/expanded-exhaustive.stdout

Original file line number	Diff line number	Diff line change
`@@ -473,7 +473,7 @@ fn visit_attr_args<T: MutVisitor>(vis: &mut T, args: &mut AttrArgs) {`
`473`	`473`
`474`	`474`	// No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
`475`	`475`	`fn visit_delim_args<T: MutVisitor>(vis: &mut T, args: &mut DelimArgs) {`
`476`		`- let DelimArgs { dspan, delim: _, tokens } = args;`
	`476`	`+ let DelimArgs { dspan, open_spacing: _, delim: _, tokens } = args;`
`477`	`477`	`visit_tts(vis, tokens);`
`478`	`478`	`visit_delim_span(vis, dspan);`
`479`	`479`	`}`
Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@ pub fn parse_cfg_attr(`
`225`	`225`	`<https://doc.rust-lang.org/reference/conditional-compilation.html#the-cfg_attr-attribute>";`
`226`	`226`
`227`	`227`	`match cfg_attr.get_normal_item().args {`
`228`		`- ast::AttrArgs::Delimited(ast::DelimArgs { dspan, delim, ref tokens })`
	`228`	`+ ast::AttrArgs::Delimited(ast::DelimArgs { dspan, open_spacing: _, delim, ref tokens })`
`229`	`229`	`if !tokens.is_empty() =>`
`230`	`230`	`{`
`231`	`231`	`crate::validate_attr::check_cfg_attr_bad_delim(psess, dspan, delim);`