1 // Copyright 2012-2014 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.
13 #![allow(unused_must_use)] // as with encoding, everything is a no-fail MemWriter
14 #![allow(non_camel_case_types)]
16 use std::cell::RefCell;
17 use std::collections::HashMap;
20 use middle::subst::VecPerParamSpace;
21 use middle::ty::ParamTy;
27 use syntax::diagnostic::SpanHandler;
28 use syntax::parse::token;
30 use util::io::SeekableMemWriter;
32 macro_rules! mywrite( ($($arg:tt)*) => ({ write!($($arg)*); }) )
35 pub diag: &'a SpanHandler,
36 // Def -> str Callback:
37 pub ds: fn(DefId) -> String,
39 pub tcx: &'a ty::ctxt,
40 pub abbrevs: &'a abbrev_map
43 // Compact string representation for ty.t values. API ty_str & parse_from_str.
44 // Extra parameters are for converting to/from def_ids in the string rep.
45 // Whatever format you choose should not contain pipe characters.
46 pub struct ty_abbrev {
50 pub type abbrev_map = RefCell<HashMap<ty::t, ty_abbrev>>;
52 pub fn enc_ty(w: &mut SeekableMemWriter, cx: &ctxt, t: ty::t) {
53 match cx.abbrevs.borrow_mut().find(&t) {
54 Some(a) => { w.write(a.s.as_bytes()); return; }
57 let pos = w.tell().unwrap();
58 enc_sty(w, cx, &ty::get(t).sty);
59 let end = w.tell().unwrap();
61 fn estimate_sz(u: u64) -> u64 {
64 while n != 0 { len += 1; n = n >> 4; }
67 let abbrev_len = 3 + estimate_sz(pos) + estimate_sz(len);
69 // I.e. it's actually an abbreviation.
70 cx.abbrevs.borrow_mut().insert(t, ty_abbrev {
71 s: format!("#{:x}:{:x}#", pos, len)
76 fn enc_mutability(w: &mut SeekableMemWriter, mt: ast::Mutability) {
79 MutMutable => mywrite!(w, "m"),
83 fn enc_mt(w: &mut SeekableMemWriter, cx: &ctxt, mt: ty::mt) {
84 enc_mutability(w, mt.mutbl);
88 fn enc_opt<T>(w: &mut SeekableMemWriter, t: Option<T>, enc_f: |&mut SeekableMemWriter, T|) {
90 None => mywrite!(w, "n"),
98 fn enc_vec_per_param_space<T>(w: &mut SeekableMemWriter,
100 v: &VecPerParamSpace<T>,
101 op: |&mut SeekableMemWriter, &ctxt, &T|) {
102 for &space in subst::ParamSpace::all().iter() {
104 for t in v.get_slice(space).iter() {
111 pub fn enc_substs(w: &mut SeekableMemWriter, cx: &ctxt, substs: &subst::Substs) {
112 enc_region_substs(w, cx, &substs.regions);
113 enc_vec_per_param_space(w, cx, &substs.types,
114 |w, cx, &ty| enc_ty(w, cx, ty));
117 fn enc_region_substs(w: &mut SeekableMemWriter, cx: &ctxt, substs: &subst::RegionSubsts) {
119 subst::ErasedRegions => {
122 subst::NonerasedRegions(ref regions) => {
124 enc_vec_per_param_space(w, cx, regions,
125 |w, cx, &r| enc_region(w, cx, r));
130 fn enc_region(w: &mut SeekableMemWriter, cx: &ctxt, r: ty::Region) {
132 ty::ReLateBound(id, br) => {
133 mywrite!(w, "b[{}|", id);
134 enc_bound_region(w, cx, br);
137 ty::ReEarlyBound(node_id, space, index, name) => {
138 mywrite!(w, "B[{}|{}|{}|{}]",
142 token::get_name(name));
144 ty::ReFree(ref fr) => {
145 mywrite!(w, "f[{}|", fr.scope_id);
146 enc_bound_region(w, cx, fr.bound_region);
149 ty::ReScope(nid) => {
150 mywrite!(w, "s{}|", nid);
159 // these should not crop up after typeck
160 cx.diag.handler().bug("cannot encode region variables");
165 fn enc_bound_region(w: &mut SeekableMemWriter, cx: &ctxt, br: ty::BoundRegion) {
168 mywrite!(w, "a{}|", idx);
170 ty::BrNamed(d, name) => {
171 mywrite!(w, "[{}|{}]",
173 token::get_name(name));
176 mywrite!(w, "f{}|", id);
181 pub fn enc_trait_ref(w: &mut SeekableMemWriter, cx: &ctxt, s: &ty::TraitRef) {
182 mywrite!(w, "{}|", (cx.ds)(s.def_id));
183 enc_substs(w, cx, &s.substs);
186 pub fn enc_trait_store(w: &mut SeekableMemWriter, cx: &ctxt, s: ty::TraitStore) {
188 ty::UniqTraitStore => mywrite!(w, "~"),
189 ty::RegionTraitStore(re, m) => {
191 enc_region(w, cx, re);
192 enc_mutability(w, m);
197 fn enc_sty(w: &mut SeekableMemWriter, cx: &ctxt, st: &ty::sty) {
199 ty::ty_nil => mywrite!(w, "n"),
200 ty::ty_bot => mywrite!(w, "z"),
201 ty::ty_bool => mywrite!(w, "b"),
202 ty::ty_char => mywrite!(w, "c"),
205 TyI => mywrite!(w, "i"),
206 TyI8 => mywrite!(w, "MB"),
207 TyI16 => mywrite!(w, "MW"),
208 TyI32 => mywrite!(w, "ML"),
209 TyI64 => mywrite!(w, "MD")
214 TyU => mywrite!(w, "u"),
215 TyU8 => mywrite!(w, "Mb"),
216 TyU16 => mywrite!(w, "Mw"),
217 TyU32 => mywrite!(w, "Ml"),
218 TyU64 => mywrite!(w, "Md")
223 TyF32 => mywrite!(w, "Mf"),
224 TyF64 => mywrite!(w, "MF"),
227 ty::ty_enum(def, ref substs) => {
228 mywrite!(w, "t[{}|", (cx.ds)(def));
229 enc_substs(w, cx, substs);
232 ty::ty_trait(box ty::TyTrait {
237 mywrite!(w, "x[{}|", (cx.ds)(def_id));
238 enc_substs(w, cx, substs);
239 let bounds = ty::ParamBounds {builtin_bounds: bounds,
240 trait_bounds: Vec::new()};
241 enc_bounds(w, cx, &bounds);
244 ty::ty_tup(ref ts) => {
246 for t in ts.iter() { enc_ty(w, cx, *t); }
249 ty::ty_box(typ) => { mywrite!(w, "@"); enc_ty(w, cx, typ); }
250 ty::ty_uniq(typ) => { mywrite!(w, "~"); enc_ty(w, cx, typ); }
251 ty::ty_ptr(mt) => { mywrite!(w, "*"); enc_mt(w, cx, mt); }
252 ty::ty_rptr(r, mt) => {
254 enc_region(w, cx, r);
257 ty::ty_vec(mt, sz) => {
262 Some(n) => mywrite!(w, "{}|", n),
263 None => mywrite!(w, "|"),
269 ty::ty_closure(ref f) => {
271 enc_closure_ty(w, cx, &**f);
273 ty::ty_bare_fn(ref f) => {
275 enc_bare_fn_ty(w, cx, f);
278 cx.diag.handler().bug("cannot encode inference variable types");
280 ty::ty_param(ParamTy {space, idx: id, def_id: did}) => {
281 mywrite!(w, "p{}|{}|{}|", (cx.ds)(did), id, space.to_uint())
283 ty::ty_struct(def, ref substs) => {
284 mywrite!(w, "a[{}|", (cx.ds)(def));
285 enc_substs(w, cx, substs);
288 ty::ty_unboxed_closure(def) => {
289 mywrite!(w, "k{}", (cx.ds)(def));
297 fn enc_fn_style(w: &mut SeekableMemWriter, p: FnStyle) {
299 NormalFn => mywrite!(w, "n"),
300 UnsafeFn => mywrite!(w, "u"),
304 fn enc_abi(w: &mut SeekableMemWriter, abi: Abi) {
306 mywrite!(w, "{}", abi.name());
310 fn enc_onceness(w: &mut SeekableMemWriter, o: Onceness) {
312 Once => mywrite!(w, "o"),
313 Many => mywrite!(w, "m")
317 pub fn enc_bare_fn_ty(w: &mut SeekableMemWriter, cx: &ctxt, ft: &ty::BareFnTy) {
318 enc_fn_style(w, ft.fn_style);
320 enc_fn_sig(w, cx, &ft.sig);
323 pub fn enc_closure_ty(w: &mut SeekableMemWriter, cx: &ctxt, ft: &ty::ClosureTy) {
324 enc_fn_style(w, ft.fn_style);
325 enc_onceness(w, ft.onceness);
326 enc_trait_store(w, cx, ft.store);
327 let bounds = ty::ParamBounds {builtin_bounds: ft.bounds,
328 trait_bounds: Vec::new()};
329 enc_bounds(w, cx, &bounds);
330 enc_fn_sig(w, cx, &ft.sig);
334 fn enc_fn_sig(w: &mut SeekableMemWriter, cx: &ctxt, fsig: &ty::FnSig) {
335 mywrite!(w, "[{}|", fsig.binder_id);
336 for ty in fsig.inputs.iter() {
345 enc_ty(w, cx, fsig.output);
348 fn enc_bounds(w: &mut SeekableMemWriter, cx: &ctxt, bs: &ty::ParamBounds) {
349 for bound in bs.builtin_bounds.iter() {
351 ty::BoundSend => mywrite!(w, "S"),
352 ty::BoundStatic => mywrite!(w, "O"),
353 ty::BoundSized => mywrite!(w, "Z"),
354 ty::BoundCopy => mywrite!(w, "P"),
355 ty::BoundShare => mywrite!(w, "T"),
359 for tp in bs.trait_bounds.iter() {
361 enc_trait_ref(w, cx, &**tp);
367 pub fn enc_type_param_def(w: &mut SeekableMemWriter, cx: &ctxt, v: &ty::TypeParameterDef) {
368 mywrite!(w, "{}:{}|{}|{}|",
369 token::get_ident(v.ident), (cx.ds)(v.def_id),
370 v.space.to_uint(), v.index);
371 enc_bounds(w, cx, &*v.bounds);
372 enc_opt(w, v.default, |w, t| enc_ty(w, cx, t));