Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 09d9b60

Browse files
borsbors
committed
Auto merge of rust-lang#86282 - camelid:macro_rules-matchers, r=jyn514
Pretty-print macro matchers instead of using source code Fixes rust-lang#86208.
2 parents 44860d1 + 7ffec70 commit 09d9b60

File tree

14 files changed

+107
-70
lines changed

14 files changed

+107
-70
lines changed

‎compiler/rustc_ast_pretty/src/pprust/state.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,11 @@ pub fn print_crate<'a>(
136136
s.s.eof()
137137
}
138138

139-
// This makes printed token streams look slightly nicer,
140-
// and also addresses some specific regressions described in #63896 and #73345.
139+
/// This makes printed token streams look slightly nicer,
140+
/// and also addresses some specific regressions described in #63896 and #73345.
141141
fn tt_prepend_space(tt: &TokenTree, prev: &TokenTree) -> bool {
142142
if let TokenTree::Token(token) = prev {
143-
if matches!(token.kind, token::Dot) {
143+
if matches!(token.kind, token::Dot | token::Dollar) {
144144
return false;
145145
}
146146
if let token::DocComment(comment_kind, ..) = token.kind {

‎src/librustdoc/clean/inline.rs‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ use rustc_metadata::creader::LoadedMacro;
1313
use rustc_middle::ty::{self, TyCtxt};
1414
use rustc_span::hygiene::MacroKind;
1515
use rustc_span::symbol::{kw, sym, Symbol};
16-
use rustc_span::Span;
1716

1817
use crate::clean::{
19-
self, Attributes, AttributesExt, FakeDefId, GetDefId, NestedAttributesExt, ToSource, Type,
18+
self, utils, Attributes, AttributesExt, FakeDefId, GetDefId, NestedAttributesExt, Type,
2019
};
2120
use crate::core::DocContext;
2221
use crate::formats::item_type::ItemType;
@@ -547,23 +546,20 @@ fn build_macro(cx: &mut DocContext<'_>, did: DefId, name: Symbol) -> clean::Item
547546
let imported_from = cx.tcx.crate_name(did.krate);
548547
match cx.enter_resolver(|r| r.cstore().load_macro_untracked(did, cx.sess())) {
549548
LoadedMacro::MacroDef(def, _) => {
550-
let matchers: Vec<Span> = if let ast::ItemKind::MacroDef(ref def) = def.kind {
549+
if let ast::ItemKind::MacroDef(ref def) = def.kind {
551550
let tts: Vec<_> = def.body.inner_tokens().into_trees().collect();
552-
tts.chunks(4).map(|arm| arm[0].span()).collect()
553-
} else {
554-
unreachable!()
555-
};
551+
let matchers = tts.chunks(4).map(|arm| &arm[0]);
556552

557-
let source = format!(
558-
"macro_rules! {} {{\n{}}}",
559-
name.clean(cx),
560-
matchers
561-
.iter()
562-
.map(|span| { format!(" {} => {{ ... }};\n", span.to_src(cx)) })
563-
.collect::<String>()
564-
);
553+
let source = format!(
554+
"macro_rules! {} {{\n{}}}",
555+
name.clean(cx),
556+
utils::render_macro_arms(matchers, ";")
557+
);
565558

566-
clean::MacroItem(clean::Macro { source, imported_from: Some(imported_from) })
559+
clean::MacroItem(clean::Macro { source, imported_from: Some(imported_from) })
560+
} else {
561+
unreachable!()
562+
}
567563
}
568564
LoadedMacro::ProcMacro(ext) => clean::ProcMacroItem(clean::ProcMacro {
569565
kind: ext.macro_kind(),

‎src/librustdoc/clean/mod.rs‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2172,17 +2172,11 @@ impl Clean<Item> for (&hir::MacroDef<'_>, Option<Symbol>) {
21722172
let (item, renamed) = self;
21732173
let name = renamed.unwrap_or(item.ident.name);
21742174
let tts = item.ast.body.inner_tokens().trees().collect::<Vec<_>>();
2175-
// Extract the spans of all matchers. They represent the "interface" of the macro.
2176-
let matchers = tts.chunks(4).map(|arm| arm[0].span()).collect::<Vec<_>>();
2175+
// Extract the macro's matchers. They represent the "interface" of the macro.
2176+
let matchers = tts.chunks(4).map(|arm| &arm[0]);
2177+
21772178
let source = if item.ast.macro_rules {
2178-
format!(
2179-
"macro_rules! {} {{\n{}}}",
2180-
name,
2181-
matchers
2182-
.iter()
2183-
.map(|span| { format!(" {} => {{ ... }};\n", span.to_src(cx)) })
2184-
.collect::<String>(),
2185-
)
2179+
format!("macro_rules! {} {{\n{}}}", name, render_macro_arms(matchers, ";"))
21862180
} else {
21872181
let vis = item.vis.clean(cx);
21882182
let def_id = item.def_id.to_def_id();
@@ -2192,17 +2186,14 @@ impl Clean<Item> for (&hir::MacroDef<'_>, Option<Symbol>) {
21922186
"{}macro {}{} {{\n ...\n}}",
21932187
vis.to_src_with_space(cx.tcx, def_id),
21942188
name,
2195-
matchers.iter().map(|span| span.to_src(cx)).collect::<String>(),
2189+
matchers.map(render_macro_matcher).collect::<String>(),
21962190
)
21972191
} else {
21982192
format!(
21992193
"{}macro {} {{\n{}}}",
22002194
vis.to_src_with_space(cx.tcx, def_id),
22012195
name,
2202-
matchers
2203-
.iter()
2204-
.map(|span| { format!(" {} => {{ ... }},\n", span.to_src(cx)) })
2205-
.collect::<String>(),
2196+
render_macro_arms(matchers, ","),
22062197
)
22072198
}
22082199
};

‎src/librustdoc/clean/utils.rs‎

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ use crate::clean::{
77
use crate::core::DocContext;
88
use crate::formats::item_type::ItemType;
99

10+
use rustc_ast::tokenstream::TokenTree;
1011
use rustc_hir as hir;
1112
use rustc_hir::def::{DefKind, Res};
1213
use rustc_hir::def_id::{DefId, LOCAL_CRATE};
1314
use rustc_middle::mir::interpret::ConstValue;
1415
use rustc_middle::ty::subst::{GenericArgKind, SubstsRef};
1516
use rustc_middle::ty::{self, DefIdTree, TyCtxt};
1617
use rustc_span::symbol::{kw, sym, Symbol};
18+
use std::fmt::Write as _;
1719
use std::mem;
1820

1921
#[cfg(test)]
@@ -248,22 +250,6 @@ crate fn build_deref_target_impls(cx: &mut DocContext<'_>, items: &[Item], ret:
248250
}
249251
}
250252

251-
crate trait ToSource {
252-
fn to_src(&self, cx: &DocContext<'_>) -> String;
253-
}
254-
255-
impl ToSource for rustc_span::Span {
256-
fn to_src(&self, cx: &DocContext<'_>) -> String {
257-
debug!("converting span {:?} to snippet", self);
258-
let sn = match cx.sess().source_map().span_to_snippet(*self) {
259-
Ok(x) => x,
260-
Err(_) => String::new(),
261-
};
262-
debug!("got snippet {}", sn);
263-
sn
264-
}
265-
}
266-
267253
crate fn name_from_pat(p: &hir::Pat<'_>) -> Symbol {
268254
use rustc_hir::*;
269255
debug!("trying to get a name from pattern: {:?}", p);
@@ -572,3 +558,22 @@ crate fn has_doc_flag(attrs: ty::Attributes<'_>, flag: Symbol) -> bool {
572558
///
573559
/// Set by `bootstrap::Builder::doc_rust_lang_org_channel` in order to keep tests passing on beta/stable.
574560
crate const DOC_RUST_LANG_ORG_CHANNEL: &'static str = env!("DOC_RUST_LANG_ORG_CHANNEL");
561+
562+
/// Render a sequence of macro arms in a format suitable for displaying to the user
563+
/// as part of an item declaration.
564+
pub(super) fn render_macro_arms<'a>(
565+
matchers: impl Iterator<Item = &'a TokenTree>,
566+
arm_delim: &str,
567+
) -> String {
568+
let mut out = String::new();
569+
for matcher in matchers {
570+
writeln!(out, " {} => {{ ... }}{}", render_macro_matcher(matcher), arm_delim).unwrap();
571+
}
572+
out
573+
}
574+
575+
/// Render a macro matcher in a format suitable for displaying to the user
576+
/// as part of an item declaration.
577+
pub(super) fn render_macro_matcher(matcher: &TokenTree) -> String {
578+
rustc_ast_pretty::pprust::tt_to_string(matcher)
579+
}

‎src/test/pretty/cast-lt.pp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88
// pretty-mode:expanded
99
// pp-exact:cast-lt.pp
1010

11-
macro_rules! negative { ($ e : expr) => { $ e < 0 } }
11+
macro_rules! negative { ($e : expr) => { $e < 0 } }
1212

1313
fn main() { (1 as i32) < 0; }

‎src/test/pretty/delimited-token-groups.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
#![feature(rustc_attrs)]
44

5-
macro_rules! mac { ($ ($ tt : tt) *) => () }
5+
macro_rules! mac { ($($tt : tt) *) => () }
66

77
mac! {
88
struct S { field1 : u8, field2 : u16, } impl Clone for S

‎src/test/pretty/macro.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
#![feature(decl_macro)]
44

5-
pub(crate) macro mac { ($ arg : expr) => { $ arg + $ arg } }
5+
pub(crate) macro mac { ($arg : expr) => { $arg + $arg } }
66

77
fn main() { }

‎src/test/pretty/macro_rules.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ macro_rules! matcher_brackets {
1111
}
1212

1313
macro_rules! all_fragments {
14-
($ b : block, $ e : expr, $ i : ident, $ it : item, $ l : lifetime, $ lit
15-
: literal, $ m : meta, $ p : pat, $ pth : path, $ s : stmt, $ tt : tt, $
16-
ty : ty, $ vis : vis) => { } ;
14+
($b : block, $e : expr, $i : ident, $it : item, $l : lifetime, $lit :
15+
literal, $m : meta, $p : pat, $pth : path, $s : stmt, $tt : tt, $ty : ty,
16+
$vis : vis) => { } ;
1717
}
1818

1919
fn main() { }

‎src/test/rustdoc/decl_macro.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ pub macro my_macro() {
99

1010
}
1111

12-
// @has decl_macro/macro.my_macro_2.html //pre 'pub macro my_macro_2($($tok:tt)*) {'
12+
// @has decl_macro/macro.my_macro_2.html //pre 'pub macro my_macro_2($($tok : tt) *) {'
1313
// @has - //pre '...'
1414
// @has - //pre '}'
1515
pub macro my_macro_2($($tok:tt)*) {
@@ -18,8 +18,8 @@ pub macro my_macro_2($($tok:tt)*) {
1818

1919
// @has decl_macro/macro.my_macro_multi.html //pre 'pub macro my_macro_multi {'
2020
// @has - //pre '(_) => { ... },'
21-
// @has - //pre '($foo:ident . $bar:expr) => { ... },'
22-
// @has - //pre '($($foo:literal),+) => { ... }'
21+
// @has - //pre '($foo : ident.$bar : expr) => { ... },'
22+
// @has - //pre '($($foo : literal), +) => { ... },'
2323
// @has - //pre '}'
2424
pub macro my_macro_multi {
2525
(_) => {
@@ -33,7 +33,7 @@ pub macro my_macro_multi {
3333
}
3434
}
3535

36-
// @has decl_macro/macro.by_example_single.html //pre 'pub macro by_example_single($foo:expr) {'
36+
// @has decl_macro/macro.by_example_single.html //pre 'pub macro by_example_single($foo : expr) {'
3737
// @has - //pre '...'
3838
// @has - //pre '}'
3939
pub macro by_example_single {
@@ -42,12 +42,12 @@ pub macro by_example_single {
4242

4343
mod a {
4444
mod b {
45-
// @has decl_macro/a/b/macro.by_example_vis.html //pre 'pub(super) macro by_example_vis($foo:expr) {'
45+
// @has decl_macro/a/b/macro.by_example_vis.html //pre 'pub(super) macro by_example_vis($foo : expr) {'
4646
pub(in super) macro by_example_vis {
4747
($foo:expr) => {}
4848
}
4949
mod c {
50-
// @has decl_macro/a/b/c/macro.by_example_vis_named.html //pre 'pub(in a) macro by_example_vis_named($foo:expr) {'
50+
// @has decl_macro/a/b/c/macro.by_example_vis_named.html //pre 'pub(in a) macro by_example_vis_named($foo : expr) {'
5151
pub(in a) macro by_example_vis_named {
5252
($foo:expr) => {}
5353
}

‎src/test/rustdoc/macro_rules-matchers.rs‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// This is a regression test for issue #86208.
2+
// It is also a general test of macro_rules! display.
3+
4+
#![crate_name = "foo"]
5+
6+
// @has 'foo/macro.todo.html'
7+
// @has - '//span[@class="macro"]' 'macro_rules!'
8+
// @has - '//span[@class="ident"]' 'todo'
9+
// Note: count = 2 * ('=' + '>') + '+' = 2 * (1 + 1) + 1 = 5
10+
// @count - '//pre[@class="rust macro"]//span[@class="op"]' 5
11+
12+
// @has - '{ ()'
13+
// @has - '//span[@class="op"]' '='
14+
// @has - '//span[@class="op"]' '>'
15+
// @has - '{ ... };'
16+
17+
// @has - '($('
18+
// @has - '//span[@class="macro-nonterminal"]' '$'
19+
// @has - '//span[@class="macro-nonterminal"]' 'arg'
20+
// @has - ':'
21+
// @has - '//span[@class="ident"]' 'tt'
22+
// @has - '),'
23+
// @has - '//span[@class="op"]' '+'
24+
// @has - ')'
25+
pub use std::todo;
26+
27+
mod mod1 {
28+
// @has 'foo/macro.macro1.html'
29+
// @has - 'macro_rules!'
30+
// @has - 'macro1'
31+
// @has - '{ ()'
32+
// @has - '($('
33+
// @has - '//span[@class="macro-nonterminal"]' '$'
34+
// @has - '//span[@class="macro-nonterminal"]' 'arg'
35+
// @has - ':'
36+
// @has - 'expr'
37+
// @has - '),'
38+
// @has - '+'
39+
// @has - ')'
40+
#[macro_export]
41+
macro_rules! macro1 {
42+
() => {};
43+
($($arg:expr),+) => { stringify!($($arg),+) };
44+
}
45+
}

0 commit comments

Comments
 (0)