src/librustc/middle/cstore.rs

   1 // Copyright 2015 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 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
  12 // file at the top-level directory of this distribution and at
  13 // http://rust-lang.org/COPYRIGHT.
  14 //
  15 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
  16 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
  17 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
  18 // option. This file may not be copied, modified, or distributed
  19 // except according to those terms.
  20
  21 // the rustc crate store interface. This also includes types that
  22 // are *mostly* used as a part of that interface, but these should
  23 // probably get a better home if someone can find one.
  24
  25 use back::svh::Svh;
  26 use front::map as hir_map;
  27 use middle::def::{self, Def};
  28 use middle::lang_items;
  29 use middle::ty::{self, Ty, VariantKind};
  30 use middle::def_id::{DefId, DefIndex};
  31 use mir::repr::Mir;
  32 use session::Session;
  33 use session::search_paths::PathKind;
  34 use util::nodemap::{FnvHashMap, NodeMap, NodeSet};
  35 use std::any::Any;
  36 use std::cell::RefCell;
  37 use std::rc::Rc;
  38 use std::path::PathBuf;
  39 use syntax::ast;
  40 use syntax::ast_util::{IdVisitingOperation};
  41 use syntax::attr;
  42 use syntax::codemap::Span;
  43 use syntax::ptr::P;
  44 use rustc_back::target::Target;
  45 use rustc_front::hir;
  46 use rustc_front::intravisit::Visitor;
  47 use rustc_front::util::IdVisitor;
  48
  49 pub use self::DefLike::{DlDef, DlField, DlImpl};
  50 pub use self::NativeLibraryKind::{NativeStatic, NativeFramework, NativeUnknown};
  51
  52 // lonely orphan structs and enums looking for a better home
  53
  54 #[derive(Clone, Debug)]
  55 pub struct LinkMeta {
  56     pub crate_name: String,
  57     pub crate_hash: Svh,
  58 }
  59
  60 // Where a crate came from on the local filesystem. One of these two options
  61 // must be non-None.
  62 #[derive(PartialEq, Clone, Debug)]
  63 pub struct CrateSource {
  64     pub dylib: Option<(PathBuf, PathKind)>,
  65     pub rlib: Option<(PathBuf, PathKind)>,
  66     pub cnum: ast::CrateNum,
  67 }
  68
  69 #[derive(Copy, Debug, PartialEq, Clone)]
  70 pub enum LinkagePreference {
  71     RequireDynamic,
  72     RequireStatic,
  73 }
  74
  75 enum_from_u32! {
  76     #[derive(Copy, Clone, PartialEq)]
  77     pub enum NativeLibraryKind {
  78         NativeStatic,    // native static library (.a archive)
  79         NativeFramework, // OSX-specific
  80         NativeUnknown,   // default way to specify a dynamic library
  81     }
  82 }
  83
  84 // Something that a name can resolve to.
  85 #[derive(Copy, Clone, Debug)]
  86 pub enum DefLike {
  87     DlDef(Def),
  88     DlImpl(DefId),
  89     DlField
  90 }
  91
  92 /// The data we save and restore about an inlined item or method.  This is not
  93 /// part of the AST that we parse from a file, but it becomes part of the tree
  94 /// that we trans.
  95 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
  96 pub enum InlinedItem {
  97     Item(P<hir::Item>),
  98     TraitItem(DefId /* impl id */, P<hir::TraitItem>),
  99     ImplItem(DefId /* impl id */, P<hir::ImplItem>),
 100     Foreign(P<hir::ForeignItem>),
 101 }
 102
 103 /// A borrowed version of `hir::InlinedItem`.
 104 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
 105 pub enum InlinedItemRef<'a> {
 106     Item(&'a hir::Item),
 107     TraitItem(DefId, &'a hir::TraitItem),
 108     ImplItem(DefId, &'a hir::ImplItem),
 109     Foreign(&'a hir::ForeignItem)
 110 }
 111
 112 /// Item definitions in the currently-compiled crate would have the CrateNum
 113 /// LOCAL_CRATE in their DefId.
 114 pub const LOCAL_CRATE: ast::CrateNum = 0;
 115
 116 pub struct ChildItem {
 117     pub def: DefLike,
 118     pub name: ast::Name,
 119     pub vis: hir::Visibility
 120 }
 121
 122 pub enum FoundAst<'ast> {
 123     Found(&'ast InlinedItem),
 124     FoundParent(DefId, &'ast InlinedItem),
 125     NotFound,
 126 }
 127
 128 /// A store of Rust crates, through with their metadata
 129 /// can be accessed.
 130 ///
 131 /// The `: Any` bound is a temporary measure that allows access
 132 /// to the backing `rustc_metadata::cstore::CStore` object. It
 133 /// will be removed in the near future - if you need to access
 134 /// internal APIs, please tell us.
 135 pub trait CrateStore<'tcx> : Any {
 136     // item info
 137     fn stability(&self, def: DefId) -> Option<attr::Stability>;
 138     fn deprecation(&self, def: DefId) -> Option<attr::Deprecation>;
 139     fn closure_kind(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
 140                     -> ty::ClosureKind;
 141     fn closure_ty(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
 142                   -> ty::ClosureTy<'tcx>;
 143     fn item_variances(&self, def: DefId) -> ty::ItemVariances;
 144     fn repr_attrs(&self, def: DefId) -> Vec<attr::ReprAttr>;
 145     fn item_type(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 146                  -> ty::TypeScheme<'tcx>;
 147     fn item_path(&self, def: DefId) -> Vec<hir_map::PathElem>;
 148     fn extern_item_path(&self, def: DefId) -> Vec<hir_map::PathElem>;
 149     fn item_name(&self, def: DefId) -> ast::Name;
 150     fn item_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 151                        -> ty::GenericPredicates<'tcx>;
 152     fn item_super_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 153                              -> ty::GenericPredicates<'tcx>;
 154     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>;
 155     fn item_symbol(&self, def: DefId) -> String;
 156     fn trait_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId)-> ty::TraitDef<'tcx>;
 157     fn adt_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId) -> ty::AdtDefMaster<'tcx>;
 158     fn method_arg_names(&self, did: DefId) -> Vec<String>;
 159     fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId>;
 160
 161     // trait info
 162     fn implementations_of_trait(&self, def_id: DefId) -> Vec<DefId>;
 163     fn provided_trait_methods(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 164                               -> Vec<Rc<ty::Method<'tcx>>>;
 165     fn trait_item_def_ids(&self, def: DefId)
 166                           -> Vec<ty::ImplOrTraitItemId>;
 167
 168     // impl info
 169     fn impl_items(&self, impl_def_id: DefId) -> Vec<ty::ImplOrTraitItemId>;
 170     fn impl_trait_ref(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 171                       -> Option<ty::TraitRef<'tcx>>;
 172     fn impl_polarity(&self, def: DefId) -> Option<hir::ImplPolarity>;
 173     fn custom_coerce_unsized_kind(&self, def: DefId)
 174                                   -> Option<ty::adjustment::CustomCoerceUnsized>;
 175     fn associated_consts(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 176                          -> Vec<Rc<ty::AssociatedConst<'tcx>>>;
 177
 178     // trait/impl-item info
 179     fn trait_of_item(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
 180                      -> Option<DefId>;
 181     fn impl_or_trait_item(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 182                           -> ty::ImplOrTraitItem<'tcx>;
 183
 184     // flags
 185     fn is_const_fn(&self, did: DefId) -> bool;
 186     fn is_defaulted_trait(&self, did: DefId) -> bool;
 187     fn is_impl(&self, did: DefId) -> bool;
 188     fn is_default_impl(&self, impl_did: DefId) -> bool;
 189     fn is_extern_fn(&self, tcx: &ty::ctxt<'tcx>, did: DefId) -> bool;
 190     fn is_static(&self, did: DefId) -> bool;
 191     fn is_static_method(&self, did: DefId) -> bool;
 192     fn is_statically_included_foreign_item(&self, id: ast::NodeId) -> bool;
 193     fn is_typedef(&self, did: DefId) -> bool;
 194
 195     // crate metadata
 196     fn dylib_dependency_formats(&self, cnum: ast::CrateNum)
 197                                     -> Vec<(ast::CrateNum, LinkagePreference)>;
 198     fn lang_items(&self, cnum: ast::CrateNum) -> Vec<(DefIndex, usize)>;
 199     fn missing_lang_items(&self, cnum: ast::CrateNum) -> Vec<lang_items::LangItem>;
 200     fn is_staged_api(&self, cnum: ast::CrateNum) -> bool;
 201     fn is_explicitly_linked(&self, cnum: ast::CrateNum) -> bool;
 202     fn is_allocator(&self, cnum: ast::CrateNum) -> bool;
 203     fn crate_attrs(&self, cnum: ast::CrateNum) -> Vec<ast::Attribute>;
 204     fn crate_name(&self, cnum: ast::CrateNum) -> String;
 205     fn crate_hash(&self, cnum: ast::CrateNum) -> Svh;
 206     fn crate_struct_field_attrs(&self, cnum: ast::CrateNum)
 207                                 -> FnvHashMap<DefId, Vec<ast::Attribute>>;
 208     fn plugin_registrar_fn(&self, cnum: ast::CrateNum) -> Option<DefId>;
 209     fn native_libraries(&self, cnum: ast::CrateNum) -> Vec<(NativeLibraryKind, String)>;
 210     fn reachable_ids(&self, cnum: ast::CrateNum) -> Vec<DefId>;
 211
 212     // resolve
 213     fn def_path(&self, def: DefId) -> hir_map::DefPath;
 214     fn variant_kind(&self, def_id: DefId) -> Option<VariantKind>;
 215     fn struct_ctor_def_id(&self, struct_def_id: DefId) -> Option<DefId>;
 216     fn tuple_struct_definition_if_ctor(&self, did: DefId) -> Option<DefId>;
 217     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
 218     fn item_children(&self, did: DefId) -> Vec<ChildItem>;
 219     fn crate_top_level_items(&self, cnum: ast::CrateNum) -> Vec<ChildItem>;
 220
 221     // misc. metadata
 222     fn maybe_get_item_ast(&'tcx self, tcx: &ty::ctxt<'tcx>, def: DefId)
 223                           -> FoundAst<'tcx>;
 224     fn maybe_get_item_mir(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 225                           -> Option<Mir<'tcx>>;
 226     // This is basically a 1-based range of ints, which is a little
 227     // silly - I may fix that.
 228     fn crates(&self) -> Vec<ast::CrateNum>;
 229     fn used_libraries(&self) -> Vec<(String, NativeLibraryKind)>;
 230     fn used_link_args(&self) -> Vec<String>;
 231
 232     // utility functions
 233     fn metadata_filename(&self) -> &str;
 234     fn metadata_section_name(&self, target: &Target) -> &str;
 235     fn encode_type(&self, tcx: &ty::ctxt<'tcx>, ty: Ty<'tcx>) -> Vec<u8>;
 236     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(ast::CrateNum, Option<PathBuf>)>;
 237     fn used_crate_source(&self, cnum: ast::CrateNum) -> CrateSource;
 238     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<ast::CrateNum>;
 239     fn encode_metadata(&self,
 240                        tcx: &ty::ctxt<'tcx>,
 241                        reexports: &def::ExportMap,
 242                        item_symbols: &RefCell<NodeMap<String>>,
 243                        link_meta: &LinkMeta,
 244                        reachable: &NodeSet,
 245                        mir_map: &NodeMap<Mir<'tcx>>,
 246                        krate: &hir::Crate) -> Vec<u8>;
 247     fn metadata_encoding_version(&self) -> &[u8];
 248 }
 249
 250 impl InlinedItem {
 251     pub fn visit<'ast,V>(&'ast self, visitor: &mut V)
 252         where V: Visitor<'ast>
 253     {
 254         match *self {
 255             InlinedItem::Item(ref i) => visitor.visit_item(&**i),
 256             InlinedItem::Foreign(ref i) => visitor.visit_foreign_item(&**i),
 257             InlinedItem::TraitItem(_, ref ti) => visitor.visit_trait_item(ti),
 258             InlinedItem::ImplItem(_, ref ii) => visitor.visit_impl_item(ii),
 259         }
 260     }
 261
 262     pub fn visit_ids<O: IdVisitingOperation>(&self, operation: &mut O) {
 263         let mut id_visitor = IdVisitor::new(operation);
 264         self.visit(&mut id_visitor);
 265     }
 266 }
 267
 268 // FIXME: find a better place for this?
 269 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
 270     let say = |s: &str| {
 271         match (sp, sess) {
 272             (_, None) => panic!("{}", s),
 273             (Some(sp), Some(sess)) => sess.span_err(sp, s),
 274             (None, Some(sess)) => sess.err(s),
 275         }
 276     };
 277     if s.is_empty() {
 278         say("crate name must not be empty");
 279     }
 280     for c in s.chars() {
 281         if c.is_alphanumeric() { continue }
 282         if c == '_'  { continue }
 283         say(&format!("invalid character `{}` in crate name: `{}`", c, s));
 284     }
 285     match sess {
 286         Some(sess) => sess.abort_if_errors(),
 287         None => {}
 288     }
 289 }
 290
 291 /// A dummy crate store that does not support any non-local crates,
 292 /// for test purposes.
 293 pub struct DummyCrateStore;
 294 #[allow(unused_variables)]
 295 impl<'tcx> CrateStore<'tcx> for DummyCrateStore {
 296     // item info
 297     fn stability(&self, def: DefId) -> Option<attr::Stability> { unimplemented!() }
 298     fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> { unimplemented!() }
 299     fn closure_kind(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
 300                     -> ty::ClosureKind  { unimplemented!() }
 301     fn closure_ty(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
 302                   -> ty::ClosureTy<'tcx>  { unimplemented!() }
 303     fn item_variances(&self, def: DefId) -> ty::ItemVariances { unimplemented!() }
 304     fn repr_attrs(&self, def: DefId) -> Vec<attr::ReprAttr> { unimplemented!() }
 305     fn item_type(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 306                  -> ty::TypeScheme<'tcx> { unimplemented!() }
 307     fn item_path(&self, def: DefId) -> Vec<hir_map::PathElem> { unimplemented!() }
 308     fn extern_item_path(&self, def: DefId) -> Vec<hir_map::PathElem> { unimplemented!() }
 309     fn item_name(&self, def: DefId) -> ast::Name { unimplemented!() }
 310     fn item_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 311                        -> ty::GenericPredicates<'tcx> { unimplemented!() }
 312     fn item_super_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 313                              -> ty::GenericPredicates<'tcx> { unimplemented!() }
 314     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute> { unimplemented!() }
 315     fn item_symbol(&self, def: DefId) -> String { unimplemented!() }
 316     fn trait_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId)-> ty::TraitDef<'tcx>
 317         { unimplemented!() }
 318     fn adt_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId) -> ty::AdtDefMaster<'tcx>
 319         { unimplemented!() }
 320     fn method_arg_names(&self, did: DefId) -> Vec<String> { unimplemented!() }
 321     fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId> { vec![] }
 322
 323     // trait info
 324     fn implementations_of_trait(&self, def_id: DefId) -> Vec<DefId> { vec![] }
 325     fn provided_trait_methods(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 326                               -> Vec<Rc<ty::Method<'tcx>>> { unimplemented!() }
 327     fn trait_item_def_ids(&self, def: DefId)
 328                           -> Vec<ty::ImplOrTraitItemId> { unimplemented!() }
 329
 330     // impl info
 331     fn impl_items(&self, impl_def_id: DefId) -> Vec<ty::ImplOrTraitItemId>
 332         { unimplemented!() }
 333     fn impl_trait_ref(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 334                       -> Option<ty::TraitRef<'tcx>> { unimplemented!() }
 335     fn impl_polarity(&self, def: DefId) -> Option<hir::ImplPolarity> { unimplemented!() }
 336     fn custom_coerce_unsized_kind(&self, def: DefId)
 337                                   -> Option<ty::adjustment::CustomCoerceUnsized>
 338         { unimplemented!() }
 339     fn associated_consts(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 340                          -> Vec<Rc<ty::AssociatedConst<'tcx>>> { unimplemented!() }
 341
 342     // trait/impl-item info
 343     fn trait_of_item(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
 344                      -> Option<DefId> { unimplemented!() }
 345     fn impl_or_trait_item(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 346                           -> ty::ImplOrTraitItem<'tcx> { unimplemented!() }
 347
 348     // flags
 349     fn is_const_fn(&self, did: DefId) -> bool { unimplemented!() }
 350     fn is_defaulted_trait(&self, did: DefId) -> bool { unimplemented!() }
 351     fn is_impl(&self, did: DefId) -> bool { unimplemented!() }
 352     fn is_default_impl(&self, impl_did: DefId) -> bool { unimplemented!() }
 353     fn is_extern_fn(&self, tcx: &ty::ctxt<'tcx>, did: DefId) -> bool { unimplemented!() }
 354     fn is_static(&self, did: DefId) -> bool { unimplemented!() }
 355     fn is_static_method(&self, did: DefId) -> bool { unimplemented!() }
 356     fn is_statically_included_foreign_item(&self, id: ast::NodeId) -> bool { false }
 357     fn is_typedef(&self, did: DefId) -> bool { unimplemented!() }
 358
 359     // crate metadata
 360     fn dylib_dependency_formats(&self, cnum: ast::CrateNum)
 361                                     -> Vec<(ast::CrateNum, LinkagePreference)>
 362         { unimplemented!() }
 363     fn lang_items(&self, cnum: ast::CrateNum) -> Vec<(DefIndex, usize)>
 364         { unimplemented!() }
 365     fn missing_lang_items(&self, cnum: ast::CrateNum) -> Vec<lang_items::LangItem>
 366         { unimplemented!() }
 367     fn is_staged_api(&self, cnum: ast::CrateNum) -> bool { unimplemented!() }
 368     fn is_explicitly_linked(&self, cnum: ast::CrateNum) -> bool { unimplemented!() }
 369     fn is_allocator(&self, cnum: ast::CrateNum) -> bool { unimplemented!() }
 370     fn crate_attrs(&self, cnum: ast::CrateNum) -> Vec<ast::Attribute>
 371         { unimplemented!() }
 372     fn crate_name(&self, cnum: ast::CrateNum) -> String { unimplemented!() }
 373     fn crate_hash(&self, cnum: ast::CrateNum) -> Svh { unimplemented!() }
 374     fn crate_struct_field_attrs(&self, cnum: ast::CrateNum)
 375                                 -> FnvHashMap<DefId, Vec<ast::Attribute>>
 376         { unimplemented!() }
 377     fn plugin_registrar_fn(&self, cnum: ast::CrateNum) -> Option<DefId>
 378         { unimplemented!() }
 379     fn native_libraries(&self, cnum: ast::CrateNum) -> Vec<(NativeLibraryKind, String)>
 380         { unimplemented!() }
 381     fn reachable_ids(&self, cnum: ast::CrateNum) -> Vec<DefId> { unimplemented!() }
 382
 383     // resolve
 384     fn def_path(&self, def: DefId) -> hir_map::DefPath { unimplemented!() }
 385     fn variant_kind(&self, def_id: DefId) -> Option<VariantKind> { unimplemented!() }
 386     fn struct_ctor_def_id(&self, struct_def_id: DefId) -> Option<DefId>
 387         { unimplemented!() }
 388     fn tuple_struct_definition_if_ctor(&self, did: DefId) -> Option<DefId>
 389         { unimplemented!() }
 390     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { unimplemented!() }
 391     fn item_children(&self, did: DefId) -> Vec<ChildItem> { unimplemented!() }
 392     fn crate_top_level_items(&self, cnum: ast::CrateNum) -> Vec<ChildItem>
 393         { unimplemented!() }
 394
 395     // misc. metadata
 396     fn maybe_get_item_ast(&'tcx self, tcx: &ty::ctxt<'tcx>, def: DefId)
 397                           -> FoundAst<'tcx> { unimplemented!() }
 398     fn maybe_get_item_mir(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
 399                           -> Option<Mir<'tcx>> { unimplemented!() }
 400
 401     // This is basically a 1-based range of ints, which is a little
 402     // silly - I may fix that.
 403     fn crates(&self) -> Vec<ast::CrateNum> { vec![] }
 404     fn used_libraries(&self) -> Vec<(String, NativeLibraryKind)> { vec![] }
 405     fn used_link_args(&self) -> Vec<String> { vec![] }
 406
 407     // utility functions
 408     fn metadata_filename(&self) -> &str { unimplemented!() }
 409     fn metadata_section_name(&self, target: &Target) -> &str { unimplemented!() }
 410     fn encode_type(&self, tcx: &ty::ctxt<'tcx>, ty: Ty<'tcx>) -> Vec<u8>
 411         { unimplemented!() }
 412     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(ast::CrateNum, Option<PathBuf>)>
 413         { vec![] }
 414     fn used_crate_source(&self, cnum: ast::CrateNum) -> CrateSource { unimplemented!() }
 415     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<ast::CrateNum> { None }
 416     fn encode_metadata(&self,
 417                        tcx: &ty::ctxt<'tcx>,
 418                        reexports: &def::ExportMap,
 419                        item_symbols: &RefCell<NodeMap<String>>,
 420                        link_meta: &LinkMeta,
 421                        reachable: &NodeSet,
 422                        mir_map: &NodeMap<Mir<'tcx>>,
 423                        krate: &hir::Crate) -> Vec<u8> { vec![] }
 424     fn metadata_encoding_version(&self) -> &[u8] { unimplemented!() }
 425 }
 426
 427
 428 /// Metadata encoding and decoding can make use of thread-local encoding and
 429 /// decoding contexts. These allow implementers of serialize::Encodable and
 430 /// Decodable to access information and datastructures that would otherwise not
 431 /// be available to them. For example, we can automatically translate def-id and
 432 /// span information during decoding because the decoding context knows which
 433 /// crate the data is decoded from. Or it allows to make ty::Ty decodable
 434 /// because the context has access to the ty::ctxt that is needed for creating
 435 /// ty::Ty instances.
 436 ///
 437 /// Note, however, that this only works for RBML-based encoding and decoding at
 438 /// the moment.
 439 pub mod tls {
 440     use rbml::opaque::Encoder as OpaqueEncoder;
 441     use rbml::opaque::Decoder as OpaqueDecoder;
 442     use serialize;
 443     use std::mem;
 444     use middle::ty::{self, Ty};
 445     use middle::subst::Substs;
 446     use middle::def_id::DefId;
 447
 448     pub trait EncodingContext<'tcx> {
 449         fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx>;
 450         fn encode_ty(&self, encoder: &mut OpaqueEncoder, t: Ty<'tcx>);
 451         fn encode_substs(&self, encoder: &mut OpaqueEncoder, substs: &Substs<'tcx>);
 452     }
 453
 454     /// Marker type used for the scoped TLS slot.
 455     /// The type context cannot be used directly because the scoped TLS
 456     /// in libstd doesn't allow types generic over lifetimes.
 457     struct TlsPayload;
 458
 459     scoped_thread_local!(static TLS_ENCODING: TlsPayload);
 460
 461     /// Execute f after pushing the given EncodingContext onto the TLS stack.
 462     pub fn enter_encoding_context<'tcx, F, R>(ecx: &EncodingContext<'tcx>,
 463                                               encoder: &mut OpaqueEncoder,
 464                                               f: F) -> R
 465         where F: FnOnce(&EncodingContext<'tcx>, &mut OpaqueEncoder) -> R
 466     {
 467         let tls_payload = (ecx as *const _, encoder as *mut _);
 468         let tls_ptr = &tls_payload as *const _ as *const TlsPayload;
 469         TLS_ENCODING.set(unsafe { &*tls_ptr }, || f(ecx, encoder))
 470     }
 471
 472     /// Execute f with access to the thread-local encoding context and
 473     /// rbml encoder. This function will panic if the encoder passed in and the
 474     /// context encoder are not the same.
 475     ///
 476     /// Note that this method is 'practically' safe due to its checking that the
 477     /// encoder passed in is the same as the one in TLS, but it would still be
 478     /// possible to construct cases where the EncodingContext is exchanged
 479     /// while the same encoder is used, thus working with a wrong context.
 480     pub fn with_encoding_context<'tcx, E, F, R>(encoder: &mut E, f: F) -> R
 481         where F: FnOnce(&EncodingContext<'tcx>, &mut OpaqueEncoder) -> R,
 482               E: serialize::Encoder
 483     {
 484         unsafe {
 485             unsafe_with_encoding_context(|ecx, tls_encoder| {
 486                 assert!(encoder as *mut _ as usize == tls_encoder as *mut _ as usize);
 487
 488                 let ecx: &EncodingContext<'tcx> = mem::transmute(ecx);
 489
 490                 f(ecx, tls_encoder)
 491             })
 492         }
 493     }
 494
 495     /// Execute f with access to the thread-local encoding context and
 496     /// rbml encoder.
 497     pub unsafe fn unsafe_with_encoding_context<F, R>(f: F) -> R
 498         where F: FnOnce(&EncodingContext, &mut OpaqueEncoder) -> R
 499     {
 500         TLS_ENCODING.with(|tls| {
 501             let tls_payload = (tls as *const TlsPayload)
 502                                    as *mut (&EncodingContext, &mut OpaqueEncoder);
 503             f((*tls_payload).0, (*tls_payload).1)
 504         })
 505     }
 506
 507     pub trait DecodingContext<'tcx> {
 508         fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx>;
 509         fn decode_ty(&self, decoder: &mut OpaqueDecoder) -> ty::Ty<'tcx>;
 510         fn decode_substs(&self, decoder: &mut OpaqueDecoder) -> Substs<'tcx>;
 511         fn translate_def_id(&self, def_id: DefId) -> DefId;
 512     }
 513
 514     scoped_thread_local!(static TLS_DECODING: TlsPayload);
 515
 516     /// Execute f after pushing the given DecodingContext onto the TLS stack.
 517     pub fn enter_decoding_context<'tcx, F, R>(dcx: &DecodingContext<'tcx>,
 518                                               decoder: &mut OpaqueDecoder,
 519                                               f: F) -> R
 520         where F: FnOnce(&DecodingContext<'tcx>, &mut OpaqueDecoder) -> R
 521     {
 522         let tls_payload = (dcx as *const _, decoder as *mut _);
 523         let tls_ptr = &tls_payload as *const _ as *const TlsPayload;
 524         TLS_DECODING.set(unsafe { &*tls_ptr }, || f(dcx, decoder))
 525     }
 526
 527     /// Execute f with access to the thread-local decoding context and
 528     /// rbml decoder. This function will panic if the decoder passed in and the
 529     /// context decoder are not the same.
 530     ///
 531     /// Note that this method is 'practically' safe due to its checking that the
 532     /// decoder passed in is the same as the one in TLS, but it would still be
 533     /// possible to construct cases where the DecodingContext is exchanged
 534     /// while the same decoder is used, thus working with a wrong context.
 535     pub fn with_decoding_context<'decoder, 'tcx, D, F, R>(d: &'decoder mut D, f: F) -> R
 536         where D: serialize::Decoder,
 537               F: FnOnce(&DecodingContext<'tcx>,
 538                         &mut OpaqueDecoder) -> R,
 539               'tcx: 'decoder
 540     {
 541         unsafe {
 542             unsafe_with_decoding_context(|dcx, decoder| {
 543                 assert!((d as *mut _ as usize) == (decoder as *mut _ as usize));
 544
 545                 let dcx: &DecodingContext<'tcx> = mem::transmute(dcx);
 546
 547                 f(dcx, decoder)
 548             })
 549         }
 550     }
 551
 552     /// Execute f with access to the thread-local decoding context and
 553     /// rbml decoder.
 554     pub unsafe fn unsafe_with_decoding_context<F, R>(f: F) -> R
 555         where F: FnOnce(&DecodingContext, &mut OpaqueDecoder) -> R
 556     {
 557         TLS_DECODING.with(|tls| {
 558             let tls_payload = (tls as *const TlsPayload)
 559                                    as *mut (&DecodingContext, &mut OpaqueDecoder);
 560             f((*tls_payload).0, (*tls_payload).1)
 561         })
 562     }
 563 }