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.
25 use hir::def::{self, Def};
26 use hir::def_id::{CrateNum, DefId, DefIndex};
27 use hir::map as hir_map;
28 use hir::map::definitions::{Definitions, DefKey, DisambiguatedDefPathData};
30 use middle::lang_items;
31 use ty::{self, TyCtxt};
33 use session::search_paths::PathKind;
34 use util::nodemap::{NodeSet, DefIdMap};
37 use std::collections::BTreeMap;
38 use std::path::PathBuf;
42 use syntax::ext::base::SyntaxExtension;
43 use syntax::symbol::Symbol;
45 use rustc_back::target::Target;
47 use rustc_back::PanicStrategy;
49 pub use self::NativeLibraryKind::*;
51 // lonely orphan structs and enums looking for a better home
53 #[derive(Clone, Debug)]
55 pub crate_name: Symbol,
59 // Where a crate came from on the local filesystem. One of these three options
61 #[derive(PartialEq, Clone, Debug)]
62 pub struct CrateSource {
63 pub dylib: Option<(PathBuf, PathKind)>,
64 pub rlib: Option<(PathBuf, PathKind)>,
65 pub rmeta: Option<(PathBuf, PathKind)>,
68 #[derive(RustcEncodable, RustcDecodable, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Debug)]
70 /// A dependency that is only used for its macros, none of which are visible from other crates.
71 /// These are included in the metadata only as placeholders and are ignored when decoding.
73 /// A dependency that is only used for its macros.
75 /// A dependency that is always injected into the dependency list and so
76 /// doesn't need to be linked to an rlib, e.g. the injected allocator.
78 /// A dependency that is required by an rlib version of this crate.
79 /// Ordinary `extern crate`s result in `Explicit` dependencies.
84 pub fn macros_only(self) -> bool {
86 DepKind::UnexportedMacrosOnly | DepKind::MacrosOnly => true,
87 DepKind::Implicit | DepKind::Explicit => false,
92 #[derive(PartialEq, Clone, Debug)]
100 pub fn is_some(&self) -> bool {
101 if let LibSource::Some(_) = *self {
108 pub fn option(&self) -> Option<PathBuf> {
110 LibSource::Some(ref p) => Some(p.clone()),
111 LibSource::MetadataOnly | LibSource::None => None,
116 #[derive(Copy, Debug, PartialEq, Clone, RustcEncodable, RustcDecodable)]
117 pub enum LinkagePreference {
122 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
123 pub enum NativeLibraryKind {
124 NativeStatic, // native static library (.a archive)
125 NativeStaticNobundle, // native static library, which doesn't get bundled into .rlibs
126 NativeFramework, // macOS-specific
127 NativeUnknown, // default way to specify a dynamic library
130 #[derive(Clone, Hash, RustcEncodable, RustcDecodable)]
131 pub struct NativeLibrary {
132 pub kind: NativeLibraryKind,
134 pub cfg: Option<ast::MetaItem>,
135 pub foreign_items: Vec<DefIndex>,
138 pub enum LoadedMacro {
140 ProcMacro(Rc<SyntaxExtension>),
143 #[derive(Copy, Clone, Debug)]
144 pub struct ExternCrate {
145 /// def_id of an `extern crate` in the current crate that caused
146 /// this crate to be loaded; note that there could be multiple
150 /// span of the extern crate that caused this to be loaded
153 /// If true, then this crate is the crate named by the extern
154 /// crate referenced above. If false, then this crate is a dep
158 /// Number of links to reach the extern crate `def_id`
159 /// declaration; used to select the extern crate with the shortest
164 /// A store of Rust crates, through with their metadata
166 pub trait CrateStore {
167 fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>;
170 fn describe_def(&self, def: DefId) -> Option<Def>;
171 fn def_span(&self, sess: &Session, def: DefId) -> Span;
172 fn stability(&self, def: DefId) -> Option<attr::Stability>;
173 fn deprecation(&self, def: DefId) -> Option<attr::Deprecation>;
174 fn visibility(&self, def: DefId) -> ty::Visibility;
175 fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>>;
176 fn item_generics_cloned(&self, def: DefId) -> ty::Generics;
177 fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>;
178 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>;
181 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>;
184 fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity;
185 fn impl_parent(&self, impl_def_id: DefId) -> Option<DefId>;
187 // trait/impl-item info
188 fn trait_of_item(&self, def_id: DefId) -> Option<DefId>;
189 fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem;
192 fn is_const_fn(&self, did: DefId) -> bool;
193 fn is_default_impl(&self, impl_did: DefId) -> bool;
194 fn is_foreign_item(&self, did: DefId) -> bool;
195 fn is_dllimport_foreign_item(&self, def: DefId) -> bool;
196 fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool;
197 fn is_exported_symbol(&self, def_id: DefId) -> bool;
200 fn dylib_dependency_formats(&self, cnum: CrateNum)
201 -> Vec<(CrateNum, LinkagePreference)>;
202 fn dep_kind(&self, cnum: CrateNum) -> DepKind;
203 fn export_macros(&self, cnum: CrateNum);
204 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>;
205 fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>;
206 fn is_staged_api(&self, cnum: CrateNum) -> bool;
207 fn is_allocator(&self, cnum: CrateNum) -> bool;
208 fn is_panic_runtime(&self, cnum: CrateNum) -> bool;
209 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool;
210 fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool;
211 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy;
212 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>;
213 /// The name of the crate as it is referred to in source code of the current
215 fn crate_name(&self, cnum: CrateNum) -> Symbol;
216 /// The name of the crate as it is stored in the crate's metadata.
217 fn original_crate_name(&self, cnum: CrateNum) -> Symbol;
218 fn crate_hash(&self, cnum: CrateNum) -> Svh;
219 fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol;
220 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
221 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
222 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>;
223 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>;
224 fn is_no_builtins(&self, cnum: CrateNum) -> bool;
227 fn retrace_path(&self,
229 path_data: &[DisambiguatedDefPathData])
231 fn def_key(&self, def: DefId) -> DefKey;
232 fn def_path(&self, def: DefId) -> hir_map::DefPath;
233 fn def_path_hash(&self, def: DefId) -> u64;
234 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
235 fn item_children(&self, did: DefId) -> Vec<def::Export>;
236 fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro;
239 fn maybe_get_item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
240 -> Option<&'tcx hir::Body>;
241 fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body>;
242 fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool;
244 fn is_item_mir_available(&self, def: DefId) -> bool;
246 // This is basically a 1-based range of ints, which is a little
247 // silly - I may fix that.
248 fn crates(&self) -> Vec<CrateNum>;
249 fn used_libraries(&self) -> Vec<NativeLibrary>;
250 fn used_link_args(&self) -> Vec<String>;
253 fn metadata_filename(&self) -> &str;
254 fn metadata_section_name(&self, target: &Target) -> &str;
255 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>;
256 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource;
257 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>;
258 fn encode_metadata<'a, 'tcx>(&self,
259 tcx: TyCtxt<'a, 'tcx, 'tcx>,
260 link_meta: &LinkMeta,
261 reachable: &NodeSet) -> Vec<u8>;
262 fn metadata_encoding_version(&self) -> &[u8];
265 // FIXME: find a better place for this?
266 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
267 let mut err_count = 0;
269 let mut say = |s: &str| {
271 (_, None) => bug!("{}", s),
272 (Some(sp), Some(sess)) => sess.span_err(sp, s),
273 (None, Some(sess)) => sess.err(s),
278 say("crate name must not be empty");
281 if c.is_alphanumeric() { continue }
282 if c == '_' { continue }
283 say(&format!("invalid character `{}` in crate name: `{}`", c, s));
288 sess.unwrap().abort_if_errors();
292 /// A dummy crate store that does not support any non-local crates,
293 /// for test purposes.
294 pub struct DummyCrateStore;
296 #[allow(unused_variables)]
297 impl CrateStore for DummyCrateStore {
298 fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>
299 { bug!("crate_data_as_rc_any") }
301 fn describe_def(&self, def: DefId) -> Option<Def> { bug!("describe_def") }
302 fn def_span(&self, sess: &Session, def: DefId) -> Span { bug!("def_span") }
303 fn stability(&self, def: DefId) -> Option<attr::Stability> { bug!("stability") }
304 fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> { bug!("deprecation") }
305 fn visibility(&self, def: DefId) -> ty::Visibility { bug!("visibility") }
306 fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
307 bug!("visible_parent_map")
309 fn item_generics_cloned(&self, def: DefId) -> ty::Generics
310 { bug!("item_generics_cloned") }
311 fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute> { bug!("item_attrs") }
312 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name> { bug!("fn_arg_names") }
315 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId> { vec![] }
318 fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity { bug!("impl_polarity") }
319 fn impl_parent(&self, def: DefId) -> Option<DefId> { bug!("impl_parent") }
321 // trait/impl-item info
322 fn trait_of_item(&self, def_id: DefId) -> Option<DefId> { bug!("trait_of_item") }
323 fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
324 { bug!("associated_item_cloned") }
327 fn is_const_fn(&self, did: DefId) -> bool { bug!("is_const_fn") }
328 fn is_default_impl(&self, impl_did: DefId) -> bool { bug!("is_default_impl") }
329 fn is_foreign_item(&self, did: DefId) -> bool { bug!("is_foreign_item") }
330 fn is_dllimport_foreign_item(&self, id: DefId) -> bool { false }
331 fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool { false }
332 fn is_exported_symbol(&self, def_id: DefId) -> bool { false }
335 fn dylib_dependency_formats(&self, cnum: CrateNum)
336 -> Vec<(CrateNum, LinkagePreference)>
337 { bug!("dylib_dependency_formats") }
338 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
339 { bug!("lang_items") }
340 fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>
341 { bug!("missing_lang_items") }
342 fn is_staged_api(&self, cnum: CrateNum) -> bool { bug!("is_staged_api") }
343 fn dep_kind(&self, cnum: CrateNum) -> DepKind { bug!("is_explicitly_linked") }
344 fn export_macros(&self, cnum: CrateNum) { bug!("export_macros") }
345 fn is_allocator(&self, cnum: CrateNum) -> bool { bug!("is_allocator") }
346 fn is_panic_runtime(&self, cnum: CrateNum) -> bool { bug!("is_panic_runtime") }
347 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool { bug!("is_compiler_builtins") }
348 fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool { bug!("is_sanitizer_runtime") }
349 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
350 bug!("panic_strategy")
352 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate> { bug!("extern_crate") }
353 fn crate_name(&self, cnum: CrateNum) -> Symbol { bug!("crate_name") }
354 fn original_crate_name(&self, cnum: CrateNum) -> Symbol {
355 bug!("original_crate_name")
357 fn crate_hash(&self, cnum: CrateNum) -> Svh { bug!("crate_hash") }
358 fn crate_disambiguator(&self, cnum: CrateNum)
359 -> Symbol { bug!("crate_disambiguator") }
360 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
361 { bug!("plugin_registrar_fn") }
362 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
363 { bug!("derive_registrar_fn") }
364 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
365 { bug!("native_libraries") }
366 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId> { bug!("exported_symbols") }
367 fn is_no_builtins(&self, cnum: CrateNum) -> bool { bug!("is_no_builtins") }
370 fn retrace_path(&self,
372 path_data: &[DisambiguatedDefPathData])
377 fn def_key(&self, def: DefId) -> DefKey { bug!("def_key") }
378 fn def_path(&self, def: DefId) -> hir_map::DefPath {
379 bug!("relative_def_path")
381 fn def_path_hash(&self, def: DefId) -> u64 {
384 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { bug!("struct_field_names") }
385 fn item_children(&self, did: DefId) -> Vec<def::Export> { bug!("item_children") }
386 fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro { bug!("load_macro") }
389 fn maybe_get_item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
390 -> Option<&'tcx hir::Body> {
391 bug!("maybe_get_item_body")
393 fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body> {
394 bug!("item_body_nested_bodies")
396 fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool {
397 bug!("const_is_rvalue_promotable_to_static")
400 fn is_item_mir_available(&self, def: DefId) -> bool {
401 bug!("is_item_mir_available")
404 // This is basically a 1-based range of ints, which is a little
405 // silly - I may fix that.
406 fn crates(&self) -> Vec<CrateNum> { vec![] }
407 fn used_libraries(&self) -> Vec<NativeLibrary> { vec![] }
408 fn used_link_args(&self) -> Vec<String> { vec![] }
411 fn metadata_filename(&self) -> &str { bug!("metadata_filename") }
412 fn metadata_section_name(&self, target: &Target) -> &str { bug!("metadata_section_name") }
413 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
415 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource { bug!("used_crate_source") }
416 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum> { None }
417 fn encode_metadata<'a, 'tcx>(&self,
418 tcx: TyCtxt<'a, 'tcx, 'tcx>,
419 link_meta: &LinkMeta,
420 reachable: &NodeSet) -> Vec<u8> { vec![] }
421 fn metadata_encoding_version(&self) -> &[u8] { bug!("metadata_encoding_version") }
424 pub trait CrateLoader {
425 fn process_item(&mut self, item: &ast::Item, defs: &Definitions);
426 fn postprocess(&mut self, krate: &ast::Crate);