compiler/rustc_expand/src/proc_macro_server.rs

   1 use crate::base::{ExtCtxt, ResolverExpand};
   2
   3 use rustc_ast as ast;
   4 use rustc_ast::token::{self, Nonterminal, NtIdent, TokenKind};
   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};
  20
  21 use pm::bridge::{server, TokenTree};
  22 use pm::{Delimiter, Level, LineColumn, Spacing};
  23 use std::ops::Bound;
  24 use std::{ascii, panic};
  25
  26 trait FromInternal<T> {
  27     fn from_internal(x: T) -> Self;
  28 }
  29
  30 trait ToInternal<T> {
  31     fn to_internal(self) -> T;
  32 }
  33
  34 impl FromInternal<token::DelimToken> for Delimiter {
  35     fn from_internal(delim: token::DelimToken) -> Delimiter {
  36         match delim {
  37             token::Paren => Delimiter::Parenthesis,
  38             token::Brace => Delimiter::Brace,
  39             token::Bracket => Delimiter::Bracket,
  40             token::NoDelim => Delimiter::None,
  41         }
  42     }
  43 }
  44
  45 impl ToInternal<token::DelimToken> for Delimiter {
  46     fn to_internal(self) -> token::DelimToken {
  47         match self {
  48             Delimiter::Parenthesis => token::Paren,
  49             Delimiter::Brace => token::Brace,
  50             Delimiter::Bracket => token::Bracket,
  51             Delimiter::None => token::NoDelim,
  52         }
  53     }
  54 }
  55
  56 impl FromInternal<(TreeAndSpacing, &'_ mut Vec<Self>, &mut Rustc<'_>)>
  57     for TokenTree<Group, Punct, Ident, Literal>
  58 {
  59     fn from_internal(
  60         ((tree, spacing), stack, rustc): (TreeAndSpacing, &mut Vec<Self>, &mut Rustc<'_>),
  61     ) -> Self {
  62         use rustc_ast::token::*;
  63
  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 });
  69             }
  70             tokenstream::TokenTree::Token(token) => token,
  71         };
  72
  73         macro_rules! tt {
  74             ($ty:ident { $($field:ident $(: $value:expr)*),+ $(,)? }) => (
  75                 TokenTree::$ty(self::$ty {
  76                     $($field $(: $value)*,)+
  77                     span,
  78                 })
  79             );
  80             ($ty:ident::$method:ident($($value:expr),*)) => (
  81                 TokenTree::$ty(self::$ty::$method($($value,)* span))
  82             );
  83         }
  84         macro_rules! op {
  85             ($a:expr) => {
  86                 tt!(Punct::new($a, joint))
  87             };
  88             ($a:expr, $b:expr) => {{
  89                 stack.push(tt!(Punct::new($b, joint)));
  90                 tt!(Punct::new($a, true))
  91             }};
  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))
  96             }};
  97         }
  98
  99         match kind {
 100             Eq => op!('='),
 101             Lt => op!('<'),
 102             Le => op!('<', '='),
 103             EqEq => op!('=', '='),
 104             Ne => op!('!', '='),
 105             Ge => op!('>', '='),
 106             Gt => op!('>'),
 107             AndAnd => op!('&', '&'),
 108             OrOr => op!('|', '|'),
 109             Not => op!('!'),
 110             Tilde => 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!('>', '>', '='),
 131             At => op!('@'),
 132             Dot => op!('.'),
 133             DotDot => op!('.', '.'),
 134             DotDotDot => op!('.', '.', '.'),
 135             DotDotEq => op!('.', '.', '='),
 136             Comma => op!(','),
 137             Semi => op!(';'),
 138             Colon => op!(':'),
 139             ModSep => op!(':', ':'),
 140             RArrow => op!('-', '>'),
 141             LArrow => op!('<', '-'),
 142             FatArrow => op!('=', '>'),
 143             Pound => op!('#'),
 144             Dollar => op!('$'),
 145             Question => op!('?'),
 146             SingleQuote => op!('\''),
 147
 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)),
 150             Lifetime(name) => {
 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))
 154             }
 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());
 160                 }
 161                 let stream = vec![
 162                     Ident(sym::doc, false),
 163                     Eq,
 164                     TokenKind::lit(token::Str, Symbol::intern(&escaped), None),
 165                 ]
 166                 .into_iter()
 167                 .map(|kind| tokenstream::TokenTree::token(kind, span))
 168                 .collect();
 169                 stack.push(TokenTree::Group(Group {
 170                     delimiter: Delimiter::Bracket,
 171                     stream,
 172                     span: DelimSpan::from_single(span),
 173                     flatten: false,
 174                 }));
 175                 if attr_style == ast::AttrStyle::Inner {
 176                     stack.push(tt!(Punct::new('!', false)));
 177                 }
 178                 tt!(Punct::new('#', false))
 179             }
 180
 181             Interpolated(nt) => {
 182                 if let Some((name, is_raw)) = ident_name_compatibility_hack(&nt, span, rustc) {
 183                     TokenTree::Ident(Ident::new(rustc.sess, name.name, is_raw, name.span))
 184                 } else {
 185                     let stream = nt_to_tokenstream(&nt, rustc.sess, CanSynthesizeMissingTokens::No);
 186                     TokenTree::Group(Group {
 187                         delimiter: Delimiter::None,
 188                         stream,
 189                         span: DelimSpan::from_single(span),
 190                         flatten: crate::base::pretty_printing_compatibility_hack(&nt, rustc.sess),
 191                     })
 192                 }
 193             }
 194
 195             OpenDelim(..) | CloseDelim(..) => unreachable!(),
 196             Eof => unreachable!(),
 197         }
 198     }
 199 }
 200
 201 impl ToInternal<TokenStream> for TokenTree<Group, Punct, Ident, Literal> {
 202     fn to_internal(self) -> TokenStream {
 203         use rustc_ast::token::*;
 204
 205         let (ch, joint, span) = match self {
 206             TokenTree::Punct(Punct { ch, joint, span }) => (ch, joint, span),
 207             TokenTree::Group(Group { delimiter, stream, span, .. }) => {
 208                 return tokenstream::TokenTree::Delimited(span, delimiter.to_internal(), stream)
 209                     .into();
 210             }
 211             TokenTree::Ident(self::Ident { sym, is_raw, span }) => {
 212                 return tokenstream::TokenTree::token(Ident(sym, is_raw), span).into();
 213             }
 214             TokenTree::Literal(self::Literal {
 215                 lit: token::Lit { kind: token::Integer, symbol, suffix },
 216                 span,
 217             }) if symbol.as_str().starts_with('-') => {
 218                 let minus = BinOp(BinOpToken::Minus);
 219                 let symbol = Symbol::intern(&symbol.as_str()[1..]);
 220                 let integer = TokenKind::lit(token::Integer, symbol, suffix);
 221                 let a = tokenstream::TokenTree::token(minus, span);
 222                 let b = tokenstream::TokenTree::token(integer, span);
 223                 return vec![a, b].into_iter().collect();
 224             }
 225             TokenTree::Literal(self::Literal {
 226                 lit: token::Lit { kind: token::Float, symbol, suffix },
 227                 span,
 228             }) if symbol.as_str().starts_with('-') => {
 229                 let minus = BinOp(BinOpToken::Minus);
 230                 let symbol = Symbol::intern(&symbol.as_str()[1..]);
 231                 let float = TokenKind::lit(token::Float, symbol, suffix);
 232                 let a = tokenstream::TokenTree::token(minus, span);
 233                 let b = tokenstream::TokenTree::token(float, span);
 234                 return vec![a, b].into_iter().collect();
 235             }
 236             TokenTree::Literal(self::Literal { lit, span }) => {
 237                 return tokenstream::TokenTree::token(Literal(lit), span).into();
 238             }
 239         };
 240
 241         let kind = match ch {
 242             '=' => Eq,
 243             '<' => Lt,
 244             '>' => Gt,
 245             '!' => Not,
 246             '~' => Tilde,
 247             '+' => BinOp(Plus),
 248             '-' => BinOp(Minus),
 249             '*' => BinOp(Star),
 250             '/' => BinOp(Slash),
 251             '%' => BinOp(Percent),
 252             '^' => BinOp(Caret),
 253             '&' => BinOp(And),
 254             '|' => BinOp(Or),
 255             '@' => At,
 256             '.' => Dot,
 257             ',' => Comma,
 258             ';' => Semi,
 259             ':' => Colon,
 260             '#' => Pound,
 261             '$' => Dollar,
 262             '?' => Question,
 263             '\'' => SingleQuote,
 264             _ => unreachable!(),
 265         };
 266
 267         let tree = tokenstream::TokenTree::token(kind, span);
 268         TokenStream::new(vec![(tree, if joint { Joint } else { Alone })])
 269     }
 270 }
 271
 272 impl ToInternal<rustc_errors::Level> for Level {
 273     fn to_internal(self) -> rustc_errors::Level {
 274         match self {
 275             Level::Error => rustc_errors::Level::Error,
 276             Level::Warning => rustc_errors::Level::Warning,
 277             Level::Note => rustc_errors::Level::Note,
 278             Level::Help => rustc_errors::Level::Help,
 279             _ => unreachable!("unknown proc_macro::Level variant: {:?}", self),
 280         }
 281     }
 282 }
 283
 284 pub struct FreeFunctions;
 285
 286 #[derive(Clone)]
 287 pub struct TokenStreamIter {
 288     cursor: tokenstream::Cursor,
 289     stack: Vec<TokenTree<Group, Punct, Ident, Literal>>,
 290 }
 291
 292 #[derive(Clone)]
 293 pub struct Group {
 294     delimiter: Delimiter,
 295     stream: TokenStream,
 296     span: DelimSpan,
 297     /// A hack used to pass AST fragments to attribute and derive macros
 298     /// as a single nonterminal token instead of a token stream.
 299     /// FIXME: It needs to be removed, but there are some compatibility issues (see #73345).
 300     flatten: bool,
 301 }
 302
 303 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
 304 pub struct Punct {
 305     ch: char,
 306     // NB. not using `Spacing` here because it doesn't implement `Hash`.
 307     joint: bool,
 308     span: Span,
 309 }
 310
 311 impl Punct {
 312     fn new(ch: char, joint: bool, span: Span) -> Punct {
 313         const LEGAL_CHARS: &[char] = &[
 314             '=', '<', '>', '!', '~', '+', '-', '*', '/', '%', '^', '&', '|', '@', '.', ',', ';',
 315             ':', '#', '$', '?', '\'',
 316         ];
 317         if !LEGAL_CHARS.contains(&ch) {
 318             panic!("unsupported character `{:?}`", ch)
 319         }
 320         Punct { ch, joint, span }
 321     }
 322 }
 323
 324 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
 325 pub struct Ident {
 326     sym: Symbol,
 327     is_raw: bool,
 328     span: Span,
 329 }
 330
 331 impl Ident {
 332     fn new(sess: &ParseSess, sym: Symbol, is_raw: bool, span: Span) -> Ident {
 333         let sym = nfc_normalize(&sym.as_str());
 334         let string = sym.as_str();
 335         if !rustc_lexer::is_ident(&string) {
 336             panic!("`{:?}` is not a valid identifier", string)
 337         }
 338         if is_raw && !sym.can_be_raw() {
 339             panic!("`{}` cannot be a raw identifier", string);
 340         }
 341         sess.symbol_gallery.insert(sym, span);
 342         Ident { sym, is_raw, span }
 343     }
 344     fn dollar_crate(span: Span) -> Ident {
 345         // `$crate` is accepted as an ident only if it comes from the compiler.
 346         Ident { sym: kw::DollarCrate, is_raw: false, span }
 347     }
 348 }
 349
 350 // FIXME(eddyb) `Literal` should not expose internal `Debug` impls.
 351 #[derive(Clone, Debug)]
 352 pub struct Literal {
 353     lit: token::Lit,
 354     span: Span,
 355 }
 356
 357 pub(crate) struct Rustc<'a> {
 358     resolver: &'a dyn ResolverExpand,
 359     sess: &'a ParseSess,
 360     def_site: Span,
 361     call_site: Span,
 362     mixed_site: Span,
 363     span_debug: bool,
 364     krate: CrateNum,
 365     rebased_spans: FxHashMap<usize, Span>,
 366 }
 367
 368 impl<'a> Rustc<'a> {
 369     pub fn new(cx: &'a ExtCtxt<'_>) -> Self {
 370         let expn_data = cx.current_expansion.id.expn_data();
 371         Rustc {
 372             resolver: cx.resolver,
 373             sess: cx.parse_sess(),
 374             def_site: cx.with_def_site_ctxt(expn_data.def_site),
 375             call_site: cx.with_call_site_ctxt(expn_data.call_site),
 376             mixed_site: cx.with_mixed_site_ctxt(expn_data.call_site),
 377             span_debug: cx.ecfg.span_debug,
 378             krate: expn_data.macro_def_id.unwrap().krate,
 379             rebased_spans: FxHashMap::default(),
 380         }
 381     }
 382
 383     fn lit(&mut self, kind: token::LitKind, symbol: Symbol, suffix: Option<Symbol>) -> Literal {
 384         Literal { lit: token::Lit::new(kind, symbol, suffix), span: server::Span::call_site(self) }
 385     }
 386 }
 387
 388 impl server::Types for Rustc<'_> {
 389     type FreeFunctions = FreeFunctions;
 390     type TokenStream = TokenStream;
 391     type TokenStreamBuilder = tokenstream::TokenStreamBuilder;
 392     type TokenStreamIter = TokenStreamIter;
 393     type Group = Group;
 394     type Punct = Punct;
 395     type Ident = Ident;
 396     type Literal = Literal;
 397     type SourceFile = Lrc<SourceFile>;
 398     type MultiSpan = Vec<Span>;
 399     type Diagnostic = Diagnostic;
 400     type Span = Span;
 401 }
 402
 403 impl server::FreeFunctions for Rustc<'_> {
 404     fn track_env_var(&mut self, var: &str, value: Option<&str>) {
 405         self.sess.env_depinfo.borrow_mut().insert((Symbol::intern(var), value.map(Symbol::intern)));
 406     }
 407
 408     fn track_path(&mut self, path: &str) {
 409         self.sess.file_depinfo.borrow_mut().insert(Symbol::intern(path));
 410     }
 411 }
 412
 413 impl server::TokenStream for Rustc<'_> {
 414     fn new(&mut self) -> Self::TokenStream {
 415         TokenStream::default()
 416     }
 417     fn is_empty(&mut self, stream: &Self::TokenStream) -> bool {
 418         stream.is_empty()
 419     }
 420     fn from_str(&mut self, src: &str) -> Self::TokenStream {
 421         parse_stream_from_source_str(
 422             FileName::proc_macro_source_code(src),
 423             src.to_string(),
 424             self.sess,
 425             Some(self.call_site),
 426         )
 427     }
 428     fn to_string(&mut self, stream: &Self::TokenStream) -> String {
 429         pprust::tts_to_string(stream)
 430     }
 431     fn from_token_tree(
 432         &mut self,
 433         tree: TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>,
 434     ) -> Self::TokenStream {
 435         tree.to_internal()
 436     }
 437     fn into_iter(&mut self, stream: Self::TokenStream) -> Self::TokenStreamIter {
 438         TokenStreamIter { cursor: stream.trees(), stack: vec![] }
 439     }
 440 }
 441
 442 impl server::TokenStreamBuilder for Rustc<'_> {
 443     fn new(&mut self) -> Self::TokenStreamBuilder {
 444         tokenstream::TokenStreamBuilder::new()
 445     }
 446     fn push(&mut self, builder: &mut Self::TokenStreamBuilder, stream: Self::TokenStream) {
 447         builder.push(stream);
 448     }
 449     fn build(&mut self, builder: Self::TokenStreamBuilder) -> Self::TokenStream {
 450         builder.build()
 451     }
 452 }
 453
 454 impl server::TokenStreamIter for Rustc<'_> {
 455     fn next(
 456         &mut self,
 457         iter: &mut Self::TokenStreamIter,
 458     ) -> Option<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>> {
 459         loop {
 460             let tree = iter.stack.pop().or_else(|| {
 461                 let next = iter.cursor.next_with_spacing()?;
 462                 Some(TokenTree::from_internal((next, &mut iter.stack, self)))
 463             })?;
 464             // A hack used to pass AST fragments to attribute and derive macros
 465             // as a single nonterminal token instead of a token stream.
 466             // Such token needs to be "unwrapped" and not represented as a delimited group.
 467             // FIXME: It needs to be removed, but there are some compatibility issues (see #73345).
 468             if let TokenTree::Group(ref group) = tree {
 469                 if group.flatten {
 470                     iter.cursor.append(group.stream.clone());
 471                     continue;
 472                 }
 473             }
 474             return Some(tree);
 475         }
 476     }
 477 }
 478
 479 impl server::Group for Rustc<'_> {
 480     fn new(&mut self, delimiter: Delimiter, stream: Self::TokenStream) -> Self::Group {
 481         Group {
 482             delimiter,
 483             stream,
 484             span: DelimSpan::from_single(server::Span::call_site(self)),
 485             flatten: false,
 486         }
 487     }
 488     fn delimiter(&mut self, group: &Self::Group) -> Delimiter {
 489         group.delimiter
 490     }
 491     fn stream(&mut self, group: &Self::Group) -> Self::TokenStream {
 492         group.stream.clone()
 493     }
 494     fn span(&mut self, group: &Self::Group) -> Self::Span {
 495         group.span.entire()
 496     }
 497     fn span_open(&mut self, group: &Self::Group) -> Self::Span {
 498         group.span.open
 499     }
 500     fn span_close(&mut self, group: &Self::Group) -> Self::Span {
 501         group.span.close
 502     }
 503     fn set_span(&mut self, group: &mut Self::Group, span: Self::Span) {
 504         group.span = DelimSpan::from_single(span);
 505     }
 506 }
 507
 508 impl server::Punct for Rustc<'_> {
 509     fn new(&mut self, ch: char, spacing: Spacing) -> Self::Punct {
 510         Punct::new(ch, spacing == Spacing::Joint, server::Span::call_site(self))
 511     }
 512     fn as_char(&mut self, punct: Self::Punct) -> char {
 513         punct.ch
 514     }
 515     fn spacing(&mut self, punct: Self::Punct) -> Spacing {
 516         if punct.joint { Spacing::Joint } else { Spacing::Alone }
 517     }
 518     fn span(&mut self, punct: Self::Punct) -> Self::Span {
 519         punct.span
 520     }
 521     fn with_span(&mut self, punct: Self::Punct, span: Self::Span) -> Self::Punct {
 522         Punct { span, ..punct }
 523     }
 524 }
 525
 526 impl server::Ident for Rustc<'_> {
 527     fn new(&mut self, string: &str, span: Self::Span, is_raw: bool) -> Self::Ident {
 528         Ident::new(self.sess, Symbol::intern(string), is_raw, span)
 529     }
 530     fn span(&mut self, ident: Self::Ident) -> Self::Span {
 531         ident.span
 532     }
 533     fn with_span(&mut self, ident: Self::Ident, span: Self::Span) -> Self::Ident {
 534         Ident { span, ..ident }
 535     }
 536 }
 537
 538 impl server::Literal for Rustc<'_> {
 539     fn from_str(&mut self, s: &str) -> Result<Self::Literal, ()> {
 540         let override_span = None;
 541         let stream = parse_stream_from_source_str(
 542             FileName::proc_macro_source_code(s),
 543             s.to_owned(),
 544             self.sess,
 545             override_span,
 546         );
 547         if stream.len() != 1 {
 548             return Err(());
 549         }
 550         let tree = stream.into_trees().next().unwrap();
 551         let token = match tree {
 552             tokenstream::TokenTree::Token(token) => token,
 553             tokenstream::TokenTree::Delimited { .. } => return Err(()),
 554         };
 555         let span_data = token.span.data();
 556         if (span_data.hi.0 - span_data.lo.0) as usize != s.len() {
 557             // There is a comment or whitespace adjacent to the literal.
 558             return Err(());
 559         }
 560         let lit = match token.kind {
 561             TokenKind::Literal(lit) => lit,
 562             _ => return Err(()),
 563         };
 564         Ok(Literal { lit, span: self.call_site })
 565     }
 566     fn debug_kind(&mut self, literal: &Self::Literal) -> String {
 567         format!("{:?}", literal.lit.kind)
 568     }
 569     fn symbol(&mut self, literal: &Self::Literal) -> String {
 570         literal.lit.symbol.to_string()
 571     }
 572     fn suffix(&mut self, literal: &Self::Literal) -> Option<String> {
 573         literal.lit.suffix.as_ref().map(Symbol::to_string)
 574     }
 575     fn integer(&mut self, n: &str) -> Self::Literal {
 576         self.lit(token::Integer, Symbol::intern(n), None)
 577     }
 578     fn typed_integer(&mut self, n: &str, kind: &str) -> Self::Literal {
 579         self.lit(token::Integer, Symbol::intern(n), Some(Symbol::intern(kind)))
 580     }
 581     fn float(&mut self, n: &str) -> Self::Literal {
 582         self.lit(token::Float, Symbol::intern(n), None)
 583     }
 584     fn f32(&mut self, n: &str) -> Self::Literal {
 585         self.lit(token::Float, Symbol::intern(n), Some(sym::f32))
 586     }
 587     fn f64(&mut self, n: &str) -> Self::Literal {
 588         self.lit(token::Float, Symbol::intern(n), Some(sym::f64))
 589     }
 590     fn string(&mut self, string: &str) -> Self::Literal {
 591         let mut escaped = String::new();
 592         for ch in string.chars() {
 593             escaped.extend(ch.escape_debug());
 594         }
 595         self.lit(token::Str, Symbol::intern(&escaped), None)
 596     }
 597     fn character(&mut self, ch: char) -> Self::Literal {
 598         let mut escaped = String::new();
 599         escaped.extend(ch.escape_unicode());
 600         self.lit(token::Char, Symbol::intern(&escaped), None)
 601     }
 602     fn byte_string(&mut self, bytes: &[u8]) -> Self::Literal {
 603         let string = bytes
 604             .iter()
 605             .cloned()
 606             .flat_map(ascii::escape_default)
 607             .map(Into::<char>::into)
 608             .collect::<String>();
 609         self.lit(token::ByteStr, Symbol::intern(&string), None)
 610     }
 611     fn span(&mut self, literal: &Self::Literal) -> Self::Span {
 612         literal.span
 613     }
 614     fn set_span(&mut self, literal: &mut Self::Literal, span: Self::Span) {
 615         literal.span = span;
 616     }
 617     fn subspan(
 618         &mut self,
 619         literal: &Self::Literal,
 620         start: Bound<usize>,
 621         end: Bound<usize>,
 622     ) -> Option<Self::Span> {
 623         let span = literal.span;
 624         let length = span.hi().to_usize() - span.lo().to_usize();
 625
 626         let start = match start {
 627             Bound::Included(lo) => lo,
 628             Bound::Excluded(lo) => lo.checked_add(1)?,
 629             Bound::Unbounded => 0,
 630         };
 631
 632         let end = match end {
 633             Bound::Included(hi) => hi.checked_add(1)?,
 634             Bound::Excluded(hi) => hi,
 635             Bound::Unbounded => length,
 636         };
 637
 638         // Bounds check the values, preventing addition overflow and OOB spans.
 639         if start > u32::MAX as usize
 640             || end > u32::MAX as usize
 641             || (u32::MAX - start as u32) < span.lo().to_u32()
 642             || (u32::MAX - end as u32) < span.lo().to_u32()
 643             || start >= end
 644             || end > length
 645         {
 646             return None;
 647         }
 648
 649         let new_lo = span.lo() + BytePos::from_usize(start);
 650         let new_hi = span.lo() + BytePos::from_usize(end);
 651         Some(span.with_lo(new_lo).with_hi(new_hi))
 652     }
 653 }
 654
 655 impl server::SourceFile for Rustc<'_> {
 656     fn eq(&mut self, file1: &Self::SourceFile, file2: &Self::SourceFile) -> bool {
 657         Lrc::ptr_eq(file1, file2)
 658     }
 659     fn path(&mut self, file: &Self::SourceFile) -> String {
 660         match file.name {
 661             FileName::Real(ref name) => name
 662                 .local_path()
 663                 .expect("attempting to get a file path in an imported file in `proc_macro::SourceFile::path`")
 664                 .to_str()
 665                 .expect("non-UTF8 file path in `proc_macro::SourceFile::path`")
 666                 .to_string(),
 667             _ => file.name.prefer_local().to_string(),
 668         }
 669     }
 670     fn is_real(&mut self, file: &Self::SourceFile) -> bool {
 671         file.is_real_file()
 672     }
 673 }
 674
 675 impl server::MultiSpan for Rustc<'_> {
 676     fn new(&mut self) -> Self::MultiSpan {
 677         vec![]
 678     }
 679     fn push(&mut self, spans: &mut Self::MultiSpan, span: Self::Span) {
 680         spans.push(span)
 681     }
 682 }
 683
 684 impl server::Diagnostic for Rustc<'_> {
 685     fn new(&mut self, level: Level, msg: &str, spans: Self::MultiSpan) -> Self::Diagnostic {
 686         let mut diag = Diagnostic::new(level.to_internal(), msg);
 687         diag.set_span(MultiSpan::from_spans(spans));
 688         diag
 689     }
 690     fn sub(
 691         &mut self,
 692         diag: &mut Self::Diagnostic,
 693         level: Level,
 694         msg: &str,
 695         spans: Self::MultiSpan,
 696     ) {
 697         diag.sub(level.to_internal(), msg, MultiSpan::from_spans(spans), None);
 698     }
 699     fn emit(&mut self, diag: Self::Diagnostic) {
 700         self.sess.span_diagnostic.emit_diagnostic(&diag);
 701     }
 702 }
 703
 704 impl server::Span for Rustc<'_> {
 705     fn debug(&mut self, span: Self::Span) -> String {
 706         if self.span_debug {
 707             format!("{:?}", span)
 708         } else {
 709             format!("{:?} bytes({}..{})", span.ctxt(), span.lo().0, span.hi().0)
 710         }
 711     }
 712     fn def_site(&mut self) -> Self::Span {
 713         self.def_site
 714     }
 715     fn call_site(&mut self) -> Self::Span {
 716         self.call_site
 717     }
 718     fn mixed_site(&mut self) -> Self::Span {
 719         self.mixed_site
 720     }
 721     fn source_file(&mut self, span: Self::Span) -> Self::SourceFile {
 722         self.sess.source_map().lookup_char_pos(span.lo()).file
 723     }
 724     fn parent(&mut self, span: Self::Span) -> Option<Self::Span> {
 725         span.parent()
 726     }
 727     fn source(&mut self, span: Self::Span) -> Self::Span {
 728         span.source_callsite()
 729     }
 730     fn start(&mut self, span: Self::Span) -> LineColumn {
 731         let loc = self.sess.source_map().lookup_char_pos(span.lo());
 732         LineColumn { line: loc.line, column: loc.col.to_usize() }
 733     }
 734     fn end(&mut self, span: Self::Span) -> LineColumn {
 735         let loc = self.sess.source_map().lookup_char_pos(span.hi());
 736         LineColumn { line: loc.line, column: loc.col.to_usize() }
 737     }
 738     fn join(&mut self, first: Self::Span, second: Self::Span) -> Option<Self::Span> {
 739         let self_loc = self.sess.source_map().lookup_char_pos(first.lo());
 740         let other_loc = self.sess.source_map().lookup_char_pos(second.lo());
 741
 742         if self_loc.file.name != other_loc.file.name {
 743             return None;
 744         }
 745
 746         Some(first.to(second))
 747     }
 748     fn resolved_at(&mut self, span: Self::Span, at: Self::Span) -> Self::Span {
 749         span.with_ctxt(at.ctxt())
 750     }
 751     fn source_text(&mut self, span: Self::Span) -> Option<String> {
 752         self.sess.source_map().span_to_snippet(span).ok()
 753     }
 754     /// Saves the provided span into the metadata of
 755     /// *the crate we are currently compiling*, which must
 756     /// be a proc-macro crate. This id can be passed to
 757     /// `recover_proc_macro_span` when our current crate
 758     /// is *run* as a proc-macro.
 759     ///
 760     /// Let's suppose that we have two crates - `my_client`
 761     /// and `my_proc_macro`. The `my_proc_macro` crate
 762     /// contains a procedural macro `my_macro`, which
 763     /// is implemented as: `quote! { "hello" }`
 764     ///
 765     /// When we *compile* `my_proc_macro`, we will execute
 766     /// the `quote` proc-macro. This will save the span of
 767     /// "hello" into the metadata of `my_proc_macro`. As a result,
 768     /// the body of `my_proc_macro` (after expansion) will end
 769     /// up containg a call that looks like this:
 770     /// `proc_macro::Ident::new("hello", proc_macro::Span::recover_proc_macro_span(0))`
 771     ///
 772     /// where `0` is the id returned by this function.
 773     /// When `my_proc_macro` *executes* (during the compilation of `my_client`),
 774     /// the call to `recover_proc_macro_span` will load the corresponding
 775     /// span from the metadata of `my_proc_macro` (which we have access to,
 776     /// since we've loaded `my_proc_macro` from disk in order to execute it).
 777     /// In this way, we have obtained a span pointing into `my_proc_macro`
 778     fn save_span(&mut self, span: Self::Span) -> usize {
 779         self.sess.save_proc_macro_span(span)
 780     }
 781     fn recover_proc_macro_span(&mut self, id: usize) -> Self::Span {
 782         let (resolver, krate, def_site) = (self.resolver, self.krate, self.def_site);
 783         *self.rebased_spans.entry(id).or_insert_with(|| {
 784             // FIXME: `SyntaxContext` for spans from proc macro crates is lost during encoding,
 785             // replace it with a def-site context until we are encoding it properly.
 786             resolver.get_proc_macro_quoted_span(krate, id).with_ctxt(def_site.ctxt())
 787         })
 788     }
 789 }
 790
 791 // See issue #74616 for details
 792 fn ident_name_compatibility_hack(
 793     nt: &Nonterminal,
 794     orig_span: Span,
 795     rustc: &mut Rustc<'_>,
 796 ) -> Option<(rustc_span::symbol::Ident, bool)> {
 797     if let NtIdent(ident, is_raw) = nt {
 798         if let ExpnKind::Macro(_, macro_name) = orig_span.ctxt().outer_expn_data().kind {
 799             let source_map = rustc.sess.source_map();
 800             let filename = source_map.span_to_filename(orig_span);
 801             if let FileName::Real(RealFileName::LocalPath(path)) = filename {
 802                 let matches_prefix = |prefix, filename| {
 803                     // Check for a path that ends with 'prefix*/src/<filename>'
 804                     let mut iter = path.components().rev();
 805                     iter.next().and_then(|p| p.as_os_str().to_str()) == Some(filename)
 806                         && iter.next().and_then(|p| p.as_os_str().to_str()) == Some("src")
 807                         && iter
 808                             .next()
 809                             .and_then(|p| p.as_os_str().to_str())
 810                             .map_or(false, |p| p.starts_with(prefix))
 811                 };
 812
 813                 let time_macros_impl =
 814                     macro_name == sym::impl_macros && matches_prefix("time-macros-impl", "lib.rs");
 815                 let js_sys = macro_name == sym::arrays && matches_prefix("js-sys", "lib.rs");
 816                 if time_macros_impl || js_sys {
 817                     let snippet = source_map.span_to_snippet(orig_span);
 818                     if snippet.as_deref() == Ok("$name") {
 819                         if time_macros_impl {
 820                             rustc.sess.buffer_lint_with_diagnostic(
 821                                 &PROC_MACRO_BACK_COMPAT,
 822                                 orig_span,
 823                                 ast::CRATE_NODE_ID,
 824                                 "using an old version of `time-macros-impl`",
 825                                 BuiltinLintDiagnostics::ProcMacroBackCompat(
 826                                 "the `time-macros-impl` crate will stop compiling in futures version of Rust. \
 827                                 Please update to the latest version of the `time` crate to avoid breakage".to_string())
 828                             );
 829                             return Some((*ident, *is_raw));
 830                         }
 831                         if js_sys {
 832                             if let Some(c) = path
 833                                 .components()
 834                                 .flat_map(|c| c.as_os_str().to_str())
 835                                 .find(|c| c.starts_with("js-sys"))
 836                             {
 837                                 let mut version = c.trim_start_matches("js-sys-").split('.');
 838                                 if version.next() == Some("0")
 839                                     && version.next() == Some("3")
 840                                     && version
 841                                         .next()
 842                                         .and_then(|c| c.parse::<u32>().ok())
 843                                         .map_or(false, |v| v < 40)
 844                                 {
 845                                     rustc.sess.buffer_lint_with_diagnostic(
 846                                         &PROC_MACRO_BACK_COMPAT,
 847                                         orig_span,
 848                                         ast::CRATE_NODE_ID,
 849                                         "using an old version of `js-sys`",
 850                                         BuiltinLintDiagnostics::ProcMacroBackCompat(
 851                                         "older versions of the `js-sys` crate will stop compiling in future versions of Rust; \
 852                                         please update to `js-sys` v0.3.40 or above".to_string())
 853                                     );
 854                                     return Some((*ident, *is_raw));
 855                                 }
 856                             }
 857                         }
 858                     }
 859                 }
 860
 861                 if macro_name == sym::tuple_from_req && matches_prefix("actix-web", "extract.rs") {
 862                     let snippet = source_map.span_to_snippet(orig_span);
 863                     if snippet.as_deref() == Ok("$T") {
 864                         if let FileName::Real(RealFileName::LocalPath(macro_path)) =
 865                             source_map.span_to_filename(rustc.def_site)
 866                         {
 867                             if macro_path.to_string_lossy().contains("pin-project-internal-0.") {
 868                                 rustc.sess.buffer_lint_with_diagnostic(
 869                                     &PROC_MACRO_BACK_COMPAT,
 870                                     orig_span,
 871                                     ast::CRATE_NODE_ID,
 872                                     "using an old version of `actix-web`",
 873                                     BuiltinLintDiagnostics::ProcMacroBackCompat(
 874                                     "the version of `actix-web` you are using might stop compiling in future versions of Rust; \
 875                                     please update to the latest version of the `actix-web` crate to avoid breakage".to_string())
 876                                 );
 877                                 return Some((*ident, *is_raw));
 878                             }
 879                         }
 880                     }
 881                 }
 882             }
 883         }
 884     }
 885     None
 886 }