//! See [`FamousDefs`]. use base_db::{CrateOrigin, LangCrateOrigin, SourceDatabase}; use hir::{Crate, Enum, Macro, Module, ScopeDef, Semantics, Trait}; use crate::RootDatabase; /// Helps with finding well-know things inside the standard library. This is /// somewhat similar to the known paths infra inside hir, but it different; We /// want to make sure that IDE specific paths don't become interesting inside /// the compiler itself as well. /// /// Note that, by default, rust-analyzer tests **do not** include core or std /// libraries. If you are writing tests for functionality using [`FamousDefs`], /// you'd want to include minicore (see `test_utils::MiniCore`) declaration at /// the start of your tests: /// /// ``` /// //- minicore: iterator, ord, derive /// ``` pub struct FamousDefs<'a, 'b>(pub &'a Semantics<'b, RootDatabase>, pub Crate); #[allow(non_snake_case)] impl FamousDefs<'_, '_> { pub fn std(&self) -> Option { self.find_lang_crate(LangCrateOrigin::Std) } pub fn core(&self) -> Option { self.find_lang_crate(LangCrateOrigin::Core) } pub fn alloc(&self) -> Option { self.find_lang_crate(LangCrateOrigin::Alloc) } pub fn test(&self) -> Option { self.find_lang_crate(LangCrateOrigin::Test) } pub fn proc_macro(&self) -> Option { self.find_lang_crate(LangCrateOrigin::ProcMacro) } pub fn core_cmp_Ord(&self) -> Option { self.find_trait("core:cmp:Ord") } pub fn core_convert_From(&self) -> Option { self.find_trait("core:convert:From") } pub fn core_convert_Into(&self) -> Option { self.find_trait("core:convert:Into") } pub fn core_option_Option(&self) -> Option { self.find_enum("core:option:Option") } pub fn core_result_Result(&self) -> Option { self.find_enum("core:result:Result") } pub fn core_default_Default(&self) -> Option { self.find_trait("core:default:Default") } pub fn core_iter_Iterator(&self) -> Option { self.find_trait("core:iter:traits:iterator:Iterator") } pub fn core_iter_IntoIterator(&self) -> Option { self.find_trait("core:iter:traits:collect:IntoIterator") } pub fn core_iter(&self) -> Option { self.find_module("core:iter") } pub fn core_ops_Deref(&self) -> Option { self.find_trait("core:ops:Deref") } pub fn core_convert_AsRef(&self) -> Option { self.find_trait("core:convert:AsRef") } pub fn core_ops_ControlFlow(&self) -> Option { self.find_enum("core:ops:ControlFlow") } pub fn core_ops_Drop(&self) -> Option { self.find_trait("core:ops:Drop") } pub fn core_marker_Copy(&self) -> Option { self.find_trait("core:marker:Copy") } pub fn core_macros_builtin_derive(&self) -> Option { self.find_macro("core:macros:builtin:derive") } pub fn builtin_crates(&self) -> impl Iterator { IntoIterator::into_iter([ self.std(), self.core(), self.alloc(), self.test(), self.proc_macro(), ]) .flatten() } fn find_trait(&self, path: &str) -> Option { match self.find_def(path)? { hir::ScopeDef::ModuleDef(hir::ModuleDef::Trait(it)) => Some(it), _ => None, } } fn find_macro(&self, path: &str) -> Option { match self.find_def(path)? { hir::ScopeDef::ModuleDef(hir::ModuleDef::Macro(it)) => Some(it), _ => None, } } fn find_enum(&self, path: &str) -> Option { match self.find_def(path)? { hir::ScopeDef::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Enum(it))) => Some(it), _ => None, } } fn find_module(&self, path: &str) -> Option { match self.find_def(path)? { hir::ScopeDef::ModuleDef(hir::ModuleDef::Module(it)) => Some(it), _ => None, } } fn find_lang_crate(&self, origin: LangCrateOrigin) -> Option { let krate = self.1; let db = self.0.db; let crate_graph = self.0.db.crate_graph(); let res = krate .dependencies(db) .into_iter() .find(|dep| crate_graph[dep.krate.into()].origin == CrateOrigin::Lang(origin))? .krate; Some(res) } fn find_def(&self, path: &str) -> Option { let db = self.0.db; let mut path = path.split(':'); let trait_ = path.next_back()?; let lang_crate = path.next()?; let lang_crate = match LangCrateOrigin::from(lang_crate) { LangCrateOrigin::Other => return None, lang_crate => lang_crate, }; let std_crate = self.find_lang_crate(lang_crate)?; let mut module = std_crate.root_module(db); for segment in path { module = module.children(db).find_map(|child| { let name = child.name(db)?; if name.to_smol_str() == segment { Some(child) } else { None } })?; } let def = module.scope(db, None).into_iter().find(|(name, _def)| name.to_smol_str() == trait_)?.1; Some(def) } }