Skip to content

Commit 72bfe61

Browse files
mystormystor
committed
proc_macro: stop using a remote object handle for Punct
This greatly reduces round-trips to fetch relevant extra information about the token in proc macro code, and avoids RPC messages to create Punct tokens.
1 parent 3b0d481 commit 72bfe61

File tree

6 files changed

+49
-95
lines changed

6 files changed

+49
-95
lines changed

‎compiler/rustc_expand/src/proc_macro_server.rs

Lines changed: 16 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ use rustc_span::def_id::CrateNum;
1414
use rustc_span::symbol::{self, kw, sym, Symbol};
1515
use rustc_span::{BytePos, FileName, Pos, SourceFile, Span};
1616

17-
use pm::bridge::{server, ExpnGlobals, TokenTree};
18-
use pm::{Delimiter, Level, LineColumn, Spacing};
17+
use pm::bridge::{server, ExpnGlobals, Punct, TokenTree};
18+
use pm::{Delimiter, Level, LineColumn};
1919
use std::ops::Bound;
2020
use std::{ascii, panic};
2121

@@ -50,7 +50,7 @@ impl ToInternal<token::Delimiter> for Delimiter {
5050
}
5151

5252
impl FromInternal<(TreeAndSpacing, &'_ mut Vec<Self>, &mut Rustc<'_, '_>)>
53-
for TokenTree<Group, Punct, Ident, Literal>
53+
for TokenTree<Span, Group, Ident, Literal>
5454
{
5555
fn from_internal(
5656
((tree, spacing), stack, rustc): (TreeAndSpacing, &mut Vec<Self>, &mut Rustc<'_, '_>),
@@ -79,16 +79,16 @@ impl FromInternal<(TreeAndSpacing, &'_ mut Vec<Self>, &mut Rustc<'_, '_>)>
7979
}
8080
macro_rules! op {
8181
($a:expr) => {
82-
tt!(Punct::new($a, joint))
82+
tt!(Punct { ch: $a, joint })
8383
};
8484
($a:expr, $b:expr) => {{
85-
stack.push(tt!(Punct::new($b, joint)));
86-
tt!(Punct::new($a, true))
85+
stack.push(tt!(Punct { ch: $b, joint }));
86+
tt!(Punct { ch: $a, joint: true })
8787
}};
8888
($a:expr, $b:expr, $c:expr) => {{
89-
stack.push(tt!(Punct::new($c, joint)));
90-
stack.push(tt!(Punct::new($b, true)));
91-
tt!(Punct::new($a, true))
89+
stack.push(tt!(Punct { ch: $c, joint }));
90+
stack.push(tt!(Punct { ch: $b, joint: true }));
91+
tt!(Punct { ch: $a, joint: true })
9292
}};
9393
}
9494

@@ -146,7 +146,7 @@ impl FromInternal<(TreeAndSpacing, &'_ mut Vec<Self>, &mut Rustc<'_, '_>)>
146146
Lifetime(name) => {
147147
let ident = symbol::Ident::new(name, span).without_first_quote();
148148
stack.push(tt!(Ident::new(rustc.sess(), ident.name, false)));
149-
tt!(Punct::new('\'', true))
149+
tt!(Punct { ch: '\'', joint: true })
150150
}
151151
Literal(lit) => tt!(Literal { lit }),
152152
DocComment(_, attr_style, data) => {
@@ -169,9 +169,9 @@ impl FromInternal<(TreeAndSpacing, &'_ mut Vec<Self>, &mut Rustc<'_, '_>)>
169169
flatten: false,
170170
}));
171171
if attr_style == ast::AttrStyle::Inner {
172-
stack.push(tt!(Punct::new('!', false)));
172+
stack.push(tt!(Punct { ch: '!', joint: false }));
173173
}
174-
tt!(Punct::new('#', false))
174+
tt!(Punct { ch: '#', joint: false })
175175
}
176176

177177
Interpolated(nt) if let NtIdent(ident, is_raw) = *nt => {
@@ -192,7 +192,7 @@ impl FromInternal<(TreeAndSpacing, &'_ mut Vec<Self>, &mut Rustc<'_, '_>)>
192192
}
193193
}
194194

195-
impl ToInternal<TokenStream> for TokenTree<Group, Punct, Ident, Literal> {
195+
impl ToInternal<TokenStream> for TokenTree<Span, Group, Ident, Literal> {
196196
fn to_internal(self) -> TokenStream {
197197
use rustc_ast::token::*;
198198

@@ -288,27 +288,6 @@ pub struct Group {
288288
flatten: bool,
289289
}
290290

291-
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
292-
pub struct Punct {
293-
ch: char,
294-
// NB. not using `Spacing` here because it doesn't implement `Hash`.
295-
joint: bool,
296-
span: Span,
297-
}
298-
299-
impl Punct {
300-
fn new(ch: char, joint: bool, span: Span) -> Punct {
301-
const LEGAL_CHARS: &[char] = &[
302-
'=', '<', '>', '!', '~', '+', '-', '*', '/', '%', '^', '&', '|', '@', '.', ',', ';',
303-
':', '#', '$', '?', '\'',
304-
];
305-
if !LEGAL_CHARS.contains(&ch) {
306-
panic!("unsupported character `{:?}`", ch)
307-
}
308-
Punct { ch, joint, span }
309-
}
310-
}
311-
312291
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
313292
pub struct Ident {
314293
sym: Symbol,
@@ -378,7 +357,6 @@ impl server::Types for Rustc<'_, '_> {
378357
type FreeFunctions = FreeFunctions;
379358
type TokenStream = TokenStream;
380359
type Group = Group;
381-
type Punct = Punct;
382360
type Ident = Ident;
383361
type Literal = Literal;
384362
type SourceFile = Lrc<SourceFile>;
@@ -471,15 +449,15 @@ impl server::TokenStream for Rustc<'_, '_> {
471449

472450
fn from_token_tree(
473451
&mut self,
474-
tree: TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>,
452+
tree: TokenTree<Self::Span, Self::Group, Self::Ident, Self::Literal>,
475453
) -> Self::TokenStream {
476454
tree.to_internal()
477455
}
478456

479457
fn concat_trees(
480458
&mut self,
481459
base: Option<Self::TokenStream>,
482-
trees: Vec<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>>,
460+
trees: Vec<TokenTree<Self::Span, Self::Group, Self::Ident, Self::Literal>>,
483461
) -> Self::TokenStream {
484462
let mut builder = tokenstream::TokenStreamBuilder::new();
485463
if let Some(base) = base {
@@ -509,7 +487,7 @@ impl server::TokenStream for Rustc<'_, '_> {
509487
fn into_trees(
510488
&mut self,
511489
stream: Self::TokenStream,
512-
) -> Vec<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>> {
490+
) -> Vec<TokenTree<Self::Span, Self::Group, Self::Ident, Self::Literal>> {
513491
// FIXME: This is a raw port of the previous approach (which had a
514492
// `TokenStreamIter` server-side object with a single `next` method),
515493
// and can probably be optimized (for bulk conversion).
@@ -577,28 +555,6 @@ impl server::Group for Rustc<'_, '_> {
577555
}
578556
}
579557

580-
impl server::Punct for Rustc<'_, '_> {
581-
fn new(&mut self, ch: char, spacing: Spacing) -> Self::Punct {
582-
Punct::new(ch, spacing == Spacing::Joint, self.call_site)
583-
}
584-
585-
fn as_char(&mut self, punct: Self::Punct) -> char {
586-
punct.ch
587-
}
588-
589-
fn spacing(&mut self, punct: Self::Punct) -> Spacing {
590-
if punct.joint { Spacing::Joint } else { Spacing::Alone }
591-
}
592-
593-
fn span(&mut self, punct: Self::Punct) -> Self::Span {
594-
punct.span
595-
}
596-
597-
fn with_span(&mut self, punct: Self::Punct, span: Self::Span) -> Self::Punct {
598-
Punct { span, ..punct }
599-
}
600-
}
601-
602558
impl server::Ident for Rustc<'_, '_> {
603559
fn new(&mut self, string: &str, span: Self::Span, is_raw: bool) -> Self::Ident {
604560
Ident::new(self.sess(), Symbol::intern(string), is_raw, span)

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,6 @@ define_handles! {
182182
Diagnostic,
183183

184184
'interned:
185-
Punct,
186185
Ident,
187186
Span,
188187
}

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

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -65,19 +65,19 @@ macro_rules! with_api {
6565
fn from_str(src: &str) -> $S::TokenStream;
6666
fn to_string($self: &$S::TokenStream) -> String;
6767
fn from_token_tree(
68-
tree: TokenTree<$S::Group, $S::Punct, $S::Ident, $S::Literal>,
68+
tree: TokenTree<$S::Span, $S::Group, $S::Ident, $S::Literal>,
6969
) -> $S::TokenStream;
7070
fn concat_trees(
7171
base: Option<$S::TokenStream>,
72-
trees: Vec<TokenTree<$S::Group, $S::Punct, $S::Ident, $S::Literal>>,
72+
trees: Vec<TokenTree<$S::Span, $S::Group, $S::Ident, $S::Literal>>,
7373
) -> $S::TokenStream;
7474
fn concat_streams(
7575
base: Option<$S::TokenStream>,
7676
streams: Vec<$S::TokenStream>,
7777
) -> $S::TokenStream;
7878
fn into_trees(
7979
$self: $S::TokenStream
80-
) -> Vec<TokenTree<$S::Group, $S::Punct, $S::Ident, $S::Literal>>;
80+
) -> Vec<TokenTree<$S::Span, $S::Group, $S::Ident, $S::Literal>>;
8181
},
8282
Group {
8383
fn drop($self: $S::Group);
@@ -90,13 +90,6 @@ macro_rules! with_api {
9090
fn span_close($self: &$S::Group) -> $S::Span;
9191
fn set_span($self: &mut $S::Group, span: $S::Span);
9292
},
93-
Punct {
94-
fn new(ch: char, spacing: Spacing) -> $S::Punct;
95-
fn as_char($self: $S::Punct) -> char;
96-
fn spacing($self: $S::Punct) -> Spacing;
97-
fn span($self: $S::Punct) -> $S::Span;
98-
fn with_span($self: $S::Punct, span: $S::Span) -> $S::Punct;
99-
},
10093
Ident {
10194
fn new(string: &str, span: $S::Span, is_raw: bool) -> $S::Ident;
10295
fn span($self: $S::Ident) -> $S::Span;
@@ -449,15 +442,24 @@ compound_traits!(
449442
);
450443

451444
#[derive(Clone)]
452-
pub enum TokenTree<G, P, I, L> {
445+
pub struct Punct<S> {
446+
pub ch: char,
447+
pub joint: bool,
448+
pub span: S,
449+
}
450+
451+
compound_traits!(struct Punct<Sp> { ch, joint, span });
452+
453+
#[derive(Clone)]
454+
pub enum TokenTree<S, G, I, L> {
453455
Group(G),
454-
Punct(P),
456+
Punct(Punct<S>),
455457
Ident(I),
456458
Literal(L),
457459
}
458460

459461
compound_traits!(
460-
enum TokenTree<G, P, I, L> {
462+
enum TokenTree<Sp, G, I, L> {
461463
Group(tt),
462464
Punct(tt),
463465
Ident(tt),

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ pub trait Types {
99
type FreeFunctions: 'static;
1010
type TokenStream: 'static + Clone;
1111
type Group: 'static + Clone;
12-
type Punct: 'static + Copy + Eq + Hash;
1312
type Ident: 'static + Copy + Eq + Hash;
1413
type Literal: 'static + Clone;
1514
type SourceFile: 'static + Clone;

‎library/proc_macro/src/lib.rs

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,8 @@ pub use quote::{quote, quote_span};
212212
fn tree_to_bridge_tree(
213213
tree: TokenTree,
214214
) -> bridge::TokenTree<
215+
bridge::client::Span,
215216
bridge::client::Group,
216-
bridge::client::Punct,
217217
bridge::client::Ident,
218218
bridge::client::Literal,
219219
> {
@@ -238,8 +238,8 @@ impl From<TokenTree> for TokenStream {
238238
struct ConcatTreesHelper {
239239
trees: Vec<
240240
bridge::TokenTree<
241+
bridge::client::Span,
241242
bridge::client::Group,
242-
bridge::client::Punct,
243243
bridge::client::Ident,
244244
bridge::client::Literal,
245245
>,
@@ -365,8 +365,8 @@ pub mod token_stream {
365365
pub struct IntoIter(
366366
std::vec::IntoIter<
367367
bridge::TokenTree<
368+
bridge::client::Span,
368369
bridge::client::Group,
369-
bridge::client::Punct,
370370
bridge::client::Ident,
371371
bridge::client::Literal,
372372
>,
@@ -925,7 +925,7 @@ impl fmt::Debug for Group {
925925
/// forms of `Spacing` returned.
926926
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
927927
#[derive(Clone)]
928-
pub struct Punct(bridge::client::Punct);
928+
pub struct Punct(bridge::Punct<bridge::client::Span>);
929929

930930
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
931931
impl !Send for Punct {}
@@ -958,13 +958,20 @@ impl Punct {
958958
/// which can be further configured with the `set_span` method below.
959959
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
960960
pub fn new(ch: char, spacing: Spacing) -> Punct {
961-
Punct(bridge::client::Punct::new(ch, spacing))
961+
const LEGAL_CHARS: &[char] = &[
962+
'=', '<', '>', '!', '~', '+', '-', '*', '/', '%', '^', '&', '|', '@', '.', ',', ';',
963+
':', '#', '$', '?', '\'',
964+
];
965+
if !LEGAL_CHARS.contains(&ch) {
966+
panic!("unsupported character `{:?}`", ch);
967+
}
968+
Punct(bridge::Punct { ch, joint: spacing == Spacing::Joint, span: Span::call_site().0 })
962969
}
963970

964971
/// Returns the value of this punctuation character as `char`.
965972
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
966973
pub fn as_char(&self) -> char {
967-
self.0.as_char()
974+
self.0.ch
968975
}
969976

970977
/// Returns the spacing of this punctuation character, indicating whether it's immediately
@@ -973,28 +980,19 @@ impl Punct {
973980
/// (`Alone`) so the operator has certainly ended.
974981
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
975982
pub fn spacing(&self) -> Spacing {
976-
self.0.spacing()
983+
if self.0.joint { Spacing::Joint } else { Spacing::Alone }
977984
}
978985

979986
/// Returns the span for this punctuation character.
980987
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
981988
pub fn span(&self) -> Span {
982-
Span(self.0.span())
989+
Span(self.0.span)
983990
}
984991

985992
/// Configure the span for this punctuation character.
986993
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
987994
pub fn set_span(&mut self, span: Span) {
988-
self.0 = self.0.with_span(span.0);
989-
}
990-
}
991-
992-
// N.B., the bridge only provides `to_string`, implement `fmt::Display`
993-
// based on it (the reverse of the usual relationship between the two).
994-
#[stable(feature = "proc_macro_lib", since = "1.15.0")]
995-
impl ToString for Punct {
996-
fn to_string(&self) -> String {
997-
TokenStream::from(TokenTree::from(self.clone())).to_string()
995+
self.0.span = span.0;
998996
}
999997
}
1000998

@@ -1003,7 +1001,7 @@ impl ToString for Punct {
10031001
#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
10041002
impl fmt::Display for Punct {
10051003
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1006-
f.write_str(&self.to_string())
1004+
write!(f, "{}", self.as_char())
10071005
}
10081006
}
10091007

‎src/test/ui/proc-macro/invalid-punct-ident-1.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// rustc-env:RUST_BACKTRACE=0
33

44
// FIXME https://github.com/rust-lang/rust/issues/59998
5-
// normalize-stderr-test "thread.*panicked.*proc_macro_server.rs.*\n" -> ""
5+
// normalize-stderr-test "thread.*panicked.*proc_macro.*lib.rs.*\n" -> ""
66
// normalize-stderr-test "note:.*RUST_BACKTRACE=1.*\n" -> ""
77
// normalize-stderr-test "\nerror: internal compiler error.*\n\n" -> ""
88
// normalize-stderr-test "note:.*unexpectedly panicked.*\n\n" -> ""

0 commit comments

Comments
 (0)