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