]> git.lizzy.rs Git - rust.git/blob - src/librustc/util/ppaux.rs
auto merge of #17654 : gereeter/rust/no-unnecessary-cell, r=alexcrichton
[rust.git] / src / librustc / util / ppaux.rs
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.
4 //
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.
10
11
12 use middle::def;
13 use middle::subst::{VecPerParamSpace,Subst};
14 use middle::subst;
15 use middle::ty::{BoundRegion, BrAnon, BrNamed};
16 use middle::ty::{ReEarlyBound, BrFresh, ctxt};
17 use middle::ty::{ReFree, ReScope, ReInfer, ReStatic, Region, ReEmpty};
18 use middle::ty::{ReSkolemized, ReVar};
19 use middle::ty::{mt, t, ParamTy};
20 use middle::ty::{ty_bool, ty_char, ty_bot, ty_box, ty_struct, ty_enum};
21 use middle::ty::{ty_err, ty_str, ty_vec, ty_float, ty_bare_fn, ty_closure};
22 use middle::ty::{ty_nil, ty_param, ty_ptr, ty_rptr, ty_tup, ty_open};
23 use middle::ty::{ty_unboxed_closure};
24 use middle::ty::{ty_uniq, ty_trait, ty_int, ty_uint, ty_infer};
25 use middle::ty;
26 use middle::typeck;
27 use middle::typeck::check::regionmanip;
28
29 use std::rc::Rc;
30 use syntax::abi;
31 use syntax::ast_map;
32 use syntax::codemap::{Span, Pos};
33 use syntax::parse::token;
34 use syntax::print::pprust;
35 use syntax::{ast, ast_util};
36 use syntax::owned_slice::OwnedSlice;
37
38 /// Produces a string suitable for debugging output.
39 pub trait Repr {
40     fn repr(&self, tcx: &ctxt) -> String;
41 }
42
43 /// Produces a string suitable for showing to the user.
44 pub trait UserString {
45     fn user_string(&self, tcx: &ctxt) -> String;
46 }
47
48 pub fn note_and_explain_region(cx: &ctxt,
49                                prefix: &str,
50                                region: ty::Region,
51                                suffix: &str) {
52     match explain_region_and_span(cx, region) {
53       (ref str, Some(span)) => {
54         cx.sess.span_note(
55             span,
56             format!("{}{}{}", prefix, *str, suffix).as_slice());
57       }
58       (ref str, None) => {
59         cx.sess.note(
60             format!("{}{}{}", prefix, *str, suffix).as_slice());
61       }
62     }
63 }
64
65 fn item_scope_tag(item: &ast::Item) -> &'static str {
66     /*!
67      * When a free region is associated with `item`, how should we describe
68      * the item in the error message.
69      */
70
71     match item.node {
72         ast::ItemImpl(..) => "impl",
73         ast::ItemStruct(..) => "struct",
74         ast::ItemEnum(..) => "enum",
75         ast::ItemTrait(..) => "trait",
76         ast::ItemFn(..) => "function body",
77         _ => "item"
78     }
79 }
80
81 pub fn explain_region_and_span(cx: &ctxt, region: ty::Region)
82                             -> (String, Option<Span>) {
83     return match region {
84       ReScope(node_id) => {
85         match cx.map.find(node_id) {
86           Some(ast_map::NodeBlock(ref blk)) => {
87             explain_span(cx, "block", blk.span)
88           }
89           Some(ast_map::NodeExpr(expr)) => {
90             match expr.node {
91               ast::ExprCall(..) => explain_span(cx, "call", expr.span),
92               ast::ExprMethodCall(..) => {
93                 explain_span(cx, "method call", expr.span)
94               },
95               ast::ExprMatch(_, _, ast::MatchIfLetDesugar) => explain_span(cx, "if let", expr.span),
96               ast::ExprMatch(..) => explain_span(cx, "match", expr.span),
97               _ => explain_span(cx, "expression", expr.span)
98             }
99           }
100           Some(ast_map::NodeStmt(stmt)) => {
101               explain_span(cx, "statement", stmt.span)
102           }
103           Some(ast_map::NodeItem(it)) => {
104               let tag = item_scope_tag(&*it);
105               explain_span(cx, tag, it.span)
106           }
107           Some(_) | None => {
108             // this really should not happen
109             (format!("unknown scope: {}.  Please report a bug.", node_id), None)
110           }
111         }
112       }
113
114       ReFree(ref fr) => {
115         let prefix = match fr.bound_region {
116           BrAnon(idx) => {
117               format!("the anonymous lifetime #{} defined on", idx + 1)
118           }
119           BrFresh(_) => "an anonymous lifetime defined on".to_string(),
120           _ => {
121               format!("the lifetime {} as defined on",
122                       bound_region_ptr_to_string(cx, fr.bound_region))
123           }
124         };
125
126         match cx.map.find(fr.scope_id) {
127           Some(ast_map::NodeBlock(ref blk)) => {
128               let (msg, opt_span) = explain_span(cx, "block", blk.span);
129               (format!("{} {}", prefix, msg), opt_span)
130           }
131           Some(ast_map::NodeItem(it)) => {
132               let tag = item_scope_tag(&*it);
133               let (msg, opt_span) = explain_span(cx, tag, it.span);
134               (format!("{} {}", prefix, msg), opt_span)
135           }
136           Some(_) | None => {
137               // this really should not happen
138               (format!("{} node {}", prefix, fr.scope_id), None)
139           }
140         }
141       }
142
143       ReStatic => { ("the static lifetime".to_string(), None) }
144
145       ReEmpty => { ("the empty lifetime".to_string(), None) }
146
147       ReEarlyBound(_, _, _, name) => {
148         (format!("{}", token::get_name(name)), None)
149       }
150
151       // I believe these cases should not occur (except when debugging,
152       // perhaps)
153       ty::ReInfer(_) | ty::ReLateBound(..) => {
154         (format!("lifetime {:?}", region), None)
155       }
156     };
157
158     fn explain_span(cx: &ctxt, heading: &str, span: Span)
159                     -> (String, Option<Span>) {
160         let lo = cx.sess.codemap().lookup_char_pos_adj(span.lo);
161         (format!("the {} at {}:{}", heading, lo.line, lo.col.to_uint()),
162          Some(span))
163     }
164 }
165
166 pub fn bound_region_ptr_to_string(cx: &ctxt, br: BoundRegion) -> String {
167     bound_region_to_string(cx, "", false, br)
168 }
169
170 pub fn bound_region_to_string(cx: &ctxt,
171                            prefix: &str, space: bool,
172                            br: BoundRegion) -> String {
173     let space_str = if space { " " } else { "" };
174
175     if cx.sess.verbose() {
176         return format!("{}{}{}", prefix, br.repr(cx), space_str)
177     }
178
179     match br {
180         BrNamed(_, name) => {
181             format!("{}{}{}", prefix, token::get_name(name), space_str)
182         }
183         BrAnon(_) => prefix.to_string(),
184         BrFresh(_) => prefix.to_string(),
185     }
186 }
187
188 // In general, if you are giving a region error message,
189 // you should use `explain_region()` or, better yet,
190 // `note_and_explain_region()`
191 pub fn region_ptr_to_string(cx: &ctxt, region: Region) -> String {
192     region_to_string(cx, "&", true, region)
193 }
194
195 pub fn region_to_string(cx: &ctxt, prefix: &str, space: bool, region: Region) -> String {
196     let space_str = if space { " " } else { "" };
197
198     if cx.sess.verbose() {
199         return format!("{}{}{}", prefix, region.repr(cx), space_str)
200     }
201
202     // These printouts are concise.  They do not contain all the information
203     // the user might want to diagnose an error, but there is basically no way
204     // to fit that into a short string.  Hence the recommendation to use
205     // `explain_region()` or `note_and_explain_region()`.
206     match region {
207         ty::ReScope(_) => prefix.to_string(),
208         ty::ReEarlyBound(_, _, _, name) => {
209             token::get_name(name).get().to_string()
210         }
211         ty::ReLateBound(_, br) => bound_region_to_string(cx, prefix, space, br),
212         ty::ReFree(ref fr) => bound_region_to_string(cx, prefix, space, fr.bound_region),
213         ty::ReInfer(ReSkolemized(_, br)) => {
214             bound_region_to_string(cx, prefix, space, br)
215         }
216         ty::ReInfer(ReVar(_)) => prefix.to_string(),
217         ty::ReStatic => format!("{}'static{}", prefix, space_str),
218         ty::ReEmpty => format!("{}'<empty>{}", prefix, space_str),
219     }
220 }
221
222 pub fn mutability_to_string(m: ast::Mutability) -> String {
223     match m {
224         ast::MutMutable => "mut ".to_string(),
225         ast::MutImmutable => "".to_string(),
226     }
227 }
228
229 pub fn mt_to_string(cx: &ctxt, m: &mt) -> String {
230     format!("{}{}", mutability_to_string(m.mutbl), ty_to_string(cx, m.ty))
231 }
232
233 pub fn trait_store_to_string(cx: &ctxt, s: ty::TraitStore) -> String {
234     match s {
235         ty::UniqTraitStore => "Box ".to_string(),
236         ty::RegionTraitStore(r, m) => {
237             format!("{}{}", region_ptr_to_string(cx, r), mutability_to_string(m))
238         }
239     }
240 }
241
242 pub fn vec_map_to_string<T>(ts: &[T], f: |t: &T| -> String) -> String {
243     let tstrs = ts.iter().map(f).collect::<Vec<String>>();
244     format!("[{}]", tstrs.connect(", "))
245 }
246
247 pub fn fn_sig_to_string(cx: &ctxt, typ: &ty::FnSig) -> String {
248     format!("fn{}{} -> {}", typ.binder_id, typ.inputs.repr(cx),
249             typ.output.repr(cx))
250 }
251
252 pub fn trait_ref_to_string(cx: &ctxt, trait_ref: &ty::TraitRef) -> String {
253     trait_ref.user_string(cx).to_string()
254 }
255
256 pub fn ty_to_string(cx: &ctxt, typ: t) -> String {
257     fn fn_input_to_string(cx: &ctxt, input: ty::t) -> String {
258         ty_to_string(cx, input).to_string()
259     }
260     fn bare_fn_to_string(cx: &ctxt,
261                       fn_style: ast::FnStyle,
262                       abi: abi::Abi,
263                       ident: Option<ast::Ident>,
264                       sig: &ty::FnSig)
265                       -> String {
266         let mut s = String::new();
267         match fn_style {
268             ast::NormalFn => {}
269             _ => {
270                 s.push_str(fn_style.to_string().as_slice());
271                 s.push_char(' ');
272             }
273         };
274
275         if abi != abi::Rust {
276             s.push_str(format!("extern {} ", abi.to_string()).as_slice());
277         };
278
279         s.push_str("fn");
280
281         match ident {
282             Some(i) => {
283                 s.push_char(' ');
284                 s.push_str(token::get_ident(i).get());
285             }
286             _ => { }
287         }
288
289         push_sig_to_string(cx, &mut s, '(', ')', sig, "");
290
291         s
292     }
293
294     fn closure_to_string(cx: &ctxt, cty: &ty::ClosureTy) -> String {
295         let mut s = String::new();
296
297         match cty.store {
298             ty::UniqTraitStore => {}
299             ty::RegionTraitStore(region, _) => {
300                 s.push_str(region_to_string(cx, "", true, region).as_slice());
301             }
302         }
303
304         match cty.fn_style {
305             ast::NormalFn => {}
306             _ => {
307                 s.push_str(cty.fn_style.to_string().as_slice());
308                 s.push_char(' ');
309             }
310         };
311
312         let bounds_str = cty.bounds.user_string(cx);
313
314         match cty.store {
315             ty::UniqTraitStore => {
316                 assert_eq!(cty.onceness, ast::Once);
317                 s.push_str("proc");
318                 push_sig_to_string(cx, &mut s, '(', ')', &cty.sig,
319                                    bounds_str.as_slice());
320             }
321             ty::RegionTraitStore(..) => {
322                 match cty.onceness {
323                     ast::Many => {}
324                     ast::Once => s.push_str("once ")
325                 }
326                 push_sig_to_string(cx, &mut s, '|', '|', &cty.sig,
327                                    bounds_str.as_slice());
328             }
329         }
330
331         s.into_owned()
332     }
333
334     fn push_sig_to_string(cx: &ctxt,
335                        s: &mut String,
336                        bra: char,
337                        ket: char,
338                        sig: &ty::FnSig,
339                        bounds: &str) {
340         s.push_char(bra);
341         let strs: Vec<String> = sig.inputs.iter().map(|a| fn_input_to_string(cx, *a)).collect();
342         s.push_str(strs.connect(", ").as_slice());
343         if sig.variadic {
344             s.push_str(", ...");
345         }
346         s.push_char(ket);
347
348         if !bounds.is_empty() {
349             s.push_str(":");
350             s.push_str(bounds);
351         }
352
353         if ty::get(sig.output).sty != ty_nil {
354             s.push_str(" -> ");
355             if ty::type_is_bot(sig.output) {
356                 s.push_char('!');
357             } else {
358                 s.push_str(ty_to_string(cx, sig.output).as_slice());
359             }
360         }
361     }
362
363     // if there is an id, print that instead of the structural type:
364     /*for def_id in ty::type_def_id(typ).iter() {
365         // note that this typedef cannot have type parameters
366         return ty::item_path_str(cx, *def_id);
367     }*/
368
369     // pretty print the structural type representation:
370     return match ty::get(typ).sty {
371       ty_nil => "()".to_string(),
372       ty_bot => "!".to_string(),
373       ty_bool => "bool".to_string(),
374       ty_char => "char".to_string(),
375       ty_int(t) => ast_util::int_ty_to_string(t, None).to_string(),
376       ty_uint(t) => ast_util::uint_ty_to_string(t, None).to_string(),
377       ty_float(t) => ast_util::float_ty_to_string(t).to_string(),
378       ty_box(typ) => format!("Gc<{}>", ty_to_string(cx, typ)),
379       ty_uniq(typ) => format!("Box<{}>", ty_to_string(cx, typ)),
380       ty_ptr(ref tm) => {
381           format!("*{} {}", match tm.mutbl {
382               ast::MutMutable => "mut",
383               ast::MutImmutable => "const",
384           }, ty_to_string(cx, tm.ty))
385       }
386       ty_rptr(r, ref tm) => {
387           let mut buf = region_ptr_to_string(cx, r);
388           buf.push_str(mt_to_string(cx, tm).as_slice());
389           buf
390       }
391       ty_open(typ) => format!("opened<{}>", ty_to_string(cx, typ)),
392       ty_tup(ref elems) => {
393         let strs: Vec<String> = elems.iter().map(|elem| ty_to_string(cx, *elem)).collect();
394         format!("({})", strs.connect(","))
395       }
396       ty_closure(ref f) => {
397           closure_to_string(cx, &**f)
398       }
399       ty_bare_fn(ref f) => {
400           bare_fn_to_string(cx, f.fn_style, f.abi, None, &f.sig)
401       }
402       ty_infer(infer_ty) => infer_ty.to_string(),
403       ty_err => "[type error]".to_string(),
404       ty_param(ref param_ty) => {
405           param_ty.repr(cx)
406       }
407       ty_enum(did, ref substs) | ty_struct(did, ref substs) => {
408           let base = ty::item_path_str(cx, did);
409           let generics = ty::lookup_item_type(cx, did).generics;
410           parameterized(cx, base.as_slice(), substs, &generics)
411       }
412       ty_trait(box ty::TyTrait {
413           def_id: did, ref substs, ref bounds
414       }) => {
415           let base = ty::item_path_str(cx, did);
416           let trait_def = ty::lookup_trait_def(cx, did);
417           let ty = parameterized(cx, base.as_slice(),
418                                  substs, &trait_def.generics);
419           let bound_str = bounds.user_string(cx);
420           let bound_sep = if bound_str.is_empty() { "" } else { "+" };
421           format!("{}{}{}",
422                   ty,
423                   bound_sep,
424                   bound_str)
425       }
426       ty_str => "str".to_string(),
427       ty_unboxed_closure(..) => "closure".to_string(),
428       ty_vec(t, sz) => {
429           match sz {
430               Some(n) => {
431                   format!("[{}, .. {}]", ty_to_string(cx, t), n)
432               }
433               None => format!("[{}]", ty_to_string(cx, t)),
434           }
435       }
436     }
437 }
438
439 pub fn explicit_self_category_to_str(category: &ty::ExplicitSelfCategory)
440                                      -> &'static str {
441     match *category {
442         ty::StaticExplicitSelfCategory => "static",
443         ty::ByValueExplicitSelfCategory => "self",
444         ty::ByReferenceExplicitSelfCategory(_, ast::MutMutable) => {
445             "&mut self"
446         }
447         ty::ByReferenceExplicitSelfCategory(_, ast::MutImmutable) => "&self",
448         ty::ByBoxExplicitSelfCategory => "Box<self>",
449     }
450 }
451
452 pub fn parameterized(cx: &ctxt,
453                      base: &str,
454                      substs: &subst::Substs,
455                      generics: &ty::Generics)
456                      -> String
457 {
458     let mut strs = Vec::new();
459
460     match substs.regions {
461         subst::ErasedRegions => { }
462         subst::NonerasedRegions(ref regions) => {
463             for &r in regions.iter() {
464                 let s = region_to_string(cx, "", false, r);
465                 if !s.is_empty() {
466                     strs.push(s)
467                 } else {
468                     // This happens when the value of the region
469                     // parameter is not easily serialized. This may be
470                     // because the user omitted it in the first place,
471                     // or because it refers to some block in the code,
472                     // etc. I'm not sure how best to serialize this.
473                     strs.push(format!("'_"));
474                 }
475             }
476         }
477     }
478
479     let tps = substs.types.get_slice(subst::TypeSpace);
480     let ty_params = generics.types.get_slice(subst::TypeSpace);
481     let has_defaults = ty_params.last().map_or(false, |def| def.default.is_some());
482     let num_defaults = if has_defaults && !cx.sess.verbose() {
483         ty_params.iter().zip(tps.iter()).rev().take_while(|&(def, &actual)| {
484             match def.default {
485                 Some(default) => default.subst(cx, substs) == actual,
486                 None => false
487             }
488         }).count()
489     } else {
490         0
491     };
492
493     for t in tps.slice_to(tps.len() - num_defaults).iter() {
494         strs.push(ty_to_string(cx, *t))
495     }
496
497     if cx.sess.verbose() {
498         for t in substs.types.get_slice(subst::SelfSpace).iter() {
499             strs.push(format!("self {}", t.repr(cx)));
500         }
501
502         // generally there shouldn't be any substs in the fn param
503         // space, but in verbose mode, print them out.
504         for t in substs.types.get_slice(subst::FnSpace).iter() {
505             strs.push(format!("fn {}", t.repr(cx)));
506         }
507     }
508
509     if strs.len() > 0u {
510         format!("{}<{}>", base, strs.connect(","))
511     } else {
512         format!("{}", base)
513     }
514 }
515
516 pub fn ty_to_short_str(cx: &ctxt, typ: t) -> String {
517     let mut s = typ.repr(cx).to_string();
518     if s.len() >= 32u {
519         s = s.as_slice().slice(0u, 32u).to_string();
520     }
521     return s;
522 }
523
524 impl<T:Repr> Repr for Option<T> {
525     fn repr(&self, tcx: &ctxt) -> String {
526         match self {
527             &None => "None".to_string(),
528             &Some(ref t) => t.repr(tcx),
529         }
530     }
531 }
532
533 impl<T:Repr,U:Repr> Repr for Result<T,U> {
534     fn repr(&self, tcx: &ctxt) -> String {
535         match self {
536             &Ok(ref t) => t.repr(tcx),
537             &Err(ref u) => format!("Err({})", u.repr(tcx))
538         }
539     }
540 }
541
542 impl Repr for () {
543     fn repr(&self, _tcx: &ctxt) -> String {
544         "()".to_string()
545     }
546 }
547
548 impl<'a,T:Repr> Repr for &'a T {
549     fn repr(&self, tcx: &ctxt) -> String {
550         (&**self).repr(tcx)
551     }
552 }
553
554 impl<T:Repr> Repr for Rc<T> {
555     fn repr(&self, tcx: &ctxt) -> String {
556         (&**self).repr(tcx)
557     }
558 }
559
560 impl<T:Repr> Repr for Box<T> {
561     fn repr(&self, tcx: &ctxt) -> String {
562         (&**self).repr(tcx)
563     }
564 }
565
566 fn repr_vec<T:Repr>(tcx: &ctxt, v: &[T]) -> String {
567     vec_map_to_string(v, |t| t.repr(tcx))
568 }
569
570 impl<'a, T:Repr> Repr for &'a [T] {
571     fn repr(&self, tcx: &ctxt) -> String {
572         repr_vec(tcx, *self)
573     }
574 }
575
576 impl<T:Repr> Repr for OwnedSlice<T> {
577     fn repr(&self, tcx: &ctxt) -> String {
578         repr_vec(tcx, self.as_slice())
579     }
580 }
581
582 // This is necessary to handle types like Option<~[T]>, for which
583 // autoderef cannot convert the &[T] handler
584 impl<T:Repr> Repr for Vec<T> {
585     fn repr(&self, tcx: &ctxt) -> String {
586         repr_vec(tcx, self.as_slice())
587     }
588 }
589
590 impl<T:UserString> UserString for Vec<T> {
591     fn user_string(&self, tcx: &ctxt) -> String {
592         let strs: Vec<String> =
593             self.iter().map(|t| t.user_string(tcx)).collect();
594         strs.connect(", ")
595     }
596 }
597
598 impl Repr for def::Def {
599     fn repr(&self, _tcx: &ctxt) -> String {
600         format!("{:?}", *self)
601     }
602 }
603
604 impl Repr for ty::TypeParameterDef {
605     fn repr(&self, tcx: &ctxt) -> String {
606         format!("TypeParameterDef({}, {}, {}/{})",
607                 self.def_id,
608                 self.bounds.repr(tcx),
609                 self.space,
610                 self.index)
611     }
612 }
613
614 impl Repr for ty::RegionParameterDef {
615     fn repr(&self, tcx: &ctxt) -> String {
616         format!("RegionParameterDef(name={}, def_id={}, bounds={})",
617                 token::get_name(self.name),
618                 self.def_id.repr(tcx),
619                 self.bounds.repr(tcx))
620     }
621 }
622
623 impl Repr for ty::t {
624     fn repr(&self, tcx: &ctxt) -> String {
625         ty_to_string(tcx, *self)
626     }
627 }
628
629 impl Repr for ty::mt {
630     fn repr(&self, tcx: &ctxt) -> String {
631         mt_to_string(tcx, self)
632     }
633 }
634
635 impl Repr for subst::Substs {
636     fn repr(&self, tcx: &ctxt) -> String {
637         format!("Substs[types={}, regions={}]",
638                        self.types.repr(tcx),
639                        self.regions.repr(tcx))
640     }
641 }
642
643 impl<T:Repr> Repr for subst::VecPerParamSpace<T> {
644     fn repr(&self, tcx: &ctxt) -> String {
645         format!("[{};{};{}]",
646                        self.get_slice(subst::TypeSpace).repr(tcx),
647                        self.get_slice(subst::SelfSpace).repr(tcx),
648                        self.get_slice(subst::FnSpace).repr(tcx))
649     }
650 }
651
652 impl Repr for ty::ItemSubsts {
653     fn repr(&self, tcx: &ctxt) -> String {
654         format!("ItemSubsts({})", self.substs.repr(tcx))
655     }
656 }
657
658 impl Repr for subst::RegionSubsts {
659     fn repr(&self, tcx: &ctxt) -> String {
660         match *self {
661             subst::ErasedRegions => "erased".to_string(),
662             subst::NonerasedRegions(ref regions) => regions.repr(tcx)
663         }
664     }
665 }
666
667 impl Repr for ty::BuiltinBounds {
668     fn repr(&self, _tcx: &ctxt) -> String {
669         let mut res = Vec::new();
670         for b in self.iter() {
671             res.push(match b {
672                 ty::BoundSend => "Send".to_owned(),
673                 ty::BoundSized => "Sized".to_owned(),
674                 ty::BoundCopy => "Copy".to_owned(),
675                 ty::BoundSync => "Sync".to_owned(),
676             });
677         }
678         res.connect("+")
679     }
680 }
681
682 impl Repr for ty::ExistentialBounds {
683     fn repr(&self, tcx: &ctxt) -> String {
684         self.user_string(tcx)
685     }
686 }
687
688 impl Repr for ty::ParamBounds {
689     fn repr(&self, tcx: &ctxt) -> String {
690         let mut res = Vec::new();
691         res.push(self.builtin_bounds.repr(tcx));
692         for t in self.trait_bounds.iter() {
693             res.push(t.repr(tcx));
694         }
695         res.connect("+")
696     }
697 }
698
699 impl Repr for ty::TraitRef {
700     fn repr(&self, tcx: &ctxt) -> String {
701         let base = ty::item_path_str(tcx, self.def_id);
702         let trait_def = ty::lookup_trait_def(tcx, self.def_id);
703         format!("<{} as {}>",
704                 self.substs.self_ty().repr(tcx),
705                 parameterized(tcx, base.as_slice(), &self.substs, &trait_def.generics))
706     }
707 }
708
709 impl Repr for ty::TraitDef {
710     fn repr(&self, tcx: &ctxt) -> String {
711         format!("TraitDef(generics={}, bounds={}, trait_ref={})",
712                 self.generics.repr(tcx),
713                 self.bounds.repr(tcx),
714                 self.trait_ref.repr(tcx))
715     }
716 }
717
718 impl Repr for ast::Expr {
719     fn repr(&self, _tcx: &ctxt) -> String {
720         format!("expr({}: {})", self.id, pprust::expr_to_string(self))
721     }
722 }
723
724 impl Repr for ast::Path {
725     fn repr(&self, _tcx: &ctxt) -> String {
726         format!("path({})", pprust::path_to_string(self))
727     }
728 }
729
730 impl UserString for ast::Path {
731     fn user_string(&self, _tcx: &ctxt) -> String {
732         pprust::path_to_string(self)
733     }
734 }
735
736 impl Repr for ast::Item {
737     fn repr(&self, tcx: &ctxt) -> String {
738         format!("item({})", tcx.map.node_to_string(self.id))
739     }
740 }
741
742 impl Repr for ast::Lifetime {
743     fn repr(&self, _tcx: &ctxt) -> String {
744         format!("lifetime({}: {})", self.id, pprust::lifetime_to_string(self))
745     }
746 }
747
748 impl Repr for ast::Stmt {
749     fn repr(&self, _tcx: &ctxt) -> String {
750         format!("stmt({}: {})",
751                 ast_util::stmt_id(self),
752                 pprust::stmt_to_string(self))
753     }
754 }
755
756 impl Repr for ast::Pat {
757     fn repr(&self, _tcx: &ctxt) -> String {
758         format!("pat({}: {})", self.id, pprust::pat_to_string(self))
759     }
760 }
761
762 impl Repr for ty::BoundRegion {
763     fn repr(&self, tcx: &ctxt) -> String {
764         match *self {
765             ty::BrAnon(id) => format!("BrAnon({})", id),
766             ty::BrNamed(id, name) => {
767                 format!("BrNamed({}, {})", id.repr(tcx), token::get_name(name))
768             }
769             ty::BrFresh(id) => format!("BrFresh({})", id),
770         }
771     }
772 }
773
774 impl Repr for ty::Region {
775     fn repr(&self, tcx: &ctxt) -> String {
776         match *self {
777             ty::ReEarlyBound(id, space, index, name) => {
778                 format!("ReEarlyBound({}, {}, {}, {})",
779                                id,
780                                space,
781                                index,
782                                token::get_name(name))
783             }
784
785             ty::ReLateBound(binder_id, ref bound_region) => {
786                 format!("ReLateBound({}, {})",
787                         binder_id,
788                         bound_region.repr(tcx))
789             }
790
791             ty::ReFree(ref fr) => fr.repr(tcx),
792
793             ty::ReScope(id) => {
794                 format!("ReScope({})", id)
795             }
796
797             ty::ReStatic => {
798                 "ReStatic".to_string()
799             }
800
801             ty::ReInfer(ReVar(ref vid)) => {
802                 format!("ReInfer({})", vid.index)
803             }
804
805             ty::ReInfer(ReSkolemized(id, ref bound_region)) => {
806                 format!("re_skolemized({}, {})", id, bound_region.repr(tcx))
807             }
808
809             ty::ReEmpty => {
810                 "ReEmpty".to_string()
811             }
812         }
813     }
814 }
815
816 impl UserString for ty::Region {
817     fn user_string(&self, tcx: &ctxt) -> String {
818         region_to_string(tcx, "", false, *self)
819     }
820 }
821
822 impl Repr for ty::FreeRegion {
823     fn repr(&self, tcx: &ctxt) -> String {
824         format!("ReFree({}, {})",
825                 self.scope_id,
826                 self.bound_region.repr(tcx))
827     }
828 }
829
830 impl Repr for ast::DefId {
831     fn repr(&self, tcx: &ctxt) -> String {
832         // Unfortunately, there seems to be no way to attempt to print
833         // a path for a def-id, so I'll just make a best effort for now
834         // and otherwise fallback to just printing the crate/node pair
835         if self.krate == ast::LOCAL_CRATE {
836             match tcx.map.find(self.node) {
837                 Some(ast_map::NodeItem(..)) |
838                 Some(ast_map::NodeForeignItem(..)) |
839                 Some(ast_map::NodeImplItem(..)) |
840                 Some(ast_map::NodeTraitItem(..)) |
841                 Some(ast_map::NodeVariant(..)) |
842                 Some(ast_map::NodeStructCtor(..)) => {
843                     return format!(
844                                 "{:?}:{}",
845                                 *self,
846                                 ty::item_path_str(tcx, *self))
847                 }
848                 _ => {}
849             }
850         }
851         return format!("{:?}", *self)
852     }
853 }
854
855 impl Repr for ty::Polytype {
856     fn repr(&self, tcx: &ctxt) -> String {
857         format!("Polytype {{generics: {}, ty: {}}}",
858                 self.generics.repr(tcx),
859                 self.ty.repr(tcx))
860     }
861 }
862
863 impl Repr for ty::Generics {
864     fn repr(&self, tcx: &ctxt) -> String {
865         format!("Generics(types: {}, regions: {})",
866                 self.types.repr(tcx),
867                 self.regions.repr(tcx))
868     }
869 }
870
871 impl Repr for ty::ItemVariances {
872     fn repr(&self, tcx: &ctxt) -> String {
873         format!("ItemVariances(types={}, \
874                 regions={})",
875                 self.types.repr(tcx),
876                 self.regions.repr(tcx))
877     }
878 }
879
880 impl Repr for ty::Variance {
881     fn repr(&self, _: &ctxt) -> String {
882         // The first `.to_string()` returns a &'static str (it is not an implementation
883         // of the ToString trait). Because of that, we need to call `.to_string()` again
884         // if we want to have a `String`.
885         let result: &'static str = (*self).to_string();
886         result.to_string()
887     }
888 }
889
890 impl Repr for ty::Method {
891     fn repr(&self, tcx: &ctxt) -> String {
892         format!("method(ident: {}, generics: {}, fty: {}, \
893                  explicit_self: {}, vis: {}, def_id: {})",
894                 self.ident.repr(tcx),
895                 self.generics.repr(tcx),
896                 self.fty.repr(tcx),
897                 self.explicit_self.repr(tcx),
898                 self.vis.repr(tcx),
899                 self.def_id.repr(tcx))
900     }
901 }
902
903 impl Repr for ast::Name {
904     fn repr(&self, _tcx: &ctxt) -> String {
905         token::get_name(*self).get().to_string()
906     }
907 }
908
909 impl UserString for ast::Name {
910     fn user_string(&self, _tcx: &ctxt) -> String {
911         token::get_name(*self).get().to_string()
912     }
913 }
914
915 impl Repr for ast::Ident {
916     fn repr(&self, _tcx: &ctxt) -> String {
917         token::get_ident(*self).get().to_string()
918     }
919 }
920
921 impl Repr for ast::ExplicitSelf_ {
922     fn repr(&self, _tcx: &ctxt) -> String {
923         format!("{:?}", *self)
924     }
925 }
926
927 impl Repr for ast::Visibility {
928     fn repr(&self, _tcx: &ctxt) -> String {
929         format!("{:?}", *self)
930     }
931 }
932
933 impl Repr for ty::BareFnTy {
934     fn repr(&self, tcx: &ctxt) -> String {
935         format!("BareFnTy {{fn_style: {:?}, abi: {}, sig: {}}}",
936                 self.fn_style,
937                 self.abi.to_string(),
938                 self.sig.repr(tcx))
939     }
940 }
941
942 impl Repr for ty::FnSig {
943     fn repr(&self, tcx: &ctxt) -> String {
944         fn_sig_to_string(tcx, self)
945     }
946 }
947
948 impl Repr for typeck::MethodCallee {
949     fn repr(&self, tcx: &ctxt) -> String {
950         format!("MethodCallee {{origin: {}, ty: {}, {}}}",
951                 self.origin.repr(tcx),
952                 self.ty.repr(tcx),
953                 self.substs.repr(tcx))
954     }
955 }
956
957 impl Repr for typeck::MethodOrigin {
958     fn repr(&self, tcx: &ctxt) -> String {
959         match self {
960             &typeck::MethodStatic(def_id) => {
961                 format!("MethodStatic({})", def_id.repr(tcx))
962             }
963             &typeck::MethodStaticUnboxedClosure(def_id) => {
964                 format!("MethodStaticUnboxedClosure({})", def_id.repr(tcx))
965             }
966             &typeck::MethodTypeParam(ref p) => {
967                 p.repr(tcx)
968             }
969             &typeck::MethodTraitObject(ref p) => {
970                 p.repr(tcx)
971             }
972         }
973     }
974 }
975
976 impl Repr for typeck::MethodParam {
977     fn repr(&self, tcx: &ctxt) -> String {
978         format!("MethodParam({},{})",
979                 self.trait_ref.repr(tcx),
980                 self.method_num)
981     }
982 }
983
984 impl Repr for typeck::MethodObject {
985     fn repr(&self, tcx: &ctxt) -> String {
986         format!("MethodObject({},{:?},{:?})",
987                 self.trait_ref.repr(tcx),
988                 self.method_num,
989                 self.real_index)
990     }
991 }
992
993 impl Repr for ty::TraitStore {
994     fn repr(&self, tcx: &ctxt) -> String {
995         trait_store_to_string(tcx, *self)
996     }
997 }
998
999 impl Repr for ty::BuiltinBound {
1000     fn repr(&self, _tcx: &ctxt) -> String {
1001         format!("{:?}", *self)
1002     }
1003 }
1004
1005 impl UserString for ty::BuiltinBound {
1006     fn user_string(&self, _tcx: &ctxt) -> String {
1007         match *self {
1008             ty::BoundSend => "Send".to_owned(),
1009             ty::BoundSized => "Sized".to_owned(),
1010             ty::BoundCopy => "Copy".to_owned(),
1011             ty::BoundSync => "Sync".to_owned(),
1012         }
1013     }
1014 }
1015
1016 impl Repr for Span {
1017     fn repr(&self, tcx: &ctxt) -> String {
1018         tcx.sess.codemap().span_to_string(*self).to_string()
1019     }
1020 }
1021
1022 impl<A:UserString> UserString for Rc<A> {
1023     fn user_string(&self, tcx: &ctxt) -> String {
1024         let this: &A = &**self;
1025         this.user_string(tcx)
1026     }
1027 }
1028
1029 impl UserString for ty::ParamBounds {
1030     fn user_string(&self, tcx: &ctxt) -> String {
1031         let mut result = Vec::new();
1032         let s = self.builtin_bounds.user_string(tcx);
1033         if !s.is_empty() {
1034             result.push(s);
1035         }
1036         for n in self.trait_bounds.iter() {
1037             result.push(n.user_string(tcx));
1038         }
1039         result.connect("+")
1040     }
1041 }
1042
1043 impl UserString for ty::ExistentialBounds {
1044     fn user_string(&self, tcx: &ctxt) -> String {
1045         if self.builtin_bounds.contains_elem(ty::BoundSend) &&
1046             self.region_bound == ty::ReStatic
1047         { // Region bound is implied by builtin bounds:
1048             return self.builtin_bounds.repr(tcx);
1049         }
1050
1051         let mut res = Vec::new();
1052
1053         let region_str = self.region_bound.user_string(tcx);
1054         if !region_str.is_empty() {
1055             res.push(region_str);
1056         }
1057
1058         for bound in self.builtin_bounds.iter() {
1059             res.push(bound.user_string(tcx));
1060         }
1061
1062         res.connect("+")
1063     }
1064 }
1065
1066 impl UserString for ty::BuiltinBounds {
1067     fn user_string(&self, tcx: &ctxt) -> String {
1068         self.iter()
1069             .map(|bb| bb.user_string(tcx))
1070             .collect::<Vec<String>>()
1071             .connect("+")
1072             .to_string()
1073     }
1074 }
1075
1076 impl UserString for ty::TraitRef {
1077     fn user_string(&self, tcx: &ctxt) -> String {
1078         let base = ty::item_path_str(tcx, self.def_id);
1079         let trait_def = ty::lookup_trait_def(tcx, self.def_id);
1080         parameterized(tcx, base.as_slice(), &self.substs, &trait_def.generics)
1081     }
1082 }
1083
1084 impl UserString for ty::t {
1085     fn user_string(&self, tcx: &ctxt) -> String {
1086         ty_to_string(tcx, *self)
1087     }
1088 }
1089
1090 impl UserString for ast::Ident {
1091     fn user_string(&self, _tcx: &ctxt) -> String {
1092         token::get_name(self.name).get().to_string()
1093     }
1094 }
1095
1096 impl Repr for abi::Abi {
1097     fn repr(&self, _tcx: &ctxt) -> String {
1098         self.to_string()
1099     }
1100 }
1101
1102 impl UserString for abi::Abi {
1103     fn user_string(&self, _tcx: &ctxt) -> String {
1104         self.to_string()
1105     }
1106 }
1107
1108 impl Repr for ty::UpvarId {
1109     fn repr(&self, tcx: &ctxt) -> String {
1110         format!("UpvarId({};`{}`;{})",
1111                 self.var_id,
1112                 ty::local_var_name_str(tcx, self.var_id),
1113                 self.closure_expr_id)
1114     }
1115 }
1116
1117 impl Repr for ast::Mutability {
1118     fn repr(&self, _tcx: &ctxt) -> String {
1119         format!("{:?}", *self)
1120     }
1121 }
1122
1123 impl Repr for ty::BorrowKind {
1124     fn repr(&self, _tcx: &ctxt) -> String {
1125         format!("{:?}", *self)
1126     }
1127 }
1128
1129 impl Repr for ty::UpvarBorrow {
1130     fn repr(&self, tcx: &ctxt) -> String {
1131         format!("UpvarBorrow({}, {})",
1132                 self.kind.repr(tcx),
1133                 self.region.repr(tcx))
1134     }
1135 }
1136
1137 impl Repr for ty::IntVid {
1138     fn repr(&self, _tcx: &ctxt) -> String {
1139         format!("{}", self)
1140     }
1141 }
1142
1143 impl Repr for ty::FloatVid {
1144     fn repr(&self, _tcx: &ctxt) -> String {
1145         format!("{}", self)
1146     }
1147 }
1148
1149 impl Repr for ty::RegionVid {
1150     fn repr(&self, _tcx: &ctxt) -> String {
1151         format!("{}", self)
1152     }
1153 }
1154
1155 impl Repr for ty::TyVid {
1156     fn repr(&self, _tcx: &ctxt) -> String {
1157         format!("{}", self)
1158     }
1159 }
1160
1161 impl Repr for ty::IntVarValue {
1162     fn repr(&self, _tcx: &ctxt) -> String {
1163         format!("{:?}", *self)
1164     }
1165 }
1166
1167 impl Repr for ast::IntTy {
1168     fn repr(&self, _tcx: &ctxt) -> String {
1169         format!("{:?}", *self)
1170     }
1171 }
1172
1173 impl Repr for ast::UintTy {
1174     fn repr(&self, _tcx: &ctxt) -> String {
1175         format!("{:?}", *self)
1176     }
1177 }
1178
1179 impl Repr for ast::FloatTy {
1180     fn repr(&self, _tcx: &ctxt) -> String {
1181         format!("{:?}", *self)
1182     }
1183 }
1184
1185 impl Repr for ty::ExplicitSelfCategory {
1186     fn repr(&self, _: &ctxt) -> String {
1187         explicit_self_category_to_str(self).to_string()
1188     }
1189 }
1190
1191
1192 impl Repr for regionmanip::WfConstraint {
1193     fn repr(&self, tcx: &ctxt) -> String {
1194         match *self {
1195             regionmanip::RegionSubRegionConstraint(_, r_a, r_b) => {
1196                 format!("RegionSubRegionConstraint({}, {})",
1197                         r_a.repr(tcx),
1198                         r_b.repr(tcx))
1199             }
1200
1201             regionmanip::RegionSubParamConstraint(_, r, p) => {
1202                 format!("RegionSubParamConstraint({}, {})",
1203                         r.repr(tcx),
1204                         p.repr(tcx))
1205             }
1206         }
1207     }
1208 }
1209
1210 impl UserString for ParamTy {
1211     fn user_string(&self, tcx: &ctxt) -> String {
1212         let id = self.idx;
1213         let did = self.def_id;
1214         let ident = match tcx.ty_param_defs.borrow().find(&did.node) {
1215             Some(def) => token::get_ident(def.ident).get().to_string(),
1216
1217             // This can only happen when a type mismatch error happens and
1218             // the actual type has more type parameters than the expected one.
1219             None => format!("<generic #{}>", id),
1220         };
1221         ident
1222     }
1223 }
1224
1225 impl Repr for ParamTy {
1226     fn repr(&self, tcx: &ctxt) -> String {
1227         self.user_string(tcx)
1228     }
1229 }
1230
1231 impl<A:Repr,B:Repr> Repr for (A,B) {
1232     fn repr(&self, tcx: &ctxt) -> String {
1233         let &(ref a, ref b) = self;
1234         format!("({},{})", a.repr(tcx), b.repr(tcx))
1235     }
1236 }
1237