1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 use hir::def_id::DefId;
12 use hir::map::definitions::DefPathData;
13 use mir::interpret::ConstValue;
15 use ty::subst::{self, Subst};
16 use ty::{BrAnon, BrEnv, BrFresh, BrNamed};
17 use ty::{Bool, Char, Adt};
18 use ty::{Error, Str, Array, Slice, Float, FnDef, FnPtr};
19 use ty::{Param, RawPtr, Ref, Never, Tuple};
20 use ty::{Closure, Generator, GeneratorWitness, Foreign, Projection, Opaque};
21 use ty::{Dynamic, Int, Uint, Infer};
22 use ty::{self, RegionVid, Ty, TyCtxt, TypeFoldable, GenericParamCount, GenericParamDefKind};
23 use util::nodemap::FxHashSet;
29 use rustc_target::spec::abi::Abi;
30 use syntax::ast::CRATE_NODE_ID;
31 use syntax::symbol::{Symbol, InternedString};
35 /// Mechanism for highlighting of specific regions for display in NLL region inference errors.
36 /// Contains region to highlight and counter for number to use when highlighting.
37 static HIGHLIGHT_REGION: Cell<Option<(RegionVid, usize)>> = Cell::new(None)
40 macro_rules! gen_display_debug_body {
42 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
43 let mut cx = PrintContext::new();
44 $with(self, f, &mut cx)
48 macro_rules! gen_display_debug {
49 ( ($($x:tt)+) $target:ty, display yes ) => {
50 impl<$($x)+> fmt::Display for $target {
51 gen_display_debug_body! { Print::print_display }
54 ( () $target:ty, display yes ) => {
55 impl fmt::Display for $target {
56 gen_display_debug_body! { Print::print_display }
59 ( ($($x:tt)+) $target:ty, debug yes ) => {
60 impl<$($x)+> fmt::Debug for $target {
61 gen_display_debug_body! { Print::print_debug }
64 ( () $target:ty, debug yes ) => {
65 impl fmt::Debug for $target {
66 gen_display_debug_body! { Print::print_debug }
69 ( $generic:tt $target:ty, $t:ident no ) => {};
71 macro_rules! gen_print_impl {
72 ( ($($x:tt)+) $target:ty, ($self:ident, $f:ident, $cx:ident) $disp:block $dbg:block ) => {
73 impl<$($x)+> Print for $target {
74 fn print<F: fmt::Write>(&$self, $f: &mut F, $cx: &mut PrintContext) -> fmt::Result {
80 ( () $target:ty, ($self:ident, $f:ident, $cx:ident) $disp:block $dbg:block ) => {
81 impl Print for $target {
82 fn print<F: fmt::Write>(&$self, $f: &mut F, $cx: &mut PrintContext) -> fmt::Result {
88 ( $generic:tt $target:ty,
89 $vars:tt $gendisp:ident $disp:block $gendbg:ident $dbg:block ) => {
90 gen_print_impl! { $generic $target, $vars $disp $dbg }
91 gen_display_debug! { $generic $target, display $gendisp }
92 gen_display_debug! { $generic $target, debug $gendbg }
95 macro_rules! define_print {
96 ( $generic:tt $target:ty,
97 $vars:tt { display $disp:block debug $dbg:block } ) => {
98 gen_print_impl! { $generic $target, $vars yes $disp yes $dbg }
100 ( $generic:tt $target:ty,
101 $vars:tt { debug $dbg:block display $disp:block } ) => {
102 gen_print_impl! { $generic $target, $vars yes $disp yes $dbg }
104 ( $generic:tt $target:ty,
105 $vars:tt { debug $dbg:block } ) => {
106 gen_print_impl! { $generic $target, $vars no {
107 bug!(concat!("display not implemented for ", stringify!($target)));
110 ( $generic:tt $target:ty,
111 ($self:ident, $f:ident, $cx:ident) { display $disp:block } ) => {
112 gen_print_impl! { $generic $target, ($self, $f, $cx) yes $disp no {
113 write!($f, "{:?}", $self)
117 macro_rules! define_print_multi {
118 ( [ $($generic:tt $target:ty),* ] $vars:tt $def:tt ) => {
119 $(define_print! { $generic $target, $vars $def })*
122 macro_rules! print_inner {
123 ( $f:expr, $cx:expr, write ($($data:expr),+) ) => {
124 write!($f, $($data),+)
126 ( $f:expr, $cx:expr, $kind:ident ($data:expr) ) => {
131 ( $f:expr, $cx:expr $(, $kind:ident $data:tt)+ ) => {
132 Ok(())$(.and_then(|_| print_inner!($f, $cx, $kind $data)))+
137 struct LateBoundRegionNameCollector(FxHashSet<InternedString>);
138 impl<'tcx> ty::fold::TypeVisitor<'tcx> for LateBoundRegionNameCollector {
139 fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
141 ty::ReLateBound(_, ty::BrNamed(_, name)) => {
146 r.super_visit_with(self)
151 pub struct PrintContext {
154 identify_regions: bool,
155 used_region_names: Option<FxHashSet<InternedString>>,
161 ty::tls::with_opt(|tcx| {
162 let (is_verbose, identify_regions) = tcx.map(
163 |tcx| (tcx.sess.verbose(), tcx.sess.opts.debugging_opts.identify_regions)
164 ).unwrap_or((false, false));
167 is_verbose: is_verbose,
168 identify_regions: identify_regions,
169 used_region_names: None,
175 fn prepare_late_bound_region_info<'tcx, T>(&mut self, value: &ty::Binder<T>)
176 where T: TypeFoldable<'tcx>
178 let mut collector = LateBoundRegionNameCollector(FxHashSet());
179 value.visit_with(&mut collector);
180 self.used_region_names = Some(collector.0);
181 self.region_index = 0;
186 fn print<F: fmt::Write>(&self, f: &mut F, cx: &mut PrintContext) -> fmt::Result;
187 fn print_to_string(&self, cx: &mut PrintContext) -> String {
188 let mut result = String::new();
189 let _ = self.print(&mut result, cx);
192 fn print_display<F: fmt::Write>(&self, f: &mut F, cx: &mut PrintContext) -> fmt::Result {
193 let old_debug = cx.is_debug;
195 let result = self.print(f, cx);
196 cx.is_debug = old_debug;
199 fn print_display_to_string(&self, cx: &mut PrintContext) -> String {
200 let mut result = String::new();
201 let _ = self.print_display(&mut result, cx);
204 fn print_debug<F: fmt::Write>(&self, f: &mut F, cx: &mut PrintContext) -> fmt::Result {
205 let old_debug = cx.is_debug;
207 let result = self.print(f, cx);
208 cx.is_debug = old_debug;
211 fn print_debug_to_string(&self, cx: &mut PrintContext) -> String {
212 let mut result = String::new();
213 let _ = self.print_debug(&mut result, cx);
219 fn fn_sig<F: fmt::Write>(&mut self,
226 let mut inputs = inputs.iter();
227 if let Some(&ty) = inputs.next() {
228 print!(f, self, print_display(ty))?;
230 print!(f, self, write(", "), print_display(ty))?;
237 if !output.is_unit() {
238 print!(f, self, write(" -> "), print_display(output))?;
244 fn parameterized<F: fmt::Write>(&mut self,
246 substs: &subst::Substs,
248 projections: &[ty::ProjectionPredicate])
250 let key = ty::tls::with(|tcx| tcx.def_key(did));
251 let mut item_name = if let Some(name) = key.disambiguated_data.data.get_opt_name() {
254 did.index = key.parent.unwrap_or_else(
255 || bug!("finding type for {:?}, encountered def-id {:?} with no parent",
257 self.parameterized(f, substs, did, projections)?;
258 return write!(f, "::{}", key.disambiguated_data.data.as_interned_str());
261 let verbose = self.is_verbose;
262 let mut num_supplied_defaults = 0;
263 let mut has_self = false;
264 let mut own_counts: GenericParamCount = Default::default();
265 let mut is_value_path = false;
266 let fn_trait_kind = ty::tls::with(|tcx| {
267 // Unfortunately, some kinds of items (e.g., closures) don't have
268 // generics. So walk back up the find the closest parent that DOES
270 let mut item_def_id = did;
272 let key = tcx.def_key(item_def_id);
273 match key.disambiguated_data.data {
274 DefPathData::AssocTypeInTrait(_) |
275 DefPathData::AssocTypeInImpl(_) |
276 DefPathData::AssocExistentialInImpl(_) |
277 DefPathData::Trait(_) |
278 DefPathData::TypeNs(_) => {
281 DefPathData::ValueNs(_) |
282 DefPathData::EnumVariant(_) => {
283 is_value_path = true;
286 DefPathData::CrateRoot |
289 DefPathData::Module(_) |
290 DefPathData::MacroDef(_) |
291 DefPathData::ClosureExpr |
292 DefPathData::TypeParam(_) |
293 DefPathData::LifetimeParam(_) |
294 DefPathData::Field(_) |
295 DefPathData::StructCtor |
296 DefPathData::AnonConst |
297 DefPathData::ImplTrait |
298 DefPathData::GlobalMetaData(_) => {
299 // if we're making a symbol for something, there ought
300 // to be a value or type-def or something in there
302 item_def_id.index = key.parent.unwrap_or_else(|| {
303 bug!("finding type for {:?}, encountered def-id {:?} with no \
304 parent", did, item_def_id);
309 let mut generics = tcx.generics_of(item_def_id);
310 let child_own_counts = generics.own_counts();
311 let mut path_def_id = did;
312 has_self = generics.has_self;
314 let mut child_types = 0;
315 if let Some(def_id) = generics.parent {
317 assert!(is_value_path);
318 child_types = child_own_counts.types;
319 generics = tcx.generics_of(def_id);
320 own_counts = generics.own_counts();
323 print!(f, self, write("<"), print_display(substs.type_at(0)), write(" as "))?;
326 path_def_id = def_id;
332 assert_eq!(has_self, false);
335 own_counts = child_own_counts;
340 let mut type_params =
341 generics.params.iter().rev().filter_map(|param| match param.kind {
342 GenericParamDefKind::Lifetime => None,
343 GenericParamDefKind::Type { has_default, .. } => {
344 Some((param.def_id, has_default))
348 let has_default = type_params.peek().map(|(_, has_default)| has_default);
349 *has_default.unwrap_or(&false)
352 if let Some(substs) = tcx.lift(&substs) {
353 let types = substs.types().rev().skip(child_types);
354 for ((def_id, has_default), actual) in type_params.zip(types) {
358 if tcx.type_of(def_id).subst(tcx, substs) != actual {
361 num_supplied_defaults += 1;
367 print!(f, self, write("{}", tcx.item_path_str(path_def_id)))?;
368 Ok(tcx.lang_items().fn_trait_kind(path_def_id))
371 if !verbose && fn_trait_kind.is_some() && projections.len() == 1 {
372 let projection_ty = projections[0].ty;
373 if let Tuple(ref args) = substs.type_at(1).sty {
374 return self.fn_sig(f, args, false, projection_ty);
378 let empty = Cell::new(true);
379 let start_or_continue = |f: &mut F, start: &str, cont: &str| {
382 write!(f, "{}", start)
384 write!(f, "{}", cont)
388 let print_regions = |f: &mut F, start: &str, skip, count| {
389 // Don't print any regions if they're all erased.
390 let regions = || substs.regions().skip(skip).take(count);
391 if regions().all(|r: ty::Region| *r == ty::ReErased) {
395 for region in regions() {
396 let region: ty::Region = region;
397 start_or_continue(f, start, ", ")?;
399 write!(f, "{:?}", region)?;
401 let s = region.to_string();
403 // This happens when the value of the region
404 // parameter is not easily serialized. This may be
405 // because the user omitted it in the first place,
406 // or because it refers to some block in the code,
407 // etc. I'm not sure how best to serialize this.
418 print_regions(f, "<", 0, own_counts.lifetimes)?;
420 let tps = substs.types()
421 .take(own_counts.types - num_supplied_defaults)
422 .skip(has_self as usize);
425 start_or_continue(f, "<", ", ")?;
426 ty.print_display(f, self)?;
429 for projection in projections {
430 start_or_continue(f, "<", ", ")?;
434 tcx.associated_item(projection.projection_ty.item_def_id).ident),
435 print_display(projection.ty))
439 start_or_continue(f, "", ">")?;
441 // For values, also print their name and type parameters.
449 if let Some(item_name) = item_name {
450 write!(f, "::{}", item_name)?;
453 print_regions(f, "::<", own_counts.lifetimes, usize::MAX)?;
455 // FIXME: consider being smart with defaults here too
456 for ty in substs.types().skip(own_counts.types) {
457 start_or_continue(f, "::<", ", ")?;
458 ty.print_display(f, self)?;
461 start_or_continue(f, "", ">")?;
467 fn in_binder<'a, 'gcx, 'tcx, T, U, F>(&mut self,
469 tcx: TyCtxt<'a, 'gcx, 'tcx>,
470 original: &ty::Binder<T>,
471 lifted: Option<ty::Binder<U>>) -> fmt::Result
472 where T: Print, U: Print + TypeFoldable<'tcx>, F: fmt::Write
474 fn name_by_region_index(index: usize) -> InternedString {
476 0 => Symbol::intern("'r"),
477 1 => Symbol::intern("'s"),
478 i => Symbol::intern(&format!("'t{}", i-2)),
482 // Replace any anonymous late-bound regions with named
483 // variants, using gensym'd identifiers, so that we can
484 // clearly differentiate between named and unnamed regions in
485 // the output. We'll probably want to tweak this over time to
486 // decide just how much information to give.
487 let value = if let Some(v) = lifted {
490 return original.skip_binder().print_display(f, self);
493 if self.binder_depth == 0 {
494 self.prepare_late_bound_region_info(&value);
497 let mut empty = true;
498 let mut start_or_continue = |f: &mut F, start: &str, cont: &str| {
501 write!(f, "{}", start)
503 write!(f, "{}", cont)
507 let old_region_index = self.region_index;
508 let mut region_index = old_region_index;
509 let new_value = tcx.replace_late_bound_regions(&value, |br| {
510 let _ = start_or_continue(f, "for<", ", ");
512 ty::BrNamed(_, name) => {
513 let _ = write!(f, "{}", name);
520 let name = name_by_region_index(region_index);
522 if !self.is_name_used(&name) {
526 let _ = write!(f, "{}", name);
527 ty::BrNamed(tcx.hir.local_def_id(CRATE_NODE_ID), name)
530 tcx.mk_region(ty::ReLateBound(ty::INNERMOST, br))
532 start_or_continue(f, "", "> ")?;
534 // Push current state to gcx, and restore after writing new_value.
535 self.binder_depth += 1;
536 self.region_index = region_index;
537 let result = new_value.print_display(f, self);
538 self.region_index = old_region_index;
539 self.binder_depth -= 1;
543 fn is_name_used(&self, name: &InternedString) -> bool {
544 match self.used_region_names {
545 Some(ref names) => names.contains(name),
551 pub fn verbose() -> bool {
552 ty::tls::with(|tcx| tcx.sess.verbose())
555 pub fn identify_regions() -> bool {
556 ty::tls::with(|tcx| tcx.sess.opts.debugging_opts.identify_regions)
559 pub fn parameterized<F: fmt::Write>(f: &mut F,
560 substs: &subst::Substs,
562 projections: &[ty::ProjectionPredicate])
564 PrintContext::new().parameterized(f, substs, did, projections)
567 fn get_highlight_region() -> Option<(RegionVid, usize)> {
568 HIGHLIGHT_REGION.with(|hr| hr.get())
571 pub fn with_highlight_region<R>(r: RegionVid, counter: usize, op: impl FnOnce() -> R) -> R {
572 HIGHLIGHT_REGION.with(|hr| {
573 assert_eq!(hr.get(), None);
574 hr.set(Some((r, counter)));
581 impl<'a, T: Print> Print for &'a T {
582 fn print<F: fmt::Write>(&self, f: &mut F, cx: &mut PrintContext) -> fmt::Result {
588 ('tcx) &'tcx ty::List<ty::ExistentialPredicate<'tcx>>, (self, f, cx) {
590 // Generate the main trait ref, including associated types.
591 ty::tls::with(|tcx| {
592 // Use a type that can't appear in defaults of type parameters.
593 let dummy_self = tcx.mk_infer(ty::FreshTy(0));
595 if let Some(p) = self.principal() {
596 let principal = tcx.lift(&p).expect("could not lift TraitRef for printing")
597 .with_self_ty(tcx, dummy_self);
598 let projections = self.projection_bounds().map(|p| {
600 .expect("could not lift projection for printing")
601 .with_self_ty(tcx, dummy_self)
602 }).collect::<Vec<_>>();
603 cx.parameterized(f, principal.substs, principal.def_id, &projections)?;
607 for did in self.auto_traits() {
608 write!(f, " + {}", tcx.item_path_str(did))?;
619 impl fmt::Debug for ty::GenericParamDef {
620 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
621 let type_name = match self.kind {
622 ty::GenericParamDefKind::Lifetime => "Lifetime",
623 ty::GenericParamDefKind::Type {..} => "Type",
625 write!(f, "{}({}, {:?}, {})",
633 impl fmt::Debug for ty::TraitDef {
634 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
635 ty::tls::with(|tcx| {
636 write!(f, "{}", tcx.item_path_str(self.def_id))
641 impl fmt::Debug for ty::AdtDef {
642 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
643 ty::tls::with(|tcx| {
644 write!(f, "{}", tcx.item_path_str(self.did))
649 impl<'tcx> fmt::Debug for ty::ClosureUpvar<'tcx> {
650 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
651 write!(f, "ClosureUpvar({:?},{:?})",
657 impl fmt::Debug for ty::UpvarId {
658 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
659 write!(f, "UpvarId({:?};`{}`;{:?})",
661 ty::tls::with(|tcx| tcx.hir.name(tcx.hir.hir_to_node_id(self.var_id))),
662 self.closure_expr_id)
666 impl<'tcx> fmt::Debug for ty::UpvarBorrow<'tcx> {
667 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
668 write!(f, "UpvarBorrow({:?}, {:?})",
669 self.kind, self.region)
674 ('tcx) &'tcx ty::List<Ty<'tcx>>, (self, f, cx) {
677 let mut tys = self.iter();
678 if let Some(&ty) = tys.next() {
679 print!(f, cx, print(ty))?;
681 print!(f, cx, write(", "), print(ty))?;
690 ('tcx) ty::TypeAndMut<'tcx>, (self, f, cx) {
693 write("{}", if self.mutbl == hir::MutMutable { "mut " } else { "" }),
700 ('tcx) ty::ExistentialTraitRef<'tcx>, (self, f, cx) {
702 ty::tls::with(|tcx| {
703 let dummy_self = tcx.mk_infer(ty::FreshTy(0));
705 let trait_ref = *tcx.lift(&ty::Binder::bind(*self))
706 .expect("could not lift TraitRef for printing")
707 .with_self_ty(tcx, dummy_self).skip_binder();
708 cx.parameterized(f, trait_ref.substs, trait_ref.def_id, &[])
715 ('tcx) ty::adjustment::Adjustment<'tcx>, (self, f, cx) {
717 print!(f, cx, write("{:?} -> ", self.kind), print(self.target))
723 () ty::BoundRegion, (self, f, cx) {
726 return self.print_debug(f, cx);
730 BrNamed(_, name) => write!(f, "{}", name),
731 BrAnon(_) | BrFresh(_) | BrEnv => Ok(())
736 BrAnon(n) => write!(f, "BrAnon({:?})", n),
737 BrFresh(n) => write!(f, "BrFresh({:?})", n),
738 BrNamed(did, name) => {
739 write!(f, "BrNamed({:?}:{:?}, {})",
740 did.krate, did.index, name)
742 BrEnv => write!(f, "BrEnv"),
749 () ty::RegionKind, (self, f, cx) {
751 if cx.is_verbose || get_highlight_region().is_some() {
752 return self.print_debug(f, cx);
755 // These printouts are concise. They do not contain all the information
756 // the user might want to diagnose an error, but there is basically no way
757 // to fit that into a short string. Hence the recommendation to use
758 // `explain_region()` or `note_and_explain_region()`.
760 ty::ReEarlyBound(ref data) => {
761 write!(f, "{}", data.name)
763 ty::ReCanonical(_) => {
766 ty::ReLateBound(_, br) |
767 ty::ReFree(ty::FreeRegion { bound_region: br, .. }) |
768 ty::ReSkolemized(_, br) => {
771 ty::ReScope(scope) if cx.identify_regions => {
773 region::ScopeData::Node =>
774 write!(f, "'{}s", scope.item_local_id().as_usize()),
775 region::ScopeData::CallSite =>
776 write!(f, "'{}cs", scope.item_local_id().as_usize()),
777 region::ScopeData::Arguments =>
778 write!(f, "'{}as", scope.item_local_id().as_usize()),
779 region::ScopeData::Destruction =>
780 write!(f, "'{}ds", scope.item_local_id().as_usize()),
781 region::ScopeData::Remainder(first_statement_index) => write!(
784 scope.item_local_id().as_usize(),
785 first_statement_index.index()
789 ty::ReVar(region_vid) if cx.identify_regions => {
790 write!(f, "'{}rv", region_vid.index())
794 ty::ReErased => Ok(()),
795 ty::ReStatic => write!(f, "'static"),
796 ty::ReEmpty => write!(f, "'<empty>"),
798 // The user should never encounter these in unsubstituted form.
799 ty::ReClosureBound(vid) => write!(f, "{:?}", vid),
804 ty::ReEarlyBound(ref data) => {
805 write!(f, "ReEarlyBound({}, {})",
810 ty::ReClosureBound(ref vid) => {
811 write!(f, "ReClosureBound({:?})",
815 ty::ReLateBound(binder_id, ref bound_region) => {
816 write!(f, "ReLateBound({:?}, {:?})",
821 ty::ReFree(ref fr) => write!(f, "{:?}", fr),
824 write!(f, "ReScope({:?})", id)
827 ty::ReStatic => write!(f, "ReStatic"),
829 ty::ReVar(ref vid) => {
830 write!(f, "{:?}", vid)
833 ty::ReCanonical(c) => {
834 write!(f, "'?{}", c.index())
837 ty::ReSkolemized(universe, ref bound_region) => {
838 write!(f, "ReSkolemized({:?}, {:?})", universe, bound_region)
841 ty::ReEmpty => write!(f, "ReEmpty"),
843 ty::ReErased => write!(f, "ReErased")
850 () ty::FreeRegion, (self, f, cx) {
852 write!(f, "ReFree({:?}, {:?})", self.scope, self.bound_region)
858 () ty::Variance, (self, f, cx) {
860 f.write_str(match *self {
861 ty::Covariant => "+",
862 ty::Contravariant => "-",
863 ty::Invariant => "o",
864 ty::Bivariant => "*",
871 ('tcx) ty::GenericPredicates<'tcx>, (self, f, cx) {
873 write!(f, "GenericPredicates({:?})", self.predicates)
879 ('tcx) ty::InstantiatedPredicates<'tcx>, (self, f, cx) {
881 write!(f, "InstantiatedPredicates({:?})", self.predicates)
887 ('tcx) ty::FnSig<'tcx>, (self, f, cx) {
889 if self.unsafety == hir::Unsafety::Unsafe {
890 write!(f, "unsafe ")?;
893 if self.abi != Abi::Rust {
894 write!(f, "extern {} ", self.abi)?;
898 cx.fn_sig(f, self.inputs(), self.variadic, self.output())
901 write!(f, "({:?}; variadic: {})->{:?}", self.inputs(), self.variadic, self.output())
906 impl fmt::Debug for ty::TyVid {
907 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
908 write!(f, "_#{}t", self.index)
912 impl fmt::Debug for ty::IntVid {
913 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
914 write!(f, "_#{}i", self.index)
918 impl fmt::Debug for ty::FloatVid {
919 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
920 write!(f, "_#{}f", self.index)
924 impl fmt::Debug for ty::RegionVid {
925 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
926 if let Some((region, counter)) = get_highlight_region() {
927 debug!("RegionVid.fmt: region={:?} self={:?} counter={:?}", region, self, counter);
928 return if *self == region {
929 write!(f, "'{:?}", counter)
935 write!(f, "'_#{}r", self.index())
940 () ty::InferTy, (self, f, cx) {
943 print!(f, cx, print_debug(self))
946 ty::TyVar(_) => write!(f, "_"),
947 ty::IntVar(_) => write!(f, "{}", "{integer}"),
948 ty::FloatVar(_) => write!(f, "{}", "{float}"),
949 ty::CanonicalTy(_) => write!(f, "_"),
950 ty::FreshTy(v) => write!(f, "FreshTy({})", v),
951 ty::FreshIntTy(v) => write!(f, "FreshIntTy({})", v),
952 ty::FreshFloatTy(v) => write!(f, "FreshFloatTy({})", v)
958 ty::TyVar(ref v) => write!(f, "{:?}", v),
959 ty::IntVar(ref v) => write!(f, "{:?}", v),
960 ty::FloatVar(ref v) => write!(f, "{:?}", v),
961 ty::CanonicalTy(v) => write!(f, "?{:?}", v.index()),
962 ty::FreshTy(v) => write!(f, "FreshTy({:?})", v),
963 ty::FreshIntTy(v) => write!(f, "FreshIntTy({:?})", v),
964 ty::FreshFloatTy(v) => write!(f, "FreshFloatTy({:?})", v)
970 impl fmt::Debug for ty::IntVarValue {
971 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
973 ty::IntType(ref v) => v.fmt(f),
974 ty::UintType(ref v) => v.fmt(f),
979 impl fmt::Debug for ty::FloatVarValue {
980 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
985 // The generic impl doesn't work yet because projections are not
986 // normalized under HRTB.
987 /*impl<T> fmt::Display for ty::Binder<T>
988 where T: fmt::Display + for<'a> ty::Lift<'a>,
989 for<'a> <T as ty::Lift<'a>>::Lifted: fmt::Display + TypeFoldable<'a>
991 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
992 ty::tls::with(|tcx| in_binder(f, tcx, self, tcx.lift(self)))
996 define_print_multi! {
998 ('tcx) ty::Binder<&'tcx ty::List<ty::ExistentialPredicate<'tcx>>>,
999 ('tcx) ty::Binder<ty::TraitRef<'tcx>>,
1000 ('tcx) ty::Binder<ty::FnSig<'tcx>>,
1001 ('tcx) ty::Binder<ty::TraitPredicate<'tcx>>,
1002 ('tcx) ty::Binder<ty::SubtypePredicate<'tcx>>,
1003 ('tcx) ty::Binder<ty::ProjectionPredicate<'tcx>>,
1004 ('tcx) ty::Binder<ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>>,
1005 ('tcx) ty::Binder<ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>>
1009 ty::tls::with(|tcx| cx.in_binder(f, tcx, self, tcx.lift(self)))
1015 ('tcx) ty::TraitRef<'tcx>, (self, f, cx) {
1017 cx.parameterized(f, self.substs, self.def_id, &[])
1020 // when printing out the debug representation, we don't need
1021 // to enumerate the `for<...>` etc because the debruijn index
1022 // tells you everything you need to know.
1025 print(self.self_ty()),
1027 cx.parameterized(f, self.substs, self.def_id, &[])?;
1034 ('tcx) ty::TyKind<'tcx>, (self, f, cx) {
1037 Bool => write!(f, "bool"),
1038 Char => write!(f, "char"),
1039 Int(t) => write!(f, "{}", t.ty_to_string()),
1040 Uint(t) => write!(f, "{}", t.ty_to_string()),
1041 Float(t) => write!(f, "{}", t.ty_to_string()),
1043 write!(f, "*{} ", match tm.mutbl {
1044 hir::MutMutable => "mut",
1045 hir::MutImmutable => "const",
1049 Ref(r, ty, mutbl) => {
1051 let s = r.print_to_string(cx);
1053 write!(f, "{}", s)?;
1058 ty::TypeAndMut { ty, mutbl }.print(f, cx)
1060 Never => write!(f, "!"),
1063 let mut tys = tys.iter();
1064 if let Some(&ty) = tys.next() {
1065 print!(f, cx, print(ty), write(","))?;
1066 if let Some(&ty) = tys.next() {
1067 print!(f, cx, write(" "), print(ty))?;
1069 print!(f, cx, write(", "), print(ty))?;
1075 FnDef(def_id, substs) => {
1076 ty::tls::with(|tcx| {
1077 let mut sig = tcx.fn_sig(def_id);
1078 if let Some(substs) = tcx.lift(&substs) {
1079 sig = sig.subst(tcx, substs);
1081 print!(f, cx, print(sig), write(" {{"))
1083 cx.parameterized(f, substs, def_id, &[])?;
1086 FnPtr(ref bare_fn) => {
1087 bare_fn.print(f, cx)
1089 Infer(infer_ty) => write!(f, "{}", infer_ty),
1090 Error => write!(f, "[type error]"),
1091 Param(ref param_ty) => write!(f, "{}", param_ty),
1092 Adt(def, substs) => cx.parameterized(f, substs, def.did, &[]),
1093 Dynamic(data, r) => {
1094 let r = r.print_to_string(cx);
1101 write!(f, " + {})", r)
1106 Foreign(def_id) => parameterized(f, subst::Substs::empty(), def_id, &[]),
1107 Projection(ref data) => data.print(f, cx),
1108 Opaque(def_id, substs) => {
1110 return write!(f, "Opaque({:?}, {:?})", def_id, substs);
1113 ty::tls::with(|tcx| {
1114 let def_key = tcx.def_key(def_id);
1115 if let Some(name) = def_key.disambiguated_data.data.get_opt_name() {
1116 write!(f, "{}", name)?;
1117 let mut substs = substs.iter();
1118 if let Some(first) = substs.next() {
1120 write!(f, "{}", first)?;
1121 for subst in substs {
1122 write!(f, ", {}", subst)?;
1128 // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
1129 // by looking up the projections associated with the def_id.
1130 let predicates_of = tcx.predicates_of(def_id);
1131 let substs = tcx.lift(&substs).unwrap_or_else(|| {
1132 tcx.intern_substs(&[])
1134 let bounds = predicates_of.instantiate(tcx, substs);
1136 let mut first = true;
1137 let mut is_sized = false;
1139 for predicate in bounds.predicates {
1140 if let Some(trait_ref) = predicate.to_opt_poly_trait_ref() {
1141 // Don't print +Sized, but rather +?Sized if absent.
1142 if Some(trait_ref.def_id()) == tcx.lang_items().sized_trait() {
1148 write("{}", if first { " " } else { "+" }),
1154 write!(f, "{}?Sized", if first { " " } else { "+" })?;
1159 Str => write!(f, "str"),
1160 Generator(did, substs, movability) => ty::tls::with(|tcx| {
1161 let upvar_tys = substs.upvar_tys(did, tcx);
1162 let witness = substs.witness(did, tcx);
1163 if movability == hir::GeneratorMovability::Movable {
1164 write!(f, "[generator")?;
1166 write!(f, "[static generator")?;
1169 if let Some(node_id) = tcx.hir.as_local_node_id(did) {
1170 write!(f, "@{:?}", tcx.hir.span(node_id))?;
1172 tcx.with_freevars(node_id, |freevars| {
1173 for (freevar, upvar_ty) in freevars.iter().zip(upvar_tys) {
1177 tcx.hir.name(freevar.var_id())),
1184 // cross-crate closure types should only be
1185 // visible in codegen bug reports, I imagine.
1186 write!(f, "@{:?}", did)?;
1188 for (index, upvar_ty) in upvar_tys.enumerate() {
1190 write("{}{}:", sep, index),
1196 print!(f, cx, write(" "), print(witness), write("]"))
1198 GeneratorWitness(types) => {
1199 ty::tls::with(|tcx| cx.in_binder(f, tcx, &types, tcx.lift(&types)))
1201 Closure(did, substs) => ty::tls::with(|tcx| {
1202 let upvar_tys = substs.upvar_tys(did, tcx);
1203 write!(f, "[closure")?;
1205 if let Some(node_id) = tcx.hir.as_local_node_id(did) {
1206 if tcx.sess.opts.debugging_opts.span_free_formats {
1207 write!(f, "@{:?}", node_id)?;
1209 write!(f, "@{:?}", tcx.hir.span(node_id))?;
1212 tcx.with_freevars(node_id, |freevars| {
1213 for (freevar, upvar_ty) in freevars.iter().zip(upvar_tys) {
1217 tcx.hir.name(freevar.var_id())),
1224 // cross-crate closure types should only be
1225 // visible in codegen bug reports, I imagine.
1226 write!(f, "@{:?}", did)?;
1228 for (index, upvar_ty) in upvar_tys.enumerate() {
1230 write("{}{}:", sep, index),
1239 print!(f, cx, write("["), print(ty), write("; "))?;
1241 ConstValue::Unevaluated(_def_id, _substs) => {
1244 _ => ty::tls::with(|tcx| {
1245 write!(f, "{}", sz.unwrap_usize(tcx))
1251 print!(f, cx, write("["), print(ty), write("]"))
1259 ('tcx) ty::TyS<'tcx>, (self, f, cx) {
1261 self.sty.print(f, cx)
1264 self.sty.print_display(f, cx)
1270 () ty::ParamTy, (self, f, cx) {
1272 write!(f, "{}", self.name)
1275 write!(f, "{}/#{}", self.name, self.idx)
1281 ('tcx, T: Print + fmt::Debug, U: Print + fmt::Debug) ty::OutlivesPredicate<T, U>,
1284 print!(f, cx, print(self.0), write(" : "), print(self.1))
1290 ('tcx) ty::SubtypePredicate<'tcx>, (self, f, cx) {
1292 print!(f, cx, print(self.a), write(" <: "), print(self.b))
1298 ('tcx) ty::TraitPredicate<'tcx>, (self, f, cx) {
1300 write!(f, "TraitPredicate({:?})",
1304 print!(f, cx, print(self.trait_ref.self_ty()), write(": "), print(self.trait_ref))
1310 ('tcx) ty::ProjectionPredicate<'tcx>, (self, f, cx) {
1313 write("ProjectionPredicate("),
1314 print(self.projection_ty),
1320 print!(f, cx, print(self.projection_ty), write(" == "), print(self.ty))
1326 ('tcx) ty::ProjectionTy<'tcx>, (self, f, cx) {
1328 // FIXME(tschottdorf): use something like
1329 // parameterized(f, self.substs, self.item_def_id, &[])
1330 // (which currently ICEs).
1331 let (trait_ref, item_name) = ty::tls::with(|tcx|
1332 (self.trait_ref(tcx), tcx.associated_item(self.item_def_id).ident)
1334 print!(f, cx, print_debug(trait_ref), write("::{}", item_name))
1340 () ty::ClosureKind, (self, f, cx) {
1343 ty::ClosureKind::Fn => write!(f, "Fn"),
1344 ty::ClosureKind::FnMut => write!(f, "FnMut"),
1345 ty::ClosureKind::FnOnce => write!(f, "FnOnce"),
1352 ('tcx) ty::Predicate<'tcx>, (self, f, cx) {
1355 ty::Predicate::Trait(ref data) => data.print(f, cx),
1356 ty::Predicate::Subtype(ref predicate) => predicate.print(f, cx),
1357 ty::Predicate::RegionOutlives(ref predicate) => predicate.print(f, cx),
1358 ty::Predicate::TypeOutlives(ref predicate) => predicate.print(f, cx),
1359 ty::Predicate::Projection(ref predicate) => predicate.print(f, cx),
1360 ty::Predicate::WellFormed(ty) => print!(f, cx, print(ty), write(" well-formed")),
1361 ty::Predicate::ObjectSafe(trait_def_id) =>
1362 ty::tls::with(|tcx| {
1363 write!(f, "the trait `{}` is object-safe", tcx.item_path_str(trait_def_id))
1365 ty::Predicate::ClosureKind(closure_def_id, _closure_substs, kind) =>
1366 ty::tls::with(|tcx| {
1367 write!(f, "the closure `{}` implements the trait `{}`",
1368 tcx.item_path_str(closure_def_id), kind)
1370 ty::Predicate::ConstEvaluatable(def_id, substs) => {
1371 write!(f, "the constant `")?;
1372 cx.parameterized(f, substs, def_id, &[])?;
1373 write!(f, "` can be evaluated")
1379 ty::Predicate::Trait(ref a) => a.print(f, cx),
1380 ty::Predicate::Subtype(ref pair) => pair.print(f, cx),
1381 ty::Predicate::RegionOutlives(ref pair) => pair.print(f, cx),
1382 ty::Predicate::TypeOutlives(ref pair) => pair.print(f, cx),
1383 ty::Predicate::Projection(ref pair) => pair.print(f, cx),
1384 ty::Predicate::WellFormed(ty) => ty.print(f, cx),
1385 ty::Predicate::ObjectSafe(trait_def_id) => {
1386 write!(f, "ObjectSafe({:?})", trait_def_id)
1388 ty::Predicate::ClosureKind(closure_def_id, closure_substs, kind) => {
1389 write!(f, "ClosureKind({:?}, {:?}, {:?})", closure_def_id, closure_substs, kind)
1391 ty::Predicate::ConstEvaluatable(def_id, substs) => {
1392 write!(f, "ConstEvaluatable({:?}, {:?})", def_id, substs)