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.
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.
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.
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.
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.
26 use front::map as hir_map;
28 use middle::lang_items;
29 use middle::ty::{self, Ty};
30 use middle::def_id::{DefId, DefIndex};
32 use session::search_paths::PathKind;
33 use util::nodemap::{FnvHashMap, NodeMap, NodeSet};
35 use std::cell::RefCell;
37 use std::path::PathBuf;
39 use syntax::ast_util::{IdVisitingOperation};
41 use syntax::codemap::Span;
43 use rustc_back::target::Target;
45 use rustc_front::intravisit::Visitor;
46 use rustc_front::util::IdVisitor;
48 pub use self::DefLike::{DlDef, DlField, DlImpl};
49 pub use self::NativeLibraryKind::{NativeStatic, NativeFramework, NativeUnknown};
51 // lonely orphan structs and enums looking for a better home
53 #[derive(Clone, Debug)]
55 pub crate_name: String,
59 // Where a crate came from on the local filesystem. One of these two options
61 #[derive(PartialEq, Clone, Debug)]
62 pub struct CrateSource {
63 pub dylib: Option<(PathBuf, PathKind)>,
64 pub rlib: Option<(PathBuf, PathKind)>,
65 pub cnum: ast::CrateNum,
68 #[derive(Copy, Debug, PartialEq, Clone)]
69 pub enum LinkagePreference {
75 #[derive(Copy, Clone, PartialEq)]
76 pub enum NativeLibraryKind {
77 NativeStatic, // native static library (.a archive)
78 NativeFramework, // OSX-specific
79 NativeUnknown, // default way to specify a dynamic library
83 // Something that a name can resolve to.
84 #[derive(Copy, Clone, Debug)]
91 /// The data we save and restore about an inlined item or method. This is not
92 /// part of the AST that we parse from a file, but it becomes part of the tree
94 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
95 pub enum InlinedItem {
97 TraitItem(DefId /* impl id */, P<hir::TraitItem>),
98 ImplItem(DefId /* impl id */, P<hir::ImplItem>),
99 Foreign(P<hir::ForeignItem>),
102 /// A borrowed version of `hir::InlinedItem`.
103 pub enum InlinedItemRef<'a> {
105 TraitItem(DefId, &'a hir::TraitItem),
106 ImplItem(DefId, &'a hir::ImplItem),
107 Foreign(&'a hir::ForeignItem)
110 /// Item definitions in the currently-compiled crate would have the CrateNum
111 /// LOCAL_CRATE in their DefId.
112 pub const LOCAL_CRATE: ast::CrateNum = 0;
114 pub struct ChildItem {
117 pub vis: hir::Visibility
120 pub enum FoundAst<'ast> {
121 Found(&'ast InlinedItem),
122 FoundParent(DefId, &'ast InlinedItem),
126 /// A store of Rust crates, through with their metadata
129 /// The `: Any` bound is a temporary measure that allows access
130 /// to the backing `rustc_metadata::cstore::CStore` object. It
131 /// will be removed in the near future - if you need to access
132 /// internal APIs, please tell us.
133 pub trait CrateStore<'tcx> : Any {
135 fn stability(&self, def: DefId) -> Option<attr::Stability>;
136 fn closure_kind(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
138 fn closure_ty(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
139 -> ty::ClosureTy<'tcx>;
140 fn item_variances(&self, def: DefId) -> ty::ItemVariances;
141 fn repr_attrs(&self, def: DefId) -> Vec<attr::ReprAttr>;
142 fn item_type(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
143 -> ty::TypeScheme<'tcx>;
144 fn item_path(&self, def: DefId) -> Vec<hir_map::PathElem>;
145 fn item_name(&self, def: DefId) -> ast::Name;
146 fn item_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
147 -> ty::GenericPredicates<'tcx>;
148 fn item_super_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
149 -> ty::GenericPredicates<'tcx>;
150 fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>;
151 fn item_symbol(&self, def: DefId) -> String;
152 fn trait_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId)-> ty::TraitDef<'tcx>;
153 fn adt_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId) -> ty::AdtDefMaster<'tcx>;
154 fn method_arg_names(&self, did: DefId) -> Vec<String>;
155 fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId>;
158 fn implementations_of_trait(&self, def_id: DefId) -> Vec<DefId>;
159 fn provided_trait_methods(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
160 -> Vec<Rc<ty::Method<'tcx>>>;
161 fn trait_item_def_ids(&self, def: DefId)
162 -> Vec<ty::ImplOrTraitItemId>;
165 fn impl_items(&self, impl_def_id: DefId) -> Vec<ty::ImplOrTraitItemId>;
166 fn impl_trait_ref(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
167 -> Option<ty::TraitRef<'tcx>>;
168 fn impl_polarity(&self, def: DefId) -> Option<hir::ImplPolarity>;
169 fn custom_coerce_unsized_kind(&self, def: DefId)
170 -> Option<ty::adjustment::CustomCoerceUnsized>;
171 fn associated_consts(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
172 -> Vec<Rc<ty::AssociatedConst<'tcx>>>;
174 // trait/impl-item info
175 fn trait_of_item(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
177 fn impl_or_trait_item(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
178 -> ty::ImplOrTraitItem<'tcx>;
181 fn is_const_fn(&self, did: DefId) -> bool;
182 fn is_defaulted_trait(&self, did: DefId) -> bool;
183 fn is_impl(&self, did: DefId) -> bool;
184 fn is_default_impl(&self, impl_did: DefId) -> bool;
185 fn is_extern_fn(&self, tcx: &ty::ctxt<'tcx>, did: DefId) -> bool;
186 fn is_static(&self, did: DefId) -> bool;
187 fn is_static_method(&self, did: DefId) -> bool;
188 fn is_statically_included_foreign_item(&self, id: ast::NodeId) -> bool;
189 fn is_typedef(&self, did: DefId) -> bool;
192 fn dylib_dependency_formats(&self, cnum: ast::CrateNum)
193 -> Vec<(ast::CrateNum, LinkagePreference)>;
194 fn lang_items(&self, cnum: ast::CrateNum) -> Vec<(DefIndex, usize)>;
195 fn missing_lang_items(&self, cnum: ast::CrateNum) -> Vec<lang_items::LangItem>;
196 fn is_staged_api(&self, cnum: ast::CrateNum) -> bool;
197 fn is_explicitly_linked(&self, cnum: ast::CrateNum) -> bool;
198 fn is_allocator(&self, cnum: ast::CrateNum) -> bool;
199 fn crate_attrs(&self, cnum: ast::CrateNum) -> Vec<ast::Attribute>;
200 fn crate_name(&self, cnum: ast::CrateNum) -> String;
201 fn crate_hash(&self, cnum: ast::CrateNum) -> Svh;
202 fn crate_struct_field_attrs(&self, cnum: ast::CrateNum)
203 -> FnvHashMap<DefId, Vec<ast::Attribute>>;
204 fn plugin_registrar_fn(&self, cnum: ast::CrateNum) -> Option<DefId>;
205 fn native_libraries(&self, cnum: ast::CrateNum) -> Vec<(NativeLibraryKind, String)>;
206 fn reachable_ids(&self, cnum: ast::CrateNum) -> Vec<DefId>;
209 fn def_path(&self, def: DefId) -> hir_map::DefPath;
210 fn tuple_struct_definition_if_ctor(&self, did: DefId) -> Option<DefId>;
211 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
212 fn item_children(&self, did: DefId) -> Vec<ChildItem>;
213 fn crate_top_level_items(&self, cnum: ast::CrateNum) -> Vec<ChildItem>;
216 fn maybe_get_item_ast(&'tcx self, tcx: &ty::ctxt<'tcx>, def: DefId)
218 // This is basically a 1-based range of ints, which is a little
219 // silly - I may fix that.
220 fn crates(&self) -> Vec<ast::CrateNum>;
221 fn used_libraries(&self) -> Vec<(String, NativeLibraryKind)>;
222 fn used_link_args(&self) -> Vec<String>;
225 fn metadata_filename(&self) -> &str;
226 fn metadata_section_name(&self, target: &Target) -> &str;
227 fn encode_type(&self, tcx: &ty::ctxt<'tcx>, ty: Ty<'tcx>) -> Vec<u8>;
228 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(ast::CrateNum, Option<PathBuf>)>;
229 fn used_crate_source(&self, cnum: ast::CrateNum) -> CrateSource;
230 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<ast::CrateNum>;
231 fn encode_metadata(&self,
232 tcx: &ty::ctxt<'tcx>,
233 reexports: &def::ExportMap,
234 item_symbols: &RefCell<NodeMap<String>>,
235 link_meta: &LinkMeta,
237 krate: &hir::Crate) -> Vec<u8>;
238 fn metadata_encoding_version(&self) -> &[u8];
242 pub fn visit<'ast,V>(&'ast self, visitor: &mut V)
243 where V: Visitor<'ast>
246 InlinedItem::Item(ref i) => visitor.visit_item(&**i),
247 InlinedItem::Foreign(ref i) => visitor.visit_foreign_item(&**i),
248 InlinedItem::TraitItem(_, ref ti) => visitor.visit_trait_item(ti),
249 InlinedItem::ImplItem(_, ref ii) => visitor.visit_impl_item(ii),
253 pub fn visit_ids<O: IdVisitingOperation>(&self, operation: &mut O) {
254 let mut id_visitor = IdVisitor::new(operation);
255 self.visit(&mut id_visitor);
259 // FIXME: find a better place for this?
260 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
261 let say = |s: &str| {
263 (_, None) => panic!("{}", s),
264 (Some(sp), Some(sess)) => sess.span_err(sp, s),
265 (None, Some(sess)) => sess.err(s),
269 say("crate name must not be empty");
272 if c.is_alphanumeric() { continue }
273 if c == '_' { continue }
274 say(&format!("invalid character `{}` in crate name: `{}`", c, s));
277 Some(sess) => sess.abort_if_errors(),
282 /// A dummy crate store that does not support any non-local crates,
283 /// for test purposes.
284 pub struct DummyCrateStore;
285 #[allow(unused_variables)]
286 impl<'tcx> CrateStore<'tcx> for DummyCrateStore {
288 fn stability(&self, def: DefId) -> Option<attr::Stability> { unimplemented!() }
289 fn closure_kind(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
290 -> ty::ClosureKind { unimplemented!() }
291 fn closure_ty(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
292 -> ty::ClosureTy<'tcx> { unimplemented!() }
293 fn item_variances(&self, def: DefId) -> ty::ItemVariances { unimplemented!() }
294 fn repr_attrs(&self, def: DefId) -> Vec<attr::ReprAttr> { unimplemented!() }
295 fn item_type(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
296 -> ty::TypeScheme<'tcx> { unimplemented!() }
297 fn item_path(&self, def: DefId) -> Vec<hir_map::PathElem> { unimplemented!() }
298 fn item_name(&self, def: DefId) -> ast::Name { unimplemented!() }
299 fn item_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
300 -> ty::GenericPredicates<'tcx> { unimplemented!() }
301 fn item_super_predicates(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
302 -> ty::GenericPredicates<'tcx> { unimplemented!() }
303 fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute> { unimplemented!() }
304 fn item_symbol(&self, def: DefId) -> String { unimplemented!() }
305 fn trait_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId)-> ty::TraitDef<'tcx>
307 fn adt_def(&self, tcx: &ty::ctxt<'tcx>, def: DefId) -> ty::AdtDefMaster<'tcx>
309 fn method_arg_names(&self, did: DefId) -> Vec<String> { unimplemented!() }
310 fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId> { vec![] }
313 fn implementations_of_trait(&self, def_id: DefId) -> Vec<DefId> { vec![] }
314 fn provided_trait_methods(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
315 -> Vec<Rc<ty::Method<'tcx>>> { unimplemented!() }
316 fn trait_item_def_ids(&self, def: DefId)
317 -> Vec<ty::ImplOrTraitItemId> { unimplemented!() }
320 fn impl_items(&self, impl_def_id: DefId) -> Vec<ty::ImplOrTraitItemId>
322 fn impl_trait_ref(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
323 -> Option<ty::TraitRef<'tcx>> { unimplemented!() }
324 fn impl_polarity(&self, def: DefId) -> Option<hir::ImplPolarity> { unimplemented!() }
325 fn custom_coerce_unsized_kind(&self, def: DefId)
326 -> Option<ty::adjustment::CustomCoerceUnsized>
328 fn associated_consts(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
329 -> Vec<Rc<ty::AssociatedConst<'tcx>>> { unimplemented!() }
331 // trait/impl-item info
332 fn trait_of_item(&self, tcx: &ty::ctxt<'tcx>, def_id: DefId)
333 -> Option<DefId> { unimplemented!() }
334 fn impl_or_trait_item(&self, tcx: &ty::ctxt<'tcx>, def: DefId)
335 -> ty::ImplOrTraitItem<'tcx> { unimplemented!() }
338 fn is_const_fn(&self, did: DefId) -> bool { unimplemented!() }
339 fn is_defaulted_trait(&self, did: DefId) -> bool { unimplemented!() }
340 fn is_impl(&self, did: DefId) -> bool { unimplemented!() }
341 fn is_default_impl(&self, impl_did: DefId) -> bool { unimplemented!() }
342 fn is_extern_fn(&self, tcx: &ty::ctxt<'tcx>, did: DefId) -> bool { unimplemented!() }
343 fn is_static(&self, did: DefId) -> bool { unimplemented!() }
344 fn is_static_method(&self, did: DefId) -> bool { unimplemented!() }
345 fn is_statically_included_foreign_item(&self, id: ast::NodeId) -> bool { false }
346 fn is_typedef(&self, did: DefId) -> bool { unimplemented!() }
349 fn dylib_dependency_formats(&self, cnum: ast::CrateNum)
350 -> Vec<(ast::CrateNum, LinkagePreference)>
352 fn lang_items(&self, cnum: ast::CrateNum) -> Vec<(DefIndex, usize)>
354 fn missing_lang_items(&self, cnum: ast::CrateNum) -> Vec<lang_items::LangItem>
356 fn is_staged_api(&self, cnum: ast::CrateNum) -> bool { unimplemented!() }
357 fn is_explicitly_linked(&self, cnum: ast::CrateNum) -> bool { unimplemented!() }
358 fn is_allocator(&self, cnum: ast::CrateNum) -> bool { unimplemented!() }
359 fn crate_attrs(&self, cnum: ast::CrateNum) -> Vec<ast::Attribute>
361 fn crate_name(&self, cnum: ast::CrateNum) -> String { unimplemented!() }
362 fn crate_hash(&self, cnum: ast::CrateNum) -> Svh { unimplemented!() }
363 fn crate_struct_field_attrs(&self, cnum: ast::CrateNum)
364 -> FnvHashMap<DefId, Vec<ast::Attribute>>
366 fn plugin_registrar_fn(&self, cnum: ast::CrateNum) -> Option<DefId>
368 fn native_libraries(&self, cnum: ast::CrateNum) -> Vec<(NativeLibraryKind, String)>
370 fn reachable_ids(&self, cnum: ast::CrateNum) -> Vec<DefId> { unimplemented!() }
373 fn def_path(&self, def: DefId) -> hir_map::DefPath { unimplemented!() }
374 fn tuple_struct_definition_if_ctor(&self, did: DefId) -> Option<DefId>
376 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { unimplemented!() }
377 fn item_children(&self, did: DefId) -> Vec<ChildItem> { unimplemented!() }
378 fn crate_top_level_items(&self, cnum: ast::CrateNum) -> Vec<ChildItem>
382 fn maybe_get_item_ast(&'tcx self, tcx: &ty::ctxt<'tcx>, def: DefId)
383 -> FoundAst<'tcx> { unimplemented!() }
384 // This is basically a 1-based range of ints, which is a little
385 // silly - I may fix that.
386 fn crates(&self) -> Vec<ast::CrateNum> { vec![] }
387 fn used_libraries(&self) -> Vec<(String, NativeLibraryKind)> { vec![] }
388 fn used_link_args(&self) -> Vec<String> { vec![] }
391 fn metadata_filename(&self) -> &str { unimplemented!() }
392 fn metadata_section_name(&self, target: &Target) -> &str { unimplemented!() }
393 fn encode_type(&self, tcx: &ty::ctxt<'tcx>, ty: Ty<'tcx>) -> Vec<u8>
395 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(ast::CrateNum, Option<PathBuf>)>
397 fn used_crate_source(&self, cnum: ast::CrateNum) -> CrateSource { unimplemented!() }
398 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<ast::CrateNum> { None }
399 fn encode_metadata(&self,
400 tcx: &ty::ctxt<'tcx>,
401 reexports: &def::ExportMap,
402 item_symbols: &RefCell<NodeMap<String>>,
403 link_meta: &LinkMeta,
405 krate: &hir::Crate) -> Vec<u8> { vec![] }
406 fn metadata_encoding_version(&self) -> &[u8] { unimplemented!() }