compiler/rustc_middle/src/ty/print/pretty.rs

   1 use crate::mir::interpret::{AllocRange, GlobalAlloc, Pointer, Provenance, Scalar};
   2 use crate::ty::{
   3     self, ConstInt, DefIdTree, ParamConst, ScalarInt, Term, TermKind, Ty, TyCtxt, TypeFoldable,
   4     TypeSuperFoldable, TypeSuperVisitable, TypeVisitable,
   5 };
   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;
  10 use rustc_hir as hir;
  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::{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_target::abi::Size;
  20 use rustc_target::spec::abi::Abi;
  21 use smallvec::SmallVec;
  22
  23 use std::cell::Cell;
  24 use std::char;
  25 use std::collections::BTreeMap;
  26 use std::convert::TryFrom;
  27 use std::fmt::{self, Write as _};
  28 use std::iter;
  29 use std::ops::{ControlFlow, Deref, DerefMut};
  30
  31 // `pretty` is a separate module only for organization.
  32 use super::*;
  33
  34 macro_rules! p {
  35     (@$lit:literal) => {
  36         write!(scoped_cx!(), $lit)?
  37     };
  38     (@write($($data:expr),+)) => {
  39         write!(scoped_cx!(), $($data),+)?
  40     };
  41     (@print($x:expr)) => {
  42         scoped_cx!() = $x.print(scoped_cx!())?
  43     };
  44     (@$method:ident($($arg:expr),*)) => {
  45         scoped_cx!() = scoped_cx!().$method($($arg),*)?
  46     };
  47     ($($elem:tt $(($($args:tt)*))?),+) => {{
  48         $(p!(@ $elem $(($($args)*))?);)+
  49     }};
  50 }
  51 macro_rules! define_scoped_cx {
  52     ($cx:ident) => {
  53         #[allow(unused_macros)]
  54         macro_rules! scoped_cx {
  55             () => {
  56                 $cx
  57             };
  58         }
  59     };
  60 }
  61
  62 thread_local! {
  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 NO_QUERIES: Cell<bool> = const { Cell::new(false) };
  67     static NO_VISIBLE_PATH: Cell<bool> = const { Cell::new(false) };
  68 }
  69
  70 macro_rules! define_helper {
  71     ($($(#[$a:meta])* fn $name:ident($helper:ident, $tl:ident);)+) => {
  72         $(
  73             #[must_use]
  74             pub struct $helper(bool);
  75
  76             impl $helper {
  77                 pub fn new() -> $helper {
  78                     $helper($tl.with(|c| c.replace(true)))
  79                 }
  80             }
  81
  82             $(#[$a])*
  83             pub macro $name($e:expr) {
  84                 {
  85                     let _guard = $helper::new();
  86                     $e
  87                 }
  88             }
  89
  90             impl Drop for $helper {
  91                 fn drop(&mut self) {
  92                     $tl.with(|c| c.set(self.0))
  93                 }
  94             }
  95         )+
  96     }
  97 }
  98
  99 define_helper!(
 100     /// Avoids running any queries during any prints that occur
 101     /// during the closure. This may alter the appearance of some
 102     /// types (e.g. forcing verbose printing for opaque types).
 103     /// This method is used during some queries (e.g. `explicit_item_bounds`
 104     /// for opaque types), to ensure that any debug printing that
 105     /// occurs during the query computation does not end up recursively
 106     /// calling the same query.
 107     fn with_no_queries(NoQueriesGuard, NO_QUERIES);
 108     /// Force us to name impls with just the filename/line number. We
 109     /// normally try to use types. But at some points, notably while printing
 110     /// cycle errors, this can result in extra or suboptimal error output,
 111     /// so this variable disables that check.
 112     fn with_forced_impl_filename_line(ForcedImplGuard, FORCE_IMPL_FILENAME_LINE);
 113     /// Adds the `crate::` prefix to paths where appropriate.
 114     fn with_crate_prefix(CratePrefixGuard, SHOULD_PREFIX_WITH_CRATE);
 115     /// Prevent path trimming if it is turned on. Path trimming affects `Display` impl
 116     /// of various rustc types, for example `std::vec::Vec` would be trimmed to `Vec`,
 117     /// if no other `Vec` is found.
 118     fn with_no_trimmed_paths(NoTrimmedGuard, NO_TRIMMED_PATH);
 119     /// Prevent selection of visible paths. `Display` impl of DefId will prefer
 120     /// visible (public) reexports of types as paths.
 121     fn with_no_visible_paths(NoVisibleGuard, NO_VISIBLE_PATH);
 122 );
 123
 124 /// The "region highlights" are used to control region printing during
 125 /// specific error messages. When a "region highlight" is enabled, it
 126 /// gives an alternate way to print specific regions. For now, we
 127 /// always print those regions using a number, so something like "`'0`".
 128 ///
 129 /// Regions not selected by the region highlight mode are presently
 130 /// unaffected.
 131 #[derive(Copy, Clone)]
 132 pub struct RegionHighlightMode<'tcx> {
 133     tcx: TyCtxt<'tcx>,
 134
 135     /// If enabled, when we see the selected region, use "`'N`"
 136     /// instead of the ordinary behavior.
 137     highlight_regions: [Option<(ty::Region<'tcx>, usize)>; 3],
 138
 139     /// If enabled, when printing a "free region" that originated from
 140     /// the given `ty::BoundRegionKind`, print it as "`'1`". Free regions that would ordinarily
 141     /// have names print as normal.
 142     ///
 143     /// This is used when you have a signature like `fn foo(x: &u32,
 144     /// y: &'a u32)` and we want to give a name to the region of the
 145     /// reference `x`.
 146     highlight_bound_region: Option<(ty::BoundRegionKind, usize)>,
 147 }
 148
 149 impl<'tcx> RegionHighlightMode<'tcx> {
 150     pub fn new(tcx: TyCtxt<'tcx>) -> Self {
 151         Self {
 152             tcx,
 153             highlight_regions: Default::default(),
 154             highlight_bound_region: Default::default(),
 155         }
 156     }
 157
 158     /// If `region` and `number` are both `Some`, invokes
 159     /// `highlighting_region`.
 160     pub fn maybe_highlighting_region(
 161         &mut self,
 162         region: Option<ty::Region<'tcx>>,
 163         number: Option<usize>,
 164     ) {
 165         if let Some(k) = region {
 166             if let Some(n) = number {
 167                 self.highlighting_region(k, n);
 168             }
 169         }
 170     }
 171
 172     /// Highlights the region inference variable `vid` as `'N`.
 173     pub fn highlighting_region(&mut self, region: ty::Region<'tcx>, number: usize) {
 174         let num_slots = self.highlight_regions.len();
 175         let first_avail_slot =
 176             self.highlight_regions.iter_mut().find(|s| s.is_none()).unwrap_or_else(|| {
 177                 bug!("can only highlight {} placeholders at a time", num_slots,)
 178             });
 179         *first_avail_slot = Some((region, number));
 180     }
 181
 182     /// Convenience wrapper for `highlighting_region`.
 183     pub fn highlighting_region_vid(&mut self, vid: ty::RegionVid, number: usize) {
 184         self.highlighting_region(self.tcx.mk_region(ty::ReVar(vid)), number)
 185     }
 186
 187     /// Returns `Some(n)` with the number to use for the given region, if any.
 188     fn region_highlighted(&self, region: ty::Region<'tcx>) -> Option<usize> {
 189         self.highlight_regions.iter().find_map(|h| match h {
 190             Some((r, n)) if *r == region => Some(*n),
 191             _ => None,
 192         })
 193     }
 194
 195     /// Highlight the given bound region.
 196     /// We can only highlight one bound region at a time. See
 197     /// the field `highlight_bound_region` for more detailed notes.
 198     pub fn highlighting_bound_region(&mut self, br: ty::BoundRegionKind, number: usize) {
 199         assert!(self.highlight_bound_region.is_none());
 200         self.highlight_bound_region = Some((br, number));
 201     }
 202 }
 203
 204 /// Trait for printers that pretty-print using `fmt::Write` to the printer.
 205 pub trait PrettyPrinter<'tcx>:
 206     Printer<
 207         'tcx,
 208         Error = fmt::Error,
 209         Path = Self,
 210         Region = Self,
 211         Type = Self,
 212         DynExistential = Self,
 213         Const = Self,
 214     > + fmt::Write
 215 {
 216     /// Like `print_def_path` but for value paths.
 217     fn print_value_path(
 218         self,
 219         def_id: DefId,
 220         substs: &'tcx [GenericArg<'tcx>],
 221     ) -> Result<Self::Path, Self::Error> {
 222         self.print_def_path(def_id, substs)
 223     }
 224
 225     fn in_binder<T>(self, value: &ty::Binder<'tcx, T>) -> Result<Self, Self::Error>
 226     where
 227         T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
 228     {
 229         value.as_ref().skip_binder().print(self)
 230     }
 231
 232     fn wrap_binder<T, F: FnOnce(&T, Self) -> Result<Self, fmt::Error>>(
 233         self,
 234         value: &ty::Binder<'tcx, T>,
 235         f: F,
 236     ) -> Result<Self, Self::Error>
 237     where
 238         T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
 239     {
 240         f(value.as_ref().skip_binder(), self)
 241     }
 242
 243     /// Prints comma-separated elements.
 244     fn comma_sep<T>(mut self, mut elems: impl Iterator<Item = T>) -> Result<Self, Self::Error>
 245     where
 246         T: Print<'tcx, Self, Output = Self, Error = Self::Error>,
 247     {
 248         if let Some(first) = elems.next() {
 249             self = first.print(self)?;
 250             for elem in elems {
 251                 self.write_str(", ")?;
 252                 self = elem.print(self)?;
 253             }
 254         }
 255         Ok(self)
 256     }
 257
 258     /// Prints `{f: t}` or `{f as t}` depending on the `cast` argument
 259     fn typed_value(
 260         mut self,
 261         f: impl FnOnce(Self) -> Result<Self, Self::Error>,
 262         t: impl FnOnce(Self) -> Result<Self, Self::Error>,
 263         conversion: &str,
 264     ) -> Result<Self::Const, Self::Error> {
 265         self.write_str("{")?;
 266         self = f(self)?;
 267         self.write_str(conversion)?;
 268         self = t(self)?;
 269         self.write_str("}")?;
 270         Ok(self)
 271     }
 272
 273     /// Prints `<...>` around what `f` prints.
 274     fn generic_delimiters(
 275         self,
 276         f: impl FnOnce(Self) -> Result<Self, Self::Error>,
 277     ) -> Result<Self, Self::Error>;
 278
 279     /// Returns `true` if the region should be printed in
 280     /// optional positions, e.g., `&'a T` or `dyn Tr + 'b`.
 281     /// This is typically the case for all non-`'_` regions.
 282     fn should_print_region(&self, region: ty::Region<'tcx>) -> bool;
 283
 284     // Defaults (should not be overridden):
 285
 286     /// If possible, this returns a global path resolving to `def_id` that is visible
 287     /// from at least one local module, and returns `true`. If the crate defining `def_id` is
 288     /// declared with an `extern crate`, the path is guaranteed to use the `extern crate`.
 289     fn try_print_visible_def_path(self, def_id: DefId) -> Result<(Self, bool), Self::Error> {
 290         if NO_VISIBLE_PATH.with(|flag| flag.get()) {
 291             return Ok((self, false));
 292         }
 293
 294         let mut callers = Vec::new();
 295         self.try_print_visible_def_path_recur(def_id, &mut callers)
 296     }
 297
 298     /// Try to see if this path can be trimmed to a unique symbol name.
 299     fn try_print_trimmed_def_path(
 300         mut self,
 301         def_id: DefId,
 302     ) -> Result<(Self::Path, bool), Self::Error> {
 303         if !self.tcx().sess.opts.unstable_opts.trim_diagnostic_paths
 304             || matches!(self.tcx().sess.opts.trimmed_def_paths, TrimmedDefPaths::Never)
 305             || NO_TRIMMED_PATH.with(|flag| flag.get())
 306             || SHOULD_PREFIX_WITH_CRATE.with(|flag| flag.get())
 307         {
 308             return Ok((self, false));
 309         }
 310
 311         match self.tcx().trimmed_def_paths(()).get(&def_id) {
 312             None => Ok((self, false)),
 313             Some(symbol) => {
 314                 self.write_str(symbol.as_str())?;
 315                 Ok((self, true))
 316             }
 317         }
 318     }
 319
 320     /// Does the work of `try_print_visible_def_path`, building the
 321     /// full definition path recursively before attempting to
 322     /// post-process it into the valid and visible version that
 323     /// accounts for re-exports.
 324     ///
 325     /// This method should only be called by itself or
 326     /// `try_print_visible_def_path`.
 327     ///
 328     /// `callers` is a chain of visible_parent's leading to `def_id`,
 329     /// to support cycle detection during recursion.
 330     ///
 331     /// This method returns false if we can't print the visible path, so
 332     /// `print_def_path` can fall back on the item's real definition path.
 333     fn try_print_visible_def_path_recur(
 334         mut self,
 335         def_id: DefId,
 336         callers: &mut Vec<DefId>,
 337     ) -> Result<(Self, bool), Self::Error> {
 338         define_scoped_cx!(self);
 339
 340         debug!("try_print_visible_def_path: def_id={:?}", def_id);
 341
 342         // If `def_id` is a direct or injected extern crate, return the
 343         // path to the crate followed by the path to the item within the crate.
 344         if let Some(cnum) = def_id.as_crate_root() {
 345             if cnum == LOCAL_CRATE {
 346                 return Ok((self.path_crate(cnum)?, true));
 347             }
 348
 349             // In local mode, when we encounter a crate other than
 350             // LOCAL_CRATE, execution proceeds in one of two ways:
 351             //
 352             // 1. For a direct dependency, where user added an
 353             //    `extern crate` manually, we put the `extern
 354             //    crate` as the parent. So you wind up with
 355             //    something relative to the current crate.
 356             // 2. For an extern inferred from a path or an indirect crate,
 357             //    where there is no explicit `extern crate`, we just prepend
 358             //    the crate name.
 359             match self.tcx().extern_crate(def_id) {
 360                 Some(&ExternCrate { src, dependency_of, span, .. }) => match (src, dependency_of) {
 361                     (ExternCrateSource::Extern(def_id), LOCAL_CRATE) => {
 362                         // NOTE(eddyb) the only reason `span` might be dummy,
 363                         // that we're aware of, is that it's the `std`/`core`
 364                         // `extern crate` injected by default.
 365                         // FIXME(eddyb) find something better to key this on,
 366                         // or avoid ending up with `ExternCrateSource::Extern`,
 367                         // for the injected `std`/`core`.
 368                         if span.is_dummy() {
 369                             return Ok((self.path_crate(cnum)?, true));
 370                         }
 371
 372                         // Disable `try_print_trimmed_def_path` behavior within
 373                         // the `print_def_path` call, to avoid infinite recursion
 374                         // in cases where the `extern crate foo` has non-trivial
 375                         // parents, e.g. it's nested in `impl foo::Trait for Bar`
 376                         // (see also issues #55779 and #87932).
 377                         self = with_no_visible_paths!(self.print_def_path(def_id, &[])?);
 378
 379                         return Ok((self, true));
 380                     }
 381                     (ExternCrateSource::Path, LOCAL_CRATE) => {
 382                         return Ok((self.path_crate(cnum)?, true));
 383                     }
 384                     _ => {}
 385                 },
 386                 None => {
 387                     return Ok((self.path_crate(cnum)?, true));
 388                 }
 389             }
 390         }
 391
 392         if def_id.is_local() {
 393             return Ok((self, false));
 394         }
 395
 396         let visible_parent_map = self.tcx().visible_parent_map(());
 397
 398         let mut cur_def_key = self.tcx().def_key(def_id);
 399         debug!("try_print_visible_def_path: cur_def_key={:?}", cur_def_key);
 400
 401         // For a constructor, we want the name of its parent rather than <unnamed>.
 402         if let DefPathData::Ctor = cur_def_key.disambiguated_data.data {
 403             let parent = DefId {
 404                 krate: def_id.krate,
 405                 index: cur_def_key
 406                     .parent
 407                     .expect("`DefPathData::Ctor` / `VariantData` missing a parent"),
 408             };
 409
 410             cur_def_key = self.tcx().def_key(parent);
 411         }
 412
 413         let Some(visible_parent) = visible_parent_map.get(&def_id).cloned() else {
 414             return Ok((self, false));
 415         };
 416
 417         let actual_parent = self.tcx().opt_parent(def_id);
 418         debug!(
 419             "try_print_visible_def_path: visible_parent={:?} actual_parent={:?}",
 420             visible_parent, actual_parent,
 421         );
 422
 423         let mut data = cur_def_key.disambiguated_data.data;
 424         debug!(
 425             "try_print_visible_def_path: data={:?} visible_parent={:?} actual_parent={:?}",
 426             data, visible_parent, actual_parent,
 427         );
 428
 429         match data {
 430             // In order to output a path that could actually be imported (valid and visible),
 431             // we need to handle re-exports correctly.
 432             //
 433             // For example, take `std::os::unix::process::CommandExt`, this trait is actually
 434             // defined at `std::sys::unix::ext::process::CommandExt` (at time of writing).
 435             //
 436             // `std::os::unix` reexports the contents of `std::sys::unix::ext`. `std::sys` is
 437             // private so the "true" path to `CommandExt` isn't accessible.
 438             //
 439             // In this case, the `visible_parent_map` will look something like this:
 440             //
 441             // (child) -> (parent)
 442             // `std::sys::unix::ext::process::CommandExt` -> `std::sys::unix::ext::process`
 443             // `std::sys::unix::ext::process` -> `std::sys::unix::ext`
 444             // `std::sys::unix::ext` -> `std::os`
 445             //
 446             // This is correct, as the visible parent of `std::sys::unix::ext` is in fact
 447             // `std::os`.
 448             //
 449             // When printing the path to `CommandExt` and looking at the `cur_def_key` that
 450             // corresponds to `std::sys::unix::ext`, we would normally print `ext` and then go
 451             // to the parent - resulting in a mangled path like
 452             // `std::os::ext::process::CommandExt`.
 453             //
 454             // Instead, we must detect that there was a re-export and instead print `unix`
 455             // (which is the name `std::sys::unix::ext` was re-exported as in `std::os`). To
 456             // do this, we compare the parent of `std::sys::unix::ext` (`std::sys::unix`) with
 457             // the visible parent (`std::os`). If these do not match, then we iterate over
 458             // the children of the visible parent (as was done when computing
 459             // `visible_parent_map`), looking for the specific child we currently have and then
 460             // have access to the re-exported name.
 461             DefPathData::TypeNs(ref mut name) if Some(visible_parent) != actual_parent => {
 462                 // Item might be re-exported several times, but filter for the one
 463                 // that's public and whose identifier isn't `_`.
 464                 let reexport = self
 465                     .tcx()
 466                     .module_children(visible_parent)
 467                     .iter()
 468                     .filter(|child| child.res.opt_def_id() == Some(def_id))
 469                     .find(|child| child.vis.is_public() && child.ident.name != kw::Underscore)
 470                     .map(|child| child.ident.name);
 471
 472                 if let Some(new_name) = reexport {
 473                     *name = new_name;
 474                 } else {
 475                     // There is no name that is public and isn't `_`, so bail.
 476                     return Ok((self, false));
 477                 }
 478             }
 479             // Re-exported `extern crate` (#43189).
 480             DefPathData::CrateRoot => {
 481                 data = DefPathData::TypeNs(self.tcx().crate_name(def_id.krate));
 482             }
 483             _ => {}
 484         }
 485         debug!("try_print_visible_def_path: data={:?}", data);
 486
 487         if callers.contains(&visible_parent) {
 488             return Ok((self, false));
 489         }
 490         callers.push(visible_parent);
 491         // HACK(eddyb) this bypasses `path_append`'s prefix printing to avoid
 492         // knowing ahead of time whether the entire path will succeed or not.
 493         // To support printers that do not implement `PrettyPrinter`, a `Vec` or
 494         // linked list on the stack would need to be built, before any printing.
 495         match self.try_print_visible_def_path_recur(visible_parent, callers)? {
 496             (cx, false) => return Ok((cx, false)),
 497             (cx, true) => self = cx,
 498         }
 499         callers.pop();
 500
 501         Ok((self.path_append(Ok, &DisambiguatedDefPathData { data, disambiguator: 0 })?, true))
 502     }
 503
 504     fn pretty_path_qualified(
 505         self,
 506         self_ty: Ty<'tcx>,
 507         trait_ref: Option<ty::TraitRef<'tcx>>,
 508     ) -> Result<Self::Path, Self::Error> {
 509         if trait_ref.is_none() {
 510             // Inherent impls. Try to print `Foo::bar` for an inherent
 511             // impl on `Foo`, but fallback to `<Foo>::bar` if self-type is
 512             // anything other than a simple path.
 513             match self_ty.kind() {
 514                 ty::Adt(..)
 515                 | ty::Foreign(_)
 516                 | ty::Bool
 517                 | ty::Char
 518                 | ty::Str
 519                 | ty::Int(_)
 520                 | ty::Uint(_)
 521                 | ty::Float(_) => {
 522                     return self_ty.print(self);
 523                 }
 524
 525                 _ => {}
 526             }
 527         }
 528
 529         self.generic_delimiters(|mut cx| {
 530             define_scoped_cx!(cx);
 531
 532             p!(print(self_ty));
 533             if let Some(trait_ref) = trait_ref {
 534                 p!(" as ", print(trait_ref.print_only_trait_path()));
 535             }
 536             Ok(cx)
 537         })
 538     }
 539
 540     fn pretty_path_append_impl(
 541         mut self,
 542         print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
 543         self_ty: Ty<'tcx>,
 544         trait_ref: Option<ty::TraitRef<'tcx>>,
 545     ) -> Result<Self::Path, Self::Error> {
 546         self = print_prefix(self)?;
 547
 548         self.generic_delimiters(|mut cx| {
 549             define_scoped_cx!(cx);
 550
 551             p!("impl ");
 552             if let Some(trait_ref) = trait_ref {
 553                 p!(print(trait_ref.print_only_trait_path()), " for ");
 554             }
 555             p!(print(self_ty));
 556
 557             Ok(cx)
 558         })
 559     }
 560
 561     fn pretty_print_type(mut self, ty: Ty<'tcx>) -> Result<Self::Type, Self::Error> {
 562         define_scoped_cx!(self);
 563
 564         match *ty.kind() {
 565             ty::Bool => p!("bool"),
 566             ty::Char => p!("char"),
 567             ty::Int(t) => p!(write("{}", t.name_str())),
 568             ty::Uint(t) => p!(write("{}", t.name_str())),
 569             ty::Float(t) => p!(write("{}", t.name_str())),
 570             ty::RawPtr(ref tm) => {
 571                 p!(write(
 572                     "*{} ",
 573                     match tm.mutbl {
 574                         hir::Mutability::Mut => "mut",
 575                         hir::Mutability::Not => "const",
 576                     }
 577                 ));
 578                 p!(print(tm.ty))
 579             }
 580             ty::Ref(r, ty, mutbl) => {
 581                 p!("&");
 582                 if self.should_print_region(r) {
 583                     p!(print(r), " ");
 584                 }
 585                 p!(print(ty::TypeAndMut { ty, mutbl }))
 586             }
 587             ty::Never => p!("!"),
 588             ty::Tuple(ref tys) => {
 589                 p!("(", comma_sep(tys.iter()));
 590                 if tys.len() == 1 {
 591                     p!(",");
 592                 }
 593                 p!(")")
 594             }
 595             ty::FnDef(def_id, substs) => {
 596                 let sig = self.tcx().bound_fn_sig(def_id).subst(self.tcx(), substs);
 597                 p!(print(sig), " {{", print_value_path(def_id, substs), "}}");
 598             }
 599             ty::FnPtr(ref bare_fn) => p!(print(bare_fn)),
 600             ty::Infer(infer_ty) => {
 601                 let verbose = self.should_print_verbose();
 602                 if let ty::TyVar(ty_vid) = infer_ty {
 603                     if let Some(name) = self.ty_infer_name(ty_vid) {
 604                         p!(write("{}", name))
 605                     } else {
 606                         if verbose {
 607                             p!(write("{:?}", infer_ty))
 608                         } else {
 609                             p!(write("{}", infer_ty))
 610                         }
 611                     }
 612                 } else {
 613                     if verbose { p!(write("{:?}", infer_ty)) } else { p!(write("{}", infer_ty)) }
 614                 }
 615             }
 616             ty::Error(_) => p!("[type error]"),
 617             ty::Param(ref param_ty) => p!(print(param_ty)),
 618             ty::Bound(debruijn, bound_ty) => match bound_ty.kind {
 619                 ty::BoundTyKind::Anon => self.pretty_print_bound_var(debruijn, bound_ty.var)?,
 620                 ty::BoundTyKind::Param(p) => p!(write("{}", p)),
 621             },
 622             ty::Adt(def, substs) => {
 623                 p!(print_def_path(def.did(), substs));
 624             }
 625             ty::Dynamic(data, r, repr) => {
 626                 let print_r = self.should_print_region(r);
 627                 if print_r {
 628                     p!("(");
 629                 }
 630                 match repr {
 631                     ty::Dyn => p!("dyn "),
 632                     ty::DynStar => p!("dyn* "),
 633                 }
 634                 p!(print(data));
 635                 if print_r {
 636                     p!(" + ", print(r), ")");
 637                 }
 638             }
 639             ty::Foreign(def_id) => {
 640                 p!(print_def_path(def_id, &[]));
 641             }
 642             ty::Projection(ref data) => {
 643                 if !(self.should_print_verbose() || NO_QUERIES.with(|q| q.get()))
 644                     && self.tcx().def_kind(data.item_def_id) == DefKind::ImplTraitPlaceholder
 645                 {
 646                     return self.pretty_print_opaque_impl_type(data.item_def_id, data.substs);
 647                 } else {
 648                     p!(print(data))
 649                 }
 650             }
 651             ty::Placeholder(placeholder) => p!(write("Placeholder({:?})", placeholder)),
 652             ty::Opaque(def_id, substs) => {
 653                 // FIXME(eddyb) print this with `print_def_path`.
 654                 // We use verbose printing in 'NO_QUERIES' mode, to
 655                 // avoid needing to call `predicates_of`. This should
 656                 // only affect certain debug messages (e.g. messages printed
 657                 // from `rustc_middle::ty` during the computation of `tcx.predicates_of`),
 658                 // and should have no effect on any compiler output.
 659                 if self.should_print_verbose() || NO_QUERIES.with(|q| q.get()) {
 660                     p!(write("Opaque({:?}, {:?})", def_id, substs));
 661                     return Ok(self);
 662                 }
 663
 664                 let parent = self.tcx().parent(def_id);
 665                 match self.tcx().def_kind(parent) {
 666                     DefKind::TyAlias | DefKind::AssocTy => {
 667                         if let ty::Opaque(d, _) = *self.tcx().type_of(parent).kind() {
 668                             if d == def_id {
 669                                 // If the type alias directly starts with the `impl` of the
 670                                 // opaque type we're printing, then skip the `::{opaque#1}`.
 671                                 p!(print_def_path(parent, substs));
 672                                 return Ok(self);
 673                             }
 674                         }
 675                         // Complex opaque type, e.g. `type Foo = (i32, impl Debug);`
 676                         p!(print_def_path(def_id, substs));
 677                         return Ok(self);
 678                     }
 679                     _ => return self.pretty_print_opaque_impl_type(def_id, substs),
 680                 }
 681             }
 682             ty::Str => p!("str"),
 683             ty::Generator(did, substs, movability) => {
 684                 p!(write("["));
 685                 let generator_kind = self.tcx().generator_kind(did).unwrap();
 686                 let should_print_movability =
 687                     self.should_print_verbose() || generator_kind == hir::GeneratorKind::Gen;
 688
 689                 if should_print_movability {
 690                     match movability {
 691                         hir::Movability::Movable => {}
 692                         hir::Movability::Static => p!("static "),
 693                     }
 694                 }
 695
 696                 if !self.should_print_verbose() {
 697                     p!(write("{}", generator_kind));
 698                     // FIXME(eddyb) should use `def_span`.
 699                     if let Some(did) = did.as_local() {
 700                         let span = self.tcx().def_span(did);
 701                         p!(write(
 702                             "@{}",
 703                             // This may end up in stderr diagnostics but it may also be emitted
 704                             // into MIR. Hence we use the remapped path if available
 705                             self.tcx().sess.source_map().span_to_embeddable_string(span)
 706                         ));
 707                     } else {
 708                         p!(write("@"), print_def_path(did, substs));
 709                     }
 710                 } else {
 711                     p!(print_def_path(did, substs));
 712                     p!(" upvar_tys=(");
 713                     if !substs.as_generator().is_valid() {
 714                         p!("unavailable");
 715                     } else {
 716                         self = self.comma_sep(substs.as_generator().upvar_tys())?;
 717                     }
 718                     p!(")");
 719
 720                     if substs.as_generator().is_valid() {
 721                         p!(" ", print(substs.as_generator().witness()));
 722                     }
 723                 }
 724
 725                 p!("]")
 726             }
 727             ty::GeneratorWitness(types) => {
 728                 p!(in_binder(&types));
 729             }
 730             ty::Closure(did, substs) => {
 731                 p!(write("["));
 732                 if !self.should_print_verbose() {
 733                     p!(write("closure"));
 734                     // FIXME(eddyb) should use `def_span`.
 735                     if let Some(did) = did.as_local() {
 736                         if self.tcx().sess.opts.unstable_opts.span_free_formats {
 737                             p!("@", print_def_path(did.to_def_id(), substs));
 738                         } else {
 739                             let span = self.tcx().def_span(did);
 740                             p!(write(
 741                                 "@{}",
 742                                 // This may end up in stderr diagnostics but it may also be emitted
 743                                 // into MIR. Hence we use the remapped path if available
 744                                 self.tcx().sess.source_map().span_to_embeddable_string(span)
 745                             ));
 746                         }
 747                     } else {
 748                         p!(write("@"), print_def_path(did, substs));
 749                     }
 750                 } else {
 751                     p!(print_def_path(did, substs));
 752                     if !substs.as_closure().is_valid() {
 753                         p!(" closure_substs=(unavailable)");
 754                         p!(write(" substs={:?}", substs));
 755                     } else {
 756                         p!(" closure_kind_ty=", print(substs.as_closure().kind_ty()));
 757                         p!(
 758                             " closure_sig_as_fn_ptr_ty=",
 759                             print(substs.as_closure().sig_as_fn_ptr_ty())
 760                         );
 761                         p!(" upvar_tys=(");
 762                         self = self.comma_sep(substs.as_closure().upvar_tys())?;
 763                         p!(")");
 764                     }
 765                 }
 766                 p!("]");
 767             }
 768             ty::Array(ty, sz) => {
 769                 p!("[", print(ty), "; ");
 770                 if self.should_print_verbose() {
 771                     p!(write("{:?}", sz));
 772                 } else if let ty::ConstKind::Unevaluated(..) = sz.kind() {
 773                     // Do not try to evaluate unevaluated constants. If we are const evaluating an
 774                     // array length anon const, rustc will (with debug assertions) print the
 775                     // constant's path. Which will end up here again.
 776                     p!("_");
 777                 } else if let Some(n) = sz.kind().try_to_bits(self.tcx().data_layout.pointer_size) {
 778                     p!(write("{}", n));
 779                 } else if let ty::ConstKind::Param(param) = sz.kind() {
 780                     p!(print(param));
 781                 } else {
 782                     p!("_");
 783                 }
 784                 p!("]")
 785             }
 786             ty::Slice(ty) => p!("[", print(ty), "]"),
 787         }
 788
 789         Ok(self)
 790     }
 791
 792     fn pretty_print_opaque_impl_type(
 793         mut self,
 794         def_id: DefId,
 795         substs: &'tcx ty::List<ty::GenericArg<'tcx>>,
 796     ) -> Result<Self::Type, Self::Error> {
 797         let tcx = self.tcx();
 798
 799         // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
 800         // by looking up the projections associated with the def_id.
 801         let bounds = tcx.bound_explicit_item_bounds(def_id);
 802
 803         let mut traits = FxIndexMap::default();
 804         let mut fn_traits = FxIndexMap::default();
 805         let mut is_sized = false;
 806         let mut lifetimes = SmallVec::<[ty::Region<'tcx>; 1]>::new();
 807
 808         for (predicate, _) in bounds.subst_iter_copied(tcx, substs) {
 809             let bound_predicate = predicate.kind();
 810
 811             match bound_predicate.skip_binder() {
 812                 ty::PredicateKind::Trait(pred) => {
 813                     let trait_ref = bound_predicate.rebind(pred.trait_ref);
 814
 815                     // Don't print + Sized, but rather + ?Sized if absent.
 816                     if Some(trait_ref.def_id()) == tcx.lang_items().sized_trait() {
 817                         is_sized = true;
 818                         continue;
 819                     }
 820
 821                     self.insert_trait_and_projection(trait_ref, None, &mut traits, &mut fn_traits);
 822                 }
 823                 ty::PredicateKind::Projection(pred) => {
 824                     let proj_ref = bound_predicate.rebind(pred);
 825                     let trait_ref = proj_ref.required_poly_trait_ref(tcx);
 826
 827                     // Projection type entry -- the def-id for naming, and the ty.
 828                     let proj_ty = (proj_ref.projection_def_id(), proj_ref.term());
 829
 830                     self.insert_trait_and_projection(
 831                         trait_ref,
 832                         Some(proj_ty),
 833                         &mut traits,
 834                         &mut fn_traits,
 835                     );
 836                 }
 837                 ty::PredicateKind::TypeOutlives(outlives) => {
 838                     lifetimes.push(outlives.1);
 839                 }
 840                 _ => {}
 841             }
 842         }
 843
 844         write!(self, "impl ")?;
 845
 846         let mut first = true;
 847         // Insert parenthesis around (Fn(A, B) -> C) if the opaque ty has more than one other trait
 848         let paren_needed = fn_traits.len() > 1 || traits.len() > 0 || !is_sized;
 849
 850         for (fn_once_trait_ref, entry) in fn_traits {
 851             write!(self, "{}", if first { "" } else { " + " })?;
 852             write!(self, "{}", if paren_needed { "(" } else { "" })?;
 853
 854             self = self.wrap_binder(&fn_once_trait_ref, |trait_ref, mut cx| {
 855                 define_scoped_cx!(cx);
 856                 // Get the (single) generic ty (the args) of this FnOnce trait ref.
 857                 let generics = tcx.generics_of(trait_ref.def_id);
 858                 let args = generics.own_substs_no_defaults(tcx, trait_ref.substs);
 859
 860                 match (entry.return_ty, args[0].expect_ty()) {
 861                     // We can only print `impl Fn() -> ()` if we have a tuple of args and we recorded
 862                     // a return type.
 863                     (Some(return_ty), arg_tys) if matches!(arg_tys.kind(), ty::Tuple(_)) => {
 864                         let name = if entry.fn_trait_ref.is_some() {
 865                             "Fn"
 866                         } else if entry.fn_mut_trait_ref.is_some() {
 867                             "FnMut"
 868                         } else {
 869                             "FnOnce"
 870                         };
 871
 872                         p!(write("{}(", name));
 873
 874                         for (idx, ty) in arg_tys.tuple_fields().iter().enumerate() {
 875                             if idx > 0 {
 876                                 p!(", ");
 877                             }
 878                             p!(print(ty));
 879                         }
 880
 881                         p!(")");
 882                         if let Some(ty) = return_ty.skip_binder().ty() {
 883                             if !ty.is_unit() {
 884                                 p!(" -> ", print(return_ty));
 885                             }
 886                         }
 887                         p!(write("{}", if paren_needed { ")" } else { "" }));
 888
 889                         first = false;
 890                     }
 891                     // If we got here, we can't print as a `impl Fn(A, B) -> C`. Just record the
 892                     // trait_refs we collected in the OpaqueFnEntry as normal trait refs.
 893                     _ => {
 894                         if entry.has_fn_once {
 895                             traits.entry(fn_once_trait_ref).or_default().extend(
 896                                 // Group the return ty with its def id, if we had one.
 897                                 entry
 898                                     .return_ty
 899                                     .map(|ty| (tcx.require_lang_item(LangItem::FnOnce, None), ty)),
 900                             );
 901                         }
 902                         if let Some(trait_ref) = entry.fn_mut_trait_ref {
 903                             traits.entry(trait_ref).or_default();
 904                         }
 905                         if let Some(trait_ref) = entry.fn_trait_ref {
 906                             traits.entry(trait_ref).or_default();
 907                         }
 908                     }
 909                 }
 910
 911                 Ok(cx)
 912             })?;
 913         }
 914
 915         // Print the rest of the trait types (that aren't Fn* family of traits)
 916         for (trait_ref, assoc_items) in traits {
 917             write!(self, "{}", if first { "" } else { " + " })?;
 918
 919             self = self.wrap_binder(&trait_ref, |trait_ref, mut cx| {
 920                 define_scoped_cx!(cx);
 921                 p!(print(trait_ref.print_only_trait_name()));
 922
 923                 let generics = tcx.generics_of(trait_ref.def_id);
 924                 let args = generics.own_substs_no_defaults(tcx, trait_ref.substs);
 925
 926                 if !args.is_empty() || !assoc_items.is_empty() {
 927                     let mut first = true;
 928
 929                     for ty in args {
 930                         if first {
 931                             p!("<");
 932                             first = false;
 933                         } else {
 934                             p!(", ");
 935                         }
 936                         p!(print(ty));
 937                     }
 938
 939                     for (assoc_item_def_id, term) in assoc_items {
 940                         // Skip printing `<[generator@] as Generator<_>>::Return` from async blocks,
 941                         // unless we can find out what generator return type it comes from.
 942                         let term = if let Some(ty) = term.skip_binder().ty()
 943                             && let ty::Projection(proj) = ty.kind()
 944                             && let Some(assoc) = tcx.opt_associated_item(proj.item_def_id)
 945                             && assoc.trait_container(tcx) == tcx.lang_items().gen_trait()
 946                             && assoc.name == rustc_span::sym::Return
 947                         {
 948                             if let ty::Generator(_, substs, _) = substs.type_at(0).kind() {
 949                                 let return_ty = substs.as_generator().return_ty();
 950                                 if !return_ty.is_ty_var() {
 951                                     return_ty.into()
 952                                 } else {
 953                                     continue;
 954                                 }
 955                             } else {
 956                                 continue;
 957                             }
 958                         } else {
 959                             term.skip_binder()
 960                         };
 961
 962                         if first {
 963                             p!("<");
 964                             first = false;
 965                         } else {
 966                             p!(", ");
 967                         }
 968
 969                         p!(write("{} = ", tcx.associated_item(assoc_item_def_id).name));
 970
 971                         match term.unpack() {
 972                             TermKind::Ty(ty) => p!(print(ty)),
 973                             TermKind::Const(c) => p!(print(c)),
 974                         };
 975                     }
 976
 977                     if !first {
 978                         p!(">");
 979                     }
 980                 }
 981
 982                 first = false;
 983                 Ok(cx)
 984             })?;
 985         }
 986
 987         if !is_sized {
 988             write!(self, "{}?Sized", if first { "" } else { " + " })?;
 989         } else if first {
 990             write!(self, "Sized")?;
 991         }
 992
 993         for re in lifetimes {
 994             write!(self, " + ")?;
 995             self = self.print_region(re)?;
 996         }
 997
 998         Ok(self)
 999     }
1000
1001     /// Insert the trait ref and optionally a projection type associated with it into either the
1002     /// traits map or fn_traits map, depending on if the trait is in the Fn* family of traits.
1003     fn insert_trait_and_projection(
1004         &mut self,
1005         trait_ref: ty::PolyTraitRef<'tcx>,
1006         proj_ty: Option<(DefId, ty::Binder<'tcx, Term<'tcx>>)>,
1007         traits: &mut FxIndexMap<
1008             ty::PolyTraitRef<'tcx>,
1009             FxIndexMap<DefId, ty::Binder<'tcx, Term<'tcx>>>,
1010         >,
1011         fn_traits: &mut FxIndexMap<ty::PolyTraitRef<'tcx>, OpaqueFnEntry<'tcx>>,
1012     ) {
1013         let trait_def_id = trait_ref.def_id();
1014
1015         // If our trait_ref is FnOnce or any of its children, project it onto the parent FnOnce
1016         // super-trait ref and record it there.
1017         if let Some(fn_once_trait) = self.tcx().lang_items().fn_once_trait() {
1018             // If we have a FnOnce, then insert it into
1019             if trait_def_id == fn_once_trait {
1020                 let entry = fn_traits.entry(trait_ref).or_default();
1021                 // Optionally insert the return_ty as well.
1022                 if let Some((_, ty)) = proj_ty {
1023                     entry.return_ty = Some(ty);
1024                 }
1025                 entry.has_fn_once = true;
1026                 return;
1027             } else if Some(trait_def_id) == self.tcx().lang_items().fn_mut_trait() {
1028                 let super_trait_ref = crate::traits::util::supertraits(self.tcx(), trait_ref)
1029                     .find(|super_trait_ref| super_trait_ref.def_id() == fn_once_trait)
1030                     .unwrap();
1031
1032                 fn_traits.entry(super_trait_ref).or_default().fn_mut_trait_ref = Some(trait_ref);
1033                 return;
1034             } else if Some(trait_def_id) == self.tcx().lang_items().fn_trait() {
1035                 let super_trait_ref = crate::traits::util::supertraits(self.tcx(), trait_ref)
1036                     .find(|super_trait_ref| super_trait_ref.def_id() == fn_once_trait)
1037                     .unwrap();
1038
1039                 fn_traits.entry(super_trait_ref).or_default().fn_trait_ref = Some(trait_ref);
1040                 return;
1041             }
1042         }
1043
1044         // Otherwise, just group our traits and projection types.
1045         traits.entry(trait_ref).or_default().extend(proj_ty);
1046     }
1047
1048     fn pretty_print_bound_var(
1049         &mut self,
1050         debruijn: ty::DebruijnIndex,
1051         var: ty::BoundVar,
1052     ) -> Result<(), Self::Error> {
1053         if debruijn == ty::INNERMOST {
1054             write!(self, "^{}", var.index())
1055         } else {
1056             write!(self, "^{}_{}", debruijn.index(), var.index())
1057         }
1058     }
1059
1060     fn ty_infer_name(&self, _: ty::TyVid) -> Option<Symbol> {
1061         None
1062     }
1063
1064     fn const_infer_name(&self, _: ty::ConstVid<'tcx>) -> Option<Symbol> {
1065         None
1066     }
1067
1068     fn pretty_print_dyn_existential(
1069         mut self,
1070         predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
1071     ) -> Result<Self::DynExistential, Self::Error> {
1072         // Generate the main trait ref, including associated types.
1073         let mut first = true;
1074
1075         if let Some(principal) = predicates.principal() {
1076             self = self.wrap_binder(&principal, |principal, mut cx| {
1077                 define_scoped_cx!(cx);
1078                 p!(print_def_path(principal.def_id, &[]));
1079
1080                 let mut resugared = false;
1081
1082                 // Special-case `Fn(...) -> ...` and re-sugar it.
1083                 let fn_trait_kind = cx.tcx().fn_trait_kind_from_lang_item(principal.def_id);
1084                 if !cx.should_print_verbose() && fn_trait_kind.is_some() {
1085                     if let ty::Tuple(tys) = principal.substs.type_at(0).kind() {
1086                         let mut projections = predicates.projection_bounds();
1087                         if let (Some(proj), None) = (projections.next(), projections.next()) {
1088                             p!(pretty_fn_sig(
1089                                 tys,
1090                                 false,
1091                                 proj.skip_binder().term.ty().expect("Return type was a const")
1092                             ));
1093                             resugared = true;
1094                         }
1095                     }
1096                 }
1097
1098                 // HACK(eddyb) this duplicates `FmtPrinter`'s `path_generic_args`,
1099                 // in order to place the projections inside the `<...>`.
1100                 if !resugared {
1101                     // Use a type that can't appear in defaults of type parameters.
1102                     let dummy_cx = cx.tcx().mk_ty_infer(ty::FreshTy(0));
1103                     let principal = principal.with_self_ty(cx.tcx(), dummy_cx);
1104
1105                     let args = cx
1106                         .tcx()
1107                         .generics_of(principal.def_id)
1108                         .own_substs_no_defaults(cx.tcx(), principal.substs);
1109
1110                     let mut projections = predicates.projection_bounds();
1111
1112                     let mut args = args.iter().cloned();
1113                     let arg0 = args.next();
1114                     let projection0 = projections.next();
1115                     if arg0.is_some() || projection0.is_some() {
1116                         let args = arg0.into_iter().chain(args);
1117                         let projections = projection0.into_iter().chain(projections);
1118
1119                         p!(generic_delimiters(|mut cx| {
1120                             cx = cx.comma_sep(args)?;
1121                             if arg0.is_some() && projection0.is_some() {
1122                                 write!(cx, ", ")?;
1123                             }
1124                             cx.comma_sep(projections)
1125                         }));
1126                     }
1127                 }
1128                 Ok(cx)
1129             })?;
1130
1131             first = false;
1132         }
1133
1134         define_scoped_cx!(self);
1135
1136         // Builtin bounds.
1137         // FIXME(eddyb) avoid printing twice (needed to ensure
1138         // that the auto traits are sorted *and* printed via cx).
1139         let mut auto_traits: Vec<_> = predicates.auto_traits().collect();
1140
1141         // The auto traits come ordered by `DefPathHash`. While
1142         // `DefPathHash` is *stable* in the sense that it depends on
1143         // neither the host nor the phase of the moon, it depends
1144         // "pseudorandomly" on the compiler version and the target.
1145         //
1146         // To avoid causing instabilities in compiletest
1147         // output, sort the auto-traits alphabetically.
1148         auto_traits.sort_by_cached_key(|did| with_no_trimmed_paths!(self.tcx().def_path_str(*did)));
1149
1150         for def_id in auto_traits {
1151             if !first {
1152                 p!(" + ");
1153             }
1154             first = false;
1155
1156             p!(print_def_path(def_id, &[]));
1157         }
1158
1159         Ok(self)
1160     }
1161
1162     fn pretty_fn_sig(
1163         mut self,
1164         inputs: &[Ty<'tcx>],
1165         c_variadic: bool,
1166         output: Ty<'tcx>,
1167     ) -> Result<Self, Self::Error> {
1168         define_scoped_cx!(self);
1169
1170         p!("(", comma_sep(inputs.iter().copied()));
1171         if c_variadic {
1172             if !inputs.is_empty() {
1173                 p!(", ");
1174             }
1175             p!("...");
1176         }
1177         p!(")");
1178         if !output.is_unit() {
1179             p!(" -> ", print(output));
1180         }
1181
1182         Ok(self)
1183     }
1184
1185     fn pretty_print_const(
1186         mut self,
1187         ct: ty::Const<'tcx>,
1188         print_ty: bool,
1189     ) -> Result<Self::Const, Self::Error> {
1190         define_scoped_cx!(self);
1191
1192         if self.should_print_verbose() {
1193             p!(write("Const({:?}: {:?})", ct.kind(), ct.ty()));
1194             return Ok(self);
1195         }
1196
1197         macro_rules! print_underscore {
1198             () => {{
1199                 if print_ty {
1200                     self = self.typed_value(
1201                         |mut this| {
1202                             write!(this, "_")?;
1203                             Ok(this)
1204                         },
1205                         |this| this.print_type(ct.ty()),
1206                         ": ",
1207                     )?;
1208                 } else {
1209                     write!(self, "_")?;
1210                 }
1211             }};
1212         }
1213
1214         match ct.kind() {
1215             ty::ConstKind::Unevaluated(ty::UnevaluatedConst { def, substs }) => {
1216                 match self.tcx().def_kind(def.did) {
1217                     DefKind::Static(..) | DefKind::Const | DefKind::AssocConst => {
1218                         p!(print_value_path(def.did, substs))
1219                     }
1220                     _ => {
1221                         if def.is_local() {
1222                             let span = self.tcx().def_span(def.did);
1223                             if let Ok(snip) = self.tcx().sess.source_map().span_to_snippet(span) {
1224                                 p!(write("{}", snip))
1225                             } else {
1226                                 print_underscore!()
1227                             }
1228                         } else {
1229                             print_underscore!()
1230                         }
1231                     }
1232                 }
1233             }
1234             ty::ConstKind::Infer(infer_ct) => {
1235                 match infer_ct {
1236                     ty::InferConst::Var(ct_vid)
1237                         if let Some(name) = self.const_infer_name(ct_vid) =>
1238                             p!(write("{}", name)),
1239                     _ => print_underscore!(),
1240                 }
1241             }
1242             ty::ConstKind::Param(ParamConst { name, .. }) => p!(write("{}", name)),
1243             ty::ConstKind::Value(value) => {
1244                 return self.pretty_print_const_valtree(value, ct.ty(), print_ty);
1245             }
1246
1247             ty::ConstKind::Bound(debruijn, bound_var) => {
1248                 self.pretty_print_bound_var(debruijn, bound_var)?
1249             }
1250             ty::ConstKind::Placeholder(placeholder) => p!(write("Placeholder({:?})", placeholder)),
1251             ty::ConstKind::Error(_) => p!("[const error]"),
1252         };
1253         Ok(self)
1254     }
1255
1256     fn pretty_print_const_scalar(
1257         self,
1258         scalar: Scalar,
1259         ty: Ty<'tcx>,
1260         print_ty: bool,
1261     ) -> Result<Self::Const, Self::Error> {
1262         match scalar {
1263             Scalar::Ptr(ptr, _size) => self.pretty_print_const_scalar_ptr(ptr, ty, print_ty),
1264             Scalar::Int(int) => self.pretty_print_const_scalar_int(int, ty, print_ty),
1265         }
1266     }
1267
1268     fn pretty_print_const_scalar_ptr(
1269         mut self,
1270         ptr: Pointer,
1271         ty: Ty<'tcx>,
1272         print_ty: bool,
1273     ) -> Result<Self::Const, Self::Error> {
1274         define_scoped_cx!(self);
1275
1276         let (alloc_id, offset) = ptr.into_parts();
1277         match ty.kind() {
1278             // Byte strings (&[u8; N])
1279             ty::Ref(_, inner, _) => {
1280                 if let ty::Array(elem, len) = inner.kind() {
1281                     if let ty::Uint(ty::UintTy::U8) = elem.kind() {
1282                         if let ty::ConstKind::Value(ty::ValTree::Leaf(int)) = len.kind() {
1283                             match self.tcx().try_get_global_alloc(alloc_id) {
1284                                 Some(GlobalAlloc::Memory(alloc)) => {
1285                                     let len = int.assert_bits(self.tcx().data_layout.pointer_size);
1286                                     let range =
1287                                         AllocRange { start: offset, size: Size::from_bytes(len) };
1288                                     if let Ok(byte_str) =
1289                                         alloc.inner().get_bytes_strip_provenance(&self.tcx(), range)
1290                                     {
1291                                         p!(pretty_print_byte_str(byte_str))
1292                                     } else {
1293                                         p!("<too short allocation>")
1294                                     }
1295                                 }
1296                                 // FIXME: for statics, vtables, and functions, we could in principle print more detail.
1297                                 Some(GlobalAlloc::Static(def_id)) => {
1298                                     p!(write("<static({:?})>", def_id))
1299                                 }
1300                                 Some(GlobalAlloc::Function(_)) => p!("<function>"),
1301                                 Some(GlobalAlloc::VTable(..)) => p!("<vtable>"),
1302                                 None => p!("<dangling pointer>"),
1303                             }
1304                             return Ok(self);
1305                         }
1306                     }
1307                 }
1308             }
1309             ty::FnPtr(_) => {
1310                 // FIXME: We should probably have a helper method to share code with the "Byte strings"
1311                 // printing above (which also has to handle pointers to all sorts of things).
1312                 if let Some(GlobalAlloc::Function(instance)) =
1313                     self.tcx().try_get_global_alloc(alloc_id)
1314                 {
1315                     self = self.typed_value(
1316                         |this| this.print_value_path(instance.def_id(), instance.substs),
1317                         |this| this.print_type(ty),
1318                         " as ",
1319                     )?;
1320                     return Ok(self);
1321                 }
1322             }
1323             _ => {}
1324         }
1325         // Any pointer values not covered by a branch above
1326         self = self.pretty_print_const_pointer(ptr, ty, print_ty)?;
1327         Ok(self)
1328     }
1329
1330     fn pretty_print_const_scalar_int(
1331         mut self,
1332         int: ScalarInt,
1333         ty: Ty<'tcx>,
1334         print_ty: bool,
1335     ) -> Result<Self::Const, Self::Error> {
1336         define_scoped_cx!(self);
1337
1338         match ty.kind() {
1339             // Bool
1340             ty::Bool if int == ScalarInt::FALSE => p!("false"),
1341             ty::Bool if int == ScalarInt::TRUE => p!("true"),
1342             // Float
1343             ty::Float(ty::FloatTy::F32) => {
1344                 p!(write("{}f32", Single::try_from(int).unwrap()))
1345             }
1346             ty::Float(ty::FloatTy::F64) => {
1347                 p!(write("{}f64", Double::try_from(int).unwrap()))
1348             }
1349             // Int
1350             ty::Uint(_) | ty::Int(_) => {
1351                 let int =
1352                     ConstInt::new(int, matches!(ty.kind(), ty::Int(_)), ty.is_ptr_sized_integral());
1353                 if print_ty { p!(write("{:#?}", int)) } else { p!(write("{:?}", int)) }
1354             }
1355             // Char
1356             ty::Char if char::try_from(int).is_ok() => {
1357                 p!(write("{:?}", char::try_from(int).unwrap()))
1358             }
1359             // Pointer types
1360             ty::Ref(..) | ty::RawPtr(_) | ty::FnPtr(_) => {
1361                 let data = int.assert_bits(self.tcx().data_layout.pointer_size);
1362                 self = self.typed_value(
1363                     |mut this| {
1364                         write!(this, "0x{:x}", data)?;
1365                         Ok(this)
1366                     },
1367                     |this| this.print_type(ty),
1368                     " as ",
1369                 )?;
1370             }
1371             // Nontrivial types with scalar bit representation
1372             _ => {
1373                 let print = |mut this: Self| {
1374                     if int.size() == Size::ZERO {
1375                         write!(this, "transmute(())")?;
1376                     } else {
1377                         write!(this, "transmute(0x{:x})", int)?;
1378                     }
1379                     Ok(this)
1380                 };
1381                 self = if print_ty {
1382                     self.typed_value(print, |this| this.print_type(ty), ": ")?
1383                 } else {
1384                     print(self)?
1385                 };
1386             }
1387         }
1388         Ok(self)
1389     }
1390
1391     /// This is overridden for MIR printing because we only want to hide alloc ids from users, not
1392     /// from MIR where it is actually useful.
1393     fn pretty_print_const_pointer<Prov: Provenance>(
1394         mut self,
1395         _: Pointer<Prov>,
1396         ty: Ty<'tcx>,
1397         print_ty: bool,
1398     ) -> Result<Self::Const, Self::Error> {
1399         if print_ty {
1400             self.typed_value(
1401                 |mut this| {
1402                     this.write_str("&_")?;
1403                     Ok(this)
1404                 },
1405                 |this| this.print_type(ty),
1406                 ": ",
1407             )
1408         } else {
1409             self.write_str("&_")?;
1410             Ok(self)
1411         }
1412     }
1413
1414     fn pretty_print_byte_str(mut self, byte_str: &'tcx [u8]) -> Result<Self::Const, Self::Error> {
1415         write!(self, "b\"{}\"", byte_str.escape_ascii())?;
1416         Ok(self)
1417     }
1418
1419     fn pretty_print_const_valtree(
1420         mut self,
1421         valtree: ty::ValTree<'tcx>,
1422         ty: Ty<'tcx>,
1423         print_ty: bool,
1424     ) -> Result<Self::Const, Self::Error> {
1425         define_scoped_cx!(self);
1426
1427         if self.should_print_verbose() {
1428             p!(write("ValTree({:?}: ", valtree), print(ty), ")");
1429             return Ok(self);
1430         }
1431
1432         let u8_type = self.tcx().types.u8;
1433         match (valtree, ty.kind()) {
1434             (ty::ValTree::Branch(_), ty::Ref(_, inner_ty, _)) => match inner_ty.kind() {
1435                 ty::Slice(t) if *t == u8_type => {
1436                     let bytes = valtree.try_to_raw_bytes(self.tcx(), ty).unwrap_or_else(|| {
1437                         bug!(
1438                             "expected to convert valtree {:?} to raw bytes for type {:?}",
1439                             valtree,
1440                             t
1441                         )
1442                     });
1443                     return self.pretty_print_byte_str(bytes);
1444                 }
1445                 ty::Str => {
1446                     let bytes = valtree.try_to_raw_bytes(self.tcx(), ty).unwrap_or_else(|| {
1447                         bug!("expected to convert valtree to raw bytes for type {:?}", ty)
1448                     });
1449                     p!(write("{:?}", String::from_utf8_lossy(bytes)));
1450                     return Ok(self);
1451                 }
1452                 _ => {
1453                     p!("&");
1454                     p!(pretty_print_const_valtree(valtree, *inner_ty, print_ty));
1455                     return Ok(self);
1456                 }
1457             },
1458             (ty::ValTree::Branch(_), ty::Array(t, _)) if *t == u8_type => {
1459                 let bytes = valtree.try_to_raw_bytes(self.tcx(), ty).unwrap_or_else(|| {
1460                     bug!("expected to convert valtree to raw bytes for type {:?}", t)
1461                 });
1462                 p!("*");
1463                 p!(pretty_print_byte_str(bytes));
1464                 return Ok(self);
1465             }
1466             // Aggregates, printed as array/tuple/struct/variant construction syntax.
1467             (ty::ValTree::Branch(_), ty::Array(..) | ty::Tuple(..) | ty::Adt(..)) => {
1468                 let contents =
1469                     self.tcx().destructure_const(ty::Const::from_value(self.tcx(), valtree, ty));
1470                 let fields = contents.fields.iter().copied();
1471                 match *ty.kind() {
1472                     ty::Array(..) => {
1473                         p!("[", comma_sep(fields), "]");
1474                     }
1475                     ty::Tuple(..) => {
1476                         p!("(", comma_sep(fields));
1477                         if contents.fields.len() == 1 {
1478                             p!(",");
1479                         }
1480                         p!(")");
1481                     }
1482                     ty::Adt(def, _) if def.variants().is_empty() => {
1483                         self = self.typed_value(
1484                             |mut this| {
1485                                 write!(this, "unreachable()")?;
1486                                 Ok(this)
1487                             },
1488                             |this| this.print_type(ty),
1489                             ": ",
1490                         )?;
1491                     }
1492                     ty::Adt(def, substs) => {
1493                         let variant_idx =
1494                             contents.variant.expect("destructed const of adt without variant idx");
1495                         let variant_def = &def.variant(variant_idx);
1496                         p!(print_value_path(variant_def.def_id, substs));
1497                         match variant_def.ctor_kind() {
1498                             Some(CtorKind::Const) => {}
1499                             Some(CtorKind::Fn) => {
1500                                 p!("(", comma_sep(fields), ")");
1501                             }
1502                             None => {
1503                                 p!(" {{ ");
1504                                 let mut first = true;
1505                                 for (field_def, field) in iter::zip(&variant_def.fields, fields) {
1506                                     if !first {
1507                                         p!(", ");
1508                                     }
1509                                     p!(write("{}: ", field_def.name), print(field));
1510                                     first = false;
1511                                 }
1512                                 p!(" }}");
1513                             }
1514                         }
1515                     }
1516                     _ => unreachable!(),
1517                 }
1518                 return Ok(self);
1519             }
1520             (ty::ValTree::Leaf(leaf), ty::Ref(_, inner_ty, _)) => {
1521                 p!(write("&"));
1522                 return self.pretty_print_const_scalar_int(leaf, *inner_ty, print_ty);
1523             }
1524             (ty::ValTree::Leaf(leaf), _) => {
1525                 return self.pretty_print_const_scalar_int(leaf, ty, print_ty);
1526             }
1527             // FIXME(oli-obk): also pretty print arrays and other aggregate constants by reading
1528             // their fields instead of just dumping the memory.
1529             _ => {}
1530         }
1531
1532         // fallback
1533         if valtree == ty::ValTree::zst() {
1534             p!(write("<ZST>"));
1535         } else {
1536             p!(write("{:?}", valtree));
1537         }
1538         if print_ty {
1539             p!(": ", print(ty));
1540         }
1541         Ok(self)
1542     }
1543
1544     fn pretty_closure_as_impl(
1545         mut self,
1546         closure: ty::ClosureSubsts<'tcx>,
1547     ) -> Result<Self::Const, Self::Error> {
1548         let sig = closure.sig();
1549         let kind = closure.kind_ty().to_opt_closure_kind().unwrap_or(ty::ClosureKind::Fn);
1550
1551         write!(self, "impl ")?;
1552         self.wrap_binder(&sig, |sig, mut cx| {
1553             define_scoped_cx!(cx);
1554
1555             p!(print(kind), "(");
1556             for (i, arg) in sig.inputs()[0].tuple_fields().iter().enumerate() {
1557                 if i > 0 {
1558                     p!(", ");
1559                 }
1560                 p!(print(arg));
1561             }
1562             p!(")");
1563
1564             if !sig.output().is_unit() {
1565                 p!(" -> ", print(sig.output()));
1566             }
1567
1568             Ok(cx)
1569         })
1570     }
1571
1572     fn should_print_verbose(&self) -> bool {
1573         self.tcx().sess.verbose()
1574     }
1575 }
1576
1577 // HACK(eddyb) boxed to avoid moving around a large struct by-value.
1578 pub struct FmtPrinter<'a, 'tcx>(Box<FmtPrinterData<'a, 'tcx>>);
1579
1580 pub struct FmtPrinterData<'a, 'tcx> {
1581     tcx: TyCtxt<'tcx>,
1582     fmt: String,
1583
1584     empty_path: bool,
1585     in_value: bool,
1586     pub print_alloc_ids: bool,
1587
1588     // set of all named (non-anonymous) region names
1589     used_region_names: FxHashSet<Symbol>,
1590
1591     region_index: usize,
1592     binder_depth: usize,
1593     printed_type_count: usize,
1594     type_length_limit: Limit,
1595     truncated: bool,
1596
1597     pub region_highlight_mode: RegionHighlightMode<'tcx>,
1598
1599     pub ty_infer_name_resolver: Option<Box<dyn Fn(ty::TyVid) -> Option<Symbol> + 'a>>,
1600     pub const_infer_name_resolver: Option<Box<dyn Fn(ty::ConstVid<'tcx>) -> Option<Symbol> + 'a>>,
1601 }
1602
1603 impl<'a, 'tcx> Deref for FmtPrinter<'a, 'tcx> {
1604     type Target = FmtPrinterData<'a, 'tcx>;
1605     fn deref(&self) -> &Self::Target {
1606         &self.0
1607     }
1608 }
1609
1610 impl DerefMut for FmtPrinter<'_, '_> {
1611     fn deref_mut(&mut self) -> &mut Self::Target {
1612         &mut self.0
1613     }
1614 }
1615
1616 impl<'a, 'tcx> FmtPrinter<'a, 'tcx> {
1617     pub fn new(tcx: TyCtxt<'tcx>, ns: Namespace) -> Self {
1618         Self::new_with_limit(tcx, ns, tcx.type_length_limit())
1619     }
1620
1621     pub fn new_with_limit(tcx: TyCtxt<'tcx>, ns: Namespace, type_length_limit: Limit) -> Self {
1622         FmtPrinter(Box::new(FmtPrinterData {
1623             tcx,
1624             // Estimated reasonable capacity to allocate upfront based on a few
1625             // benchmarks.
1626             fmt: String::with_capacity(64),
1627             empty_path: false,
1628             in_value: ns == Namespace::ValueNS,
1629             print_alloc_ids: false,
1630             used_region_names: Default::default(),
1631             region_index: 0,
1632             binder_depth: 0,
1633             printed_type_count: 0,
1634             type_length_limit,
1635             truncated: false,
1636             region_highlight_mode: RegionHighlightMode::new(tcx),
1637             ty_infer_name_resolver: None,
1638             const_infer_name_resolver: None,
1639         }))
1640     }
1641
1642     pub fn into_buffer(self) -> String {
1643         self.0.fmt
1644     }
1645 }
1646
1647 // HACK(eddyb) get rid of `def_path_str` and/or pass `Namespace` explicitly always
1648 // (but also some things just print a `DefId` generally so maybe we need this?)
1649 fn guess_def_namespace(tcx: TyCtxt<'_>, def_id: DefId) -> Namespace {
1650     match tcx.def_key(def_id).disambiguated_data.data {
1651         DefPathData::TypeNs(..) | DefPathData::CrateRoot | DefPathData::ImplTrait => {
1652             Namespace::TypeNS
1653         }
1654
1655         DefPathData::ValueNs(..)
1656         | DefPathData::AnonConst
1657         | DefPathData::ClosureExpr
1658         | DefPathData::Ctor => Namespace::ValueNS,
1659
1660         DefPathData::MacroNs(..) => Namespace::MacroNS,
1661
1662         _ => Namespace::TypeNS,
1663     }
1664 }
1665
1666 impl<'t> TyCtxt<'t> {
1667     /// Returns a string identifying this `DefId`. This string is
1668     /// suitable for user output.
1669     pub fn def_path_str(self, def_id: DefId) -> String {
1670         self.def_path_str_with_substs(def_id, &[])
1671     }
1672
1673     pub fn def_path_str_with_substs(self, def_id: DefId, substs: &'t [GenericArg<'t>]) -> String {
1674         let ns = guess_def_namespace(self, def_id);
1675         debug!("def_path_str: def_id={:?}, ns={:?}", def_id, ns);
1676         FmtPrinter::new(self, ns).print_def_path(def_id, substs).unwrap().into_buffer()
1677     }
1678
1679     pub fn value_path_str_with_substs(self, def_id: DefId, substs: &'t [GenericArg<'t>]) -> String {
1680         let ns = guess_def_namespace(self, def_id);
1681         debug!("value_path_str: def_id={:?}, ns={:?}", def_id, ns);
1682         FmtPrinter::new(self, ns).print_value_path(def_id, substs).unwrap().into_buffer()
1683     }
1684 }
1685
1686 impl fmt::Write for FmtPrinter<'_, '_> {
1687     fn write_str(&mut self, s: &str) -> fmt::Result {
1688         self.fmt.push_str(s);
1689         Ok(())
1690     }
1691 }
1692
1693 impl<'tcx> Printer<'tcx> for FmtPrinter<'_, 'tcx> {
1694     type Error = fmt::Error;
1695
1696     type Path = Self;
1697     type Region = Self;
1698     type Type = Self;
1699     type DynExistential = Self;
1700     type Const = Self;
1701
1702     fn tcx<'a>(&'a self) -> TyCtxt<'tcx> {
1703         self.tcx
1704     }
1705
1706     fn print_def_path(
1707         mut self,
1708         def_id: DefId,
1709         substs: &'tcx [GenericArg<'tcx>],
1710     ) -> Result<Self::Path, Self::Error> {
1711         define_scoped_cx!(self);
1712
1713         if substs.is_empty() {
1714             match self.try_print_trimmed_def_path(def_id)? {
1715                 (cx, true) => return Ok(cx),
1716                 (cx, false) => self = cx,
1717             }
1718
1719             match self.try_print_visible_def_path(def_id)? {
1720                 (cx, true) => return Ok(cx),
1721                 (cx, false) => self = cx,
1722             }
1723         }
1724
1725         let key = self.tcx.def_key(def_id);
1726         if let DefPathData::Impl = key.disambiguated_data.data {
1727             // Always use types for non-local impls, where types are always
1728             // available, and filename/line-number is mostly uninteresting.
1729             let use_types = !def_id.is_local() || {
1730                 // Otherwise, use filename/line-number if forced.
1731                 let force_no_types = FORCE_IMPL_FILENAME_LINE.with(|f| f.get());
1732                 !force_no_types
1733             };
1734
1735             if !use_types {
1736                 // If no type info is available, fall back to
1737                 // pretty printing some span information. This should
1738                 // only occur very early in the compiler pipeline.
1739                 let parent_def_id = DefId { index: key.parent.unwrap(), ..def_id };
1740                 let span = self.tcx.def_span(def_id);
1741
1742                 self = self.print_def_path(parent_def_id, &[])?;
1743
1744                 // HACK(eddyb) copy of `path_append` to avoid
1745                 // constructing a `DisambiguatedDefPathData`.
1746                 if !self.empty_path {
1747                     write!(self, "::")?;
1748                 }
1749                 write!(
1750                     self,
1751                     "<impl at {}>",
1752                     // This may end up in stderr diagnostics but it may also be emitted
1753                     // into MIR. Hence we use the remapped path if available
1754                     self.tcx.sess.source_map().span_to_embeddable_string(span)
1755                 )?;
1756                 self.empty_path = false;
1757
1758                 return Ok(self);
1759             }
1760         }
1761
1762         self.default_print_def_path(def_id, substs)
1763     }
1764
1765     fn print_region(self, region: ty::Region<'tcx>) -> Result<Self::Region, Self::Error> {
1766         self.pretty_print_region(region)
1767     }
1768
1769     fn print_type(mut self, ty: Ty<'tcx>) -> Result<Self::Type, Self::Error> {
1770         if self.type_length_limit.value_within_limit(self.printed_type_count) {
1771             self.printed_type_count += 1;
1772             self.pretty_print_type(ty)
1773         } else {
1774             self.truncated = true;
1775             write!(self, "...")?;
1776             Ok(self)
1777         }
1778     }
1779
1780     fn print_dyn_existential(
1781         self,
1782         predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
1783     ) -> Result<Self::DynExistential, Self::Error> {
1784         self.pretty_print_dyn_existential(predicates)
1785     }
1786
1787     fn print_const(self, ct: ty::Const<'tcx>) -> Result<Self::Const, Self::Error> {
1788         self.pretty_print_const(ct, false)
1789     }
1790
1791     fn path_crate(mut self, cnum: CrateNum) -> Result<Self::Path, Self::Error> {
1792         self.empty_path = true;
1793         if cnum == LOCAL_CRATE {
1794             if self.tcx.sess.rust_2018() {
1795                 // We add the `crate::` keyword on Rust 2018, only when desired.
1796                 if SHOULD_PREFIX_WITH_CRATE.with(|flag| flag.get()) {
1797                     write!(self, "{}", kw::Crate)?;
1798                     self.empty_path = false;
1799                 }
1800             }
1801         } else {
1802             write!(self, "{}", self.tcx.crate_name(cnum))?;
1803             self.empty_path = false;
1804         }
1805         Ok(self)
1806     }
1807
1808     fn path_qualified(
1809         mut self,
1810         self_ty: Ty<'tcx>,
1811         trait_ref: Option<ty::TraitRef<'tcx>>,
1812     ) -> Result<Self::Path, Self::Error> {
1813         self = self.pretty_path_qualified(self_ty, trait_ref)?;
1814         self.empty_path = false;
1815         Ok(self)
1816     }
1817
1818     fn path_append_impl(
1819         mut self,
1820         print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1821         _disambiguated_data: &DisambiguatedDefPathData,
1822         self_ty: Ty<'tcx>,
1823         trait_ref: Option<ty::TraitRef<'tcx>>,
1824     ) -> Result<Self::Path, Self::Error> {
1825         self = self.pretty_path_append_impl(
1826             |mut cx| {
1827                 cx = print_prefix(cx)?;
1828                 if !cx.empty_path {
1829                     write!(cx, "::")?;
1830                 }
1831
1832                 Ok(cx)
1833             },
1834             self_ty,
1835             trait_ref,
1836         )?;
1837         self.empty_path = false;
1838         Ok(self)
1839     }
1840
1841     fn path_append(
1842         mut self,
1843         print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1844         disambiguated_data: &DisambiguatedDefPathData,
1845     ) -> Result<Self::Path, Self::Error> {
1846         self = print_prefix(self)?;
1847
1848         // Skip `::{{extern}}` blocks and `::{{constructor}}` on tuple/unit structs.
1849         if let DefPathData::ForeignMod | DefPathData::Ctor = disambiguated_data.data {
1850             return Ok(self);
1851         }
1852
1853         let name = disambiguated_data.data.name();
1854         if !self.empty_path {
1855             write!(self, "::")?;
1856         }
1857
1858         if let DefPathDataName::Named(name) = name {
1859             if Ident::with_dummy_span(name).is_raw_guess() {
1860                 write!(self, "r#")?;
1861             }
1862         }
1863
1864         let verbose = self.should_print_verbose();
1865         disambiguated_data.fmt_maybe_verbose(&mut self, verbose)?;
1866
1867         self.empty_path = false;
1868
1869         Ok(self)
1870     }
1871
1872     fn path_generic_args(
1873         mut self,
1874         print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1875         args: &[GenericArg<'tcx>],
1876     ) -> Result<Self::Path, Self::Error> {
1877         self = print_prefix(self)?;
1878
1879         if args.first().is_some() {
1880             if self.in_value {
1881                 write!(self, "::")?;
1882             }
1883             self.generic_delimiters(|cx| cx.comma_sep(args.iter().cloned()))
1884         } else {
1885             Ok(self)
1886         }
1887     }
1888 }
1889
1890 impl<'tcx> PrettyPrinter<'tcx> for FmtPrinter<'_, 'tcx> {
1891     fn ty_infer_name(&self, id: ty::TyVid) -> Option<Symbol> {
1892         self.0.ty_infer_name_resolver.as_ref().and_then(|func| func(id))
1893     }
1894
1895     fn const_infer_name(&self, id: ty::ConstVid<'tcx>) -> Option<Symbol> {
1896         self.0.const_infer_name_resolver.as_ref().and_then(|func| func(id))
1897     }
1898
1899     fn print_value_path(
1900         mut self,
1901         def_id: DefId,
1902         substs: &'tcx [GenericArg<'tcx>],
1903     ) -> Result<Self::Path, Self::Error> {
1904         let was_in_value = std::mem::replace(&mut self.in_value, true);
1905         self = self.print_def_path(def_id, substs)?;
1906         self.in_value = was_in_value;
1907
1908         Ok(self)
1909     }
1910
1911     fn in_binder<T>(self, value: &ty::Binder<'tcx, T>) -> Result<Self, Self::Error>
1912     where
1913         T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
1914     {
1915         self.pretty_in_binder(value)
1916     }
1917
1918     fn wrap_binder<T, C: FnOnce(&T, Self) -> Result<Self, Self::Error>>(
1919         self,
1920         value: &ty::Binder<'tcx, T>,
1921         f: C,
1922     ) -> Result<Self, Self::Error>
1923     where
1924         T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>,
1925     {
1926         self.pretty_wrap_binder(value, f)
1927     }
1928
1929     fn typed_value(
1930         mut self,
1931         f: impl FnOnce(Self) -> Result<Self, Self::Error>,
1932         t: impl FnOnce(Self) -> Result<Self, Self::Error>,
1933         conversion: &str,
1934     ) -> Result<Self::Const, Self::Error> {
1935         self.write_str("{")?;
1936         self = f(self)?;
1937         self.write_str(conversion)?;
1938         let was_in_value = std::mem::replace(&mut self.in_value, false);
1939         self = t(self)?;
1940         self.in_value = was_in_value;
1941         self.write_str("}")?;
1942         Ok(self)
1943     }
1944
1945     fn generic_delimiters(
1946         mut self,
1947         f: impl FnOnce(Self) -> Result<Self, Self::Error>,
1948     ) -> Result<Self, Self::Error> {
1949         write!(self, "<")?;
1950
1951         let was_in_value = std::mem::replace(&mut self.in_value, false);
1952         let mut inner = f(self)?;
1953         inner.in_value = was_in_value;
1954
1955         write!(inner, ">")?;
1956         Ok(inner)
1957     }
1958
1959     fn should_print_region(&self, region: ty::Region<'tcx>) -> bool {
1960         let highlight = self.region_highlight_mode;
1961         if highlight.region_highlighted(region).is_some() {
1962             return true;
1963         }
1964
1965         if self.should_print_verbose() {
1966             return true;
1967         }
1968
1969         let identify_regions = self.tcx.sess.opts.unstable_opts.identify_regions;
1970
1971         match *region {
1972             ty::ReEarlyBound(ref data) => {
1973                 data.name != kw::Empty && data.name != kw::UnderscoreLifetime
1974             }
1975
1976             ty::ReLateBound(_, ty::BoundRegion { kind: br, .. })
1977             | ty::ReFree(ty::FreeRegion { bound_region: br, .. })
1978             | ty::RePlaceholder(ty::Placeholder { name: br, .. }) => {
1979                 if let ty::BrNamed(_, name) = br {
1980                     if name != kw::Empty && name != kw::UnderscoreLifetime {
1981                         return true;
1982                     }
1983                 }
1984
1985                 if let Some((region, _)) = highlight.highlight_bound_region {
1986                     if br == region {
1987                         return true;
1988                     }
1989                 }
1990
1991                 false
1992             }
1993
1994             ty::ReVar(_) if identify_regions => true,
1995
1996             ty::ReVar(_) | ty::ReErased => false,
1997
1998             ty::ReStatic => true,
1999         }
2000     }
2001
2002     fn pretty_print_const_pointer<Prov: Provenance>(
2003         self,
2004         p: Pointer<Prov>,
2005         ty: Ty<'tcx>,
2006         print_ty: bool,
2007     ) -> Result<Self::Const, Self::Error> {
2008         let print = |mut this: Self| {
2009             define_scoped_cx!(this);
2010             if this.print_alloc_ids {
2011                 p!(write("{:?}", p));
2012             } else {
2013                 p!("&_");
2014             }
2015             Ok(this)
2016         };
2017         if print_ty {
2018             self.typed_value(print, |this| this.print_type(ty), ": ")
2019         } else {
2020             print(self)
2021         }
2022     }
2023 }
2024
2025 // HACK(eddyb) limited to `FmtPrinter` because of `region_highlight_mode`.
2026 impl<'tcx> FmtPrinter<'_, 'tcx> {
2027     pub fn pretty_print_region(mut self, region: ty::Region<'tcx>) -> Result<Self, fmt::Error> {
2028         define_scoped_cx!(self);
2029
2030         // Watch out for region highlights.
2031         let highlight = self.region_highlight_mode;
2032         if let Some(n) = highlight.region_highlighted(region) {
2033             p!(write("'{}", n));
2034             return Ok(self);
2035         }
2036
2037         if self.should_print_verbose() {
2038             p!(write("{:?}", region));
2039             return Ok(self);
2040         }
2041
2042         let identify_regions = self.tcx.sess.opts.unstable_opts.identify_regions;
2043
2044         // These printouts are concise.  They do not contain all the information
2045         // the user might want to diagnose an error, but there is basically no way
2046         // to fit that into a short string.  Hence the recommendation to use
2047         // `explain_region()` or `note_and_explain_region()`.
2048         match *region {
2049             ty::ReEarlyBound(ref data) => {
2050                 if data.name != kw::Empty {
2051                     p!(write("{}", data.name));
2052                     return Ok(self);
2053                 }
2054             }
2055             ty::ReLateBound(_, ty::BoundRegion { kind: br, .. })
2056             | ty::ReFree(ty::FreeRegion { bound_region: br, .. })
2057             | ty::RePlaceholder(ty::Placeholder { name: br, .. }) => {
2058                 if let ty::BrNamed(_, name) = br {
2059                     if name != kw::Empty && name != kw::UnderscoreLifetime {
2060                         p!(write("{}", name));
2061                         return Ok(self);
2062                     }
2063                 }
2064
2065                 if let Some((region, counter)) = highlight.highlight_bound_region {
2066                     if br == region {
2067                         p!(write("'{}", counter));
2068                         return Ok(self);
2069                     }
2070                 }
2071             }
2072             ty::ReVar(region_vid) if identify_regions => {
2073                 p!(write("{:?}", region_vid));
2074                 return Ok(self);
2075             }
2076             ty::ReVar(_) => {}
2077             ty::ReErased => {}
2078             ty::ReStatic => {
2079                 p!("'static");
2080                 return Ok(self);
2081             }
2082         }
2083
2084         p!("'_");
2085
2086         Ok(self)
2087     }
2088 }
2089
2090 /// Folds through bound vars and placeholders, naming them
2091 struct RegionFolder<'a, 'tcx> {
2092     tcx: TyCtxt<'tcx>,
2093     current_index: ty::DebruijnIndex,
2094     region_map: BTreeMap<ty::BoundRegion, ty::Region<'tcx>>,
2095     name: &'a mut (
2096                 dyn FnMut(
2097         Option<ty::DebruijnIndex>, // Debruijn index of the folded late-bound region
2098         ty::DebruijnIndex,         // Index corresponding to binder level
2099         ty::BoundRegion,
2100     ) -> ty::Region<'tcx>
2101                     + 'a
2102             ),
2103 }
2104
2105 impl<'a, 'tcx> ty::TypeFolder<'tcx> for RegionFolder<'a, 'tcx> {
2106     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
2107         self.tcx
2108     }
2109
2110     fn fold_binder<T: TypeFoldable<'tcx>>(
2111         &mut self,
2112         t: ty::Binder<'tcx, T>,
2113     ) -> ty::Binder<'tcx, T> {
2114         self.current_index.shift_in(1);
2115         let t = t.super_fold_with(self);
2116         self.current_index.shift_out(1);
2117         t
2118     }
2119
2120     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
2121         match *t.kind() {
2122             _ if t.has_vars_bound_at_or_above(self.current_index) || t.has_placeholders() => {
2123                 return t.super_fold_with(self);
2124             }
2125             _ => {}
2126         }
2127         t
2128     }
2129
2130     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
2131         let name = &mut self.name;
2132         let region = match *r {
2133             ty::ReLateBound(db, br) if db >= self.current_index => {
2134                 *self.region_map.entry(br).or_insert_with(|| name(Some(db), self.current_index, br))
2135             }
2136             ty::RePlaceholder(ty::PlaceholderRegion { name: kind, .. }) => {
2137                 // If this is an anonymous placeholder, don't rename. Otherwise, in some
2138                 // async fns, we get a `for<'r> Send` bound
2139                 match kind {
2140                     ty::BrAnon(..) | ty::BrEnv => r,
2141                     _ => {
2142                         // Index doesn't matter, since this is just for naming and these never get bound
2143                         let br = ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind };
2144                         *self
2145                             .region_map
2146                             .entry(br)
2147                             .or_insert_with(|| name(None, self.current_index, br))
2148                     }
2149                 }
2150             }
2151             _ => return r,
2152         };
2153         if let ty::ReLateBound(debruijn1, br) = *region {
2154             assert_eq!(debruijn1, ty::INNERMOST);
2155             self.tcx.mk_region(ty::ReLateBound(self.current_index, br))
2156         } else {
2157             region
2158         }
2159     }
2160 }
2161
2162 // HACK(eddyb) limited to `FmtPrinter` because of `binder_depth`,
2163 // `region_index` and `used_region_names`.
2164 impl<'tcx> FmtPrinter<'_, 'tcx> {
2165     pub fn name_all_regions<T>(
2166         mut self,
2167         value: &ty::Binder<'tcx, T>,
2168     ) -> Result<(Self, T, BTreeMap<ty::BoundRegion, ty::Region<'tcx>>), fmt::Error>
2169     where
2170         T: Print<'tcx, Self, Output = Self, Error = fmt::Error> + TypeFoldable<'tcx>,
2171     {
2172         fn name_by_region_index(
2173             index: usize,
2174             available_names: &mut Vec<Symbol>,
2175             num_available: usize,
2176         ) -> Symbol {
2177             if let Some(name) = available_names.pop() {
2178                 name
2179             } else {
2180                 Symbol::intern(&format!("'z{}", index - num_available))
2181             }
2182         }
2183
2184         debug!("name_all_regions");
2185
2186         // Replace any anonymous late-bound regions with named
2187         // variants, using new unique identifiers, so that we can
2188         // clearly differentiate between named and unnamed regions in
2189         // the output. We'll probably want to tweak this over time to
2190         // decide just how much information to give.
2191         if self.binder_depth == 0 {
2192             self.prepare_region_info(value);
2193         }
2194
2195         debug!("self.used_region_names: {:?}", &self.used_region_names);
2196
2197         let mut empty = true;
2198         let mut start_or_continue = |cx: &mut Self, start: &str, cont: &str| {
2199             let w = if empty {
2200                 empty = false;
2201                 start
2202             } else {
2203                 cont
2204             };
2205             let _ = write!(cx, "{}", w);
2206         };
2207         let do_continue = |cx: &mut Self, cont: Symbol| {
2208             let _ = write!(cx, "{}", cont);
2209         };
2210
2211         define_scoped_cx!(self);
2212
2213         let possible_names = ('a'..='z').rev().map(|s| Symbol::intern(&format!("'{s}")));
2214
2215         let mut available_names = possible_names
2216             .filter(|name| !self.used_region_names.contains(&name))
2217             .collect::<Vec<_>>();
2218         debug!(?available_names);
2219         let num_available = available_names.len();
2220
2221         let mut region_index = self.region_index;
2222         let mut next_name = |this: &Self| {
2223             let mut name;
2224
2225             loop {
2226                 name = name_by_region_index(region_index, &mut available_names, num_available);
2227                 region_index += 1;
2228
2229                 if !this.used_region_names.contains(&name) {
2230                     break;
2231                 }
2232             }
2233
2234             name
2235         };
2236
2237         // If we want to print verbosely, then print *all* binders, even if they
2238         // aren't named. Eventually, we might just want this as the default, but
2239         // this is not *quite* right and changes the ordering of some output
2240         // anyways.
2241         let (new_value, map) = if self.should_print_verbose() {
2242             for var in value.bound_vars().iter() {
2243                 start_or_continue(&mut self, "for<", ", ");
2244                 write!(self, "{:?}", var)?;
2245             }
2246             start_or_continue(&mut self, "", "> ");
2247             (value.clone().skip_binder(), BTreeMap::default())
2248         } else {
2249             let tcx = self.tcx;
2250
2251             // Closure used in `RegionFolder` to create names for anonymous late-bound
2252             // regions. We use two `DebruijnIndex`es (one for the currently folded
2253             // late-bound region and the other for the binder level) to determine
2254             // whether a name has already been created for the currently folded region,
2255             // see issue #102392.
2256             let mut name = |lifetime_idx: Option<ty::DebruijnIndex>,
2257                             binder_level_idx: ty::DebruijnIndex,
2258                             br: ty::BoundRegion| {
2259                 let (name, kind) = match br.kind {
2260                     ty::BrAnon(..) | ty::BrEnv => {
2261                         let name = next_name(&self);
2262
2263                         if let Some(lt_idx) = lifetime_idx {
2264                             if lt_idx > binder_level_idx {
2265                                 let kind = ty::BrNamed(CRATE_DEF_ID.to_def_id(), name);
2266                                 return tcx.mk_region(ty::ReLateBound(
2267                                     ty::INNERMOST,
2268                                     ty::BoundRegion { var: br.var, kind },
2269                                 ));
2270                             }
2271                         }
2272
2273                         (name, ty::BrNamed(CRATE_DEF_ID.to_def_id(), name))
2274                     }
2275                     ty::BrNamed(def_id, kw::UnderscoreLifetime) => {
2276                         let name = next_name(&self);
2277
2278                         if let Some(lt_idx) = lifetime_idx {
2279                             if lt_idx > binder_level_idx {
2280                                 let kind = ty::BrNamed(def_id, name);
2281                                 return tcx.mk_region(ty::ReLateBound(
2282                                     ty::INNERMOST,
2283                                     ty::BoundRegion { var: br.var, kind },
2284                                 ));
2285                             }
2286                         }
2287
2288                         (name, ty::BrNamed(def_id, name))
2289                     }
2290                     ty::BrNamed(_, name) => {
2291                         if let Some(lt_idx) = lifetime_idx {
2292                             if lt_idx > binder_level_idx {
2293                                 let kind = br.kind;
2294                                 return tcx.mk_region(ty::ReLateBound(
2295                                     ty::INNERMOST,
2296                                     ty::BoundRegion { var: br.var, kind },
2297                                 ));
2298                             }
2299                         }
2300
2301                         (name, br.kind)
2302                     }
2303                 };
2304
2305                 start_or_continue(&mut self, "for<", ", ");
2306                 do_continue(&mut self, name);
2307                 tcx.mk_region(ty::ReLateBound(ty::INNERMOST, ty::BoundRegion { var: br.var, kind }))
2308             };
2309             let mut folder = RegionFolder {
2310                 tcx,
2311                 current_index: ty::INNERMOST,
2312                 name: &mut name,
2313                 region_map: BTreeMap::new(),
2314             };
2315             let new_value = value.clone().skip_binder().fold_with(&mut folder);
2316             let region_map = folder.region_map;
2317             start_or_continue(&mut self, "", "> ");
2318             (new_value, region_map)
2319         };
2320
2321         self.binder_depth += 1;
2322         self.region_index = region_index;
2323         Ok((self, new_value, map))
2324     }
2325
2326     pub fn pretty_in_binder<T>(self, value: &ty::Binder<'tcx, T>) -> Result<Self, fmt::Error>
2327     where
2328         T: Print<'tcx, Self, Output = Self, Error = fmt::Error> + TypeFoldable<'tcx>,
2329     {
2330         let old_region_index = self.region_index;
2331         let (new, new_value, _) = self.name_all_regions(value)?;
2332         let mut inner = new_value.print(new)?;
2333         inner.region_index = old_region_index;
2334         inner.binder_depth -= 1;
2335         Ok(inner)
2336     }
2337
2338     pub fn pretty_wrap_binder<T, C: FnOnce(&T, Self) -> Result<Self, fmt::Error>>(
2339         self,
2340         value: &ty::Binder<'tcx, T>,
2341         f: C,
2342     ) -> Result<Self, fmt::Error>
2343     where
2344         T: Print<'tcx, Self, Output = Self, Error = fmt::Error> + TypeFoldable<'tcx>,
2345     {
2346         let old_region_index = self.region_index;
2347         let (new, new_value, _) = self.name_all_regions(value)?;
2348         let mut inner = f(&new_value, new)?;
2349         inner.region_index = old_region_index;
2350         inner.binder_depth -= 1;
2351         Ok(inner)
2352     }
2353
2354     fn prepare_region_info<T>(&mut self, value: &ty::Binder<'tcx, T>)
2355     where
2356         T: TypeVisitable<'tcx>,
2357     {
2358         struct RegionNameCollector<'tcx> {
2359             used_region_names: FxHashSet<Symbol>,
2360             type_collector: SsoHashSet<Ty<'tcx>>,
2361         }
2362
2363         impl<'tcx> RegionNameCollector<'tcx> {
2364             fn new() -> Self {
2365                 RegionNameCollector {
2366                     used_region_names: Default::default(),
2367                     type_collector: SsoHashSet::new(),
2368                 }
2369             }
2370         }
2371
2372         impl<'tcx> ty::visit::TypeVisitor<'tcx> for RegionNameCollector<'tcx> {
2373             type BreakTy = ();
2374
2375             fn visit_region(&mut self, r: ty::Region<'tcx>) -> ControlFlow<Self::BreakTy> {
2376                 trace!("address: {:p}", r.0.0);
2377
2378                 // Collect all named lifetimes. These allow us to prevent duplication
2379                 // of already existing lifetime names when introducing names for
2380                 // anonymous late-bound regions.
2381                 if let Some(name) = r.get_name() {
2382                     self.used_region_names.insert(name);
2383                 }
2384
2385                 r.super_visit_with(self)
2386             }
2387
2388             // We collect types in order to prevent really large types from compiling for
2389             // a really long time. See issue #83150 for why this is necessary.
2390             fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
2391                 let not_previously_inserted = self.type_collector.insert(ty);
2392                 if not_previously_inserted {
2393                     ty.super_visit_with(self)
2394                 } else {
2395                     ControlFlow::CONTINUE
2396                 }
2397             }
2398         }
2399
2400         let mut collector = RegionNameCollector::new();
2401         value.visit_with(&mut collector);
2402         self.used_region_names = collector.used_region_names;
2403         self.region_index = 0;
2404     }
2405 }
2406
2407 impl<'tcx, T, P: PrettyPrinter<'tcx>> Print<'tcx, P> for ty::Binder<'tcx, T>
2408 where
2409     T: Print<'tcx, P, Output = P, Error = P::Error> + TypeFoldable<'tcx>,
2410 {
2411     type Output = P;
2412     type Error = P::Error;
2413
2414     fn print(&self, cx: P) -> Result<Self::Output, Self::Error> {
2415         cx.in_binder(self)
2416     }
2417 }
2418
2419 impl<'tcx, T, U, P: PrettyPrinter<'tcx>> Print<'tcx, P> for ty::OutlivesPredicate<T, U>
2420 where
2421     T: Print<'tcx, P, Output = P, Error = P::Error>,
2422     U: Print<'tcx, P, Output = P, Error = P::Error>,
2423 {
2424     type Output = P;
2425     type Error = P::Error;
2426     fn print(&self, mut cx: P) -> Result<Self::Output, Self::Error> {
2427         define_scoped_cx!(cx);
2428         p!(print(self.0), ": ", print(self.1));
2429         Ok(cx)
2430     }
2431 }
2432
2433 macro_rules! forward_display_to_print {
2434     ($($ty:ty),+) => {
2435         // Some of the $ty arguments may not actually use 'tcx
2436         $(#[allow(unused_lifetimes)] impl<'tcx> fmt::Display for $ty {
2437             fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2438                 ty::tls::with(|tcx| {
2439                     let cx = tcx.lift(*self)
2440                         .expect("could not lift for printing")
2441                         .print(FmtPrinter::new(tcx, Namespace::TypeNS))?;
2442                     f.write_str(&cx.into_buffer())?;
2443                     Ok(())
2444                 })
2445             }
2446         })+
2447     };
2448 }
2449
2450 macro_rules! define_print_and_forward_display {
2451     (($self:ident, $cx:ident): $($ty:ty $print:block)+) => {
2452         $(impl<'tcx, P: PrettyPrinter<'tcx>> Print<'tcx, P> for $ty {
2453             type Output = P;
2454             type Error = fmt::Error;
2455             fn print(&$self, $cx: P) -> Result<Self::Output, Self::Error> {
2456                 #[allow(unused_mut)]
2457                 let mut $cx = $cx;
2458                 define_scoped_cx!($cx);
2459                 let _: () = $print;
2460                 #[allow(unreachable_code)]
2461                 Ok($cx)
2462             }
2463         })+
2464
2465         forward_display_to_print!($($ty),+);
2466     };
2467 }
2468
2469 /// Wrapper type for `ty::TraitRef` which opts-in to pretty printing only
2470 /// the trait path. That is, it will print `Trait<U>` instead of
2471 /// `<T as Trait<U>>`.
2472 #[derive(Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2473 pub struct TraitRefPrintOnlyTraitPath<'tcx>(ty::TraitRef<'tcx>);
2474
2475 impl<'tcx> fmt::Debug for TraitRefPrintOnlyTraitPath<'tcx> {
2476     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2477         fmt::Display::fmt(self, f)
2478     }
2479 }
2480
2481 /// Wrapper type for `ty::TraitRef` which opts-in to pretty printing only
2482 /// the trait name. That is, it will print `Trait` instead of
2483 /// `<T as Trait<U>>`.
2484 #[derive(Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2485 pub struct TraitRefPrintOnlyTraitName<'tcx>(ty::TraitRef<'tcx>);
2486
2487 impl<'tcx> fmt::Debug for TraitRefPrintOnlyTraitName<'tcx> {
2488     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2489         fmt::Display::fmt(self, f)
2490     }
2491 }
2492
2493 impl<'tcx> ty::TraitRef<'tcx> {
2494     pub fn print_only_trait_path(self) -> TraitRefPrintOnlyTraitPath<'tcx> {
2495         TraitRefPrintOnlyTraitPath(self)
2496     }
2497
2498     pub fn print_only_trait_name(self) -> TraitRefPrintOnlyTraitName<'tcx> {
2499         TraitRefPrintOnlyTraitName(self)
2500     }
2501 }
2502
2503 impl<'tcx> ty::Binder<'tcx, ty::TraitRef<'tcx>> {
2504     pub fn print_only_trait_path(self) -> ty::Binder<'tcx, TraitRefPrintOnlyTraitPath<'tcx>> {
2505         self.map_bound(|tr| tr.print_only_trait_path())
2506     }
2507 }
2508
2509 #[derive(Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2510 pub struct TraitPredPrintModifiersAndPath<'tcx>(ty::TraitPredicate<'tcx>);
2511
2512 impl<'tcx> fmt::Debug for TraitPredPrintModifiersAndPath<'tcx> {
2513     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2514         fmt::Display::fmt(self, f)
2515     }
2516 }
2517
2518 impl<'tcx> ty::TraitPredicate<'tcx> {
2519     pub fn print_modifiers_and_trait_path(self) -> TraitPredPrintModifiersAndPath<'tcx> {
2520         TraitPredPrintModifiersAndPath(self)
2521     }
2522 }
2523
2524 impl<'tcx> ty::PolyTraitPredicate<'tcx> {
2525     pub fn print_modifiers_and_trait_path(
2526         self,
2527     ) -> ty::Binder<'tcx, TraitPredPrintModifiersAndPath<'tcx>> {
2528         self.map_bound(TraitPredPrintModifiersAndPath)
2529     }
2530 }
2531
2532 #[derive(Debug, Copy, Clone, TypeFoldable, TypeVisitable, Lift)]
2533 pub struct PrintClosureAsImpl<'tcx> {
2534     pub closure: ty::ClosureSubsts<'tcx>,
2535 }
2536
2537 forward_display_to_print! {
2538     ty::Region<'tcx>,
2539     Ty<'tcx>,
2540     &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
2541     ty::Const<'tcx>,
2542
2543     // HACK(eddyb) these are exhaustive instead of generic,
2544     // because `for<'tcx>` isn't possible yet.
2545     ty::PolyExistentialPredicate<'tcx>,
2546     ty::Binder<'tcx, ty::TraitRef<'tcx>>,
2547     ty::Binder<'tcx, ty::ExistentialTraitRef<'tcx>>,
2548     ty::Binder<'tcx, TraitRefPrintOnlyTraitPath<'tcx>>,
2549     ty::Binder<'tcx, TraitRefPrintOnlyTraitName<'tcx>>,
2550     ty::Binder<'tcx, ty::FnSig<'tcx>>,
2551     ty::Binder<'tcx, ty::TraitPredicate<'tcx>>,
2552     ty::Binder<'tcx, TraitPredPrintModifiersAndPath<'tcx>>,
2553     ty::Binder<'tcx, ty::SubtypePredicate<'tcx>>,
2554     ty::Binder<'tcx, ty::ProjectionPredicate<'tcx>>,
2555     ty::Binder<'tcx, ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>>,
2556     ty::Binder<'tcx, ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>>,
2557
2558     ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>,
2559     ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>
2560 }
2561
2562 define_print_and_forward_display! {
2563     (self, cx):
2564
2565     &'tcx ty::List<Ty<'tcx>> {
2566         p!("{{", comma_sep(self.iter()), "}}")
2567     }
2568
2569     ty::TypeAndMut<'tcx> {
2570         p!(write("{}", self.mutbl.prefix_str()), print(self.ty))
2571     }
2572
2573     ty::ExistentialTraitRef<'tcx> {
2574         // Use a type that can't appear in defaults of type parameters.
2575         let dummy_self = cx.tcx().mk_ty_infer(ty::FreshTy(0));
2576         let trait_ref = self.with_self_ty(cx.tcx(), dummy_self);
2577         p!(print(trait_ref.print_only_trait_path()))
2578     }
2579
2580     ty::ExistentialProjection<'tcx> {
2581         let name = cx.tcx().associated_item(self.item_def_id).name;
2582         p!(write("{} = ", name), print(self.term))
2583     }
2584
2585     ty::ExistentialPredicate<'tcx> {
2586         match *self {
2587             ty::ExistentialPredicate::Trait(x) => p!(print(x)),
2588             ty::ExistentialPredicate::Projection(x) => p!(print(x)),
2589             ty::ExistentialPredicate::AutoTrait(def_id) => {
2590                 p!(print_def_path(def_id, &[]));
2591             }
2592         }
2593     }
2594
2595     ty::FnSig<'tcx> {
2596         p!(write("{}", self.unsafety.prefix_str()));
2597
2598         if self.abi != Abi::Rust {
2599             p!(write("extern {} ", self.abi));
2600         }
2601
2602         p!("fn", pretty_fn_sig(self.inputs(), self.c_variadic, self.output()));
2603     }
2604
2605     ty::TraitRef<'tcx> {
2606         p!(write("<{} as {}>", self.self_ty(), self.print_only_trait_path()))
2607     }
2608
2609     TraitRefPrintOnlyTraitPath<'tcx> {
2610         p!(print_def_path(self.0.def_id, self.0.substs));
2611     }
2612
2613     TraitRefPrintOnlyTraitName<'tcx> {
2614         p!(print_def_path(self.0.def_id, &[]));
2615     }
2616
2617     TraitPredPrintModifiersAndPath<'tcx> {
2618         if let ty::BoundConstness::ConstIfConst = self.0.constness {
2619             p!("~const ")
2620         }
2621
2622         if let ty::ImplPolarity::Negative = self.0.polarity {
2623             p!("!")
2624         }
2625
2626         p!(print(self.0.trait_ref.print_only_trait_path()));
2627     }
2628
2629     PrintClosureAsImpl<'tcx> {
2630         p!(pretty_closure_as_impl(self.closure))
2631     }
2632
2633     ty::ParamTy {
2634         p!(write("{}", self.name))
2635     }
2636
2637     ty::ParamConst {
2638         p!(write("{}", self.name))
2639     }
2640
2641     ty::SubtypePredicate<'tcx> {
2642         p!(print(self.a), " <: ", print(self.b))
2643     }
2644
2645     ty::CoercePredicate<'tcx> {
2646         p!(print(self.a), " -> ", print(self.b))
2647     }
2648
2649     ty::TraitPredicate<'tcx> {
2650         p!(print(self.trait_ref.self_ty()), ": ");
2651         if let ty::BoundConstness::ConstIfConst = self.constness && cx.tcx().features().const_trait_impl {
2652             p!("~const ");
2653         }
2654         p!(print(self.trait_ref.print_only_trait_path()))
2655     }
2656
2657     ty::ProjectionPredicate<'tcx> {
2658         p!(print(self.projection_ty), " == ", print(self.term))
2659     }
2660
2661     ty::Term<'tcx> {
2662       match self.unpack() {
2663         ty::TermKind::Ty(ty) => p!(print(ty)),
2664         ty::TermKind::Const(c) => p!(print(c)),
2665       }
2666     }
2667
2668     ty::ProjectionTy<'tcx> {
2669         p!(print_def_path(self.item_def_id, self.substs));
2670     }
2671
2672     ty::ClosureKind {
2673         match *self {
2674             ty::ClosureKind::Fn => p!("Fn"),
2675             ty::ClosureKind::FnMut => p!("FnMut"),
2676             ty::ClosureKind::FnOnce => p!("FnOnce"),
2677         }
2678     }
2679
2680     ty::Predicate<'tcx> {
2681         let binder = self.kind();
2682         p!(print(binder))
2683     }
2684
2685     ty::PredicateKind<'tcx> {
2686         match *self {
2687             ty::PredicateKind::Trait(ref data) => {
2688                 p!(print(data))
2689             }
2690             ty::PredicateKind::Subtype(predicate) => p!(print(predicate)),
2691             ty::PredicateKind::Coerce(predicate) => p!(print(predicate)),
2692             ty::PredicateKind::RegionOutlives(predicate) => p!(print(predicate)),
2693             ty::PredicateKind::TypeOutlives(predicate) => p!(print(predicate)),
2694             ty::PredicateKind::Projection(predicate) => p!(print(predicate)),
2695             ty::PredicateKind::WellFormed(arg) => p!(print(arg), " well-formed"),
2696             ty::PredicateKind::ObjectSafe(trait_def_id) => {
2697                 p!("the trait `", print_def_path(trait_def_id, &[]), "` is object-safe")
2698             }
2699             ty::PredicateKind::ClosureKind(closure_def_id, _closure_substs, kind) => {
2700                 p!("the closure `",
2701                 print_value_path(closure_def_id, &[]),
2702                 write("` implements the trait `{}`", kind))
2703             }
2704             ty::PredicateKind::ConstEvaluatable(ct) => {
2705                 p!("the constant `", print(ct), "` can be evaluated")
2706             }
2707             ty::PredicateKind::ConstEquate(c1, c2) => {
2708                 p!("the constant `", print(c1), "` equals `", print(c2), "`")
2709             }
2710             ty::PredicateKind::TypeWellFormedFromEnv(ty) => {
2711                 p!("the type `", print(ty), "` is found in the environment")
2712             }
2713             ty::PredicateKind::Ambiguous => p!("ambiguous"),
2714         }
2715     }
2716
2717     GenericArg<'tcx> {
2718         match self.unpack() {
2719             GenericArgKind::Lifetime(lt) => p!(print(lt)),
2720             GenericArgKind::Type(ty) => p!(print(ty)),
2721             GenericArgKind::Const(ct) => p!(print(ct)),
2722         }
2723     }
2724 }
2725
2726 fn for_each_def(tcx: TyCtxt<'_>, mut collect_fn: impl for<'b> FnMut(&'b Ident, Namespace, DefId)) {
2727     // Iterate all local crate items no matter where they are defined.
2728     let hir = tcx.hir();
2729     for id in hir.items() {
2730         if matches!(tcx.def_kind(id.owner_id), DefKind::Use) {
2731             continue;
2732         }
2733
2734         let item = hir.item(id);
2735         if item.ident.name == kw::Empty {
2736             continue;
2737         }
2738
2739         let def_id = item.owner_id.to_def_id();
2740         let ns = tcx.def_kind(def_id).ns().unwrap_or(Namespace::TypeNS);
2741         collect_fn(&item.ident, ns, def_id);
2742     }
2743
2744     // Now take care of extern crate items.
2745     let queue = &mut Vec::new();
2746     let mut seen_defs: DefIdSet = Default::default();
2747
2748     for &cnum in tcx.crates(()).iter() {
2749         let def_id = cnum.as_def_id();
2750
2751         // Ignore crates that are not direct dependencies.
2752         match tcx.extern_crate(def_id) {
2753             None => continue,
2754             Some(extern_crate) => {
2755                 if !extern_crate.is_direct() {
2756                     continue;
2757                 }
2758             }
2759         }
2760
2761         queue.push(def_id);
2762     }
2763
2764     // Iterate external crate defs but be mindful about visibility
2765     while let Some(def) = queue.pop() {
2766         for child in tcx.module_children(def).iter() {
2767             if !child.vis.is_public() {
2768                 continue;
2769             }
2770
2771             match child.res {
2772                 def::Res::Def(DefKind::AssocTy, _) => {}
2773                 def::Res::Def(DefKind::TyAlias, _) => {}
2774                 def::Res::Def(defkind, def_id) => {
2775                     if let Some(ns) = defkind.ns() {
2776                         collect_fn(&child.ident, ns, def_id);
2777                     }
2778
2779                     if matches!(defkind, DefKind::Mod | DefKind::Enum | DefKind::Trait)
2780                         && seen_defs.insert(def_id)
2781                     {
2782                         queue.push(def_id);
2783                     }
2784                 }
2785                 _ => {}
2786             }
2787         }
2788     }
2789 }
2790
2791 /// The purpose of this function is to collect public symbols names that are unique across all
2792 /// crates in the build. Later, when printing about types we can use those names instead of the
2793 /// full exported path to them.
2794 ///
2795 /// So essentially, if a symbol name can only be imported from one place for a type, and as
2796 /// long as it was not glob-imported anywhere in the current crate, we can trim its printed
2797 /// path and print only the name.
2798 ///
2799 /// This has wide implications on error messages with types, for example, shortening
2800 /// `std::vec::Vec` to just `Vec`, as long as there is no other `Vec` importable anywhere.
2801 ///
2802 /// The implementation uses similar import discovery logic to that of 'use' suggestions.
2803 fn trimmed_def_paths(tcx: TyCtxt<'_>, (): ()) -> FxHashMap<DefId, Symbol> {
2804     let mut map: FxHashMap<DefId, Symbol> = FxHashMap::default();
2805
2806     if let TrimmedDefPaths::GoodPath = tcx.sess.opts.trimmed_def_paths {
2807         // For good paths causing this bug, the `rustc_middle::ty::print::with_no_trimmed_paths`
2808         // wrapper can be used to suppress this query, in exchange for full paths being formatted.
2809         tcx.sess.delay_good_path_bug("trimmed_def_paths constructed");
2810     }
2811
2812     let unique_symbols_rev: &mut FxHashMap<(Namespace, Symbol), Option<DefId>> =
2813         &mut FxHashMap::default();
2814
2815     for symbol_set in tcx.resolutions(()).glob_map.values() {
2816         for symbol in symbol_set {
2817             unique_symbols_rev.insert((Namespace::TypeNS, *symbol), None);
2818             unique_symbols_rev.insert((Namespace::ValueNS, *symbol), None);
2819             unique_symbols_rev.insert((Namespace::MacroNS, *symbol), None);
2820         }
2821     }
2822
2823     for_each_def(tcx, |ident, ns, def_id| {
2824         use std::collections::hash_map::Entry::{Occupied, Vacant};
2825
2826         match unique_symbols_rev.entry((ns, ident.name)) {
2827             Occupied(mut v) => match v.get() {
2828                 None => {}
2829                 Some(existing) => {
2830                     if *existing != def_id {
2831                         v.insert(None);
2832                     }
2833                 }
2834             },
2835             Vacant(v) => {
2836                 v.insert(Some(def_id));
2837             }
2838         }
2839     });
2840
2841     for ((_, symbol), opt_def_id) in unique_symbols_rev.drain() {
2842         use std::collections::hash_map::Entry::{Occupied, Vacant};
2843
2844         if let Some(def_id) = opt_def_id {
2845             match map.entry(def_id) {
2846                 Occupied(mut v) => {
2847                     // A single DefId can be known under multiple names (e.g.,
2848                     // with a `pub use ... as ...;`). We need to ensure that the
2849                     // name placed in this map is chosen deterministically, so
2850                     // if we find multiple names (`symbol`) resolving to the
2851                     // same `def_id`, we prefer the lexicographically smallest
2852                     // name.
2853                     //
2854                     // Any stable ordering would be fine here though.
2855                     if *v.get() != symbol {
2856                         if v.get().as_str() > symbol.as_str() {
2857                             v.insert(symbol);
2858                         }
2859                     }
2860                 }
2861                 Vacant(v) => {
2862                     v.insert(symbol);
2863                 }
2864             }
2865         }
2866     }
2867
2868     map
2869 }
2870
2871 pub fn provide(providers: &mut ty::query::Providers) {
2872     *providers = ty::query::Providers { trimmed_def_paths, ..*providers };
2873 }
2874
2875 #[derive(Default)]
2876 pub struct OpaqueFnEntry<'tcx> {
2877     // The trait ref is already stored as a key, so just track if we have it as a real predicate
2878     has_fn_once: bool,
2879     fn_mut_trait_ref: Option<ty::PolyTraitRef<'tcx>>,
2880     fn_trait_ref: Option<ty::PolyTraitRef<'tcx>>,
2881     return_ty: Option<ty::Binder<'tcx, Term<'tcx>>>,
2882 }