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 hir::def_id::{CrateNum, DefId, DefIndex};
27 use hir::map as hir_map;
28 use hir::map::definitions::{Definitions, DefKey, DisambiguatedDefPathData};
31 use middle::lang_items;
32 use ty::{self, TyCtxt};
34 use session::search_paths::PathKind;
35 use util::nodemap::{NodeSet, DefIdMap};
38 use std::path::PathBuf;
41 use syntax::ext::base::SyntaxExtension;
42 use syntax::symbol::Symbol;
44 use rustc_back::target::Target;
46 use rustc_back::PanicStrategy;
48 pub use self::NativeLibraryKind::*;
50 // lonely orphan structs and enums looking for a better home
52 #[derive(Clone, Debug)]
57 // Where a crate came from on the local filesystem. One of these three options
59 #[derive(PartialEq, Clone, Debug)]
60 pub struct CrateSource {
61 pub dylib: Option<(PathBuf, PathKind)>,
62 pub rlib: Option<(PathBuf, PathKind)>,
63 pub rmeta: Option<(PathBuf, PathKind)>,
66 #[derive(RustcEncodable, RustcDecodable, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Debug)]
68 /// A dependency that is only used for its macros, none of which are visible from other crates.
69 /// These are included in the metadata only as placeholders and are ignored when decoding.
71 /// A dependency that is only used for its macros.
73 /// A dependency that is always injected into the dependency list and so
74 /// doesn't need to be linked to an rlib, e.g. the injected allocator.
76 /// A dependency that is required by an rlib version of this crate.
77 /// Ordinary `extern crate`s result in `Explicit` dependencies.
82 pub fn macros_only(self) -> bool {
84 DepKind::UnexportedMacrosOnly | DepKind::MacrosOnly => true,
85 DepKind::Implicit | DepKind::Explicit => false,
90 #[derive(PartialEq, Clone, Debug)]
98 pub fn is_some(&self) -> bool {
99 if let LibSource::Some(_) = *self {
106 pub fn option(&self) -> Option<PathBuf> {
108 LibSource::Some(ref p) => Some(p.clone()),
109 LibSource::MetadataOnly | LibSource::None => None,
114 #[derive(Copy, Debug, PartialEq, Clone, RustcEncodable, RustcDecodable)]
115 pub enum LinkagePreference {
120 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
121 pub enum NativeLibraryKind {
122 NativeStatic, // native static library (.a archive)
123 NativeStaticNobundle, // native static library, which doesn't get bundled into .rlibs
124 NativeFramework, // macOS-specific
125 NativeUnknown, // default way to specify a dynamic library
128 #[derive(Clone, Hash, RustcEncodable, RustcDecodable)]
129 pub struct NativeLibrary {
130 pub kind: NativeLibraryKind,
132 pub cfg: Option<ast::MetaItem>,
133 pub foreign_items: Vec<DefIndex>,
136 pub enum LoadedMacro {
138 ProcMacro(Rc<SyntaxExtension>),
141 #[derive(Copy, Clone, Debug)]
142 pub struct ExternCrate {
143 /// def_id of an `extern crate` in the current crate that caused
144 /// this crate to be loaded; note that there could be multiple
148 /// span of the extern crate that caused this to be loaded
151 /// If true, then this crate is the crate named by the extern
152 /// crate referenced above. If false, then this crate is a dep
156 /// Number of links to reach the extern crate `def_id`
157 /// declaration; used to select the extern crate with the shortest
162 pub struct EncodedMetadata {
163 pub raw_data: Vec<u8>,
164 pub hashes: Vec<EncodedMetadataHash>,
167 /// The hash for some metadata that (when saving) will be exported
168 /// from this crate, or which (when importing) was exported by an
170 #[derive(Debug, RustcEncodable, RustcDecodable, Copy, Clone)]
171 pub struct EncodedMetadataHash {
172 pub def_index: DefIndex,
173 pub hash: ich::Fingerprint,
176 /// A store of Rust crates, through with their metadata
178 pub trait CrateStore {
179 fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>;
182 fn visibility(&self, def: DefId) -> ty::Visibility;
183 fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>>;
184 fn item_generics_cloned(&self, def: DefId) -> ty::Generics;
185 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>;
188 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>;
191 fn impl_defaultness(&self, def: DefId) -> hir::Defaultness;
192 fn impl_parent(&self, impl_def_id: DefId) -> Option<DefId>;
194 // trait/impl-item info
195 fn trait_of_item(&self, def_id: DefId) -> Option<DefId>;
196 fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem;
199 fn is_const_fn(&self, did: DefId) -> bool;
200 fn is_default_impl(&self, impl_did: DefId) -> bool;
201 fn is_foreign_item(&self, did: DefId) -> bool;
202 fn is_dllimport_foreign_item(&self, def: DefId) -> bool;
203 fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool;
204 fn is_exported_symbol(&self, def_id: DefId) -> bool;
207 fn dylib_dependency_formats(&self, cnum: CrateNum)
208 -> Vec<(CrateNum, LinkagePreference)>;
209 fn dep_kind(&self, cnum: CrateNum) -> DepKind;
210 fn export_macros(&self, cnum: CrateNum);
211 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>;
212 fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>;
213 fn is_staged_api(&self, cnum: CrateNum) -> bool;
214 fn is_allocator(&self, cnum: CrateNum) -> bool;
215 fn is_panic_runtime(&self, cnum: CrateNum) -> bool;
216 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool;
217 fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool;
218 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy;
219 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>;
220 /// The name of the crate as it is referred to in source code of the current
222 fn crate_name(&self, cnum: CrateNum) -> Symbol;
223 /// The name of the crate as it is stored in the crate's metadata.
224 fn original_crate_name(&self, cnum: CrateNum) -> Symbol;
225 fn crate_hash(&self, cnum: CrateNum) -> Svh;
226 fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol;
227 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
228 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
229 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>;
230 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>;
231 fn is_no_builtins(&self, cnum: CrateNum) -> bool;
234 fn retrace_path(&self,
236 path_data: &[DisambiguatedDefPathData])
238 fn def_key(&self, def: DefId) -> DefKey;
239 fn def_path(&self, def: DefId) -> hir_map::DefPath;
240 fn def_path_hash(&self, def: DefId) -> u64;
241 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
242 fn item_children(&self, did: DefId) -> Vec<def::Export>;
243 fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro;
246 fn item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
249 // This is basically a 1-based range of ints, which is a little
250 // silly - I may fix that.
251 fn crates(&self) -> Vec<CrateNum>;
252 fn used_libraries(&self) -> Vec<NativeLibrary>;
253 fn used_link_args(&self) -> Vec<String>;
256 fn metadata_filename(&self) -> &str;
257 fn metadata_section_name(&self, target: &Target) -> &str;
258 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>;
259 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource;
260 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>;
261 fn encode_metadata<'a, 'tcx>(&self,
262 tcx: TyCtxt<'a, 'tcx, 'tcx>,
263 link_meta: &LinkMeta,
266 fn metadata_encoding_version(&self) -> &[u8];
269 // FIXME: find a better place for this?
270 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
271 let mut err_count = 0;
273 let mut say = |s: &str| {
275 (_, None) => bug!("{}", s),
276 (Some(sp), Some(sess)) => sess.span_err(sp, s),
277 (None, Some(sess)) => sess.err(s),
282 say("crate name must not be empty");
285 if c.is_alphanumeric() { continue }
286 if c == '_' { continue }
287 say(&format!("invalid character `{}` in crate name: `{}`", c, s));
292 sess.unwrap().abort_if_errors();
296 /// A dummy crate store that does not support any non-local crates,
297 /// for test purposes.
298 pub struct DummyCrateStore;
300 #[allow(unused_variables)]
301 impl CrateStore for DummyCrateStore {
302 fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>
303 { bug!("crate_data_as_rc_any") }
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 fn_arg_names(&self, did: DefId) -> Vec<ast::Name> { bug!("fn_arg_names") }
314 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId> { vec![] }
317 fn impl_defaultness(&self, def: DefId) -> hir::Defaultness { bug!("impl_defaultness") }
318 fn impl_parent(&self, def: DefId) -> Option<DefId> { bug!("impl_parent") }
320 // trait/impl-item info
321 fn trait_of_item(&self, def_id: DefId) -> Option<DefId> { bug!("trait_of_item") }
322 fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
323 { bug!("associated_item_cloned") }
326 fn is_const_fn(&self, did: DefId) -> bool { bug!("is_const_fn") }
327 fn is_default_impl(&self, impl_did: DefId) -> bool { bug!("is_default_impl") }
328 fn is_foreign_item(&self, did: DefId) -> bool { bug!("is_foreign_item") }
329 fn is_dllimport_foreign_item(&self, id: DefId) -> bool { false }
330 fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool { false }
331 fn is_exported_symbol(&self, def_id: DefId) -> bool { false }
334 fn dylib_dependency_formats(&self, cnum: CrateNum)
335 -> Vec<(CrateNum, LinkagePreference)>
336 { bug!("dylib_dependency_formats") }
337 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
338 { bug!("lang_items") }
339 fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>
340 { bug!("missing_lang_items") }
341 fn is_staged_api(&self, cnum: CrateNum) -> bool { bug!("is_staged_api") }
342 fn dep_kind(&self, cnum: CrateNum) -> DepKind { bug!("is_explicitly_linked") }
343 fn export_macros(&self, cnum: CrateNum) { bug!("export_macros") }
344 fn is_allocator(&self, cnum: CrateNum) -> bool { bug!("is_allocator") }
345 fn is_panic_runtime(&self, cnum: CrateNum) -> bool { bug!("is_panic_runtime") }
346 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool { bug!("is_compiler_builtins") }
347 fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool { bug!("is_sanitizer_runtime") }
348 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
349 bug!("panic_strategy")
351 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate> { bug!("extern_crate") }
352 fn crate_name(&self, cnum: CrateNum) -> Symbol { bug!("crate_name") }
353 fn original_crate_name(&self, cnum: CrateNum) -> Symbol {
354 bug!("original_crate_name")
356 fn crate_hash(&self, cnum: CrateNum) -> Svh { bug!("crate_hash") }
357 fn crate_disambiguator(&self, cnum: CrateNum)
358 -> Symbol { bug!("crate_disambiguator") }
359 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
360 { bug!("plugin_registrar_fn") }
361 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
362 { bug!("derive_registrar_fn") }
363 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
364 { bug!("native_libraries") }
365 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId> { bug!("exported_symbols") }
366 fn is_no_builtins(&self, cnum: CrateNum) -> bool { bug!("is_no_builtins") }
369 fn retrace_path(&self,
371 path_data: &[DisambiguatedDefPathData])
376 fn def_key(&self, def: DefId) -> DefKey { bug!("def_key") }
377 fn def_path(&self, def: DefId) -> hir_map::DefPath {
378 bug!("relative_def_path")
380 fn def_path_hash(&self, def: DefId) -> u64 {
383 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { bug!("struct_field_names") }
384 fn item_children(&self, did: DefId) -> Vec<def::Export> { bug!("item_children") }
385 fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro { bug!("load_macro") }
388 fn item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
393 // This is basically a 1-based range of ints, which is a little
394 // silly - I may fix that.
395 fn crates(&self) -> Vec<CrateNum> { vec![] }
396 fn used_libraries(&self) -> Vec<NativeLibrary> { vec![] }
397 fn used_link_args(&self) -> Vec<String> { vec![] }
400 fn metadata_filename(&self) -> &str { bug!("metadata_filename") }
401 fn metadata_section_name(&self, target: &Target) -> &str { bug!("metadata_section_name") }
402 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
404 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource { bug!("used_crate_source") }
405 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum> { None }
406 fn encode_metadata<'a, 'tcx>(&self,
407 tcx: TyCtxt<'a, 'tcx, 'tcx>,
408 link_meta: &LinkMeta,
411 bug!("encode_metadata")
413 fn metadata_encoding_version(&self) -> &[u8] { bug!("metadata_encoding_version") }
416 pub trait CrateLoader {
417 fn process_item(&mut self, item: &ast::Item, defs: &Definitions);
418 fn postprocess(&mut self, krate: &ast::Crate);