src/librustc/metadata/decoder.rs

   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.
   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 // Decoding metadata from a single crate's metadata
  12
  13 #![allow(non_camel_case_types)]
  14
  15 use back::svh::Svh;
  16 use metadata::cstore::crate_metadata;
  17 use metadata::common::*;
  18 use metadata::csearch::StaticMethodInfo;
  19 use metadata::csearch;
  20 use metadata::cstore;
  21 use metadata::tydecode::{parse_ty_data, parse_def_id,
  22                          parse_type_param_def_data,
  23                          parse_bare_fn_ty_data, parse_trait_ref_data};
  24 use middle::lang_items;
  25 use middle::def;
  26 use middle::subst;
  27 use middle::ty::{ImplContainer, TraitContainer};
  28 use middle::ty;
  29 use middle::typeck;
  30 use middle::astencode::vtable_decoder_helpers;
  31
  32 use std::gc::Gc;
  33 use std::hash::Hash;
  34 use std::hash;
  35 use std::io::extensions::u64_from_be_bytes;
  36 use std::io;
  37 use std::rc::Rc;
  38 use std::u64;
  39 use serialize::ebml::reader;
  40 use serialize::ebml;
  41 use serialize::Decodable;
  42 use syntax::ast_map;
  43 use syntax::attr;
  44 use syntax::parse::token::{IdentInterner, special_idents};
  45 use syntax::parse::token;
  46 use syntax::print::pprust;
  47 use syntax::ast;
  48 use syntax::codemap;
  49 use syntax::crateid::CrateId;
  50
  51 pub type Cmd<'a> = &'a crate_metadata;
  52
  53 // A function that takes a def_id relative to the crate being searched and
  54 // returns a def_id relative to the compilation environment, i.e. if we hit a
  55 // def_id for an item defined in another crate, somebody needs to figure out
  56 // what crate that's in and give us a def_id that makes sense for the current
  57 // build.
  58
  59 fn lookup_hash<'a>(d: ebml::Doc<'a>, eq_fn: |&[u8]| -> bool,
  60                    hash: u64) -> Option<ebml::Doc<'a>> {
  61     let index = reader::get_doc(d, tag_index);
  62     let table = reader::get_doc(index, tag_index_table);
  63     let hash_pos = table.start + (hash % 256 * 4) as uint;
  64     let pos = u64_from_be_bytes(d.data, hash_pos, 4) as uint;
  65     let tagged_doc = reader::doc_at(d.data, pos).unwrap();
  66
  67     let belt = tag_index_buckets_bucket_elt;
  68
  69     let mut ret = None;
  70     reader::tagged_docs(tagged_doc.doc, belt, |elt| {
  71         let pos = u64_from_be_bytes(elt.data, elt.start, 4) as uint;
  72         if eq_fn(elt.data.slice(elt.start + 4, elt.end)) {
  73             ret = Some(reader::doc_at(d.data, pos).unwrap().doc);
  74             false
  75         } else {
  76             true
  77         }
  78     });
  79     ret
  80 }
  81
  82 pub fn maybe_find_item<'a>(item_id: ast::NodeId,
  83                            items: ebml::Doc<'a>) -> Option<ebml::Doc<'a>> {
  84     fn eq_item(bytes: &[u8], item_id: ast::NodeId) -> bool {
  85         return u64_from_be_bytes(
  86             bytes.slice(0u, 4u), 0u, 4u) as ast::NodeId
  87             == item_id;
  88     }
  89     lookup_hash(items,
  90                 |a| eq_item(a, item_id),
  91                 hash::hash(&(item_id as i64)))
  92 }
  93
  94 fn find_item<'a>(item_id: ast::NodeId, items: ebml::Doc<'a>) -> ebml::Doc<'a> {
  95     match maybe_find_item(item_id, items) {
  96        None => fail!("lookup_item: id not found: {}", item_id),
  97        Some(d) => d
  98     }
  99 }
 100
 101 // Looks up an item in the given metadata and returns an ebml doc pointing
 102 // to the item data.
 103 fn lookup_item<'a>(item_id: ast::NodeId, data: &'a [u8]) -> ebml::Doc<'a> {
 104     let items = reader::get_doc(ebml::Doc::new(data), tag_items);
 105     find_item(item_id, items)
 106 }
 107
 108 #[deriving(PartialEq)]
 109 enum Family {
 110     ImmStatic,             // c
 111     MutStatic,             // b
 112     Fn,                    // f
 113     UnsafeFn,              // u
 114     StaticMethod,          // F
 115     UnsafeStaticMethod,    // U
 116     Type,                  // y
 117     ForeignType,           // T
 118     Mod,                   // m
 119     ForeignMod,            // n
 120     Enum,                  // t
 121     TupleVariant,          // v
 122     StructVariant,         // V
 123     Impl,                  // i
 124     Trait,                 // I
 125     Struct,                // S
 126     PublicField,           // g
 127     InheritedField         // N
 128 }
 129
 130 fn item_family(item: ebml::Doc) -> Family {
 131     let fam = reader::get_doc(item, tag_items_data_item_family);
 132     match reader::doc_as_u8(fam) as char {
 133       'c' => ImmStatic,
 134       'b' => MutStatic,
 135       'f' => Fn,
 136       'u' => UnsafeFn,
 137       'F' => StaticMethod,
 138       'U' => UnsafeStaticMethod,
 139       'y' => Type,
 140       'T' => ForeignType,
 141       'm' => Mod,
 142       'n' => ForeignMod,
 143       't' => Enum,
 144       'v' => TupleVariant,
 145       'V' => StructVariant,
 146       'i' => Impl,
 147       'I' => Trait,
 148       'S' => Struct,
 149       'g' => PublicField,
 150       'N' => InheritedField,
 151        c => fail!("unexpected family char: {}", c)
 152     }
 153 }
 154
 155 fn item_visibility(item: ebml::Doc) -> ast::Visibility {
 156     match reader::maybe_get_doc(item, tag_items_data_item_visibility) {
 157         None => ast::Public,
 158         Some(visibility_doc) => {
 159             match reader::doc_as_u8(visibility_doc) as char {
 160                 'y' => ast::Public,
 161                 'i' => ast::Inherited,
 162                 _ => fail!("unknown visibility character")
 163             }
 164         }
 165     }
 166 }
 167
 168 fn item_sized(item: ebml::Doc) -> ast::Sized {
 169     match reader::maybe_get_doc(item, tag_items_data_item_sized) {
 170         None => ast::StaticSize,
 171         Some(sized_doc) => {
 172             match reader::doc_as_u8(sized_doc) as char {
 173                 'd' => ast::DynSize,
 174                 's' => ast::StaticSize,
 175                 _ => fail!("unknown sized-ness character")
 176             }
 177         }
 178     }
 179 }
 180
 181 fn item_method_sort(item: ebml::Doc) -> char {
 182     let mut ret = 'r';
 183     reader::tagged_docs(item, tag_item_trait_method_sort, |doc| {
 184         ret = doc.as_str_slice().as_bytes()[0] as char;
 185         false
 186     });
 187     ret
 188 }
 189
 190 fn item_symbol(item: ebml::Doc) -> String {
 191     reader::get_doc(item, tag_items_data_item_symbol).as_str().to_string()
 192 }
 193
 194 fn item_parent_item(d: ebml::Doc) -> Option<ast::DefId> {
 195     let mut ret = None;
 196     reader::tagged_docs(d, tag_items_data_parent_item, |did| {
 197         ret = Some(reader::with_doc_data(did, parse_def_id));
 198         false
 199     });
 200     ret
 201 }
 202
 203 fn item_reqd_and_translated_parent_item(cnum: ast::CrateNum,
 204                                         d: ebml::Doc) -> ast::DefId {
 205     let trait_did = item_parent_item(d).expect("item without parent");
 206     ast::DefId { krate: cnum, node: trait_did.node }
 207 }
 208
 209 fn item_def_id(d: ebml::Doc, cdata: Cmd) -> ast::DefId {
 210     let tagdoc = reader::get_doc(d, tag_def_id);
 211     return translate_def_id(cdata, reader::with_doc_data(tagdoc, parse_def_id));
 212 }
 213
 214 fn get_provided_source(d: ebml::Doc, cdata: Cmd) -> Option<ast::DefId> {
 215     reader::maybe_get_doc(d, tag_item_method_provided_source).map(|doc| {
 216         translate_def_id(cdata, reader::with_doc_data(doc, parse_def_id))
 217     })
 218 }
 219
 220 fn each_reexport(d: ebml::Doc, f: |ebml::Doc| -> bool) -> bool {
 221     reader::tagged_docs(d, tag_items_data_item_reexport, f)
 222 }
 223
 224 fn variant_disr_val(d: ebml::Doc) -> Option<ty::Disr> {
 225     reader::maybe_get_doc(d, tag_disr_val).and_then(|val_doc| {
 226         reader::with_doc_data(val_doc, |data| u64::parse_bytes(data, 10u))
 227     })
 228 }
 229
 230 fn doc_type(doc: ebml::Doc, tcx: &ty::ctxt, cdata: Cmd) -> ty::t {
 231     let tp = reader::get_doc(doc, tag_items_data_item_type);
 232     parse_ty_data(tp.data, cdata.cnum, tp.start, tcx,
 233                   |_, did| translate_def_id(cdata, did))
 234 }
 235
 236 fn doc_method_fty(doc: ebml::Doc, tcx: &ty::ctxt, cdata: Cmd) -> ty::BareFnTy {
 237     let tp = reader::get_doc(doc, tag_item_method_fty);
 238     parse_bare_fn_ty_data(tp.data, cdata.cnum, tp.start, tcx,
 239                           |_, did| translate_def_id(cdata, did))
 240 }
 241
 242 pub fn item_type(_item_id: ast::DefId, item: ebml::Doc,
 243                  tcx: &ty::ctxt, cdata: Cmd) -> ty::t {
 244     doc_type(item, tcx, cdata)
 245 }
 246
 247 fn doc_trait_ref(doc: ebml::Doc, tcx: &ty::ctxt, cdata: Cmd) -> ty::TraitRef {
 248     parse_trait_ref_data(doc.data, cdata.cnum, doc.start, tcx,
 249                          |_, did| translate_def_id(cdata, did))
 250 }
 251
 252 fn item_trait_ref(doc: ebml::Doc, tcx: &ty::ctxt, cdata: Cmd) -> ty::TraitRef {
 253     let tp = reader::get_doc(doc, tag_item_trait_ref);
 254     doc_trait_ref(tp, tcx, cdata)
 255 }
 256
 257 fn item_ty_param_defs(item: ebml::Doc,
 258                       tcx: &ty::ctxt,
 259                       cdata: Cmd,
 260                       tag: uint)
 261                       -> subst::VecPerParamSpace<ty::TypeParameterDef> {
 262     let mut bounds = subst::VecPerParamSpace::empty();
 263     reader::tagged_docs(item, tag, |p| {
 264         let bd = parse_type_param_def_data(
 265             p.data, p.start, cdata.cnum, tcx,
 266             |_, did| translate_def_id(cdata, did));
 267         bounds.push(bd.space, bd);
 268         true
 269     });
 270     bounds
 271 }
 272
 273 fn item_region_param_defs(item_doc: ebml::Doc, cdata: Cmd)
 274                           -> subst::VecPerParamSpace<ty::RegionParameterDef>
 275 {
 276     let mut v = subst::VecPerParamSpace::empty();
 277     reader::tagged_docs(item_doc, tag_region_param_def, |rp_doc| {
 278         let ident_str_doc = reader::get_doc(rp_doc,
 279                                             tag_region_param_def_ident);
 280         let ident = item_name(&*token::get_ident_interner(), ident_str_doc);
 281         let def_id_doc = reader::get_doc(rp_doc,
 282                                          tag_region_param_def_def_id);
 283         let def_id = reader::with_doc_data(def_id_doc, parse_def_id);
 284         let def_id = translate_def_id(cdata, def_id);
 285
 286         let doc = reader::get_doc(rp_doc, tag_region_param_def_space);
 287         let space = subst::ParamSpace::from_uint(reader::doc_as_u64(doc) as uint);
 288
 289         let doc = reader::get_doc(rp_doc, tag_region_param_def_index);
 290         let index = reader::doc_as_u64(doc) as uint;
 291
 292         v.push(space, ty::RegionParameterDef { name: ident.name,
 293                                                def_id: def_id,
 294                                                space: space,
 295                                                index: index });
 296         true
 297     });
 298     v
 299 }
 300
 301 fn enum_variant_ids(item: ebml::Doc, cdata: Cmd) -> Vec<ast::DefId> {
 302     let mut ids: Vec<ast::DefId> = Vec::new();
 303     let v = tag_items_data_item_variant;
 304     reader::tagged_docs(item, v, |p| {
 305         let ext = reader::with_doc_data(p, parse_def_id);
 306         ids.push(ast::DefId { krate: cdata.cnum, node: ext.node });
 307         true
 308     });
 309     return ids;
 310 }
 311
 312 fn item_path(item_doc: ebml::Doc) -> Vec<ast_map::PathElem> {
 313     let path_doc = reader::get_doc(item_doc, tag_path);
 314
 315     let len_doc = reader::get_doc(path_doc, tag_path_len);
 316     let len = reader::doc_as_u32(len_doc) as uint;
 317
 318     let mut result = Vec::with_capacity(len);
 319     reader::docs(path_doc, |tag, elt_doc| {
 320         if tag == tag_path_elem_mod {
 321             let s = elt_doc.as_str_slice();
 322             result.push(ast_map::PathMod(token::intern(s)));
 323         } else if tag == tag_path_elem_name {
 324             let s = elt_doc.as_str_slice();
 325             result.push(ast_map::PathName(token::intern(s)));
 326         } else {
 327             // ignore tag_path_len element
 328         }
 329         true
 330     });
 331
 332     result
 333 }
 334
 335 fn item_name(intr: &IdentInterner, item: ebml::Doc) -> ast::Ident {
 336     let name = reader::get_doc(item, tag_paths_data_name);
 337     let string = name.as_str_slice();
 338     match intr.find_equiv(&string) {
 339         None => token::str_to_ident(string),
 340         Some(val) => ast::Ident::new(val as ast::Name),
 341     }
 342 }
 343
 344 fn item_to_def_like(item: ebml::Doc, did: ast::DefId, cnum: ast::CrateNum)
 345     -> DefLike {
 346     let fam = item_family(item);
 347     match fam {
 348         ImmStatic => DlDef(def::DefStatic(did, false)),
 349         MutStatic => DlDef(def::DefStatic(did, true)),
 350         Struct    => DlDef(def::DefStruct(did)),
 351         UnsafeFn  => DlDef(def::DefFn(did, ast::UnsafeFn)),
 352         Fn        => DlDef(def::DefFn(did, ast::NormalFn)),
 353         StaticMethod | UnsafeStaticMethod => {
 354             let fn_style = if fam == UnsafeStaticMethod { ast::UnsafeFn } else
 355                 { ast::NormalFn };
 356             // def_static_method carries an optional field of its enclosing
 357             // trait or enclosing impl (if this is an inherent static method).
 358             // So we need to detect whether this is in a trait or not, which
 359             // we do through the mildly hacky way of checking whether there is
 360             // a trait_method_sort.
 361             let provenance = if reader::maybe_get_doc(
 362                   item, tag_item_trait_method_sort).is_some() {
 363                 def::FromTrait(item_reqd_and_translated_parent_item(cnum,
 364                                                                     item))
 365             } else {
 366                 def::FromImpl(item_reqd_and_translated_parent_item(cnum,
 367                                                                    item))
 368             };
 369             DlDef(def::DefStaticMethod(did, provenance, fn_style))
 370         }
 371         Type | ForeignType => DlDef(def::DefTy(did)),
 372         Mod => DlDef(def::DefMod(did)),
 373         ForeignMod => DlDef(def::DefForeignMod(did)),
 374         StructVariant => {
 375             let enum_did = item_reqd_and_translated_parent_item(cnum, item);
 376             DlDef(def::DefVariant(enum_did, did, true))
 377         }
 378         TupleVariant => {
 379             let enum_did = item_reqd_and_translated_parent_item(cnum, item);
 380             DlDef(def::DefVariant(enum_did, did, false))
 381         }
 382         Trait => DlDef(def::DefTrait(did)),
 383         Enum => DlDef(def::DefTy(did)),
 384         Impl => DlImpl(did),
 385         PublicField | InheritedField => DlField,
 386     }
 387 }
 388
 389 pub fn get_trait_def(cdata: Cmd,
 390                      item_id: ast::NodeId,
 391                      tcx: &ty::ctxt) -> ty::TraitDef
 392 {
 393     let item_doc = lookup_item(item_id, cdata.data());
 394     let tp_defs = item_ty_param_defs(item_doc, tcx, cdata,
 395                                      tag_items_data_item_ty_param_bounds);
 396     let rp_defs = item_region_param_defs(item_doc, cdata);
 397     let sized = item_sized(item_doc);
 398     let mut bounds = ty::empty_builtin_bounds();
 399     // Collect the builtin bounds from the encoded supertraits.
 400     // FIXME(#8559): They should be encoded directly.
 401     reader::tagged_docs(item_doc, tag_item_super_trait_ref, |trait_doc| {
 402         // NB. Bypasses real supertraits. See get_supertraits() if you wanted them.
 403         let trait_ref = doc_trait_ref(trait_doc, tcx, cdata);
 404         tcx.lang_items.to_builtin_kind(trait_ref.def_id).map(|bound| {
 405             bounds.add(bound);
 406         });
 407         true
 408     });
 409     // Turn sized into a bound, FIXME(#8559).
 410     if sized == ast::StaticSize {
 411         tcx.lang_items.to_builtin_kind(tcx.lang_items.sized_trait().unwrap()).map(|bound| {
 412             bounds.add(bound);
 413         });
 414     }
 415
 416     ty::TraitDef {
 417         generics: ty::Generics {types: tp_defs,
 418                                 regions: rp_defs},
 419         bounds: bounds,
 420         trait_ref: Rc::new(item_trait_ref(item_doc, tcx, cdata))
 421     }
 422 }
 423
 424 pub fn get_type(cdata: Cmd, id: ast::NodeId, tcx: &ty::ctxt)
 425     -> ty::Polytype {
 426
 427     let item = lookup_item(id, cdata.data());
 428
 429     let t = item_type(ast::DefId { krate: cdata.cnum, node: id }, item, tcx,
 430                       cdata);
 431
 432     let tp_defs = item_ty_param_defs(item, tcx, cdata, tag_items_data_item_ty_param_bounds);
 433     let rp_defs = item_region_param_defs(item, cdata);
 434
 435     ty::Polytype {
 436         generics: ty::Generics {types: tp_defs,
 437                                 regions: rp_defs},
 438         ty: t
 439     }
 440 }
 441
 442 pub fn get_stability(cdata: Cmd, id: ast::NodeId) -> Option<attr::Stability> {
 443     let item = lookup_item(id, cdata.data());
 444     reader::maybe_get_doc(item, tag_items_data_item_stability).map(|doc| {
 445         let mut decoder = reader::Decoder::new(doc);
 446         Decodable::decode(&mut decoder).unwrap()
 447     })
 448 }
 449
 450 pub fn get_impl_trait(cdata: Cmd,
 451                       id: ast::NodeId,
 452                       tcx: &ty::ctxt) -> Option<Rc<ty::TraitRef>>
 453 {
 454     let item_doc = lookup_item(id, cdata.data());
 455     reader::maybe_get_doc(item_doc, tag_item_trait_ref).map(|tp| {
 456         Rc::new(doc_trait_ref(tp, tcx, cdata))
 457     })
 458 }
 459
 460 pub fn get_impl_vtables(cdata: Cmd,
 461                         id: ast::NodeId,
 462                         tcx: &ty::ctxt)
 463                         -> typeck::vtable_res
 464 {
 465     let item_doc = lookup_item(id, cdata.data());
 466     let vtables_doc = reader::get_doc(item_doc, tag_item_impl_vtables);
 467     let mut decoder = reader::Decoder::new(vtables_doc);
 468     decoder.read_vtable_res(tcx, cdata)
 469 }
 470
 471
 472 pub fn get_symbol(data: &[u8], id: ast::NodeId) -> String {
 473     return item_symbol(lookup_item(id, data));
 474 }
 475
 476 // Something that a name can resolve to.
 477 #[deriving(Clone)]
 478 pub enum DefLike {
 479     DlDef(def::Def),
 480     DlImpl(ast::DefId),
 481     DlField
 482 }
 483
 484 /// Iterates over the language items in the given crate.
 485 pub fn each_lang_item(cdata: Cmd, f: |ast::NodeId, uint| -> bool) -> bool {
 486     let root = ebml::Doc::new(cdata.data());
 487     let lang_items = reader::get_doc(root, tag_lang_items);
 488     reader::tagged_docs(lang_items, tag_lang_items_item, |item_doc| {
 489         let id_doc = reader::get_doc(item_doc, tag_lang_items_item_id);
 490         let id = reader::doc_as_u32(id_doc) as uint;
 491         let node_id_doc = reader::get_doc(item_doc,
 492                                           tag_lang_items_item_node_id);
 493         let node_id = reader::doc_as_u32(node_id_doc) as ast::NodeId;
 494
 495         f(node_id, id)
 496     })
 497 }
 498
 499 pub type GetCrateDataCb<'a> = |ast::CrateNum|: 'a -> Rc<crate_metadata>;
 500
 501 fn each_child_of_item_or_crate(intr: Rc<IdentInterner>,
 502                                cdata: Cmd,
 503                                item_doc: ebml::Doc,
 504                                get_crate_data: GetCrateDataCb,
 505                                callback: |DefLike,
 506                                           ast::Ident,
 507                                           ast::Visibility|) {
 508     // Iterate over all children.
 509     let _ = reader::tagged_docs(item_doc, tag_mod_child, |child_info_doc| {
 510         let child_def_id = reader::with_doc_data(child_info_doc,
 511                                                  parse_def_id);
 512         let child_def_id = translate_def_id(cdata, child_def_id);
 513
 514         // This item may be in yet another crate if it was the child of a
 515         // reexport.
 516         let crate_data = if child_def_id.krate == cdata.cnum {
 517             None
 518         } else {
 519             Some(get_crate_data(child_def_id.krate))
 520         };
 521         let crate_data = match crate_data {
 522             Some(ref cdata) => &**cdata,
 523             None => cdata
 524         };
 525
 526         let other_crates_items = reader::get_doc(ebml::Doc::new(crate_data.data()), tag_items);
 527
 528         // Get the item.
 529         match maybe_find_item(child_def_id.node, other_crates_items) {
 530             None => {}
 531             Some(child_item_doc) => {
 532                 // Hand off the item to the callback.
 533                 let child_name = item_name(&*intr, child_item_doc);
 534                 let def_like = item_to_def_like(child_item_doc,
 535                                                 child_def_id,
 536                                                 cdata.cnum);
 537                 let visibility = item_visibility(child_item_doc);
 538                 callback(def_like, child_name, visibility);
 539
 540             }
 541         }
 542
 543         true
 544     });
 545
 546     // As a special case, iterate over all static methods of
 547     // associated implementations too. This is a bit of a botch.
 548     // --pcwalton
 549     let _ = reader::tagged_docs(item_doc,
 550                                 tag_items_data_item_inherent_impl,
 551                                 |inherent_impl_def_id_doc| {
 552         let inherent_impl_def_id = item_def_id(inherent_impl_def_id_doc,
 553                                                cdata);
 554         let items = reader::get_doc(ebml::Doc::new(cdata.data()), tag_items);
 555         match maybe_find_item(inherent_impl_def_id.node, items) {
 556             None => {}
 557             Some(inherent_impl_doc) => {
 558                 let _ = reader::tagged_docs(inherent_impl_doc,
 559                                             tag_item_impl_method,
 560                                             |impl_method_def_id_doc| {
 561                     let impl_method_def_id =
 562                         reader::with_doc_data(impl_method_def_id_doc,
 563                                               parse_def_id);
 564                     let impl_method_def_id =
 565                         translate_def_id(cdata, impl_method_def_id);
 566                     match maybe_find_item(impl_method_def_id.node, items) {
 567                         None => {}
 568                         Some(impl_method_doc) => {
 569                             match item_family(impl_method_doc) {
 570                                 StaticMethod | UnsafeStaticMethod => {
 571                                     // Hand off the static method
 572                                     // to the callback.
 573                                     let static_method_name =
 574                                         item_name(&*intr, impl_method_doc);
 575                                     let static_method_def_like =
 576                                         item_to_def_like(impl_method_doc,
 577                                                          impl_method_def_id,
 578                                                          cdata.cnum);
 579                                     callback(static_method_def_like,
 580                                              static_method_name,
 581                                              item_visibility(impl_method_doc));
 582                                 }
 583                                 _ => {}
 584                             }
 585                         }
 586                     }
 587
 588                     true
 589                 });
 590             }
 591         }
 592
 593         true
 594     });
 595
 596     // Iterate over all reexports.
 597     let _ = each_reexport(item_doc, |reexport_doc| {
 598         let def_id_doc = reader::get_doc(reexport_doc,
 599                                          tag_items_data_item_reexport_def_id);
 600         let child_def_id = reader::with_doc_data(def_id_doc,
 601                                                  parse_def_id);
 602         let child_def_id = translate_def_id(cdata, child_def_id);
 603
 604         let name_doc = reader::get_doc(reexport_doc,
 605                                        tag_items_data_item_reexport_name);
 606         let name = name_doc.as_str_slice();
 607
 608         // This reexport may be in yet another crate.
 609         let crate_data = if child_def_id.krate == cdata.cnum {
 610             None
 611         } else {
 612             Some(get_crate_data(child_def_id.krate))
 613         };
 614         let crate_data = match crate_data {
 615             Some(ref cdata) => &**cdata,
 616             None => cdata
 617         };
 618
 619         let other_crates_items = reader::get_doc(ebml::Doc::new(crate_data.data()), tag_items);
 620
 621         // Get the item.
 622         match maybe_find_item(child_def_id.node, other_crates_items) {
 623             None => {}
 624             Some(child_item_doc) => {
 625                 // Hand off the item to the callback.
 626                 let def_like = item_to_def_like(child_item_doc,
 627                                                 child_def_id,
 628                                                 child_def_id.krate);
 629                 // These items have a public visibility because they're part of
 630                 // a public re-export.
 631                 callback(def_like, token::str_to_ident(name), ast::Public);
 632             }
 633         }
 634
 635         true
 636     });
 637 }
 638
 639 /// Iterates over each child of the given item.
 640 pub fn each_child_of_item(intr: Rc<IdentInterner>,
 641                           cdata: Cmd,
 642                           id: ast::NodeId,
 643                           get_crate_data: GetCrateDataCb,
 644                           callback: |DefLike, ast::Ident, ast::Visibility|) {
 645     // Find the item.
 646     let root_doc = ebml::Doc::new(cdata.data());
 647     let items = reader::get_doc(root_doc, tag_items);
 648     let item_doc = match maybe_find_item(id, items) {
 649         None => return,
 650         Some(item_doc) => item_doc,
 651     };
 652
 653     each_child_of_item_or_crate(intr,
 654                                 cdata,
 655                                 item_doc,
 656                                 get_crate_data,
 657                                 callback)
 658 }
 659
 660 /// Iterates over all the top-level crate items.
 661 pub fn each_top_level_item_of_crate(intr: Rc<IdentInterner>,
 662                                     cdata: Cmd,
 663                                     get_crate_data: GetCrateDataCb,
 664                                     callback: |DefLike,
 665                                                ast::Ident,
 666                                                ast::Visibility|) {
 667     let root_doc = ebml::Doc::new(cdata.data());
 668     let misc_info_doc = reader::get_doc(root_doc, tag_misc_info);
 669     let crate_items_doc = reader::get_doc(misc_info_doc,
 670                                           tag_misc_info_crate_items);
 671
 672     each_child_of_item_or_crate(intr,
 673                                 cdata,
 674                                 crate_items_doc,
 675                                 get_crate_data,
 676                                 callback)
 677 }
 678
 679 pub fn get_item_path(cdata: Cmd, id: ast::NodeId) -> Vec<ast_map::PathElem> {
 680     item_path(lookup_item(id, cdata.data()))
 681 }
 682
 683 pub type DecodeInlinedItem<'a> = |cdata: Cmd,
 684                                   tcx: &ty::ctxt,
 685                                   path: Vec<ast_map::PathElem>,
 686                                   par_doc: ebml::Doc|: 'a
 687                                   -> Result<ast::InlinedItem, Vec<ast_map::PathElem> >;
 688
 689 pub fn maybe_get_item_ast(cdata: Cmd, tcx: &ty::ctxt, id: ast::NodeId,
 690                           decode_inlined_item: DecodeInlinedItem)
 691                           -> csearch::found_ast {
 692     debug!("Looking up item: {}", id);
 693     let item_doc = lookup_item(id, cdata.data());
 694     let path = Vec::from_slice(item_path(item_doc).init());
 695     match decode_inlined_item(cdata, tcx, path, item_doc) {
 696         Ok(ref ii) => csearch::found(*ii),
 697         Err(path) => {
 698             match item_parent_item(item_doc) {
 699                 Some(did) => {
 700                     let did = translate_def_id(cdata, did);
 701                     let parent_item = lookup_item(did.node, cdata.data());
 702                     match decode_inlined_item(cdata, tcx, path, parent_item) {
 703                         Ok(ref ii) => csearch::found_parent(did, *ii),
 704                         Err(_) => csearch::not_found
 705                     }
 706                 }
 707                 None => csearch::not_found
 708             }
 709         }
 710     }
 711 }
 712
 713 pub fn get_enum_variants(intr: Rc<IdentInterner>, cdata: Cmd, id: ast::NodeId,
 714                      tcx: &ty::ctxt) -> Vec<Rc<ty::VariantInfo>> {
 715     let data = cdata.data();
 716     let items = reader::get_doc(ebml::Doc::new(data), tag_items);
 717     let item = find_item(id, items);
 718     let mut disr_val = 0;
 719     enum_variant_ids(item, cdata).iter().map(|did| {
 720         let item = find_item(did.node, items);
 721         let ctor_ty = item_type(ast::DefId { krate: cdata.cnum, node: id},
 722                                 item, tcx, cdata);
 723         let name = item_name(&*intr, item);
 724         let arg_tys = match ty::get(ctor_ty).sty {
 725             ty::ty_bare_fn(ref f) => f.sig.inputs.clone(),
 726             _ => Vec::new(), // Nullary enum variant.
 727         };
 728         match variant_disr_val(item) {
 729             Some(val) => { disr_val = val; }
 730             _         => { /* empty */ }
 731         }
 732         let old_disr_val = disr_val;
 733         disr_val += 1;
 734         Rc::new(ty::VariantInfo {
 735             args: arg_tys,
 736             arg_names: None,
 737             ctor_ty: ctor_ty,
 738             name: name,
 739             // I'm not even sure if we encode visibility
 740             // for variants -- TEST -- tjc
 741             id: *did,
 742             disr_val: old_disr_val,
 743             vis: ast::Inherited
 744         })
 745     }).collect()
 746 }
 747
 748 fn get_explicit_self(item: ebml::Doc) -> ast::ExplicitSelf_ {
 749     fn get_mutability(ch: u8) -> ast::Mutability {
 750         match ch as char {
 751             'i' => ast::MutImmutable,
 752             'm' => ast::MutMutable,
 753             _ => fail!("unknown mutability character: `{}`", ch as char),
 754         }
 755     }
 756
 757     let explicit_self_doc = reader::get_doc(item, tag_item_trait_method_explicit_self);
 758     let string = explicit_self_doc.as_str_slice();
 759
 760     let explicit_self_kind = string.as_bytes()[0];
 761     match explicit_self_kind as char {
 762         's' => ast::SelfStatic,
 763         'v' => ast::SelfValue,
 764         '~' => ast::SelfUniq,
 765         // FIXME(#4846) expl. region
 766         '&' => ast::SelfRegion(None, get_mutability(string.as_bytes()[1])),
 767         _ => fail!("unknown self type code: `{}`", explicit_self_kind as char)
 768     }
 769 }
 770
 771 /// Returns information about the given implementation.
 772 pub fn get_impl_methods(cdata: Cmd, impl_id: ast::NodeId) -> Vec<ast::DefId> {
 773     let mut methods = Vec::new();
 774     reader::tagged_docs(lookup_item(impl_id, cdata.data()),
 775                         tag_item_impl_method, |doc| {
 776         let m_did = reader::with_doc_data(doc, parse_def_id);
 777         methods.push(translate_def_id(cdata, m_did));
 778         true
 779     });
 780
 781     methods
 782 }
 783
 784 pub fn get_method_name_and_explicit_self(
 785     intr: Rc<IdentInterner>,
 786     cdata: Cmd,
 787     id: ast::NodeId) -> (ast::Ident, ast::ExplicitSelf_)
 788 {
 789     let method_doc = lookup_item(id, cdata.data());
 790     let name = item_name(&*intr, method_doc);
 791     let explicit_self = get_explicit_self(method_doc);
 792     (name, explicit_self)
 793 }
 794
 795 pub fn get_method(intr: Rc<IdentInterner>, cdata: Cmd, id: ast::NodeId,
 796                   tcx: &ty::ctxt) -> ty::Method
 797 {
 798     let method_doc = lookup_item(id, cdata.data());
 799     let def_id = item_def_id(method_doc, cdata);
 800
 801     let container_id = item_reqd_and_translated_parent_item(cdata.cnum,
 802                                                             method_doc);
 803     let container_doc = lookup_item(container_id.node, cdata.data());
 804     let container = match item_family(container_doc) {
 805         Trait => TraitContainer(container_id),
 806         _ => ImplContainer(container_id),
 807     };
 808
 809     let name = item_name(&*intr, method_doc);
 810     let type_param_defs = item_ty_param_defs(method_doc, tcx, cdata,
 811                                              tag_item_method_tps);
 812     let rp_defs = item_region_param_defs(method_doc, cdata);
 813     let fty = doc_method_fty(method_doc, tcx, cdata);
 814     let vis = item_visibility(method_doc);
 815     let explicit_self = get_explicit_self(method_doc);
 816     let provided_source = get_provided_source(method_doc, cdata);
 817
 818     ty::Method::new(
 819         name,
 820         ty::Generics {
 821             types: type_param_defs,
 822             regions: rp_defs,
 823         },
 824         fty,
 825         explicit_self,
 826         vis,
 827         def_id,
 828         container,
 829         provided_source
 830     )
 831 }
 832
 833 pub fn get_trait_method_def_ids(cdata: Cmd,
 834                                 id: ast::NodeId) -> Vec<ast::DefId> {
 835     let data = cdata.data();
 836     let item = lookup_item(id, data);
 837     let mut result = Vec::new();
 838     reader::tagged_docs(item, tag_item_trait_method, |mth| {
 839         result.push(item_def_id(mth, cdata));
 840         true
 841     });
 842     result
 843 }
 844
 845 pub fn get_item_variances(cdata: Cmd, id: ast::NodeId) -> ty::ItemVariances {
 846     let data = cdata.data();
 847     let item_doc = lookup_item(id, data);
 848     let variance_doc = reader::get_doc(item_doc, tag_item_variances);
 849     let mut decoder = reader::Decoder::new(variance_doc);
 850     Decodable::decode(&mut decoder).unwrap()
 851 }
 852
 853 pub fn get_provided_trait_methods(intr: Rc<IdentInterner>, cdata: Cmd,
 854                                   id: ast::NodeId, tcx: &ty::ctxt)
 855                                   -> Vec<Rc<ty::Method>> {
 856     let data = cdata.data();
 857     let item = lookup_item(id, data);
 858     let mut result = Vec::new();
 859
 860     reader::tagged_docs(item, tag_item_trait_method, |mth_id| {
 861         let did = item_def_id(mth_id, cdata);
 862         let mth = lookup_item(did.node, data);
 863
 864         if item_method_sort(mth) == 'p' {
 865             result.push(Rc::new(get_method(intr.clone(), cdata, did.node, tcx)));
 866         }
 867         true
 868     });
 869
 870     return result;
 871 }
 872
 873 /// Returns the supertraits of the given trait.
 874 pub fn get_supertraits(cdata: Cmd, id: ast::NodeId, tcx: &ty::ctxt)
 875                     -> Vec<Rc<ty::TraitRef>> {
 876     let mut results = Vec::new();
 877     let item_doc = lookup_item(id, cdata.data());
 878     reader::tagged_docs(item_doc, tag_item_super_trait_ref, |trait_doc| {
 879         // NB. Only reads the ones that *aren't* builtin-bounds. See also
 880         // get_trait_def() for collecting the builtin bounds.
 881         // FIXME(#8559): The builtin bounds shouldn't be encoded in the first place.
 882         let trait_ref = doc_trait_ref(trait_doc, tcx, cdata);
 883         if tcx.lang_items.to_builtin_kind(trait_ref.def_id).is_none() {
 884             results.push(Rc::new(trait_ref));
 885         }
 886         true
 887     });
 888     return results;
 889 }
 890
 891 pub fn get_type_name_if_impl(cdata: Cmd,
 892                              node_id: ast::NodeId) -> Option<ast::Ident> {
 893     let item = lookup_item(node_id, cdata.data());
 894     if item_family(item) != Impl {
 895         return None;
 896     }
 897
 898     let mut ret = None;
 899     reader::tagged_docs(item, tag_item_impl_type_basename, |doc| {
 900         ret = Some(token::str_to_ident(doc.as_str_slice()));
 901         false
 902     });
 903
 904     ret
 905 }
 906
 907 pub fn get_static_methods_if_impl(intr: Rc<IdentInterner>,
 908                                   cdata: Cmd,
 909                                   node_id: ast::NodeId)
 910                                -> Option<Vec<StaticMethodInfo> > {
 911     let item = lookup_item(node_id, cdata.data());
 912     if item_family(item) != Impl {
 913         return None;
 914     }
 915
 916     // If this impl implements a trait, don't consider it.
 917     let ret = reader::tagged_docs(item, tag_item_trait_ref, |_doc| {
 918         false
 919     });
 920
 921     if !ret { return None }
 922
 923     let mut impl_method_ids = Vec::new();
 924     reader::tagged_docs(item, tag_item_impl_method, |impl_method_doc| {
 925         impl_method_ids.push(reader::with_doc_data(impl_method_doc, parse_def_id));
 926         true
 927     });
 928
 929     let mut static_impl_methods = Vec::new();
 930     for impl_method_id in impl_method_ids.iter() {
 931         let impl_method_doc = lookup_item(impl_method_id.node, cdata.data());
 932         let family = item_family(impl_method_doc);
 933         match family {
 934             StaticMethod | UnsafeStaticMethod => {
 935                 let fn_style;
 936                 match item_family(impl_method_doc) {
 937                     StaticMethod => fn_style = ast::NormalFn,
 938                     UnsafeStaticMethod => fn_style = ast::UnsafeFn,
 939                     _ => fail!()
 940                 }
 941
 942                 static_impl_methods.push(StaticMethodInfo {
 943                     ident: item_name(&*intr, impl_method_doc),
 944                     def_id: item_def_id(impl_method_doc, cdata),
 945                     fn_style: fn_style,
 946                     vis: item_visibility(impl_method_doc),
 947                 });
 948             }
 949             _ => {}
 950         }
 951     }
 952
 953     return Some(static_impl_methods);
 954 }
 955
 956 /// If node_id is the constructor of a tuple struct, retrieve the NodeId of
 957 /// the actual type definition, otherwise, return None
 958 pub fn get_tuple_struct_definition_if_ctor(cdata: Cmd,
 959                                            node_id: ast::NodeId)
 960     -> Option<ast::DefId>
 961 {
 962     let item = lookup_item(node_id, cdata.data());
 963     let mut ret = None;
 964     reader::tagged_docs(item, tag_items_data_item_is_tuple_struct_ctor, |_| {
 965         ret = Some(item_reqd_and_translated_parent_item(cdata.cnum, item));
 966         false
 967     });
 968     ret
 969 }
 970
 971 pub fn get_item_attrs(cdata: Cmd,
 972                       orig_node_id: ast::NodeId,
 973                       f: |Vec<ast::Attribute>|) {
 974     // The attributes for a tuple struct are attached to the definition, not the ctor;
 975     // we assume that someone passing in a tuple struct ctor is actually wanting to
 976     // look at the definition
 977     let node_id = get_tuple_struct_definition_if_ctor(cdata, orig_node_id);
 978     let node_id = node_id.map(|x| x.node).unwrap_or(orig_node_id);
 979     let item = lookup_item(node_id, cdata.data());
 980     f(get_attributes(item));
 981 }
 982
 983 fn struct_field_family_to_visibility(family: Family) -> ast::Visibility {
 984     match family {
 985       PublicField => ast::Public,
 986       InheritedField => ast::Inherited,
 987       _ => fail!()
 988     }
 989 }
 990
 991 pub fn get_struct_fields(intr: Rc<IdentInterner>, cdata: Cmd, id: ast::NodeId)
 992     -> Vec<ty::field_ty> {
 993     let data = cdata.data();
 994     let item = lookup_item(id, data);
 995     let mut result = Vec::new();
 996     reader::tagged_docs(item, tag_item_field, |an_item| {
 997         let f = item_family(an_item);
 998         if f == PublicField || f == InheritedField {
 999             // FIXME #6993: name should be of type Name, not Ident
1000             let name = item_name(&*intr, an_item);
1001             let did = item_def_id(an_item, cdata);
1002             let tagdoc = reader::get_doc(an_item, tag_item_field_origin);
1003             let origin_id =  translate_def_id(cdata, reader::with_doc_data(tagdoc, parse_def_id));
1004             result.push(ty::field_ty {
1005                 name: name.name,
1006                 id: did,
1007                 vis: struct_field_family_to_visibility(f),
1008                 origin: origin_id,
1009             });
1010         }
1011         true
1012     });
1013     reader::tagged_docs(item, tag_item_unnamed_field, |an_item| {
1014         let did = item_def_id(an_item, cdata);
1015         let tagdoc = reader::get_doc(an_item, tag_item_field_origin);
1016         let f = item_family(an_item);
1017         let origin_id =  translate_def_id(cdata, reader::with_doc_data(tagdoc, parse_def_id));
1018         result.push(ty::field_ty {
1019             name: special_idents::unnamed_field.name,
1020             id: did,
1021             vis: struct_field_family_to_visibility(f),
1022             origin: origin_id,
1023         });
1024         true
1025     });
1026     result
1027 }
1028
1029 fn get_meta_items(md: ebml::Doc) -> Vec<Gc<ast::MetaItem>> {
1030     let mut items: Vec<Gc<ast::MetaItem>> = Vec::new();
1031     reader::tagged_docs(md, tag_meta_item_word, |meta_item_doc| {
1032         let nd = reader::get_doc(meta_item_doc, tag_meta_item_name);
1033         let n = token::intern_and_get_ident(nd.as_str_slice());
1034         items.push(attr::mk_word_item(n));
1035         true
1036     });
1037     reader::tagged_docs(md, tag_meta_item_name_value, |meta_item_doc| {
1038         let nd = reader::get_doc(meta_item_doc, tag_meta_item_name);
1039         let vd = reader::get_doc(meta_item_doc, tag_meta_item_value);
1040         let n = token::intern_and_get_ident(nd.as_str_slice());
1041         let v = token::intern_and_get_ident(vd.as_str_slice());
1042         // FIXME (#623): Should be able to decode MetaNameValue variants,
1043         // but currently the encoder just drops them
1044         items.push(attr::mk_name_value_item_str(n, v));
1045         true
1046     });
1047     reader::tagged_docs(md, tag_meta_item_list, |meta_item_doc| {
1048         let nd = reader::get_doc(meta_item_doc, tag_meta_item_name);
1049         let n = token::intern_and_get_ident(nd.as_str_slice());
1050         let subitems = get_meta_items(meta_item_doc);
1051         items.push(attr::mk_list_item(n, subitems.move_iter().collect()));
1052         true
1053     });
1054     return items;
1055 }
1056
1057 fn get_attributes(md: ebml::Doc) -> Vec<ast::Attribute> {
1058     let mut attrs: Vec<ast::Attribute> = Vec::new();
1059     match reader::maybe_get_doc(md, tag_attributes) {
1060       Some(attrs_d) => {
1061         reader::tagged_docs(attrs_d, tag_attribute, |attr_doc| {
1062             let meta_items = get_meta_items(attr_doc);
1063             // Currently it's only possible to have a single meta item on
1064             // an attribute
1065             assert_eq!(meta_items.len(), 1u);
1066             let meta_item = *meta_items.get(0);
1067             attrs.push(
1068                 codemap::Spanned {
1069                     node: ast::Attribute_ {
1070                         id: attr::mk_attr_id(),
1071                         style: ast::AttrOuter,
1072                         value: meta_item,
1073                         is_sugared_doc: false,
1074                     },
1075                     span: codemap::DUMMY_SP
1076                 });
1077             true
1078         });
1079       }
1080       None => ()
1081     }
1082     return attrs;
1083 }
1084
1085 fn list_crate_attributes(md: ebml::Doc, hash: &Svh,
1086                          out: &mut io::Writer) -> io::IoResult<()> {
1087     try!(write!(out, "=Crate Attributes ({})=\n", *hash));
1088
1089     let r = get_attributes(md);
1090     for attr in r.iter() {
1091         try!(write!(out, "{}\n", pprust::attribute_to_str(attr)));
1092     }
1093
1094     write!(out, "\n\n")
1095 }
1096
1097 pub fn get_crate_attributes(data: &[u8]) -> Vec<ast::Attribute> {
1098     get_attributes(ebml::Doc::new(data))
1099 }
1100
1101 #[deriving(Clone)]
1102 pub struct CrateDep {
1103     pub cnum: ast::CrateNum,
1104     pub crate_id: CrateId,
1105     pub hash: Svh,
1106 }
1107
1108 pub fn get_crate_deps(data: &[u8]) -> Vec<CrateDep> {
1109     let mut deps: Vec<CrateDep> = Vec::new();
1110     let cratedoc = ebml::Doc::new(data);
1111     let depsdoc = reader::get_doc(cratedoc, tag_crate_deps);
1112     let mut crate_num = 1;
1113     fn docstr(doc: ebml::Doc, tag_: uint) -> String {
1114         let d = reader::get_doc(doc, tag_);
1115         d.as_str_slice().to_string()
1116     }
1117     reader::tagged_docs(depsdoc, tag_crate_dep, |depdoc| {
1118         let crate_id =
1119             from_str(docstr(depdoc,
1120                             tag_crate_dep_crateid).as_slice()).unwrap();
1121         let hash = Svh::new(docstr(depdoc, tag_crate_dep_hash).as_slice());
1122         deps.push(CrateDep {
1123             cnum: crate_num,
1124             crate_id: crate_id,
1125             hash: hash,
1126         });
1127         crate_num += 1;
1128         true
1129     });
1130     return deps;
1131 }
1132
1133 fn list_crate_deps(data: &[u8], out: &mut io::Writer) -> io::IoResult<()> {
1134     try!(write!(out, "=External Dependencies=\n"));
1135     for dep in get_crate_deps(data).iter() {
1136         try!(write!(out, "{} {}-{}\n", dep.cnum, dep.crate_id, dep.hash));
1137     }
1138     try!(write!(out, "\n"));
1139     Ok(())
1140 }
1141
1142 pub fn maybe_get_crate_hash(data: &[u8]) -> Option<Svh> {
1143     let cratedoc = ebml::Doc::new(data);
1144     reader::maybe_get_doc(cratedoc, tag_crate_hash).map(|doc| {
1145         Svh::new(doc.as_str_slice())
1146     })
1147 }
1148
1149 pub fn get_crate_hash(data: &[u8]) -> Svh {
1150     let cratedoc = ebml::Doc::new(data);
1151     let hashdoc = reader::get_doc(cratedoc, tag_crate_hash);
1152     Svh::new(hashdoc.as_str_slice())
1153 }
1154
1155 pub fn maybe_get_crate_id(data: &[u8]) -> Option<CrateId> {
1156     let cratedoc = ebml::Doc::new(data);
1157     reader::maybe_get_doc(cratedoc, tag_crate_crateid).map(|doc| {
1158         from_str(doc.as_str_slice()).unwrap()
1159     })
1160 }
1161
1162 pub fn get_crate_triple(data: &[u8]) -> String {
1163     let cratedoc = ebml::Doc::new(data);
1164     let triple_doc = reader::maybe_get_doc(cratedoc, tag_crate_triple);
1165     triple_doc.expect("No triple in crate").as_str().to_string()
1166 }
1167
1168 pub fn get_crate_id(data: &[u8]) -> CrateId {
1169     let cratedoc = ebml::Doc::new(data);
1170     let hashdoc = reader::get_doc(cratedoc, tag_crate_crateid);
1171     from_str(hashdoc.as_str_slice()).unwrap()
1172 }
1173
1174 pub fn list_crate_metadata(bytes: &[u8], out: &mut io::Writer) -> io::IoResult<()> {
1175     let hash = get_crate_hash(bytes);
1176     let md = ebml::Doc::new(bytes);
1177     try!(list_crate_attributes(md, &hash, out));
1178     list_crate_deps(bytes, out)
1179 }
1180
1181 // Translates a def_id from an external crate to a def_id for the current
1182 // compilation environment. We use this when trying to load types from
1183 // external crates - if those types further refer to types in other crates
1184 // then we must translate the crate number from that encoded in the external
1185 // crate to the correct local crate number.
1186 pub fn translate_def_id(cdata: Cmd, did: ast::DefId) -> ast::DefId {
1187     if did.krate == ast::LOCAL_CRATE {
1188         return ast::DefId { krate: cdata.cnum, node: did.node };
1189     }
1190
1191     match cdata.cnum_map.find(&did.krate) {
1192         Some(&n) => {
1193             ast::DefId {
1194                 krate: n,
1195                 node: did.node,
1196             }
1197         }
1198         None => fail!("didn't find a crate in the cnum_map")
1199     }
1200 }
1201
1202 pub fn each_impl(cdata: Cmd, callback: |ast::DefId|) {
1203     let impls_doc = reader::get_doc(ebml::Doc::new(cdata.data()), tag_impls);
1204     let _ = reader::tagged_docs(impls_doc, tag_impls_impl, |impl_doc| {
1205         callback(item_def_id(impl_doc, cdata));
1206         true
1207     });
1208 }
1209
1210 pub fn each_implementation_for_type(cdata: Cmd,
1211                                     id: ast::NodeId,
1212                                     callback: |ast::DefId|) {
1213     let item_doc = lookup_item(id, cdata.data());
1214     reader::tagged_docs(item_doc,
1215                         tag_items_data_item_inherent_impl,
1216                         |impl_doc| {
1217         let implementation_def_id = item_def_id(impl_doc, cdata);
1218         callback(implementation_def_id);
1219         true
1220     });
1221 }
1222
1223 pub fn each_implementation_for_trait(cdata: Cmd,
1224                                      id: ast::NodeId,
1225                                      callback: |ast::DefId|) {
1226     let item_doc = lookup_item(id, cdata.data());
1227
1228     let _ = reader::tagged_docs(item_doc,
1229                                 tag_items_data_item_extension_impl,
1230                                 |impl_doc| {
1231         let implementation_def_id = item_def_id(impl_doc, cdata);
1232         callback(implementation_def_id);
1233         true
1234     });
1235 }
1236
1237 pub fn get_trait_of_method(cdata: Cmd, id: ast::NodeId, tcx: &ty::ctxt)
1238                            -> Option<ast::DefId> {
1239     let item_doc = lookup_item(id, cdata.data());
1240     let parent_item_id = match item_parent_item(item_doc) {
1241         None => return None,
1242         Some(item_id) => item_id,
1243     };
1244     let parent_item_id = translate_def_id(cdata, parent_item_id);
1245     let parent_item_doc = lookup_item(parent_item_id.node, cdata.data());
1246     match item_family(parent_item_doc) {
1247         Trait => Some(item_def_id(parent_item_doc, cdata)),
1248         Impl => {
1249             reader::maybe_get_doc(parent_item_doc, tag_item_trait_ref)
1250                 .map(|_| item_trait_ref(parent_item_doc, tcx, cdata).def_id)
1251         }
1252         _ => None
1253     }
1254 }
1255
1256
1257 pub fn get_native_libraries(cdata: Cmd)
1258                             -> Vec<(cstore::NativeLibaryKind, String)> {
1259     let libraries = reader::get_doc(ebml::Doc::new(cdata.data()),
1260                                     tag_native_libraries);
1261     let mut result = Vec::new();
1262     reader::tagged_docs(libraries, tag_native_libraries_lib, |lib_doc| {
1263         let kind_doc = reader::get_doc(lib_doc, tag_native_libraries_kind);
1264         let name_doc = reader::get_doc(lib_doc, tag_native_libraries_name);
1265         let kind: cstore::NativeLibaryKind =
1266             FromPrimitive::from_u32(reader::doc_as_u32(kind_doc)).unwrap();
1267         let name = name_doc.as_str().to_string();
1268         result.push((kind, name));
1269         true
1270     });
1271     return result;
1272 }
1273
1274 pub fn get_plugin_registrar_fn(data: &[u8]) -> Option<ast::NodeId> {
1275     reader::maybe_get_doc(ebml::Doc::new(data), tag_plugin_registrar_fn)
1276         .map(|doc| FromPrimitive::from_u32(reader::doc_as_u32(doc)).unwrap())
1277 }
1278
1279 pub fn get_exported_macros(data: &[u8]) -> Vec<String> {
1280     let macros = reader::get_doc(ebml::Doc::new(data),
1281                                  tag_exported_macros);
1282     let mut result = Vec::new();
1283     reader::tagged_docs(macros, tag_macro_def, |macro_doc| {
1284         result.push(macro_doc.as_str().to_string());
1285         true
1286     });
1287     result
1288 }
1289
1290 pub fn get_dylib_dependency_formats(cdata: Cmd)
1291     -> Vec<(ast::CrateNum, cstore::LinkagePreference)>
1292 {
1293     let formats = reader::get_doc(ebml::Doc::new(cdata.data()),
1294                                   tag_dylib_dependency_formats);
1295     let mut result = Vec::new();
1296
1297     debug!("found dylib deps: {}", formats.as_str_slice());
1298     for spec in formats.as_str_slice().split(',') {
1299         if spec.len() == 0 { continue }
1300         let cnum = spec.split(':').nth(0).unwrap();
1301         let link = spec.split(':').nth(1).unwrap();
1302         let cnum = from_str(cnum).unwrap();
1303         let cnum = match cdata.cnum_map.find(&cnum) {
1304             Some(&n) => n,
1305             None => fail!("didn't find a crate in the cnum_map")
1306         };
1307         result.push((cnum, if link == "d" {
1308             cstore::RequireDynamic
1309         } else {
1310             cstore::RequireStatic
1311         }));
1312     }
1313     return result;
1314 }
1315
1316 pub fn get_missing_lang_items(cdata: Cmd)
1317     -> Vec<lang_items::LangItem>
1318 {
1319     let items = reader::get_doc(ebml::Doc::new(cdata.data()), tag_lang_items);
1320     let mut result = Vec::new();
1321     reader::tagged_docs(items, tag_lang_items_missing, |missing_doc| {
1322         let item: lang_items::LangItem =
1323             FromPrimitive::from_u32(reader::doc_as_u32(missing_doc)).unwrap();
1324         result.push(item);
1325         true
1326     });
1327     return result;
1328 }
1329
1330 pub fn get_method_arg_names(cdata: Cmd, id: ast::NodeId) -> Vec<String> {
1331     let mut ret = Vec::new();
1332     let method_doc = lookup_item(id, cdata.data());
1333     match reader::maybe_get_doc(method_doc, tag_method_argument_names) {
1334         Some(args_doc) => {
1335             reader::tagged_docs(args_doc, tag_method_argument_name, |name_doc| {
1336                 ret.push(name_doc.as_str_slice().to_string());
1337                 true
1338             });
1339         }
1340         None => {}
1341     }
1342     return ret;
1343 }
1344
1345 pub fn get_reachable_extern_fns(cdata: Cmd) -> Vec<ast::DefId> {
1346     let mut ret = Vec::new();
1347     let items = reader::get_doc(ebml::Doc::new(cdata.data()),
1348                                 tag_reachable_extern_fns);
1349     reader::tagged_docs(items, tag_reachable_extern_fn_id, |doc| {
1350         ret.push(ast::DefId {
1351             krate: cdata.cnum,
1352             node: reader::doc_as_u32(doc),
1353         });
1354         true
1355     });
1356     return ret;
1357 }
1358
1359 pub fn is_typedef(cdata: Cmd, id: ast::NodeId) -> bool {
1360     let item_doc = lookup_item(id, cdata.data());
1361     match item_family(item_doc) {
1362         Type => true,
1363         _ => false,
1364     }
1365 }