1 //! Rustc proc-macro server implementation with tt
3 //! Based on idea from https://github.com/fedochet/rust-proc-macro-expander
4 //! The lib-proc-macro server backend is `TokenStream`-agnostic, such that
5 //! we could provide any TokenStream implementation.
6 //! The original idea from fedochet is using proc-macro2 as backend,
7 //! we use tt instead for better integration with RA.
9 //! FIXME: No span and source file information is implemented yet
11 use crate::proc_macro::bridge::{self, server};
13 use std::collections::HashMap;
15 use std::iter::FromIterator;
17 use std::{ascii, vec::IntoIter};
19 type Group = tt::Subtree;
20 type TokenTree = tt::TokenTree;
21 type Punct = tt::Punct;
22 type Spacing = tt::Spacing;
23 type Literal = tt::Literal;
24 type Span = tt::TokenId;
26 #[derive(Debug, Clone)]
27 pub struct TokenStream {
28 pub subtree: tt::Subtree,
32 pub fn new() -> Self {
33 TokenStream { subtree: Default::default() }
36 pub fn with_subtree(subtree: tt::Subtree) -> Self {
37 TokenStream { subtree }
40 pub fn is_empty(&self) -> bool {
41 self.subtree.token_trees.is_empty()
45 /// Creates a token stream containing a single token tree.
46 impl From<TokenTree> for TokenStream {
47 fn from(tree: TokenTree) -> TokenStream {
48 TokenStream { subtree: tt::Subtree { delimiter: None, token_trees: vec![tree] } }
52 /// Collects a number of token trees into a single stream.
53 impl FromIterator<TokenTree> for TokenStream {
54 fn from_iter<I: IntoIterator<Item = TokenTree>>(trees: I) -> Self {
55 trees.into_iter().map(TokenStream::from).collect()
59 /// A "flattening" operation on token streams, collects token trees
60 /// from multiple token streams into a single stream.
61 impl FromIterator<TokenStream> for TokenStream {
62 fn from_iter<I: IntoIterator<Item = TokenStream>>(streams: I) -> Self {
63 let mut builder = TokenStreamBuilder::new();
64 streams.into_iter().for_each(|stream| builder.push(stream));
69 impl Extend<TokenTree> for TokenStream {
70 fn extend<I: IntoIterator<Item = TokenTree>>(&mut self, trees: I) {
71 self.extend(trees.into_iter().map(TokenStream::from));
75 impl Extend<TokenStream> for TokenStream {
76 fn extend<I: IntoIterator<Item = TokenStream>>(&mut self, streams: I) {
80 tt::TokenTree::Subtree(subtree) if subtree.delimiter.is_none() => {
81 self.subtree.token_trees.extend(subtree.token_trees);
84 self.subtree.token_trees.push(tkn);
92 type Level = crate::proc_macro::Level;
93 type LineColumn = crate::proc_macro::LineColumn;
94 type SourceFile = crate::proc_macro::SourceFile;
96 /// A structure representing a diagnostic message and associated children
98 #[derive(Clone, Debug)]
99 pub struct Diagnostic {
103 children: Vec<Diagnostic>,
107 /// Creates a new diagnostic with the given `level` and `message`.
108 pub fn new<T: Into<String>>(level: Level, message: T) -> Diagnostic {
109 Diagnostic { level, message: message.into(), spans: vec![], children: vec![] }
113 // Rustc Server Ident has to be `Copyable`
114 // We use a stub here for bypassing
115 #[derive(Hash, Eq, PartialEq, Copy, Clone)]
116 pub struct IdentId(u32);
118 #[derive(Clone, Hash, Eq, PartialEq)]
119 struct IdentData(tt::Ident);
122 struct IdentInterner {
123 idents: HashMap<IdentData, u32>,
124 ident_data: Vec<IdentData>,
128 fn intern(&mut self, data: &IdentData) -> u32 {
129 if let Some(index) = self.idents.get(data) {
133 let index = self.idents.len() as u32;
134 self.ident_data.push(data.clone());
135 self.idents.insert(data.clone(), index);
139 fn get(&self, index: u32) -> &IdentData {
140 &self.ident_data[index as usize]
144 fn get_mut(&mut self, index: u32) -> &mut IdentData {
145 self.ident_data.get_mut(index as usize).expect("Should be consistent")
149 pub struct TokenStreamBuilder {
153 /// Public implementation details for the `TokenStream` type, such as iterators.
154 pub mod token_stream {
155 use std::str::FromStr;
157 use super::{TokenStream, TokenTree};
159 /// An iterator over `TokenStream`'s `TokenTree`s.
160 /// The iteration is "shallow", e.g., the iterator doesn't recurse into delimited groups,
161 /// and returns whole groups as token trees.
162 impl IntoIterator for TokenStream {
163 type Item = TokenTree;
164 type IntoIter = super::IntoIter<TokenTree>;
166 fn into_iter(self) -> Self::IntoIter {
167 self.subtree.token_trees.into_iter()
171 type LexError = String;
173 /// Attempts to break the string into tokens and parse those tokens into a token stream.
174 /// May fail for a number of reasons, for example, if the string contains unbalanced delimiters
175 /// or characters not existing in the language.
176 /// All tokens in the parsed stream get `Span::call_site()` spans.
178 /// NOTE: some errors may cause panics instead of returning `LexError`. We reserve the right to
179 /// change these errors into `LexError`s later.
180 impl FromStr for TokenStream {
183 fn from_str(src: &str) -> Result<TokenStream, LexError> {
184 let (subtree, _token_map) =
185 mbe::parse_to_token_tree(src).ok_or("Failed to parse from mbe")?;
187 Ok(TokenStream { subtree })
191 impl ToString for TokenStream {
192 fn to_string(&self) -> String {
193 let tt = self.subtree.clone().into();
198 fn to_text(tkn: &tt::TokenTree) -> String {
200 tt::TokenTree::Leaf(tt::Leaf::Ident(ident)) => ident.text.clone().into(),
201 tt::TokenTree::Leaf(tt::Leaf::Literal(literal)) => literal.text.clone().into(),
202 tt::TokenTree::Leaf(tt::Leaf::Punct(punct)) => format!("{}", punct.char),
203 tt::TokenTree::Subtree(subtree) => {
204 let content = subtree
207 .fold((String::new(), true), |(last, last_to_joint), tkn| {
208 let s = [last, to_text(tkn)].join(if last_to_joint { "" } else { " " });
209 let mut is_joint = false;
210 if let tt::TokenTree::Leaf(tt::Leaf::Punct(punct)) = tkn {
211 if punct.spacing == tt::Spacing::Joint {
219 let (open, close) = match subtree.delimiter.map(|it| it.kind) {
221 Some(tt::DelimiterKind::Brace) => ("{", "}"),
222 Some(tt::DelimiterKind::Parenthesis) => ("(", ")"),
223 Some(tt::DelimiterKind::Bracket) => ("[", "]"),
225 format!("{}{}{}", open, content, close)
231 impl TokenStreamBuilder {
232 fn new() -> TokenStreamBuilder {
233 TokenStreamBuilder { acc: TokenStream::new() }
236 fn push(&mut self, stream: TokenStream) {
237 self.acc.extend(stream.into_iter())
240 fn build(self) -> TokenStream {
245 pub struct FreeFunctions;
248 pub struct TokenStreamIter {
249 trees: IntoIter<TokenTree>,
254 ident_interner: IdentInterner,
255 // FIXME: store span information here.
258 impl server::Types for Rustc {
259 type FreeFunctions = FreeFunctions;
260 type TokenStream = TokenStream;
261 type TokenStreamBuilder = TokenStreamBuilder;
262 type TokenStreamIter = TokenStreamIter;
265 type Ident = IdentId;
266 type Literal = Literal;
267 type SourceFile = SourceFile;
268 type Diagnostic = Diagnostic;
270 type MultiSpan = Vec<Span>;
273 impl server::FreeFunctions for Rustc {
274 fn track_env_var(&mut self, _var: &str, _value: Option<&str>) {
275 // FIXME: track env var accesses
276 // https://github.com/rust-lang/rust/pull/71858
280 fn subtree_replace_token_ids_with_unspecified(subtree: tt::Subtree) -> tt::Subtree {
282 delimiter: subtree.delimiter.map(|d| tt::Delimiter { id: tt::TokenId::unspecified(), ..d }),
286 .map(|t| token_tree_replace_token_ids_with_unspecified(t))
291 fn token_tree_replace_token_ids_with_unspecified(tt: tt::TokenTree) -> tt::TokenTree {
293 tt::TokenTree::Leaf(leaf) => {
294 tt::TokenTree::Leaf(leaf_replace_token_ids_with_unspecified(leaf))
296 tt::TokenTree::Subtree(subtree) => {
297 tt::TokenTree::Subtree(subtree_replace_token_ids_with_unspecified(subtree))
302 fn leaf_replace_token_ids_with_unspecified(leaf: tt::Leaf) -> tt::Leaf {
304 tt::Leaf::Literal(lit) => {
305 tt::Leaf::Literal(tt::Literal { id: tt::TokenId::unspecified(), ..lit })
307 tt::Leaf::Punct(punct) => {
308 tt::Leaf::Punct(tt::Punct { id: tt::TokenId::unspecified(), ..punct })
310 tt::Leaf::Ident(ident) => {
311 tt::Leaf::Ident(tt::Ident { id: tt::TokenId::unspecified(), ..ident })
316 impl server::TokenStream for Rustc {
317 fn new(&mut self) -> Self::TokenStream {
318 Self::TokenStream::new()
321 fn is_empty(&mut self, stream: &Self::TokenStream) -> bool {
324 fn from_str(&mut self, src: &str) -> Self::TokenStream {
325 let (subtree, _) = mbe::parse_to_token_tree(src).expect("cannot parse string");
326 TokenStream::with_subtree(subtree_replace_token_ids_with_unspecified(subtree))
328 fn to_string(&mut self, stream: &Self::TokenStream) -> String {
333 tree: bridge::TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>,
334 ) -> Self::TokenStream {
336 bridge::TokenTree::Group(group) => {
337 let tree = TokenTree::from(group);
338 Self::TokenStream::from_iter(vec![tree])
341 bridge::TokenTree::Ident(IdentId(index)) => {
342 let IdentData(ident) = self.ident_interner.get(index).clone();
343 let ident: tt::Ident = ident;
344 let leaf = tt::Leaf::from(ident);
345 let tree = TokenTree::from(leaf);
346 Self::TokenStream::from_iter(vec![tree])
349 bridge::TokenTree::Literal(literal) => {
350 let leaf = tt::Leaf::from(literal);
351 let tree = TokenTree::from(leaf);
352 Self::TokenStream::from_iter(vec![tree])
355 bridge::TokenTree::Punct(p) => {
356 let leaf = tt::Leaf::from(p);
357 let tree = TokenTree::from(leaf);
358 Self::TokenStream::from_iter(vec![tree])
363 fn into_iter(&mut self, stream: Self::TokenStream) -> Self::TokenStreamIter {
364 let trees: Vec<TokenTree> = stream.into_iter().collect();
365 TokenStreamIter { trees: trees.into_iter() }
369 impl server::TokenStreamBuilder for Rustc {
370 fn new(&mut self) -> Self::TokenStreamBuilder {
371 Self::TokenStreamBuilder::new()
373 fn push(&mut self, builder: &mut Self::TokenStreamBuilder, stream: Self::TokenStream) {
376 fn build(&mut self, builder: Self::TokenStreamBuilder) -> Self::TokenStream {
381 impl server::TokenStreamIter for Rustc {
384 iter: &mut Self::TokenStreamIter,
385 ) -> Option<bridge::TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>> {
386 iter.trees.next().map(|tree| match tree {
387 TokenTree::Subtree(group) => bridge::TokenTree::Group(group),
388 TokenTree::Leaf(tt::Leaf::Ident(ident)) => {
389 bridge::TokenTree::Ident(IdentId(self.ident_interner.intern(&IdentData(ident))))
391 TokenTree::Leaf(tt::Leaf::Literal(literal)) => bridge::TokenTree::Literal(literal),
392 TokenTree::Leaf(tt::Leaf::Punct(punct)) => bridge::TokenTree::Punct(punct),
397 fn delim_to_internal(d: bridge::Delimiter) -> Option<tt::Delimiter> {
399 bridge::Delimiter::Parenthesis => tt::DelimiterKind::Parenthesis,
400 bridge::Delimiter::Brace => tt::DelimiterKind::Brace,
401 bridge::Delimiter::Bracket => tt::DelimiterKind::Bracket,
402 bridge::Delimiter::None => return None,
404 Some(tt::Delimiter { id: tt::TokenId::unspecified(), kind })
407 fn delim_to_external(d: Option<tt::Delimiter>) -> bridge::Delimiter {
408 match d.map(|it| it.kind) {
409 Some(tt::DelimiterKind::Parenthesis) => bridge::Delimiter::Parenthesis,
410 Some(tt::DelimiterKind::Brace) => bridge::Delimiter::Brace,
411 Some(tt::DelimiterKind::Bracket) => bridge::Delimiter::Bracket,
412 None => bridge::Delimiter::None,
416 fn spacing_to_internal(spacing: bridge::Spacing) -> Spacing {
418 bridge::Spacing::Alone => Spacing::Alone,
419 bridge::Spacing::Joint => Spacing::Joint,
423 fn spacing_to_external(spacing: Spacing) -> bridge::Spacing {
425 Spacing::Alone => bridge::Spacing::Alone,
426 Spacing::Joint => bridge::Spacing::Joint,
430 impl server::Group for Rustc {
431 fn new(&mut self, delimiter: bridge::Delimiter, stream: Self::TokenStream) -> Self::Group {
433 delimiter: delim_to_internal(delimiter),
434 token_trees: stream.subtree.token_trees,
437 fn delimiter(&mut self, group: &Self::Group) -> bridge::Delimiter {
438 delim_to_external(group.delimiter)
441 // NOTE: Return value of do not include delimiter
442 fn stream(&mut self, group: &Self::Group) -> Self::TokenStream {
444 subtree: tt::Subtree { delimiter: None, token_trees: group.token_trees.clone() },
448 fn span(&mut self, group: &Self::Group) -> Self::Span {
449 group.delimiter.map(|it| it.id).unwrap_or_else(|| tt::TokenId::unspecified())
452 fn set_span(&mut self, _group: &mut Self::Group, _span: Self::Span) {
456 fn span_open(&mut self, _group: &Self::Group) -> Self::Span {
458 // MySpan(self.span_interner.intern(&MySpanData(group.span_open())))
459 tt::TokenId::unspecified()
462 fn span_close(&mut self, _group: &Self::Group) -> Self::Span {
464 tt::TokenId::unspecified()
468 impl server::Punct for Rustc {
469 fn new(&mut self, ch: char, spacing: bridge::Spacing) -> Self::Punct {
472 spacing: spacing_to_internal(spacing),
473 id: tt::TokenId::unspecified(),
476 fn as_char(&mut self, punct: Self::Punct) -> char {
479 fn spacing(&mut self, punct: Self::Punct) -> bridge::Spacing {
480 spacing_to_external(punct.spacing)
482 fn span(&mut self, _punct: Self::Punct) -> Self::Span {
484 tt::TokenId::unspecified()
486 fn with_span(&mut self, punct: Self::Punct, _span: Self::Span) -> Self::Punct {
492 impl server::Ident for Rustc {
493 fn new(&mut self, string: &str, _span: Self::Span, _is_raw: bool) -> Self::Ident {
495 self.ident_interner.intern(&IdentData(tt::Ident {
497 id: tt::TokenId::unspecified(),
502 fn span(&mut self, _ident: Self::Ident) -> Self::Span {
504 tt::TokenId::unspecified()
506 fn with_span(&mut self, ident: Self::Ident, _span: Self::Span) -> Self::Ident {
512 impl server::Literal for Rustc {
513 fn debug_kind(&mut self, _literal: &Self::Literal) -> String {
514 // r-a: debug_kind and suffix are unsupported; corresponding client code has been changed to not call these.
515 // They must still be present to be ABI-compatible and work with upstream proc_macro.
518 fn symbol(&mut self, literal: &Self::Literal) -> String {
519 literal.text.to_string()
521 fn suffix(&mut self, _literal: &Self::Literal) -> Option<String> {
525 fn integer(&mut self, n: &str) -> Self::Literal {
526 let n: i128 = n.parse().unwrap();
527 Literal { text: n.to_string().into(), id: tt::TokenId::unspecified() }
530 fn typed_integer(&mut self, n: &str, kind: &str) -> Self::Literal {
531 macro_rules! def_suffixed_integer {
532 ($kind:ident, $($ty:ty),*) => {
536 let n: $ty = n.parse().unwrap();
537 format!(concat!("{}", stringify!($ty)), n)
540 _ => unimplemented!("unknown args for typed_integer: n {}, kind {}", n, $kind),
545 let text = def_suffixed_integer! {kind, u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize};
547 Literal { text: text.into(), id: tt::TokenId::unspecified() }
550 fn float(&mut self, n: &str) -> Self::Literal {
551 let n: f64 = n.parse().unwrap();
552 let mut text = f64::to_string(&n);
553 if !text.contains('.') {
556 Literal { text: text.into(), id: tt::TokenId::unspecified() }
559 fn f32(&mut self, n: &str) -> Self::Literal {
560 let n: f32 = n.parse().unwrap();
561 let text = format!("{}f32", n);
562 Literal { text: text.into(), id: tt::TokenId::unspecified() }
565 fn f64(&mut self, n: &str) -> Self::Literal {
566 let n: f64 = n.parse().unwrap();
567 let text = format!("{}f64", n);
568 Literal { text: text.into(), id: tt::TokenId::unspecified() }
571 fn string(&mut self, string: &str) -> Self::Literal {
572 let mut escaped = String::new();
573 for ch in string.chars() {
574 escaped.extend(ch.escape_debug());
576 Literal { text: format!("\"{}\"", escaped).into(), id: tt::TokenId::unspecified() }
579 fn character(&mut self, ch: char) -> Self::Literal {
580 Literal { text: format!("'{}'", ch).into(), id: tt::TokenId::unspecified() }
583 fn byte_string(&mut self, bytes: &[u8]) -> Self::Literal {
587 .flat_map(ascii::escape_default)
588 .map(Into::<char>::into)
589 .collect::<String>();
591 Literal { text: format!("b\"{}\"", string).into(), id: tt::TokenId::unspecified() }
594 fn span(&mut self, literal: &Self::Literal) -> Self::Span {
598 fn set_span(&mut self, _literal: &mut Self::Literal, _span: Self::Span) {
604 _literal: &Self::Literal,
605 _start: Bound<usize>,
607 ) -> Option<Self::Span> {
613 impl server::SourceFile for Rustc {
614 fn eq(&mut self, file1: &Self::SourceFile, file2: &Self::SourceFile) -> bool {
617 fn path(&mut self, file: &Self::SourceFile) -> String {
619 file.path().to_str().expect("non-UTF8 file path in `proc_macro::SourceFile::path`"),
622 fn is_real(&mut self, file: &Self::SourceFile) -> bool {
627 impl server::Diagnostic for Rustc {
628 fn new(&mut self, level: Level, msg: &str, spans: Self::MultiSpan) -> Self::Diagnostic {
629 let mut diag = Diagnostic::new(level, msg);
636 _diag: &mut Self::Diagnostic,
639 _spans: Self::MultiSpan,
641 // FIXME handle diagnostic
645 fn emit(&mut self, _diag: Self::Diagnostic) {
646 // FIXME handle diagnostic
651 impl server::Span for Rustc {
652 fn debug(&mut self, span: Self::Span) -> String {
653 format!("{:?}", span.0)
655 fn def_site(&mut self) -> Self::Span {
656 // MySpan(self.span_interner.intern(&MySpanData(Span::def_site())))
658 tt::TokenId::unspecified()
660 fn call_site(&mut self) -> Self::Span {
661 // MySpan(self.span_interner.intern(&MySpanData(Span::call_site())))
663 tt::TokenId::unspecified()
665 fn source_file(&mut self, _span: Self::Span) -> Self::SourceFile {
666 // let MySpanData(span) = self.span_interner.get(span.0);
670 /// Recent feature, not yet in the proc_macro
673 /// https://github.com/rust-lang/rust/pull/55780
674 fn source_text(&mut self, _span: Self::Span) -> Option<String> {
678 fn parent(&mut self, _span: Self::Span) -> Option<Self::Span> {
682 fn source(&mut self, span: Self::Span) -> Self::Span {
686 fn start(&mut self, _span: Self::Span) -> LineColumn {
688 LineColumn { line: 0, column: 0 }
690 fn end(&mut self, _span: Self::Span) -> LineColumn {
692 LineColumn { line: 0, column: 0 }
694 fn join(&mut self, _first: Self::Span, _second: Self::Span) -> Option<Self::Span> {
697 fn resolved_at(&mut self, _span: Self::Span, _at: Self::Span) -> Self::Span {
699 tt::TokenId::unspecified()
702 fn mixed_site(&mut self) -> Self::Span {
704 tt::TokenId::unspecified()
708 impl server::MultiSpan for Rustc {
709 fn new(&mut self) -> Self::MultiSpan {
714 fn push(&mut self, other: &mut Self::MultiSpan, span: Self::Span) {
723 use crate::proc_macro::bridge::server::Literal;
726 fn test_rustc_server_literals() {
727 let mut srv = Rustc { ident_interner: IdentInterner::default() };
728 assert_eq!(srv.integer("1234").text, "1234");
730 assert_eq!(srv.typed_integer("12", "u8").text, "12u8");
731 assert_eq!(srv.typed_integer("255", "u16").text, "255u16");
732 assert_eq!(srv.typed_integer("1234", "u32").text, "1234u32");
733 assert_eq!(srv.typed_integer("15846685", "u64").text, "15846685u64");
734 assert_eq!(srv.typed_integer("15846685258", "u128").text, "15846685258u128");
735 assert_eq!(srv.typed_integer("156788984", "usize").text, "156788984usize");
736 assert_eq!(srv.typed_integer("127", "i8").text, "127i8");
737 assert_eq!(srv.typed_integer("255", "i16").text, "255i16");
738 assert_eq!(srv.typed_integer("1234", "i32").text, "1234i32");
739 assert_eq!(srv.typed_integer("15846685", "i64").text, "15846685i64");
740 assert_eq!(srv.typed_integer("15846685258", "i128").text, "15846685258i128");
741 assert_eq!(srv.float("0").text, "0.0");
742 assert_eq!(srv.float("15684.5867").text, "15684.5867");
743 assert_eq!(srv.f32("15684.58").text, "15684.58f32");
744 assert_eq!(srv.f64("15684.58").text, "15684.58f64");
746 assert_eq!(srv.string("hello_world").text, "\"hello_world\"");
747 assert_eq!(srv.character('c').text, "'c'");
748 assert_eq!(srv.byte_string(b"1234586\x88").text, "b\"1234586\\x88\"");
752 fn test_rustc_server_to_string() {
753 let s = TokenStream {
754 subtree: tt::Subtree {
757 tt::TokenTree::Leaf(tt::Leaf::Ident(tt::Ident {
758 text: "struct".into(),
759 id: tt::TokenId::unspecified(),
761 tt::TokenTree::Leaf(tt::Leaf::Ident(tt::Ident {
763 id: tt::TokenId::unspecified(),
765 tt::TokenTree::Subtree(tt::Subtree {
766 delimiter: Some(tt::Delimiter {
767 id: tt::TokenId::unspecified(),
768 kind: tt::DelimiterKind::Brace,
776 assert_eq!(s.to_string(), "struct T {}");