crates/ra_hir_def/src/data.rs

   1 //! Contains basic data about various HIR declarations.
   2
   3 use std::sync::Arc;
   4
   5 use hir_expand::{name::Name, InFile};
   6 use ra_prof::profile;
   7 use ra_syntax::ast;
   8
   9 use crate::{
  10     attr::Attrs,
  11     body::Expander,
  12     db::DefDatabase,
  13     item_tree::{AssocItem, ItemTreeId, ModItem},
  14     type_ref::{TypeBound, TypeRef},
  15     visibility::RawVisibility,
  16     AssocContainerId, AssocItemId, ConstId, ConstLoc, FunctionId, FunctionLoc, HasModule, ImplId,
  17     Intern, Lookup, ModuleId, StaticId, TraitId, TypeAliasId, TypeAliasLoc,
  18 };
  19
  20 #[derive(Debug, Clone, PartialEq, Eq)]
  21 pub struct FunctionData {
  22     pub name: Name,
  23     pub params: Vec<TypeRef>,
  24     pub ret_type: TypeRef,
  25     pub attrs: Attrs,
  26     /// True if the first param is `self`. This is relevant to decide whether this
  27     /// can be called as a method.
  28     pub has_self_param: bool,
  29     pub is_unsafe: bool,
  30     pub visibility: RawVisibility,
  31 }
  32
  33 impl FunctionData {
  34     pub(crate) fn fn_data_query(db: &impl DefDatabase, func: FunctionId) -> Arc<FunctionData> {
  35         let loc = func.lookup(db);
  36         let item_tree = db.item_tree(loc.id.file_id);
  37         let func = &item_tree[loc.id.value];
  38
  39         Arc::new(FunctionData {
  40             name: func.name.clone(),
  41             params: func.params.clone(),
  42             ret_type: func.ret_type.clone(),
  43             attrs: func.attrs.clone(),
  44             has_self_param: func.has_self_param,
  45             is_unsafe: func.is_unsafe,
  46             visibility: func.visibility.clone(),
  47         })
  48     }
  49 }
  50
  51 #[derive(Debug, Clone, PartialEq, Eq)]
  52 pub struct TypeAliasData {
  53     pub name: Name,
  54     pub type_ref: Option<TypeRef>,
  55     pub visibility: RawVisibility,
  56     /// Bounds restricting the type alias itself (eg. `type Ty: Bound;` in a trait or impl).
  57     pub bounds: Vec<TypeBound>,
  58 }
  59
  60 impl TypeAliasData {
  61     pub(crate) fn type_alias_data_query(
  62         db: &dyn DefDatabase,
  63         typ: TypeAliasId,
  64     ) -> Arc<TypeAliasData> {
  65         let loc = typ.lookup(db);
  66         let item_tree = db.item_tree(loc.id.file_id);
  67         let typ = &item_tree[loc.id.value];
  68
  69         Arc::new(TypeAliasData {
  70             name: typ.name.clone(),
  71             type_ref: typ.type_ref.clone(),
  72             visibility: typ.visibility.clone(),
  73             bounds: typ.bounds.clone(),
  74         })
  75     }
  76 }
  77
  78 #[derive(Debug, Clone, PartialEq, Eq)]
  79 pub struct TraitData {
  80     pub name: Name,
  81     pub items: Vec<(Name, AssocItemId)>,
  82     pub auto: bool,
  83 }
  84
  85 impl TraitData {
  86     pub(crate) fn trait_data_query(db: &dyn DefDatabase, tr: TraitId) -> Arc<TraitData> {
  87         let tr_loc = tr.lookup(db);
  88         let item_tree = db.item_tree(tr_loc.id.file_id);
  89         let tr_def = &item_tree[tr_loc.id.value];
  90         let name = tr_def.name.clone();
  91         let auto = tr_def.auto;
  92         let module_id = tr_loc.container.module(db);
  93         let container = AssocContainerId::TraitId(tr);
  94         let mut expander = Expander::new(db, tr_loc.id.file_id, module_id);
  95
  96         let items = collect_items(
  97             db,
  98             module_id,
  99             &mut expander,
 100             tr_def.items.iter().copied(),
 101             tr_loc.id.file_id,
 102             container,
 103             100,
 104         );
 105
 106         Arc::new(TraitData { name, items, auto })
 107     }
 108
 109     pub fn associated_types(&self) -> impl Iterator<Item = TypeAliasId> + '_ {
 110         self.items.iter().filter_map(|(_name, item)| match item {
 111             AssocItemId::TypeAliasId(t) => Some(*t),
 112             _ => None,
 113         })
 114     }
 115
 116     pub fn associated_type_by_name(&self, name: &Name) -> Option<TypeAliasId> {
 117         self.items.iter().find_map(|(item_name, item)| match item {
 118             AssocItemId::TypeAliasId(t) if item_name == name => Some(*t),
 119             _ => None,
 120         })
 121     }
 122 }
 123
 124 #[derive(Debug, Clone, PartialEq, Eq)]
 125 pub struct ImplData {
 126     pub target_trait: Option<TypeRef>,
 127     pub target_type: TypeRef,
 128     pub items: Vec<AssocItemId>,
 129     pub is_negative: bool,
 130 }
 131
 132 impl ImplData {
 133     pub(crate) fn impl_data_query(db: &dyn DefDatabase, id: ImplId) -> Arc<ImplData> {
 134         let _p = profile("impl_data_query");
 135         let impl_loc = id.lookup(db);
 136
 137         let item_tree = db.item_tree(impl_loc.id.file_id);
 138         let impl_def = &item_tree[impl_loc.id.value];
 139         let target_trait = impl_def.target_trait.clone();
 140         let target_type = impl_def.target_type.clone();
 141         let is_negative = impl_def.is_negative;
 142         let module_id = impl_loc.container.module(db);
 143         let container = AssocContainerId::ImplId(id);
 144         let mut expander = Expander::new(db, impl_loc.id.file_id, module_id);
 145
 146         let items = collect_items(
 147             db,
 148             module_id,
 149             &mut expander,
 150             impl_def.items.iter().copied(),
 151             impl_loc.id.file_id,
 152             container,
 153             100,
 154         );
 155         let items = items.into_iter().map(|(_, item)| item).collect();
 156
 157         Arc::new(ImplData { target_trait, target_type, items, is_negative })
 158     }
 159 }
 160
 161 #[derive(Debug, Clone, PartialEq, Eq)]
 162 pub struct ConstData {
 163     /// const _: () = ();
 164     pub name: Option<Name>,
 165     pub type_ref: TypeRef,
 166     pub visibility: RawVisibility,
 167 }
 168
 169 impl ConstData {
 170     pub(crate) fn const_data_query(db: &dyn DefDatabase, konst: ConstId) -> Arc<ConstData> {
 171         let loc = konst.lookup(db);
 172         let item_tree = db.item_tree(loc.id.file_id);
 173         let konst = &item_tree[loc.id.value];
 174
 175         Arc::new(ConstData {
 176             name: konst.name.clone(),
 177             type_ref: konst.type_ref.clone(),
 178             visibility: konst.visibility.clone(),
 179         })
 180     }
 181 }
 182
 183 #[derive(Debug, Clone, PartialEq, Eq)]
 184 pub struct StaticData {
 185     pub name: Option<Name>,
 186     pub type_ref: TypeRef,
 187     pub visibility: RawVisibility,
 188     pub mutable: bool,
 189 }
 190
 191 impl StaticData {
 192     pub(crate) fn static_data_query(db: &dyn DefDatabase, konst: StaticId) -> Arc<StaticData> {
 193         let node = konst.lookup(db);
 194         let item_tree = db.item_tree(node.id.file_id);
 195         let statik = &item_tree[node.id.value];
 196
 197         Arc::new(StaticData {
 198             name: Some(statik.name.clone()),
 199             type_ref: statik.type_ref.clone(),
 200             visibility: statik.visibility.clone(),
 201             mutable: statik.mutable,
 202         })
 203     }
 204 }
 205
 206 fn collect_items(
 207     db: &dyn DefDatabase,
 208     module: ModuleId,
 209     expander: &mut Expander,
 210     assoc_items: impl Iterator<Item = AssocItem>,
 211     file_id: crate::HirFileId,
 212     container: AssocContainerId,
 213     limit: usize,
 214 ) -> Vec<(Name, AssocItemId)> {
 215     if limit == 0 {
 216         return Vec::new();
 217     }
 218
 219     let item_tree = db.item_tree(file_id);
 220     let cfg_options = db.crate_graph()[module.krate].cfg_options.clone();
 221
 222     let mut items = Vec::new();
 223     for item in assoc_items {
 224         match item {
 225             AssocItem::Function(id) => {
 226                 let item = &item_tree[id];
 227                 if !item.attrs.is_cfg_enabled(&cfg_options) {
 228                     continue;
 229                 }
 230                 let def = FunctionLoc { container, id: ItemTreeId::new(file_id, id) }.intern(db);
 231                 items.push((item.name.clone(), def.into()));
 232             }
 233             // FIXME: cfg?
 234             AssocItem::Const(id) => {
 235                 let item = &item_tree[id];
 236                 let name = if let Some(name) = item.name.clone() {
 237                     name
 238                 } else {
 239                     continue;
 240                 };
 241                 let def = ConstLoc { container, id: ItemTreeId::new(file_id, id) }.intern(db);
 242                 items.push((name, def.into()));
 243             }
 244             AssocItem::TypeAlias(id) => {
 245                 let item = &item_tree[id];
 246                 let def = TypeAliasLoc { container, id: ItemTreeId::new(file_id, id) }.intern(db);
 247                 items.push((item.name.clone(), def.into()));
 248             }
 249             AssocItem::MacroCall(call) => {
 250                 let call = &item_tree[call];
 251                 let ast_id_map = db.ast_id_map(file_id);
 252                 let root = db.parse_or_expand(file_id).unwrap();
 253                 let call = ast_id_map.get(call.ast_id).to_node(&root);
 254
 255                 if let Some((mark, mac)) = expander.enter_expand(db, None, call) {
 256                     let src: InFile<ast::MacroItems> = expander.to_source(mac);
 257                     let item_tree = db.item_tree(src.file_id);
 258                     let iter =
 259                         item_tree.top_level_items().iter().filter_map(ModItem::as_assoc_item);
 260                     items.extend(collect_items(
 261                         db,
 262                         module,
 263                         expander,
 264                         iter,
 265                         src.file_id,
 266                         container,
 267                         limit - 1,
 268                     ));
 269
 270                     expander.exit(db, mark);
 271                 }
 272             }
 273         }
 274     }
 275
 276     items
 277 }