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

Commit 7e8a339

Browse files
committed
Auto merge of rust-lang#16037 - Veykril:proc-macro-backtrace, r=Veykril
fix: Don't print proc-macro panic backtraces in the logs Fixes rust-lang/rust-analyzer#9859
2 parents 9e8d793 + 80dc20f commit 7e8a339

File tree

11 files changed

+41
-42
lines changed

11 files changed

+41
-42
lines changed

crates/hir-expand/src/builtin_fn_macro.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,8 @@ fn line_expand(
152152
span: SpanData,
153153
) -> ExpandResult<tt::Subtree> {
154154
// dummy implementation for type-checking purposes
155+
// Note that `line!` and `column!` will never be implemented properly, as they are by definition
156+
// not incremental
155157
ExpandResult::ok(tt::Subtree {
156158
delimiter: tt::Delimiter::dummy_invisible(),
157159
token_trees: vec![tt::TokenTree::Leaf(tt::Leaf::Literal(tt::Literal {

crates/hir-expand/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ pub enum ExpandError {
7878
Mbe(mbe::ExpandError),
7979
RecursionOverflowPoisoned,
8080
Other(Box<Box<str>>),
81+
ProcMacroPanic(Box<Box<str>>),
8182
}
8283

8384
impl ExpandError {
@@ -100,6 +101,10 @@ impl fmt::Display for ExpandError {
100101
ExpandError::RecursionOverflowPoisoned => {
101102
f.write_str("overflow expanding the original macro")
102103
}
104+
ExpandError::ProcMacroPanic(it) => {
105+
f.write_str("proc-macro panicked: ")?;
106+
f.write_str(it)
107+
}
103108
ExpandError::Other(it) => f.write_str(it),
104109
}
105110
}

crates/hir-expand/src/proc_macro.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ impl ProcMacroExpander {
8585
ProcMacroExpansionError::System(text)
8686
| ProcMacroExpansionError::Panic(text) => ExpandResult::new(
8787
tt::Subtree::empty(tt::DelimSpan { open: call_site, close: call_site }),
88-
ExpandError::other(text),
88+
ExpandError::ProcMacroPanic(Box::new(text.into_boxed_str())),
8989
),
9090
},
9191
}

crates/ide/src/navigation_target.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -736,8 +736,6 @@ fn orig_range_with_focus(
736736
.definition_range(db)
737737
};
738738

739-
// FIXME What about include!d things
740-
741739
let value_range = InFile::new(hir_file, value).original_file_range_opt(db);
742740
let ((call_site_range, call_site_focus), def_site) =
743741
match InFile::new(hir_file, name.syntax()).original_file_range_opt(db) {

crates/ide/src/syntax_highlighting.rs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -404,13 +404,7 @@ fn traverse(
404404
})
405405
.unwrap()
406406
} else {
407-
sema.descend_into_macros_single(
408-
match attr_or_derive_item {
409-
Some(AttrOrDerive::Attr(_)) => DescendPreference::SameKind,
410-
Some(AttrOrDerive::Derive(_)) | None => DescendPreference::None,
411-
},
412-
token,
413-
)
407+
sema.descend_into_macros_single(DescendPreference::SameKind, token)
414408
};
415409
match token.parent().and_then(ast::NameLike::cast) {
416410
// Remap the token into the wrapping single token nodes

crates/ide/src/syntax_highlighting/test_data/highlight_macros.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@
4343
.invalid_escape_sequence { color: #FC5555; text-decoration: wavy underline; }
4444
.unresolved_reference { color: #FC5555; text-decoration: wavy underline; }
4545
</style>
46-
<pre><code><span class="module crate_root library">proc_macros</span><span class="operator">::</span><span class="macro library">mirror</span><span class="macro_bang">!</span> <span class="brace macro">{</span>
46+
<pre><code><span class="keyword">use</span> <span class="module crate_root library">proc_macros</span><span class="operator">::</span><span class="brace">{</span><span class="function library">mirror</span><span class="comma">,</span> <span class="function library">identity</span><span class="comma">,</span> <span class="derive library">DeriveIdentity</span><span class="brace">}</span><span class="semicolon">;</span>
47+
48+
<span class="macro library">mirror</span><span class="macro_bang">!</span> <span class="brace macro">{</span>
4749
<span class="brace macro">{</span>
4850
<span class="comma macro">,</span><span class="builtin_type macro">i32</span> <span class="colon macro">:</span><span class="field declaration macro public">x</span> <span class="keyword macro">pub</span>
4951
<span class="comma macro">,</span><span class="builtin_type macro">i32</span> <span class="colon macro">:</span><span class="field declaration macro public">y</span> <span class="keyword macro">pub</span>

crates/ide/src/syntax_highlighting/test_data/highlight_strings.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"Hello </span><span class="format_specifier">{</span><span class="format_specifier">:</span><span class="format_specifier">+</span><span class="format_specifier">}</span><span class="string_literal macro">!"</span><span class="comma macro">,</span> <span class="numeric_literal macro">5</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
119119
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"</span><span class="format_specifier">{</span><span class="format_specifier">:</span><span class="format_specifier">#</span><span class="variable">x</span><span class="format_specifier">}</span><span class="string_literal macro">!"</span><span class="comma macro">,</span> <span class="numeric_literal macro">27</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
120120
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"Hello </span><span class="format_specifier">{</span><span class="format_specifier">:</span><span class="numeric_literal">0</span><span class="numeric_literal">5</span><span class="format_specifier">}</span><span class="string_literal macro">!"</span><span class="comma macro">,</span> <span class="numeric_literal macro">5</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
121-
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"Hello </span><span class="format_specifier">{</span><span class="format_specifier">:</span><span class="numeric_literal">0</span><span class="numeric_literal">5</span><span class="format_specifier">}</span><span class="string_literal macro">!"</span>, <span class="numeric_literal macro">-</span><span class="numeric_literal macro">5</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
121+
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"Hello </span><span class="format_specifier">{</span><span class="format_specifier">:</span><span class="numeric_literal">0</span><span class="numeric_literal">5</span><span class="format_specifier">}</span><span class="string_literal macro">!"</span><span class="comma macro">,</span> <span class="numeric_literal macro">-</span><span class="numeric_literal macro">5</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
122122
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"</span><span class="format_specifier">{</span><span class="format_specifier">:</span><span class="format_specifier">#</span><span class="numeric_literal">0</span><span class="numeric_literal">10</span><span class="variable">x</span><span class="format_specifier">}</span><span class="string_literal macro">!"</span><span class="comma macro">,</span> <span class="numeric_literal macro">27</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
123123
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"Hello </span><span class="format_specifier">{</span><span class="numeric_literal">0</span><span class="format_specifier">}</span><span class="string_literal macro"> is </span><span class="format_specifier">{</span><span class="numeric_literal">1</span><span class="format_specifier">:</span><span class="format_specifier">.</span><span class="numeric_literal">5</span><span class="format_specifier">}</span><span class="string_literal macro">"</span><span class="comma macro">,</span> <span class="string_literal macro">"x"</span><span class="comma macro">,</span> <span class="numeric_literal macro">0.01</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
124124
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"Hello </span><span class="format_specifier">{</span><span class="numeric_literal">1</span><span class="format_specifier">}</span><span class="string_literal macro"> is </span><span class="format_specifier">{</span><span class="numeric_literal">2</span><span class="format_specifier">:</span><span class="format_specifier">.</span><span class="numeric_literal">0</span><span class="format_specifier">$</span><span class="format_specifier">}</span><span class="string_literal macro">"</span><span class="comma macro">,</span> <span class="numeric_literal macro">5</span><span class="comma macro">,</span> <span class="string_literal macro">"x"</span><span class="comma macro">,</span> <span class="numeric_literal macro">0.01</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>

crates/ide/src/syntax_highlighting/tests.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,12 @@ struct Foo;
4747
fn macros() {
4848
check_highlighting(
4949
r#"
50-
//- proc_macros: mirror
50+
//- proc_macros: mirror, identity, derive_identity
5151
//- minicore: fmt, include, concat
5252
//- /lib.rs crate:lib
53-
proc_macros::mirror! {
53+
use proc_macros::{mirror, identity, DeriveIdentity};
54+
55+
mirror! {
5456
{
5557
,i32 :x pub
5658
,i32 :y pub

crates/proc-macro-srv/src/dylib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ impl Expander {
160160
.inner
161161
.proc_macros
162162
.expand(macro_name, macro_body, attributes, def_site, call_site, mixed_site);
163-
result.map_err(|e| e.as_str().unwrap_or_else(|| "<unknown error>".to_string()))
163+
result.map_err(|e| e.into_string().unwrap_or_default())
164164
}
165165

166166
pub fn list_macros(&self) -> Vec<(String, ProcMacroKind)> {

crates/proc-macro-srv/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ pub struct PanicMessage {
160160
}
161161

162162
impl PanicMessage {
163-
pub fn as_str(&self) -> Option<String> {
164-
self.message.clone()
163+
pub fn into_string(self) -> Option<String> {
164+
self.message
165165
}
166166
}
167167

crates/proc-macro-srv/src/proc_macros.rs

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
//! Proc macro ABI
22
33
use libloading::Library;
4+
use proc_macro::bridge;
45
use proc_macro_api::{msg::TokenId, ProcMacroKind, RustCInfo};
56

67
use crate::{dylib::LoadProcMacroDylibError, server::SYMBOL_INTERNER, tt};
78

89
pub(crate) struct ProcMacros {
9-
exported_macros: Vec<proc_macro::bridge::client::ProcMacro>,
10+
exported_macros: Vec<bridge::client::ProcMacro>,
1011
}
1112

12-
impl From<proc_macro::bridge::PanicMessage> for crate::PanicMessage {
13-
fn from(p: proc_macro::bridge::PanicMessage) -> Self {
13+
impl From<bridge::PanicMessage> for crate::PanicMessage {
14+
fn from(p: bridge::PanicMessage) -> Self {
1415
Self { message: p.as_str().map(|s| s.to_string()) }
1516
}
1617
}
@@ -31,9 +32,8 @@ impl ProcMacros {
3132
info: RustCInfo,
3233
) -> Result<ProcMacros, LoadProcMacroDylibError> {
3334
if info.version_string == crate::RUSTC_VERSION_STRING {
34-
let macros = unsafe {
35-
lib.get::<&&[proc_macro::bridge::client::ProcMacro]>(symbol_name.as_bytes())
36-
}?;
35+
let macros =
36+
unsafe { lib.get::<&&[bridge::client::ProcMacro]>(symbol_name.as_bytes()) }?;
3737

3838
return Ok(Self { exported_macros: macros.to_vec() });
3939
}
@@ -57,47 +57,43 @@ impl ProcMacros {
5757

5858
for proc_macro in &self.exported_macros {
5959
match proc_macro {
60-
proc_macro::bridge::client::ProcMacro::CustomDerive {
61-
trait_name, client, ..
62-
} if *trait_name == macro_name => {
60+
bridge::client::ProcMacro::CustomDerive { trait_name, client, .. }
61+
if *trait_name == macro_name =>
62+
{
6363
let res = client.run(
64-
&proc_macro::bridge::server::SameThread,
64+
&bridge::server::SameThread,
6565
crate::server::RustAnalyzer {
6666
interner: &SYMBOL_INTERNER,
6767
call_site,
6868
def_site,
6969
mixed_site,
7070
},
7171
parsed_body,
72-
true,
72+
false,
7373
);
7474
return res
7575
.map(|it| it.into_subtree(call_site))
7676
.map_err(crate::PanicMessage::from);
7777
}
78-
proc_macro::bridge::client::ProcMacro::Bang { name, client }
79-
if *name == macro_name =>
80-
{
78+
bridge::client::ProcMacro::Bang { name, client } if *name == macro_name => {
8179
let res = client.run(
82-
&proc_macro::bridge::server::SameThread,
80+
&bridge::server::SameThread,
8381
crate::server::RustAnalyzer {
8482
interner: &SYMBOL_INTERNER,
8583
call_site,
8684
def_site,
8785
mixed_site,
8886
},
8987
parsed_body,
90-
true,
88+
false,
9189
);
9290
return res
9391
.map(|it| it.into_subtree(call_site))
9492
.map_err(crate::PanicMessage::from);
9593
}
96-
proc_macro::bridge::client::ProcMacro::Attr { name, client }
97-
if *name == macro_name =>
98-
{
94+
bridge::client::ProcMacro::Attr { name, client } if *name == macro_name => {
9995
let res = client.run(
100-
&proc_macro::bridge::server::SameThread,
96+
&bridge::server::SameThread,
10197
crate::server::RustAnalyzer {
10298
interner: &SYMBOL_INTERNER,
10399

@@ -107,7 +103,7 @@ impl ProcMacros {
107103
},
108104
parsed_attributes,
109105
parsed_body,
110-
true,
106+
false,
111107
);
112108
return res
113109
.map(|it| it.into_subtree(call_site))
@@ -117,20 +113,20 @@ impl ProcMacros {
117113
}
118114
}
119115

120-
Err(proc_macro::bridge::PanicMessage::String("Nothing to expand".to_string()).into())
116+
Err(bridge::PanicMessage::String("Nothing to expand".to_string()).into())
121117
}
122118

123119
pub(crate) fn list_macros(&self) -> Vec<(String, ProcMacroKind)> {
124120
self.exported_macros
125121
.iter()
126122
.map(|proc_macro| match proc_macro {
127-
proc_macro::bridge::client::ProcMacro::CustomDerive { trait_name, .. } => {
123+
bridge::client::ProcMacro::CustomDerive { trait_name, .. } => {
128124
(trait_name.to_string(), ProcMacroKind::CustomDerive)
129125
}
130-
proc_macro::bridge::client::ProcMacro::Bang { name, .. } => {
126+
bridge::client::ProcMacro::Bang { name, .. } => {
131127
(name.to_string(), ProcMacroKind::FuncLike)
132128
}
133-
proc_macro::bridge::client::ProcMacro::Attr { name, .. } => {
129+
bridge::client::ProcMacro::Attr { name, .. } => {
134130
(name.to_string(), ProcMacroKind::Attr)
135131
}
136132
})

0 commit comments

Comments
 (0)