src/libsyntax_pos/hygiene.rs

   1 //! Machinery for hygienic macros, inspired by the `MTWT[1]` paper.
   2 //!
   3 //! `[1]` Matthew Flatt, Ryan Culpepper, David Darais, and Robert Bruce Findler. 2012.
   4 //! *Macros that work together: Compile-time bindings, partial expansion,
   5 //! and definition contexts*. J. Funct. Program. 22, 2 (March 2012), 181-216.
   6 //! DOI=10.1017/S0956796812000093 <https://doi.org/10.1017/S0956796812000093>
   7
   8 use crate::GLOBALS;
   9 use crate::Span;
  10 use crate::edition::Edition;
  11 use crate::symbol::{kw, Symbol};
  12
  13 use serialize::{Encodable, Decodable, Encoder, Decoder};
  14 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  15 use rustc_data_structures::sync::Lrc;
  16 use std::{fmt, mem};
  17
  18 /// A SyntaxContext represents a chain of macro expansions (represented by marks).
  19 #[derive(Clone, Copy, PartialEq, Eq, Default, PartialOrd, Ord, Hash)]
  20 pub struct SyntaxContext(u32);
  21
  22 #[derive(Copy, Clone, Debug)]
  23 struct SyntaxContextData {
  24     outer_mark: Mark,
  25     transparency: Transparency,
  26     prev_ctxt: SyntaxContext,
  27     /// This context, but with all transparent and semi-transparent marks filtered away.
  28     opaque: SyntaxContext,
  29     /// This context, but with all transparent marks filtered away.
  30     opaque_and_semitransparent: SyntaxContext,
  31     /// Name of the crate to which `$crate` with this context would resolve.
  32     dollar_crate_name: Symbol,
  33 }
  34
  35 /// A mark is a unique ID associated with a macro expansion.
  36 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
  37 pub struct Mark(u32);
  38
  39 #[derive(Clone, Debug)]
  40 struct MarkData {
  41     parent: Mark,
  42     default_transparency: Transparency,
  43     expn_info: Option<ExpnInfo>,
  44 }
  45
  46 /// A property of a macro expansion that determines how identifiers
  47 /// produced by that expansion are resolved.
  48 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Hash, Debug)]
  49 pub enum Transparency {
  50     /// Identifier produced by a transparent expansion is always resolved at call-site.
  51     /// Call-site spans in procedural macros, hygiene opt-out in `macro` should use this.
  52     Transparent,
  53     /// Identifier produced by a semi-transparent expansion may be resolved
  54     /// either at call-site or at definition-site.
  55     /// If it's a local variable, label or `$crate` then it's resolved at def-site.
  56     /// Otherwise it's resolved at call-site.
  57     /// `macro_rules` macros behave like this, built-in macros currently behave like this too,
  58     /// but that's an implementation detail.
  59     SemiTransparent,
  60     /// Identifier produced by an opaque expansion is always resolved at definition-site.
  61     /// Def-site spans in procedural macros, identifiers from `macro` by default use this.
  62     Opaque,
  63 }
  64
  65 impl Mark {
  66     pub fn fresh(parent: Mark) -> Self {
  67         HygieneData::with(|data| {
  68             data.marks.push(MarkData {
  69                 parent,
  70                 // By default expansions behave like `macro_rules`.
  71                 default_transparency: Transparency::SemiTransparent,
  72                 expn_info: None,
  73             });
  74             Mark(data.marks.len() as u32 - 1)
  75         })
  76     }
  77
  78     /// The mark of the theoretical expansion that generates freshly parsed, unexpanded AST.
  79     #[inline]
  80     pub fn root() -> Self {
  81         Mark(0)
  82     }
  83
  84     #[inline]
  85     pub fn as_u32(self) -> u32 {
  86         self.0
  87     }
  88
  89     #[inline]
  90     pub fn from_u32(raw: u32) -> Mark {
  91         Mark(raw)
  92     }
  93
  94     #[inline]
  95     pub fn parent(self) -> Mark {
  96         HygieneData::with(|data| data.marks[self.0 as usize].parent)
  97     }
  98
  99     #[inline]
 100     pub fn expn_info(self) -> Option<ExpnInfo> {
 101         HygieneData::with(|data| data.marks[self.0 as usize].expn_info.clone())
 102     }
 103
 104     #[inline]
 105     pub fn set_expn_info(self, info: ExpnInfo) {
 106         HygieneData::with(|data| data.marks[self.0 as usize].expn_info = Some(info))
 107     }
 108
 109     #[inline]
 110     pub fn set_default_transparency(self, transparency: Transparency) {
 111         assert_ne!(self, Mark::root());
 112         HygieneData::with(|data| data.marks[self.0 as usize].default_transparency = transparency)
 113     }
 114
 115     pub fn is_descendant_of(mut self, ancestor: Mark) -> bool {
 116         HygieneData::with(|data| {
 117             while self != ancestor {
 118                 if self == Mark::root() {
 119                     return false;
 120                 }
 121                 self = data.marks[self.0 as usize].parent;
 122             }
 123             true
 124         })
 125     }
 126
 127     /// Computes a mark such that both input marks are descendants of (or equal to) the returned
 128     /// mark. That is, the following holds:
 129     ///
 130     /// ```rust
 131     /// let la = least_ancestor(a, b);
 132     /// assert!(a.is_descendant_of(la))
 133     /// assert!(b.is_descendant_of(la))
 134     /// ```
 135     pub fn least_ancestor(mut a: Mark, mut b: Mark) -> Mark {
 136         HygieneData::with(|data| {
 137             // Compute the path from a to the root
 138             let mut a_path = FxHashSet::<Mark>::default();
 139             while a != Mark::root() {
 140                 a_path.insert(a);
 141                 a = data.marks[a.0 as usize].parent;
 142             }
 143
 144             // While the path from b to the root hasn't intersected, move up the tree
 145             while !a_path.contains(&b) {
 146                 b = data.marks[b.0 as usize].parent;
 147             }
 148
 149             b
 150         })
 151     }
 152
 153     // Used for enabling some compatibility fallback in resolve.
 154     #[inline]
 155     pub fn looks_like_proc_macro_derive(self) -> bool {
 156         HygieneData::with(|data| {
 157             let mark_data = &data.marks[self.0 as usize];
 158             if mark_data.default_transparency == Transparency::Opaque {
 159                 if let Some(expn_info) = &mark_data.expn_info {
 160                     if let ExpnFormat::MacroAttribute(name) = expn_info.format {
 161                         if name.as_str().starts_with("derive(") {
 162                             return true;
 163                         }
 164                     }
 165                 }
 166             }
 167             false
 168         })
 169     }
 170 }
 171
 172 #[derive(Debug)]
 173 crate struct HygieneData {
 174     marks: Vec<MarkData>,
 175     syntax_contexts: Vec<SyntaxContextData>,
 176     markings: FxHashMap<(SyntaxContext, Mark, Transparency), SyntaxContext>,
 177 }
 178
 179 impl HygieneData {
 180     crate fn new() -> Self {
 181         HygieneData {
 182             marks: vec![MarkData {
 183                 parent: Mark::root(),
 184                 // If the root is opaque, then loops searching for an opaque mark
 185                 // will automatically stop after reaching it.
 186                 default_transparency: Transparency::Opaque,
 187                 expn_info: None,
 188             }],
 189             syntax_contexts: vec![SyntaxContextData {
 190                 outer_mark: Mark::root(),
 191                 transparency: Transparency::Opaque,
 192                 prev_ctxt: SyntaxContext(0),
 193                 opaque: SyntaxContext(0),
 194                 opaque_and_semitransparent: SyntaxContext(0),
 195                 dollar_crate_name: kw::DollarCrate,
 196             }],
 197             markings: FxHashMap::default(),
 198         }
 199     }
 200
 201     fn with<T, F: FnOnce(&mut HygieneData) -> T>(f: F) -> T {
 202         GLOBALS.with(|globals| f(&mut *globals.hygiene_data.borrow_mut()))
 203     }
 204 }
 205
 206 pub fn clear_markings() {
 207     HygieneData::with(|data| data.markings = FxHashMap::default());
 208 }
 209
 210 impl SyntaxContext {
 211     #[inline]
 212     pub const fn empty() -> Self {
 213         SyntaxContext(0)
 214     }
 215
 216     #[inline]
 217     crate fn as_u32(self) -> u32 {
 218         self.0
 219     }
 220
 221     #[inline]
 222     crate fn from_u32(raw: u32) -> SyntaxContext {
 223         SyntaxContext(raw)
 224     }
 225
 226     // Allocate a new SyntaxContext with the given ExpnInfo. This is used when
 227     // deserializing Spans from the incr. comp. cache.
 228     // FIXME(mw): This method does not restore MarkData::parent or
 229     // SyntaxContextData::prev_ctxt or SyntaxContextData::opaque. These things
 230     // don't seem to be used after HIR lowering, so everything should be fine
 231     // as long as incremental compilation does not kick in before that.
 232     pub fn allocate_directly(expansion_info: ExpnInfo) -> Self {
 233         HygieneData::with(|data| {
 234             data.marks.push(MarkData {
 235                 parent: Mark::root(),
 236                 default_transparency: Transparency::SemiTransparent,
 237                 expn_info: Some(expansion_info),
 238             });
 239
 240             let mark = Mark(data.marks.len() as u32 - 1);
 241
 242             data.syntax_contexts.push(SyntaxContextData {
 243                 outer_mark: mark,
 244                 transparency: Transparency::SemiTransparent,
 245                 prev_ctxt: SyntaxContext::empty(),
 246                 opaque: SyntaxContext::empty(),
 247                 opaque_and_semitransparent: SyntaxContext::empty(),
 248                 dollar_crate_name: kw::DollarCrate,
 249             });
 250             SyntaxContext(data.syntax_contexts.len() as u32 - 1)
 251         })
 252     }
 253
 254     /// Extend a syntax context with a given mark and default transparency for that mark.
 255     pub fn apply_mark(self, mark: Mark) -> SyntaxContext {
 256         assert_ne!(mark, Mark::root());
 257         self.apply_mark_with_transparency(
 258             mark, HygieneData::with(|data| data.marks[mark.0 as usize].default_transparency)
 259         )
 260     }
 261
 262     /// Extend a syntax context with a given mark and transparency
 263     pub fn apply_mark_with_transparency(self, mark: Mark, transparency: Transparency)
 264                                         -> SyntaxContext {
 265         assert_ne!(mark, Mark::root());
 266         if transparency == Transparency::Opaque {
 267             return self.apply_mark_internal(mark, transparency);
 268         }
 269
 270         let call_site_ctxt =
 271             mark.expn_info().map_or(SyntaxContext::empty(), |info| info.call_site.ctxt());
 272         let call_site_ctxt = if transparency == Transparency::SemiTransparent {
 273             call_site_ctxt.modern()
 274         } else {
 275             call_site_ctxt.modern_and_legacy()
 276         };
 277
 278         if call_site_ctxt == SyntaxContext::empty() {
 279             return self.apply_mark_internal(mark, transparency);
 280         }
 281
 282         // Otherwise, `mark` is a macros 1.0 definition and the call site is in a
 283         // macros 2.0 expansion, i.e., a macros 1.0 invocation is in a macros 2.0 definition.
 284         //
 285         // In this case, the tokens from the macros 1.0 definition inherit the hygiene
 286         // at their invocation. That is, we pretend that the macros 1.0 definition
 287         // was defined at its invocation (i.e., inside the macros 2.0 definition)
 288         // so that the macros 2.0 definition remains hygienic.
 289         //
 290         // See the example at `test/run-pass/hygiene/legacy_interaction.rs`.
 291         let mut ctxt = call_site_ctxt;
 292         for (mark, transparency) in self.marks() {
 293             ctxt = ctxt.apply_mark_internal(mark, transparency);
 294         }
 295         ctxt.apply_mark_internal(mark, transparency)
 296     }
 297
 298     fn apply_mark_internal(self, mark: Mark, transparency: Transparency) -> SyntaxContext {
 299         HygieneData::with(|data| {
 300             let syntax_contexts = &mut data.syntax_contexts;
 301             let mut opaque = syntax_contexts[self.0 as usize].opaque;
 302             let mut opaque_and_semitransparent =
 303                 syntax_contexts[self.0 as usize].opaque_and_semitransparent;
 304
 305             if transparency >= Transparency::Opaque {
 306                 let prev_ctxt = opaque;
 307                 opaque = *data.markings.entry((prev_ctxt, mark, transparency)).or_insert_with(|| {
 308                     let new_opaque = SyntaxContext(syntax_contexts.len() as u32);
 309                     syntax_contexts.push(SyntaxContextData {
 310                         outer_mark: mark,
 311                         transparency,
 312                         prev_ctxt,
 313                         opaque: new_opaque,
 314                         opaque_and_semitransparent: new_opaque,
 315                         dollar_crate_name: kw::DollarCrate,
 316                     });
 317                     new_opaque
 318                 });
 319             }
 320
 321             if transparency >= Transparency::SemiTransparent {
 322                 let prev_ctxt = opaque_and_semitransparent;
 323                 opaque_and_semitransparent =
 324                         *data.markings.entry((prev_ctxt, mark, transparency)).or_insert_with(|| {
 325                     let new_opaque_and_semitransparent =
 326                         SyntaxContext(syntax_contexts.len() as u32);
 327                     syntax_contexts.push(SyntaxContextData {
 328                         outer_mark: mark,
 329                         transparency,
 330                         prev_ctxt,
 331                         opaque,
 332                         opaque_and_semitransparent: new_opaque_and_semitransparent,
 333                         dollar_crate_name: kw::DollarCrate,
 334                     });
 335                     new_opaque_and_semitransparent
 336                 });
 337             }
 338
 339             let prev_ctxt = self;
 340             *data.markings.entry((prev_ctxt, mark, transparency)).or_insert_with(|| {
 341                 let new_opaque_and_semitransparent_and_transparent =
 342                     SyntaxContext(syntax_contexts.len() as u32);
 343                 syntax_contexts.push(SyntaxContextData {
 344                     outer_mark: mark,
 345                     transparency,
 346                     prev_ctxt,
 347                     opaque,
 348                     opaque_and_semitransparent,
 349                     dollar_crate_name: kw::DollarCrate,
 350                 });
 351                 new_opaque_and_semitransparent_and_transparent
 352             })
 353         })
 354     }
 355
 356     /// Pulls a single mark off of the syntax context. This effectively moves the
 357     /// context up one macro definition level. That is, if we have a nested macro
 358     /// definition as follows:
 359     ///
 360     /// ```rust
 361     /// macro_rules! f {
 362     ///    macro_rules! g {
 363     ///        ...
 364     ///    }
 365     /// }
 366     /// ```
 367     ///
 368     /// and we have a SyntaxContext that is referring to something declared by an invocation
 369     /// of g (call it g1), calling remove_mark will result in the SyntaxContext for the
 370     /// invocation of f that created g1.
 371     /// Returns the mark that was removed.
 372     pub fn remove_mark(&mut self) -> Mark {
 373         HygieneData::with(|data| {
 374             let outer_mark = data.syntax_contexts[self.0 as usize].outer_mark;
 375             *self = data.syntax_contexts[self.0 as usize].prev_ctxt;
 376             outer_mark
 377         })
 378     }
 379
 380     pub fn marks(mut self) -> Vec<(Mark, Transparency)> {
 381         HygieneData::with(|data| {
 382             let mut marks = Vec::new();
 383             while self != SyntaxContext::empty() {
 384                 let ctxt_data = &data.syntax_contexts[self.0 as usize];
 385                 marks.push((ctxt_data.outer_mark, ctxt_data.transparency));
 386                 self = ctxt_data.prev_ctxt;
 387             }
 388             marks.reverse();
 389             marks
 390         })
 391     }
 392
 393     /// Adjust this context for resolution in a scope created by the given expansion.
 394     /// For example, consider the following three resolutions of `f`:
 395     ///
 396     /// ```rust
 397     /// mod foo { pub fn f() {} } // `f`'s `SyntaxContext` is empty.
 398     /// m!(f);
 399     /// macro m($f:ident) {
 400     ///     mod bar {
 401     ///         pub fn f() {} // `f`'s `SyntaxContext` has a single `Mark` from `m`.
 402     ///         pub fn $f() {} // `$f`'s `SyntaxContext` is empty.
 403     ///     }
 404     ///     foo::f(); // `f`'s `SyntaxContext` has a single `Mark` from `m`
 405     ///     //^ Since `mod foo` is outside this expansion, `adjust` removes the mark from `f`,
 406     ///     //| and it resolves to `::foo::f`.
 407     ///     bar::f(); // `f`'s `SyntaxContext` has a single `Mark` from `m`
 408     ///     //^ Since `mod bar` not outside this expansion, `adjust` does not change `f`,
 409     ///     //| and it resolves to `::bar::f`.
 410     ///     bar::$f(); // `f`'s `SyntaxContext` is empty.
 411     ///     //^ Since `mod bar` is not outside this expansion, `adjust` does not change `$f`,
 412     ///     //| and it resolves to `::bar::$f`.
 413     /// }
 414     /// ```
 415     /// This returns the expansion whose definition scope we use to privacy check the resolution,
 416     /// or `None` if we privacy check as usual (i.e., not w.r.t. a macro definition scope).
 417     pub fn adjust(&mut self, expansion: Mark) -> Option<Mark> {
 418         let mut scope = None;
 419         while !expansion.is_descendant_of(self.outer()) {
 420             scope = Some(self.remove_mark());
 421         }
 422         scope
 423     }
 424
 425     /// Adjust this context for resolution in a scope created by the given expansion
 426     /// via a glob import with the given `SyntaxContext`.
 427     /// For example:
 428     ///
 429     /// ```rust
 430     /// m!(f);
 431     /// macro m($i:ident) {
 432     ///     mod foo {
 433     ///         pub fn f() {} // `f`'s `SyntaxContext` has a single `Mark` from `m`.
 434     ///         pub fn $i() {} // `$i`'s `SyntaxContext` is empty.
 435     ///     }
 436     ///     n(f);
 437     ///     macro n($j:ident) {
 438     ///         use foo::*;
 439     ///         f(); // `f`'s `SyntaxContext` has a mark from `m` and a mark from `n`
 440     ///         //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::f`.
 441     ///         $i(); // `$i`'s `SyntaxContext` has a mark from `n`
 442     ///         //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::$i`.
 443     ///         $j(); // `$j`'s `SyntaxContext` has a mark from `m`
 444     ///         //^ This cannot be glob-adjusted, so this is a resolution error.
 445     ///     }
 446     /// }
 447     /// ```
 448     /// This returns `None` if the context cannot be glob-adjusted.
 449     /// Otherwise, it returns the scope to use when privacy checking (see `adjust` for details).
 450     pub fn glob_adjust(&mut self, expansion: Mark, mut glob_ctxt: SyntaxContext)
 451                        -> Option<Option<Mark>> {
 452         let mut scope = None;
 453         while !expansion.is_descendant_of(glob_ctxt.outer()) {
 454             scope = Some(glob_ctxt.remove_mark());
 455             if self.remove_mark() != scope.unwrap() {
 456                 return None;
 457             }
 458         }
 459         if self.adjust(expansion).is_some() {
 460             return None;
 461         }
 462         Some(scope)
 463     }
 464
 465     /// Undo `glob_adjust` if possible:
 466     ///
 467     /// ```rust
 468     /// if let Some(privacy_checking_scope) = self.reverse_glob_adjust(expansion, glob_ctxt) {
 469     ///     assert!(self.glob_adjust(expansion, glob_ctxt) == Some(privacy_checking_scope));
 470     /// }
 471     /// ```
 472     pub fn reverse_glob_adjust(&mut self, expansion: Mark, mut glob_ctxt: SyntaxContext)
 473                                -> Option<Option<Mark>> {
 474         if self.adjust(expansion).is_some() {
 475             return None;
 476         }
 477
 478         let mut marks = Vec::new();
 479         while !expansion.is_descendant_of(glob_ctxt.outer()) {
 480             marks.push(glob_ctxt.remove_mark());
 481         }
 482
 483         let scope = marks.last().cloned();
 484         while let Some(mark) = marks.pop() {
 485             *self = self.apply_mark(mark);
 486         }
 487         Some(scope)
 488     }
 489
 490     #[inline]
 491     pub fn modern(self) -> SyntaxContext {
 492         HygieneData::with(|data| data.syntax_contexts[self.0 as usize].opaque)
 493     }
 494
 495     #[inline]
 496     pub fn modern_and_legacy(self) -> SyntaxContext {
 497         HygieneData::with(|data| data.syntax_contexts[self.0 as usize].opaque_and_semitransparent)
 498     }
 499
 500     #[inline]
 501     pub fn outer(self) -> Mark {
 502         HygieneData::with(|data| data.syntax_contexts[self.0 as usize].outer_mark)
 503     }
 504
 505     pub fn dollar_crate_name(self) -> Symbol {
 506         HygieneData::with(|data| data.syntax_contexts[self.0 as usize].dollar_crate_name)
 507     }
 508
 509     pub fn set_dollar_crate_name(self, dollar_crate_name: Symbol) {
 510         HygieneData::with(|data| {
 511             let prev_dollar_crate_name = mem::replace(
 512                 &mut data.syntax_contexts[self.0 as usize].dollar_crate_name, dollar_crate_name
 513             );
 514             assert!(dollar_crate_name == prev_dollar_crate_name ||
 515                     prev_dollar_crate_name == kw::DollarCrate,
 516                     "$crate name is reset for a syntax context");
 517         })
 518     }
 519 }
 520
 521 impl fmt::Debug for SyntaxContext {
 522     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 523         write!(f, "#{}", self.0)
 524     }
 525 }
 526
 527 /// Extra information for tracking spans of macro and syntax sugar expansion
 528 #[derive(Clone, Hash, Debug, RustcEncodable, RustcDecodable)]
 529 pub struct ExpnInfo {
 530     /// The location of the actual macro invocation or syntax sugar , e.g.
 531     /// `let x = foo!();` or `if let Some(y) = x {}`
 532     ///
 533     /// This may recursively refer to other macro invocations, e.g., if
 534     /// `foo!()` invoked `bar!()` internally, and there was an
 535     /// expression inside `bar!`; the call_site of the expression in
 536     /// the expansion would point to the `bar!` invocation; that
 537     /// call_site span would have its own ExpnInfo, with the call_site
 538     /// pointing to the `foo!` invocation.
 539     pub call_site: Span,
 540     /// The span of the macro definition itself. The macro may not
 541     /// have a sensible definition span (e.g., something defined
 542     /// completely inside libsyntax) in which case this is None.
 543     /// This span serves only informational purpose and is not used for resolution.
 544     pub def_site: Option<Span>,
 545     /// The format with which the macro was invoked.
 546     pub format: ExpnFormat,
 547     /// List of #[unstable]/feature-gated features that the macro is allowed to use
 548     /// internally without forcing the whole crate to opt-in
 549     /// to them.
 550     pub allow_internal_unstable: Option<Lrc<[Symbol]>>,
 551     /// Whether the macro is allowed to use `unsafe` internally
 552     /// even if the user crate has `#![forbid(unsafe_code)]`.
 553     pub allow_internal_unsafe: bool,
 554     /// Enables the macro helper hack (`ident!(...)` -> `$crate::ident!(...)`)
 555     /// for a given macro.
 556     pub local_inner_macros: bool,
 557     /// Edition of the crate in which the macro is defined.
 558     pub edition: Edition,
 559 }
 560
 561 /// The source of expansion.
 562 #[derive(Clone, Hash, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
 563 pub enum ExpnFormat {
 564     /// e.g., #[derive(...)] <item>
 565     MacroAttribute(Symbol),
 566     /// e.g., `format!()`
 567     MacroBang(Symbol),
 568     /// Desugaring done by the compiler during HIR lowering.
 569     CompilerDesugaring(CompilerDesugaringKind)
 570 }
 571
 572 impl ExpnFormat {
 573     pub fn name(&self) -> Symbol {
 574         match *self {
 575             ExpnFormat::MacroBang(name) | ExpnFormat::MacroAttribute(name) => name,
 576             ExpnFormat::CompilerDesugaring(kind) => kind.name(),
 577         }
 578     }
 579 }
 580
 581 /// The kind of compiler desugaring.
 582 #[derive(Clone, Copy, Hash, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
 583 pub enum CompilerDesugaringKind {
 584     /// We desugar `if c { i } else { e }` to `match $ExprKind::Use(c) { true => i, _ => e }`.
 585     /// However, we do not want to blame `c` for unreachability but rather say that `i`
 586     /// is unreachable. This desugaring kind allows us to avoid blaming `c`.
 587     IfTemporary,
 588     QuestionMark,
 589     TryBlock,
 590     /// Desugaring of an `impl Trait` in return type position
 591     /// to an `existential type Foo: Trait;` and replacing the
 592     /// `impl Trait` with `Foo`.
 593     ExistentialReturnType,
 594     Async,
 595     Await,
 596     ForLoop,
 597 }
 598
 599 impl CompilerDesugaringKind {
 600     pub fn name(self) -> Symbol {
 601         Symbol::intern(match self {
 602             CompilerDesugaringKind::IfTemporary => "if",
 603             CompilerDesugaringKind::Async => "async",
 604             CompilerDesugaringKind::Await => "await",
 605             CompilerDesugaringKind::QuestionMark => "?",
 606             CompilerDesugaringKind::TryBlock => "try block",
 607             CompilerDesugaringKind::ExistentialReturnType => "existential type",
 608             CompilerDesugaringKind::ForLoop => "for loop",
 609         })
 610     }
 611 }
 612
 613 impl Encodable for SyntaxContext {
 614     fn encode<E: Encoder>(&self, _: &mut E) -> Result<(), E::Error> {
 615         Ok(()) // FIXME(jseyfried) intercrate hygiene
 616     }
 617 }
 618
 619 impl Decodable for SyntaxContext {
 620     fn decode<D: Decoder>(_: &mut D) -> Result<SyntaxContext, D::Error> {
 621         Ok(SyntaxContext::empty()) // FIXME(jseyfried) intercrate hygiene
 622     }
 623 }