aboutsummaryrefslogtreecommitdiff
path: root/crates/hir
diff options
context:
space:
mode:
Diffstat (limited to 'crates/hir')
-rw-r--r--crates/hir/src/code_model.rs2095
-rw-r--r--crates/hir/src/from_id.rs5
-rw-r--r--crates/hir/src/lib.rs2127
-rw-r--r--crates/hir/src/semantics.rs5
-rw-r--r--crates/hir/src/source_analyzer.rs5
5 files changed, 2104 insertions, 2133 deletions
diff --git a/crates/hir/src/code_model.rs b/crates/hir/src/code_model.rs
deleted file mode 100644
index fc1a74641..000000000
--- a/crates/hir/src/code_model.rs
+++ /dev/null
@@ -1,2095 +0,0 @@
1//! FIXME: write short doc here
2use std::{iter, sync::Arc};
3
4use arrayvec::ArrayVec;
5use base_db::{CrateDisplayName, CrateId, Edition, FileId};
6use either::Either;
7use hir_def::{
8 adt::{ReprKind, StructKind, VariantData},
9 expr::{BindingAnnotation, LabelId, Pat, PatId},
10 import_map,
11 item_tree::ItemTreeNode,
12 lang_item::LangItemTarget,
13 path::ModPath,
14 per_ns::PerNs,
15 resolver::{HasResolver, Resolver},
16 src::HasSource as _,
17 type_ref::TypeRef,
18 AdtId, AssocContainerId, AssocItemId, AssocItemLoc, AttrDefId, ConstId, ConstParamId,
19 DefWithBodyId, EnumId, FunctionId, GenericDefId, HasModule, ImplId, LifetimeParamId,
20 LocalEnumVariantId, LocalFieldId, Lookup, ModuleId, StaticId, StructId, TraitId, TypeAliasId,
21 TypeParamId, UnionId,
22};
23use hir_def::{find_path::PrefixKind, item_scope::ItemInNs, visibility::Visibility};
24use hir_expand::{
25 diagnostics::DiagnosticSink,
26 name::{name, AsName},
27 MacroDefId, MacroDefKind,
28};
29use hir_ty::{
30 autoderef,
31 display::{write_bounds_like_dyn_trait_with_prefix, HirDisplayError, HirFormatter},
32 method_resolution,
33 traits::{FnTrait, Solution, SolutionVariables},
34 AliasTy, BoundVar, CallableDefId, CallableSig, Canonical, DebruijnIndex, GenericPredicate,
35 InEnvironment, Mutability, Obligation, ProjectionPredicate, ProjectionTy, Scalar, Substs,
36 TraitEnvironment, Ty, TyDefId, TyVariableKind,
37};
38use rustc_hash::FxHashSet;
39use stdx::{format_to, impl_from};
40use syntax::{
41 ast::{self, AttrsOwner, NameOwner},
42 AstNode, SmolStr,
43};
44use tt::{Ident, Leaf, Literal, TokenTree};
45
46use crate::{
47 db::{DefDatabase, HirDatabase},
48 has_source::HasSource,
49 HirDisplay, InFile, Name,
50};
51
52/// hir::Crate describes a single crate. It's the main interface with which
53/// a crate's dependencies interact. Mostly, it should be just a proxy for the
54/// root module.
55#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
56pub struct Crate {
57 pub(crate) id: CrateId,
58}
59
60#[derive(Debug)]
61pub struct CrateDependency {
62 pub krate: Crate,
63 pub name: Name,
64}
65
66impl Crate {
67 pub fn dependencies(self, db: &dyn HirDatabase) -> Vec<CrateDependency> {
68 db.crate_graph()[self.id]
69 .dependencies
70 .iter()
71 .map(|dep| {
72 let krate = Crate { id: dep.crate_id };
73 let name = dep.as_name();
74 CrateDependency { krate, name }
75 })
76 .collect()
77 }
78
79 // FIXME: add `transitive_reverse_dependencies`.
80 pub fn reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
81 let crate_graph = db.crate_graph();
82 crate_graph
83 .iter()
84 .filter(|&krate| {
85 crate_graph[krate].dependencies.iter().any(|it| it.crate_id == self.id)
86 })
87 .map(|id| Crate { id })
88 .collect()
89 }
90
91 pub fn root_module(self, db: &dyn HirDatabase) -> Module {
92 let def_map = db.crate_def_map(self.id);
93 Module { id: def_map.module_id(def_map.root()) }
94 }
95
96 pub fn root_file(self, db: &dyn HirDatabase) -> FileId {
97 db.crate_graph()[self.id].root_file_id
98 }
99
100 pub fn edition(self, db: &dyn HirDatabase) -> Edition {
101 db.crate_graph()[self.id].edition
102 }
103
104 pub fn display_name(self, db: &dyn HirDatabase) -> Option<CrateDisplayName> {
105 db.crate_graph()[self.id].display_name.clone()
106 }
107
108 pub fn query_external_importables(
109 self,
110 db: &dyn DefDatabase,
111 query: import_map::Query,
112 ) -> impl Iterator<Item = Either<ModuleDef, MacroDef>> {
113 import_map::search_dependencies(db, self.into(), query).into_iter().map(|item| match item {
114 ItemInNs::Types(mod_id) | ItemInNs::Values(mod_id) => Either::Left(mod_id.into()),
115 ItemInNs::Macros(mac_id) => Either::Right(mac_id.into()),
116 })
117 }
118
119 pub fn all(db: &dyn HirDatabase) -> Vec<Crate> {
120 db.crate_graph().iter().map(|id| Crate { id }).collect()
121 }
122
123 /// Try to get the root URL of the documentation of a crate.
124 pub fn get_html_root_url(self: &Crate, db: &dyn HirDatabase) -> Option<String> {
125 // Look for #![doc(html_root_url = "...")]
126 let attrs = db.attrs(AttrDefId::ModuleId(self.root_module(db).into()));
127 let doc_attr_q = attrs.by_key("doc");
128
129 if !doc_attr_q.exists() {
130 return None;
131 }
132
133 let doc_url = doc_attr_q.tt_values().map(|tt| {
134 let name = tt.token_trees.iter()
135 .skip_while(|tt| !matches!(tt, TokenTree::Leaf(Leaf::Ident(Ident{text: ref ident, ..})) if ident == "html_root_url"))
136 .skip(2)
137 .next();
138
139 match name {
140 Some(TokenTree::Leaf(Leaf::Literal(Literal{ref text, ..}))) => Some(text),
141 _ => None
142 }
143 }).flat_map(|t| t).next();
144
145 doc_url.map(|s| s.trim_matches('"').trim_end_matches('/').to_owned() + "/")
146 }
147}
148
149#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
150pub struct Module {
151 pub(crate) id: ModuleId,
152}
153
154/// The defs which can be visible in the module.
155#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
156pub enum ModuleDef {
157 Module(Module),
158 Function(Function),
159 Adt(Adt),
160 // Can't be directly declared, but can be imported.
161 Variant(Variant),
162 Const(Const),
163 Static(Static),
164 Trait(Trait),
165 TypeAlias(TypeAlias),
166 BuiltinType(BuiltinType),
167}
168impl_from!(
169 Module,
170 Function,
171 Adt(Struct, Enum, Union),
172 Variant,
173 Const,
174 Static,
175 Trait,
176 TypeAlias,
177 BuiltinType
178 for ModuleDef
179);
180
181impl From<VariantDef> for ModuleDef {
182 fn from(var: VariantDef) -> Self {
183 match var {
184 VariantDef::Struct(t) => Adt::from(t).into(),
185 VariantDef::Union(t) => Adt::from(t).into(),
186 VariantDef::Variant(t) => t.into(),
187 }
188 }
189}
190
191impl ModuleDef {
192 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
193 match self {
194 ModuleDef::Module(it) => it.parent(db),
195 ModuleDef::Function(it) => Some(it.module(db)),
196 ModuleDef::Adt(it) => Some(it.module(db)),
197 ModuleDef::Variant(it) => Some(it.module(db)),
198 ModuleDef::Const(it) => Some(it.module(db)),
199 ModuleDef::Static(it) => Some(it.module(db)),
200 ModuleDef::Trait(it) => Some(it.module(db)),
201 ModuleDef::TypeAlias(it) => Some(it.module(db)),
202 ModuleDef::BuiltinType(_) => None,
203 }
204 }
205
206 pub fn canonical_path(&self, db: &dyn HirDatabase) -> Option<String> {
207 let mut segments = Vec::new();
208 segments.push(self.name(db)?.to_string());
209 for m in self.module(db)?.path_to_root(db) {
210 segments.extend(m.name(db).map(|it| it.to_string()))
211 }
212 segments.reverse();
213 Some(segments.join("::"))
214 }
215
216 pub fn definition_visibility(&self, db: &dyn HirDatabase) -> Option<Visibility> {
217 let module = match self {
218 ModuleDef::Module(it) => it.parent(db)?,
219 ModuleDef::Function(it) => return Some(it.visibility(db)),
220 ModuleDef::Adt(it) => it.module(db),
221 ModuleDef::Variant(it) => {
222 let parent = it.parent_enum(db);
223 let module = it.module(db);
224 return module.visibility_of(db, &ModuleDef::Adt(Adt::Enum(parent)));
225 }
226 ModuleDef::Const(it) => return Some(it.visibility(db)),
227 ModuleDef::Static(it) => it.module(db),
228 ModuleDef::Trait(it) => it.module(db),
229 ModuleDef::TypeAlias(it) => return Some(it.visibility(db)),
230 ModuleDef::BuiltinType(_) => return None,
231 };
232
233 module.visibility_of(db, self)
234 }
235
236 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
237 match self {
238 ModuleDef::Adt(it) => Some(it.name(db)),
239 ModuleDef::Trait(it) => Some(it.name(db)),
240 ModuleDef::Function(it) => Some(it.name(db)),
241 ModuleDef::Variant(it) => Some(it.name(db)),
242 ModuleDef::TypeAlias(it) => Some(it.name(db)),
243 ModuleDef::Module(it) => it.name(db),
244 ModuleDef::Const(it) => it.name(db),
245 ModuleDef::Static(it) => it.name(db),
246
247 ModuleDef::BuiltinType(it) => Some(it.name()),
248 }
249 }
250
251 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
252 let id = match self {
253 ModuleDef::Adt(it) => match it {
254 Adt::Struct(it) => it.id.into(),
255 Adt::Enum(it) => it.id.into(),
256 Adt::Union(it) => it.id.into(),
257 },
258 ModuleDef::Trait(it) => it.id.into(),
259 ModuleDef::Function(it) => it.id.into(),
260 ModuleDef::TypeAlias(it) => it.id.into(),
261 ModuleDef::Module(it) => it.id.into(),
262 ModuleDef::Const(it) => it.id.into(),
263 ModuleDef::Static(it) => it.id.into(),
264 _ => return,
265 };
266
267 let module = match self.module(db) {
268 Some(it) => it,
269 None => return,
270 };
271
272 hir_ty::diagnostics::validate_module_item(db, module.id.krate(), id, sink)
273 }
274}
275
276impl Module {
277 /// Name of this module.
278 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
279 let def_map = self.id.def_map(db.upcast());
280 let parent = def_map[self.id.local_id].parent?;
281 def_map[parent].children.iter().find_map(|(name, module_id)| {
282 if *module_id == self.id.local_id {
283 Some(name.clone())
284 } else {
285 None
286 }
287 })
288 }
289
290 /// Returns the crate this module is part of.
291 pub fn krate(self) -> Crate {
292 Crate { id: self.id.krate() }
293 }
294
295 /// Topmost parent of this module. Every module has a `crate_root`, but some
296 /// might be missing `krate`. This can happen if a module's file is not included
297 /// in the module tree of any target in `Cargo.toml`.
298 pub fn crate_root(self, db: &dyn HirDatabase) -> Module {
299 let def_map = db.crate_def_map(self.id.krate());
300 Module { id: def_map.module_id(def_map.root()) }
301 }
302
303 /// Iterates over all child modules.
304 pub fn children(self, db: &dyn HirDatabase) -> impl Iterator<Item = Module> {
305 let def_map = self.id.def_map(db.upcast());
306 let children = def_map[self.id.local_id]
307 .children
308 .iter()
309 .map(|(_, module_id)| Module { id: def_map.module_id(*module_id) })
310 .collect::<Vec<_>>();
311 children.into_iter()
312 }
313
314 /// Finds a parent module.
315 pub fn parent(self, db: &dyn HirDatabase) -> Option<Module> {
316 // FIXME: handle block expressions as modules (their parent is in a different DefMap)
317 let def_map = self.id.def_map(db.upcast());
318 let parent_id = def_map[self.id.local_id].parent?;
319 Some(Module { id: def_map.module_id(parent_id) })
320 }
321
322 pub fn path_to_root(self, db: &dyn HirDatabase) -> Vec<Module> {
323 let mut res = vec![self];
324 let mut curr = self;
325 while let Some(next) = curr.parent(db) {
326 res.push(next);
327 curr = next
328 }
329 res
330 }
331
332 /// Returns a `ModuleScope`: a set of items, visible in this module.
333 pub fn scope(
334 self,
335 db: &dyn HirDatabase,
336 visible_from: Option<Module>,
337 ) -> Vec<(Name, ScopeDef)> {
338 self.id.def_map(db.upcast())[self.id.local_id]
339 .scope
340 .entries()
341 .filter_map(|(name, def)| {
342 if let Some(m) = visible_from {
343 let filtered =
344 def.filter_visibility(|vis| vis.is_visible_from(db.upcast(), m.id));
345 if filtered.is_none() && !def.is_none() {
346 None
347 } else {
348 Some((name, filtered))
349 }
350 } else {
351 Some((name, def))
352 }
353 })
354 .flat_map(|(name, def)| {
355 ScopeDef::all_items(def).into_iter().map(move |item| (name.clone(), item))
356 })
357 .collect()
358 }
359
360 pub fn visibility_of(self, db: &dyn HirDatabase, def: &ModuleDef) -> Option<Visibility> {
361 self.id.def_map(db.upcast())[self.id.local_id].scope.visibility_of(def.clone().into())
362 }
363
364 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
365 let _p = profile::span("Module::diagnostics").detail(|| {
366 format!("{:?}", self.name(db).map_or("<unknown>".into(), |name| name.to_string()))
367 });
368 let crate_def_map = self.id.def_map(db.upcast());
369 crate_def_map.add_diagnostics(db.upcast(), self.id.local_id, sink);
370 for decl in self.declarations(db) {
371 match decl {
372 crate::ModuleDef::Function(f) => f.diagnostics(db, sink),
373 crate::ModuleDef::Module(m) => {
374 // Only add diagnostics from inline modules
375 if crate_def_map[m.id.local_id].origin.is_inline() {
376 m.diagnostics(db, sink)
377 }
378 }
379 _ => {
380 decl.diagnostics(db, sink);
381 }
382 }
383 }
384
385 for impl_def in self.impl_defs(db) {
386 for item in impl_def.items(db) {
387 if let AssocItem::Function(f) = item {
388 f.diagnostics(db, sink);
389 }
390 }
391 }
392 }
393
394 pub fn declarations(self, db: &dyn HirDatabase) -> Vec<ModuleDef> {
395 let def_map = self.id.def_map(db.upcast());
396 def_map[self.id.local_id].scope.declarations().map(ModuleDef::from).collect()
397 }
398
399 pub fn impl_defs(self, db: &dyn HirDatabase) -> Vec<Impl> {
400 let def_map = self.id.def_map(db.upcast());
401 def_map[self.id.local_id].scope.impls().map(Impl::from).collect()
402 }
403
404 /// Finds a path that can be used to refer to the given item from within
405 /// this module, if possible.
406 pub fn find_use_path(self, db: &dyn DefDatabase, item: impl Into<ItemInNs>) -> Option<ModPath> {
407 hir_def::find_path::find_path(db, item.into(), self.into())
408 }
409
410 /// Finds a path that can be used to refer to the given item from within
411 /// this module, if possible. This is used for returning import paths for use-statements.
412 pub fn find_use_path_prefixed(
413 self,
414 db: &dyn DefDatabase,
415 item: impl Into<ItemInNs>,
416 prefix_kind: PrefixKind,
417 ) -> Option<ModPath> {
418 hir_def::find_path::find_path_prefixed(db, item.into(), self.into(), prefix_kind)
419 }
420}
421
422#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
423pub struct Field {
424 pub(crate) parent: VariantDef,
425 pub(crate) id: LocalFieldId,
426}
427
428#[derive(Debug, PartialEq, Eq)]
429pub enum FieldSource {
430 Named(ast::RecordField),
431 Pos(ast::TupleField),
432}
433
434impl Field {
435 pub fn name(&self, db: &dyn HirDatabase) -> Name {
436 self.parent.variant_data(db).fields()[self.id].name.clone()
437 }
438
439 /// Returns the type as in the signature of the struct (i.e., with
440 /// placeholder types for type parameters). This is good for showing
441 /// signature help, but not so good to actually get the type of the field
442 /// when you actually have a variable of the struct.
443 pub fn signature_ty(&self, db: &dyn HirDatabase) -> Type {
444 let var_id = self.parent.into();
445 let generic_def_id: GenericDefId = match self.parent {
446 VariantDef::Struct(it) => it.id.into(),
447 VariantDef::Union(it) => it.id.into(),
448 VariantDef::Variant(it) => it.parent.id.into(),
449 };
450 let substs = Substs::type_params(db, generic_def_id);
451 let ty = db.field_types(var_id)[self.id].clone().subst(&substs);
452 Type::new(db, self.parent.module(db).id.krate(), var_id, ty)
453 }
454
455 pub fn parent_def(&self, _db: &dyn HirDatabase) -> VariantDef {
456 self.parent
457 }
458}
459
460impl HasVisibility for Field {
461 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
462 let variant_data = self.parent.variant_data(db);
463 let visibility = &variant_data.fields()[self.id].visibility;
464 let parent_id: hir_def::VariantId = self.parent.into();
465 visibility.resolve(db.upcast(), &parent_id.resolver(db.upcast()))
466 }
467}
468
469#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
470pub struct Struct {
471 pub(crate) id: StructId,
472}
473
474impl Struct {
475 pub fn module(self, db: &dyn HirDatabase) -> Module {
476 Module { id: self.id.lookup(db.upcast()).container.module(db.upcast()) }
477 }
478
479 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
480 Some(self.module(db).krate())
481 }
482
483 pub fn name(self, db: &dyn HirDatabase) -> Name {
484 db.struct_data(self.id).name.clone()
485 }
486
487 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
488 db.struct_data(self.id)
489 .variant_data
490 .fields()
491 .iter()
492 .map(|(id, _)| Field { parent: self.into(), id })
493 .collect()
494 }
495
496 pub fn ty(self, db: &dyn HirDatabase) -> Type {
497 Type::from_def(
498 db,
499 self.id.lookup(db.upcast()).container.module(db.upcast()).krate(),
500 self.id,
501 )
502 }
503
504 pub fn repr(self, db: &dyn HirDatabase) -> Option<ReprKind> {
505 db.struct_data(self.id).repr.clone()
506 }
507
508 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
509 self.variant_data(db).kind()
510 }
511
512 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
513 db.struct_data(self.id).variant_data.clone()
514 }
515}
516
517#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
518pub struct Union {
519 pub(crate) id: UnionId,
520}
521
522impl Union {
523 pub fn name(self, db: &dyn HirDatabase) -> Name {
524 db.union_data(self.id).name.clone()
525 }
526
527 pub fn module(self, db: &dyn HirDatabase) -> Module {
528 Module { id: self.id.lookup(db.upcast()).container.module(db.upcast()) }
529 }
530
531 pub fn ty(self, db: &dyn HirDatabase) -> Type {
532 Type::from_def(
533 db,
534 self.id.lookup(db.upcast()).container.module(db.upcast()).krate(),
535 self.id,
536 )
537 }
538
539 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
540 db.union_data(self.id)
541 .variant_data
542 .fields()
543 .iter()
544 .map(|(id, _)| Field { parent: self.into(), id })
545 .collect()
546 }
547
548 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
549 db.union_data(self.id).variant_data.clone()
550 }
551}
552
553#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
554pub struct Enum {
555 pub(crate) id: EnumId,
556}
557
558impl Enum {
559 pub fn module(self, db: &dyn HirDatabase) -> Module {
560 Module { id: self.id.lookup(db.upcast()).container.module(db.upcast()) }
561 }
562
563 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
564 Some(self.module(db).krate())
565 }
566
567 pub fn name(self, db: &dyn HirDatabase) -> Name {
568 db.enum_data(self.id).name.clone()
569 }
570
571 pub fn variants(self, db: &dyn HirDatabase) -> Vec<Variant> {
572 db.enum_data(self.id).variants.iter().map(|(id, _)| Variant { parent: self, id }).collect()
573 }
574
575 pub fn ty(self, db: &dyn HirDatabase) -> Type {
576 Type::from_def(
577 db,
578 self.id.lookup(db.upcast()).container.module(db.upcast()).krate(),
579 self.id,
580 )
581 }
582}
583
584#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
585pub struct Variant {
586 pub(crate) parent: Enum,
587 pub(crate) id: LocalEnumVariantId,
588}
589
590impl Variant {
591 pub fn module(self, db: &dyn HirDatabase) -> Module {
592 self.parent.module(db)
593 }
594 pub fn parent_enum(self, _db: &dyn HirDatabase) -> Enum {
595 self.parent
596 }
597
598 pub fn name(self, db: &dyn HirDatabase) -> Name {
599 db.enum_data(self.parent.id).variants[self.id].name.clone()
600 }
601
602 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
603 self.variant_data(db)
604 .fields()
605 .iter()
606 .map(|(id, _)| Field { parent: self.into(), id })
607 .collect()
608 }
609
610 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
611 self.variant_data(db).kind()
612 }
613
614 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
615 db.enum_data(self.parent.id).variants[self.id].variant_data.clone()
616 }
617}
618
619/// A Data Type
620#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
621pub enum Adt {
622 Struct(Struct),
623 Union(Union),
624 Enum(Enum),
625}
626impl_from!(Struct, Union, Enum for Adt);
627
628impl Adt {
629 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
630 let subst = db.generic_defaults(self.into());
631 subst.iter().any(|ty| &ty.value == &Ty::Unknown)
632 }
633
634 /// Turns this ADT into a type. Any type parameters of the ADT will be
635 /// turned into unknown types, which is good for e.g. finding the most
636 /// general set of completions, but will not look very nice when printed.
637 pub fn ty(self, db: &dyn HirDatabase) -> Type {
638 let id = AdtId::from(self);
639 Type::from_def(db, id.module(db.upcast()).krate(), id)
640 }
641
642 pub fn module(self, db: &dyn HirDatabase) -> Module {
643 match self {
644 Adt::Struct(s) => s.module(db),
645 Adt::Union(s) => s.module(db),
646 Adt::Enum(e) => e.module(db),
647 }
648 }
649
650 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
651 Some(self.module(db).krate())
652 }
653
654 pub fn name(self, db: &dyn HirDatabase) -> Name {
655 match self {
656 Adt::Struct(s) => s.name(db),
657 Adt::Union(u) => u.name(db),
658 Adt::Enum(e) => e.name(db),
659 }
660 }
661}
662
663#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
664pub enum VariantDef {
665 Struct(Struct),
666 Union(Union),
667 Variant(Variant),
668}
669impl_from!(Struct, Union, Variant for VariantDef);
670
671impl VariantDef {
672 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
673 match self {
674 VariantDef::Struct(it) => it.fields(db),
675 VariantDef::Union(it) => it.fields(db),
676 VariantDef::Variant(it) => it.fields(db),
677 }
678 }
679
680 pub fn module(self, db: &dyn HirDatabase) -> Module {
681 match self {
682 VariantDef::Struct(it) => it.module(db),
683 VariantDef::Union(it) => it.module(db),
684 VariantDef::Variant(it) => it.module(db),
685 }
686 }
687
688 pub fn name(&self, db: &dyn HirDatabase) -> Name {
689 match self {
690 VariantDef::Struct(s) => s.name(db),
691 VariantDef::Union(u) => u.name(db),
692 VariantDef::Variant(e) => e.name(db),
693 }
694 }
695
696 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
697 match self {
698 VariantDef::Struct(it) => it.variant_data(db),
699 VariantDef::Union(it) => it.variant_data(db),
700 VariantDef::Variant(it) => it.variant_data(db),
701 }
702 }
703}
704
705/// The defs which have a body.
706#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
707pub enum DefWithBody {
708 Function(Function),
709 Static(Static),
710 Const(Const),
711}
712impl_from!(Function, Const, Static for DefWithBody);
713
714impl DefWithBody {
715 pub fn module(self, db: &dyn HirDatabase) -> Module {
716 match self {
717 DefWithBody::Const(c) => c.module(db),
718 DefWithBody::Function(f) => f.module(db),
719 DefWithBody::Static(s) => s.module(db),
720 }
721 }
722
723 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
724 match self {
725 DefWithBody::Function(f) => Some(f.name(db)),
726 DefWithBody::Static(s) => s.name(db),
727 DefWithBody::Const(c) => c.name(db),
728 }
729 }
730}
731
732#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
733pub struct Function {
734 pub(crate) id: FunctionId,
735}
736
737impl Function {
738 pub fn module(self, db: &dyn HirDatabase) -> Module {
739 self.id.lookup(db.upcast()).module(db.upcast()).into()
740 }
741
742 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
743 Some(self.module(db).krate())
744 }
745
746 pub fn name(self, db: &dyn HirDatabase) -> Name {
747 db.function_data(self.id).name.clone()
748 }
749
750 /// Get this function's return type
751 pub fn ret_type(self, db: &dyn HirDatabase) -> Type {
752 let resolver = self.id.resolver(db.upcast());
753 let ret_type = &db.function_data(self.id).ret_type;
754 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
755 let environment = TraitEnvironment::lower(db, &resolver);
756 Type {
757 krate: self.id.lookup(db.upcast()).container.module(db.upcast()).krate(),
758 ty: InEnvironment { value: Ty::from_hir_ext(&ctx, ret_type).0, environment },
759 }
760 }
761
762 pub fn self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
763 if !db.function_data(self.id).has_self_param {
764 return None;
765 }
766 Some(SelfParam { func: self.id })
767 }
768
769 pub fn assoc_fn_params(self, db: &dyn HirDatabase) -> Vec<Param> {
770 let resolver = self.id.resolver(db.upcast());
771 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
772 let environment = TraitEnvironment::lower(db, &resolver);
773 db.function_data(self.id)
774 .params
775 .iter()
776 .map(|type_ref| {
777 let ty = Type {
778 krate: self.id.lookup(db.upcast()).container.module(db.upcast()).krate(),
779 ty: InEnvironment {
780 value: Ty::from_hir_ext(&ctx, type_ref).0,
781 environment: environment.clone(),
782 },
783 };
784 Param { ty }
785 })
786 .collect()
787 }
788 pub fn method_params(self, db: &dyn HirDatabase) -> Option<Vec<Param>> {
789 if self.self_param(db).is_none() {
790 return None;
791 }
792 let mut res = self.assoc_fn_params(db);
793 res.remove(0);
794 Some(res)
795 }
796
797 pub fn is_unsafe(self, db: &dyn HirDatabase) -> bool {
798 db.function_data(self.id).is_unsafe
799 }
800
801 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
802 let krate = self.module(db).id.krate();
803 hir_def::diagnostics::validate_body(db.upcast(), self.id.into(), sink);
804 hir_ty::diagnostics::validate_module_item(db, krate, self.id.into(), sink);
805 hir_ty::diagnostics::validate_body(db, self.id.into(), sink);
806 }
807
808 /// Whether this function declaration has a definition.
809 ///
810 /// This is false in the case of required (not provided) trait methods.
811 pub fn has_body(self, db: &dyn HirDatabase) -> bool {
812 db.function_data(self.id).has_body
813 }
814
815 /// A textual representation of the HIR of this function for debugging purposes.
816 pub fn debug_hir(self, db: &dyn HirDatabase) -> String {
817 let body = db.body(self.id.into());
818
819 let mut result = String::new();
820 format_to!(result, "HIR expressions in the body of `{}`:\n", self.name(db));
821 for (id, expr) in body.exprs.iter() {
822 format_to!(result, "{:?}: {:?}\n", id, expr);
823 }
824
825 result
826 }
827}
828
829// Note: logically, this belongs to `hir_ty`, but we are not using it there yet.
830pub enum Access {
831 Shared,
832 Exclusive,
833 Owned,
834}
835
836impl From<Mutability> for Access {
837 fn from(mutability: Mutability) -> Access {
838 match mutability {
839 Mutability::Not => Access::Shared,
840 Mutability::Mut => Access::Exclusive,
841 }
842 }
843}
844
845#[derive(Debug)]
846pub struct Param {
847 ty: Type,
848}
849
850impl Param {
851 pub fn ty(&self) -> &Type {
852 &self.ty
853 }
854}
855
856#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
857pub struct SelfParam {
858 func: FunctionId,
859}
860
861impl SelfParam {
862 pub fn access(self, db: &dyn HirDatabase) -> Access {
863 let func_data = db.function_data(self.func);
864 func_data
865 .params
866 .first()
867 .map(|param| match *param {
868 TypeRef::Reference(.., mutability) => match mutability {
869 hir_def::type_ref::Mutability::Shared => Access::Shared,
870 hir_def::type_ref::Mutability::Mut => Access::Exclusive,
871 },
872 _ => Access::Owned,
873 })
874 .unwrap_or(Access::Owned)
875 }
876}
877
878impl HasVisibility for Function {
879 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
880 let function_data = db.function_data(self.id);
881 let visibility = &function_data.visibility;
882 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
883 }
884}
885
886#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
887pub struct Const {
888 pub(crate) id: ConstId,
889}
890
891impl Const {
892 pub fn module(self, db: &dyn HirDatabase) -> Module {
893 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
894 }
895
896 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
897 Some(self.module(db).krate())
898 }
899
900 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
901 db.const_data(self.id).name.clone()
902 }
903}
904
905impl HasVisibility for Const {
906 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
907 let function_data = db.const_data(self.id);
908 let visibility = &function_data.visibility;
909 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
910 }
911}
912
913#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
914pub struct Static {
915 pub(crate) id: StaticId,
916}
917
918impl Static {
919 pub fn module(self, db: &dyn HirDatabase) -> Module {
920 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
921 }
922
923 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
924 Some(self.module(db).krate())
925 }
926
927 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
928 db.static_data(self.id).name.clone()
929 }
930
931 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
932 db.static_data(self.id).mutable
933 }
934}
935
936#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
937pub struct Trait {
938 pub(crate) id: TraitId,
939}
940
941impl Trait {
942 pub fn module(self, db: &dyn HirDatabase) -> Module {
943 Module { id: self.id.lookup(db.upcast()).container.module(db.upcast()) }
944 }
945
946 pub fn name(self, db: &dyn HirDatabase) -> Name {
947 db.trait_data(self.id).name.clone()
948 }
949
950 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
951 db.trait_data(self.id).items.iter().map(|(_name, it)| (*it).into()).collect()
952 }
953
954 pub fn is_auto(self, db: &dyn HirDatabase) -> bool {
955 db.trait_data(self.id).auto
956 }
957}
958
959#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
960pub struct TypeAlias {
961 pub(crate) id: TypeAliasId,
962}
963
964impl TypeAlias {
965 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
966 let subst = db.generic_defaults(self.id.into());
967 subst.iter().any(|ty| &ty.value == &Ty::Unknown)
968 }
969
970 pub fn module(self, db: &dyn HirDatabase) -> Module {
971 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
972 }
973
974 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
975 Some(self.module(db).krate())
976 }
977
978 pub fn type_ref(self, db: &dyn HirDatabase) -> Option<TypeRef> {
979 db.type_alias_data(self.id).type_ref.clone()
980 }
981
982 pub fn ty(self, db: &dyn HirDatabase) -> Type {
983 Type::from_def(db, self.id.lookup(db.upcast()).module(db.upcast()).krate(), self.id)
984 }
985
986 pub fn name(self, db: &dyn HirDatabase) -> Name {
987 db.type_alias_data(self.id).name.clone()
988 }
989}
990
991impl HasVisibility for TypeAlias {
992 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
993 let function_data = db.type_alias_data(self.id);
994 let visibility = &function_data.visibility;
995 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
996 }
997}
998
999#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1000pub struct BuiltinType {
1001 pub(crate) inner: hir_def::builtin_type::BuiltinType,
1002}
1003
1004impl BuiltinType {
1005 pub fn ty(self, db: &dyn HirDatabase, module: Module) -> Type {
1006 let resolver = module.id.resolver(db.upcast());
1007 Type::new_with_resolver(db, &resolver, Ty::builtin(self.inner))
1008 .expect("crate not present in resolver")
1009 }
1010
1011 pub fn name(self) -> Name {
1012 self.inner.as_name()
1013 }
1014}
1015
1016#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1017pub struct MacroDef {
1018 pub(crate) id: MacroDefId,
1019}
1020
1021impl MacroDef {
1022 /// FIXME: right now, this just returns the root module of the crate that
1023 /// defines this macro. The reasons for this is that macros are expanded
1024 /// early, in `hir_expand`, where modules simply do not exist yet.
1025 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
1026 let krate = self.id.krate;
1027 let def_map = db.crate_def_map(krate);
1028 let module_id = def_map.root();
1029 Some(Module { id: def_map.module_id(module_id) })
1030 }
1031
1032 /// XXX: this parses the file
1033 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1034 self.source(db)?.value.name().map(|it| it.as_name())
1035 }
1036
1037 /// Indicate it is a proc-macro
1038 pub fn is_proc_macro(&self) -> bool {
1039 matches!(self.id.kind, MacroDefKind::ProcMacro(_))
1040 }
1041
1042 /// Indicate it is a derive macro
1043 pub fn is_derive_macro(&self) -> bool {
1044 matches!(self.id.kind, MacroDefKind::ProcMacro(_) | MacroDefKind::BuiltInDerive(_))
1045 }
1046}
1047
1048/// Invariant: `inner.as_assoc_item(db).is_some()`
1049/// We do not actively enforce this invariant.
1050#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1051pub enum AssocItem {
1052 Function(Function),
1053 Const(Const),
1054 TypeAlias(TypeAlias),
1055}
1056pub enum AssocItemContainer {
1057 Trait(Trait),
1058 Impl(Impl),
1059}
1060pub trait AsAssocItem {
1061 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>;
1062}
1063
1064impl AsAssocItem for Function {
1065 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1066 as_assoc_item(db, AssocItem::Function, self.id)
1067 }
1068}
1069impl AsAssocItem for Const {
1070 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1071 as_assoc_item(db, AssocItem::Const, self.id)
1072 }
1073}
1074impl AsAssocItem for TypeAlias {
1075 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1076 as_assoc_item(db, AssocItem::TypeAlias, self.id)
1077 }
1078}
1079impl AsAssocItem for ModuleDef {
1080 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1081 match self {
1082 ModuleDef::Function(it) => it.as_assoc_item(db),
1083 ModuleDef::Const(it) => it.as_assoc_item(db),
1084 ModuleDef::TypeAlias(it) => it.as_assoc_item(db),
1085 _ => None,
1086 }
1087 }
1088}
1089fn as_assoc_item<ID, DEF, CTOR, AST>(db: &dyn HirDatabase, ctor: CTOR, id: ID) -> Option<AssocItem>
1090where
1091 ID: Lookup<Data = AssocItemLoc<AST>>,
1092 DEF: From<ID>,
1093 CTOR: FnOnce(DEF) -> AssocItem,
1094 AST: ItemTreeNode,
1095{
1096 match id.lookup(db.upcast()).container {
1097 AssocContainerId::TraitId(_) | AssocContainerId::ImplId(_) => Some(ctor(DEF::from(id))),
1098 AssocContainerId::ContainerId(_) => None,
1099 }
1100}
1101
1102impl AssocItem {
1103 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1104 match self {
1105 AssocItem::Function(it) => Some(it.name(db)),
1106 AssocItem::Const(it) => it.name(db),
1107 AssocItem::TypeAlias(it) => Some(it.name(db)),
1108 }
1109 }
1110 pub fn module(self, db: &dyn HirDatabase) -> Module {
1111 match self {
1112 AssocItem::Function(f) => f.module(db),
1113 AssocItem::Const(c) => c.module(db),
1114 AssocItem::TypeAlias(t) => t.module(db),
1115 }
1116 }
1117 pub fn container(self, db: &dyn HirDatabase) -> AssocItemContainer {
1118 let container = match self {
1119 AssocItem::Function(it) => it.id.lookup(db.upcast()).container,
1120 AssocItem::Const(it) => it.id.lookup(db.upcast()).container,
1121 AssocItem::TypeAlias(it) => it.id.lookup(db.upcast()).container,
1122 };
1123 match container {
1124 AssocContainerId::TraitId(id) => AssocItemContainer::Trait(id.into()),
1125 AssocContainerId::ImplId(id) => AssocItemContainer::Impl(id.into()),
1126 AssocContainerId::ContainerId(_) => panic!("invalid AssocItem"),
1127 }
1128 }
1129
1130 pub fn containing_trait(self, db: &dyn HirDatabase) -> Option<Trait> {
1131 match self.container(db) {
1132 AssocItemContainer::Trait(t) => Some(t),
1133 _ => None,
1134 }
1135 }
1136}
1137
1138impl HasVisibility for AssocItem {
1139 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1140 match self {
1141 AssocItem::Function(f) => f.visibility(db),
1142 AssocItem::Const(c) => c.visibility(db),
1143 AssocItem::TypeAlias(t) => t.visibility(db),
1144 }
1145 }
1146}
1147
1148#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1149pub enum GenericDef {
1150 Function(Function),
1151 Adt(Adt),
1152 Trait(Trait),
1153 TypeAlias(TypeAlias),
1154 Impl(Impl),
1155 // enum variants cannot have generics themselves, but their parent enums
1156 // can, and this makes some code easier to write
1157 Variant(Variant),
1158 // consts can have type parameters from their parents (i.e. associated consts of traits)
1159 Const(Const),
1160}
1161impl_from!(
1162 Function,
1163 Adt(Struct, Enum, Union),
1164 Trait,
1165 TypeAlias,
1166 Impl,
1167 Variant,
1168 Const
1169 for GenericDef
1170);
1171
1172impl GenericDef {
1173 pub fn params(self, db: &dyn HirDatabase) -> Vec<GenericParam> {
1174 let generics = db.generic_params(self.into());
1175 let ty_params = generics
1176 .types
1177 .iter()
1178 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1179 .map(GenericParam::TypeParam);
1180 let lt_params = generics
1181 .lifetimes
1182 .iter()
1183 .map(|(local_id, _)| LifetimeParam {
1184 id: LifetimeParamId { parent: self.into(), local_id },
1185 })
1186 .map(GenericParam::LifetimeParam);
1187 let const_params = generics
1188 .consts
1189 .iter()
1190 .map(|(local_id, _)| ConstParam { id: ConstParamId { parent: self.into(), local_id } })
1191 .map(GenericParam::ConstParam);
1192 ty_params.chain(lt_params).chain(const_params).collect()
1193 }
1194
1195 pub fn type_params(self, db: &dyn HirDatabase) -> Vec<TypeParam> {
1196 let generics = db.generic_params(self.into());
1197 generics
1198 .types
1199 .iter()
1200 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1201 .collect()
1202 }
1203}
1204
1205#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1206pub struct Local {
1207 pub(crate) parent: DefWithBodyId,
1208 pub(crate) pat_id: PatId,
1209}
1210
1211impl Local {
1212 pub fn is_param(self, db: &dyn HirDatabase) -> bool {
1213 let src = self.source(db);
1214 match src.value {
1215 Either::Left(bind_pat) => {
1216 bind_pat.syntax().ancestors().any(|it| ast::Param::can_cast(it.kind()))
1217 }
1218 Either::Right(_self_param) => true,
1219 }
1220 }
1221
1222 // FIXME: why is this an option? It shouldn't be?
1223 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1224 let body = db.body(self.parent.into());
1225 match &body[self.pat_id] {
1226 Pat::Bind { name, .. } => Some(name.clone()),
1227 _ => None,
1228 }
1229 }
1230
1231 pub fn is_self(self, db: &dyn HirDatabase) -> bool {
1232 self.name(db) == Some(name![self])
1233 }
1234
1235 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1236 let body = db.body(self.parent.into());
1237 match &body[self.pat_id] {
1238 Pat::Bind { mode, .. } => match mode {
1239 BindingAnnotation::Mutable | BindingAnnotation::RefMut => true,
1240 _ => false,
1241 },
1242 _ => false,
1243 }
1244 }
1245
1246 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1247 self.parent.into()
1248 }
1249
1250 pub fn module(self, db: &dyn HirDatabase) -> Module {
1251 self.parent(db).module(db)
1252 }
1253
1254 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1255 let def = DefWithBodyId::from(self.parent);
1256 let infer = db.infer(def);
1257 let ty = infer[self.pat_id].clone();
1258 let krate = def.module(db.upcast()).krate();
1259 Type::new(db, krate, def, ty)
1260 }
1261
1262 pub fn source(self, db: &dyn HirDatabase) -> InFile<Either<ast::IdentPat, ast::SelfParam>> {
1263 let (_body, source_map) = db.body_with_source_map(self.parent.into());
1264 let src = source_map.pat_syntax(self.pat_id).unwrap(); // Hmm...
1265 let root = src.file_syntax(db.upcast());
1266 src.map(|ast| {
1267 ast.map_left(|it| it.cast().unwrap().to_node(&root)).map_right(|it| it.to_node(&root))
1268 })
1269 }
1270}
1271
1272#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1273pub struct Label {
1274 pub(crate) parent: DefWithBodyId,
1275 pub(crate) label_id: LabelId,
1276}
1277
1278impl Label {
1279 pub fn module(self, db: &dyn HirDatabase) -> Module {
1280 self.parent(db).module(db)
1281 }
1282
1283 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1284 self.parent.into()
1285 }
1286
1287 pub fn name(self, db: &dyn HirDatabase) -> Name {
1288 let body = db.body(self.parent.into());
1289 body[self.label_id].name.clone()
1290 }
1291
1292 pub fn source(self, db: &dyn HirDatabase) -> InFile<ast::Label> {
1293 let (_body, source_map) = db.body_with_source_map(self.parent.into());
1294 let src = source_map.label_syntax(self.label_id);
1295 let root = src.file_syntax(db.upcast());
1296 src.map(|ast| ast.to_node(&root))
1297 }
1298}
1299
1300#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1301pub enum GenericParam {
1302 TypeParam(TypeParam),
1303 LifetimeParam(LifetimeParam),
1304 ConstParam(ConstParam),
1305}
1306impl_from!(TypeParam, LifetimeParam, ConstParam for GenericParam);
1307
1308impl GenericParam {
1309 pub fn module(self, db: &dyn HirDatabase) -> Module {
1310 match self {
1311 GenericParam::TypeParam(it) => it.module(db),
1312 GenericParam::LifetimeParam(it) => it.module(db),
1313 GenericParam::ConstParam(it) => it.module(db),
1314 }
1315 }
1316
1317 pub fn name(self, db: &dyn HirDatabase) -> Name {
1318 match self {
1319 GenericParam::TypeParam(it) => it.name(db),
1320 GenericParam::LifetimeParam(it) => it.name(db),
1321 GenericParam::ConstParam(it) => it.name(db),
1322 }
1323 }
1324}
1325
1326#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1327pub struct TypeParam {
1328 pub(crate) id: TypeParamId,
1329}
1330
1331impl TypeParam {
1332 pub fn name(self, db: &dyn HirDatabase) -> Name {
1333 let params = db.generic_params(self.id.parent);
1334 params.types[self.id.local_id].name.clone().unwrap_or_else(Name::missing)
1335 }
1336
1337 pub fn module(self, db: &dyn HirDatabase) -> Module {
1338 self.id.parent.module(db.upcast()).into()
1339 }
1340
1341 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1342 let resolver = self.id.parent.resolver(db.upcast());
1343 let environment = TraitEnvironment::lower(db, &resolver);
1344 let ty = Ty::Placeholder(self.id);
1345 Type {
1346 krate: self.id.parent.module(db.upcast()).krate(),
1347 ty: InEnvironment { value: ty, environment },
1348 }
1349 }
1350
1351 pub fn trait_bounds(self, db: &dyn HirDatabase) -> Vec<Trait> {
1352 db.generic_predicates_for_param(self.id)
1353 .into_iter()
1354 .filter_map(|pred| match &pred.value {
1355 hir_ty::GenericPredicate::Implemented(trait_ref) => {
1356 Some(Trait::from(trait_ref.trait_))
1357 }
1358 _ => None,
1359 })
1360 .collect()
1361 }
1362
1363 pub fn default(self, db: &dyn HirDatabase) -> Option<Type> {
1364 let params = db.generic_defaults(self.id.parent);
1365 let local_idx = hir_ty::param_idx(db, self.id)?;
1366 let resolver = self.id.parent.resolver(db.upcast());
1367 let environment = TraitEnvironment::lower(db, &resolver);
1368 let ty = params.get(local_idx)?.clone();
1369 let subst = Substs::type_params(db, self.id.parent);
1370 let ty = ty.subst(&subst.prefix(local_idx));
1371 Some(Type {
1372 krate: self.id.parent.module(db.upcast()).krate(),
1373 ty: InEnvironment { value: ty, environment },
1374 })
1375 }
1376}
1377
1378impl HirDisplay for TypeParam {
1379 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1380 write!(f, "{}", self.name(f.db))?;
1381 let bounds = f.db.generic_predicates_for_param(self.id);
1382 let substs = Substs::type_params(f.db, self.id.parent);
1383 let predicates = bounds.iter().cloned().map(|b| b.subst(&substs)).collect::<Vec<_>>();
1384 if !(predicates.is_empty() || f.omit_verbose_types()) {
1385 write_bounds_like_dyn_trait_with_prefix(":", &predicates, f)?;
1386 }
1387 Ok(())
1388 }
1389}
1390
1391#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1392pub struct LifetimeParam {
1393 pub(crate) id: LifetimeParamId,
1394}
1395
1396impl LifetimeParam {
1397 pub fn name(self, db: &dyn HirDatabase) -> Name {
1398 let params = db.generic_params(self.id.parent);
1399 params.lifetimes[self.id.local_id].name.clone()
1400 }
1401
1402 pub fn module(self, db: &dyn HirDatabase) -> Module {
1403 self.id.parent.module(db.upcast()).into()
1404 }
1405
1406 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1407 self.id.parent.into()
1408 }
1409}
1410
1411#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1412pub struct ConstParam {
1413 pub(crate) id: ConstParamId,
1414}
1415
1416impl ConstParam {
1417 pub fn name(self, db: &dyn HirDatabase) -> Name {
1418 let params = db.generic_params(self.id.parent);
1419 params.consts[self.id.local_id].name.clone()
1420 }
1421
1422 pub fn module(self, db: &dyn HirDatabase) -> Module {
1423 self.id.parent.module(db.upcast()).into()
1424 }
1425
1426 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1427 self.id.parent.into()
1428 }
1429
1430 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1431 let def = self.id.parent;
1432 let krate = def.module(db.upcast()).krate();
1433 Type::new(db, krate, def, db.const_param_ty(self.id))
1434 }
1435}
1436
1437#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1438pub struct Impl {
1439 pub(crate) id: ImplId,
1440}
1441
1442impl Impl {
1443 pub fn all_in_crate(db: &dyn HirDatabase, krate: Crate) -> Vec<Impl> {
1444 let inherent = db.inherent_impls_in_crate(krate.id);
1445 let trait_ = db.trait_impls_in_crate(krate.id);
1446
1447 inherent.all_impls().chain(trait_.all_impls()).map(Self::from).collect()
1448 }
1449 pub fn for_trait(db: &dyn HirDatabase, krate: Crate, trait_: Trait) -> Vec<Impl> {
1450 let impls = db.trait_impls_in_crate(krate.id);
1451 impls.for_trait(trait_.id).map(Self::from).collect()
1452 }
1453
1454 // FIXME: the return type is wrong. This should be a hir version of
1455 // `TraitRef` (ie, resolved `TypeRef`).
1456 pub fn target_trait(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1457 db.impl_data(self.id).target_trait.clone()
1458 }
1459
1460 pub fn target_ty(self, db: &dyn HirDatabase) -> Type {
1461 let impl_data = db.impl_data(self.id);
1462 let resolver = self.id.resolver(db.upcast());
1463 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1464 let environment = TraitEnvironment::lower(db, &resolver);
1465 let ty = Ty::from_hir(&ctx, &impl_data.target_type);
1466 Type {
1467 krate: self.id.lookup(db.upcast()).container.module(db.upcast()).krate(),
1468 ty: InEnvironment { value: ty, environment },
1469 }
1470 }
1471
1472 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1473 db.impl_data(self.id).items.iter().map(|it| (*it).into()).collect()
1474 }
1475
1476 pub fn is_negative(self, db: &dyn HirDatabase) -> bool {
1477 db.impl_data(self.id).is_negative
1478 }
1479
1480 pub fn module(self, db: &dyn HirDatabase) -> Module {
1481 self.id.lookup(db.upcast()).container.module(db.upcast()).into()
1482 }
1483
1484 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1485 Crate { id: self.module(db).id.krate() }
1486 }
1487
1488 pub fn is_builtin_derive(self, db: &dyn HirDatabase) -> Option<InFile<ast::Attr>> {
1489 let src = self.source(db)?;
1490 let item = src.file_id.is_builtin_derive(db.upcast())?;
1491 let hygenic = hir_expand::hygiene::Hygiene::new(db.upcast(), item.file_id);
1492
1493 // FIXME: handle `cfg_attr`
1494 let attr = item
1495 .value
1496 .attrs()
1497 .filter_map(|it| {
1498 let path = ModPath::from_src(it.path()?, &hygenic)?;
1499 if path.as_ident()?.to_string() == "derive" {
1500 Some(it)
1501 } else {
1502 None
1503 }
1504 })
1505 .last()?;
1506
1507 Some(item.with_value(attr))
1508 }
1509}
1510
1511#[derive(Clone, PartialEq, Eq, Debug)]
1512pub struct Type {
1513 krate: CrateId,
1514 ty: InEnvironment<Ty>,
1515}
1516
1517impl Type {
1518 pub(crate) fn new_with_resolver(
1519 db: &dyn HirDatabase,
1520 resolver: &Resolver,
1521 ty: Ty,
1522 ) -> Option<Type> {
1523 let krate = resolver.krate()?;
1524 Some(Type::new_with_resolver_inner(db, krate, resolver, ty))
1525 }
1526 pub(crate) fn new_with_resolver_inner(
1527 db: &dyn HirDatabase,
1528 krate: CrateId,
1529 resolver: &Resolver,
1530 ty: Ty,
1531 ) -> Type {
1532 let environment = TraitEnvironment::lower(db, &resolver);
1533 Type { krate, ty: InEnvironment { value: ty, environment } }
1534 }
1535
1536 fn new(db: &dyn HirDatabase, krate: CrateId, lexical_env: impl HasResolver, ty: Ty) -> Type {
1537 let resolver = lexical_env.resolver(db.upcast());
1538 let environment = TraitEnvironment::lower(db, &resolver);
1539 Type { krate, ty: InEnvironment { value: ty, environment } }
1540 }
1541
1542 fn from_def(
1543 db: &dyn HirDatabase,
1544 krate: CrateId,
1545 def: impl HasResolver + Into<TyDefId> + Into<GenericDefId>,
1546 ) -> Type {
1547 let substs = Substs::build_for_def(db, def).fill_with_unknown().build();
1548 let ty = db.ty(def.into()).subst(&substs);
1549 Type::new(db, krate, def, ty)
1550 }
1551
1552 pub fn is_unit(&self) -> bool {
1553 matches!(self.ty.value, Ty::Tuple(0, ..))
1554 }
1555 pub fn is_bool(&self) -> bool {
1556 matches!(self.ty.value, Ty::Scalar(Scalar::Bool))
1557 }
1558
1559 pub fn is_mutable_reference(&self) -> bool {
1560 matches!(self.ty.value, Ty::Ref(Mutability::Mut, ..))
1561 }
1562
1563 pub fn remove_ref(&self) -> Option<Type> {
1564 if let Ty::Ref(.., substs) = &self.ty.value {
1565 Some(self.derived(substs[0].clone()))
1566 } else {
1567 None
1568 }
1569 }
1570
1571 pub fn is_unknown(&self) -> bool {
1572 matches!(self.ty.value, Ty::Unknown)
1573 }
1574
1575 /// Checks that particular type `ty` implements `std::future::Future`.
1576 /// This function is used in `.await` syntax completion.
1577 pub fn impls_future(&self, db: &dyn HirDatabase) -> bool {
1578 // No special case for the type of async block, since Chalk can figure it out.
1579
1580 let krate = self.krate;
1581
1582 let std_future_trait =
1583 db.lang_item(krate, "future_trait".into()).and_then(|it| it.as_trait());
1584 let std_future_trait = match std_future_trait {
1585 Some(it) => it,
1586 None => return false,
1587 };
1588
1589 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1590 method_resolution::implements_trait(
1591 &canonical_ty,
1592 db,
1593 self.ty.environment.clone(),
1594 krate,
1595 std_future_trait,
1596 )
1597 }
1598
1599 /// Checks that particular type `ty` implements `std::ops::FnOnce`.
1600 ///
1601 /// This function can be used to check if a particular type is callable, since FnOnce is a
1602 /// supertrait of Fn and FnMut, so all callable types implements at least FnOnce.
1603 pub fn impls_fnonce(&self, db: &dyn HirDatabase) -> bool {
1604 let krate = self.krate;
1605
1606 let fnonce_trait = match FnTrait::FnOnce.get_id(db, krate) {
1607 Some(it) => it,
1608 None => return false,
1609 };
1610
1611 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1612 method_resolution::implements_trait_unique(
1613 &canonical_ty,
1614 db,
1615 self.ty.environment.clone(),
1616 krate,
1617 fnonce_trait,
1618 )
1619 }
1620
1621 pub fn impls_trait(&self, db: &dyn HirDatabase, trait_: Trait, args: &[Type]) -> bool {
1622 let trait_ref = hir_ty::TraitRef {
1623 trait_: trait_.id,
1624 substs: Substs::build_for_def(db, trait_.id)
1625 .push(self.ty.value.clone())
1626 .fill(args.iter().map(|t| t.ty.value.clone()))
1627 .build(),
1628 };
1629
1630 let goal = Canonical {
1631 value: hir_ty::InEnvironment::new(
1632 self.ty.environment.clone(),
1633 hir_ty::Obligation::Trait(trait_ref),
1634 ),
1635 kinds: Arc::new([]),
1636 };
1637
1638 db.trait_solve(self.krate, goal).is_some()
1639 }
1640
1641 pub fn normalize_trait_assoc_type(
1642 &self,
1643 db: &dyn HirDatabase,
1644 trait_: Trait,
1645 args: &[Type],
1646 alias: TypeAlias,
1647 ) -> Option<Type> {
1648 let subst = Substs::build_for_def(db, trait_.id)
1649 .push(self.ty.value.clone())
1650 .fill(args.iter().map(|t| t.ty.value.clone()))
1651 .build();
1652 let predicate = ProjectionPredicate {
1653 projection_ty: ProjectionTy { associated_ty: alias.id, parameters: subst },
1654 ty: Ty::BoundVar(BoundVar::new(DebruijnIndex::INNERMOST, 0)),
1655 };
1656 let goal = Canonical {
1657 value: InEnvironment::new(
1658 self.ty.environment.clone(),
1659 Obligation::Projection(predicate),
1660 ),
1661 kinds: Arc::new([TyVariableKind::General]),
1662 };
1663
1664 match db.trait_solve(self.krate, goal)? {
1665 Solution::Unique(SolutionVariables(subst)) => subst.value.first().cloned(),
1666 Solution::Ambig(_) => None,
1667 }
1668 .map(|ty| Type {
1669 krate: self.krate,
1670 ty: InEnvironment { value: ty, environment: Arc::clone(&self.ty.environment) },
1671 })
1672 }
1673
1674 pub fn is_copy(&self, db: &dyn HirDatabase) -> bool {
1675 let lang_item = db.lang_item(self.krate, SmolStr::new("copy"));
1676 let copy_trait = match lang_item {
1677 Some(LangItemTarget::TraitId(it)) => it,
1678 _ => return false,
1679 };
1680 self.impls_trait(db, copy_trait.into(), &[])
1681 }
1682
1683 pub fn as_callable(&self, db: &dyn HirDatabase) -> Option<Callable> {
1684 let def = match self.ty.value {
1685 Ty::FnDef(def, _) => Some(def),
1686 _ => None,
1687 };
1688
1689 let sig = self.ty.value.callable_sig(db)?;
1690 Some(Callable { ty: self.clone(), sig, def, is_bound_method: false })
1691 }
1692
1693 pub fn is_closure(&self) -> bool {
1694 matches!(&self.ty.value, Ty::Closure { .. })
1695 }
1696
1697 pub fn is_fn(&self) -> bool {
1698 matches!(&self.ty.value, Ty::FnDef(..) | Ty::Function { .. })
1699 }
1700
1701 pub fn is_packed(&self, db: &dyn HirDatabase) -> bool {
1702 let adt_id = match self.ty.value {
1703 Ty::Adt(adt_id, ..) => adt_id,
1704 _ => return false,
1705 };
1706
1707 let adt = adt_id.into();
1708 match adt {
1709 Adt::Struct(s) => matches!(s.repr(db), Some(ReprKind::Packed)),
1710 _ => false,
1711 }
1712 }
1713
1714 pub fn is_raw_ptr(&self) -> bool {
1715 matches!(&self.ty.value, Ty::Raw(..))
1716 }
1717
1718 pub fn contains_unknown(&self) -> bool {
1719 return go(&self.ty.value);
1720
1721 fn go(ty: &Ty) -> bool {
1722 match ty {
1723 Ty::Unknown => true,
1724 _ => ty.substs().map_or(false, |substs| substs.iter().any(go)),
1725 }
1726 }
1727 }
1728
1729 pub fn fields(&self, db: &dyn HirDatabase) -> Vec<(Field, Type)> {
1730 let (variant_id, substs) = match self.ty.value {
1731 Ty::Adt(AdtId::StructId(s), ref substs) => (s.into(), substs),
1732 Ty::Adt(AdtId::UnionId(u), ref substs) => (u.into(), substs),
1733 _ => return Vec::new(),
1734 };
1735
1736 db.field_types(variant_id)
1737 .iter()
1738 .map(|(local_id, ty)| {
1739 let def = Field { parent: variant_id.into(), id: local_id };
1740 let ty = ty.clone().subst(substs);
1741 (def, self.derived(ty))
1742 })
1743 .collect()
1744 }
1745
1746 pub fn tuple_fields(&self, _db: &dyn HirDatabase) -> Vec<Type> {
1747 if let Ty::Tuple(_, substs) = &self.ty.value {
1748 substs.iter().map(|ty| self.derived(ty.clone())).collect()
1749 } else {
1750 Vec::new()
1751 }
1752 }
1753
1754 pub fn autoderef<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Type> + 'a {
1755 // There should be no inference vars in types passed here
1756 // FIXME check that?
1757 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1758 let environment = self.ty.environment.clone();
1759 let ty = InEnvironment { value: canonical, environment };
1760 autoderef(db, Some(self.krate), ty)
1761 .map(|canonical| canonical.value)
1762 .map(move |ty| self.derived(ty))
1763 }
1764
1765 // This would be nicer if it just returned an iterator, but that runs into
1766 // lifetime problems, because we need to borrow temp `CrateImplDefs`.
1767 pub fn iterate_assoc_items<T>(
1768 self,
1769 db: &dyn HirDatabase,
1770 krate: Crate,
1771 mut callback: impl FnMut(AssocItem) -> Option<T>,
1772 ) -> Option<T> {
1773 for krate in self.ty.value.def_crates(db, krate.id)? {
1774 let impls = db.inherent_impls_in_crate(krate);
1775
1776 for impl_def in impls.for_self_ty(&self.ty.value) {
1777 for &item in db.impl_data(*impl_def).items.iter() {
1778 if let Some(result) = callback(item.into()) {
1779 return Some(result);
1780 }
1781 }
1782 }
1783 }
1784 None
1785 }
1786
1787 pub fn type_parameters(&self) -> impl Iterator<Item = Type> + '_ {
1788 self.ty
1789 .value
1790 .strip_references()
1791 .substs()
1792 .into_iter()
1793 .flat_map(|substs| substs.iter())
1794 .map(move |ty| self.derived(ty.clone()))
1795 }
1796
1797 pub fn iterate_method_candidates<T>(
1798 &self,
1799 db: &dyn HirDatabase,
1800 krate: Crate,
1801 traits_in_scope: &FxHashSet<TraitId>,
1802 name: Option<&Name>,
1803 mut callback: impl FnMut(&Ty, Function) -> Option<T>,
1804 ) -> Option<T> {
1805 // There should be no inference vars in types passed here
1806 // FIXME check that?
1807 // FIXME replace Unknown by bound vars here
1808 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1809
1810 let env = self.ty.environment.clone();
1811 let krate = krate.id;
1812
1813 method_resolution::iterate_method_candidates(
1814 &canonical,
1815 db,
1816 env,
1817 krate,
1818 traits_in_scope,
1819 name,
1820 method_resolution::LookupMode::MethodCall,
1821 |ty, it| match it {
1822 AssocItemId::FunctionId(f) => callback(ty, f.into()),
1823 _ => None,
1824 },
1825 )
1826 }
1827
1828 pub fn iterate_path_candidates<T>(
1829 &self,
1830 db: &dyn HirDatabase,
1831 krate: Crate,
1832 traits_in_scope: &FxHashSet<TraitId>,
1833 name: Option<&Name>,
1834 mut callback: impl FnMut(&Ty, AssocItem) -> Option<T>,
1835 ) -> Option<T> {
1836 // There should be no inference vars in types passed here
1837 // FIXME check that?
1838 // FIXME replace Unknown by bound vars here
1839 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1840
1841 let env = self.ty.environment.clone();
1842 let krate = krate.id;
1843
1844 method_resolution::iterate_method_candidates(
1845 &canonical,
1846 db,
1847 env,
1848 krate,
1849 traits_in_scope,
1850 name,
1851 method_resolution::LookupMode::Path,
1852 |ty, it| callback(ty, it.into()),
1853 )
1854 }
1855
1856 pub fn as_adt(&self) -> Option<Adt> {
1857 let (adt, _subst) = self.ty.value.as_adt()?;
1858 Some(adt.into())
1859 }
1860
1861 pub fn as_dyn_trait(&self) -> Option<Trait> {
1862 self.ty.value.dyn_trait().map(Into::into)
1863 }
1864
1865 pub fn as_impl_traits(&self, db: &dyn HirDatabase) -> Option<Vec<Trait>> {
1866 self.ty.value.impl_trait_bounds(db).map(|it| {
1867 it.into_iter()
1868 .filter_map(|pred| match pred {
1869 hir_ty::GenericPredicate::Implemented(trait_ref) => {
1870 Some(Trait::from(trait_ref.trait_))
1871 }
1872 _ => None,
1873 })
1874 .collect()
1875 })
1876 }
1877
1878 pub fn as_associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<Trait> {
1879 self.ty.value.associated_type_parent_trait(db).map(Into::into)
1880 }
1881
1882 // FIXME: provide required accessors such that it becomes implementable from outside.
1883 pub fn is_equal_for_find_impls(&self, other: &Type) -> bool {
1884 let rref = other.remove_ref();
1885 self.ty.value.equals_ctor(rref.as_ref().map_or(&other.ty.value, |it| &it.ty.value))
1886 }
1887
1888 fn derived(&self, ty: Ty) -> Type {
1889 Type {
1890 krate: self.krate,
1891 ty: InEnvironment { value: ty, environment: self.ty.environment.clone() },
1892 }
1893 }
1894
1895 pub fn walk(&self, db: &dyn HirDatabase, mut cb: impl FnMut(Type)) {
1896 // TypeWalk::walk for a Ty at first visits parameters and only after that the Ty itself.
1897 // We need a different order here.
1898
1899 fn walk_substs(
1900 db: &dyn HirDatabase,
1901 type_: &Type,
1902 substs: &Substs,
1903 cb: &mut impl FnMut(Type),
1904 ) {
1905 for ty in substs.iter() {
1906 walk_type(db, &type_.derived(ty.clone()), cb);
1907 }
1908 }
1909
1910 fn walk_bounds(
1911 db: &dyn HirDatabase,
1912 type_: &Type,
1913 bounds: &[GenericPredicate],
1914 cb: &mut impl FnMut(Type),
1915 ) {
1916 for pred in bounds {
1917 match pred {
1918 GenericPredicate::Implemented(trait_ref) => {
1919 cb(type_.clone());
1920 walk_substs(db, type_, &trait_ref.substs, cb);
1921 }
1922 _ => (),
1923 }
1924 }
1925 }
1926
1927 fn walk_type(db: &dyn HirDatabase, type_: &Type, cb: &mut impl FnMut(Type)) {
1928 let ty = type_.ty.value.strip_references();
1929 match ty {
1930 Ty::Adt(..) => {
1931 cb(type_.derived(ty.clone()));
1932 }
1933 Ty::AssociatedType(..) => {
1934 if let Some(_) = ty.associated_type_parent_trait(db) {
1935 cb(type_.derived(ty.clone()));
1936 }
1937 }
1938 Ty::OpaqueType(..) => {
1939 if let Some(bounds) = ty.impl_trait_bounds(db) {
1940 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
1941 }
1942 }
1943 Ty::Alias(AliasTy::Opaque(opaque_ty)) => {
1944 if let Some(bounds) = ty.impl_trait_bounds(db) {
1945 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
1946 }
1947
1948 walk_substs(db, type_, &opaque_ty.parameters, cb);
1949 }
1950 Ty::Placeholder(_) => {
1951 if let Some(bounds) = ty.impl_trait_bounds(db) {
1952 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
1953 }
1954 }
1955 Ty::Dyn(bounds) => {
1956 walk_bounds(db, &type_.derived(ty.clone()), bounds.as_ref(), cb);
1957 }
1958
1959 _ => {}
1960 }
1961 if let Some(substs) = ty.substs() {
1962 walk_substs(db, type_, &substs, cb);
1963 }
1964 }
1965
1966 walk_type(db, self, &mut cb);
1967 }
1968}
1969
1970impl HirDisplay for Type {
1971 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1972 self.ty.value.hir_fmt(f)
1973 }
1974}
1975
1976// FIXME: closures
1977#[derive(Debug)]
1978pub struct Callable {
1979 ty: Type,
1980 sig: CallableSig,
1981 def: Option<CallableDefId>,
1982 pub(crate) is_bound_method: bool,
1983}
1984
1985pub enum CallableKind {
1986 Function(Function),
1987 TupleStruct(Struct),
1988 TupleEnumVariant(Variant),
1989 Closure,
1990}
1991
1992impl Callable {
1993 pub fn kind(&self) -> CallableKind {
1994 match self.def {
1995 Some(CallableDefId::FunctionId(it)) => CallableKind::Function(it.into()),
1996 Some(CallableDefId::StructId(it)) => CallableKind::TupleStruct(it.into()),
1997 Some(CallableDefId::EnumVariantId(it)) => CallableKind::TupleEnumVariant(it.into()),
1998 None => CallableKind::Closure,
1999 }
2000 }
2001 pub fn receiver_param(&self, db: &dyn HirDatabase) -> Option<ast::SelfParam> {
2002 let func = match self.def {
2003 Some(CallableDefId::FunctionId(it)) if self.is_bound_method => it,
2004 _ => return None,
2005 };
2006 let src = func.lookup(db.upcast()).source(db.upcast());
2007 let param_list = src.value.param_list()?;
2008 param_list.self_param()
2009 }
2010 pub fn n_params(&self) -> usize {
2011 self.sig.params().len() - if self.is_bound_method { 1 } else { 0 }
2012 }
2013 pub fn params(
2014 &self,
2015 db: &dyn HirDatabase,
2016 ) -> Vec<(Option<Either<ast::SelfParam, ast::Pat>>, Type)> {
2017 let types = self
2018 .sig
2019 .params()
2020 .iter()
2021 .skip(if self.is_bound_method { 1 } else { 0 })
2022 .map(|ty| self.ty.derived(ty.clone()));
2023 let patterns = match self.def {
2024 Some(CallableDefId::FunctionId(func)) => {
2025 let src = func.lookup(db.upcast()).source(db.upcast());
2026 src.value.param_list().map(|param_list| {
2027 param_list
2028 .self_param()
2029 .map(|it| Some(Either::Left(it)))
2030 .filter(|_| !self.is_bound_method)
2031 .into_iter()
2032 .chain(param_list.params().map(|it| it.pat().map(Either::Right)))
2033 })
2034 }
2035 _ => None,
2036 };
2037 patterns.into_iter().flatten().chain(iter::repeat(None)).zip(types).collect()
2038 }
2039 pub fn return_type(&self) -> Type {
2040 self.ty.derived(self.sig.ret().clone())
2041 }
2042}
2043
2044/// For IDE only
2045#[derive(Debug, PartialEq, Eq, Hash)]
2046pub enum ScopeDef {
2047 ModuleDef(ModuleDef),
2048 MacroDef(MacroDef),
2049 GenericParam(GenericParam),
2050 ImplSelfType(Impl),
2051 AdtSelfType(Adt),
2052 Local(Local),
2053 Unknown,
2054}
2055
2056impl ScopeDef {
2057 pub fn all_items(def: PerNs) -> ArrayVec<[Self; 3]> {
2058 let mut items = ArrayVec::new();
2059
2060 match (def.take_types(), def.take_values()) {
2061 (Some(m1), None) => items.push(ScopeDef::ModuleDef(m1.into())),
2062 (None, Some(m2)) => items.push(ScopeDef::ModuleDef(m2.into())),
2063 (Some(m1), Some(m2)) => {
2064 // Some items, like unit structs and enum variants, are
2065 // returned as both a type and a value. Here we want
2066 // to de-duplicate them.
2067 if m1 != m2 {
2068 items.push(ScopeDef::ModuleDef(m1.into()));
2069 items.push(ScopeDef::ModuleDef(m2.into()));
2070 } else {
2071 items.push(ScopeDef::ModuleDef(m1.into()));
2072 }
2073 }
2074 (None, None) => {}
2075 };
2076
2077 if let Some(macro_def_id) = def.take_macros() {
2078 items.push(ScopeDef::MacroDef(macro_def_id.into()));
2079 }
2080
2081 if items.is_empty() {
2082 items.push(ScopeDef::Unknown);
2083 }
2084
2085 items
2086 }
2087}
2088
2089pub trait HasVisibility {
2090 fn visibility(&self, db: &dyn HirDatabase) -> Visibility;
2091 fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool {
2092 let vis = self.visibility(db);
2093 vis.is_visible_from(db.upcast(), module.id)
2094 }
2095}
diff --git a/crates/hir/src/from_id.rs b/crates/hir/src/from_id.rs
index b5814da11..179b9d51e 100644
--- a/crates/hir/src/from_id.rs
+++ b/crates/hir/src/from_id.rs
@@ -11,9 +11,8 @@ use hir_def::{
11}; 11};
12 12
13use crate::{ 13use crate::{
14 code_model::{BuiltinType, GenericParam}, 14 Adt, AssocItem, BuiltinType, DefWithBody, Field, GenericDef, GenericParam, Label, Local,
15 Adt, AssocItem, DefWithBody, Field, GenericDef, Label, Local, MacroDef, ModuleDef, Variant, 15 MacroDef, ModuleDef, Variant, VariantDef,
16 VariantDef,
17}; 16};
18 17
19macro_rules! from_id { 18macro_rules! from_id {
diff --git a/crates/hir/src/lib.rs b/crates/hir/src/lib.rs
index 69fcdab07..4ef38c0f0 100644
--- a/crates/hir/src/lib.rs
+++ b/crates/hir/src/lib.rs
@@ -20,49 +20,2118 @@
20#![recursion_limit = "512"] 20#![recursion_limit = "512"]
21 21
22mod semantics; 22mod semantics;
23pub mod db;
24mod source_analyzer; 23mod source_analyzer;
25 24
26pub mod diagnostics;
27
28mod from_id; 25mod from_id;
29mod code_model;
30mod attrs; 26mod attrs;
31mod has_source; 27mod has_source;
32 28
29pub mod diagnostics;
30pub mod db;
31
32use std::{iter, sync::Arc};
33
34use arrayvec::ArrayVec;
35use base_db::{CrateDisplayName, CrateId, Edition, FileId};
36use either::Either;
37use hir_def::{
38 adt::{ReprKind, VariantData},
39 expr::{BindingAnnotation, LabelId, Pat, PatId},
40 item_tree::ItemTreeNode,
41 lang_item::LangItemTarget,
42 per_ns::PerNs,
43 resolver::{HasResolver, Resolver},
44 src::HasSource as _,
45 AdtId, AssocContainerId, AssocItemId, AssocItemLoc, AttrDefId, ConstId, ConstParamId,
46 DefWithBodyId, EnumId, FunctionId, GenericDefId, HasModule, ImplId, LifetimeParamId,
47 LocalEnumVariantId, LocalFieldId, Lookup, ModuleId, StaticId, StructId, TraitId, TypeAliasId,
48 TypeParamId, UnionId,
49};
50use hir_expand::{diagnostics::DiagnosticSink, name::name, MacroDefKind};
51use hir_ty::{
52 autoderef,
53 display::{write_bounds_like_dyn_trait_with_prefix, HirDisplayError, HirFormatter},
54 method_resolution,
55 traits::{FnTrait, Solution, SolutionVariables},
56 AliasTy, BoundVar, CallableDefId, CallableSig, Canonical, DebruijnIndex, GenericPredicate,
57 InEnvironment, Obligation, ProjectionPredicate, ProjectionTy, Scalar, Substs, TraitEnvironment,
58 Ty, TyDefId, TyVariableKind,
59};
60use rustc_hash::FxHashSet;
61use stdx::{format_to, impl_from};
62use syntax::{
63 ast::{self, AttrsOwner, NameOwner},
64 AstNode, SmolStr,
65};
66use tt::{Ident, Leaf, Literal, TokenTree};
67
68use crate::db::{DefDatabase, HirDatabase};
69
33pub use crate::{ 70pub use crate::{
34 attrs::{HasAttrs, Namespace}, 71 attrs::{HasAttrs, Namespace},
35 code_model::{
36 Access, Adt, AsAssocItem, AssocItem, AssocItemContainer, BuiltinType, Callable,
37 CallableKind, Const, ConstParam, Crate, CrateDependency, DefWithBody, Enum, Field,
38 FieldSource, Function, GenericDef, GenericParam, HasVisibility, Impl, Label, LifetimeParam,
39 Local, MacroDef, Module, ModuleDef, ScopeDef, Static, Struct, Trait, Type, TypeAlias,
40 TypeParam, Union, Variant, VariantDef,
41 },
42 has_source::HasSource, 72 has_source::HasSource,
43 semantics::{PathResolution, Semantics, SemanticsScope}, 73 semantics::{PathResolution, Semantics, SemanticsScope},
44}; 74};
45 75
46pub use hir_def::{ 76// Be careful with these re-exports.
47 adt::StructKind, 77//
48 attr::{Attrs, Documentation}, 78// `hir` is the boundary between the compiler and the IDE. It should try hard to
49 body::scope::ExprScopes, 79// isolate the compiler from the ide, to allow the two to be refactored
50 find_path::PrefixKind, 80// independently. Re-exporting something from the compiler is the sure way to
51 import_map, 81// breach the boundary.
52 item_scope::ItemInNs, 82//
53 nameres::ModuleSource, 83// Generally, a refactoring which *removes* a name from this list is a good
54 path::{ModPath, PathKind}, 84// idea!
55 type_ref::{Mutability, TypeRef}, 85pub use {
56 visibility::Visibility, 86 hir_def::{
57}; 87 adt::StructKind,
58pub use hir_expand::{ 88 attr::{Attrs, Documentation},
59 name::{known, AsName, Name}, 89 body::scope::ExprScopes,
60 ExpandResult, HirFileId, InFile, MacroCallId, MacroCallLoc, /* FIXME */ MacroDefId, 90 find_path::PrefixKind,
61 MacroFile, Origin, 91 import_map,
92 item_scope::ItemInNs,
93 nameres::ModuleSource,
94 path::{ModPath, PathKind},
95 type_ref::{Mutability, TypeRef},
96 visibility::Visibility,
97 },
98 hir_expand::{
99 name::{known, Name},
100 ExpandResult, HirFileId, InFile, MacroCallId, MacroCallLoc, /* FIXME */ MacroDefId,
101 MacroFile, Origin,
102 },
103 hir_ty::display::HirDisplay,
62}; 104};
63pub use hir_ty::display::HirDisplay;
64 105
65// These are negative re-exports: pub using these names is forbidden, they 106// These are negative re-exports: pub using these names is forbidden, they
66// should remain private to hir internals. 107// should remain private to hir internals.
67#[allow(unused)] 108#[allow(unused)]
68use {hir_def::path::Path, hir_expand::hygiene::Hygiene}; 109use {
110 hir_def::path::Path,
111 hir_expand::{hygiene::Hygiene, name::AsName},
112};
113
114/// hir::Crate describes a single crate. It's the main interface with which
115/// a crate's dependencies interact. Mostly, it should be just a proxy for the
116/// root module.
117#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
118pub struct Crate {
119 pub(crate) id: CrateId,
120}
121
122#[derive(Debug)]
123pub struct CrateDependency {
124 pub krate: Crate,
125 pub name: Name,
126}
127
128impl Crate {
129 pub fn dependencies(self, db: &dyn HirDatabase) -> Vec<CrateDependency> {
130 db.crate_graph()[self.id]
131 .dependencies
132 .iter()
133 .map(|dep| {
134 let krate = Crate { id: dep.crate_id };
135 let name = dep.as_name();
136 CrateDependency { krate, name }
137 })
138 .collect()
139 }
140
141 // FIXME: add `transitive_reverse_dependencies`.
142 pub fn reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
143 let crate_graph = db.crate_graph();
144 crate_graph
145 .iter()
146 .filter(|&krate| {
147 crate_graph[krate].dependencies.iter().any(|it| it.crate_id == self.id)
148 })
149 .map(|id| Crate { id })
150 .collect()
151 }
152
153 pub fn root_module(self, db: &dyn HirDatabase) -> Module {
154 let def_map = db.crate_def_map(self.id);
155 Module { id: def_map.module_id(def_map.root()) }
156 }
157
158 pub fn root_file(self, db: &dyn HirDatabase) -> FileId {
159 db.crate_graph()[self.id].root_file_id
160 }
161
162 pub fn edition(self, db: &dyn HirDatabase) -> Edition {
163 db.crate_graph()[self.id].edition
164 }
165
166 pub fn display_name(self, db: &dyn HirDatabase) -> Option<CrateDisplayName> {
167 db.crate_graph()[self.id].display_name.clone()
168 }
169
170 pub fn query_external_importables(
171 self,
172 db: &dyn DefDatabase,
173 query: import_map::Query,
174 ) -> impl Iterator<Item = Either<ModuleDef, MacroDef>> {
175 import_map::search_dependencies(db, self.into(), query).into_iter().map(|item| match item {
176 ItemInNs::Types(mod_id) | ItemInNs::Values(mod_id) => Either::Left(mod_id.into()),
177 ItemInNs::Macros(mac_id) => Either::Right(mac_id.into()),
178 })
179 }
180
181 pub fn all(db: &dyn HirDatabase) -> Vec<Crate> {
182 db.crate_graph().iter().map(|id| Crate { id }).collect()
183 }
184
185 /// Try to get the root URL of the documentation of a crate.
186 pub fn get_html_root_url(self: &Crate, db: &dyn HirDatabase) -> Option<String> {
187 // Look for #![doc(html_root_url = "...")]
188 let attrs = db.attrs(AttrDefId::ModuleId(self.root_module(db).into()));
189 let doc_attr_q = attrs.by_key("doc");
190
191 if !doc_attr_q.exists() {
192 return None;
193 }
194
195 let doc_url = doc_attr_q.tt_values().map(|tt| {
196 let name = tt.token_trees.iter()
197 .skip_while(|tt| !matches!(tt, TokenTree::Leaf(Leaf::Ident(Ident{text: ref ident, ..})) if ident == "html_root_url"))
198 .skip(2)
199 .next();
200
201 match name {
202 Some(TokenTree::Leaf(Leaf::Literal(Literal{ref text, ..}))) => Some(text),
203 _ => None
204 }
205 }).flat_map(|t| t).next();
206
207 doc_url.map(|s| s.trim_matches('"').trim_end_matches('/').to_owned() + "/")
208 }
209}
210
211#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
212pub struct Module {
213 pub(crate) id: ModuleId,
214}
215
216/// The defs which can be visible in the module.
217#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
218pub enum ModuleDef {
219 Module(Module),
220 Function(Function),
221 Adt(Adt),
222 // Can't be directly declared, but can be imported.
223 Variant(Variant),
224 Const(Const),
225 Static(Static),
226 Trait(Trait),
227 TypeAlias(TypeAlias),
228 BuiltinType(BuiltinType),
229}
230impl_from!(
231 Module,
232 Function,
233 Adt(Struct, Enum, Union),
234 Variant,
235 Const,
236 Static,
237 Trait,
238 TypeAlias,
239 BuiltinType
240 for ModuleDef
241);
242
243impl From<VariantDef> for ModuleDef {
244 fn from(var: VariantDef) -> Self {
245 match var {
246 VariantDef::Struct(t) => Adt::from(t).into(),
247 VariantDef::Union(t) => Adt::from(t).into(),
248 VariantDef::Variant(t) => t.into(),
249 }
250 }
251}
252
253impl ModuleDef {
254 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
255 match self {
256 ModuleDef::Module(it) => it.parent(db),
257 ModuleDef::Function(it) => Some(it.module(db)),
258 ModuleDef::Adt(it) => Some(it.module(db)),
259 ModuleDef::Variant(it) => Some(it.module(db)),
260 ModuleDef::Const(it) => Some(it.module(db)),
261 ModuleDef::Static(it) => Some(it.module(db)),
262 ModuleDef::Trait(it) => Some(it.module(db)),
263 ModuleDef::TypeAlias(it) => Some(it.module(db)),
264 ModuleDef::BuiltinType(_) => None,
265 }
266 }
267
268 pub fn canonical_path(&self, db: &dyn HirDatabase) -> Option<String> {
269 let mut segments = Vec::new();
270 segments.push(self.name(db)?.to_string());
271 for m in self.module(db)?.path_to_root(db) {
272 segments.extend(m.name(db).map(|it| it.to_string()))
273 }
274 segments.reverse();
275 Some(segments.join("::"))
276 }
277
278 pub fn definition_visibility(&self, db: &dyn HirDatabase) -> Option<Visibility> {
279 let module = match self {
280 ModuleDef::Module(it) => it.parent(db)?,
281 ModuleDef::Function(it) => return Some(it.visibility(db)),
282 ModuleDef::Adt(it) => it.module(db),
283 ModuleDef::Variant(it) => {
284 let parent = it.parent_enum(db);
285 let module = it.module(db);
286 return module.visibility_of(db, &ModuleDef::Adt(Adt::Enum(parent)));
287 }
288 ModuleDef::Const(it) => return Some(it.visibility(db)),
289 ModuleDef::Static(it) => it.module(db),
290 ModuleDef::Trait(it) => it.module(db),
291 ModuleDef::TypeAlias(it) => return Some(it.visibility(db)),
292 ModuleDef::BuiltinType(_) => return None,
293 };
294
295 module.visibility_of(db, self)
296 }
297
298 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
299 match self {
300 ModuleDef::Adt(it) => Some(it.name(db)),
301 ModuleDef::Trait(it) => Some(it.name(db)),
302 ModuleDef::Function(it) => Some(it.name(db)),
303 ModuleDef::Variant(it) => Some(it.name(db)),
304 ModuleDef::TypeAlias(it) => Some(it.name(db)),
305 ModuleDef::Module(it) => it.name(db),
306 ModuleDef::Const(it) => it.name(db),
307 ModuleDef::Static(it) => it.name(db),
308
309 ModuleDef::BuiltinType(it) => Some(it.name()),
310 }
311 }
312
313 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
314 let id = match self {
315 ModuleDef::Adt(it) => match it {
316 Adt::Struct(it) => it.id.into(),
317 Adt::Enum(it) => it.id.into(),
318 Adt::Union(it) => it.id.into(),
319 },
320 ModuleDef::Trait(it) => it.id.into(),
321 ModuleDef::Function(it) => it.id.into(),
322 ModuleDef::TypeAlias(it) => it.id.into(),
323 ModuleDef::Module(it) => it.id.into(),
324 ModuleDef::Const(it) => it.id.into(),
325 ModuleDef::Static(it) => it.id.into(),
326 _ => return,
327 };
328
329 let module = match self.module(db) {
330 Some(it) => it,
331 None => return,
332 };
333
334 hir_ty::diagnostics::validate_module_item(db, module.id.krate(), id, sink)
335 }
336}
337
338impl Module {
339 /// Name of this module.
340 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
341 let def_map = self.id.def_map(db.upcast());
342 let parent = def_map[self.id.local_id].parent?;
343 def_map[parent].children.iter().find_map(|(name, module_id)| {
344 if *module_id == self.id.local_id {
345 Some(name.clone())
346 } else {
347 None
348 }
349 })
350 }
351
352 /// Returns the crate this module is part of.
353 pub fn krate(self) -> Crate {
354 Crate { id: self.id.krate() }
355 }
356
357 /// Topmost parent of this module. Every module has a `crate_root`, but some
358 /// might be missing `krate`. This can happen if a module's file is not included
359 /// in the module tree of any target in `Cargo.toml`.
360 pub fn crate_root(self, db: &dyn HirDatabase) -> Module {
361 let def_map = db.crate_def_map(self.id.krate());
362 Module { id: def_map.module_id(def_map.root()) }
363 }
364
365 /// Iterates over all child modules.
366 pub fn children(self, db: &dyn HirDatabase) -> impl Iterator<Item = Module> {
367 let def_map = self.id.def_map(db.upcast());
368 let children = def_map[self.id.local_id]
369 .children
370 .iter()
371 .map(|(_, module_id)| Module { id: def_map.module_id(*module_id) })
372 .collect::<Vec<_>>();
373 children.into_iter()
374 }
375
376 /// Finds a parent module.
377 pub fn parent(self, db: &dyn HirDatabase) -> Option<Module> {
378 // FIXME: handle block expressions as modules (their parent is in a different DefMap)
379 let def_map = self.id.def_map(db.upcast());
380 let parent_id = def_map[self.id.local_id].parent?;
381 Some(Module { id: def_map.module_id(parent_id) })
382 }
383
384 pub fn path_to_root(self, db: &dyn HirDatabase) -> Vec<Module> {
385 let mut res = vec![self];
386 let mut curr = self;
387 while let Some(next) = curr.parent(db) {
388 res.push(next);
389 curr = next
390 }
391 res
392 }
393
394 /// Returns a `ModuleScope`: a set of items, visible in this module.
395 pub fn scope(
396 self,
397 db: &dyn HirDatabase,
398 visible_from: Option<Module>,
399 ) -> Vec<(Name, ScopeDef)> {
400 self.id.def_map(db.upcast())[self.id.local_id]
401 .scope
402 .entries()
403 .filter_map(|(name, def)| {
404 if let Some(m) = visible_from {
405 let filtered =
406 def.filter_visibility(|vis| vis.is_visible_from(db.upcast(), m.id));
407 if filtered.is_none() && !def.is_none() {
408 None
409 } else {
410 Some((name, filtered))
411 }
412 } else {
413 Some((name, def))
414 }
415 })
416 .flat_map(|(name, def)| {
417 ScopeDef::all_items(def).into_iter().map(move |item| (name.clone(), item))
418 })
419 .collect()
420 }
421
422 pub fn visibility_of(self, db: &dyn HirDatabase, def: &ModuleDef) -> Option<Visibility> {
423 self.id.def_map(db.upcast())[self.id.local_id].scope.visibility_of(def.clone().into())
424 }
425
426 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
427 let _p = profile::span("Module::diagnostics").detail(|| {
428 format!("{:?}", self.name(db).map_or("<unknown>".into(), |name| name.to_string()))
429 });
430 let def_map = self.id.def_map(db.upcast());
431 def_map.add_diagnostics(db.upcast(), self.id.local_id, sink);
432 for decl in self.declarations(db) {
433 match decl {
434 crate::ModuleDef::Function(f) => f.diagnostics(db, sink),
435 crate::ModuleDef::Module(m) => {
436 // Only add diagnostics from inline modules
437 if def_map[m.id.local_id].origin.is_inline() {
438 m.diagnostics(db, sink)
439 }
440 }
441 _ => {
442 decl.diagnostics(db, sink);
443 }
444 }
445 }
446
447 for impl_def in self.impl_defs(db) {
448 for item in impl_def.items(db) {
449 if let AssocItem::Function(f) = item {
450 f.diagnostics(db, sink);
451 }
452 }
453 }
454 }
455
456 pub fn declarations(self, db: &dyn HirDatabase) -> Vec<ModuleDef> {
457 let def_map = self.id.def_map(db.upcast());
458 def_map[self.id.local_id].scope.declarations().map(ModuleDef::from).collect()
459 }
460
461 pub fn impl_defs(self, db: &dyn HirDatabase) -> Vec<Impl> {
462 let def_map = self.id.def_map(db.upcast());
463 def_map[self.id.local_id].scope.impls().map(Impl::from).collect()
464 }
465
466 /// Finds a path that can be used to refer to the given item from within
467 /// this module, if possible.
468 pub fn find_use_path(self, db: &dyn DefDatabase, item: impl Into<ItemInNs>) -> Option<ModPath> {
469 hir_def::find_path::find_path(db, item.into(), self.into())
470 }
471
472 /// Finds a path that can be used to refer to the given item from within
473 /// this module, if possible. This is used for returning import paths for use-statements.
474 pub fn find_use_path_prefixed(
475 self,
476 db: &dyn DefDatabase,
477 item: impl Into<ItemInNs>,
478 prefix_kind: PrefixKind,
479 ) -> Option<ModPath> {
480 hir_def::find_path::find_path_prefixed(db, item.into(), self.into(), prefix_kind)
481 }
482}
483
484#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
485pub struct Field {
486 pub(crate) parent: VariantDef,
487 pub(crate) id: LocalFieldId,
488}
489
490#[derive(Debug, PartialEq, Eq)]
491pub enum FieldSource {
492 Named(ast::RecordField),
493 Pos(ast::TupleField),
494}
495
496impl Field {
497 pub fn name(&self, db: &dyn HirDatabase) -> Name {
498 self.parent.variant_data(db).fields()[self.id].name.clone()
499 }
500
501 /// Returns the type as in the signature of the struct (i.e., with
502 /// placeholder types for type parameters). This is good for showing
503 /// signature help, but not so good to actually get the type of the field
504 /// when you actually have a variable of the struct.
505 pub fn signature_ty(&self, db: &dyn HirDatabase) -> Type {
506 let var_id = self.parent.into();
507 let generic_def_id: GenericDefId = match self.parent {
508 VariantDef::Struct(it) => it.id.into(),
509 VariantDef::Union(it) => it.id.into(),
510 VariantDef::Variant(it) => it.parent.id.into(),
511 };
512 let substs = Substs::type_params(db, generic_def_id);
513 let ty = db.field_types(var_id)[self.id].clone().subst(&substs);
514 Type::new(db, self.parent.module(db).id.krate(), var_id, ty)
515 }
516
517 pub fn parent_def(&self, _db: &dyn HirDatabase) -> VariantDef {
518 self.parent
519 }
520}
521
522impl HasVisibility for Field {
523 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
524 let variant_data = self.parent.variant_data(db);
525 let visibility = &variant_data.fields()[self.id].visibility;
526 let parent_id: hir_def::VariantId = self.parent.into();
527 visibility.resolve(db.upcast(), &parent_id.resolver(db.upcast()))
528 }
529}
530
531#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
532pub struct Struct {
533 pub(crate) id: StructId,
534}
535
536impl Struct {
537 pub fn module(self, db: &dyn HirDatabase) -> Module {
538 Module { id: self.id.lookup(db.upcast()).container }
539 }
540
541 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
542 Some(self.module(db).krate())
543 }
544
545 pub fn name(self, db: &dyn HirDatabase) -> Name {
546 db.struct_data(self.id).name.clone()
547 }
548
549 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
550 db.struct_data(self.id)
551 .variant_data
552 .fields()
553 .iter()
554 .map(|(id, _)| Field { parent: self.into(), id })
555 .collect()
556 }
557
558 pub fn ty(self, db: &dyn HirDatabase) -> Type {
559 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
560 }
561
562 pub fn repr(self, db: &dyn HirDatabase) -> Option<ReprKind> {
563 db.struct_data(self.id).repr.clone()
564 }
565
566 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
567 self.variant_data(db).kind()
568 }
569
570 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
571 db.struct_data(self.id).variant_data.clone()
572 }
573}
574
575#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
576pub struct Union {
577 pub(crate) id: UnionId,
578}
579
580impl Union {
581 pub fn name(self, db: &dyn HirDatabase) -> Name {
582 db.union_data(self.id).name.clone()
583 }
584
585 pub fn module(self, db: &dyn HirDatabase) -> Module {
586 Module { id: self.id.lookup(db.upcast()).container }
587 }
588
589 pub fn ty(self, db: &dyn HirDatabase) -> Type {
590 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
591 }
592
593 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
594 db.union_data(self.id)
595 .variant_data
596 .fields()
597 .iter()
598 .map(|(id, _)| Field { parent: self.into(), id })
599 .collect()
600 }
601
602 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
603 db.union_data(self.id).variant_data.clone()
604 }
605}
606
607#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
608pub struct Enum {
609 pub(crate) id: EnumId,
610}
611
612impl Enum {
613 pub fn module(self, db: &dyn HirDatabase) -> Module {
614 Module { id: self.id.lookup(db.upcast()).container }
615 }
616
617 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
618 Some(self.module(db).krate())
619 }
620
621 pub fn name(self, db: &dyn HirDatabase) -> Name {
622 db.enum_data(self.id).name.clone()
623 }
624
625 pub fn variants(self, db: &dyn HirDatabase) -> Vec<Variant> {
626 db.enum_data(self.id).variants.iter().map(|(id, _)| Variant { parent: self, id }).collect()
627 }
628
629 pub fn ty(self, db: &dyn HirDatabase) -> Type {
630 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
631 }
632}
633
634#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
635pub struct Variant {
636 pub(crate) parent: Enum,
637 pub(crate) id: LocalEnumVariantId,
638}
639
640impl Variant {
641 pub fn module(self, db: &dyn HirDatabase) -> Module {
642 self.parent.module(db)
643 }
644 pub fn parent_enum(self, _db: &dyn HirDatabase) -> Enum {
645 self.parent
646 }
647
648 pub fn name(self, db: &dyn HirDatabase) -> Name {
649 db.enum_data(self.parent.id).variants[self.id].name.clone()
650 }
651
652 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
653 self.variant_data(db)
654 .fields()
655 .iter()
656 .map(|(id, _)| Field { parent: self.into(), id })
657 .collect()
658 }
659
660 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
661 self.variant_data(db).kind()
662 }
663
664 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
665 db.enum_data(self.parent.id).variants[self.id].variant_data.clone()
666 }
667}
668
669/// A Data Type
670#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
671pub enum Adt {
672 Struct(Struct),
673 Union(Union),
674 Enum(Enum),
675}
676impl_from!(Struct, Union, Enum for Adt);
677
678impl Adt {
679 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
680 let subst = db.generic_defaults(self.into());
681 subst.iter().any(|ty| &ty.value == &Ty::Unknown)
682 }
683
684 /// Turns this ADT into a type. Any type parameters of the ADT will be
685 /// turned into unknown types, which is good for e.g. finding the most
686 /// general set of completions, but will not look very nice when printed.
687 pub fn ty(self, db: &dyn HirDatabase) -> Type {
688 let id = AdtId::from(self);
689 Type::from_def(db, id.module(db.upcast()).krate(), id)
690 }
691
692 pub fn module(self, db: &dyn HirDatabase) -> Module {
693 match self {
694 Adt::Struct(s) => s.module(db),
695 Adt::Union(s) => s.module(db),
696 Adt::Enum(e) => e.module(db),
697 }
698 }
699
700 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
701 Some(self.module(db).krate())
702 }
703
704 pub fn name(self, db: &dyn HirDatabase) -> Name {
705 match self {
706 Adt::Struct(s) => s.name(db),
707 Adt::Union(u) => u.name(db),
708 Adt::Enum(e) => e.name(db),
709 }
710 }
711}
712
713#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
714pub enum VariantDef {
715 Struct(Struct),
716 Union(Union),
717 Variant(Variant),
718}
719impl_from!(Struct, Union, Variant for VariantDef);
720
721impl VariantDef {
722 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
723 match self {
724 VariantDef::Struct(it) => it.fields(db),
725 VariantDef::Union(it) => it.fields(db),
726 VariantDef::Variant(it) => it.fields(db),
727 }
728 }
729
730 pub fn module(self, db: &dyn HirDatabase) -> Module {
731 match self {
732 VariantDef::Struct(it) => it.module(db),
733 VariantDef::Union(it) => it.module(db),
734 VariantDef::Variant(it) => it.module(db),
735 }
736 }
737
738 pub fn name(&self, db: &dyn HirDatabase) -> Name {
739 match self {
740 VariantDef::Struct(s) => s.name(db),
741 VariantDef::Union(u) => u.name(db),
742 VariantDef::Variant(e) => e.name(db),
743 }
744 }
745
746 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
747 match self {
748 VariantDef::Struct(it) => it.variant_data(db),
749 VariantDef::Union(it) => it.variant_data(db),
750 VariantDef::Variant(it) => it.variant_data(db),
751 }
752 }
753}
754
755/// The defs which have a body.
756#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
757pub enum DefWithBody {
758 Function(Function),
759 Static(Static),
760 Const(Const),
761}
762impl_from!(Function, Const, Static for DefWithBody);
763
764impl DefWithBody {
765 pub fn module(self, db: &dyn HirDatabase) -> Module {
766 match self {
767 DefWithBody::Const(c) => c.module(db),
768 DefWithBody::Function(f) => f.module(db),
769 DefWithBody::Static(s) => s.module(db),
770 }
771 }
772
773 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
774 match self {
775 DefWithBody::Function(f) => Some(f.name(db)),
776 DefWithBody::Static(s) => s.name(db),
777 DefWithBody::Const(c) => c.name(db),
778 }
779 }
780}
781
782#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
783pub struct Function {
784 pub(crate) id: FunctionId,
785}
786
787impl Function {
788 pub fn module(self, db: &dyn HirDatabase) -> Module {
789 self.id.lookup(db.upcast()).module(db.upcast()).into()
790 }
791
792 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
793 Some(self.module(db).krate())
794 }
795
796 pub fn name(self, db: &dyn HirDatabase) -> Name {
797 db.function_data(self.id).name.clone()
798 }
799
800 /// Get this function's return type
801 pub fn ret_type(self, db: &dyn HirDatabase) -> Type {
802 let resolver = self.id.resolver(db.upcast());
803 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
804 let ret_type = &db.function_data(self.id).ret_type;
805 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
806 let ty = Ty::from_hir_ext(&ctx, ret_type).0;
807 Type::new_with_resolver_inner(db, krate, &resolver, ty)
808 }
809
810 pub fn self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
811 if !db.function_data(self.id).has_self_param {
812 return None;
813 }
814 Some(SelfParam { func: self.id })
815 }
816
817 pub fn assoc_fn_params(self, db: &dyn HirDatabase) -> Vec<Param> {
818 let resolver = self.id.resolver(db.upcast());
819 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
820 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
821 let environment = TraitEnvironment::lower(db, &resolver);
822 db.function_data(self.id)
823 .params
824 .iter()
825 .map(|type_ref| {
826 let ty = Type {
827 krate,
828 ty: InEnvironment {
829 value: Ty::from_hir_ext(&ctx, type_ref).0,
830 environment: environment.clone(),
831 },
832 };
833 Param { ty }
834 })
835 .collect()
836 }
837 pub fn method_params(self, db: &dyn HirDatabase) -> Option<Vec<Param>> {
838 if self.self_param(db).is_none() {
839 return None;
840 }
841 let mut res = self.assoc_fn_params(db);
842 res.remove(0);
843 Some(res)
844 }
845
846 pub fn is_unsafe(self, db: &dyn HirDatabase) -> bool {
847 db.function_data(self.id).is_unsafe
848 }
849
850 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
851 let krate = self.module(db).id.krate();
852 hir_def::diagnostics::validate_body(db.upcast(), self.id.into(), sink);
853 hir_ty::diagnostics::validate_module_item(db, krate, self.id.into(), sink);
854 hir_ty::diagnostics::validate_body(db, self.id.into(), sink);
855 }
856
857 /// Whether this function declaration has a definition.
858 ///
859 /// This is false in the case of required (not provided) trait methods.
860 pub fn has_body(self, db: &dyn HirDatabase) -> bool {
861 db.function_data(self.id).has_body
862 }
863
864 /// A textual representation of the HIR of this function for debugging purposes.
865 pub fn debug_hir(self, db: &dyn HirDatabase) -> String {
866 let body = db.body(self.id.into());
867
868 let mut result = String::new();
869 format_to!(result, "HIR expressions in the body of `{}`:\n", self.name(db));
870 for (id, expr) in body.exprs.iter() {
871 format_to!(result, "{:?}: {:?}\n", id, expr);
872 }
873
874 result
875 }
876}
877
878// Note: logically, this belongs to `hir_ty`, but we are not using it there yet.
879pub enum Access {
880 Shared,
881 Exclusive,
882 Owned,
883}
884
885impl From<hir_ty::Mutability> for Access {
886 fn from(mutability: hir_ty::Mutability) -> Access {
887 match mutability {
888 hir_ty::Mutability::Not => Access::Shared,
889 hir_ty::Mutability::Mut => Access::Exclusive,
890 }
891 }
892}
893
894#[derive(Debug)]
895pub struct Param {
896 ty: Type,
897}
898
899impl Param {
900 pub fn ty(&self) -> &Type {
901 &self.ty
902 }
903}
904
905#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
906pub struct SelfParam {
907 func: FunctionId,
908}
909
910impl SelfParam {
911 pub fn access(self, db: &dyn HirDatabase) -> Access {
912 let func_data = db.function_data(self.func);
913 func_data
914 .params
915 .first()
916 .map(|param| match *param {
917 TypeRef::Reference(.., mutability) => match mutability {
918 hir_def::type_ref::Mutability::Shared => Access::Shared,
919 hir_def::type_ref::Mutability::Mut => Access::Exclusive,
920 },
921 _ => Access::Owned,
922 })
923 .unwrap_or(Access::Owned)
924 }
925}
926
927impl HasVisibility for Function {
928 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
929 let function_data = db.function_data(self.id);
930 let visibility = &function_data.visibility;
931 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
932 }
933}
934
935#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
936pub struct Const {
937 pub(crate) id: ConstId,
938}
939
940impl Const {
941 pub fn module(self, db: &dyn HirDatabase) -> Module {
942 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
943 }
944
945 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
946 Some(self.module(db).krate())
947 }
948
949 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
950 db.const_data(self.id).name.clone()
951 }
952}
953
954impl HasVisibility for Const {
955 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
956 let function_data = db.const_data(self.id);
957 let visibility = &function_data.visibility;
958 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
959 }
960}
961
962#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
963pub struct Static {
964 pub(crate) id: StaticId,
965}
966
967impl Static {
968 pub fn module(self, db: &dyn HirDatabase) -> Module {
969 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
970 }
971
972 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
973 Some(self.module(db).krate())
974 }
975
976 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
977 db.static_data(self.id).name.clone()
978 }
979
980 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
981 db.static_data(self.id).mutable
982 }
983}
984
985#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
986pub struct Trait {
987 pub(crate) id: TraitId,
988}
989
990impl Trait {
991 pub fn module(self, db: &dyn HirDatabase) -> Module {
992 Module { id: self.id.lookup(db.upcast()).container }
993 }
994
995 pub fn name(self, db: &dyn HirDatabase) -> Name {
996 db.trait_data(self.id).name.clone()
997 }
998
999 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1000 db.trait_data(self.id).items.iter().map(|(_name, it)| (*it).into()).collect()
1001 }
1002
1003 pub fn is_auto(self, db: &dyn HirDatabase) -> bool {
1004 db.trait_data(self.id).auto
1005 }
1006}
1007
1008#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1009pub struct TypeAlias {
1010 pub(crate) id: TypeAliasId,
1011}
1012
1013impl TypeAlias {
1014 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
1015 let subst = db.generic_defaults(self.id.into());
1016 subst.iter().any(|ty| &ty.value == &Ty::Unknown)
1017 }
1018
1019 pub fn module(self, db: &dyn HirDatabase) -> Module {
1020 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1021 }
1022
1023 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
1024 Some(self.module(db).krate())
1025 }
1026
1027 pub fn type_ref(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1028 db.type_alias_data(self.id).type_ref.clone()
1029 }
1030
1031 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1032 Type::from_def(db, self.id.lookup(db.upcast()).module(db.upcast()).krate(), self.id)
1033 }
1034
1035 pub fn name(self, db: &dyn HirDatabase) -> Name {
1036 db.type_alias_data(self.id).name.clone()
1037 }
1038}
1039
1040impl HasVisibility for TypeAlias {
1041 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1042 let function_data = db.type_alias_data(self.id);
1043 let visibility = &function_data.visibility;
1044 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1045 }
1046}
1047
1048#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1049pub struct BuiltinType {
1050 pub(crate) inner: hir_def::builtin_type::BuiltinType,
1051}
1052
1053impl BuiltinType {
1054 pub fn ty(self, db: &dyn HirDatabase, module: Module) -> Type {
1055 let resolver = module.id.resolver(db.upcast());
1056 Type::new_with_resolver(db, &resolver, Ty::builtin(self.inner))
1057 .expect("crate not present in resolver")
1058 }
1059
1060 pub fn name(self) -> Name {
1061 self.inner.as_name()
1062 }
1063}
1064
1065#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1066pub struct MacroDef {
1067 pub(crate) id: MacroDefId,
1068}
1069
1070impl MacroDef {
1071 /// FIXME: right now, this just returns the root module of the crate that
1072 /// defines this macro. The reasons for this is that macros are expanded
1073 /// early, in `hir_expand`, where modules simply do not exist yet.
1074 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
1075 let krate = self.id.krate;
1076 let def_map = db.crate_def_map(krate);
1077 let module_id = def_map.root();
1078 Some(Module { id: def_map.module_id(module_id) })
1079 }
1080
1081 /// XXX: this parses the file
1082 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1083 self.source(db)?.value.name().map(|it| it.as_name())
1084 }
1085
1086 /// Indicate it is a proc-macro
1087 pub fn is_proc_macro(&self) -> bool {
1088 matches!(self.id.kind, MacroDefKind::ProcMacro(_))
1089 }
1090
1091 /// Indicate it is a derive macro
1092 pub fn is_derive_macro(&self) -> bool {
1093 matches!(self.id.kind, MacroDefKind::ProcMacro(_) | MacroDefKind::BuiltInDerive(_))
1094 }
1095}
1096
1097/// Invariant: `inner.as_assoc_item(db).is_some()`
1098/// We do not actively enforce this invariant.
1099#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1100pub enum AssocItem {
1101 Function(Function),
1102 Const(Const),
1103 TypeAlias(TypeAlias),
1104}
1105#[derive(Debug)]
1106pub enum AssocItemContainer {
1107 Trait(Trait),
1108 Impl(Impl),
1109}
1110pub trait AsAssocItem {
1111 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>;
1112}
1113
1114impl AsAssocItem for Function {
1115 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1116 as_assoc_item(db, AssocItem::Function, self.id)
1117 }
1118}
1119impl AsAssocItem for Const {
1120 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1121 as_assoc_item(db, AssocItem::Const, self.id)
1122 }
1123}
1124impl AsAssocItem for TypeAlias {
1125 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1126 as_assoc_item(db, AssocItem::TypeAlias, self.id)
1127 }
1128}
1129impl AsAssocItem for ModuleDef {
1130 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1131 match self {
1132 ModuleDef::Function(it) => it.as_assoc_item(db),
1133 ModuleDef::Const(it) => it.as_assoc_item(db),
1134 ModuleDef::TypeAlias(it) => it.as_assoc_item(db),
1135 _ => None,
1136 }
1137 }
1138}
1139fn as_assoc_item<ID, DEF, CTOR, AST>(db: &dyn HirDatabase, ctor: CTOR, id: ID) -> Option<AssocItem>
1140where
1141 ID: Lookup<Data = AssocItemLoc<AST>>,
1142 DEF: From<ID>,
1143 CTOR: FnOnce(DEF) -> AssocItem,
1144 AST: ItemTreeNode,
1145{
1146 match id.lookup(db.upcast()).container {
1147 AssocContainerId::TraitId(_) | AssocContainerId::ImplId(_) => Some(ctor(DEF::from(id))),
1148 AssocContainerId::ModuleId(_) => None,
1149 }
1150}
1151
1152impl AssocItem {
1153 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1154 match self {
1155 AssocItem::Function(it) => Some(it.name(db)),
1156 AssocItem::Const(it) => it.name(db),
1157 AssocItem::TypeAlias(it) => Some(it.name(db)),
1158 }
1159 }
1160 pub fn module(self, db: &dyn HirDatabase) -> Module {
1161 match self {
1162 AssocItem::Function(f) => f.module(db),
1163 AssocItem::Const(c) => c.module(db),
1164 AssocItem::TypeAlias(t) => t.module(db),
1165 }
1166 }
1167 pub fn container(self, db: &dyn HirDatabase) -> AssocItemContainer {
1168 let container = match self {
1169 AssocItem::Function(it) => it.id.lookup(db.upcast()).container,
1170 AssocItem::Const(it) => it.id.lookup(db.upcast()).container,
1171 AssocItem::TypeAlias(it) => it.id.lookup(db.upcast()).container,
1172 };
1173 match container {
1174 AssocContainerId::TraitId(id) => AssocItemContainer::Trait(id.into()),
1175 AssocContainerId::ImplId(id) => AssocItemContainer::Impl(id.into()),
1176 AssocContainerId::ModuleId(_) => panic!("invalid AssocItem"),
1177 }
1178 }
1179
1180 pub fn containing_trait(self, db: &dyn HirDatabase) -> Option<Trait> {
1181 match self.container(db) {
1182 AssocItemContainer::Trait(t) => Some(t),
1183 _ => None,
1184 }
1185 }
1186}
1187
1188impl HasVisibility for AssocItem {
1189 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1190 match self {
1191 AssocItem::Function(f) => f.visibility(db),
1192 AssocItem::Const(c) => c.visibility(db),
1193 AssocItem::TypeAlias(t) => t.visibility(db),
1194 }
1195 }
1196}
1197
1198#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1199pub enum GenericDef {
1200 Function(Function),
1201 Adt(Adt),
1202 Trait(Trait),
1203 TypeAlias(TypeAlias),
1204 Impl(Impl),
1205 // enum variants cannot have generics themselves, but their parent enums
1206 // can, and this makes some code easier to write
1207 Variant(Variant),
1208 // consts can have type parameters from their parents (i.e. associated consts of traits)
1209 Const(Const),
1210}
1211impl_from!(
1212 Function,
1213 Adt(Struct, Enum, Union),
1214 Trait,
1215 TypeAlias,
1216 Impl,
1217 Variant,
1218 Const
1219 for GenericDef
1220);
1221
1222impl GenericDef {
1223 pub fn params(self, db: &dyn HirDatabase) -> Vec<GenericParam> {
1224 let generics = db.generic_params(self.into());
1225 let ty_params = generics
1226 .types
1227 .iter()
1228 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1229 .map(GenericParam::TypeParam);
1230 let lt_params = generics
1231 .lifetimes
1232 .iter()
1233 .map(|(local_id, _)| LifetimeParam {
1234 id: LifetimeParamId { parent: self.into(), local_id },
1235 })
1236 .map(GenericParam::LifetimeParam);
1237 let const_params = generics
1238 .consts
1239 .iter()
1240 .map(|(local_id, _)| ConstParam { id: ConstParamId { parent: self.into(), local_id } })
1241 .map(GenericParam::ConstParam);
1242 ty_params.chain(lt_params).chain(const_params).collect()
1243 }
1244
1245 pub fn type_params(self, db: &dyn HirDatabase) -> Vec<TypeParam> {
1246 let generics = db.generic_params(self.into());
1247 generics
1248 .types
1249 .iter()
1250 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1251 .collect()
1252 }
1253}
1254
1255#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1256pub struct Local {
1257 pub(crate) parent: DefWithBodyId,
1258 pub(crate) pat_id: PatId,
1259}
1260
1261impl Local {
1262 pub fn is_param(self, db: &dyn HirDatabase) -> bool {
1263 let src = self.source(db);
1264 match src.value {
1265 Either::Left(bind_pat) => {
1266 bind_pat.syntax().ancestors().any(|it| ast::Param::can_cast(it.kind()))
1267 }
1268 Either::Right(_self_param) => true,
1269 }
1270 }
1271
1272 // FIXME: why is this an option? It shouldn't be?
1273 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1274 let body = db.body(self.parent.into());
1275 match &body[self.pat_id] {
1276 Pat::Bind { name, .. } => Some(name.clone()),
1277 _ => None,
1278 }
1279 }
1280
1281 pub fn is_self(self, db: &dyn HirDatabase) -> bool {
1282 self.name(db) == Some(name![self])
1283 }
1284
1285 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1286 let body = db.body(self.parent.into());
1287 matches!(&body[self.pat_id], Pat::Bind { mode: BindingAnnotation::Mutable, .. })
1288 }
1289
1290 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1291 self.parent.into()
1292 }
1293
1294 pub fn module(self, db: &dyn HirDatabase) -> Module {
1295 self.parent(db).module(db)
1296 }
1297
1298 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1299 let def = DefWithBodyId::from(self.parent);
1300 let infer = db.infer(def);
1301 let ty = infer[self.pat_id].clone();
1302 let krate = def.module(db.upcast()).krate();
1303 Type::new(db, krate, def, ty)
1304 }
1305
1306 pub fn source(self, db: &dyn HirDatabase) -> InFile<Either<ast::IdentPat, ast::SelfParam>> {
1307 let (_body, source_map) = db.body_with_source_map(self.parent.into());
1308 let src = source_map.pat_syntax(self.pat_id).unwrap(); // Hmm...
1309 let root = src.file_syntax(db.upcast());
1310 src.map(|ast| {
1311 ast.map_left(|it| it.cast().unwrap().to_node(&root)).map_right(|it| it.to_node(&root))
1312 })
1313 }
1314}
1315
1316#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1317pub struct Label {
1318 pub(crate) parent: DefWithBodyId,
1319 pub(crate) label_id: LabelId,
1320}
1321
1322impl Label {
1323 pub fn module(self, db: &dyn HirDatabase) -> Module {
1324 self.parent(db).module(db)
1325 }
1326
1327 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1328 self.parent.into()
1329 }
1330
1331 pub fn name(self, db: &dyn HirDatabase) -> Name {
1332 let body = db.body(self.parent.into());
1333 body[self.label_id].name.clone()
1334 }
1335
1336 pub fn source(self, db: &dyn HirDatabase) -> InFile<ast::Label> {
1337 let (_body, source_map) = db.body_with_source_map(self.parent.into());
1338 let src = source_map.label_syntax(self.label_id);
1339 let root = src.file_syntax(db.upcast());
1340 src.map(|ast| ast.to_node(&root))
1341 }
1342}
1343
1344#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1345pub enum GenericParam {
1346 TypeParam(TypeParam),
1347 LifetimeParam(LifetimeParam),
1348 ConstParam(ConstParam),
1349}
1350impl_from!(TypeParam, LifetimeParam, ConstParam for GenericParam);
1351
1352impl GenericParam {
1353 pub fn module(self, db: &dyn HirDatabase) -> Module {
1354 match self {
1355 GenericParam::TypeParam(it) => it.module(db),
1356 GenericParam::LifetimeParam(it) => it.module(db),
1357 GenericParam::ConstParam(it) => it.module(db),
1358 }
1359 }
1360
1361 pub fn name(self, db: &dyn HirDatabase) -> Name {
1362 match self {
1363 GenericParam::TypeParam(it) => it.name(db),
1364 GenericParam::LifetimeParam(it) => it.name(db),
1365 GenericParam::ConstParam(it) => it.name(db),
1366 }
1367 }
1368}
1369
1370#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1371pub struct TypeParam {
1372 pub(crate) id: TypeParamId,
1373}
1374
1375impl TypeParam {
1376 pub fn name(self, db: &dyn HirDatabase) -> Name {
1377 let params = db.generic_params(self.id.parent);
1378 params.types[self.id.local_id].name.clone().unwrap_or_else(Name::missing)
1379 }
1380
1381 pub fn module(self, db: &dyn HirDatabase) -> Module {
1382 self.id.parent.module(db.upcast()).into()
1383 }
1384
1385 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1386 let resolver = self.id.parent.resolver(db.upcast());
1387 let krate = self.id.parent.module(db.upcast()).krate();
1388 let ty = Ty::Placeholder(self.id);
1389 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1390 }
1391
1392 pub fn trait_bounds(self, db: &dyn HirDatabase) -> Vec<Trait> {
1393 db.generic_predicates_for_param(self.id)
1394 .into_iter()
1395 .filter_map(|pred| match &pred.value {
1396 hir_ty::GenericPredicate::Implemented(trait_ref) => {
1397 Some(Trait::from(trait_ref.trait_))
1398 }
1399 _ => None,
1400 })
1401 .collect()
1402 }
1403
1404 pub fn default(self, db: &dyn HirDatabase) -> Option<Type> {
1405 let params = db.generic_defaults(self.id.parent);
1406 let local_idx = hir_ty::param_idx(db, self.id)?;
1407 let resolver = self.id.parent.resolver(db.upcast());
1408 let krate = self.id.parent.module(db.upcast()).krate();
1409 let ty = params.get(local_idx)?.clone();
1410 let subst = Substs::type_params(db, self.id.parent);
1411 let ty = ty.subst(&subst.prefix(local_idx));
1412 Some(Type::new_with_resolver_inner(db, krate, &resolver, ty))
1413 }
1414}
1415
1416impl HirDisplay for TypeParam {
1417 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1418 write!(f, "{}", self.name(f.db))?;
1419 let bounds = f.db.generic_predicates_for_param(self.id);
1420 let substs = Substs::type_params(f.db, self.id.parent);
1421 let predicates = bounds.iter().cloned().map(|b| b.subst(&substs)).collect::<Vec<_>>();
1422 if !(predicates.is_empty() || f.omit_verbose_types()) {
1423 write_bounds_like_dyn_trait_with_prefix(":", &predicates, f)?;
1424 }
1425 Ok(())
1426 }
1427}
1428
1429#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1430pub struct LifetimeParam {
1431 pub(crate) id: LifetimeParamId,
1432}
1433
1434impl LifetimeParam {
1435 pub fn name(self, db: &dyn HirDatabase) -> Name {
1436 let params = db.generic_params(self.id.parent);
1437 params.lifetimes[self.id.local_id].name.clone()
1438 }
1439
1440 pub fn module(self, db: &dyn HirDatabase) -> Module {
1441 self.id.parent.module(db.upcast()).into()
1442 }
1443
1444 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1445 self.id.parent.into()
1446 }
1447}
1448
1449#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1450pub struct ConstParam {
1451 pub(crate) id: ConstParamId,
1452}
1453
1454impl ConstParam {
1455 pub fn name(self, db: &dyn HirDatabase) -> Name {
1456 let params = db.generic_params(self.id.parent);
1457 params.consts[self.id.local_id].name.clone()
1458 }
1459
1460 pub fn module(self, db: &dyn HirDatabase) -> Module {
1461 self.id.parent.module(db.upcast()).into()
1462 }
1463
1464 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1465 self.id.parent.into()
1466 }
1467
1468 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1469 let def = self.id.parent;
1470 let krate = def.module(db.upcast()).krate();
1471 Type::new(db, krate, def, db.const_param_ty(self.id))
1472 }
1473}
1474
1475#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1476pub struct Impl {
1477 pub(crate) id: ImplId,
1478}
1479
1480impl Impl {
1481 pub fn all_in_crate(db: &dyn HirDatabase, krate: Crate) -> Vec<Impl> {
1482 let inherent = db.inherent_impls_in_crate(krate.id);
1483 let trait_ = db.trait_impls_in_crate(krate.id);
1484
1485 inherent.all_impls().chain(trait_.all_impls()).map(Self::from).collect()
1486 }
1487 pub fn for_trait(db: &dyn HirDatabase, krate: Crate, trait_: Trait) -> Vec<Impl> {
1488 let impls = db.trait_impls_in_crate(krate.id);
1489 impls.for_trait(trait_.id).map(Self::from).collect()
1490 }
1491
1492 // FIXME: the return type is wrong. This should be a hir version of
1493 // `TraitRef` (ie, resolved `TypeRef`).
1494 pub fn target_trait(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1495 db.impl_data(self.id).target_trait.clone()
1496 }
1497
1498 pub fn target_ty(self, db: &dyn HirDatabase) -> Type {
1499 let impl_data = db.impl_data(self.id);
1500 let resolver = self.id.resolver(db.upcast());
1501 let krate = self.id.lookup(db.upcast()).container.krate();
1502 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1503 let ty = Ty::from_hir(&ctx, &impl_data.target_type);
1504 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1505 }
1506
1507 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1508 db.impl_data(self.id).items.iter().map(|it| (*it).into()).collect()
1509 }
1510
1511 pub fn is_negative(self, db: &dyn HirDatabase) -> bool {
1512 db.impl_data(self.id).is_negative
1513 }
1514
1515 pub fn module(self, db: &dyn HirDatabase) -> Module {
1516 self.id.lookup(db.upcast()).container.into()
1517 }
1518
1519 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1520 Crate { id: self.module(db).id.krate() }
1521 }
1522
1523 pub fn is_builtin_derive(self, db: &dyn HirDatabase) -> Option<InFile<ast::Attr>> {
1524 let src = self.source(db)?;
1525 let item = src.file_id.is_builtin_derive(db.upcast())?;
1526 let hygenic = hir_expand::hygiene::Hygiene::new(db.upcast(), item.file_id);
1527
1528 // FIXME: handle `cfg_attr`
1529 let attr = item
1530 .value
1531 .attrs()
1532 .filter_map(|it| {
1533 let path = ModPath::from_src(it.path()?, &hygenic)?;
1534 if path.as_ident()?.to_string() == "derive" {
1535 Some(it)
1536 } else {
1537 None
1538 }
1539 })
1540 .last()?;
1541
1542 Some(item.with_value(attr))
1543 }
1544}
1545
1546#[derive(Clone, PartialEq, Eq, Debug)]
1547pub struct Type {
1548 krate: CrateId,
1549 ty: InEnvironment<Ty>,
1550}
1551
1552impl Type {
1553 pub(crate) fn new_with_resolver(
1554 db: &dyn HirDatabase,
1555 resolver: &Resolver,
1556 ty: Ty,
1557 ) -> Option<Type> {
1558 let krate = resolver.krate()?;
1559 Some(Type::new_with_resolver_inner(db, krate, resolver, ty))
1560 }
1561 pub(crate) fn new_with_resolver_inner(
1562 db: &dyn HirDatabase,
1563 krate: CrateId,
1564 resolver: &Resolver,
1565 ty: Ty,
1566 ) -> Type {
1567 let environment = TraitEnvironment::lower(db, &resolver);
1568 Type { krate, ty: InEnvironment { value: ty, environment } }
1569 }
1570
1571 fn new(db: &dyn HirDatabase, krate: CrateId, lexical_env: impl HasResolver, ty: Ty) -> Type {
1572 let resolver = lexical_env.resolver(db.upcast());
1573 let environment = TraitEnvironment::lower(db, &resolver);
1574 Type { krate, ty: InEnvironment { value: ty, environment } }
1575 }
1576
1577 fn from_def(
1578 db: &dyn HirDatabase,
1579 krate: CrateId,
1580 def: impl HasResolver + Into<TyDefId> + Into<GenericDefId>,
1581 ) -> Type {
1582 let substs = Substs::build_for_def(db, def).fill_with_unknown().build();
1583 let ty = db.ty(def.into()).subst(&substs);
1584 Type::new(db, krate, def, ty)
1585 }
1586
1587 pub fn is_unit(&self) -> bool {
1588 matches!(self.ty.value, Ty::Tuple(0, ..))
1589 }
1590 pub fn is_bool(&self) -> bool {
1591 matches!(self.ty.value, Ty::Scalar(Scalar::Bool))
1592 }
1593
1594 pub fn is_mutable_reference(&self) -> bool {
1595 matches!(self.ty.value, Ty::Ref(hir_ty::Mutability::Mut, ..))
1596 }
1597
1598 pub fn remove_ref(&self) -> Option<Type> {
1599 match &self.ty.value {
1600 Ty::Ref(.., substs) => Some(self.derived(substs[0].clone())),
1601 _ => None,
1602 }
1603 }
1604
1605 pub fn is_unknown(&self) -> bool {
1606 matches!(self.ty.value, Ty::Unknown)
1607 }
1608
1609 /// Checks that particular type `ty` implements `std::future::Future`.
1610 /// This function is used in `.await` syntax completion.
1611 pub fn impls_future(&self, db: &dyn HirDatabase) -> bool {
1612 // No special case for the type of async block, since Chalk can figure it out.
1613
1614 let krate = self.krate;
1615
1616 let std_future_trait =
1617 db.lang_item(krate, "future_trait".into()).and_then(|it| it.as_trait());
1618 let std_future_trait = match std_future_trait {
1619 Some(it) => it,
1620 None => return false,
1621 };
1622
1623 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1624 method_resolution::implements_trait(
1625 &canonical_ty,
1626 db,
1627 self.ty.environment.clone(),
1628 krate,
1629 std_future_trait,
1630 )
1631 }
1632
1633 /// Checks that particular type `ty` implements `std::ops::FnOnce`.
1634 ///
1635 /// This function can be used to check if a particular type is callable, since FnOnce is a
1636 /// supertrait of Fn and FnMut, so all callable types implements at least FnOnce.
1637 pub fn impls_fnonce(&self, db: &dyn HirDatabase) -> bool {
1638 let krate = self.krate;
1639
1640 let fnonce_trait = match FnTrait::FnOnce.get_id(db, krate) {
1641 Some(it) => it,
1642 None => return false,
1643 };
1644
1645 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1646 method_resolution::implements_trait_unique(
1647 &canonical_ty,
1648 db,
1649 self.ty.environment.clone(),
1650 krate,
1651 fnonce_trait,
1652 )
1653 }
1654
1655 pub fn impls_trait(&self, db: &dyn HirDatabase, trait_: Trait, args: &[Type]) -> bool {
1656 let trait_ref = hir_ty::TraitRef {
1657 trait_: trait_.id,
1658 substs: Substs::build_for_def(db, trait_.id)
1659 .push(self.ty.value.clone())
1660 .fill(args.iter().map(|t| t.ty.value.clone()))
1661 .build(),
1662 };
1663
1664 let goal = Canonical {
1665 value: hir_ty::InEnvironment::new(
1666 self.ty.environment.clone(),
1667 hir_ty::Obligation::Trait(trait_ref),
1668 ),
1669 kinds: Arc::new([]),
1670 };
1671
1672 db.trait_solve(self.krate, goal).is_some()
1673 }
1674
1675 pub fn normalize_trait_assoc_type(
1676 &self,
1677 db: &dyn HirDatabase,
1678 trait_: Trait,
1679 args: &[Type],
1680 alias: TypeAlias,
1681 ) -> Option<Type> {
1682 let subst = Substs::build_for_def(db, trait_.id)
1683 .push(self.ty.value.clone())
1684 .fill(args.iter().map(|t| t.ty.value.clone()))
1685 .build();
1686 let predicate = ProjectionPredicate {
1687 projection_ty: ProjectionTy { associated_ty: alias.id, parameters: subst },
1688 ty: Ty::BoundVar(BoundVar::new(DebruijnIndex::INNERMOST, 0)),
1689 };
1690 let goal = Canonical {
1691 value: InEnvironment::new(
1692 self.ty.environment.clone(),
1693 Obligation::Projection(predicate),
1694 ),
1695 kinds: Arc::new([TyVariableKind::General]),
1696 };
1697
1698 match db.trait_solve(self.krate, goal)? {
1699 Solution::Unique(SolutionVariables(subst)) => {
1700 subst.value.first().map(|ty| self.derived(ty.clone()))
1701 }
1702 Solution::Ambig(_) => None,
1703 }
1704 }
1705
1706 pub fn is_copy(&self, db: &dyn HirDatabase) -> bool {
1707 let lang_item = db.lang_item(self.krate, SmolStr::new("copy"));
1708 let copy_trait = match lang_item {
1709 Some(LangItemTarget::TraitId(it)) => it,
1710 _ => return false,
1711 };
1712 self.impls_trait(db, copy_trait.into(), &[])
1713 }
1714
1715 pub fn as_callable(&self, db: &dyn HirDatabase) -> Option<Callable> {
1716 let def = match self.ty.value {
1717 Ty::FnDef(def, _) => Some(def),
1718 _ => None,
1719 };
1720
1721 let sig = self.ty.value.callable_sig(db)?;
1722 Some(Callable { ty: self.clone(), sig, def, is_bound_method: false })
1723 }
1724
1725 pub fn is_closure(&self) -> bool {
1726 matches!(&self.ty.value, Ty::Closure { .. })
1727 }
1728
1729 pub fn is_fn(&self) -> bool {
1730 matches!(&self.ty.value, Ty::FnDef(..) | Ty::Function { .. })
1731 }
1732
1733 pub fn is_packed(&self, db: &dyn HirDatabase) -> bool {
1734 let adt_id = match self.ty.value {
1735 Ty::Adt(hir_ty::AdtId(adt_id), ..) => adt_id,
1736 _ => return false,
1737 };
1738
1739 let adt = adt_id.into();
1740 match adt {
1741 Adt::Struct(s) => matches!(s.repr(db), Some(ReprKind::Packed)),
1742 _ => false,
1743 }
1744 }
1745
1746 pub fn is_raw_ptr(&self) -> bool {
1747 matches!(&self.ty.value, Ty::Raw(..))
1748 }
1749
1750 pub fn contains_unknown(&self) -> bool {
1751 return go(&self.ty.value);
1752
1753 fn go(ty: &Ty) -> bool {
1754 match ty {
1755 Ty::Unknown => true,
1756 _ => ty.substs().map_or(false, |substs| substs.iter().any(go)),
1757 }
1758 }
1759 }
1760
1761 pub fn fields(&self, db: &dyn HirDatabase) -> Vec<(Field, Type)> {
1762 let (variant_id, substs) = match self.ty.value {
1763 Ty::Adt(hir_ty::AdtId(AdtId::StructId(s)), ref substs) => (s.into(), substs),
1764 Ty::Adt(hir_ty::AdtId(AdtId::UnionId(u)), ref substs) => (u.into(), substs),
1765 _ => return Vec::new(),
1766 };
1767
1768 db.field_types(variant_id)
1769 .iter()
1770 .map(|(local_id, ty)| {
1771 let def = Field { parent: variant_id.into(), id: local_id };
1772 let ty = ty.clone().subst(substs);
1773 (def, self.derived(ty))
1774 })
1775 .collect()
1776 }
1777
1778 pub fn tuple_fields(&self, _db: &dyn HirDatabase) -> Vec<Type> {
1779 if let Ty::Tuple(_, substs) = &self.ty.value {
1780 substs.iter().map(|ty| self.derived(ty.clone())).collect()
1781 } else {
1782 Vec::new()
1783 }
1784 }
1785
1786 pub fn autoderef<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Type> + 'a {
1787 // There should be no inference vars in types passed here
1788 // FIXME check that?
1789 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1790 let environment = self.ty.environment.clone();
1791 let ty = InEnvironment { value: canonical, environment };
1792 autoderef(db, Some(self.krate), ty)
1793 .map(|canonical| canonical.value)
1794 .map(move |ty| self.derived(ty))
1795 }
1796
1797 // This would be nicer if it just returned an iterator, but that runs into
1798 // lifetime problems, because we need to borrow temp `CrateImplDefs`.
1799 pub fn iterate_assoc_items<T>(
1800 self,
1801 db: &dyn HirDatabase,
1802 krate: Crate,
1803 mut callback: impl FnMut(AssocItem) -> Option<T>,
1804 ) -> Option<T> {
1805 for krate in self.ty.value.def_crates(db, krate.id)? {
1806 let impls = db.inherent_impls_in_crate(krate);
1807
1808 for impl_def in impls.for_self_ty(&self.ty.value) {
1809 for &item in db.impl_data(*impl_def).items.iter() {
1810 if let Some(result) = callback(item.into()) {
1811 return Some(result);
1812 }
1813 }
1814 }
1815 }
1816 None
1817 }
1818
1819 pub fn type_parameters(&self) -> impl Iterator<Item = Type> + '_ {
1820 self.ty
1821 .value
1822 .strip_references()
1823 .substs()
1824 .into_iter()
1825 .flat_map(|substs| substs.iter())
1826 .map(move |ty| self.derived(ty.clone()))
1827 }
1828
1829 pub fn iterate_method_candidates<T>(
1830 &self,
1831 db: &dyn HirDatabase,
1832 krate: Crate,
1833 traits_in_scope: &FxHashSet<TraitId>,
1834 name: Option<&Name>,
1835 mut callback: impl FnMut(&Ty, Function) -> Option<T>,
1836 ) -> Option<T> {
1837 // There should be no inference vars in types passed here
1838 // FIXME check that?
1839 // FIXME replace Unknown by bound vars here
1840 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1841
1842 let env = self.ty.environment.clone();
1843 let krate = krate.id;
1844
1845 method_resolution::iterate_method_candidates(
1846 &canonical,
1847 db,
1848 env,
1849 krate,
1850 traits_in_scope,
1851 name,
1852 method_resolution::LookupMode::MethodCall,
1853 |ty, it| match it {
1854 AssocItemId::FunctionId(f) => callback(ty, f.into()),
1855 _ => None,
1856 },
1857 )
1858 }
1859
1860 pub fn iterate_path_candidates<T>(
1861 &self,
1862 db: &dyn HirDatabase,
1863 krate: Crate,
1864 traits_in_scope: &FxHashSet<TraitId>,
1865 name: Option<&Name>,
1866 mut callback: impl FnMut(&Ty, AssocItem) -> Option<T>,
1867 ) -> Option<T> {
1868 // There should be no inference vars in types passed here
1869 // FIXME check that?
1870 // FIXME replace Unknown by bound vars here
1871 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1872
1873 let env = self.ty.environment.clone();
1874 let krate = krate.id;
1875
1876 method_resolution::iterate_method_candidates(
1877 &canonical,
1878 db,
1879 env,
1880 krate,
1881 traits_in_scope,
1882 name,
1883 method_resolution::LookupMode::Path,
1884 |ty, it| callback(ty, it.into()),
1885 )
1886 }
1887
1888 pub fn as_adt(&self) -> Option<Adt> {
1889 let (adt, _subst) = self.ty.value.as_adt()?;
1890 Some(adt.into())
1891 }
1892
1893 pub fn as_dyn_trait(&self) -> Option<Trait> {
1894 self.ty.value.dyn_trait().map(Into::into)
1895 }
1896
1897 pub fn as_impl_traits(&self, db: &dyn HirDatabase) -> Option<Vec<Trait>> {
1898 self.ty.value.impl_trait_bounds(db).map(|it| {
1899 it.into_iter()
1900 .filter_map(|pred| match pred {
1901 hir_ty::GenericPredicate::Implemented(trait_ref) => {
1902 Some(Trait::from(trait_ref.trait_))
1903 }
1904 _ => None,
1905 })
1906 .collect()
1907 })
1908 }
1909
1910 pub fn as_associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<Trait> {
1911 self.ty.value.associated_type_parent_trait(db).map(Into::into)
1912 }
1913
1914 // FIXME: provide required accessors such that it becomes implementable from outside.
1915 pub fn is_equal_for_find_impls(&self, other: &Type) -> bool {
1916 let rref = other.remove_ref();
1917 self.ty.value.equals_ctor(rref.as_ref().map_or(&other.ty.value, |it| &it.ty.value))
1918 }
1919
1920 fn derived(&self, ty: Ty) -> Type {
1921 Type {
1922 krate: self.krate,
1923 ty: InEnvironment { value: ty, environment: self.ty.environment.clone() },
1924 }
1925 }
1926
1927 pub fn walk(&self, db: &dyn HirDatabase, mut cb: impl FnMut(Type)) {
1928 // TypeWalk::walk for a Ty at first visits parameters and only after that the Ty itself.
1929 // We need a different order here.
1930
1931 fn walk_substs(
1932 db: &dyn HirDatabase,
1933 type_: &Type,
1934 substs: &Substs,
1935 cb: &mut impl FnMut(Type),
1936 ) {
1937 for ty in substs.iter() {
1938 walk_type(db, &type_.derived(ty.clone()), cb);
1939 }
1940 }
1941
1942 fn walk_bounds(
1943 db: &dyn HirDatabase,
1944 type_: &Type,
1945 bounds: &[GenericPredicate],
1946 cb: &mut impl FnMut(Type),
1947 ) {
1948 for pred in bounds {
1949 match pred {
1950 GenericPredicate::Implemented(trait_ref) => {
1951 cb(type_.clone());
1952 walk_substs(db, type_, &trait_ref.substs, cb);
1953 }
1954 _ => (),
1955 }
1956 }
1957 }
1958
1959 fn walk_type(db: &dyn HirDatabase, type_: &Type, cb: &mut impl FnMut(Type)) {
1960 let ty = type_.ty.value.strip_references();
1961 match ty {
1962 Ty::Adt(..) => {
1963 cb(type_.derived(ty.clone()));
1964 }
1965 Ty::AssociatedType(..) => {
1966 if let Some(_) = ty.associated_type_parent_trait(db) {
1967 cb(type_.derived(ty.clone()));
1968 }
1969 }
1970 Ty::OpaqueType(..) => {
1971 if let Some(bounds) = ty.impl_trait_bounds(db) {
1972 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
1973 }
1974 }
1975 Ty::Alias(AliasTy::Opaque(opaque_ty)) => {
1976 if let Some(bounds) = ty.impl_trait_bounds(db) {
1977 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
1978 }
1979
1980 walk_substs(db, type_, &opaque_ty.parameters, cb);
1981 }
1982 Ty::Placeholder(_) => {
1983 if let Some(bounds) = ty.impl_trait_bounds(db) {
1984 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
1985 }
1986 }
1987 Ty::Dyn(bounds) => {
1988 walk_bounds(db, &type_.derived(ty.clone()), bounds.as_ref(), cb);
1989 }
1990
1991 _ => {}
1992 }
1993 if let Some(substs) = ty.substs() {
1994 walk_substs(db, type_, &substs, cb);
1995 }
1996 }
1997
1998 walk_type(db, self, &mut cb);
1999 }
2000}
2001
2002impl HirDisplay for Type {
2003 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
2004 self.ty.value.hir_fmt(f)
2005 }
2006}
2007
2008// FIXME: closures
2009#[derive(Debug)]
2010pub struct Callable {
2011 ty: Type,
2012 sig: CallableSig,
2013 def: Option<CallableDefId>,
2014 pub(crate) is_bound_method: bool,
2015}
2016
2017pub enum CallableKind {
2018 Function(Function),
2019 TupleStruct(Struct),
2020 TupleEnumVariant(Variant),
2021 Closure,
2022}
2023
2024impl Callable {
2025 pub fn kind(&self) -> CallableKind {
2026 match self.def {
2027 Some(CallableDefId::FunctionId(it)) => CallableKind::Function(it.into()),
2028 Some(CallableDefId::StructId(it)) => CallableKind::TupleStruct(it.into()),
2029 Some(CallableDefId::EnumVariantId(it)) => CallableKind::TupleEnumVariant(it.into()),
2030 None => CallableKind::Closure,
2031 }
2032 }
2033 pub fn receiver_param(&self, db: &dyn HirDatabase) -> Option<ast::SelfParam> {
2034 let func = match self.def {
2035 Some(CallableDefId::FunctionId(it)) if self.is_bound_method => it,
2036 _ => return None,
2037 };
2038 let src = func.lookup(db.upcast()).source(db.upcast());
2039 let param_list = src.value.param_list()?;
2040 param_list.self_param()
2041 }
2042 pub fn n_params(&self) -> usize {
2043 self.sig.params().len() - if self.is_bound_method { 1 } else { 0 }
2044 }
2045 pub fn params(
2046 &self,
2047 db: &dyn HirDatabase,
2048 ) -> Vec<(Option<Either<ast::SelfParam, ast::Pat>>, Type)> {
2049 let types = self
2050 .sig
2051 .params()
2052 .iter()
2053 .skip(if self.is_bound_method { 1 } else { 0 })
2054 .map(|ty| self.ty.derived(ty.clone()));
2055 let patterns = match self.def {
2056 Some(CallableDefId::FunctionId(func)) => {
2057 let src = func.lookup(db.upcast()).source(db.upcast());
2058 src.value.param_list().map(|param_list| {
2059 param_list
2060 .self_param()
2061 .map(|it| Some(Either::Left(it)))
2062 .filter(|_| !self.is_bound_method)
2063 .into_iter()
2064 .chain(param_list.params().map(|it| it.pat().map(Either::Right)))
2065 })
2066 }
2067 _ => None,
2068 };
2069 patterns.into_iter().flatten().chain(iter::repeat(None)).zip(types).collect()
2070 }
2071 pub fn return_type(&self) -> Type {
2072 self.ty.derived(self.sig.ret().clone())
2073 }
2074}
2075
2076/// For IDE only
2077#[derive(Debug, PartialEq, Eq, Hash)]
2078pub enum ScopeDef {
2079 ModuleDef(ModuleDef),
2080 MacroDef(MacroDef),
2081 GenericParam(GenericParam),
2082 ImplSelfType(Impl),
2083 AdtSelfType(Adt),
2084 Local(Local),
2085 Unknown,
2086}
2087
2088impl ScopeDef {
2089 pub fn all_items(def: PerNs) -> ArrayVec<[Self; 3]> {
2090 let mut items = ArrayVec::new();
2091
2092 match (def.take_types(), def.take_values()) {
2093 (Some(m1), None) => items.push(ScopeDef::ModuleDef(m1.into())),
2094 (None, Some(m2)) => items.push(ScopeDef::ModuleDef(m2.into())),
2095 (Some(m1), Some(m2)) => {
2096 // Some items, like unit structs and enum variants, are
2097 // returned as both a type and a value. Here we want
2098 // to de-duplicate them.
2099 if m1 != m2 {
2100 items.push(ScopeDef::ModuleDef(m1.into()));
2101 items.push(ScopeDef::ModuleDef(m2.into()));
2102 } else {
2103 items.push(ScopeDef::ModuleDef(m1.into()));
2104 }
2105 }
2106 (None, None) => {}
2107 };
2108
2109 if let Some(macro_def_id) = def.take_macros() {
2110 items.push(ScopeDef::MacroDef(macro_def_id.into()));
2111 }
2112
2113 if items.is_empty() {
2114 items.push(ScopeDef::Unknown);
2115 }
2116
2117 items
2118 }
2119}
2120
2121impl From<ItemInNs> for ScopeDef {
2122 fn from(item: ItemInNs) -> Self {
2123 match item {
2124 ItemInNs::Types(id) => ScopeDef::ModuleDef(id.into()),
2125 ItemInNs::Values(id) => ScopeDef::ModuleDef(id.into()),
2126 ItemInNs::Macros(id) => ScopeDef::MacroDef(id.into()),
2127 }
2128 }
2129}
2130
2131pub trait HasVisibility {
2132 fn visibility(&self, db: &dyn HirDatabase) -> Visibility;
2133 fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool {
2134 let vis = self.visibility(db);
2135 vis.is_visible_from(db.upcast(), module.id)
2136 }
2137}
diff --git a/crates/hir/src/semantics.rs b/crates/hir/src/semantics.rs
index 144851f83..945638cc5 100644
--- a/crates/hir/src/semantics.rs
+++ b/crates/hir/src/semantics.rs
@@ -20,12 +20,11 @@ use syntax::{
20}; 20};
21 21
22use crate::{ 22use crate::{
23 code_model::Access,
24 db::HirDatabase, 23 db::HirDatabase,
25 semantics::source_to_def::{ChildContainer, SourceToDefCache, SourceToDefCtx}, 24 semantics::source_to_def::{ChildContainer, SourceToDefCache, SourceToDefCtx},
26 source_analyzer::{resolve_hir_path, SourceAnalyzer}, 25 source_analyzer::{resolve_hir_path, SourceAnalyzer},
27 AssocItem, Callable, ConstParam, Crate, Field, Function, HirFileId, Impl, InFile, Label, 26 Access, AssocItem, Callable, ConstParam, Crate, Field, Function, HirFileId, Impl, InFile,
28 LifetimeParam, Local, MacroDef, Module, ModuleDef, Name, Path, ScopeDef, Trait, Type, 27 Label, LifetimeParam, Local, MacroDef, Module, ModuleDef, Name, Path, ScopeDef, Trait, Type,
29 TypeAlias, TypeParam, VariantDef, 28 TypeAlias, TypeParam, VariantDef,
30}; 29};
31 30
diff --git a/crates/hir/src/source_analyzer.rs b/crates/hir/src/source_analyzer.rs
index 64ce4add1..d546512cb 100644
--- a/crates/hir/src/source_analyzer.rs
+++ b/crates/hir/src/source_analyzer.rs
@@ -28,9 +28,8 @@ use syntax::{
28}; 28};
29 29
30use crate::{ 30use crate::{
31 code_model::BuiltinType, db::HirDatabase, semantics::PathResolution, Adt, Const, Field, 31 db::HirDatabase, semantics::PathResolution, Adt, BuiltinType, Const, Field, Function, Local,
32 Function, Local, MacroDef, ModuleDef, Static, Struct, Trait, Type, TypeAlias, TypeParam, 32 MacroDef, ModuleDef, Static, Struct, Trait, Type, TypeAlias, TypeParam, Variant,
33 Variant,
34}; 33};
35use base_db::CrateId; 34use base_db::CrateId;
36 35
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-05 16:39:28 +0100