1 use crate::mir::interpret::{AllocRange, GlobalAlloc, Pointer, Provenance, Scalar};
3 self, ConstInt, DefIdTree, ParamConst, ScalarInt, Term, TermKind, Ty, TyCtxt, TypeFoldable,
4 TypeSuperFoldable, TypeSuperVisitable, TypeVisitable,
6 use crate::ty::{GenericArg, GenericArgKind};
7 use rustc_apfloat::ieee::{Double, Single};
8 use rustc_data_structures::fx::{FxHashMap, FxIndexMap};
9 use rustc_data_structures::sso::SsoHashSet;
11 use rustc_hir::def::{self, CtorKind, DefKind, Namespace};
12 use rustc_hir::def_id::{DefId, DefIdSet, CRATE_DEF_ID, LOCAL_CRATE};
13 use rustc_hir::definitions::{DefKey, DefPathData, DefPathDataName, DisambiguatedDefPathData};
14 use rustc_hir::LangItem;
15 use rustc_session::config::TrimmedDefPaths;
16 use rustc_session::cstore::{ExternCrate, ExternCrateSource};
17 use rustc_session::Limit;
18 use rustc_span::symbol::{kw, Ident, Symbol};
19 use rustc_span::FileNameDisplayPreference;
20 use rustc_target::abi::Size;
21 use rustc_target::spec::abi::Abi;
22 use smallvec::SmallVec;
26 use std::collections::BTreeMap;
27 use std::fmt::{self, Write as _};
29 use std::ops::{ControlFlow, Deref, DerefMut};
31 // `pretty` is a separate module only for organization.
36 write!(scoped_cx!(), $lit)?
38 (@write($($data:expr),+)) => {
39 write!(scoped_cx!(), $($data),+)?
41 (@print($x:expr)) => {
42 scoped_cx!() = $x.print(scoped_cx!())?
44 (@$method:ident($($arg:expr),*)) => {
45 scoped_cx!() = scoped_cx!().$method($($arg),*)?
47 ($($elem:tt $(($($args:tt)*))?),+) => {{
48 $(p!(@ $elem $(($($args)*))?);)+
51 macro_rules! define_scoped_cx {
53 #[allow(unused_macros)]
54 macro_rules! scoped_cx {
63 static FORCE_IMPL_FILENAME_LINE: Cell<bool> = const { Cell::new(false) };
64 static SHOULD_PREFIX_WITH_CRATE: Cell<bool> = const { Cell::new(false) };
65 static NO_TRIMMED_PATH: Cell<bool> = const { Cell::new(false) };
66 static FORCE_TRIMMED_PATH: Cell<bool> = const { Cell::new(false) };
67 static NO_QUERIES: Cell<bool> = const { Cell::new(false) };
68 static NO_VISIBLE_PATH: Cell<bool> = const { Cell::new(false) };
71 macro_rules! define_helper {
72 ($($(#[$a:meta])* fn $name:ident($helper:ident, $tl:ident);)+) => {
75 pub struct $helper(bool);
78 pub fn new() -> $helper {
79 $helper($tl.with(|c| c.replace(true)))
84 pub macro $name($e:expr) {
86 let _guard = $helper::new();
91 impl Drop for $helper {
93 $tl.with(|c| c.set(self.0))
101 /// Avoids running any queries during any prints that occur
102 /// during the closure. This may alter the appearance of some
103 /// types (e.g. forcing verbose printing for opaque types).
104 /// This method is used during some queries (e.g. `explicit_item_bounds`
105 /// for opaque types), to ensure that any debug printing that
106 /// occurs during the query computation does not end up recursively
107 /// calling the same query.
108 fn with_no_queries(NoQueriesGuard, NO_QUERIES);
109 /// Force us to name impls with just the filename/line number. We
110 /// normally try to use types. But at some points, notably while printing
111 /// cycle errors, this can result in extra or suboptimal error output,
112 /// so this variable disables that check.
113 fn with_forced_impl_filename_line(ForcedImplGuard, FORCE_IMPL_FILENAME_LINE);
114 /// Adds the `crate::` prefix to paths where appropriate.
115 fn with_crate_prefix(CratePrefixGuard, SHOULD_PREFIX_WITH_CRATE);
116 /// Prevent path trimming if it is turned on. Path trimming affects `Display` impl
117 /// of various rustc types, for example `std::vec::Vec` would be trimmed to `Vec`,
118 /// if no other `Vec` is found.
119 fn with_no_trimmed_paths(NoTrimmedGuard, NO_TRIMMED_PATH);
120 fn with_forced_trimmed_paths(ForceTrimmedGuard, FORCE_TRIMMED_PATH);
121 /// Prevent selection of visible paths. `Display` impl of DefId will prefer
122 /// visible (public) reexports of types as paths.
123 fn with_no_visible_paths(NoVisibleGuard, NO_VISIBLE_PATH);
126 /// The "region highlights" are used to control region printing during
127 /// specific error messages. When a "region highlight" is enabled, it
128 /// gives an alternate way to print specific regions. For now, we
129 /// always print those regions using a number, so something like "`'0`".
131 /// Regions not selected by the region highlight mode are presently
133 #[derive(Copy, Clone)]
134 pub struct RegionHighlightMode<'tcx> {
137 /// If enabled, when we see the selected region, use "`'N`"
138 /// instead of the ordinary behavior.
139 highlight_regions: [Option<(ty::Region<'tcx>, usize)>; 3],
141 /// If enabled, when printing a "free region" that originated from
142 /// the given `ty::BoundRegionKind`, print it as "`'1`". Free regions that would ordinarily
143 /// have names print as normal.
145 /// This is used when you have a signature like `fn foo(x: &u32,
146 /// y: &'a u32)` and we want to give a name to the region of the
148 highlight_bound_region: Option<(ty::BoundRegionKind, usize)>,
151 impl<'tcx> RegionHighlightMode<'tcx> {
152 pub fn new(tcx: TyCtxt<'tcx>) -> Self {
155 highlight_regions: Default::default(),
156 highlight_bound_region: Default::default(),
160 /// If `region` and `number` are both `Some`, invokes
161 /// `highlighting_region`.
162 pub fn maybe_highlighting_region(
164 region: Option<ty::Region<'tcx>>,
165 number: Option<usize>,
167 if let Some(k) = region {
168 if let Some(n) = number {
169 self.highlighting_region(k, n);
174 /// Highlights the region inference variable `vid` as `'N`.
175 pub fn highlighting_region(&mut self, region: ty::Region<'tcx>, number: usize) {
176 let num_slots = self.highlight_regions.len();
177 let first_avail_slot =
178 self.highlight_regions.iter_mut().find(|s| s.is_none()).unwrap_or_else(|| {
179 bug!("can only highlight {} placeholders at a time", num_slots,)
181 *first_avail_slot = Some((region, number));
184 /// Convenience wrapper for `highlighting_region`.
185 pub fn highlighting_region_vid(&mut self, vid: ty::RegionVid, number: usize) {
186 self.highlighting_region(self.tcx.mk_region(ty::ReVar(vid)), number)
189 /// Returns `Some(n)` with the number to use for the given region, if any.
190 fn region_highlighted(&self, region: ty::Region<'tcx>) -> Option<usize> {
191 self.highlight_regions.iter().find_map(|h| match h {
192 Some((r, n)) if *r == region => Some(*n),
197 /// Highlight the given bound region.
198 /// We can only highlight one bound region at a time. See
199 /// the field `highlight_bound_region` for more detailed notes.
200 pub fn highlighting_bound_region(&mut self, br: ty::BoundRegionKind, number: usize) {
201 assert!(self.highlight_bound_region.is_none());
202 self.highlight_bound_region = Some((br, number));
206 /// Trait for printers that pretty-print using `fmt::Write` to the printer.
207 pub trait PrettyPrinter<'tcx>:
214 DynExistential = Self,
218 /// Like `print_def_path` but for value paths.
222 substs: &'tcx [GenericArg<'tcx>],
223 ) -> Result<Self::Path, Self::Error> {
224 self.print_def_path(def_id, substs)
227 fn in_binder<T>(self, value: &ty::Binder<'tcx, T>) -> Result<Self, Self::Error>
229 T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
231 value.as_ref().skip_binder().print(self)
234 fn wrap_binder<T, F: FnOnce(&T, Self) -> Result<Self, fmt::Error>>(
236 value: &ty::Binder<'tcx, T>,
238 ) -> Result<Self, Self::Error>
240 T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
242 f(value.as_ref().skip_binder(), self)
245 /// Prints comma-separated elements.
246 fn comma_sep<T>(mut self, mut elems: impl Iterator<Item = T>) -> Result<Self, Self::Error>
248 T: Print<'tcx, Self, Output = Self, Error = Self::Error>,
250 if let Some(first) = elems.next() {
251 self = first.print(self)?;
253 self.write_str(", ")?;
254 self = elem.print(self)?;
260 /// Prints `{f: t}` or `{f as t}` depending on the `cast` argument
263 f: impl FnOnce(Self) -> Result<Self, Self::Error>,
264 t: impl FnOnce(Self) -> Result<Self, Self::Error>,
266 ) -> Result<Self::Const, Self::Error> {
267 self.write_str("{")?;
269 self.write_str(conversion)?;
271 self.write_str("}")?;
275 /// Prints `<...>` around what `f` prints.
276 fn generic_delimiters(
278 f: impl FnOnce(Self) -> Result<Self, Self::Error>,
279 ) -> Result<Self, Self::Error>;
281 /// Returns `true` if the region should be printed in
282 /// optional positions, e.g., `&'a T` or `dyn Tr + 'b`.
283 /// This is typically the case for all non-`'_` regions.
284 fn should_print_region(&self, region: ty::Region<'tcx>) -> bool;
286 fn reset_type_limit(&mut self) {}
288 // Defaults (should not be overridden):
290 /// If possible, this returns a global path resolving to `def_id` that is visible
291 /// from at least one local module, and returns `true`. If the crate defining `def_id` is
292 /// declared with an `extern crate`, the path is guaranteed to use the `extern crate`.
293 fn try_print_visible_def_path(self, def_id: DefId) -> Result<(Self, bool), Self::Error> {
294 if NO_VISIBLE_PATH.with(|flag| flag.get()) {
295 return Ok((self, false));
298 let mut callers = Vec::new();
299 self.try_print_visible_def_path_recur(def_id, &mut callers)
302 // Given a `DefId`, produce a short name. For types and traits, it prints *only* its name,
303 // For associated items on traits it prints out the trait's name and the associated item's name.
304 // For enum variants, if they have an unique name, then we only print the name, otherwise we
305 // print the enum name and the variant name. Otherwise, we do not print anything and let the
306 // caller use the `print_def_path` fallback.
307 fn force_print_trimmed_def_path(
310 ) -> Result<(Self::Path, bool), Self::Error> {
311 let key = self.tcx().def_key(def_id);
312 let visible_parent_map = self.tcx().visible_parent_map(());
313 let kind = self.tcx().def_kind(def_id);
315 let get_local_name = |this: &Self, name, def_id, key: DefKey| {
316 if let Some(visible_parent) = visible_parent_map.get(&def_id)
317 && let actual_parent = this.tcx().opt_parent(def_id)
318 && let DefPathData::TypeNs(_) = key.disambiguated_data.data
319 && Some(*visible_parent) != actual_parent
323 .module_children(visible_parent)
325 .filter(|child| child.res.opt_def_id() == Some(def_id))
326 .find(|child| child.vis.is_public() && child.ident.name != kw::Underscore)
327 .map(|child| child.ident.name)
333 if let DefKind::Variant = kind
334 && let Some(symbol) = self.tcx().trimmed_def_paths(()).get(&def_id)
336 // If `Assoc` is unique, we don't want to talk about `Trait::Assoc`.
337 self.write_str(get_local_name(&self, *symbol, def_id, key).as_str())?;
338 return Ok((self, true));
340 if let Some(symbol) = key.get_opt_name() {
341 if let DefKind::AssocConst | DefKind::AssocFn | DefKind::AssocTy = kind
342 && let Some(parent) = self.tcx().opt_parent(def_id)
343 && let parent_key = self.tcx().def_key(parent)
344 && let Some(symbol) = parent_key.get_opt_name()
347 self.write_str(get_local_name(&self, symbol, parent, parent_key).as_str())?;
348 self.write_str("::")?;
349 } else if let DefKind::Variant = kind
350 && let Some(parent) = self.tcx().opt_parent(def_id)
351 && let parent_key = self.tcx().def_key(parent)
352 && let Some(symbol) = parent_key.get_opt_name()
356 // For associated items and variants, we want the "full" path, namely, include
357 // the parent type in the path. For example, `Iterator::Item`.
358 self.write_str(get_local_name(&self, symbol, parent, parent_key).as_str())?;
359 self.write_str("::")?;
360 } else if let DefKind::Struct | DefKind::Union | DefKind::Enum | DefKind::Trait
361 | DefKind::TyAlias | DefKind::Fn | DefKind::Const | DefKind::Static(_) = kind
364 // If not covered above, like for example items out of `impl` blocks, fallback.
365 return Ok((self, false));
367 self.write_str(get_local_name(&self, symbol, def_id, key).as_str())?;
368 return Ok((self, true));
373 /// Try to see if this path can be trimmed to a unique symbol name.
374 fn try_print_trimmed_def_path(
377 ) -> Result<(Self::Path, bool), Self::Error> {
378 if FORCE_TRIMMED_PATH.with(|flag| flag.get()) {
379 let (s, trimmed) = self.force_print_trimmed_def_path(def_id)?;
381 return Ok((s, true));
385 if !self.tcx().sess.opts.unstable_opts.trim_diagnostic_paths
386 || matches!(self.tcx().sess.opts.trimmed_def_paths, TrimmedDefPaths::Never)
387 || NO_TRIMMED_PATH.with(|flag| flag.get())
388 || SHOULD_PREFIX_WITH_CRATE.with(|flag| flag.get())
390 return Ok((self, false));
393 match self.tcx().trimmed_def_paths(()).get(&def_id) {
394 None => Ok((self, false)),
396 write!(self, "{}", Ident::with_dummy_span(*symbol))?;
402 /// Does the work of `try_print_visible_def_path`, building the
403 /// full definition path recursively before attempting to
404 /// post-process it into the valid and visible version that
405 /// accounts for re-exports.
407 /// This method should only be called by itself or
408 /// `try_print_visible_def_path`.
410 /// `callers` is a chain of visible_parent's leading to `def_id`,
411 /// to support cycle detection during recursion.
413 /// This method returns false if we can't print the visible path, so
414 /// `print_def_path` can fall back on the item's real definition path.
415 fn try_print_visible_def_path_recur(
418 callers: &mut Vec<DefId>,
419 ) -> Result<(Self, bool), Self::Error> {
420 define_scoped_cx!(self);
422 debug!("try_print_visible_def_path: def_id={:?}", def_id);
424 // If `def_id` is a direct or injected extern crate, return the
425 // path to the crate followed by the path to the item within the crate.
426 if let Some(cnum) = def_id.as_crate_root() {
427 if cnum == LOCAL_CRATE {
428 return Ok((self.path_crate(cnum)?, true));
431 // In local mode, when we encounter a crate other than
432 // LOCAL_CRATE, execution proceeds in one of two ways:
434 // 1. For a direct dependency, where user added an
435 // `extern crate` manually, we put the `extern
436 // crate` as the parent. So you wind up with
437 // something relative to the current crate.
438 // 2. For an extern inferred from a path or an indirect crate,
439 // where there is no explicit `extern crate`, we just prepend
441 match self.tcx().extern_crate(def_id) {
442 Some(&ExternCrate { src, dependency_of, span, .. }) => match (src, dependency_of) {
443 (ExternCrateSource::Extern(def_id), LOCAL_CRATE) => {
444 // NOTE(eddyb) the only reason `span` might be dummy,
445 // that we're aware of, is that it's the `std`/`core`
446 // `extern crate` injected by default.
447 // FIXME(eddyb) find something better to key this on,
448 // or avoid ending up with `ExternCrateSource::Extern`,
449 // for the injected `std`/`core`.
451 return Ok((self.path_crate(cnum)?, true));
454 // Disable `try_print_trimmed_def_path` behavior within
455 // the `print_def_path` call, to avoid infinite recursion
456 // in cases where the `extern crate foo` has non-trivial
457 // parents, e.g. it's nested in `impl foo::Trait for Bar`
458 // (see also issues #55779 and #87932).
459 self = with_no_visible_paths!(self.print_def_path(def_id, &[])?);
461 return Ok((self, true));
463 (ExternCrateSource::Path, LOCAL_CRATE) => {
464 return Ok((self.path_crate(cnum)?, true));
469 return Ok((self.path_crate(cnum)?, true));
474 if def_id.is_local() {
475 return Ok((self, false));
478 let visible_parent_map = self.tcx().visible_parent_map(());
480 let mut cur_def_key = self.tcx().def_key(def_id);
481 debug!("try_print_visible_def_path: cur_def_key={:?}", cur_def_key);
483 // For a constructor, we want the name of its parent rather than <unnamed>.
484 if let DefPathData::Ctor = cur_def_key.disambiguated_data.data {
489 .expect("`DefPathData::Ctor` / `VariantData` missing a parent"),
492 cur_def_key = self.tcx().def_key(parent);
495 let Some(visible_parent) = visible_parent_map.get(&def_id).cloned() else {
496 return Ok((self, false));
499 let actual_parent = self.tcx().opt_parent(def_id);
501 "try_print_visible_def_path: visible_parent={:?} actual_parent={:?}",
502 visible_parent, actual_parent,
505 let mut data = cur_def_key.disambiguated_data.data;
507 "try_print_visible_def_path: data={:?} visible_parent={:?} actual_parent={:?}",
508 data, visible_parent, actual_parent,
512 // In order to output a path that could actually be imported (valid and visible),
513 // we need to handle re-exports correctly.
515 // For example, take `std::os::unix::process::CommandExt`, this trait is actually
516 // defined at `std::sys::unix::ext::process::CommandExt` (at time of writing).
518 // `std::os::unix` reexports the contents of `std::sys::unix::ext`. `std::sys` is
519 // private so the "true" path to `CommandExt` isn't accessible.
521 // In this case, the `visible_parent_map` will look something like this:
523 // (child) -> (parent)
524 // `std::sys::unix::ext::process::CommandExt` -> `std::sys::unix::ext::process`
525 // `std::sys::unix::ext::process` -> `std::sys::unix::ext`
526 // `std::sys::unix::ext` -> `std::os`
528 // This is correct, as the visible parent of `std::sys::unix::ext` is in fact
531 // When printing the path to `CommandExt` and looking at the `cur_def_key` that
532 // corresponds to `std::sys::unix::ext`, we would normally print `ext` and then go
533 // to the parent - resulting in a mangled path like
534 // `std::os::ext::process::CommandExt`.
536 // Instead, we must detect that there was a re-export and instead print `unix`
537 // (which is the name `std::sys::unix::ext` was re-exported as in `std::os`). To
538 // do this, we compare the parent of `std::sys::unix::ext` (`std::sys::unix`) with
539 // the visible parent (`std::os`). If these do not match, then we iterate over
540 // the children of the visible parent (as was done when computing
541 // `visible_parent_map`), looking for the specific child we currently have and then
542 // have access to the re-exported name.
543 DefPathData::TypeNs(ref mut name) if Some(visible_parent) != actual_parent => {
544 // Item might be re-exported several times, but filter for the one
545 // that's public and whose identifier isn't `_`.
548 .module_children(visible_parent)
550 .filter(|child| child.res.opt_def_id() == Some(def_id))
551 .find(|child| child.vis.is_public() && child.ident.name != kw::Underscore)
552 .map(|child| child.ident.name);
554 if let Some(new_name) = reexport {
557 // There is no name that is public and isn't `_`, so bail.
558 return Ok((self, false));
561 // Re-exported `extern crate` (#43189).
562 DefPathData::CrateRoot => {
563 data = DefPathData::TypeNs(self.tcx().crate_name(def_id.krate));
567 debug!("try_print_visible_def_path: data={:?}", data);
569 if callers.contains(&visible_parent) {
570 return Ok((self, false));
572 callers.push(visible_parent);
573 // HACK(eddyb) this bypasses `path_append`'s prefix printing to avoid
574 // knowing ahead of time whether the entire path will succeed or not.
575 // To support printers that do not implement `PrettyPrinter`, a `Vec` or
576 // linked list on the stack would need to be built, before any printing.
577 match self.try_print_visible_def_path_recur(visible_parent, callers)? {
578 (cx, false) => return Ok((cx, false)),
579 (cx, true) => self = cx,
583 Ok((self.path_append(Ok, &DisambiguatedDefPathData { data, disambiguator: 0 })?, true))
586 fn pretty_path_qualified(
589 trait_ref: Option<ty::TraitRef<'tcx>>,
590 ) -> Result<Self::Path, Self::Error> {
591 if trait_ref.is_none() {
592 // Inherent impls. Try to print `Foo::bar` for an inherent
593 // impl on `Foo`, but fallback to `<Foo>::bar` if self-type is
594 // anything other than a simple path.
595 match self_ty.kind() {
604 return self_ty.print(self);
611 self.generic_delimiters(|mut cx| {
612 define_scoped_cx!(cx);
615 if let Some(trait_ref) = trait_ref {
616 p!(" as ", print(trait_ref.print_only_trait_path()));
622 fn pretty_path_append_impl(
624 print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
626 trait_ref: Option<ty::TraitRef<'tcx>>,
627 ) -> Result<Self::Path, Self::Error> {
628 self = print_prefix(self)?;
630 self.generic_delimiters(|mut cx| {
631 define_scoped_cx!(cx);
634 if let Some(trait_ref) = trait_ref {
635 p!(print(trait_ref.print_only_trait_path()), " for ");
643 fn pretty_print_type(mut self, ty: Ty<'tcx>) -> Result<Self::Type, Self::Error> {
644 define_scoped_cx!(self);
647 ty::Bool => p!("bool"),
648 ty::Char => p!("char"),
649 ty::Int(t) => p!(write("{}", t.name_str())),
650 ty::Uint(t) => p!(write("{}", t.name_str())),
651 ty::Float(t) => p!(write("{}", t.name_str())),
652 ty::RawPtr(ref tm) => {
656 hir::Mutability::Mut => "mut",
657 hir::Mutability::Not => "const",
662 ty::Ref(r, ty, mutbl) => {
664 if self.should_print_region(r) {
667 p!(print(ty::TypeAndMut { ty, mutbl }))
669 ty::Never => p!("!"),
670 ty::Tuple(ref tys) => {
671 p!("(", comma_sep(tys.iter()));
677 ty::FnDef(def_id, substs) => {
678 let sig = self.tcx().bound_fn_sig(def_id).subst(self.tcx(), substs);
679 p!(print(sig), " {{", print_value_path(def_id, substs), "}}");
681 ty::FnPtr(ref bare_fn) => p!(print(bare_fn)),
682 ty::Infer(infer_ty) => {
683 let verbose = self.should_print_verbose();
684 if let ty::TyVar(ty_vid) = infer_ty {
685 if let Some(name) = self.ty_infer_name(ty_vid) {
686 p!(write("{}", name))
689 p!(write("{:?}", infer_ty))
691 p!(write("{}", infer_ty))
695 if verbose { p!(write("{:?}", infer_ty)) } else { p!(write("{}", infer_ty)) }
698 ty::Error(_) => p!("[type error]"),
699 ty::Param(ref param_ty) => p!(print(param_ty)),
700 ty::Bound(debruijn, bound_ty) => match bound_ty.kind {
701 ty::BoundTyKind::Anon => self.pretty_print_bound_var(debruijn, bound_ty.var)?,
702 ty::BoundTyKind::Param(p) => p!(write("{}", p)),
704 ty::Adt(def, substs) => {
705 p!(print_def_path(def.did(), substs));
707 ty::Dynamic(data, r, repr) => {
708 let print_r = self.should_print_region(r);
713 ty::Dyn => p!("dyn "),
714 ty::DynStar => p!("dyn* "),
718 p!(" + ", print(r), ")");
721 ty::Foreign(def_id) => {
722 p!(print_def_path(def_id, &[]));
724 ty::Alias(ty::Projection, ref data) => {
725 if !(self.should_print_verbose() || NO_QUERIES.with(|q| q.get()))
726 && self.tcx().def_kind(data.def_id) == DefKind::ImplTraitPlaceholder
728 return self.pretty_print_opaque_impl_type(data.def_id, data.substs);
733 ty::Placeholder(placeholder) => p!(write("Placeholder({:?})", placeholder)),
734 ty::Alias(ty::Opaque, ty::AliasTy { def_id, substs, .. }) => {
735 // FIXME(eddyb) print this with `print_def_path`.
736 // We use verbose printing in 'NO_QUERIES' mode, to
737 // avoid needing to call `predicates_of`. This should
738 // only affect certain debug messages (e.g. messages printed
739 // from `rustc_middle::ty` during the computation of `tcx.predicates_of`),
740 // and should have no effect on any compiler output.
741 if self.should_print_verbose() || NO_QUERIES.with(|q| q.get()) {
742 p!(write("Opaque({:?}, {:?})", def_id, substs));
746 let parent = self.tcx().parent(def_id);
747 match self.tcx().def_kind(parent) {
748 DefKind::TyAlias | DefKind::AssocTy => {
749 if let ty::Alias(ty::Opaque, ty::AliasTy { def_id: d, .. }) =
750 *self.tcx().type_of(parent).kind()
753 // If the type alias directly starts with the `impl` of the
754 // opaque type we're printing, then skip the `::{opaque#1}`.
755 p!(print_def_path(parent, substs));
759 // Complex opaque type, e.g. `type Foo = (i32, impl Debug);`
760 p!(print_def_path(def_id, substs));
763 _ => return self.pretty_print_opaque_impl_type(def_id, substs),
766 ty::Str => p!("str"),
767 ty::Generator(did, substs, movability) => {
769 let generator_kind = self.tcx().generator_kind(did).unwrap();
770 let should_print_movability =
771 self.should_print_verbose() || generator_kind == hir::GeneratorKind::Gen;
773 if should_print_movability {
775 hir::Movability::Movable => {}
776 hir::Movability::Static => p!("static "),
780 if !self.should_print_verbose() {
781 p!(write("{}", generator_kind));
782 // FIXME(eddyb) should use `def_span`.
783 if let Some(did) = did.as_local() {
784 let span = self.tcx().def_span(did);
787 // This may end up in stderr diagnostics but it may also be emitted
788 // into MIR. Hence we use the remapped path if available
789 self.tcx().sess.source_map().span_to_embeddable_string(span)
792 p!(write("@"), print_def_path(did, substs));
795 p!(print_def_path(did, substs));
797 if !substs.as_generator().is_valid() {
800 self = self.comma_sep(substs.as_generator().upvar_tys())?;
804 if substs.as_generator().is_valid() {
805 p!(" ", print(substs.as_generator().witness()));
811 ty::GeneratorWitness(types) => {
812 p!(in_binder(&types));
814 ty::Closure(did, substs) => {
816 if !self.should_print_verbose() {
817 p!(write("closure"));
818 // FIXME(eddyb) should use `def_span`.
819 if let Some(did) = did.as_local() {
820 if self.tcx().sess.opts.unstable_opts.span_free_formats {
821 p!("@", print_def_path(did.to_def_id(), substs));
823 let span = self.tcx().def_span(did);
824 let preference = if FORCE_TRIMMED_PATH.with(|flag| flag.get()) {
825 FileNameDisplayPreference::Short
827 FileNameDisplayPreference::Remapped
831 // This may end up in stderr diagnostics but it may also be emitted
832 // into MIR. Hence we use the remapped path if available
833 self.tcx().sess.source_map().span_to_string(span, preference)
837 p!(write("@"), print_def_path(did, substs));
840 p!(print_def_path(did, substs));
841 if !substs.as_closure().is_valid() {
842 p!(" closure_substs=(unavailable)");
843 p!(write(" substs={:?}", substs));
845 p!(" closure_kind_ty=", print(substs.as_closure().kind_ty()));
847 " closure_sig_as_fn_ptr_ty=",
848 print(substs.as_closure().sig_as_fn_ptr_ty())
851 self = self.comma_sep(substs.as_closure().upvar_tys())?;
857 ty::Array(ty, sz) => p!("[", print(ty), "; ", print(sz), "]"),
858 ty::Slice(ty) => p!("[", print(ty), "]"),
864 fn pretty_print_opaque_impl_type(
867 substs: &'tcx ty::List<ty::GenericArg<'tcx>>,
868 ) -> Result<Self::Type, Self::Error> {
869 let tcx = self.tcx();
871 // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
872 // by looking up the projections associated with the def_id.
873 let bounds = tcx.bound_explicit_item_bounds(def_id);
875 let mut traits = FxIndexMap::default();
876 let mut fn_traits = FxIndexMap::default();
877 let mut is_sized = false;
878 let mut lifetimes = SmallVec::<[ty::Region<'tcx>; 1]>::new();
880 for (predicate, _) in bounds.subst_iter_copied(tcx, substs) {
881 let bound_predicate = predicate.kind();
883 match bound_predicate.skip_binder() {
884 ty::PredicateKind::Clause(ty::Clause::Trait(pred)) => {
885 let trait_ref = bound_predicate.rebind(pred.trait_ref);
887 // Don't print + Sized, but rather + ?Sized if absent.
888 if Some(trait_ref.def_id()) == tcx.lang_items().sized_trait() {
893 self.insert_trait_and_projection(trait_ref, None, &mut traits, &mut fn_traits);
895 ty::PredicateKind::Clause(ty::Clause::Projection(pred)) => {
896 let proj_ref = bound_predicate.rebind(pred);
897 let trait_ref = proj_ref.required_poly_trait_ref(tcx);
899 // Projection type entry -- the def-id for naming, and the ty.
900 let proj_ty = (proj_ref.projection_def_id(), proj_ref.term());
902 self.insert_trait_and_projection(
909 ty::PredicateKind::Clause(ty::Clause::TypeOutlives(outlives)) => {
910 lifetimes.push(outlives.1);
916 write!(self, "impl ")?;
918 let mut first = true;
919 // Insert parenthesis around (Fn(A, B) -> C) if the opaque ty has more than one other trait
920 let paren_needed = fn_traits.len() > 1 || traits.len() > 0 || !is_sized;
922 for (fn_once_trait_ref, entry) in fn_traits {
923 write!(self, "{}", if first { "" } else { " + " })?;
924 write!(self, "{}", if paren_needed { "(" } else { "" })?;
926 self = self.wrap_binder(&fn_once_trait_ref, |trait_ref, mut cx| {
927 define_scoped_cx!(cx);
928 // Get the (single) generic ty (the args) of this FnOnce trait ref.
929 let generics = tcx.generics_of(trait_ref.def_id);
930 let args = generics.own_substs_no_defaults(tcx, trait_ref.substs);
932 match (entry.return_ty, args[0].expect_ty()) {
933 // We can only print `impl Fn() -> ()` if we have a tuple of args and we recorded
935 (Some(return_ty), arg_tys) if matches!(arg_tys.kind(), ty::Tuple(_)) => {
936 let name = if entry.fn_trait_ref.is_some() {
938 } else if entry.fn_mut_trait_ref.is_some() {
944 p!(write("{}(", name));
946 for (idx, ty) in arg_tys.tuple_fields().iter().enumerate() {
954 if let Some(ty) = return_ty.skip_binder().ty() {
956 p!(" -> ", print(return_ty));
959 p!(write("{}", if paren_needed { ")" } else { "" }));
963 // If we got here, we can't print as a `impl Fn(A, B) -> C`. Just record the
964 // trait_refs we collected in the OpaqueFnEntry as normal trait refs.
966 if entry.has_fn_once {
967 traits.entry(fn_once_trait_ref).or_default().extend(
968 // Group the return ty with its def id, if we had one.
971 .map(|ty| (tcx.require_lang_item(LangItem::FnOnce, None), ty)),
974 if let Some(trait_ref) = entry.fn_mut_trait_ref {
975 traits.entry(trait_ref).or_default();
977 if let Some(trait_ref) = entry.fn_trait_ref {
978 traits.entry(trait_ref).or_default();
987 // Print the rest of the trait types (that aren't Fn* family of traits)
988 for (trait_ref, assoc_items) in traits {
989 write!(self, "{}", if first { "" } else { " + " })?;
991 self = self.wrap_binder(&trait_ref, |trait_ref, mut cx| {
992 define_scoped_cx!(cx);
993 p!(print(trait_ref.print_only_trait_name()));
995 let generics = tcx.generics_of(trait_ref.def_id);
996 let args = generics.own_substs_no_defaults(tcx, trait_ref.substs);
998 if !args.is_empty() || !assoc_items.is_empty() {
999 let mut first = true;
1011 for (assoc_item_def_id, term) in assoc_items {
1012 // Skip printing `<[generator@] as Generator<_>>::Return` from async blocks,
1013 // unless we can find out what generator return type it comes from.
1014 let term = if let Some(ty) = term.skip_binder().ty()
1015 && let ty::Alias(ty::Projection, proj) = ty.kind()
1016 && let Some(assoc) = tcx.opt_associated_item(proj.def_id)
1017 && assoc.trait_container(tcx) == tcx.lang_items().gen_trait()
1018 && assoc.name == rustc_span::sym::Return
1020 if let ty::Generator(_, substs, _) = substs.type_at(0).kind() {
1021 let return_ty = substs.as_generator().return_ty();
1022 if !return_ty.is_ty_var() {
1041 p!(write("{} = ", tcx.associated_item(assoc_item_def_id).name));
1043 match term.unpack() {
1044 TermKind::Ty(ty) => p!(print(ty)),
1045 TermKind::Const(c) => p!(print(c)),
1060 write!(self, "{}?Sized", if first { "" } else { " + " })?;
1062 write!(self, "Sized")?;
1065 for re in lifetimes {
1066 write!(self, " + ")?;
1067 self = self.print_region(re)?;
1073 /// Insert the trait ref and optionally a projection type associated with it into either the
1074 /// traits map or fn_traits map, depending on if the trait is in the Fn* family of traits.
1075 fn insert_trait_and_projection(
1077 trait_ref: ty::PolyTraitRef<'tcx>,
1078 proj_ty: Option<(DefId, ty::Binder<'tcx, Term<'tcx>>)>,
1079 traits: &mut FxIndexMap<
1080 ty::PolyTraitRef<'tcx>,
1081 FxIndexMap<DefId, ty::Binder<'tcx, Term<'tcx>>>,
1083 fn_traits: &mut FxIndexMap<ty::PolyTraitRef<'tcx>, OpaqueFnEntry<'tcx>>,
1085 let trait_def_id = trait_ref.def_id();
1087 // If our trait_ref is FnOnce or any of its children, project it onto the parent FnOnce
1088 // super-trait ref and record it there.
1089 if let Some(fn_once_trait) = self.tcx().lang_items().fn_once_trait() {
1090 // If we have a FnOnce, then insert it into
1091 if trait_def_id == fn_once_trait {
1092 let entry = fn_traits.entry(trait_ref).or_default();
1093 // Optionally insert the return_ty as well.
1094 if let Some((_, ty)) = proj_ty {
1095 entry.return_ty = Some(ty);
1097 entry.has_fn_once = true;
1099 } else if Some(trait_def_id) == self.tcx().lang_items().fn_mut_trait() {
1100 let super_trait_ref = crate::traits::util::supertraits(self.tcx(), trait_ref)
1101 .find(|super_trait_ref| super_trait_ref.def_id() == fn_once_trait)
1104 fn_traits.entry(super_trait_ref).or_default().fn_mut_trait_ref = Some(trait_ref);
1106 } else if Some(trait_def_id) == self.tcx().lang_items().fn_trait() {
1107 let super_trait_ref = crate::traits::util::supertraits(self.tcx(), trait_ref)
1108 .find(|super_trait_ref| super_trait_ref.def_id() == fn_once_trait)
1111 fn_traits.entry(super_trait_ref).or_default().fn_trait_ref = Some(trait_ref);
1116 // Otherwise, just group our traits and projection types.
1117 traits.entry(trait_ref).or_default().extend(proj_ty);
1120 fn pretty_print_bound_var(
1122 debruijn: ty::DebruijnIndex,
1124 ) -> Result<(), Self::Error> {
1125 if debruijn == ty::INNERMOST {
1126 write!(self, "^{}", var.index())
1128 write!(self, "^{}_{}", debruijn.index(), var.index())
1132 fn ty_infer_name(&self, _: ty::TyVid) -> Option<Symbol> {
1136 fn const_infer_name(&self, _: ty::ConstVid<'tcx>) -> Option<Symbol> {
1140 fn pretty_print_dyn_existential(
1142 predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
1143 ) -> Result<Self::DynExistential, Self::Error> {
1144 // Generate the main trait ref, including associated types.
1145 let mut first = true;
1147 if let Some(principal) = predicates.principal() {
1148 self = self.wrap_binder(&principal, |principal, mut cx| {
1149 define_scoped_cx!(cx);
1150 p!(print_def_path(principal.def_id, &[]));
1152 let mut resugared = false;
1154 // Special-case `Fn(...) -> ...` and re-sugar it.
1155 let fn_trait_kind = cx.tcx().fn_trait_kind_from_def_id(principal.def_id);
1156 if !cx.should_print_verbose() && fn_trait_kind.is_some() {
1157 if let ty::Tuple(tys) = principal.substs.type_at(0).kind() {
1158 let mut projections = predicates.projection_bounds();
1159 if let (Some(proj), None) = (projections.next(), projections.next()) {
1163 proj.skip_binder().term.ty().expect("Return type was a const")
1170 // HACK(eddyb) this duplicates `FmtPrinter`'s `path_generic_args`,
1171 // in order to place the projections inside the `<...>`.
1173 // Use a type that can't appear in defaults of type parameters.
1174 let dummy_cx = cx.tcx().mk_ty_infer(ty::FreshTy(0));
1175 let principal = principal.with_self_ty(cx.tcx(), dummy_cx);
1179 .generics_of(principal.def_id)
1180 .own_substs_no_defaults(cx.tcx(), principal.substs);
1182 let mut projections = predicates.projection_bounds();
1184 let mut args = args.iter().cloned();
1185 let arg0 = args.next();
1186 let projection0 = projections.next();
1187 if arg0.is_some() || projection0.is_some() {
1188 let args = arg0.into_iter().chain(args);
1189 let projections = projection0.into_iter().chain(projections);
1191 p!(generic_delimiters(|mut cx| {
1192 cx = cx.comma_sep(args)?;
1193 if arg0.is_some() && projection0.is_some() {
1196 cx.comma_sep(projections)
1206 define_scoped_cx!(self);
1209 // FIXME(eddyb) avoid printing twice (needed to ensure
1210 // that the auto traits are sorted *and* printed via cx).
1211 let mut auto_traits: Vec<_> = predicates.auto_traits().collect();
1213 // The auto traits come ordered by `DefPathHash`. While
1214 // `DefPathHash` is *stable* in the sense that it depends on
1215 // neither the host nor the phase of the moon, it depends
1216 // "pseudorandomly" on the compiler version and the target.
1218 // To avoid causing instabilities in compiletest
1219 // output, sort the auto-traits alphabetically.
1220 auto_traits.sort_by_cached_key(|did| with_no_trimmed_paths!(self.tcx().def_path_str(*did)));
1222 for def_id in auto_traits {
1228 p!(print_def_path(def_id, &[]));
1236 inputs: &[Ty<'tcx>],
1239 ) -> Result<Self, Self::Error> {
1240 define_scoped_cx!(self);
1242 p!("(", comma_sep(inputs.iter().copied()));
1244 if !inputs.is_empty() {
1250 if !output.is_unit() {
1251 p!(" -> ", print(output));
1257 fn pretty_print_const(
1259 ct: ty::Const<'tcx>,
1261 ) -> Result<Self::Const, Self::Error> {
1262 define_scoped_cx!(self);
1264 if self.should_print_verbose() {
1265 p!(write("Const({:?}: {:?})", ct.kind(), ct.ty()));
1269 macro_rules! print_underscore {
1272 self = self.typed_value(
1277 |this| this.print_type(ct.ty()),
1287 ty::ConstKind::Unevaluated(ty::UnevaluatedConst { def, substs }) => {
1288 match self.tcx().def_kind(def.did) {
1289 DefKind::Const | DefKind::AssocConst => {
1290 p!(print_value_path(def.did, substs))
1292 DefKind::AnonConst => {
1294 && let span = self.tcx().def_span(def.did)
1295 && let Ok(snip) = self.tcx().sess.source_map().span_to_snippet(span)
1297 p!(write("{}", snip))
1299 // Do not call `print_value_path` as if a parent of this anon const is an impl it will
1300 // attempt to print out the impl trait ref i.e. `<T as Trait>::{constant#0}`. This would
1301 // cause printing to enter an infinite recursion if the anon const is in the self type i.e.
1302 // `impl<T: Default> Default for [T; 32 - 1 - 1 - 1] {`
1303 // where we would try to print `<[T; /* print `constant#0` again */] as Default>::{constant#0}`
1304 p!(write("{}::{}", self.tcx().crate_name(def.did.krate), self.tcx().def_path(def.did).to_string_no_crate_verbose()))
1307 defkind => bug!("`{:?}` has unexpcted defkind {:?}", ct, defkind),
1310 ty::ConstKind::Infer(infer_ct) => {
1312 ty::InferConst::Var(ct_vid)
1313 if let Some(name) = self.const_infer_name(ct_vid) =>
1314 p!(write("{}", name)),
1315 _ => print_underscore!(),
1318 ty::ConstKind::Param(ParamConst { name, .. }) => p!(write("{}", name)),
1319 ty::ConstKind::Value(value) => {
1320 return self.pretty_print_const_valtree(value, ct.ty(), print_ty);
1323 ty::ConstKind::Bound(debruijn, bound_var) => {
1324 self.pretty_print_bound_var(debruijn, bound_var)?
1326 ty::ConstKind::Placeholder(placeholder) => p!(write("Placeholder({:?})", placeholder)),
1327 // FIXME(generic_const_exprs):
1328 // write out some legible representation of an abstract const?
1329 ty::ConstKind::Expr(_) => p!("[const expr]"),
1330 ty::ConstKind::Error(_) => p!("[const error]"),
1335 fn pretty_print_const_scalar(
1340 ) -> Result<Self::Const, Self::Error> {
1342 Scalar::Ptr(ptr, _size) => self.pretty_print_const_scalar_ptr(ptr, ty, print_ty),
1343 Scalar::Int(int) => self.pretty_print_const_scalar_int(int, ty, print_ty),
1347 fn pretty_print_const_scalar_ptr(
1352 ) -> Result<Self::Const, Self::Error> {
1353 define_scoped_cx!(self);
1355 let (alloc_id, offset) = ptr.into_parts();
1357 // Byte strings (&[u8; N])
1358 ty::Ref(_, inner, _) => {
1359 if let ty::Array(elem, len) = inner.kind() {
1360 if let ty::Uint(ty::UintTy::U8) = elem.kind() {
1361 if let ty::ConstKind::Value(ty::ValTree::Leaf(int)) = len.kind() {
1362 match self.tcx().try_get_global_alloc(alloc_id) {
1363 Some(GlobalAlloc::Memory(alloc)) => {
1364 let len = int.assert_bits(self.tcx().data_layout.pointer_size);
1366 AllocRange { start: offset, size: Size::from_bytes(len) };
1367 if let Ok(byte_str) =
1368 alloc.inner().get_bytes_strip_provenance(&self.tcx(), range)
1370 p!(pretty_print_byte_str(byte_str))
1372 p!("<too short allocation>")
1375 // FIXME: for statics, vtables, and functions, we could in principle print more detail.
1376 Some(GlobalAlloc::Static(def_id)) => {
1377 p!(write("<static({:?})>", def_id))
1379 Some(GlobalAlloc::Function(_)) => p!("<function>"),
1380 Some(GlobalAlloc::VTable(..)) => p!("<vtable>"),
1381 None => p!("<dangling pointer>"),
1389 // FIXME: We should probably have a helper method to share code with the "Byte strings"
1390 // printing above (which also has to handle pointers to all sorts of things).
1391 if let Some(GlobalAlloc::Function(instance)) =
1392 self.tcx().try_get_global_alloc(alloc_id)
1394 self = self.typed_value(
1395 |this| this.print_value_path(instance.def_id(), instance.substs),
1396 |this| this.print_type(ty),
1404 // Any pointer values not covered by a branch above
1405 self = self.pretty_print_const_pointer(ptr, ty, print_ty)?;
1409 fn pretty_print_const_scalar_int(
1414 ) -> Result<Self::Const, Self::Error> {
1415 define_scoped_cx!(self);
1419 ty::Bool if int == ScalarInt::FALSE => p!("false"),
1420 ty::Bool if int == ScalarInt::TRUE => p!("true"),
1422 ty::Float(ty::FloatTy::F32) => {
1423 p!(write("{}f32", Single::try_from(int).unwrap()))
1425 ty::Float(ty::FloatTy::F64) => {
1426 p!(write("{}f64", Double::try_from(int).unwrap()))
1429 ty::Uint(_) | ty::Int(_) => {
1431 ConstInt::new(int, matches!(ty.kind(), ty::Int(_)), ty.is_ptr_sized_integral());
1432 if print_ty { p!(write("{:#?}", int)) } else { p!(write("{:?}", int)) }
1435 ty::Char if char::try_from(int).is_ok() => {
1436 p!(write("{:?}", char::try_from(int).unwrap()))
1439 ty::Ref(..) | ty::RawPtr(_) | ty::FnPtr(_) => {
1440 let data = int.assert_bits(self.tcx().data_layout.pointer_size);
1441 self = self.typed_value(
1443 write!(this, "0x{:x}", data)?;
1446 |this| this.print_type(ty),
1450 // Nontrivial types with scalar bit representation
1452 let print = |mut this: Self| {
1453 if int.size() == Size::ZERO {
1454 write!(this, "transmute(())")?;
1456 write!(this, "transmute(0x{:x})", int)?;
1460 self = if print_ty {
1461 self.typed_value(print, |this| this.print_type(ty), ": ")?
1470 /// This is overridden for MIR printing because we only want to hide alloc ids from users, not
1471 /// from MIR where it is actually useful.
1472 fn pretty_print_const_pointer<Prov: Provenance>(
1477 ) -> Result<Self::Const, Self::Error> {
1481 this.write_str("&_")?;
1484 |this| this.print_type(ty),
1488 self.write_str("&_")?;
1493 fn pretty_print_byte_str(mut self, byte_str: &'tcx [u8]) -> Result<Self::Const, Self::Error> {
1494 write!(self, "b\"{}\"", byte_str.escape_ascii())?;
1498 fn pretty_print_const_valtree(
1500 valtree: ty::ValTree<'tcx>,
1503 ) -> Result<Self::Const, Self::Error> {
1504 define_scoped_cx!(self);
1506 if self.should_print_verbose() {
1507 p!(write("ValTree({:?}: ", valtree), print(ty), ")");
1511 let u8_type = self.tcx().types.u8;
1512 match (valtree, ty.kind()) {
1513 (ty::ValTree::Branch(_), ty::Ref(_, inner_ty, _)) => match inner_ty.kind() {
1514 ty::Slice(t) if *t == u8_type => {
1515 let bytes = valtree.try_to_raw_bytes(self.tcx(), ty).unwrap_or_else(|| {
1517 "expected to convert valtree {:?} to raw bytes for type {:?}",
1522 return self.pretty_print_byte_str(bytes);
1525 let bytes = valtree.try_to_raw_bytes(self.tcx(), ty).unwrap_or_else(|| {
1526 bug!("expected to convert valtree to raw bytes for type {:?}", ty)
1528 p!(write("{:?}", String::from_utf8_lossy(bytes)));
1533 p!(pretty_print_const_valtree(valtree, *inner_ty, print_ty));
1537 (ty::ValTree::Branch(_), ty::Array(t, _)) if *t == u8_type => {
1538 let bytes = valtree.try_to_raw_bytes(self.tcx(), ty).unwrap_or_else(|| {
1539 bug!("expected to convert valtree to raw bytes for type {:?}", t)
1542 p!(pretty_print_byte_str(bytes));
1545 // Aggregates, printed as array/tuple/struct/variant construction syntax.
1546 (ty::ValTree::Branch(_), ty::Array(..) | ty::Tuple(..) | ty::Adt(..)) => {
1547 let contents = self.tcx().destructure_const(self.tcx().mk_const(valtree, ty));
1548 let fields = contents.fields.iter().copied();
1551 p!("[", comma_sep(fields), "]");
1554 p!("(", comma_sep(fields));
1555 if contents.fields.len() == 1 {
1560 ty::Adt(def, _) if def.variants().is_empty() => {
1561 self = self.typed_value(
1563 write!(this, "unreachable()")?;
1566 |this| this.print_type(ty),
1570 ty::Adt(def, substs) => {
1572 contents.variant.expect("destructed const of adt without variant idx");
1573 let variant_def = &def.variant(variant_idx);
1574 p!(print_value_path(variant_def.def_id, substs));
1575 match variant_def.ctor_kind() {
1576 Some(CtorKind::Const) => {}
1577 Some(CtorKind::Fn) => {
1578 p!("(", comma_sep(fields), ")");
1582 let mut first = true;
1583 for (field_def, field) in iter::zip(&variant_def.fields, fields) {
1587 p!(write("{}: ", field_def.name), print(field));
1594 _ => unreachable!(),
1598 (ty::ValTree::Leaf(leaf), ty::Ref(_, inner_ty, _)) => {
1600 return self.pretty_print_const_scalar_int(leaf, *inner_ty, print_ty);
1602 (ty::ValTree::Leaf(leaf), _) => {
1603 return self.pretty_print_const_scalar_int(leaf, ty, print_ty);
1605 // FIXME(oli-obk): also pretty print arrays and other aggregate constants by reading
1606 // their fields instead of just dumping the memory.
1611 if valtree == ty::ValTree::zst() {
1614 p!(write("{:?}", valtree));
1617 p!(": ", print(ty));
1622 fn pretty_closure_as_impl(
1624 closure: ty::ClosureSubsts<'tcx>,
1625 ) -> Result<Self::Const, Self::Error> {
1626 let sig = closure.sig();
1627 let kind = closure.kind_ty().to_opt_closure_kind().unwrap_or(ty::ClosureKind::Fn);
1629 write!(self, "impl ")?;
1630 self.wrap_binder(&sig, |sig, mut cx| {
1631 define_scoped_cx!(cx);
1633 p!(print(kind), "(");
1634 for (i, arg) in sig.inputs()[0].tuple_fields().iter().enumerate() {
1642 if !sig.output().is_unit() {
1643 p!(" -> ", print(sig.output()));
1650 fn should_print_verbose(&self) -> bool {
1651 self.tcx().sess.verbose()
1655 // HACK(eddyb) boxed to avoid moving around a large struct by-value.
1656 pub struct FmtPrinter<'a, 'tcx>(Box<FmtPrinterData<'a, 'tcx>>);
1658 pub struct FmtPrinterData<'a, 'tcx> {
1664 pub print_alloc_ids: bool,
1666 // set of all named (non-anonymous) region names
1667 used_region_names: FxHashSet<Symbol>,
1669 region_index: usize,
1670 binder_depth: usize,
1671 printed_type_count: usize,
1672 type_length_limit: Limit,
1675 pub region_highlight_mode: RegionHighlightMode<'tcx>,
1677 pub ty_infer_name_resolver: Option<Box<dyn Fn(ty::TyVid) -> Option<Symbol> + 'a>>,
1678 pub const_infer_name_resolver: Option<Box<dyn Fn(ty::ConstVid<'tcx>) -> Option<Symbol> + 'a>>,
1681 impl<'a, 'tcx> Deref for FmtPrinter<'a, 'tcx> {
1682 type Target = FmtPrinterData<'a, 'tcx>;
1683 fn deref(&self) -> &Self::Target {
1688 impl DerefMut for FmtPrinter<'_, '_> {
1689 fn deref_mut(&mut self) -> &mut Self::Target {
1694 impl<'a, 'tcx> FmtPrinter<'a, 'tcx> {
1695 pub fn new(tcx: TyCtxt<'tcx>, ns: Namespace) -> Self {
1696 Self::new_with_limit(tcx, ns, tcx.type_length_limit())
1699 pub fn new_with_limit(tcx: TyCtxt<'tcx>, ns: Namespace, type_length_limit: Limit) -> Self {
1700 FmtPrinter(Box::new(FmtPrinterData {
1702 // Estimated reasonable capacity to allocate upfront based on a few
1704 fmt: String::with_capacity(64),
1706 in_value: ns == Namespace::ValueNS,
1707 print_alloc_ids: false,
1708 used_region_names: Default::default(),
1711 printed_type_count: 0,
1714 region_highlight_mode: RegionHighlightMode::new(tcx),
1715 ty_infer_name_resolver: None,
1716 const_infer_name_resolver: None,
1720 pub fn into_buffer(self) -> String {
1725 // HACK(eddyb) get rid of `def_path_str` and/or pass `Namespace` explicitly always
1726 // (but also some things just print a `DefId` generally so maybe we need this?)
1727 fn guess_def_namespace(tcx: TyCtxt<'_>, def_id: DefId) -> Namespace {
1728 match tcx.def_key(def_id).disambiguated_data.data {
1729 DefPathData::TypeNs(..) | DefPathData::CrateRoot | DefPathData::ImplTrait => {
1733 DefPathData::ValueNs(..)
1734 | DefPathData::AnonConst
1735 | DefPathData::ClosureExpr
1736 | DefPathData::Ctor => Namespace::ValueNS,
1738 DefPathData::MacroNs(..) => Namespace::MacroNS,
1740 _ => Namespace::TypeNS,
1744 impl<'t> TyCtxt<'t> {
1745 /// Returns a string identifying this `DefId`. This string is
1746 /// suitable for user output.
1747 pub fn def_path_str(self, def_id: DefId) -> String {
1748 self.def_path_str_with_substs(def_id, &[])
1751 pub fn def_path_str_with_substs(self, def_id: DefId, substs: &'t [GenericArg<'t>]) -> String {
1752 let ns = guess_def_namespace(self, def_id);
1753 debug!("def_path_str: def_id={:?}, ns={:?}", def_id, ns);
1754 FmtPrinter::new(self, ns).print_def_path(def_id, substs).unwrap().into_buffer()
1757 pub fn value_path_str_with_substs(self, def_id: DefId, substs: &'t [GenericArg<'t>]) -> String {
1758 let ns = guess_def_namespace(self, def_id);
1759 debug!("value_path_str: def_id={:?}, ns={:?}", def_id, ns);
1760 FmtPrinter::new(self, ns).print_value_path(def_id, substs).unwrap().into_buffer()
1764 impl fmt::Write for FmtPrinter<'_, '_> {
1765 fn write_str(&mut self, s: &str) -> fmt::Result {
1766 self.fmt.push_str(s);
1771 impl<'tcx> Printer<'tcx> for FmtPrinter<'_, 'tcx> {
1772 type Error = fmt::Error;
1777 type DynExistential = Self;
1780 fn tcx<'a>(&'a self) -> TyCtxt<'tcx> {
1787 substs: &'tcx [GenericArg<'tcx>],
1788 ) -> Result<Self::Path, Self::Error> {
1789 define_scoped_cx!(self);
1791 if substs.is_empty() {
1792 match self.try_print_trimmed_def_path(def_id)? {
1793 (cx, true) => return Ok(cx),
1794 (cx, false) => self = cx,
1797 match self.try_print_visible_def_path(def_id)? {
1798 (cx, true) => return Ok(cx),
1799 (cx, false) => self = cx,
1803 let key = self.tcx.def_key(def_id);
1804 if let DefPathData::Impl = key.disambiguated_data.data {
1805 // Always use types for non-local impls, where types are always
1806 // available, and filename/line-number is mostly uninteresting.
1807 let use_types = !def_id.is_local() || {
1808 // Otherwise, use filename/line-number if forced.
1809 let force_no_types = FORCE_IMPL_FILENAME_LINE.with(|f| f.get());
1814 // If no type info is available, fall back to
1815 // pretty printing some span information. This should
1816 // only occur very early in the compiler pipeline.
1817 let parent_def_id = DefId { index: key.parent.unwrap(), ..def_id };
1818 let span = self.tcx.def_span(def_id);
1820 self = self.print_def_path(parent_def_id, &[])?;
1822 // HACK(eddyb) copy of `path_append` to avoid
1823 // constructing a `DisambiguatedDefPathData`.
1824 if !self.empty_path {
1825 write!(self, "::")?;
1830 // This may end up in stderr diagnostics but it may also be emitted
1831 // into MIR. Hence we use the remapped path if available
1832 self.tcx.sess.source_map().span_to_embeddable_string(span)
1834 self.empty_path = false;
1840 self.default_print_def_path(def_id, substs)
1843 fn print_region(self, region: ty::Region<'tcx>) -> Result<Self::Region, Self::Error> {
1844 self.pretty_print_region(region)
1847 fn print_type(mut self, ty: Ty<'tcx>) -> Result<Self::Type, Self::Error> {
1848 if self.type_length_limit.value_within_limit(self.printed_type_count) {
1849 self.printed_type_count += 1;
1850 self.pretty_print_type(ty)
1852 self.truncated = true;
1853 write!(self, "...")?;
1858 fn print_dyn_existential(
1860 predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
1861 ) -> Result<Self::DynExistential, Self::Error> {
1862 self.pretty_print_dyn_existential(predicates)
1865 fn print_const(self, ct: ty::Const<'tcx>) -> Result<Self::Const, Self::Error> {
1866 self.pretty_print_const(ct, false)
1869 fn path_crate(mut self, cnum: CrateNum) -> Result<Self::Path, Self::Error> {
1870 self.empty_path = true;
1871 if cnum == LOCAL_CRATE {
1872 if self.tcx.sess.rust_2018() {
1873 // We add the `crate::` keyword on Rust 2018, only when desired.
1874 if SHOULD_PREFIX_WITH_CRATE.with(|flag| flag.get()) {
1875 write!(self, "{}", kw::Crate)?;
1876 self.empty_path = false;
1880 write!(self, "{}", self.tcx.crate_name(cnum))?;
1881 self.empty_path = false;
1889 trait_ref: Option<ty::TraitRef<'tcx>>,
1890 ) -> Result<Self::Path, Self::Error> {
1891 self = self.pretty_path_qualified(self_ty, trait_ref)?;
1892 self.empty_path = false;
1896 fn path_append_impl(
1898 print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1899 _disambiguated_data: &DisambiguatedDefPathData,
1901 trait_ref: Option<ty::TraitRef<'tcx>>,
1902 ) -> Result<Self::Path, Self::Error> {
1903 self = self.pretty_path_append_impl(
1905 cx = print_prefix(cx)?;
1915 self.empty_path = false;
1921 print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1922 disambiguated_data: &DisambiguatedDefPathData,
1923 ) -> Result<Self::Path, Self::Error> {
1924 self = print_prefix(self)?;
1926 // Skip `::{{extern}}` blocks and `::{{constructor}}` on tuple/unit structs.
1927 if let DefPathData::ForeignMod | DefPathData::Ctor = disambiguated_data.data {
1931 let name = disambiguated_data.data.name();
1932 if !self.empty_path {
1933 write!(self, "::")?;
1936 if let DefPathDataName::Named(name) = name {
1937 if Ident::with_dummy_span(name).is_raw_guess() {
1938 write!(self, "r#")?;
1942 let verbose = self.should_print_verbose();
1943 disambiguated_data.fmt_maybe_verbose(&mut self, verbose)?;
1945 self.empty_path = false;
1950 fn path_generic_args(
1952 print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1953 args: &[GenericArg<'tcx>],
1954 ) -> Result<Self::Path, Self::Error> {
1955 self = print_prefix(self)?;
1957 if args.first().is_some() {
1959 write!(self, "::")?;
1961 self.generic_delimiters(|cx| cx.comma_sep(args.iter().cloned()))
1968 impl<'tcx> PrettyPrinter<'tcx> for FmtPrinter<'_, 'tcx> {
1969 fn ty_infer_name(&self, id: ty::TyVid) -> Option<Symbol> {
1970 self.0.ty_infer_name_resolver.as_ref().and_then(|func| func(id))
1973 fn reset_type_limit(&mut self) {
1974 self.printed_type_count = 0;
1977 fn const_infer_name(&self, id: ty::ConstVid<'tcx>) -> Option<Symbol> {
1978 self.0.const_infer_name_resolver.as_ref().and_then(|func| func(id))
1981 fn print_value_path(
1984 substs: &'tcx [GenericArg<'tcx>],
1985 ) -> Result<Self::Path, Self::Error> {
1986 let was_in_value = std::mem::replace(&mut self.in_value, true);
1987 self = self.print_def_path(def_id, substs)?;
1988 self.in_value = was_in_value;
1993 fn in_binder<T>(self, value: &ty::Binder<'tcx, T>) -> Result<Self, Self::Error>
1995 T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
1997 self.pretty_in_binder(value)
2000 fn wrap_binder<T, C: FnOnce(&T, Self) -> Result<Self, Self::Error>>(
2002 value: &ty::Binder<'tcx, T>,
2004 ) -> Result<Self, Self::Error>
2006 T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
2008 self.pretty_wrap_binder(value, f)
2013 f: impl FnOnce(Self) -> Result<Self, Self::Error>,
2014 t: impl FnOnce(Self) -> Result<Self, Self::Error>,
2016 ) -> Result<Self::Const, Self::Error> {
2017 self.write_str("{")?;
2019 self.write_str(conversion)?;
2020 let was_in_value = std::mem::replace(&mut self.in_value, false);
2022 self.in_value = was_in_value;
2023 self.write_str("}")?;
2027 fn generic_delimiters(
2029 f: impl FnOnce(Self) -> Result<Self, Self::Error>,
2030 ) -> Result<Self, Self::Error> {
2033 let was_in_value = std::mem::replace(&mut self.in_value, false);
2034 let mut inner = f(self)?;
2035 inner.in_value = was_in_value;
2037 write!(inner, ">")?;
2041 fn should_print_region(&self, region: ty::Region<'tcx>) -> bool {
2042 let highlight = self.region_highlight_mode;
2043 if highlight.region_highlighted(region).is_some() {
2047 if self.should_print_verbose() {
2051 let identify_regions = self.tcx.sess.opts.unstable_opts.identify_regions;
2054 ty::ReEarlyBound(ref data) => data.has_name(),
2056 ty::ReLateBound(_, ty::BoundRegion { kind: br, .. })
2057 | ty::ReFree(ty::FreeRegion { bound_region: br, .. })
2058 | ty::RePlaceholder(ty::Placeholder { name: br, .. }) => {
2063 if let Some((region, _)) = highlight.highlight_bound_region {
2072 ty::ReVar(_) if identify_regions => true,
2074 ty::ReVar(_) | ty::ReErased => false,
2076 ty::ReStatic => true,
2080 fn pretty_print_const_pointer<Prov: Provenance>(
2085 ) -> Result<Self::Const, Self::Error> {
2086 let print = |mut this: Self| {
2087 define_scoped_cx!(this);
2088 if this.print_alloc_ids {
2089 p!(write("{:?}", p));
2096 self.typed_value(print, |this| this.print_type(ty), ": ")
2103 // HACK(eddyb) limited to `FmtPrinter` because of `region_highlight_mode`.
2104 impl<'tcx> FmtPrinter<'_, 'tcx> {
2105 pub fn pretty_print_region(mut self, region: ty::Region<'tcx>) -> Result<Self, fmt::Error> {
2106 define_scoped_cx!(self);
2108 // Watch out for region highlights.
2109 let highlight = self.region_highlight_mode;
2110 if let Some(n) = highlight.region_highlighted(region) {
2111 p!(write("'{}", n));
2115 if self.should_print_verbose() {
2116 p!(write("{:?}", region));
2120 let identify_regions = self.tcx.sess.opts.unstable_opts.identify_regions;
2122 // These printouts are concise. They do not contain all the information
2123 // the user might want to diagnose an error, but there is basically no way
2124 // to fit that into a short string. Hence the recommendation to use
2125 // `explain_region()` or `note_and_explain_region()`.
2127 ty::ReEarlyBound(ref data) => {
2128 if data.name != kw::Empty {
2129 p!(write("{}", data.name));
2133 ty::ReLateBound(_, ty::BoundRegion { kind: br, .. })
2134 | ty::ReFree(ty::FreeRegion { bound_region: br, .. })
2135 | ty::RePlaceholder(ty::Placeholder { name: br, .. }) => {
2136 if let ty::BrNamed(_, name) = br && br.is_named() {
2137 p!(write("{}", name));
2141 if let Some((region, counter)) = highlight.highlight_bound_region {
2143 p!(write("'{}", counter));
2148 ty::ReVar(region_vid) if identify_regions => {
2149 p!(write("{:?}", region_vid));
2166 /// Folds through bound vars and placeholders, naming them
2167 struct RegionFolder<'a, 'tcx> {
2169 current_index: ty::DebruijnIndex,
2170 region_map: BTreeMap<ty::BoundRegion, ty::Region<'tcx>>,
2173 Option<ty::DebruijnIndex>, // Debruijn index of the folded late-bound region
2174 ty::DebruijnIndex, // Index corresponding to binder level
2176 ) -> ty::Region<'tcx>
2181 impl<'a, 'tcx> ty::TypeFolder<'tcx> for RegionFolder<'a, 'tcx> {
2182 fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
2186 fn fold_binder<T: TypeFoldable<'tcx>>(
2188 t: ty::Binder<'tcx, T>,
2189 ) -> ty::Binder<'tcx, T> {
2190 self.current_index.shift_in(1);
2191 let t = t.super_fold_with(self);
2192 self.current_index.shift_out(1);
2196 fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
2198 _ if t.has_vars_bound_at_or_above(self.current_index) || t.has_placeholders() => {
2199 return t.super_fold_with(self);
2206 fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
2207 let name = &mut self.name;
2208 let region = match *r {
2209 ty::ReLateBound(db, br) if db >= self.current_index => {
2210 *self.region_map.entry(br).or_insert_with(|| name(Some(db), self.current_index, br))
2212 ty::RePlaceholder(ty::PlaceholderRegion { name: kind, .. }) => {
2213 // If this is an anonymous placeholder, don't rename. Otherwise, in some
2214 // async fns, we get a `for<'r> Send` bound
2216 ty::BrAnon(..) | ty::BrEnv => r,
2218 // Index doesn't matter, since this is just for naming and these never get bound
2219 let br = ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind };
2223 .or_insert_with(|| name(None, self.current_index, br))
2229 if let ty::ReLateBound(debruijn1, br) = *region {
2230 assert_eq!(debruijn1, ty::INNERMOST);
2231 self.tcx.mk_region(ty::ReLateBound(self.current_index, br))
2238 // HACK(eddyb) limited to `FmtPrinter` because of `binder_depth`,
2239 // `region_index` and `used_region_names`.
2240 impl<'tcx> FmtPrinter<'_, 'tcx> {
2241 pub fn name_all_regions<T>(
2243 value: &ty::Binder<'tcx, T>,
2244 ) -> Result<(Self, T, BTreeMap<ty::BoundRegion, ty::Region<'tcx>>), fmt::Error>
2246 T: Print<'tcx, Self, Output = Self, Error = fmt::Error> + TypeFoldable<'tcx>,
2248 fn name_by_region_index(
2250 available_names: &mut Vec<Symbol>,
2251 num_available: usize,
2253 if let Some(name) = available_names.pop() {
2256 Symbol::intern(&format!("'z{}", index - num_available))
2260 debug!("name_all_regions");
2262 // Replace any anonymous late-bound regions with named
2263 // variants, using new unique identifiers, so that we can
2264 // clearly differentiate between named and unnamed regions in
2265 // the output. We'll probably want to tweak this over time to
2266 // decide just how much information to give.
2267 if self.binder_depth == 0 {
2268 self.prepare_region_info(value);
2271 debug!("self.used_region_names: {:?}", &self.used_region_names);
2273 let mut empty = true;
2274 let mut start_or_continue = |cx: &mut Self, start: &str, cont: &str| {
2281 let _ = write!(cx, "{}", w);
2283 let do_continue = |cx: &mut Self, cont: Symbol| {
2284 let _ = write!(cx, "{}", cont);
2287 define_scoped_cx!(self);
2289 let possible_names = ('a'..='z').rev().map(|s| Symbol::intern(&format!("'{s}")));
2291 let mut available_names = possible_names
2292 .filter(|name| !self.used_region_names.contains(&name))
2293 .collect::<Vec<_>>();
2294 debug!(?available_names);
2295 let num_available = available_names.len();
2297 let mut region_index = self.region_index;
2298 let mut next_name = |this: &Self| {
2302 name = name_by_region_index(region_index, &mut available_names, num_available);
2305 if !this.used_region_names.contains(&name) {
2313 // If we want to print verbosely, then print *all* binders, even if they
2314 // aren't named. Eventually, we might just want this as the default, but
2315 // this is not *quite* right and changes the ordering of some output
2317 let (new_value, map) = if self.should_print_verbose() {
2318 for var in value.bound_vars().iter() {
2319 start_or_continue(&mut self, "for<", ", ");
2320 write!(self, "{:?}", var)?;
2322 start_or_continue(&mut self, "", "> ");
2323 (value.clone().skip_binder(), BTreeMap::default())
2327 // Closure used in `RegionFolder` to create names for anonymous late-bound
2328 // regions. We use two `DebruijnIndex`es (one for the currently folded
2329 // late-bound region and the other for the binder level) to determine
2330 // whether a name has already been created for the currently folded region,
2331 // see issue #102392.
2332 let mut name = |lifetime_idx: Option<ty::DebruijnIndex>,
2333 binder_level_idx: ty::DebruijnIndex,
2334 br: ty::BoundRegion| {
2335 let (name, kind) = match br.kind {
2336 ty::BrAnon(..) | ty::BrEnv => {
2337 let name = next_name(&self);
2339 if let Some(lt_idx) = lifetime_idx {
2340 if lt_idx > binder_level_idx {
2341 let kind = ty::BrNamed(CRATE_DEF_ID.to_def_id(), name);
2342 return tcx.mk_region(ty::ReLateBound(
2344 ty::BoundRegion { var: br.var, kind },
2349 (name, ty::BrNamed(CRATE_DEF_ID.to_def_id(), name))
2351 ty::BrNamed(def_id, kw::UnderscoreLifetime | kw::Empty) => {
2352 let name = next_name(&self);
2354 if let Some(lt_idx) = lifetime_idx {
2355 if lt_idx > binder_level_idx {
2356 let kind = ty::BrNamed(def_id, name);
2357 return tcx.mk_region(ty::ReLateBound(
2359 ty::BoundRegion { var: br.var, kind },
2364 (name, ty::BrNamed(def_id, name))
2366 ty::BrNamed(_, name) => {
2367 if let Some(lt_idx) = lifetime_idx {
2368 if lt_idx > binder_level_idx {
2370 return tcx.mk_region(ty::ReLateBound(
2372 ty::BoundRegion { var: br.var, kind },
2381 start_or_continue(&mut self, "for<", ", ");
2382 do_continue(&mut self, name);
2383 tcx.mk_region(ty::ReLateBound(ty::INNERMOST, ty::BoundRegion { var: br.var, kind }))
2385 let mut folder = RegionFolder {
2387 current_index: ty::INNERMOST,
2389 region_map: BTreeMap::new(),
2391 let new_value = value.clone().skip_binder().fold_with(&mut folder);
2392 let region_map = folder.region_map;
2393 start_or_continue(&mut self, "", "> ");
2394 (new_value, region_map)
2397 self.binder_depth += 1;
2398 self.region_index = region_index;
2399 Ok((self, new_value, map))
2402 pub fn pretty_in_binder<T>(self, value: &ty::Binder<'tcx, T>) -> Result<Self, fmt::Error>
2404 T: Print<'tcx, Self, Output = Self, Error = fmt::Error> + TypeFoldable<'tcx>,
2406 let old_region_index = self.region_index;
2407 let (new, new_value, _) = self.name_all_regions(value)?;
2408 let mut inner = new_value.print(new)?;
2409 inner.region_index = old_region_index;
2410 inner.binder_depth -= 1;
2414 pub fn pretty_wrap_binder<T, C: FnOnce(&T, Self) -> Result<Self, fmt::Error>>(
2416 value: &ty::Binder<'tcx, T>,
2418 ) -> Result<Self, fmt::Error>
2420 T: Print<'tcx, Self, Output = Self, Error = fmt::Error> + TypeFoldable<'tcx>,
2422 let old_region_index = self.region_index;
2423 let (new, new_value, _) = self.name_all_regions(value)?;
2424 let mut inner = f(&new_value, new)?;
2425 inner.region_index = old_region_index;
2426 inner.binder_depth -= 1;
2430 fn prepare_region_info<T>(&mut self, value: &ty::Binder<'tcx, T>)
2432 T: TypeVisitable<'tcx>,
2434 struct RegionNameCollector<'tcx> {
2435 used_region_names: FxHashSet<Symbol>,
2436 type_collector: SsoHashSet<Ty<'tcx>>,
2439 impl<'tcx> RegionNameCollector<'tcx> {
2441 RegionNameCollector {
2442 used_region_names: Default::default(),
2443 type_collector: SsoHashSet::new(),
2448 impl<'tcx> ty::visit::TypeVisitor<'tcx> for RegionNameCollector<'tcx> {
2451 fn visit_region(&mut self, r: ty::Region<'tcx>) -> ControlFlow<Self::BreakTy> {
2452 trace!("address: {:p}", r.0.0);
2454 // Collect all named lifetimes. These allow us to prevent duplication
2455 // of already existing lifetime names when introducing names for
2456 // anonymous late-bound regions.
2457 if let Some(name) = r.get_name() {
2458 self.used_region_names.insert(name);
2461 r.super_visit_with(self)
2464 // We collect types in order to prevent really large types from compiling for
2465 // a really long time. See issue #83150 for why this is necessary.
2466 fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
2467 let not_previously_inserted = self.type_collector.insert(ty);
2468 if not_previously_inserted {
2469 ty.super_visit_with(self)
2471 ControlFlow::Continue(())
2476 let mut collector = RegionNameCollector::new();
2477 value.visit_with(&mut collector);
2478 self.used_region_names = collector.used_region_names;
2479 self.region_index = 0;
2483 impl<'tcx, T, P: PrettyPrinter<'tcx>> Print<'tcx, P> for ty::Binder<'tcx, T>
2485 T: Print<'tcx, P, Output = P, Error = P::Error> + TypeFoldable<'tcx>,
2488 type Error = P::Error;
2490 fn print(&self, cx: P) -> Result<Self::Output, Self::Error> {
2495 impl<'tcx, T, U, P: PrettyPrinter<'tcx>> Print<'tcx, P> for ty::OutlivesPredicate<T, U>
2497 T: Print<'tcx, P, Output = P, Error = P::Error>,
2498 U: Print<'tcx, P, Output = P, Error = P::Error>,
2501 type Error = P::Error;
2502 fn print(&self, mut cx: P) -> Result<Self::Output, Self::Error> {
2503 define_scoped_cx!(cx);
2504 p!(print(self.0), ": ", print(self.1));
2509 macro_rules! forward_display_to_print {
2511 // Some of the $ty arguments may not actually use 'tcx
2512 $(#[allow(unused_lifetimes)] impl<'tcx> fmt::Display for $ty {
2513 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2514 ty::tls::with(|tcx| {
2515 let cx = tcx.lift(*self)
2516 .expect("could not lift for printing")
2517 .print(FmtPrinter::new(tcx, Namespace::TypeNS))?;
2518 f.write_str(&cx.into_buffer())?;
2526 macro_rules! define_print_and_forward_display {
2527 (($self:ident, $cx:ident): $($ty:ty $print:block)+) => {
2528 $(impl<'tcx, P: PrettyPrinter<'tcx>> Print<'tcx, P> for $ty {
2530 type Error = fmt::Error;
2531 fn print(&$self, $cx: P) -> Result<Self::Output, Self::Error> {
2532 #[allow(unused_mut)]
2534 define_scoped_cx!($cx);
2536 #[allow(unreachable_code)]
2541 forward_display_to_print!($($ty),+);
2545 /// Wrapper type for `ty::TraitRef` which opts-in to pretty printing only
2546 /// the trait path. That is, it will print `Trait<U>` instead of
2547 /// `<T as Trait<U>>`.
2548 #[derive(Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2549 pub struct TraitRefPrintOnlyTraitPath<'tcx>(ty::TraitRef<'tcx>);
2551 impl<'tcx> fmt::Debug for TraitRefPrintOnlyTraitPath<'tcx> {
2552 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2553 fmt::Display::fmt(self, f)
2557 /// Wrapper type for `ty::TraitRef` which opts-in to pretty printing only
2558 /// the trait name. That is, it will print `Trait` instead of
2559 /// `<T as Trait<U>>`.
2560 #[derive(Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2561 pub struct TraitRefPrintOnlyTraitName<'tcx>(ty::TraitRef<'tcx>);
2563 impl<'tcx> fmt::Debug for TraitRefPrintOnlyTraitName<'tcx> {
2564 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2565 fmt::Display::fmt(self, f)
2569 impl<'tcx> ty::TraitRef<'tcx> {
2570 pub fn print_only_trait_path(self) -> TraitRefPrintOnlyTraitPath<'tcx> {
2571 TraitRefPrintOnlyTraitPath(self)
2574 pub fn print_only_trait_name(self) -> TraitRefPrintOnlyTraitName<'tcx> {
2575 TraitRefPrintOnlyTraitName(self)
2579 impl<'tcx> ty::Binder<'tcx, ty::TraitRef<'tcx>> {
2580 pub fn print_only_trait_path(self) -> ty::Binder<'tcx, TraitRefPrintOnlyTraitPath<'tcx>> {
2581 self.map_bound(|tr| tr.print_only_trait_path())
2585 #[derive(Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2586 pub struct TraitPredPrintModifiersAndPath<'tcx>(ty::TraitPredicate<'tcx>);
2588 impl<'tcx> fmt::Debug for TraitPredPrintModifiersAndPath<'tcx> {
2589 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2590 fmt::Display::fmt(self, f)
2594 impl<'tcx> ty::TraitPredicate<'tcx> {
2595 pub fn print_modifiers_and_trait_path(self) -> TraitPredPrintModifiersAndPath<'tcx> {
2596 TraitPredPrintModifiersAndPath(self)
2600 impl<'tcx> ty::PolyTraitPredicate<'tcx> {
2601 pub fn print_modifiers_and_trait_path(
2603 ) -> ty::Binder<'tcx, TraitPredPrintModifiersAndPath<'tcx>> {
2604 self.map_bound(TraitPredPrintModifiersAndPath)
2608 #[derive(Debug, Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2609 pub struct PrintClosureAsImpl<'tcx> {
2610 pub closure: ty::ClosureSubsts<'tcx>,
2613 forward_display_to_print! {
2616 &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
2619 // HACK(eddyb) these are exhaustive instead of generic,
2620 // because `for<'tcx>` isn't possible yet.
2621 ty::PolyExistentialPredicate<'tcx>,
2622 ty::Binder<'tcx, ty::TraitRef<'tcx>>,
2623 ty::Binder<'tcx, ty::ExistentialTraitRef<'tcx>>,
2624 ty::Binder<'tcx, TraitRefPrintOnlyTraitPath<'tcx>>,
2625 ty::Binder<'tcx, TraitRefPrintOnlyTraitName<'tcx>>,
2626 ty::Binder<'tcx, ty::FnSig<'tcx>>,
2627 ty::Binder<'tcx, ty::TraitPredicate<'tcx>>,
2628 ty::Binder<'tcx, TraitPredPrintModifiersAndPath<'tcx>>,
2629 ty::Binder<'tcx, ty::SubtypePredicate<'tcx>>,
2630 ty::Binder<'tcx, ty::ProjectionPredicate<'tcx>>,
2631 ty::Binder<'tcx, ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>>,
2632 ty::Binder<'tcx, ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>>,
2634 ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>,
2635 ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>
2638 define_print_and_forward_display! {
2641 &'tcx ty::List<Ty<'tcx>> {
2642 p!("{{", comma_sep(self.iter()), "}}")
2645 ty::TypeAndMut<'tcx> {
2646 p!(write("{}", self.mutbl.prefix_str()), print(self.ty))
2649 ty::ExistentialTraitRef<'tcx> {
2650 // Use a type that can't appear in defaults of type parameters.
2651 let dummy_self = cx.tcx().mk_ty_infer(ty::FreshTy(0));
2652 let trait_ref = self.with_self_ty(cx.tcx(), dummy_self);
2653 p!(print(trait_ref.print_only_trait_path()))
2656 ty::ExistentialProjection<'tcx> {
2657 let name = cx.tcx().associated_item(self.def_id).name;
2658 p!(write("{} = ", name), print(self.term))
2661 ty::ExistentialPredicate<'tcx> {
2663 ty::ExistentialPredicate::Trait(x) => p!(print(x)),
2664 ty::ExistentialPredicate::Projection(x) => p!(print(x)),
2665 ty::ExistentialPredicate::AutoTrait(def_id) => {
2666 p!(print_def_path(def_id, &[]));
2672 p!(write("{}", self.unsafety.prefix_str()));
2674 if self.abi != Abi::Rust {
2675 p!(write("extern {} ", self.abi));
2678 p!("fn", pretty_fn_sig(self.inputs(), self.c_variadic, self.output()));
2681 ty::TraitRef<'tcx> {
2682 p!(write("<{} as {}>", self.self_ty(), self.print_only_trait_path()))
2685 TraitRefPrintOnlyTraitPath<'tcx> {
2686 p!(print_def_path(self.0.def_id, self.0.substs));
2689 TraitRefPrintOnlyTraitName<'tcx> {
2690 p!(print_def_path(self.0.def_id, &[]));
2693 TraitPredPrintModifiersAndPath<'tcx> {
2694 if let ty::BoundConstness::ConstIfConst = self.0.constness {
2698 if let ty::ImplPolarity::Negative = self.0.polarity {
2702 p!(print(self.0.trait_ref.print_only_trait_path()));
2705 PrintClosureAsImpl<'tcx> {
2706 p!(pretty_closure_as_impl(self.closure))
2710 p!(write("{}", self.name))
2714 p!(write("{}", self.name))
2717 ty::SubtypePredicate<'tcx> {
2718 p!(print(self.a), " <: ");
2719 cx.reset_type_limit();
2723 ty::CoercePredicate<'tcx> {
2724 p!(print(self.a), " -> ");
2725 cx.reset_type_limit();
2729 ty::TraitPredicate<'tcx> {
2730 p!(print(self.trait_ref.self_ty()), ": ");
2731 if let ty::BoundConstness::ConstIfConst = self.constness && cx.tcx().features().const_trait_impl {
2734 p!(print(self.trait_ref.print_only_trait_path()))
2737 ty::ProjectionPredicate<'tcx> {
2738 p!(print(self.projection_ty), " == ");
2739 cx.reset_type_limit();
2740 p!(print(self.term))
2744 match self.unpack() {
2745 ty::TermKind::Ty(ty) => p!(print(ty)),
2746 ty::TermKind::Const(c) => p!(print(c)),
2751 p!(print_def_path(self.def_id, self.substs));
2756 ty::ClosureKind::Fn => p!("Fn"),
2757 ty::ClosureKind::FnMut => p!("FnMut"),
2758 ty::ClosureKind::FnOnce => p!("FnOnce"),
2762 ty::Predicate<'tcx> {
2763 let binder = self.kind();
2767 ty::PredicateKind<'tcx> {
2769 ty::PredicateKind::Clause(ty::Clause::Trait(ref data)) => {
2772 ty::PredicateKind::Subtype(predicate) => p!(print(predicate)),
2773 ty::PredicateKind::Coerce(predicate) => p!(print(predicate)),
2774 ty::PredicateKind::Clause(ty::Clause::RegionOutlives(predicate)) => p!(print(predicate)),
2775 ty::PredicateKind::Clause(ty::Clause::TypeOutlives(predicate)) => p!(print(predicate)),
2776 ty::PredicateKind::Clause(ty::Clause::Projection(predicate)) => p!(print(predicate)),
2777 ty::PredicateKind::WellFormed(arg) => p!(print(arg), " well-formed"),
2778 ty::PredicateKind::ObjectSafe(trait_def_id) => {
2779 p!("the trait `", print_def_path(trait_def_id, &[]), "` is object-safe")
2781 ty::PredicateKind::ClosureKind(closure_def_id, _closure_substs, kind) => {
2783 print_value_path(closure_def_id, &[]),
2784 write("` implements the trait `{}`", kind))
2786 ty::PredicateKind::ConstEvaluatable(ct) => {
2787 p!("the constant `", print(ct), "` can be evaluated")
2789 ty::PredicateKind::ConstEquate(c1, c2) => {
2790 p!("the constant `", print(c1), "` equals `", print(c2), "`")
2792 ty::PredicateKind::TypeWellFormedFromEnv(ty) => {
2793 p!("the type `", print(ty), "` is found in the environment")
2795 ty::PredicateKind::Ambiguous => p!("ambiguous"),
2800 match self.unpack() {
2801 GenericArgKind::Lifetime(lt) => p!(print(lt)),
2802 GenericArgKind::Type(ty) => p!(print(ty)),
2803 GenericArgKind::Const(ct) => p!(print(ct)),
2808 fn for_each_def(tcx: TyCtxt<'_>, mut collect_fn: impl for<'b> FnMut(&'b Ident, Namespace, DefId)) {
2809 // Iterate all local crate items no matter where they are defined.
2810 let hir = tcx.hir();
2811 for id in hir.items() {
2812 if matches!(tcx.def_kind(id.owner_id), DefKind::Use) {
2816 let item = hir.item(id);
2817 if item.ident.name == kw::Empty {
2821 let def_id = item.owner_id.to_def_id();
2822 let ns = tcx.def_kind(def_id).ns().unwrap_or(Namespace::TypeNS);
2823 collect_fn(&item.ident, ns, def_id);
2826 // Now take care of extern crate items.
2827 let queue = &mut Vec::new();
2828 let mut seen_defs: DefIdSet = Default::default();
2830 for &cnum in tcx.crates(()).iter() {
2831 let def_id = cnum.as_def_id();
2833 // Ignore crates that are not direct dependencies.
2834 match tcx.extern_crate(def_id) {
2836 Some(extern_crate) => {
2837 if !extern_crate.is_direct() {
2846 // Iterate external crate defs but be mindful about visibility
2847 while let Some(def) = queue.pop() {
2848 for child in tcx.module_children(def).iter() {
2849 if !child.vis.is_public() {
2854 def::Res::Def(DefKind::AssocTy, _) => {}
2855 def::Res::Def(DefKind::TyAlias, _) => {}
2856 def::Res::Def(defkind, def_id) => {
2857 if let Some(ns) = defkind.ns() {
2858 collect_fn(&child.ident, ns, def_id);
2861 if matches!(defkind, DefKind::Mod | DefKind::Enum | DefKind::Trait)
2862 && seen_defs.insert(def_id)
2873 /// The purpose of this function is to collect public symbols names that are unique across all
2874 /// crates in the build. Later, when printing about types we can use those names instead of the
2875 /// full exported path to them.
2877 /// So essentially, if a symbol name can only be imported from one place for a type, and as
2878 /// long as it was not glob-imported anywhere in the current crate, we can trim its printed
2879 /// path and print only the name.
2881 /// This has wide implications on error messages with types, for example, shortening
2882 /// `std::vec::Vec` to just `Vec`, as long as there is no other `Vec` importable anywhere.
2884 /// The implementation uses similar import discovery logic to that of 'use' suggestions.
2886 /// See also [`DelayDm`](rustc_error_messages::DelayDm) and [`with_no_trimmed_paths`].
2887 fn trimmed_def_paths(tcx: TyCtxt<'_>, (): ()) -> FxHashMap<DefId, Symbol> {
2888 let mut map: FxHashMap<DefId, Symbol> = FxHashMap::default();
2890 if let TrimmedDefPaths::GoodPath = tcx.sess.opts.trimmed_def_paths {
2891 // Trimming paths is expensive and not optimized, since we expect it to only be used for error reporting.
2893 // For good paths causing this bug, the `rustc_middle::ty::print::with_no_trimmed_paths`
2894 // wrapper can be used to suppress this query, in exchange for full paths being formatted.
2895 tcx.sess.delay_good_path_bug(
2896 "trimmed_def_paths constructed but no error emitted; use `DelayDm` for lints or `with_no_trimmed_paths` for debugging",
2900 let unique_symbols_rev: &mut FxHashMap<(Namespace, Symbol), Option<DefId>> =
2901 &mut FxHashMap::default();
2903 for symbol_set in tcx.resolutions(()).glob_map.values() {
2904 for symbol in symbol_set {
2905 unique_symbols_rev.insert((Namespace::TypeNS, *symbol), None);
2906 unique_symbols_rev.insert((Namespace::ValueNS, *symbol), None);
2907 unique_symbols_rev.insert((Namespace::MacroNS, *symbol), None);
2911 for_each_def(tcx, |ident, ns, def_id| {
2912 use std::collections::hash_map::Entry::{Occupied, Vacant};
2914 match unique_symbols_rev.entry((ns, ident.name)) {
2915 Occupied(mut v) => match v.get() {
2918 if *existing != def_id {
2924 v.insert(Some(def_id));
2929 for ((_, symbol), opt_def_id) in unique_symbols_rev.drain() {
2930 use std::collections::hash_map::Entry::{Occupied, Vacant};
2932 if let Some(def_id) = opt_def_id {
2933 match map.entry(def_id) {
2934 Occupied(mut v) => {
2935 // A single DefId can be known under multiple names (e.g.,
2936 // with a `pub use ... as ...;`). We need to ensure that the
2937 // name placed in this map is chosen deterministically, so
2938 // if we find multiple names (`symbol`) resolving to the
2939 // same `def_id`, we prefer the lexicographically smallest
2942 // Any stable ordering would be fine here though.
2943 if *v.get() != symbol {
2944 if v.get().as_str() > symbol.as_str() {
2959 pub fn provide(providers: &mut ty::query::Providers) {
2960 *providers = ty::query::Providers { trimmed_def_paths, ..*providers };
2964 pub struct OpaqueFnEntry<'tcx> {
2965 // The trait ref is already stored as a key, so just track if we have it as a real predicate
2967 fn_mut_trait_ref: Option<ty::PolyTraitRef<'tcx>>,
2968 fn_trait_ref: Option<ty::PolyTraitRef<'tcx>>,
2969 return_ty: Option<ty::Binder<'tcx, Term<'tcx>>>,