1 // Copyright 2012 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 // Detecting language items.
13 // Language items are items that represent concepts intrinsic to the language
14 // itself. Examples are:
16 // * Traits that specify "kinds"; e.g. "Sync", "Send".
18 // * Traits that represent operators; e.g. "Add", "Sub", "Index".
20 // * Functions called by the compiler itself.
22 pub use self::LangItem::*;
24 use front::map as hir_map;
26 use metadata::csearch::each_lang_item;
27 use middle::def_id::DefId;
29 use middle::weak_lang_items;
30 use util::nodemap::FnvHashMap;
33 use syntax::attr::AttrMetaMethods;
34 use syntax::codemap::{DUMMY_SP, Span};
35 use syntax::parse::token::InternedString;
36 use rustc_front::intravisit::Visitor;
39 use std::iter::Enumerate;
42 // The actual lang items defined come at the end of this file in one handy table.
43 // So you probably just want to nip down to the end.
44 macro_rules! lets_do_this {
46 $( $variant:ident, $name:expr, $method:ident; )*
51 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
57 pub struct LanguageItems {
58 pub items: Vec<Option<DefId>>,
59 pub missing: Vec<LangItem>,
63 pub fn new() -> LanguageItems {
64 fn foo(_: LangItem) -> Option<DefId> { None }
67 items: vec!($(foo($variant)),*),
72 pub fn items<'a>(&'a self) -> Enumerate<slice::Iter<'a, Option<DefId>>> {
73 self.items.iter().enumerate()
76 pub fn item_name(index: usize) -> &'static str {
77 let item: Option<LangItem> = LangItem::from_u32(index as u32);
79 $( Some($variant) => $name, )*
84 pub fn require(&self, it: LangItem) -> Result<DefId, String> {
85 match self.items[it as usize] {
88 Err(format!("requires `{}` lang_item",
89 LanguageItems::item_name(it as usize)))
94 pub fn require_owned_box(&self) -> Result<DefId, String> {
95 self.require(OwnedBoxLangItem)
98 pub fn from_builtin_kind(&self, bound: ty::BuiltinBound)
99 -> Result<DefId, String>
102 ty::BoundSend => self.require(SendTraitLangItem),
103 ty::BoundSized => self.require(SizedTraitLangItem),
104 ty::BoundCopy => self.require(CopyTraitLangItem),
105 ty::BoundSync => self.require(SyncTraitLangItem),
109 pub fn to_builtin_kind(&self, id: DefId) -> Option<ty::BuiltinBound> {
110 if Some(id) == self.send_trait() {
112 } else if Some(id) == self.sized_trait() {
114 } else if Some(id) == self.copy_trait() {
116 } else if Some(id) == self.sync_trait() {
123 pub fn fn_trait_kind(&self, id: DefId) -> Option<ty::ClosureKind> {
125 (self.fn_trait(), ty::FnClosureKind),
126 (self.fn_mut_trait(), ty::FnMutClosureKind),
127 (self.fn_once_trait(), ty::FnOnceClosureKind),
130 for &(opt_def_id, kind) in &def_id_kinds {
131 if Some(id) == opt_def_id {
141 pub fn $method(&self) -> Option<DefId> {
142 self.items[$variant as usize]
147 struct LanguageItemCollector<'a, 'tcx: 'a> {
148 items: LanguageItems,
150 ast_map: &'a hir_map::Map<'tcx>,
152 session: &'a Session,
154 item_refs: FnvHashMap<&'static str, usize>,
157 impl<'a, 'v, 'tcx> Visitor<'v> for LanguageItemCollector<'a, 'tcx> {
158 fn visit_item(&mut self, item: &hir::Item) {
159 if let Some(value) = extract(&item.attrs) {
160 let item_index = self.item_refs.get(&value[..]).cloned();
162 if let Some(item_index) = item_index {
163 self.collect_item(item_index, self.ast_map.local_def_id(item.id), item.span)
169 impl<'a, 'tcx> LanguageItemCollector<'a, 'tcx> {
170 pub fn new(session: &'a Session, ast_map: &'a hir_map::Map<'tcx>)
171 -> LanguageItemCollector<'a, 'tcx> {
172 let mut item_refs = FnvHashMap();
174 $( item_refs.insert($name, $variant as usize); )*
176 LanguageItemCollector {
179 items: LanguageItems::new(),
180 item_refs: item_refs,
184 pub fn collect_item(&mut self, item_index: usize,
185 item_def_id: DefId, span: Span) {
186 // Check for duplicates.
187 match self.items.items[item_index] {
188 Some(original_def_id) if original_def_id != item_def_id => {
189 span_err!(self.session, span, E0152,
190 "duplicate entry for `{}`", LanguageItems::item_name(item_index));
198 self.items.items[item_index] = Some(item_def_id);
201 pub fn collect_local_language_items(&mut self, krate: &hir::Crate) {
202 krate.visit_all_items(self);
205 pub fn collect_external_language_items(&mut self) {
206 let crate_store = &self.session.cstore;
207 crate_store.iter_crate_data(|crate_number, _crate_metadata| {
208 each_lang_item(crate_store, crate_number, |index, item_index| {
209 let def_id = DefId { krate: crate_number, index: index };
210 self.collect_item(item_index, def_id, DUMMY_SP);
216 pub fn collect(&mut self, krate: &hir::Crate) {
217 self.collect_local_language_items(krate);
218 self.collect_external_language_items();
222 pub fn extract(attrs: &[ast::Attribute]) -> Option<InternedString> {
223 for attribute in attrs {
224 match attribute.value_str() {
225 Some(ref value) if attribute.check_name("lang") => {
226 return Some(value.clone());
235 pub fn collect_language_items(session: &Session,
238 let krate: &hir::Crate = map.krate();
239 let mut collector = LanguageItemCollector::new(session, map);
240 collector.collect(krate);
241 let LanguageItemCollector { mut items, .. } = collector;
242 weak_lang_items::check_crate(krate, session, &mut items);
243 session.abort_if_errors();
252 // Variant name, Name, Method name;
253 CharImplItem, "char", char_impl;
254 StrImplItem, "str", str_impl;
255 SliceImplItem, "slice", slice_impl;
256 ConstPtrImplItem, "const_ptr", const_ptr_impl;
257 MutPtrImplItem, "mut_ptr", mut_ptr_impl;
258 I8ImplItem, "i8", i8_impl;
259 I16ImplItem, "i16", i16_impl;
260 I32ImplItem, "i32", i32_impl;
261 I64ImplItem, "i64", i64_impl;
262 IsizeImplItem, "isize", isize_impl;
263 U8ImplItem, "u8", u8_impl;
264 U16ImplItem, "u16", u16_impl;
265 U32ImplItem, "u32", u32_impl;
266 U64ImplItem, "u64", u64_impl;
267 UsizeImplItem, "usize", usize_impl;
268 F32ImplItem, "f32", f32_impl;
269 F64ImplItem, "f64", f64_impl;
271 SendTraitLangItem, "send", send_trait;
272 SizedTraitLangItem, "sized", sized_trait;
273 UnsizeTraitLangItem, "unsize", unsize_trait;
274 CopyTraitLangItem, "copy", copy_trait;
275 SyncTraitLangItem, "sync", sync_trait;
277 DropTraitLangItem, "drop", drop_trait;
279 CoerceUnsizedTraitLangItem, "coerce_unsized", coerce_unsized_trait;
281 AddTraitLangItem, "add", add_trait;
282 SubTraitLangItem, "sub", sub_trait;
283 MulTraitLangItem, "mul", mul_trait;
284 DivTraitLangItem, "div", div_trait;
285 RemTraitLangItem, "rem", rem_trait;
286 NegTraitLangItem, "neg", neg_trait;
287 NotTraitLangItem, "not", not_trait;
288 BitXorTraitLangItem, "bitxor", bitxor_trait;
289 BitAndTraitLangItem, "bitand", bitand_trait;
290 BitOrTraitLangItem, "bitor", bitor_trait;
291 ShlTraitLangItem, "shl", shl_trait;
292 ShrTraitLangItem, "shr", shr_trait;
293 AddAssignTraitLangItem, "add_assign", add_assign_trait;
294 SubAssignTraitLangItem, "sub_assign", sub_assign_trait;
295 MulAssignTraitLangItem, "mul_assign", mul_assign_trait;
296 DivAssignTraitLangItem, "div_assign", div_assign_trait;
297 RemAssignTraitLangItem, "rem_assign", rem_assign_trait;
298 BitXorAssignTraitLangItem, "bitxor_assign", bitxor_assign_trait;
299 BitAndAssignTraitLangItem, "bitand_assign", bitand_assign_trait;
300 BitOrAssignTraitLangItem, "bitor_assign", bitor_assign_trait;
301 ShlAssignTraitLangItem, "shl_assign", shl_assign_trait;
302 ShrAssignTraitLangItem, "shr_assign", shr_assign_trait;
303 IndexTraitLangItem, "index", index_trait;
304 IndexMutTraitLangItem, "index_mut", index_mut_trait;
305 RangeStructLangItem, "range", range_struct;
306 RangeFromStructLangItem, "range_from", range_from_struct;
307 RangeToStructLangItem, "range_to", range_to_struct;
308 RangeFullStructLangItem, "range_full", range_full_struct;
310 UnsafeCellTypeLangItem, "unsafe_cell", unsafe_cell_type;
312 DerefTraitLangItem, "deref", deref_trait;
313 DerefMutTraitLangItem, "deref_mut", deref_mut_trait;
315 FnTraitLangItem, "fn", fn_trait;
316 FnMutTraitLangItem, "fn_mut", fn_mut_trait;
317 FnOnceTraitLangItem, "fn_once", fn_once_trait;
319 EqTraitLangItem, "eq", eq_trait;
320 OrdTraitLangItem, "ord", ord_trait;
322 StrEqFnLangItem, "str_eq", str_eq_fn;
324 // A number of panic-related lang items. The `panic` item corresponds to
325 // divide-by-zero and various panic cases with `match`. The
326 // `panic_bounds_check` item is for indexing arrays.
328 // The `begin_unwind` lang item has a predefined symbol name and is sort of
329 // a "weak lang item" in the sense that a crate is not required to have it
330 // defined to use it, but a final product is required to define it
331 // somewhere. Additionally, there are restrictions on crates that use a weak
332 // lang item, but do not have it defined.
333 PanicFnLangItem, "panic", panic_fn;
334 PanicBoundsCheckFnLangItem, "panic_bounds_check", panic_bounds_check_fn;
335 PanicFmtLangItem, "panic_fmt", panic_fmt;
337 ExchangeMallocFnLangItem, "exchange_malloc", exchange_malloc_fn;
338 ExchangeFreeFnLangItem, "exchange_free", exchange_free_fn;
339 StrDupUniqFnLangItem, "strdup_uniq", strdup_uniq_fn;
341 StartFnLangItem, "start", start_fn;
343 EhPersonalityLangItem, "eh_personality", eh_personality;
344 EhPersonalityCatchLangItem, "eh_personality_catch", eh_personality_catch;
345 EhUnwindResumeLangItem, "eh_unwind_resume", eh_unwind_resume;
346 MSVCTryFilterLangItem, "msvc_try_filter", msvc_try_filter;
348 OwnedBoxLangItem, "owned_box", owned_box;
350 PhantomDataItem, "phantom_data", phantom_data;
353 CovariantTypeItem, "covariant_type", covariant_type;
354 ContravariantTypeItem, "contravariant_type", contravariant_type;
355 InvariantTypeItem, "invariant_type", invariant_type;
356 CovariantLifetimeItem, "covariant_lifetime", covariant_lifetime;
357 ContravariantLifetimeItem, "contravariant_lifetime", contravariant_lifetime;
358 InvariantLifetimeItem, "invariant_lifetime", invariant_lifetime;
360 NoCopyItem, "no_copy_bound", no_copy_bound;
362 NonZeroItem, "non_zero", non_zero;
364 DebugTraitLangItem, "debug_trait", debug_trait;