1 use crate::base::{ExtCtxt, ResolverExpand};
4 use rustc_ast::token::{self, Nonterminal, NtIdent};
5 use rustc_ast::tokenstream::{self, CanSynthesizeMissingTokens};
6 use rustc_ast::tokenstream::{DelimSpan, Spacing::*, TokenStream, TreeAndSpacing};
7 use rustc_ast_pretty::pprust;
8 use rustc_data_structures::fx::FxHashMap;
9 use rustc_data_structures::sync::Lrc;
10 use rustc_errors::Diagnostic;
11 use rustc_lint_defs::builtin::PROC_MACRO_BACK_COMPAT;
12 use rustc_lint_defs::BuiltinLintDiagnostics;
13 use rustc_parse::lexer::nfc_normalize;
14 use rustc_parse::{nt_to_tokenstream, parse_stream_from_source_str};
15 use rustc_session::parse::ParseSess;
16 use rustc_span::def_id::CrateNum;
17 use rustc_span::hygiene::ExpnKind;
18 use rustc_span::symbol::{self, kw, sym, Symbol};
19 use rustc_span::{BytePos, FileName, MultiSpan, Pos, RealFileName, SourceFile, Span};
21 use pm::bridge::{server, TokenTree};
22 use pm::{Delimiter, Level, LineColumn, Spacing};
24 use std::{ascii, panic};
26 trait FromInternal<T> {
27 fn from_internal(x: T) -> Self;
31 fn to_internal(self) -> T;
34 impl FromInternal<token::DelimToken> for Delimiter {
35 fn from_internal(delim: token::DelimToken) -> Delimiter {
37 token::Paren => Delimiter::Parenthesis,
38 token::Brace => Delimiter::Brace,
39 token::Bracket => Delimiter::Bracket,
40 token::NoDelim => Delimiter::None,
45 impl ToInternal<token::DelimToken> for Delimiter {
46 fn to_internal(self) -> token::DelimToken {
48 Delimiter::Parenthesis => token::Paren,
49 Delimiter::Brace => token::Brace,
50 Delimiter::Bracket => token::Bracket,
51 Delimiter::None => token::NoDelim,
56 impl FromInternal<(TreeAndSpacing, &'_ mut Vec<Self>, &mut Rustc<'_>)>
57 for TokenTree<Group, Punct, Ident, Literal>
60 ((tree, spacing), stack, rustc): (TreeAndSpacing, &mut Vec<Self>, &mut Rustc<'_>),
62 use rustc_ast::token::*;
64 let joint = spacing == Joint;
65 let Token { kind, span } = match tree {
66 tokenstream::TokenTree::Delimited(span, delim, tts) => {
67 let delimiter = Delimiter::from_internal(delim);
68 return TokenTree::Group(Group { delimiter, stream: tts, span, flatten: false });
70 tokenstream::TokenTree::Token(token) => token,
74 ($ty:ident { $($field:ident $(: $value:expr)*),+ $(,)? }) => (
75 TokenTree::$ty(self::$ty {
76 $($field $(: $value)*,)+
80 ($ty:ident::$method:ident($($value:expr),*)) => (
81 TokenTree::$ty(self::$ty::$method($($value,)* span))
86 tt!(Punct::new($a, joint))
88 ($a:expr, $b:expr) => {{
89 stack.push(tt!(Punct::new($b, joint)));
90 tt!(Punct::new($a, true))
92 ($a:expr, $b:expr, $c:expr) => {{
93 stack.push(tt!(Punct::new($c, joint)));
94 stack.push(tt!(Punct::new($b, true)));
95 tt!(Punct::new($a, true))
103 EqEq => op!('=', '='),
107 AndAnd => op!('&', '&'),
108 OrOr => op!('|', '|'),
111 BinOp(Plus) => op!('+'),
112 BinOp(Minus) => op!('-'),
113 BinOp(Star) => op!('*'),
114 BinOp(Slash) => op!('/'),
115 BinOp(Percent) => op!('%'),
116 BinOp(Caret) => op!('^'),
117 BinOp(And) => op!('&'),
118 BinOp(Or) => op!('|'),
119 BinOp(Shl) => op!('<', '<'),
120 BinOp(Shr) => op!('>', '>'),
121 BinOpEq(Plus) => op!('+', '='),
122 BinOpEq(Minus) => op!('-', '='),
123 BinOpEq(Star) => op!('*', '='),
124 BinOpEq(Slash) => op!('/', '='),
125 BinOpEq(Percent) => op!('%', '='),
126 BinOpEq(Caret) => op!('^', '='),
127 BinOpEq(And) => op!('&', '='),
128 BinOpEq(Or) => op!('|', '='),
129 BinOpEq(Shl) => op!('<', '<', '='),
130 BinOpEq(Shr) => op!('>', '>', '='),
133 DotDot => op!('.', '.'),
134 DotDotDot => op!('.', '.', '.'),
135 DotDotEq => op!('.', '.', '='),
139 ModSep => op!(':', ':'),
140 RArrow => op!('-', '>'),
141 LArrow => op!('<', '-'),
142 FatArrow => op!('=', '>'),
145 Question => op!('?'),
146 SingleQuote => op!('\''),
148 Ident(name, false) if name == kw::DollarCrate => tt!(Ident::dollar_crate()),
149 Ident(name, is_raw) => tt!(Ident::new(rustc.sess, name, is_raw)),
151 let ident = symbol::Ident::new(name, span).without_first_quote();
152 stack.push(tt!(Ident::new(rustc.sess, ident.name, false)));
153 tt!(Punct::new('\'', true))
155 Literal(lit) => tt!(Literal { lit }),
156 DocComment(_, attr_style, data) => {
157 let mut escaped = String::new();
158 for ch in data.as_str().chars() {
159 escaped.extend(ch.escape_debug());
162 Ident(sym::doc, false),
164 TokenKind::lit(token::Str, Symbol::intern(&escaped), None),
167 .map(|kind| tokenstream::TokenTree::token(kind, span))
169 stack.push(TokenTree::Group(Group {
170 delimiter: Delimiter::Bracket,
172 span: DelimSpan::from_single(span),
175 if attr_style == ast::AttrStyle::Inner {
176 stack.push(tt!(Punct::new('!', false)));
178 tt!(Punct::new('#', false))
182 if let Some((name, is_raw)) = ident_name_compatibility_hack(&nt, span, rustc) =>
184 TokenTree::Ident(Ident::new(rustc.sess, name.name, is_raw, name.span))
186 Interpolated(nt) => {
187 let stream = nt_to_tokenstream(&nt, rustc.sess, CanSynthesizeMissingTokens::No);
188 TokenTree::Group(Group {
189 delimiter: Delimiter::None,
191 span: DelimSpan::from_single(span),
192 flatten: crate::base::pretty_printing_compatibility_hack(&nt, rustc.sess),
196 OpenDelim(..) | CloseDelim(..) => unreachable!(),
197 Eof => unreachable!(),
202 impl ToInternal<TokenStream> for TokenTree<Group, Punct, Ident, Literal> {
203 fn to_internal(self) -> TokenStream {
204 use rustc_ast::token::*;
206 let (ch, joint, span) = match self {
207 TokenTree::Punct(Punct { ch, joint, span }) => (ch, joint, span),
208 TokenTree::Group(Group { delimiter, stream, span, .. }) => {
209 return tokenstream::TokenTree::Delimited(span, delimiter.to_internal(), stream)
212 TokenTree::Ident(self::Ident { sym, is_raw, span }) => {
213 return tokenstream::TokenTree::token(Ident(sym, is_raw), span).into();
215 TokenTree::Literal(self::Literal {
216 lit: token::Lit { kind: token::Integer, symbol, suffix },
218 }) if symbol.as_str().starts_with('-') => {
219 let minus = BinOp(BinOpToken::Minus);
220 let symbol = Symbol::intern(&symbol.as_str()[1..]);
221 let integer = TokenKind::lit(token::Integer, symbol, suffix);
222 let a = tokenstream::TokenTree::token(minus, span);
223 let b = tokenstream::TokenTree::token(integer, span);
224 return vec![a, b].into_iter().collect();
226 TokenTree::Literal(self::Literal {
227 lit: token::Lit { kind: token::Float, symbol, suffix },
229 }) if symbol.as_str().starts_with('-') => {
230 let minus = BinOp(BinOpToken::Minus);
231 let symbol = Symbol::intern(&symbol.as_str()[1..]);
232 let float = TokenKind::lit(token::Float, symbol, suffix);
233 let a = tokenstream::TokenTree::token(minus, span);
234 let b = tokenstream::TokenTree::token(float, span);
235 return vec![a, b].into_iter().collect();
237 TokenTree::Literal(self::Literal { lit, span }) => {
238 return tokenstream::TokenTree::token(Literal(lit), span).into();
242 let kind = match ch {
252 '%' => BinOp(Percent),
268 let tree = tokenstream::TokenTree::token(kind, span);
269 TokenStream::new(vec![(tree, if joint { Joint } else { Alone })])
273 impl ToInternal<rustc_errors::Level> for Level {
274 fn to_internal(self) -> rustc_errors::Level {
276 Level::Error => rustc_errors::Level::Error { lint: false },
277 Level::Warning => rustc_errors::Level::Warning,
278 Level::Note => rustc_errors::Level::Note,
279 Level::Help => rustc_errors::Level::Help,
280 _ => unreachable!("unknown proc_macro::Level variant: {:?}", self),
285 pub struct FreeFunctions;
288 pub struct TokenStreamIter {
289 cursor: tokenstream::Cursor,
290 stack: Vec<TokenTree<Group, Punct, Ident, Literal>>,
295 delimiter: Delimiter,
298 /// A hack used to pass AST fragments to attribute and derive macros
299 /// as a single nonterminal token instead of a token stream.
300 /// FIXME: It needs to be removed, but there are some compatibility issues (see #73345).
304 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
307 // NB. not using `Spacing` here because it doesn't implement `Hash`.
313 fn new(ch: char, joint: bool, span: Span) -> Punct {
314 const LEGAL_CHARS: &[char] = &[
315 '=', '<', '>', '!', '~', '+', '-', '*', '/', '%', '^', '&', '|', '@', '.', ',', ';',
316 ':', '#', '$', '?', '\'',
318 if !LEGAL_CHARS.contains(&ch) {
319 panic!("unsupported character `{:?}`", ch)
321 Punct { ch, joint, span }
325 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
333 fn new(sess: &ParseSess, sym: Symbol, is_raw: bool, span: Span) -> Ident {
334 let sym = nfc_normalize(&sym.as_str());
335 let string = sym.as_str();
336 if !rustc_lexer::is_ident(&string) {
337 panic!("`{:?}` is not a valid identifier", string)
339 if is_raw && !sym.can_be_raw() {
340 panic!("`{}` cannot be a raw identifier", string);
342 sess.symbol_gallery.insert(sym, span);
343 Ident { sym, is_raw, span }
345 fn dollar_crate(span: Span) -> Ident {
346 // `$crate` is accepted as an ident only if it comes from the compiler.
347 Ident { sym: kw::DollarCrate, is_raw: false, span }
351 // FIXME(eddyb) `Literal` should not expose internal `Debug` impls.
352 #[derive(Clone, Debug)]
358 pub(crate) struct Rustc<'a> {
359 resolver: &'a dyn ResolverExpand,
366 rebased_spans: FxHashMap<usize, Span>,
370 pub fn new(cx: &'a ExtCtxt<'_>) -> Self {
371 let expn_data = cx.current_expansion.id.expn_data();
373 resolver: cx.resolver,
374 sess: cx.parse_sess(),
375 def_site: cx.with_def_site_ctxt(expn_data.def_site),
376 call_site: cx.with_call_site_ctxt(expn_data.call_site),
377 mixed_site: cx.with_mixed_site_ctxt(expn_data.call_site),
378 span_debug: cx.ecfg.span_debug,
379 krate: expn_data.macro_def_id.unwrap().krate,
380 rebased_spans: FxHashMap::default(),
384 fn lit(&mut self, kind: token::LitKind, symbol: Symbol, suffix: Option<Symbol>) -> Literal {
385 Literal { lit: token::Lit::new(kind, symbol, suffix), span: server::Span::call_site(self) }
389 impl server::Types for Rustc<'_> {
390 type FreeFunctions = FreeFunctions;
391 type TokenStream = TokenStream;
392 type TokenStreamBuilder = tokenstream::TokenStreamBuilder;
393 type TokenStreamIter = TokenStreamIter;
397 type Literal = Literal;
398 type SourceFile = Lrc<SourceFile>;
399 type MultiSpan = Vec<Span>;
400 type Diagnostic = Diagnostic;
404 impl server::FreeFunctions for Rustc<'_> {
405 fn track_env_var(&mut self, var: &str, value: Option<&str>) {
406 self.sess.env_depinfo.borrow_mut().insert((Symbol::intern(var), value.map(Symbol::intern)));
409 fn track_path(&mut self, path: &str) {
410 self.sess.file_depinfo.borrow_mut().insert(Symbol::intern(path));
414 impl server::TokenStream for Rustc<'_> {
415 fn new(&mut self) -> Self::TokenStream {
416 TokenStream::default()
418 fn is_empty(&mut self, stream: &Self::TokenStream) -> bool {
421 fn from_str(&mut self, src: &str) -> Self::TokenStream {
422 parse_stream_from_source_str(
423 FileName::proc_macro_source_code(src),
426 Some(self.call_site),
429 fn to_string(&mut self, stream: &Self::TokenStream) -> String {
430 pprust::tts_to_string(stream)
434 tree: TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>,
435 ) -> Self::TokenStream {
438 fn into_iter(&mut self, stream: Self::TokenStream) -> Self::TokenStreamIter {
439 TokenStreamIter { cursor: stream.trees(), stack: vec![] }
443 impl server::TokenStreamBuilder for Rustc<'_> {
444 fn new(&mut self) -> Self::TokenStreamBuilder {
445 tokenstream::TokenStreamBuilder::new()
447 fn push(&mut self, builder: &mut Self::TokenStreamBuilder, stream: Self::TokenStream) {
448 builder.push(stream);
450 fn build(&mut self, builder: Self::TokenStreamBuilder) -> Self::TokenStream {
455 impl server::TokenStreamIter for Rustc<'_> {
458 iter: &mut Self::TokenStreamIter,
459 ) -> Option<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>> {
461 let tree = iter.stack.pop().or_else(|| {
462 let next = iter.cursor.next_with_spacing()?;
463 Some(TokenTree::from_internal((next, &mut iter.stack, self)))
465 // A hack used to pass AST fragments to attribute and derive macros
466 // as a single nonterminal token instead of a token stream.
467 // Such token needs to be "unwrapped" and not represented as a delimited group.
468 // FIXME: It needs to be removed, but there are some compatibility issues (see #73345).
469 if let TokenTree::Group(ref group) = tree {
471 iter.cursor.append(group.stream.clone());
480 impl server::Group for Rustc<'_> {
481 fn new(&mut self, delimiter: Delimiter, stream: Self::TokenStream) -> Self::Group {
485 span: DelimSpan::from_single(server::Span::call_site(self)),
489 fn delimiter(&mut self, group: &Self::Group) -> Delimiter {
492 fn stream(&mut self, group: &Self::Group) -> Self::TokenStream {
495 fn span(&mut self, group: &Self::Group) -> Self::Span {
498 fn span_open(&mut self, group: &Self::Group) -> Self::Span {
501 fn span_close(&mut self, group: &Self::Group) -> Self::Span {
504 fn set_span(&mut self, group: &mut Self::Group, span: Self::Span) {
505 group.span = DelimSpan::from_single(span);
509 impl server::Punct for Rustc<'_> {
510 fn new(&mut self, ch: char, spacing: Spacing) -> Self::Punct {
511 Punct::new(ch, spacing == Spacing::Joint, server::Span::call_site(self))
513 fn as_char(&mut self, punct: Self::Punct) -> char {
516 fn spacing(&mut self, punct: Self::Punct) -> Spacing {
517 if punct.joint { Spacing::Joint } else { Spacing::Alone }
519 fn span(&mut self, punct: Self::Punct) -> Self::Span {
522 fn with_span(&mut self, punct: Self::Punct, span: Self::Span) -> Self::Punct {
523 Punct { span, ..punct }
527 impl server::Ident for Rustc<'_> {
528 fn new(&mut self, string: &str, span: Self::Span, is_raw: bool) -> Self::Ident {
529 Ident::new(self.sess, Symbol::intern(string), is_raw, span)
531 fn span(&mut self, ident: Self::Ident) -> Self::Span {
534 fn with_span(&mut self, ident: Self::Ident, span: Self::Span) -> Self::Ident {
535 Ident { span, ..ident }
539 impl server::Literal for Rustc<'_> {
540 fn from_str(&mut self, s: &str) -> Result<Self::Literal, ()> {
541 let name = FileName::proc_macro_source_code(s);
542 let mut parser = rustc_parse::new_parser_from_source_str(self.sess, name, s.to_owned());
544 let first_span = parser.token.span.data();
545 let minus_present = parser.eat(&token::BinOp(token::Minus));
547 let lit_span = parser.token.span.data();
548 let mut lit = match parser.token.kind {
549 token::Literal(lit) => lit,
553 // Check no comment or whitespace surrounding the (possibly negative)
554 // literal, or more tokens after it.
555 if (lit_span.hi.0 - first_span.lo.0) as usize != s.len() {
560 // If minus is present, check no comment or whitespace in between it
561 // and the literal token.
562 if first_span.hi.0 != lit_span.lo.0 {
566 // Check literal is a kind we allow to be negated in a proc macro token.
569 | token::LitKind::Byte
570 | token::LitKind::Char
571 | token::LitKind::Str
572 | token::LitKind::StrRaw(_)
573 | token::LitKind::ByteStr
574 | token::LitKind::ByteStrRaw(_)
575 | token::LitKind::Err => return Err(()),
576 token::LitKind::Integer | token::LitKind::Float => {}
579 // Synthesize a new symbol that includes the minus sign.
580 let symbol = Symbol::intern(&s[..1 + lit.symbol.as_str().len()]);
581 lit = token::Lit::new(lit.kind, symbol, lit.suffix);
584 Ok(Literal { lit, span: self.call_site })
586 fn to_string(&mut self, literal: &Self::Literal) -> String {
587 literal.lit.to_string()
589 fn debug_kind(&mut self, literal: &Self::Literal) -> String {
590 format!("{:?}", literal.lit.kind)
592 fn symbol(&mut self, literal: &Self::Literal) -> String {
593 literal.lit.symbol.to_string()
595 fn suffix(&mut self, literal: &Self::Literal) -> Option<String> {
596 literal.lit.suffix.as_ref().map(Symbol::to_string)
598 fn integer(&mut self, n: &str) -> Self::Literal {
599 self.lit(token::Integer, Symbol::intern(n), None)
601 fn typed_integer(&mut self, n: &str, kind: &str) -> Self::Literal {
602 self.lit(token::Integer, Symbol::intern(n), Some(Symbol::intern(kind)))
604 fn float(&mut self, n: &str) -> Self::Literal {
605 self.lit(token::Float, Symbol::intern(n), None)
607 fn f32(&mut self, n: &str) -> Self::Literal {
608 self.lit(token::Float, Symbol::intern(n), Some(sym::f32))
610 fn f64(&mut self, n: &str) -> Self::Literal {
611 self.lit(token::Float, Symbol::intern(n), Some(sym::f64))
613 fn string(&mut self, string: &str) -> Self::Literal {
614 let mut escaped = String::new();
615 for ch in string.chars() {
616 escaped.extend(ch.escape_debug());
618 self.lit(token::Str, Symbol::intern(&escaped), None)
620 fn character(&mut self, ch: char) -> Self::Literal {
621 let mut escaped = String::new();
622 escaped.extend(ch.escape_unicode());
623 self.lit(token::Char, Symbol::intern(&escaped), None)
625 fn byte_string(&mut self, bytes: &[u8]) -> Self::Literal {
629 .flat_map(ascii::escape_default)
630 .map(Into::<char>::into)
631 .collect::<String>();
632 self.lit(token::ByteStr, Symbol::intern(&string), None)
634 fn span(&mut self, literal: &Self::Literal) -> Self::Span {
637 fn set_span(&mut self, literal: &mut Self::Literal, span: Self::Span) {
642 literal: &Self::Literal,
645 ) -> Option<Self::Span> {
646 let span = literal.span;
647 let length = span.hi().to_usize() - span.lo().to_usize();
649 let start = match start {
650 Bound::Included(lo) => lo,
651 Bound::Excluded(lo) => lo.checked_add(1)?,
652 Bound::Unbounded => 0,
655 let end = match end {
656 Bound::Included(hi) => hi.checked_add(1)?,
657 Bound::Excluded(hi) => hi,
658 Bound::Unbounded => length,
661 // Bounds check the values, preventing addition overflow and OOB spans.
662 if start > u32::MAX as usize
663 || end > u32::MAX as usize
664 || (u32::MAX - start as u32) < span.lo().to_u32()
665 || (u32::MAX - end as u32) < span.lo().to_u32()
672 let new_lo = span.lo() + BytePos::from_usize(start);
673 let new_hi = span.lo() + BytePos::from_usize(end);
674 Some(span.with_lo(new_lo).with_hi(new_hi))
678 impl server::SourceFile for Rustc<'_> {
679 fn eq(&mut self, file1: &Self::SourceFile, file2: &Self::SourceFile) -> bool {
680 Lrc::ptr_eq(file1, file2)
682 fn path(&mut self, file: &Self::SourceFile) -> String {
684 FileName::Real(ref name) => name
686 .expect("attempting to get a file path in an imported file in `proc_macro::SourceFile::path`")
688 .expect("non-UTF8 file path in `proc_macro::SourceFile::path`")
690 _ => file.name.prefer_local().to_string(),
693 fn is_real(&mut self, file: &Self::SourceFile) -> bool {
698 impl server::MultiSpan for Rustc<'_> {
699 fn new(&mut self) -> Self::MultiSpan {
702 fn push(&mut self, spans: &mut Self::MultiSpan, span: Self::Span) {
707 impl server::Diagnostic for Rustc<'_> {
708 fn new(&mut self, level: Level, msg: &str, spans: Self::MultiSpan) -> Self::Diagnostic {
709 let mut diag = Diagnostic::new(level.to_internal(), msg);
710 diag.set_span(MultiSpan::from_spans(spans));
715 diag: &mut Self::Diagnostic,
718 spans: Self::MultiSpan,
720 diag.sub(level.to_internal(), msg, MultiSpan::from_spans(spans), None);
722 fn emit(&mut self, diag: Self::Diagnostic) {
723 self.sess.span_diagnostic.emit_diagnostic(&diag);
727 impl server::Span for Rustc<'_> {
728 fn debug(&mut self, span: Self::Span) -> String {
730 format!("{:?}", span)
732 format!("{:?} bytes({}..{})", span.ctxt(), span.lo().0, span.hi().0)
735 fn def_site(&mut self) -> Self::Span {
738 fn call_site(&mut self) -> Self::Span {
741 fn mixed_site(&mut self) -> Self::Span {
744 fn source_file(&mut self, span: Self::Span) -> Self::SourceFile {
745 self.sess.source_map().lookup_char_pos(span.lo()).file
747 fn parent(&mut self, span: Self::Span) -> Option<Self::Span> {
748 span.parent_callsite()
750 fn source(&mut self, span: Self::Span) -> Self::Span {
751 span.source_callsite()
753 fn start(&mut self, span: Self::Span) -> LineColumn {
754 let loc = self.sess.source_map().lookup_char_pos(span.lo());
755 LineColumn { line: loc.line, column: loc.col.to_usize() }
757 fn end(&mut self, span: Self::Span) -> LineColumn {
758 let loc = self.sess.source_map().lookup_char_pos(span.hi());
759 LineColumn { line: loc.line, column: loc.col.to_usize() }
761 fn before(&mut self, span: Self::Span) -> Self::Span {
764 fn after(&mut self, span: Self::Span) -> Self::Span {
767 fn join(&mut self, first: Self::Span, second: Self::Span) -> Option<Self::Span> {
768 let self_loc = self.sess.source_map().lookup_char_pos(first.lo());
769 let other_loc = self.sess.source_map().lookup_char_pos(second.lo());
771 if self_loc.file.name != other_loc.file.name {
775 Some(first.to(second))
777 fn resolved_at(&mut self, span: Self::Span, at: Self::Span) -> Self::Span {
778 span.with_ctxt(at.ctxt())
780 fn source_text(&mut self, span: Self::Span) -> Option<String> {
781 self.sess.source_map().span_to_snippet(span).ok()
783 /// Saves the provided span into the metadata of
784 /// *the crate we are currently compiling*, which must
785 /// be a proc-macro crate. This id can be passed to
786 /// `recover_proc_macro_span` when our current crate
787 /// is *run* as a proc-macro.
789 /// Let's suppose that we have two crates - `my_client`
790 /// and `my_proc_macro`. The `my_proc_macro` crate
791 /// contains a procedural macro `my_macro`, which
792 /// is implemented as: `quote! { "hello" }`
794 /// When we *compile* `my_proc_macro`, we will execute
795 /// the `quote` proc-macro. This will save the span of
796 /// "hello" into the metadata of `my_proc_macro`. As a result,
797 /// the body of `my_proc_macro` (after expansion) will end
798 /// up containg a call that looks like this:
799 /// `proc_macro::Ident::new("hello", proc_macro::Span::recover_proc_macro_span(0))`
801 /// where `0` is the id returned by this function.
802 /// When `my_proc_macro` *executes* (during the compilation of `my_client`),
803 /// the call to `recover_proc_macro_span` will load the corresponding
804 /// span from the metadata of `my_proc_macro` (which we have access to,
805 /// since we've loaded `my_proc_macro` from disk in order to execute it).
806 /// In this way, we have obtained a span pointing into `my_proc_macro`
807 fn save_span(&mut self, span: Self::Span) -> usize {
808 self.sess.save_proc_macro_span(span)
810 fn recover_proc_macro_span(&mut self, id: usize) -> Self::Span {
811 let (resolver, krate, def_site) = (self.resolver, self.krate, self.def_site);
812 *self.rebased_spans.entry(id).or_insert_with(|| {
813 // FIXME: `SyntaxContext` for spans from proc macro crates is lost during encoding,
814 // replace it with a def-site context until we are encoding it properly.
815 resolver.get_proc_macro_quoted_span(krate, id).with_ctxt(def_site.ctxt())
820 // See issue #74616 for details
821 fn ident_name_compatibility_hack(
824 rustc: &mut Rustc<'_>,
825 ) -> Option<(rustc_span::symbol::Ident, bool)> {
826 if let NtIdent(ident, is_raw) = nt {
827 if let ExpnKind::Macro(_, macro_name) = orig_span.ctxt().outer_expn_data().kind {
828 let source_map = rustc.sess.source_map();
829 let filename = source_map.span_to_filename(orig_span);
830 if let FileName::Real(RealFileName::LocalPath(path)) = filename {
831 let matches_prefix = |prefix, filename| {
832 // Check for a path that ends with 'prefix*/src/<filename>'
833 let mut iter = path.components().rev();
834 iter.next().and_then(|p| p.as_os_str().to_str()) == Some(filename)
835 && iter.next().and_then(|p| p.as_os_str().to_str()) == Some("src")
838 .and_then(|p| p.as_os_str().to_str())
839 .map_or(false, |p| p.starts_with(prefix))
842 let time_macros_impl =
843 macro_name == sym::impl_macros && matches_prefix("time-macros-impl", "lib.rs");
844 let js_sys = macro_name == sym::arrays && matches_prefix("js-sys", "lib.rs");
845 if time_macros_impl || js_sys {
846 let snippet = source_map.span_to_snippet(orig_span);
847 if snippet.as_deref() == Ok("$name") {
848 if time_macros_impl {
849 rustc.sess.buffer_lint_with_diagnostic(
850 &PROC_MACRO_BACK_COMPAT,
853 "using an old version of `time-macros-impl`",
854 BuiltinLintDiagnostics::ProcMacroBackCompat(
855 "the `time-macros-impl` crate will stop compiling in futures version of Rust. \
856 Please update to the latest version of the `time` crate to avoid breakage".to_string())
858 return Some((*ident, *is_raw));
861 if let Some(c) = path
863 .flat_map(|c| c.as_os_str().to_str())
864 .find(|c| c.starts_with("js-sys"))
866 let mut version = c.trim_start_matches("js-sys-").split('.');
867 if version.next() == Some("0")
868 && version.next() == Some("3")
871 .and_then(|c| c.parse::<u32>().ok())
872 .map_or(false, |v| v < 40)
874 rustc.sess.buffer_lint_with_diagnostic(
875 &PROC_MACRO_BACK_COMPAT,
878 "using an old version of `js-sys`",
879 BuiltinLintDiagnostics::ProcMacroBackCompat(
880 "older versions of the `js-sys` crate will stop compiling in future versions of Rust; \
881 please update to `js-sys` v0.3.40 or above".to_string())
883 return Some((*ident, *is_raw));
890 if macro_name == sym::tuple_from_req && matches_prefix("actix-web", "extract.rs") {
891 let snippet = source_map.span_to_snippet(orig_span);
892 if snippet.as_deref() == Ok("$T") {
893 if let FileName::Real(RealFileName::LocalPath(macro_path)) =
894 source_map.span_to_filename(rustc.def_site)
896 if macro_path.to_string_lossy().contains("pin-project-internal-0.") {
897 rustc.sess.buffer_lint_with_diagnostic(
898 &PROC_MACRO_BACK_COMPAT,
901 "using an old version of `actix-web`",
902 BuiltinLintDiagnostics::ProcMacroBackCompat(
903 "the version of `actix-web` you are using might stop compiling in future versions of Rust; \
904 please update to the latest version of the `actix-web` crate to avoid breakage".to_string())
906 return Some((*ident, *is_raw));