//! A simplified AST that only contains items. use hir_expand::{ ast_id_map::{AstIdMap, FileAstId}, hygiene::Hygiene, name::{name, AsName, Name}, HirFileId, InFile, }; use ra_arena::{Arena, Idx, RawId}; use ra_syntax::{ast, match_ast}; use test_utils::mark; use crate::{ attr::Attrs, db::DefDatabase, generics, path::{path, AssociatedTypeBinding, GenericArgs, ImportAlias, ModPath, Path}, type_ref::{Mutability, TypeBound, TypeRef}, visibility::RawVisibility, }; use ast::{AstNode, AttrsOwner, ModuleItemOwner, NameOwner, StructKind, TypeAscriptionOwner}; use either::Either; use rustc_hash::FxHashMap; use smallvec::SmallVec; use std::{ ops::{Index, Range}, sync::Arc, }; /// The item tree of a source file. #[derive(Debug, Default, Eq, PartialEq)] pub struct ItemTree { top_level: Vec, top_attrs: Attrs, attrs: FxHashMap, empty_attrs: Attrs, imports: Arena, functions: Arena, structs: Arena, fields: Arena, unions: Arena, enums: Arena, variants: Arena, consts: Arena, statics: Arena, traits: Arena, impls: Arena, type_aliases: Arena, mods: Arena, macro_calls: Arena, exprs: Arena, } impl ItemTree { pub fn item_tree_query(db: &dyn DefDatabase, file_id: HirFileId) -> Arc { let _p = ra_prof::profile("item_tree_query"); let syntax = if let Some(node) = db.parse_or_expand(file_id) { node } else { return Default::default(); }; let hygiene = Hygiene::new(db.upcast(), file_id); let mut top_attrs = None; let (macro_storage, file_storage); let item_owner = match_ast! { match syntax { ast::MacroItems(items) => { macro_storage = items; ¯o_storage as &dyn ModuleItemOwner }, ast::SourceFile(file) => { top_attrs = Some(Attrs::new(&file, &hygiene)); file_storage = file; &file_storage }, _ => return Default::default(), } }; let map = db.ast_id_map(file_id); let mut ctx = Ctx { tree: ItemTree::default(), hygiene, file: file_id, source_ast_id_map: map, body_ctx: crate::body::LowerCtx::new(db, file_id), }; ctx.tree.top_attrs = top_attrs.unwrap_or_default(); Arc::new(ctx.lower(item_owner)) } /// Returns an iterator over all items located at the top level of the `HirFileId` this /// `ItemTree` was created from. pub fn top_level_items(&self) -> &[ModItem] { &self.top_level } /// Returns the inner attributes of the source file. pub fn top_level_attrs(&self) -> &Attrs { &self.top_attrs } pub fn attrs(&self, of: ModItem) -> &Attrs { self.attrs.get(&of).unwrap_or(&self.empty_attrs) } } macro_rules! impl_index { ( $($fld:ident: $t:ty),+ $(,)? ) => { $( impl Index> for ItemTree { type Output = $t; fn index(&self, index: Idx<$t>) -> &Self::Output { &self.$fld[index] } } )+ }; } impl_index!( imports: Import, functions: Function, structs: Struct, fields: Field, unions: Union, enums: Enum, variants: Variant, consts: Const, statics: Static, traits: Trait, impls: Impl, type_aliases: TypeAlias, mods: Mod, macro_calls: MacroCall, exprs: Expr, ); /// A desugared `extern crate` or `use` import. #[derive(Debug, Clone, Eq, PartialEq)] pub struct Import { pub path: ModPath, pub alias: Option, pub visibility: RawVisibility, pub is_glob: bool, pub is_prelude: bool, pub is_extern_crate: bool, pub is_macro_use: bool, } #[derive(Debug, Eq, PartialEq)] pub struct Function { pub name: Name, pub attrs: Attrs, pub visibility: RawVisibility, pub generic_params: generics::GenericParams, pub has_self_param: bool, pub params: Vec, pub ret_type: TypeRef, pub ast_id: FileAstId, // FIXME inner items } #[derive(Debug, Eq, PartialEq)] pub struct Struct { pub name: Name, pub attrs: Attrs, pub visibility: RawVisibility, pub generic_params: generics::GenericParams, pub fields: Fields, pub ast_id: FileAstId, pub kind: StructDefKind, } #[derive(Debug, Eq, PartialEq)] pub enum StructDefKind { /// `struct S { ... }` - type namespace only. Record, /// `struct S(...);` Tuple, /// `struct S;` Unit, } #[derive(Debug, Eq, PartialEq)] pub struct Union { pub name: Name, pub attrs: Attrs, pub visibility: RawVisibility, pub generic_params: generics::GenericParams, pub fields: Fields, pub ast_id: FileAstId, } #[derive(Debug, Eq, PartialEq)] pub struct Enum { pub name: Name, pub attrs: Attrs, pub visibility: RawVisibility, pub generic_params: generics::GenericParams, pub variants: Range>, pub ast_id: FileAstId, } #[derive(Debug, Eq, PartialEq)] pub struct Const { /// const _: () = (); pub name: Option, pub visibility: RawVisibility, pub type_ref: TypeRef, pub ast_id: FileAstId, } #[derive(Debug, Eq, PartialEq)] pub struct Static { pub name: Name, pub visibility: RawVisibility, pub type_ref: TypeRef, pub ast_id: FileAstId, } #[derive(Debug, Eq, PartialEq)] pub struct Trait { pub name: Name, pub visibility: RawVisibility, pub generic_params: generics::GenericParams, pub auto: bool, pub items: Vec, pub ast_id: FileAstId, } #[derive(Debug, Eq, PartialEq)] pub struct Impl { pub generic_params: generics::GenericParams, pub target_trait: Option, pub target_type: TypeRef, pub is_negative: bool, pub items: Vec, pub ast_id: FileAstId, } #[derive(Debug, Clone, PartialEq, Eq)] pub struct TypeAlias { pub name: Name, pub visibility: RawVisibility, pub generic_params: generics::GenericParams, pub type_ref: Option, pub ast_id: FileAstId, } #[derive(Debug, Eq, PartialEq)] pub struct Mod { pub name: Name, pub visibility: RawVisibility, pub kind: ModKind, pub ast_id: FileAstId, } #[derive(Debug, Eq, PartialEq)] pub enum ModKind { /// `mod m { ... }` Inline { items: Vec }, /// `mod m;` Outline {}, } #[derive(Debug, Eq, PartialEq)] pub struct MacroCall { /// For `macro_rules!` declarations, this is the name of the declared macro. pub name: Option, /// Path to the called macro. pub path: ModPath, /// Has `#[macro_export]`. pub is_export: bool, /// Has `#[macro_export(local_inner_macros)]`. pub is_local_inner: bool, /// Has `#[rustc_builtin_macro]`. pub is_builtin: bool, pub ast_id: FileAstId, } // NB: There's no `FileAstId` for `Expr`. The only case where this would be useful is for array // lengths, but we don't do much with them yet. #[derive(Debug, Eq, PartialEq)] pub struct Expr; macro_rules! impl_froms { ($e:ident { $($v:ident ($t:ty)),* $(,)? }) => { $( impl From<$t> for $e { fn from(it: $t) -> $e { $e::$v(it) } } )* } } #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)] pub enum ModItem { Import(Idx), Function(Idx), Struct(Idx), Union(Idx), Enum(Idx), Const(Idx), Static(Idx), Trait(Idx), Impl(Idx), TypeAlias(Idx), Mod(Idx), MacroCall(Idx), } impl_froms!(ModItem { Import(Idx), Function(Idx), Struct(Idx), Union(Idx), Enum(Idx), Const(Idx), Static(Idx), Trait(Idx), Impl(Idx), TypeAlias(Idx), Mod(Idx), MacroCall(Idx), }); #[derive(Debug, Eq, PartialEq)] pub enum AssocItem { Function(Idx), TypeAlias(Idx), Const(Idx), MacroCall(Idx), } impl_froms!(AssocItem { Function(Idx), TypeAlias(Idx), Const(Idx), MacroCall(Idx), }); #[derive(Debug, Eq, PartialEq)] pub struct Variant { pub name: Name, pub fields: Fields, } #[derive(Debug, Clone, PartialEq, Eq)] pub enum Fields { Record(Range>), Tuple(Range>), Unit, } /// A single field of an enum variant or struct #[derive(Debug, Clone, PartialEq, Eq)] pub struct Field { pub name: Name, pub type_ref: TypeRef, pub visibility: RawVisibility, } struct ModItems(SmallVec<[ModItem; 1]>); impl From for ModItems where T: Into, { fn from(t: T) -> Self { ModItems(SmallVec::from_buf([t.into(); 1])) } } struct Ctx { tree: ItemTree, hygiene: Hygiene, file: HirFileId, source_ast_id_map: Arc, body_ctx: crate::body::LowerCtx, } impl Ctx { fn lower(mut self, item_owner: &dyn ModuleItemOwner) -> ItemTree { self.tree.top_level = item_owner .items() .flat_map(|item| self.lower_mod_item(&item)) .flat_map(|items| items.0) .collect(); self.tree } fn lower_mod_item(&mut self, item: &ast::ModuleItem) -> Option { let attrs = Attrs::new(item, &self.hygiene); let items = match item { ast::ModuleItem::StructDef(ast) => { self.lower_struct(ast).map(|data| self.tree.structs.alloc(data).into()) } ast::ModuleItem::UnionDef(ast) => { self.lower_union(ast).map(|data| self.tree.unions.alloc(data).into()) } ast::ModuleItem::EnumDef(ast) => { self.lower_enum(ast).map(|data| self.tree.enums.alloc(data).into()) } ast::ModuleItem::FnDef(ast) => { self.lower_function(ast).map(|data| self.tree.functions.alloc(data).into()) } ast::ModuleItem::TypeAliasDef(ast) => { self.lower_type_alias(ast).map(|data| self.tree.type_aliases.alloc(data).into()) } ast::ModuleItem::StaticDef(ast) => { self.lower_static(ast).map(|data| self.tree.statics.alloc(data).into()) } ast::ModuleItem::ConstDef(ast) => { let data = self.lower_const(ast); Some(self.tree.consts.alloc(data).into()) } ast::ModuleItem::Module(ast) => { self.lower_module(ast).map(|data| self.tree.mods.alloc(data).into()) } ast::ModuleItem::TraitDef(ast) => { self.lower_trait(ast).map(|data| self.tree.traits.alloc(data).into()) } ast::ModuleItem::ImplDef(ast) => { self.lower_impl(ast).map(|data| self.tree.impls.alloc(data).into()) } ast::ModuleItem::UseItem(ast) => Some(ModItems( self.lower_use(ast) .into_iter() .map(|data| self.tree.imports.alloc(data).into()) .collect::>(), )), ast::ModuleItem::ExternCrateItem(ast) => { self.lower_extern_crate(ast).map(|data| self.tree.imports.alloc(data).into()) } ast::ModuleItem::MacroCall(ast) => { self.lower_macro_call(ast).map(|data| self.tree.macro_calls.alloc(data).into()) } ast::ModuleItem::ExternBlock(ast) => Some(ModItems( self.lower_extern_block(ast) .into_iter() .map(|item| match item { Either::Left(func) => self.tree.functions.alloc(func).into(), Either::Right(statik) => self.tree.statics.alloc(statik).into(), }) .collect::>(), )), }; if !attrs.is_empty() { for item in items.iter().flat_map(|items| &items.0) { self.tree.attrs.insert(*item, attrs.clone()); } } items } fn lower_assoc_item(&mut self, item: &ast::AssocItem) -> Option { match item { ast::AssocItem::FnDef(ast) => { self.lower_function(ast).map(|data| self.tree.functions.alloc(data).into()) } ast::AssocItem::TypeAliasDef(ast) => { self.lower_type_alias(ast).map(|data| self.tree.type_aliases.alloc(data).into()) } ast::AssocItem::ConstDef(ast) => { let data = self.lower_const(ast); Some(self.tree.consts.alloc(data).into()) } } } fn lower_struct(&mut self, strukt: &ast::StructDef) -> Option { let attrs = self.lower_attrs(strukt); let visibility = self.lower_visibility(strukt); let name = strukt.name()?.as_name(); let generic_params = self.lower_generic_params(strukt); let fields = self.lower_fields(&strukt.kind()); let ast_id = self.source_ast_id_map.ast_id(strukt); let kind = match strukt.kind() { ast::StructKind::Record(_) => StructDefKind::Record, ast::StructKind::Tuple(_) => StructDefKind::Tuple, ast::StructKind::Unit => StructDefKind::Unit, }; let res = Struct { name, attrs, visibility, generic_params, fields, ast_id, kind }; Some(res) } fn lower_fields(&mut self, strukt_kind: &ast::StructKind) -> Fields { match strukt_kind { ast::StructKind::Record(it) => { let range = self.lower_record_fields(it); Fields::Record(range) } ast::StructKind::Tuple(it) => { let range = self.lower_tuple_fields(it); Fields::Tuple(range) } ast::StructKind::Unit => Fields::Unit, } } fn lower_record_fields(&mut self, fields: &ast::RecordFieldDefList) -> Range> { let start = self.next_field_idx(); for field in fields.fields() { if let Some(data) = self.lower_record_field(&field) { self.tree.fields.alloc(data); } } let end = self.next_field_idx(); start..end } fn lower_record_field(&self, field: &ast::RecordFieldDef) -> Option { let name = field.name()?.as_name(); let visibility = self.lower_visibility(field); let type_ref = self.lower_type_ref(&field.ascribed_type()?); let res = Field { name, type_ref, visibility }; Some(res) } fn lower_tuple_fields(&mut self, fields: &ast::TupleFieldDefList) -> Range> { let start = self.next_field_idx(); for (i, field) in fields.fields().enumerate() { if let Some(data) = self.lower_tuple_field(i, &field) { self.tree.fields.alloc(data); } } let end = self.next_field_idx(); start..end } fn lower_tuple_field(&self, idx: usize, field: &ast::TupleFieldDef) -> Option { let name = Name::new_tuple_field(idx); let visibility = self.lower_visibility(field); let type_ref = self.lower_type_ref(&field.type_ref()?); let res = Field { name, type_ref, visibility }; Some(res) } fn lower_union(&mut self, union: &ast::UnionDef) -> Option { let attrs = self.lower_attrs(union); let visibility = self.lower_visibility(union); let name = union.name()?.as_name(); let generic_params = self.lower_generic_params(union); let fields = match union.record_field_def_list() { Some(record_field_def_list) => { self.lower_fields(&StructKind::Record(record_field_def_list)) } None => Fields::Record(self.next_field_idx()..self.next_field_idx()), }; let ast_id = self.source_ast_id_map.ast_id(union); let res = Union { name, attrs, visibility, generic_params, fields, ast_id }; Some(res) } fn lower_enum(&mut self, enum_: &ast::EnumDef) -> Option { let attrs = self.lower_attrs(enum_); let visibility = self.lower_visibility(enum_); let name = enum_.name()?.as_name(); let generic_params = self.lower_generic_params(enum_); let variants = match &enum_.variant_list() { Some(variant_list) => self.lower_variants(variant_list), None => self.next_variant_idx()..self.next_variant_idx(), }; let ast_id = self.source_ast_id_map.ast_id(enum_); let res = Enum { name, attrs, visibility, generic_params, variants, ast_id }; Some(res) } fn lower_variants(&mut self, variants: &ast::EnumVariantList) -> Range> { let start = self.next_variant_idx(); for variant in variants.variants() { if let Some(data) = self.lower_variant(&variant) { self.tree.variants.alloc(data); } } let end = self.next_variant_idx(); start..end } fn lower_variant(&mut self, variant: &ast::EnumVariant) -> Option { let name = variant.name()?.as_name(); let fields = self.lower_fields(&variant.kind()); let res = Variant { name, fields }; Some(res) } fn lower_function(&mut self, func: &ast::FnDef) -> Option { let attrs = self.lower_attrs(func); let visibility = self.lower_visibility(func); let name = func.name()?.as_name(); let generic_params = self.lower_generic_params(func); let mut params = Vec::new(); let mut has_self_param = false; if let Some(param_list) = func.param_list() { if let Some(self_param) = param_list.self_param() { let self_type = if let Some(type_ref) = self_param.ascribed_type() { TypeRef::from_ast(&self.body_ctx, type_ref) } else { let self_type = TypeRef::Path(name![Self].into()); match self_param.kind() { ast::SelfParamKind::Owned => self_type, ast::SelfParamKind::Ref => { TypeRef::Reference(Box::new(self_type), Mutability::Shared) } ast::SelfParamKind::MutRef => { TypeRef::Reference(Box::new(self_type), Mutability::Mut) } } }; params.push(self_type); has_self_param = true; } for param in param_list.params() { let type_ref = TypeRef::from_ast_opt(&self.body_ctx, param.ascribed_type()); params.push(type_ref); } } let ret_type = match func.ret_type().and_then(|rt| rt.type_ref()) { Some(type_ref) => TypeRef::from_ast(&self.body_ctx, type_ref), _ => TypeRef::unit(), }; let ret_type = if func.async_token().is_some() { let future_impl = desugar_future_path(ret_type); let ty_bound = TypeBound::Path(future_impl); TypeRef::ImplTrait(vec![ty_bound]) } else { ret_type }; let ast_id = self.source_ast_id_map.ast_id(func); let res = Function { name, attrs, visibility, generic_params, has_self_param, params, ret_type, ast_id, }; Some(res) } fn lower_type_alias(&mut self, type_alias: &ast::TypeAliasDef) -> Option { let name = type_alias.name()?.as_name(); let type_ref = type_alias.type_ref().map(|it| self.lower_type_ref(&it)); let visibility = self.lower_visibility(type_alias); let generic_params = self.lower_generic_params(type_alias); let ast_id = self.source_ast_id_map.ast_id(type_alias); let res = TypeAlias { name, visibility, generic_params, type_ref, ast_id }; Some(res) } fn lower_static(&mut self, static_: &ast::StaticDef) -> Option { let name = static_.name()?.as_name(); let type_ref = self.lower_type_ref_opt(static_.ascribed_type()); let visibility = self.lower_visibility(static_); let ast_id = self.source_ast_id_map.ast_id(static_); let res = Static { name, visibility, type_ref, ast_id }; Some(res) } fn lower_const(&mut self, konst: &ast::ConstDef) -> Const { let name = konst.name().map(|it| it.as_name()); let type_ref = self.lower_type_ref_opt(konst.ascribed_type()); let visibility = self.lower_visibility(konst); let ast_id = self.source_ast_id_map.ast_id(konst); Const { name, visibility, type_ref, ast_id } } fn lower_module(&mut self, module: &ast::Module) -> Option { let name = module.name()?.as_name(); let visibility = self.lower_visibility(module); let kind = if module.semicolon_token().is_some() { ModKind::Outline {} } else { ModKind::Inline { items: module .item_list() .map(|list| { list.items() .flat_map(|item| self.lower_mod_item(&item)) .flat_map(|items| items.0) .collect() }) .unwrap_or_else(|| { mark::hit!(name_res_works_for_broken_modules); Vec::new() }), } }; let ast_id = self.source_ast_id_map.ast_id(module); Some(Mod { name, visibility, kind, ast_id }) } fn lower_trait(&mut self, trait_def: &ast::TraitDef) -> Option { let name = trait_def.name()?.as_name(); let visibility = self.lower_visibility(trait_def); let generic_params = self.lower_generic_params(trait_def); let auto = trait_def.auto_token().is_some(); let items = trait_def.item_list().map(|list| { // FIXME: Does not handle macros list.assoc_items().flat_map(|item| self.lower_assoc_item(&item)).collect() }); let ast_id = self.source_ast_id_map.ast_id(trait_def); Some(Trait { name, visibility, generic_params, auto, items: items.unwrap_or_default(), ast_id, }) } fn lower_impl(&mut self, impl_def: &ast::ImplDef) -> Option { let generic_params = self.lower_generic_params(impl_def); let target_trait = impl_def.target_trait().map(|tr| self.lower_type_ref(&tr)); let target_type = self.lower_type_ref(&impl_def.target_type()?); let is_negative = impl_def.excl_token().is_some(); let items = impl_def .item_list()? .assoc_items() .filter_map(|item| self.lower_assoc_item(&item)) .collect(); let ast_id = self.source_ast_id_map.ast_id(impl_def); Some(Impl { generic_params, target_trait, target_type, is_negative, items, ast_id }) } fn lower_use(&mut self, use_item: &ast::UseItem) -> Vec { // FIXME: cfg_attr let is_prelude = use_item.has_atom_attr("prelude_import"); let visibility = self.lower_visibility(use_item); // Every use item can expand to many `Import`s. let mut imports = Vec::new(); ModPath::expand_use_item( InFile::new(self.file, use_item.clone()), &self.hygiene, |path, _tree, is_glob, alias| { imports.push(Import { path, alias, visibility: visibility.clone(), is_glob, is_prelude, is_extern_crate: false, is_macro_use: false, }); }, ); imports } fn lower_extern_crate(&mut self, extern_crate: &ast::ExternCrateItem) -> Option { let path = ModPath::from_name_ref(&extern_crate.name_ref()?); let alias = extern_crate.alias().map(|a| { a.name().map(|it| it.as_name()).map_or(ImportAlias::Underscore, ImportAlias::Alias) }); let visibility = self.lower_visibility(extern_crate); // FIXME: cfg_attr let is_macro_use = extern_crate.has_atom_attr("macro_use"); Some(Import { path, alias, visibility, is_glob: false, is_prelude: false, is_extern_crate: true, is_macro_use, }) } fn lower_macro_call(&mut self, m: &ast::MacroCall) -> Option { let name = m.name().map(|it| it.as_name()); let attrs = Attrs::new(m, &self.hygiene); let path = ModPath::from_src(m.path()?, &self.hygiene)?; let ast_id = self.source_ast_id_map.ast_id(m); // FIXME: cfg_attr let export_attr = attrs.by_key("macro_export"); let is_export = export_attr.exists(); let is_local_inner = if is_export { export_attr.tt_values().map(|it| &it.token_trees).flatten().any(|it| match it { tt::TokenTree::Leaf(tt::Leaf::Ident(ident)) => { ident.text.contains("local_inner_macros") } _ => false, }) } else { false }; let is_builtin = attrs.by_key("rustc_builtin_macro").exists(); Some(MacroCall { name, path, is_export, is_builtin, is_local_inner, ast_id }) } fn lower_extern_block(&mut self, block: &ast::ExternBlock) -> Vec> { block.extern_item_list().map_or(Vec::new(), |list| { list.extern_items() .filter_map(|item| match item { ast::ExternItem::FnDef(ast) => self.lower_function(&ast).map(Either::Left), ast::ExternItem::StaticDef(ast) => self.lower_static(&ast).map(Either::Right), }) .collect() }) } fn lower_generic_params( &mut self, _item: &impl ast::TypeParamsOwner, ) -> generics::GenericParams { // TODO generics::GenericParams { types: Arena::new(), where_predicates: Vec::new() } } fn lower_attrs(&self, item: &impl ast::AttrsOwner) -> Attrs { Attrs::new(item, &self.hygiene) } fn lower_visibility(&self, item: &impl ast::VisibilityOwner) -> RawVisibility { RawVisibility::from_ast_with_hygiene(item.visibility(), &self.hygiene) } fn lower_type_ref(&self, type_ref: &ast::TypeRef) -> TypeRef { TypeRef::from_ast(&self.body_ctx, type_ref.clone()) } fn lower_type_ref_opt(&self, type_ref: Option) -> TypeRef { TypeRef::from_ast_opt(&self.body_ctx, type_ref) } fn next_field_idx(&self) -> Idx { Idx::from_raw(RawId::from(self.tree.fields.len() as u32)) } fn next_variant_idx(&self) -> Idx { Idx::from_raw(RawId::from(self.tree.variants.len() as u32)) } } fn desugar_future_path(orig: TypeRef) -> Path { let path = path![core::future::Future]; let mut generic_args: Vec<_> = std::iter::repeat(None).take(path.segments.len() - 1).collect(); let mut last = GenericArgs::empty(); let binding = AssociatedTypeBinding { name: name![Output], type_ref: Some(orig), bounds: Vec::new() }; last.bindings.push(binding); generic_args.push(Some(Arc::new(last))); Path::from_known_path(path, generic_args) }