1 //! See [`FamousDefs`].
3 use base_db::{CrateOrigin, LangCrateOrigin, SourceDatabase};
4 use hir::{Crate, Enum, Macro, Module, ScopeDef, Semantics, Trait};
6 use crate::RootDatabase;
8 /// Helps with finding well-know things inside the standard library. This is
9 /// somewhat similar to the known paths infra inside hir, but it different; We
10 /// want to make sure that IDE specific paths don't become interesting inside
11 /// the compiler itself as well.
13 /// Note that, by default, rust-analyzer tests **do not** include core or std
14 /// libraries. If you are writing tests for functionality using [`FamousDefs`],
15 /// you'd want to include minicore (see `test_utils::MiniCore`) declaration at
16 /// the start of your tests:
19 /// //- minicore: iterator, ord, derive
21 pub struct FamousDefs<'a, 'b>(pub &'a Semantics<'b, RootDatabase>, pub Crate);
23 #[allow(non_snake_case)]
24 impl FamousDefs<'_, '_> {
25 pub fn std(&self) -> Option<Crate> {
26 self.find_lang_crate(LangCrateOrigin::Std)
29 pub fn core(&self) -> Option<Crate> {
30 self.find_lang_crate(LangCrateOrigin::Core)
33 pub fn alloc(&self) -> Option<Crate> {
34 self.find_lang_crate(LangCrateOrigin::Alloc)
37 pub fn test(&self) -> Option<Crate> {
38 self.find_lang_crate(LangCrateOrigin::Test)
41 pub fn proc_macro(&self) -> Option<Crate> {
42 self.find_lang_crate(LangCrateOrigin::ProcMacro)
45 pub fn core_cmp_Ord(&self) -> Option<Trait> {
46 self.find_trait("core:cmp:Ord")
49 pub fn core_convert_From(&self) -> Option<Trait> {
50 self.find_trait("core:convert:From")
53 pub fn core_convert_Into(&self) -> Option<Trait> {
54 self.find_trait("core:convert:Into")
57 pub fn core_option_Option(&self) -> Option<Enum> {
58 self.find_enum("core:option:Option")
61 pub fn core_result_Result(&self) -> Option<Enum> {
62 self.find_enum("core:result:Result")
65 pub fn core_default_Default(&self) -> Option<Trait> {
66 self.find_trait("core:default:Default")
69 pub fn core_iter_Iterator(&self) -> Option<Trait> {
70 self.find_trait("core:iter:traits:iterator:Iterator")
73 pub fn core_iter_IntoIterator(&self) -> Option<Trait> {
74 self.find_trait("core:iter:traits:collect:IntoIterator")
77 pub fn core_iter(&self) -> Option<Module> {
78 self.find_module("core:iter")
81 pub fn core_ops_Deref(&self) -> Option<Trait> {
82 self.find_trait("core:ops:Deref")
85 pub fn core_ops_DerefMut(&self) -> Option<Trait> {
86 self.find_trait("core:ops:DerefMut")
89 pub fn core_convert_AsRef(&self) -> Option<Trait> {
90 self.find_trait("core:convert:AsRef")
93 pub fn core_ops_ControlFlow(&self) -> Option<Enum> {
94 self.find_enum("core:ops:ControlFlow")
97 pub fn core_ops_Drop(&self) -> Option<Trait> {
98 self.find_trait("core:ops:Drop")
101 pub fn core_marker_Copy(&self) -> Option<Trait> {
102 self.find_trait("core:marker:Copy")
105 pub fn core_macros_builtin_derive(&self) -> Option<Macro> {
106 self.find_macro("core:macros:builtin:derive")
109 pub fn builtin_crates(&self) -> impl Iterator<Item = Crate> {
110 IntoIterator::into_iter([
120 fn find_trait(&self, path: &str) -> Option<Trait> {
121 match self.find_def(path)? {
122 hir::ScopeDef::ModuleDef(hir::ModuleDef::Trait(it)) => Some(it),
127 fn find_macro(&self, path: &str) -> Option<Macro> {
128 match self.find_def(path)? {
129 hir::ScopeDef::ModuleDef(hir::ModuleDef::Macro(it)) => Some(it),
134 fn find_enum(&self, path: &str) -> Option<Enum> {
135 match self.find_def(path)? {
136 hir::ScopeDef::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Enum(it))) => Some(it),
141 fn find_module(&self, path: &str) -> Option<Module> {
142 match self.find_def(path)? {
143 hir::ScopeDef::ModuleDef(hir::ModuleDef::Module(it)) => Some(it),
148 fn find_lang_crate(&self, origin: LangCrateOrigin) -> Option<Crate> {
151 let crate_graph = self.0.db.crate_graph();
155 .find(|dep| crate_graph[dep.krate.into()].origin == CrateOrigin::Lang(origin))?
160 fn find_def(&self, path: &str) -> Option<ScopeDef> {
162 let mut path = path.split(':');
163 let trait_ = path.next_back()?;
164 let lang_crate = path.next()?;
165 let lang_crate = match LangCrateOrigin::from(lang_crate) {
166 LangCrateOrigin::Other => return None,
167 lang_crate => lang_crate,
169 let std_crate = self.find_lang_crate(lang_crate)?;
170 let mut module = std_crate.root_module(db);
171 for segment in path {
172 module = module.children(db).find_map(|child| {
173 let name = child.name(db)?;
174 if name.to_smol_str() == segment {
182 module.scope(db, None).into_iter().find(|(name, _def)| name.to_smol_str() == trait_)?.1;