1 //! Machinery for hygienic macros.
3 //! Inspired by Matthew Flatt et al., “Macros That Work Together: Compile-Time Bindings, Partial
4 //! Expansion, and Definition Contexts,” *Journal of Functional Programming* 22, no. 2
5 //! (March 1, 2012): 181–216, <https://doi.org/10.1017/S0956796812000093>.
7 // Hygiene data is stored in a global variable and accessed via TLS, which
8 // means that accesses are somewhat expensive. (`HygieneData::with`
9 // encapsulates a single access.) Therefore, on hot code paths it is worth
10 // ensuring that multiple HygieneData accesses are combined into a single
11 // `HygieneData::with`.
13 // This explains why `HygieneData`, `SyntaxContext` and `ExpnId` have interfaces
14 // with a certain amount of redundancy in them. For example,
15 // `SyntaxContext::outer_expn_data` combines `SyntaxContext::outer` and
16 // `ExpnId::expn_data` so that two `HygieneData` accesses can be performed within
17 // a single `HygieneData::with` call.
19 // It also explains why many functions appear in `HygieneData` and again in
20 // `SyntaxContext` or `ExpnId`. For example, `HygieneData::outer` and
21 // `SyntaxContext::outer` do the same thing, but the former is for use within a
22 // `HygieneData::with` call while the latter is for use outside such a call.
23 // When modifying this file it is important to understand this distinction,
24 // because getting it wrong can lead to nested `HygieneData::with` calls that
25 // trigger runtime aborts. (Fortunately these are obvious and easy to fix.)
27 use crate::edition::Edition;
28 use crate::symbol::{kw, sym, Symbol};
29 use crate::with_session_globals;
30 use crate::{HashStableContext, Span, DUMMY_SP};
32 use crate::def_id::{CrateNum, DefId, StableCrateId, CRATE_DEF_ID, LOCAL_CRATE};
33 use rustc_data_structures::fingerprint::Fingerprint;
34 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
35 use rustc_data_structures::stable_hasher::HashingControls;
36 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
37 use rustc_data_structures::sync::{Lock, Lrc};
38 use rustc_data_structures::unhash::UnhashMap;
39 use rustc_index::vec::IndexVec;
40 use rustc_macros::HashStable_Generic;
41 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
46 /// A `SyntaxContext` represents a chain of pairs `(ExpnId, Transparency)` named "marks".
47 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
48 pub struct SyntaxContext(u32);
50 #[derive(Debug, Encodable, Decodable, Clone)]
51 pub struct SyntaxContextData {
53 outer_transparency: Transparency,
54 parent: SyntaxContext,
55 /// This context, but with all transparent and semi-transparent expansions filtered away.
56 opaque: SyntaxContext,
57 /// This context, but with all transparent expansions filtered away.
58 opaque_and_semitransparent: SyntaxContext,
59 /// Name of the crate to which `$crate` with this context would resolve.
60 dollar_crate_name: Symbol,
63 rustc_index::newtype_index! {
64 /// A unique ID associated with a macro invocation and expansion.
65 pub struct ExpnIndex {
70 /// A unique ID associated with a macro invocation and expansion.
71 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
74 pub local_id: ExpnIndex,
77 impl fmt::Debug for ExpnId {
78 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
79 // Generate crate_::{{expn_}}.
80 write!(f, "{:?}::{{{{expn{}}}}}", self.krate, self.local_id.private)
84 rustc_index::newtype_index! {
85 /// A unique ID associated with a macro invocation and expansion.
86 pub struct LocalExpnId {
88 DEBUG_FORMAT = "expn{}"
92 /// Assert that the provided `HashStableContext` is configured with the 'default'
93 /// `HashingControls`. We should always have bailed out before getting to here
94 /// with a non-default mode. With this check in place, we can avoid the need
95 /// to maintain separate versions of `ExpnData` hashes for each permutation
96 /// of `HashingControls` settings.
97 fn assert_default_hashing_controls<CTX: HashStableContext>(ctx: &CTX, msg: &str) {
98 match ctx.hashing_controls() {
99 // Ideally, we would also check that `node_id_hashing_mode` was always
100 // `NodeIdHashingMode::HashDefPath`. However, we currently end up hashing
101 // `Span`s in this mode, and there's not an easy way to change that.
102 // All of the span-related data that we hash is pretty self-contained
103 // (in particular, we don't hash any `HirId`s), so this shouldn't result
104 // in any caching problems.
105 // FIXME: Enforce that we don't end up transitively hashing any `HirId`s,
106 // or ensure that this method is always invoked with the same
107 // `NodeIdHashingMode`
109 // Note that we require that `hash_spans` be set according to the global
110 // `-Z incremental-ignore-spans` option. Normally, this option is disabled,
111 // which will cause us to require that this method always be called with `Span` hashing
113 HashingControls { hash_spans, node_id_hashing_mode: _ }
114 if hash_spans == !ctx.debug_opts_incremental_ignore_spans() => {}
115 other => panic!("Attempted hashing of {msg} with non-default HashingControls: {:?}", other),
119 /// A unique hash value associated to an expansion.
120 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Encodable, Decodable, HashStable_Generic)]
121 pub struct ExpnHash(Fingerprint);
124 /// Returns the [StableCrateId] identifying the crate this [ExpnHash]
127 pub fn stable_crate_id(self) -> StableCrateId {
128 StableCrateId(self.0.as_value().0)
131 /// Returns the crate-local part of the [ExpnHash].
135 pub fn local_hash(self) -> u64 {
140 pub fn is_root(self) -> bool {
141 self.0 == Fingerprint::ZERO
144 /// Builds a new [ExpnHash] with the given [StableCrateId] and
145 /// `local_hash`, where `local_hash` must be unique within its crate.
146 fn new(stable_crate_id: StableCrateId, local_hash: u64) -> ExpnHash {
147 ExpnHash(Fingerprint::new(stable_crate_id.0, local_hash))
151 /// A property of a macro expansion that determines how identifiers
152 /// produced by that expansion are resolved.
153 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Hash, Debug, Encodable, Decodable)]
154 #[derive(HashStable_Generic)]
155 pub enum Transparency {
156 /// Identifier produced by a transparent expansion is always resolved at call-site.
157 /// Call-site spans in procedural macros, hygiene opt-out in `macro` should use this.
159 /// Identifier produced by a semi-transparent expansion may be resolved
160 /// either at call-site or at definition-site.
161 /// If it's a local variable, label or `$crate` then it's resolved at def-site.
162 /// Otherwise it's resolved at call-site.
163 /// `macro_rules` macros behave like this, built-in macros currently behave like this too,
164 /// but that's an implementation detail.
166 /// Identifier produced by an opaque expansion is always resolved at definition-site.
167 /// Def-site spans in procedural macros, identifiers from `macro` by default use this.
172 /// The ID of the theoretical expansion that generates freshly parsed, unexpanded AST.
173 pub const ROOT: LocalExpnId = LocalExpnId::from_u32(0);
176 pub fn from_raw(idx: ExpnIndex) -> LocalExpnId {
177 LocalExpnId::from_u32(idx.as_u32())
181 pub fn as_raw(self) -> ExpnIndex {
182 ExpnIndex::from_u32(self.as_u32())
185 pub fn fresh_empty() -> LocalExpnId {
186 HygieneData::with(|data| {
187 let expn_id = data.local_expn_data.push(None);
188 let _eid = data.local_expn_hashes.push(ExpnHash(Fingerprint::ZERO));
189 debug_assert_eq!(expn_id, _eid);
194 pub fn fresh(mut expn_data: ExpnData, ctx: impl HashStableContext) -> LocalExpnId {
195 debug_assert_eq!(expn_data.parent.krate, LOCAL_CRATE);
196 let expn_hash = update_disambiguator(&mut expn_data, ctx);
197 HygieneData::with(|data| {
198 let expn_id = data.local_expn_data.push(Some(expn_data));
199 let _eid = data.local_expn_hashes.push(expn_hash);
200 debug_assert_eq!(expn_id, _eid);
201 let _old_id = data.expn_hash_to_expn_id.insert(expn_hash, expn_id.to_expn_id());
202 debug_assert!(_old_id.is_none());
208 pub fn expn_hash(self) -> ExpnHash {
209 HygieneData::with(|data| data.local_expn_hash(self))
213 pub fn expn_data(self) -> ExpnData {
214 HygieneData::with(|data| data.local_expn_data(self).clone())
218 pub fn to_expn_id(self) -> ExpnId {
219 ExpnId { krate: LOCAL_CRATE, local_id: self.as_raw() }
223 pub fn set_expn_data(self, mut expn_data: ExpnData, ctx: impl HashStableContext) {
224 debug_assert_eq!(expn_data.parent.krate, LOCAL_CRATE);
225 let expn_hash = update_disambiguator(&mut expn_data, ctx);
226 HygieneData::with(|data| {
227 let old_expn_data = &mut data.local_expn_data[self];
228 assert!(old_expn_data.is_none(), "expansion data is reset for an expansion ID");
229 *old_expn_data = Some(expn_data);
230 debug_assert_eq!(data.local_expn_hashes[self].0, Fingerprint::ZERO);
231 data.local_expn_hashes[self] = expn_hash;
232 let _old_id = data.expn_hash_to_expn_id.insert(expn_hash, self.to_expn_id());
233 debug_assert!(_old_id.is_none());
238 pub fn is_descendant_of(self, ancestor: LocalExpnId) -> bool {
239 self.to_expn_id().is_descendant_of(ancestor.to_expn_id())
242 /// `expn_id.outer_expn_is_descendant_of(ctxt)` is equivalent to but faster than
243 /// `expn_id.is_descendant_of(ctxt.outer_expn())`.
245 pub fn outer_expn_is_descendant_of(self, ctxt: SyntaxContext) -> bool {
246 self.to_expn_id().outer_expn_is_descendant_of(ctxt)
249 /// Returns span for the macro which originally caused this expansion to happen.
251 /// Stops backtracing at include! boundary.
253 pub fn expansion_cause(self) -> Option<Span> {
254 self.to_expn_id().expansion_cause()
259 pub fn parent(self) -> LocalExpnId {
260 self.expn_data().parent.as_local().unwrap()
265 /// The ID of the theoretical expansion that generates freshly parsed, unexpanded AST.
266 /// Invariant: we do not create any ExpnId with local_id == 0 and krate != 0.
267 pub const fn root() -> ExpnId {
268 ExpnId { krate: LOCAL_CRATE, local_id: ExpnIndex::from_u32(0) }
272 pub fn expn_hash(self) -> ExpnHash {
273 HygieneData::with(|data| data.expn_hash(self))
277 pub fn from_hash(hash: ExpnHash) -> Option<ExpnId> {
278 HygieneData::with(|data| data.expn_hash_to_expn_id.get(&hash).copied())
282 pub fn as_local(self) -> Option<LocalExpnId> {
283 if self.krate == LOCAL_CRATE { Some(LocalExpnId::from_raw(self.local_id)) } else { None }
288 pub fn expect_local(self) -> LocalExpnId {
289 self.as_local().unwrap()
293 pub fn expn_data(self) -> ExpnData {
294 HygieneData::with(|data| data.expn_data(self).clone())
298 pub fn is_descendant_of(self, ancestor: ExpnId) -> bool {
299 // a few "fast path" cases to avoid locking HygieneData
300 if ancestor == ExpnId::root() || ancestor == self {
303 if ancestor.krate != self.krate {
306 HygieneData::with(|data| data.is_descendant_of(self, ancestor))
309 /// `expn_id.outer_expn_is_descendant_of(ctxt)` is equivalent to but faster than
310 /// `expn_id.is_descendant_of(ctxt.outer_expn())`.
311 pub fn outer_expn_is_descendant_of(self, ctxt: SyntaxContext) -> bool {
312 HygieneData::with(|data| data.is_descendant_of(self, data.outer_expn(ctxt)))
315 /// Returns span for the macro which originally caused this expansion to happen.
317 /// Stops backtracing at include! boundary.
318 pub fn expansion_cause(mut self) -> Option<Span> {
319 let mut last_macro = None;
321 let expn_data = self.expn_data();
322 // Stop going up the backtrace once include! is encountered
323 if expn_data.is_root()
324 || expn_data.kind == ExpnKind::Macro(MacroKind::Bang, sym::include)
328 self = expn_data.call_site.ctxt().outer_expn();
329 last_macro = Some(expn_data.call_site);
336 pub struct HygieneData {
337 /// Each expansion should have an associated expansion data, but sometimes there's a delay
338 /// between creation of an expansion ID and obtaining its data (e.g. macros are collected
339 /// first and then resolved later), so we use an `Option` here.
340 local_expn_data: IndexVec<LocalExpnId, Option<ExpnData>>,
341 local_expn_hashes: IndexVec<LocalExpnId, ExpnHash>,
342 /// Data and hash information from external crates. We may eventually want to remove these
343 /// maps, and fetch the information directly from the other crate's metadata like DefIds do.
344 foreign_expn_data: FxHashMap<ExpnId, ExpnData>,
345 foreign_expn_hashes: FxHashMap<ExpnId, ExpnHash>,
346 expn_hash_to_expn_id: UnhashMap<ExpnHash, ExpnId>,
347 syntax_context_data: Vec<SyntaxContextData>,
348 syntax_context_map: FxHashMap<(SyntaxContext, ExpnId, Transparency), SyntaxContext>,
349 /// Maps the `local_hash` of an `ExpnData` to the next disambiguator value.
350 /// This is used by `update_disambiguator` to keep track of which `ExpnData`s
351 /// would have collisions without a disambiguator.
352 /// The keys of this map are always computed with `ExpnData.disambiguator`
354 expn_data_disambiguators: FxHashMap<u64, u32>,
358 crate fn new(edition: Edition) -> Self {
359 let root_data = ExpnData::default(
363 Some(CRATE_DEF_ID.to_def_id()),
368 local_expn_data: IndexVec::from_elem_n(Some(root_data), 1),
369 local_expn_hashes: IndexVec::from_elem_n(ExpnHash(Fingerprint::ZERO), 1),
370 foreign_expn_data: FxHashMap::default(),
371 foreign_expn_hashes: FxHashMap::default(),
372 expn_hash_to_expn_id: std::iter::once((ExpnHash(Fingerprint::ZERO), ExpnId::root()))
374 syntax_context_data: vec![SyntaxContextData {
375 outer_expn: ExpnId::root(),
376 outer_transparency: Transparency::Opaque,
377 parent: SyntaxContext(0),
378 opaque: SyntaxContext(0),
379 opaque_and_semitransparent: SyntaxContext(0),
380 dollar_crate_name: kw::DollarCrate,
382 syntax_context_map: FxHashMap::default(),
383 expn_data_disambiguators: FxHashMap::default(),
387 pub fn with<T, F: FnOnce(&mut HygieneData) -> T>(f: F) -> T {
388 with_session_globals(|session_globals| f(&mut *session_globals.hygiene_data.borrow_mut()))
392 fn local_expn_hash(&self, expn_id: LocalExpnId) -> ExpnHash {
393 self.local_expn_hashes[expn_id]
397 fn expn_hash(&self, expn_id: ExpnId) -> ExpnHash {
398 match expn_id.as_local() {
399 Some(expn_id) => self.local_expn_hashes[expn_id],
400 None => self.foreign_expn_hashes[&expn_id],
404 fn local_expn_data(&self, expn_id: LocalExpnId) -> &ExpnData {
405 self.local_expn_data[expn_id].as_ref().expect("no expansion data for an expansion ID")
408 fn expn_data(&self, expn_id: ExpnId) -> &ExpnData {
409 if let Some(expn_id) = expn_id.as_local() {
410 self.local_expn_data[expn_id].as_ref().expect("no expansion data for an expansion ID")
412 &self.foreign_expn_data[&expn_id]
416 fn is_descendant_of(&self, mut expn_id: ExpnId, ancestor: ExpnId) -> bool {
417 // a couple "fast path" cases to avoid traversing parents in the loop below
418 if ancestor == ExpnId::root() {
421 if expn_id.krate != ancestor.krate {
425 if expn_id == ancestor {
428 if expn_id == ExpnId::root() {
431 expn_id = self.expn_data(expn_id).parent;
435 fn normalize_to_macros_2_0(&self, ctxt: SyntaxContext) -> SyntaxContext {
436 self.syntax_context_data[ctxt.0 as usize].opaque
439 fn normalize_to_macro_rules(&self, ctxt: SyntaxContext) -> SyntaxContext {
440 self.syntax_context_data[ctxt.0 as usize].opaque_and_semitransparent
443 fn outer_expn(&self, ctxt: SyntaxContext) -> ExpnId {
444 self.syntax_context_data[ctxt.0 as usize].outer_expn
447 fn outer_mark(&self, ctxt: SyntaxContext) -> (ExpnId, Transparency) {
448 let data = &self.syntax_context_data[ctxt.0 as usize];
449 (data.outer_expn, data.outer_transparency)
452 fn parent_ctxt(&self, ctxt: SyntaxContext) -> SyntaxContext {
453 self.syntax_context_data[ctxt.0 as usize].parent
456 fn remove_mark(&self, ctxt: &mut SyntaxContext) -> (ExpnId, Transparency) {
457 let outer_mark = self.outer_mark(*ctxt);
458 *ctxt = self.parent_ctxt(*ctxt);
462 fn marks(&self, mut ctxt: SyntaxContext) -> Vec<(ExpnId, Transparency)> {
463 let mut marks = Vec::new();
464 while ctxt != SyntaxContext::root() {
465 debug!("marks: getting parent of {:?}", ctxt);
466 marks.push(self.outer_mark(ctxt));
467 ctxt = self.parent_ctxt(ctxt);
473 fn walk_chain(&self, mut span: Span, to: SyntaxContext) -> Span {
474 debug!("walk_chain({:?}, {:?})", span, to);
475 debug!("walk_chain: span ctxt = {:?}", span.ctxt());
476 while span.from_expansion() && span.ctxt() != to {
477 let outer_expn = self.outer_expn(span.ctxt());
478 debug!("walk_chain({:?}): outer_expn={:?}", span, outer_expn);
479 let expn_data = self.expn_data(outer_expn);
480 debug!("walk_chain({:?}): expn_data={:?}", span, expn_data);
481 span = expn_data.call_site;
486 fn adjust(&self, ctxt: &mut SyntaxContext, expn_id: ExpnId) -> Option<ExpnId> {
487 let mut scope = None;
488 while !self.is_descendant_of(expn_id, self.outer_expn(*ctxt)) {
489 scope = Some(self.remove_mark(ctxt).0);
498 transparency: Transparency,
500 assert_ne!(expn_id, ExpnId::root());
501 if transparency == Transparency::Opaque {
502 return self.apply_mark_internal(ctxt, expn_id, transparency);
505 let call_site_ctxt = self.expn_data(expn_id).call_site.ctxt();
506 let mut call_site_ctxt = if transparency == Transparency::SemiTransparent {
507 self.normalize_to_macros_2_0(call_site_ctxt)
509 self.normalize_to_macro_rules(call_site_ctxt)
512 if call_site_ctxt == SyntaxContext::root() {
513 return self.apply_mark_internal(ctxt, expn_id, transparency);
516 // Otherwise, `expn_id` is a macros 1.0 definition and the call site is in a
517 // macros 2.0 expansion, i.e., a macros 1.0 invocation is in a macros 2.0 definition.
519 // In this case, the tokens from the macros 1.0 definition inherit the hygiene
520 // at their invocation. That is, we pretend that the macros 1.0 definition
521 // was defined at its invocation (i.e., inside the macros 2.0 definition)
522 // so that the macros 2.0 definition remains hygienic.
524 // See the example at `test/ui/hygiene/legacy_interaction.rs`.
525 for (expn_id, transparency) in self.marks(ctxt) {
526 call_site_ctxt = self.apply_mark_internal(call_site_ctxt, expn_id, transparency);
528 self.apply_mark_internal(call_site_ctxt, expn_id, transparency)
531 fn apply_mark_internal(
535 transparency: Transparency,
537 let syntax_context_data = &mut self.syntax_context_data;
538 let mut opaque = syntax_context_data[ctxt.0 as usize].opaque;
539 let mut opaque_and_semitransparent =
540 syntax_context_data[ctxt.0 as usize].opaque_and_semitransparent;
542 if transparency >= Transparency::Opaque {
546 .entry((parent, expn_id, transparency))
548 let new_opaque = SyntaxContext(syntax_context_data.len() as u32);
549 syntax_context_data.push(SyntaxContextData {
551 outer_transparency: transparency,
554 opaque_and_semitransparent: new_opaque,
555 dollar_crate_name: kw::DollarCrate,
561 if transparency >= Transparency::SemiTransparent {
562 let parent = opaque_and_semitransparent;
563 opaque_and_semitransparent = *self
565 .entry((parent, expn_id, transparency))
567 let new_opaque_and_semitransparent =
568 SyntaxContext(syntax_context_data.len() as u32);
569 syntax_context_data.push(SyntaxContextData {
571 outer_transparency: transparency,
574 opaque_and_semitransparent: new_opaque_and_semitransparent,
575 dollar_crate_name: kw::DollarCrate,
577 new_opaque_and_semitransparent
582 *self.syntax_context_map.entry((parent, expn_id, transparency)).or_insert_with(|| {
583 let new_opaque_and_semitransparent_and_transparent =
584 SyntaxContext(syntax_context_data.len() as u32);
585 syntax_context_data.push(SyntaxContextData {
587 outer_transparency: transparency,
590 opaque_and_semitransparent,
591 dollar_crate_name: kw::DollarCrate,
593 new_opaque_and_semitransparent_and_transparent
598 pub fn clear_syntax_context_map() {
599 HygieneData::with(|data| data.syntax_context_map = FxHashMap::default());
602 pub fn walk_chain(span: Span, to: SyntaxContext) -> Span {
603 HygieneData::with(|data| data.walk_chain(span, to))
606 pub fn update_dollar_crate_names(mut get_name: impl FnMut(SyntaxContext) -> Symbol) {
607 // The new contexts that need updating are at the end of the list and have `$crate` as a name.
608 let (len, to_update) = HygieneData::with(|data| {
610 data.syntax_context_data.len(),
611 data.syntax_context_data
614 .take_while(|scdata| scdata.dollar_crate_name == kw::DollarCrate)
618 // The callback must be called from outside of the `HygieneData` lock,
619 // since it will try to acquire it too.
620 let range_to_update = len - to_update..len;
622 range_to_update.clone().map(|idx| get_name(SyntaxContext::from_u32(idx as u32))).collect();
623 HygieneData::with(|data| {
624 range_to_update.zip(names).for_each(|(idx, name)| {
625 data.syntax_context_data[idx].dollar_crate_name = name;
630 pub fn debug_hygiene_data(verbose: bool) -> String {
631 HygieneData::with(|data| {
633 format!("{:#?}", data)
635 let mut s = String::from("");
636 s.push_str("Expansions:");
637 let mut debug_expn_data = |(id, expn_data): (&ExpnId, &ExpnData)| {
639 "\n{:?}: parent: {:?}, call_site_ctxt: {:?}, def_site_ctxt: {:?}, kind: {:?}",
642 expn_data.call_site.ctxt(),
643 expn_data.def_site.ctxt(),
647 data.local_expn_data.iter_enumerated().for_each(|(id, expn_data)| {
648 let expn_data = expn_data.as_ref().expect("no expansion data for an expansion ID");
649 debug_expn_data((&id.to_expn_id(), expn_data))
651 // Sort the hash map for more reproducible output.
652 let mut foreign_expn_data: Vec<_> = data.foreign_expn_data.iter().collect();
653 foreign_expn_data.sort_by_key(|(id, _)| (id.krate, id.local_id));
654 foreign_expn_data.into_iter().for_each(debug_expn_data);
655 s.push_str("\n\nSyntaxContexts:");
656 data.syntax_context_data.iter().enumerate().for_each(|(id, ctxt)| {
658 "\n#{}: parent: {:?}, outer_mark: ({:?}, {:?})",
659 id, ctxt.parent, ctxt.outer_expn, ctxt.outer_transparency,
669 pub const fn root() -> Self {
674 crate fn as_u32(self) -> u32 {
679 crate fn from_u32(raw: u32) -> SyntaxContext {
683 /// Extend a syntax context with a given expansion and transparency.
684 crate fn apply_mark(self, expn_id: ExpnId, transparency: Transparency) -> SyntaxContext {
685 HygieneData::with(|data| data.apply_mark(self, expn_id, transparency))
688 /// Pulls a single mark off of the syntax context. This effectively moves the
689 /// context up one macro definition level. That is, if we have a nested macro
690 /// definition as follows:
700 /// and we have a SyntaxContext that is referring to something declared by an invocation
701 /// of g (call it g1), calling remove_mark will result in the SyntaxContext for the
702 /// invocation of f that created g1.
703 /// Returns the mark that was removed.
704 pub fn remove_mark(&mut self) -> ExpnId {
705 HygieneData::with(|data| data.remove_mark(self).0)
708 pub fn marks(self) -> Vec<(ExpnId, Transparency)> {
709 HygieneData::with(|data| data.marks(self))
712 /// Adjust this context for resolution in a scope created by the given expansion.
713 /// For example, consider the following three resolutions of `f`:
716 /// mod foo { pub fn f() {} } // `f`'s `SyntaxContext` is empty.
718 /// macro m($f:ident) {
720 /// pub fn f() {} // `f`'s `SyntaxContext` has a single `ExpnId` from `m`.
721 /// pub fn $f() {} // `$f`'s `SyntaxContext` is empty.
723 /// foo::f(); // `f`'s `SyntaxContext` has a single `ExpnId` from `m`
724 /// //^ Since `mod foo` is outside this expansion, `adjust` removes the mark from `f`,
725 /// //| and it resolves to `::foo::f`.
726 /// bar::f(); // `f`'s `SyntaxContext` has a single `ExpnId` from `m`
727 /// //^ Since `mod bar` not outside this expansion, `adjust` does not change `f`,
728 /// //| and it resolves to `::bar::f`.
729 /// bar::$f(); // `f`'s `SyntaxContext` is empty.
730 /// //^ Since `mod bar` is not outside this expansion, `adjust` does not change `$f`,
731 /// //| and it resolves to `::bar::$f`.
734 /// This returns the expansion whose definition scope we use to privacy check the resolution,
735 /// or `None` if we privacy check as usual (i.e., not w.r.t. a macro definition scope).
736 pub fn adjust(&mut self, expn_id: ExpnId) -> Option<ExpnId> {
737 HygieneData::with(|data| data.adjust(self, expn_id))
740 /// Like `SyntaxContext::adjust`, but also normalizes `self` to macros 2.0.
741 pub fn normalize_to_macros_2_0_and_adjust(&mut self, expn_id: ExpnId) -> Option<ExpnId> {
742 HygieneData::with(|data| {
743 *self = data.normalize_to_macros_2_0(*self);
744 data.adjust(self, expn_id)
748 /// Adjust this context for resolution in a scope created by the given expansion
749 /// via a glob import with the given `SyntaxContext`.
754 /// macro m($i:ident) {
756 /// pub fn f() {} // `f`'s `SyntaxContext` has a single `ExpnId` from `m`.
757 /// pub fn $i() {} // `$i`'s `SyntaxContext` is empty.
760 /// macro n($j:ident) {
762 /// f(); // `f`'s `SyntaxContext` has a mark from `m` and a mark from `n`
763 /// //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::f`.
764 /// $i(); // `$i`'s `SyntaxContext` has a mark from `n`
765 /// //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::$i`.
766 /// $j(); // `$j`'s `SyntaxContext` has a mark from `m`
767 /// //^ This cannot be glob-adjusted, so this is a resolution error.
771 /// This returns `None` if the context cannot be glob-adjusted.
772 /// Otherwise, it returns the scope to use when privacy checking (see `adjust` for details).
773 pub fn glob_adjust(&mut self, expn_id: ExpnId, glob_span: Span) -> Option<Option<ExpnId>> {
774 HygieneData::with(|data| {
775 let mut scope = None;
776 let mut glob_ctxt = data.normalize_to_macros_2_0(glob_span.ctxt());
777 while !data.is_descendant_of(expn_id, data.outer_expn(glob_ctxt)) {
778 scope = Some(data.remove_mark(&mut glob_ctxt).0);
779 if data.remove_mark(self).0 != scope.unwrap() {
783 if data.adjust(self, expn_id).is_some() {
790 /// Undo `glob_adjust` if possible:
793 /// if let Some(privacy_checking_scope) = self.reverse_glob_adjust(expansion, glob_ctxt) {
794 /// assert!(self.glob_adjust(expansion, glob_ctxt) == Some(privacy_checking_scope));
797 pub fn reverse_glob_adjust(
801 ) -> Option<Option<ExpnId>> {
802 HygieneData::with(|data| {
803 if data.adjust(self, expn_id).is_some() {
807 let mut glob_ctxt = data.normalize_to_macros_2_0(glob_span.ctxt());
808 let mut marks = Vec::new();
809 while !data.is_descendant_of(expn_id, data.outer_expn(glob_ctxt)) {
810 marks.push(data.remove_mark(&mut glob_ctxt));
813 let scope = marks.last().map(|mark| mark.0);
814 while let Some((expn_id, transparency)) = marks.pop() {
815 *self = data.apply_mark(*self, expn_id, transparency);
821 pub fn hygienic_eq(self, other: SyntaxContext, expn_id: ExpnId) -> bool {
822 HygieneData::with(|data| {
823 let mut self_normalized = data.normalize_to_macros_2_0(self);
824 data.adjust(&mut self_normalized, expn_id);
825 self_normalized == data.normalize_to_macros_2_0(other)
830 pub fn normalize_to_macros_2_0(self) -> SyntaxContext {
831 HygieneData::with(|data| data.normalize_to_macros_2_0(self))
835 pub fn normalize_to_macro_rules(self) -> SyntaxContext {
836 HygieneData::with(|data| data.normalize_to_macro_rules(self))
840 pub fn outer_expn(self) -> ExpnId {
841 HygieneData::with(|data| data.outer_expn(self))
844 /// `ctxt.outer_expn_data()` is equivalent to but faster than
845 /// `ctxt.outer_expn().expn_data()`.
847 pub fn outer_expn_data(self) -> ExpnData {
848 HygieneData::with(|data| data.expn_data(data.outer_expn(self)).clone())
852 pub fn outer_mark(self) -> (ExpnId, Transparency) {
853 HygieneData::with(|data| data.outer_mark(self))
856 pub fn dollar_crate_name(self) -> Symbol {
857 HygieneData::with(|data| data.syntax_context_data[self.0 as usize].dollar_crate_name)
860 pub fn edition(self) -> Edition {
861 HygieneData::with(|data| data.expn_data(data.outer_expn(self)).edition)
865 impl fmt::Debug for SyntaxContext {
866 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
867 write!(f, "#{}", self.0)
872 /// Creates a fresh expansion with given properties.
873 /// Expansions are normally created by macros, but in some cases expansions are created for
874 /// other compiler-generated code to set per-span properties like allowed unstable features.
875 /// The returned span belongs to the created expansion and has the new properties,
876 /// but its location is inherited from the current span.
877 pub fn fresh_expansion(self, expn_data: ExpnData, ctx: impl HashStableContext) -> Span {
878 self.fresh_expansion_with_transparency(expn_data, Transparency::Transparent, ctx)
881 pub fn fresh_expansion_with_transparency(
884 transparency: Transparency,
885 ctx: impl HashStableContext,
887 let expn_id = LocalExpnId::fresh(expn_data, ctx).to_expn_id();
888 HygieneData::with(|data| {
889 self.with_ctxt(data.apply_mark(SyntaxContext::root(), expn_id, transparency))
893 /// Reuses the span but adds information like the kind of the desugaring and features that are
894 /// allowed inside this span.
895 pub fn mark_with_reason(
897 allow_internal_unstable: Option<Lrc<[Symbol]>>,
898 reason: DesugaringKind,
900 ctx: impl HashStableContext,
902 let expn_data = ExpnData {
903 allow_internal_unstable,
904 ..ExpnData::default(ExpnKind::Desugaring(reason), self, edition, None, None)
906 self.fresh_expansion(expn_data, ctx)
910 /// A subset of properties from both macro definition and macro call available through global data.
911 /// Avoid using this if you have access to the original definition or call structures.
912 #[derive(Clone, Debug, Encodable, Decodable, HashStable_Generic)]
913 pub struct ExpnData {
914 // --- The part unique to each expansion.
915 /// The kind of this expansion - macro or compiler desugaring.
917 /// The expansion that produced this expansion.
919 /// The location of the actual macro invocation or syntax sugar , e.g.
920 /// `let x = foo!();` or `if let Some(y) = x {}`
922 /// This may recursively refer to other macro invocations, e.g., if
923 /// `foo!()` invoked `bar!()` internally, and there was an
924 /// expression inside `bar!`; the call_site of the expression in
925 /// the expansion would point to the `bar!` invocation; that
926 /// call_site span would have its own ExpnData, with the call_site
927 /// pointing to the `foo!` invocation.
929 /// Used to force two `ExpnData`s to have different `Fingerprint`s.
930 /// Due to macro expansion, it's possible to end up with two `ExpnId`s
931 /// that have identical `ExpnData`s. This violates the contract of `HashStable`
932 /// - the two `ExpnId`s are not equal, but their `Fingerprint`s are equal
933 /// (since the numerical `ExpnId` value is not considered by the `HashStable`
936 /// The `disambiguator` field is set by `update_disambiguator` when two distinct
937 /// `ExpnId`s would end up with the same `Fingerprint`. Since `ExpnData` includes
938 /// a `krate` field, this value only needs to be unique within a single crate.
941 // --- The part specific to the macro/desugaring definition.
942 // --- It may be reasonable to share this part between expansions with the same definition,
943 // --- but such sharing is known to bring some minor inconveniences without also bringing
944 // --- noticeable perf improvements (PR #62898).
945 /// The span of the macro definition (possibly dummy).
946 /// This span serves only informational purpose and is not used for resolution.
948 /// List of `#[unstable]`/feature-gated features that the macro is allowed to use
949 /// internally without forcing the whole crate to opt-in
951 pub allow_internal_unstable: Option<Lrc<[Symbol]>>,
952 /// Whether the macro is allowed to use `unsafe` internally
953 /// even if the user crate has `#![forbid(unsafe_code)]`.
954 pub allow_internal_unsafe: bool,
955 /// Enables the macro helper hack (`ident!(...)` -> `$crate::ident!(...)`)
956 /// for a given macro.
957 pub local_inner_macros: bool,
958 /// Edition of the crate in which the macro is defined.
959 pub edition: Edition,
960 /// The `DefId` of the macro being invoked,
961 /// if this `ExpnData` corresponds to a macro invocation
962 pub macro_def_id: Option<DefId>,
963 /// The normal module (`mod`) in which the expanded macro was defined.
964 pub parent_module: Option<DefId>,
967 impl !PartialEq for ExpnData {}
968 impl !Hash for ExpnData {}
976 allow_internal_unstable: Option<Lrc<[Symbol]>>,
977 allow_internal_unsafe: bool,
978 local_inner_macros: bool,
980 macro_def_id: Option<DefId>,
981 parent_module: Option<DefId>,
988 allow_internal_unstable,
989 allow_internal_unsafe,
998 /// Constructs expansion data with default properties.
1003 macro_def_id: Option<DefId>,
1004 parent_module: Option<DefId>,
1008 parent: ExpnId::root(),
1011 allow_internal_unstable: None,
1012 allow_internal_unsafe: false,
1013 local_inner_macros: false,
1021 pub fn allow_unstable(
1025 allow_internal_unstable: Lrc<[Symbol]>,
1026 macro_def_id: Option<DefId>,
1027 parent_module: Option<DefId>,
1030 allow_internal_unstable: Some(allow_internal_unstable),
1031 ..ExpnData::default(kind, call_site, edition, macro_def_id, parent_module)
1036 pub fn is_root(&self) -> bool {
1037 matches!(self.kind, ExpnKind::Root)
1041 fn hash_expn(&self, ctx: &mut impl HashStableContext) -> u64 {
1042 let mut hasher = StableHasher::new();
1043 self.hash_stable(ctx, &mut hasher);
1049 #[derive(Clone, Debug, PartialEq, Encodable, Decodable, HashStable_Generic)]
1051 /// No expansion, aka root expansion. Only `ExpnId::root()` has this kind.
1053 /// Expansion produced by a macro.
1054 Macro(MacroKind, Symbol),
1055 /// Transform done by the compiler on the AST.
1057 /// Desugaring done by the compiler during HIR lowering.
1058 Desugaring(DesugaringKind),
1064 pub fn descr(&self) -> String {
1066 ExpnKind::Root => kw::PathRoot.to_string(),
1067 ExpnKind::Macro(macro_kind, name) => match macro_kind {
1068 MacroKind::Bang => format!("{}!", name),
1069 MacroKind::Attr => format!("#[{}]", name),
1070 MacroKind::Derive => format!("#[derive({})]", name),
1072 ExpnKind::AstPass(kind) => kind.descr().to_string(),
1073 ExpnKind::Desugaring(kind) => format!("desugaring of {}", kind.descr()),
1074 ExpnKind::Inlined => "inlined source".to_string(),
1079 /// The kind of macro invocation or definition.
1080 #[derive(Clone, Copy, PartialEq, Eq, Encodable, Decodable, Hash, Debug)]
1081 #[derive(HashStable_Generic)]
1082 pub enum MacroKind {
1083 /// A bang macro `foo!()`.
1085 /// An attribute macro `#[foo]`.
1087 /// A derive macro `#[derive(Foo)]`
1092 pub fn descr(self) -> &'static str {
1094 MacroKind::Bang => "macro",
1095 MacroKind::Attr => "attribute macro",
1096 MacroKind::Derive => "derive macro",
1100 pub fn descr_expected(self) -> &'static str {
1102 MacroKind::Attr => "attribute",
1107 pub fn article(self) -> &'static str {
1109 MacroKind::Attr => "an",
1115 /// The kind of AST transform.
1116 #[derive(Clone, Copy, Debug, PartialEq, Encodable, Decodable, HashStable_Generic)]
1124 pub fn descr(self) -> &'static str {
1126 AstPass::StdImports => "standard library imports",
1127 AstPass::TestHarness => "test harness",
1128 AstPass::ProcMacroHarness => "proc macro harness",
1133 /// The kind of compiler desugaring.
1134 #[derive(Clone, Copy, PartialEq, Debug, Encodable, Decodable, HashStable_Generic)]
1135 pub enum DesugaringKind {
1136 /// We desugar `if c { i } else { e }` to `match $ExprKind::Use(c) { true => i, _ => e }`.
1137 /// However, we do not want to blame `c` for unreachability but rather say that `i`
1138 /// is unreachable. This desugaring kind allows us to avoid blaming `c`.
1139 /// This also applies to `while` loops.
1143 /// Desugaring of an `impl Trait` in return type position
1144 /// to an `type Foo = impl Trait;` and replacing the
1145 /// `impl Trait` with `Foo`.
1154 impl DesugaringKind {
1155 /// The description wording should combine well with "desugaring of {}".
1156 pub fn descr(self) -> &'static str {
1158 DesugaringKind::CondTemporary => "`if` or `while` condition",
1159 DesugaringKind::Async => "`async` block or function",
1160 DesugaringKind::Await => "`await` expression",
1161 DesugaringKind::QuestionMark => "operator `?`",
1162 DesugaringKind::TryBlock => "`try` block",
1163 DesugaringKind::OpaqueTy => "`impl Trait`",
1164 DesugaringKind::ForLoop => "`for` loop",
1165 DesugaringKind::LetElse => "`let...else`",
1166 DesugaringKind::WhileLoop => "`while` loop",
1172 pub struct HygieneEncodeContext {
1173 /// All `SyntaxContexts` for which we have written `SyntaxContextData` into crate metadata.
1174 /// This is `None` after we finish encoding `SyntaxContexts`, to ensure
1175 /// that we don't accidentally try to encode any more `SyntaxContexts`
1176 serialized_ctxts: Lock<FxHashSet<SyntaxContext>>,
1177 /// The `SyntaxContexts` that we have serialized (e.g. as a result of encoding `Spans`)
1178 /// in the most recent 'round' of serializnig. Serializing `SyntaxContextData`
1179 /// may cause us to serialize more `SyntaxContext`s, so serialize in a loop
1180 /// until we reach a fixed point.
1181 latest_ctxts: Lock<FxHashSet<SyntaxContext>>,
1183 serialized_expns: Lock<FxHashSet<ExpnId>>,
1185 latest_expns: Lock<FxHashSet<ExpnId>>,
1188 impl HygieneEncodeContext {
1189 /// Record the fact that we need to serialize the corresponding `ExpnData`.
1190 pub fn schedule_expn_data_for_encoding(&self, expn: ExpnId) {
1191 if !self.serialized_expns.lock().contains(&expn) {
1192 self.latest_expns.lock().insert(expn);
1196 pub fn encode<T, R>(
1199 mut encode_ctxt: impl FnMut(&mut T, u32, &SyntaxContextData) -> Result<(), R>,
1200 mut encode_expn: impl FnMut(&mut T, ExpnId, &ExpnData, ExpnHash) -> Result<(), R>,
1201 ) -> Result<(), R> {
1202 // When we serialize a `SyntaxContextData`, we may end up serializing
1203 // a `SyntaxContext` that we haven't seen before
1204 while !self.latest_ctxts.lock().is_empty() || !self.latest_expns.lock().is_empty() {
1206 "encode_hygiene: Serializing a round of {:?} SyntaxContextDatas: {:?}",
1207 self.latest_ctxts.lock().len(),
1211 // Consume the current round of SyntaxContexts.
1212 // Drop the lock() temporary early
1213 let latest_ctxts = { std::mem::take(&mut *self.latest_ctxts.lock()) };
1215 // It's fine to iterate over a HashMap, because the serialization
1216 // of the table that we insert data into doesn't depend on insertion
1218 for_all_ctxts_in(latest_ctxts.into_iter(), |index, ctxt, data| {
1219 if self.serialized_ctxts.lock().insert(ctxt) {
1220 encode_ctxt(encoder, index, data)?;
1225 let latest_expns = { std::mem::take(&mut *self.latest_expns.lock()) };
1227 for_all_expns_in(latest_expns.into_iter(), |expn, data, hash| {
1228 if self.serialized_expns.lock().insert(expn) {
1229 encode_expn(encoder, expn, data, hash)?;
1234 debug!("encode_hygiene: Done serializing SyntaxContextData");
1240 /// Additional information used to assist in decoding hygiene data
1241 pub struct HygieneDecodeContext {
1242 // Maps serialized `SyntaxContext` ids to a `SyntaxContext` in the current
1243 // global `HygieneData`. When we deserialize a `SyntaxContext`, we need to create
1244 // a new id in the global `HygieneData`. This map tracks the ID we end up picking,
1245 // so that multiple occurrences of the same serialized id are decoded to the same
1247 remapped_ctxts: Lock<Vec<Option<SyntaxContext>>>,
1250 /// Register an expansion which has been decoded from the on-disk-cache for the local crate.
1251 pub fn register_local_expn_id(data: ExpnData, hash: ExpnHash) -> ExpnId {
1252 HygieneData::with(|hygiene_data| {
1253 let expn_id = hygiene_data.local_expn_data.next_index();
1254 hygiene_data.local_expn_data.push(Some(data));
1255 let _eid = hygiene_data.local_expn_hashes.push(hash);
1256 debug_assert_eq!(expn_id, _eid);
1258 let expn_id = expn_id.to_expn_id();
1260 let _old_id = hygiene_data.expn_hash_to_expn_id.insert(hash, expn_id);
1261 debug_assert!(_old_id.is_none());
1266 /// Register an expansion which has been decoded from the metadata of a foreign crate.
1267 pub fn register_expn_id(
1269 local_id: ExpnIndex,
1273 debug_assert!(data.parent == ExpnId::root() || krate == data.parent.krate);
1274 let expn_id = ExpnId { krate, local_id };
1275 HygieneData::with(|hygiene_data| {
1276 let _old_data = hygiene_data.foreign_expn_data.insert(expn_id, data);
1277 debug_assert!(_old_data.is_none());
1278 let _old_hash = hygiene_data.foreign_expn_hashes.insert(expn_id, hash);
1279 debug_assert!(_old_hash.is_none());
1280 let _old_id = hygiene_data.expn_hash_to_expn_id.insert(hash, expn_id);
1281 debug_assert!(_old_id.is_none());
1286 /// Decode an expansion from the metadata of a foreign crate.
1287 pub fn decode_expn_id(
1290 decode_data: impl FnOnce(ExpnId) -> (ExpnData, ExpnHash),
1293 debug!("decode_expn_id: deserialized root");
1294 return ExpnId::root();
1297 let index = ExpnIndex::from_u32(index);
1299 // This function is used to decode metadata, so it cannot decode information about LOCAL_CRATE.
1300 debug_assert_ne!(krate, LOCAL_CRATE);
1301 let expn_id = ExpnId { krate, local_id: index };
1303 // Fast path if the expansion has already been decoded.
1304 if HygieneData::with(|hygiene_data| hygiene_data.foreign_expn_data.contains_key(&expn_id)) {
1308 // Don't decode the data inside `HygieneData::with`, since we need to recursively decode
1310 let (expn_data, hash) = decode_data(expn_id);
1312 register_expn_id(krate, index, expn_data, hash)
1315 // Decodes `SyntaxContext`, using the provided `HygieneDecodeContext`
1316 // to track which `SyntaxContext`s we have already decoded.
1317 // The provided closure will be invoked to deserialize a `SyntaxContextData`
1318 // if we haven't already seen the id of the `SyntaxContext` we are deserializing.
1319 pub fn decode_syntax_context<D: Decoder, F: FnOnce(&mut D, u32) -> SyntaxContextData>(
1321 context: &HygieneDecodeContext,
1323 ) -> SyntaxContext {
1324 let raw_id: u32 = Decodable::decode(d);
1326 debug!("decode_syntax_context: deserialized root");
1327 // The root is special
1328 return SyntaxContext::root();
1331 let outer_ctxts = &context.remapped_ctxts;
1333 // Ensure that the lock() temporary is dropped early
1335 if let Some(ctxt) = outer_ctxts.lock().get(raw_id as usize).copied().flatten() {
1340 // Allocate and store SyntaxContext id *before* calling the decoder function,
1341 // as the SyntaxContextData may reference itself.
1342 let new_ctxt = HygieneData::with(|hygiene_data| {
1343 let new_ctxt = SyntaxContext(hygiene_data.syntax_context_data.len() as u32);
1344 // Push a dummy SyntaxContextData to ensure that nobody else can get the
1345 // same ID as us. This will be overwritten after call `decode_Data`
1346 hygiene_data.syntax_context_data.push(SyntaxContextData {
1347 outer_expn: ExpnId::root(),
1348 outer_transparency: Transparency::Transparent,
1349 parent: SyntaxContext::root(),
1350 opaque: SyntaxContext::root(),
1351 opaque_and_semitransparent: SyntaxContext::root(),
1352 dollar_crate_name: kw::Empty,
1354 let mut ctxts = outer_ctxts.lock();
1355 let new_len = raw_id as usize + 1;
1356 if ctxts.len() < new_len {
1357 ctxts.resize(new_len, None);
1359 ctxts[raw_id as usize] = Some(new_ctxt);
1364 // Don't try to decode data while holding the lock, since we need to
1365 // be able to recursively decode a SyntaxContext
1366 let mut ctxt_data = decode_data(d, raw_id);
1367 // Reset `dollar_crate_name` so that it will be updated by `update_dollar_crate_names`
1368 // We don't care what the encoding crate set this to - we want to resolve it
1369 // from the perspective of the current compilation session
1370 ctxt_data.dollar_crate_name = kw::DollarCrate;
1372 // Overwrite the dummy data with our decoded SyntaxContextData
1373 HygieneData::with(|hygiene_data| {
1374 let dummy = std::mem::replace(
1375 &mut hygiene_data.syntax_context_data[new_ctxt.as_u32() as usize],
1378 // Make sure nothing weird happening while `decode_data` was running
1379 assert_eq!(dummy.dollar_crate_name, kw::Empty);
1385 fn for_all_ctxts_in<E, F: FnMut(u32, SyntaxContext, &SyntaxContextData) -> Result<(), E>>(
1386 ctxts: impl Iterator<Item = SyntaxContext>,
1388 ) -> Result<(), E> {
1389 let all_data: Vec<_> = HygieneData::with(|data| {
1390 ctxts.map(|ctxt| (ctxt, data.syntax_context_data[ctxt.0 as usize].clone())).collect()
1392 for (ctxt, data) in all_data.into_iter() {
1393 f(ctxt.0, ctxt, &data)?;
1398 fn for_all_expns_in<E>(
1399 expns: impl Iterator<Item = ExpnId>,
1400 mut f: impl FnMut(ExpnId, &ExpnData, ExpnHash) -> Result<(), E>,
1401 ) -> Result<(), E> {
1402 let all_data: Vec<_> = HygieneData::with(|data| {
1403 expns.map(|expn| (expn, data.expn_data(expn).clone(), data.expn_hash(expn))).collect()
1405 for (expn, data, hash) in all_data.into_iter() {
1406 f(expn, &data, hash)?;
1411 impl<E: Encoder> Encodable<E> for LocalExpnId {
1412 fn encode(&self, e: &mut E) -> Result<(), E::Error> {
1413 self.to_expn_id().encode(e)
1417 impl<E: Encoder> Encodable<E> for ExpnId {
1418 default fn encode(&self, _: &mut E) -> Result<(), E::Error> {
1419 panic!("cannot encode `ExpnId` with `{}`", std::any::type_name::<E>());
1423 impl<D: Decoder> Decodable<D> for LocalExpnId {
1424 fn decode(d: &mut D) -> Self {
1425 ExpnId::expect_local(ExpnId::decode(d))
1429 impl<D: Decoder> Decodable<D> for ExpnId {
1430 default fn decode(_: &mut D) -> Self {
1431 panic!("cannot decode `ExpnId` with `{}`", std::any::type_name::<D>());
1435 pub fn raw_encode_syntax_context<E: Encoder>(
1436 ctxt: SyntaxContext,
1437 context: &HygieneEncodeContext,
1439 ) -> Result<(), E::Error> {
1440 if !context.serialized_ctxts.lock().contains(&ctxt) {
1441 context.latest_ctxts.lock().insert(ctxt);
1446 impl<E: Encoder> Encodable<E> for SyntaxContext {
1447 default fn encode(&self, _: &mut E) -> Result<(), E::Error> {
1448 panic!("cannot encode `SyntaxContext` with `{}`", std::any::type_name::<E>());
1452 impl<D: Decoder> Decodable<D> for SyntaxContext {
1453 default fn decode(_: &mut D) -> Self {
1454 panic!("cannot decode `SyntaxContext` with `{}`", std::any::type_name::<D>());
1458 /// Updates the `disambiguator` field of the corresponding `ExpnData`
1459 /// such that the `Fingerprint` of the `ExpnData` does not collide with
1460 /// any other `ExpnIds`.
1462 /// This method is called only when an `ExpnData` is first associated
1463 /// with an `ExpnId` (when the `ExpnId` is initially constructed, or via
1464 /// `set_expn_data`). It is *not* called for foreign `ExpnId`s deserialized
1465 /// from another crate's metadata - since `ExpnHash` includes the stable crate id,
1466 /// collisions are only possible between `ExpnId`s within the same crate.
1467 fn update_disambiguator(expn_data: &mut ExpnData, mut ctx: impl HashStableContext) -> ExpnHash {
1468 // This disambiguator should not have been set yet.
1470 expn_data.disambiguator, 0,
1471 "Already set disambiguator for ExpnData: {:?}",
1474 assert_default_hashing_controls(&ctx, "ExpnData (disambiguator)");
1475 let mut expn_hash = expn_data.hash_expn(&mut ctx);
1477 let disambiguator = HygieneData::with(|data| {
1478 // If this is the first ExpnData with a given hash, then keep our
1479 // disambiguator at 0 (the default u32 value)
1480 let disambig = data.expn_data_disambiguators.entry(expn_hash).or_default();
1481 let disambiguator = *disambig;
1486 if disambiguator != 0 {
1487 debug!("Set disambiguator for expn_data={:?} expn_hash={:?}", expn_data, expn_hash);
1489 expn_data.disambiguator = disambiguator;
1490 expn_hash = expn_data.hash_expn(&mut ctx);
1492 // Verify that the new disambiguator makes the hash unique
1493 #[cfg(debug_assertions)]
1494 HygieneData::with(|data| {
1496 data.expn_data_disambiguators.get(&expn_hash),
1498 "Hash collision after disambiguator update!",
1503 ExpnHash::new(ctx.def_path_hash(LOCAL_CRATE.as_def_id()).stable_crate_id(), expn_hash)
1506 impl<CTX: HashStableContext> HashStable<CTX> for SyntaxContext {
1507 fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
1508 const TAG_EXPANSION: u8 = 0;
1509 const TAG_NO_EXPANSION: u8 = 1;
1511 if *self == SyntaxContext::root() {
1512 TAG_NO_EXPANSION.hash_stable(ctx, hasher);
1514 TAG_EXPANSION.hash_stable(ctx, hasher);
1515 let (expn_id, transparency) = self.outer_mark();
1516 expn_id.hash_stable(ctx, hasher);
1517 transparency.hash_stable(ctx, hasher);
1522 impl<CTX: HashStableContext> HashStable<CTX> for ExpnId {
1523 fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
1524 assert_default_hashing_controls(ctx, "ExpnId");
1525 let hash = if *self == ExpnId::root() {
1526 // Avoid fetching TLS storage for a trivial often-used value.
1532 hash.hash_stable(ctx, hasher);