crates/ra_hir_def/src/lang_item.rs

   1 //! Collects lang items: items marked with `#[lang = "..."]` attribute.
   2 //!
   3 //! This attribute to tell the compiler about semi built-in std library
   4 //! features, such as Fn family of traits.
   5 use std::sync::Arc;
   6
   7 use ra_syntax::SmolStr;
   8 use rustc_hash::FxHashMap;
   9
  10 use crate::{
  11     db::DefDatabase, AdtId, AttrDefId, CrateId, EnumId, FunctionId, ImplId, ModuleDefId, ModuleId,
  12     StaticId, StructId, TraitId,
  13 };
  14
  15 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
  16 pub enum LangItemTarget {
  17     EnumId(EnumId),
  18     FunctionId(FunctionId),
  19     ImplBlockId(ImplId),
  20     StaticId(StaticId),
  21     StructId(StructId),
  22     TraitId(TraitId),
  23 }
  24
  25 impl LangItemTarget {
  26     pub fn as_enum(self) -> Option<EnumId> {
  27         match self {
  28             LangItemTarget::EnumId(id) => Some(id),
  29             _ => None,
  30         }
  31     }
  32
  33     pub fn as_function(self) -> Option<FunctionId> {
  34         match self {
  35             LangItemTarget::FunctionId(id) => Some(id),
  36             _ => None,
  37         }
  38     }
  39
  40     pub fn as_impl_block(self) -> Option<ImplId> {
  41         match self {
  42             LangItemTarget::ImplBlockId(id) => Some(id),
  43             _ => None,
  44         }
  45     }
  46
  47     pub fn as_static(self) -> Option<StaticId> {
  48         match self {
  49             LangItemTarget::StaticId(id) => Some(id),
  50             _ => None,
  51         }
  52     }
  53
  54     pub fn as_struct(self) -> Option<StructId> {
  55         match self {
  56             LangItemTarget::StructId(id) => Some(id),
  57             _ => None,
  58         }
  59     }
  60
  61     pub fn as_trait(self) -> Option<TraitId> {
  62         match self {
  63             LangItemTarget::TraitId(id) => Some(id),
  64             _ => None,
  65         }
  66     }
  67 }
  68
  69 #[derive(Default, Debug, Clone, PartialEq, Eq)]
  70 pub struct LangItems {
  71     items: FxHashMap<SmolStr, LangItemTarget>,
  72 }
  73
  74 impl LangItems {
  75     pub fn target<'a>(&'a self, item: &str) -> Option<&'a LangItemTarget> {
  76         self.items.get(item)
  77     }
  78
  79     /// Salsa query. This will look for lang items in a specific crate.
  80     pub(crate) fn crate_lang_items_query(db: &impl DefDatabase, krate: CrateId) -> Arc<LangItems> {
  81         let mut lang_items = LangItems::default();
  82
  83         let crate_def_map = db.crate_def_map(krate);
  84
  85         crate_def_map
  86             .modules
  87             .iter()
  88             .filter_map(|(local_id, _)| db.module_lang_items(ModuleId { krate, local_id }))
  89             .for_each(|it| lang_items.items.extend(it.items.iter().map(|(k, v)| (k.clone(), *v))));
  90
  91         Arc::new(lang_items)
  92     }
  93
  94     pub(crate) fn module_lang_items_query(
  95         db: &impl DefDatabase,
  96         module: ModuleId,
  97     ) -> Option<Arc<LangItems>> {
  98         let mut lang_items = LangItems::default();
  99         lang_items.collect_lang_items(db, module);
 100         if lang_items.items.is_empty() {
 101             None
 102         } else {
 103             Some(Arc::new(lang_items))
 104         }
 105     }
 106
 107     /// Salsa query. Look for a lang item, starting from the specified crate and recursively
 108     /// traversing its dependencies.
 109     pub(crate) fn lang_item_query(
 110         db: &impl DefDatabase,
 111         start_crate: CrateId,
 112         item: SmolStr,
 113     ) -> Option<LangItemTarget> {
 114         let lang_items = db.crate_lang_items(start_crate);
 115         let start_crate_target = lang_items.items.get(&item);
 116         if let Some(target) = start_crate_target {
 117             return Some(*target);
 118         }
 119         db.crate_graph()
 120             .dependencies(start_crate)
 121             .find_map(|dep| db.lang_item(dep.crate_id, item.clone()))
 122     }
 123
 124     fn collect_lang_items(&mut self, db: &impl DefDatabase, module: ModuleId) {
 125         // Look for impl targets
 126         let def_map = db.crate_def_map(module.krate);
 127         let module_data = &def_map[module.local_id];
 128         for impl_block in module_data.scope.impls() {
 129             self.collect_lang_item(db, impl_block, LangItemTarget::ImplBlockId)
 130         }
 131
 132         for def in module_data.scope.declarations() {
 133             match def {
 134                 ModuleDefId::TraitId(trait_) => {
 135                     self.collect_lang_item(db, trait_, LangItemTarget::TraitId)
 136                 }
 137                 ModuleDefId::AdtId(AdtId::EnumId(e)) => {
 138                     self.collect_lang_item(db, e, LangItemTarget::EnumId)
 139                 }
 140                 ModuleDefId::AdtId(AdtId::StructId(s)) => {
 141                     self.collect_lang_item(db, s, LangItemTarget::StructId)
 142                 }
 143                 ModuleDefId::FunctionId(f) => {
 144                     self.collect_lang_item(db, f, LangItemTarget::FunctionId)
 145                 }
 146                 ModuleDefId::StaticId(s) => self.collect_lang_item(db, s, LangItemTarget::StaticId),
 147                 _ => {}
 148             }
 149         }
 150     }
 151
 152     fn collect_lang_item<T>(
 153         &mut self,
 154         db: &impl DefDatabase,
 155         item: T,
 156         constructor: fn(T) -> LangItemTarget,
 157     ) where
 158         T: Into<AttrDefId> + Copy,
 159     {
 160         let attrs = db.attrs(item.into());
 161         if let Some(lang_item_name) = attrs.by_key("lang").string_value() {
 162             self.items.entry(lang_item_name.clone()).or_insert_with(|| constructor(item));
 163         }
 164     }
 165 }