1 //! HIR (previously known as descriptors) provides a high-level object oriented
2 //! access to Rust code.
4 //! The principal difference between HIR and syntax trees is that HIR is bound
5 //! to a particular crate instance. That is, it has cfg flags and features
6 //! applied. So, the relation between syntax and HIR is many-to-one.
8 //! HIR is the public API of the all of the compiler logic above syntax trees.
9 //! It is written in "OO" style. Each type is self contained (as in, it knows it's
10 //! parents and full context). It should be "clean code".
12 //! `hir_*` crates are the implementation of the compiler logic.
13 //! They are written in "ECS" style, with relatively little abstractions.
14 //! Many types are not self-contained, and explicitly use local indexes, arenas, etc.
16 //! `hir` is what insulates the "we don't know how to actually write an incremental compiler"
17 //! from the ide with completions, hovers, etc. It is a (soft, internal) boundary:
18 //! https://www.tedinski.com/2018/02/06/system-boundaries.html.
20 #![recursion_limit = "512"]
34 use std::{iter, sync::Arc};
36 use arrayvec::ArrayVec;
37 use base_db::{CrateDisplayName, CrateId, Edition, FileId};
40 adt::{ReprKind, VariantData},
41 expr::{BindingAnnotation, LabelId, Pat, PatId},
42 item_tree::ItemTreeNode,
43 lang_item::LangItemTarget,
45 resolver::{HasResolver, Resolver},
47 AdtId, AssocContainerId, AssocItemId, AssocItemLoc, AttrDefId, ConstId, ConstParamId,
48 DefWithBodyId, EnumId, FunctionId, GenericDefId, HasModule, ImplId, LifetimeParamId,
49 LocalEnumVariantId, LocalFieldId, Lookup, ModuleId, StaticId, StructId, TraitId, TypeAliasId,
52 use hir_expand::{diagnostics::DiagnosticSink, name::name, MacroDefKind};
55 method_resolution::{self, TyFingerprint},
58 traits::{FnTrait, Solution, SolutionVariables},
59 AliasEq, AliasTy, BoundVar, CallableDefId, CallableSig, Canonical, Cast, DebruijnIndex,
60 InEnvironment, Interner, ProjectionTy, Scalar, Substitution, Ty, TyDefId, TyKind,
61 TyVariableKind, WhereClause,
63 use itertools::Itertools;
64 use rustc_hash::FxHashSet;
65 use stdx::{format_to, impl_from};
67 ast::{self, AttrsOwner, NameOwner},
70 use tt::{Ident, Leaf, Literal, TokenTree};
72 use crate::db::{DefDatabase, HirDatabase};
75 attrs::{HasAttrs, Namespace},
76 has_source::HasSource,
77 semantics::{PathResolution, Semantics, SemanticsScope},
80 // Be careful with these re-exports.
82 // `hir` is the boundary between the compiler and the IDE. It should try hard to
83 // isolate the compiler from the ide, to allow the two to be refactored
84 // independently. Re-exporting something from the compiler is the sure way to
85 // breach the boundary.
87 // Generally, a refactoring which *removes* a name from this list is a good
92 attr::{Attr, Attrs, AttrsWithOwner, Documentation},
93 body::scope::ExprScopes,
94 find_path::PrefixKind,
97 nameres::ModuleSource,
98 path::{ModPath, PathKind},
99 type_ref::{Mutability, TypeRef},
100 visibility::Visibility,
104 ExpandResult, HirFileId, InFile, MacroCallId, MacroCallLoc, /* FIXME */ MacroDefId,
107 hir_ty::display::HirDisplay,
110 // These are negative re-exports: pub using these names is forbidden, they
111 // should remain private to hir internals.
115 hir_expand::{hygiene::Hygiene, name::AsName},
118 /// hir::Crate describes a single crate. It's the main interface with which
119 /// a crate's dependencies interact. Mostly, it should be just a proxy for the
121 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
123 pub(crate) id: CrateId,
127 pub struct CrateDependency {
133 pub fn dependencies(self, db: &dyn HirDatabase) -> Vec<CrateDependency> {
134 db.crate_graph()[self.id]
138 let krate = Crate { id: dep.crate_id };
139 let name = dep.as_name();
140 CrateDependency { krate, name }
145 pub fn reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
146 let crate_graph = db.crate_graph();
150 crate_graph[krate].dependencies.iter().any(|it| it.crate_id == self.id)
152 .map(|id| Crate { id })
156 pub fn transitive_reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
158 .transitive_reverse_dependencies(self.id)
160 .map(|id| Crate { id })
164 pub fn root_module(self, db: &dyn HirDatabase) -> Module {
165 let def_map = db.crate_def_map(self.id);
166 Module { id: def_map.module_id(def_map.root()) }
169 pub fn root_file(self, db: &dyn HirDatabase) -> FileId {
170 db.crate_graph()[self.id].root_file_id
173 pub fn edition(self, db: &dyn HirDatabase) -> Edition {
174 db.crate_graph()[self.id].edition
177 pub fn display_name(self, db: &dyn HirDatabase) -> Option<CrateDisplayName> {
178 db.crate_graph()[self.id].display_name.clone()
181 pub fn query_external_importables(
183 db: &dyn DefDatabase,
184 query: import_map::Query,
185 ) -> impl Iterator<Item = Either<ModuleDef, MacroDef>> {
186 import_map::search_dependencies(db, self.into(), query).into_iter().map(|item| match item {
187 ItemInNs::Types(mod_id) | ItemInNs::Values(mod_id) => Either::Left(mod_id.into()),
188 ItemInNs::Macros(mac_id) => Either::Right(mac_id.into()),
192 pub fn all(db: &dyn HirDatabase) -> Vec<Crate> {
193 db.crate_graph().iter().map(|id| Crate { id }).collect()
196 /// Try to get the root URL of the documentation of a crate.
197 pub fn get_html_root_url(self: &Crate, db: &dyn HirDatabase) -> Option<String> {
198 // Look for #![doc(html_root_url = "...")]
199 let attrs = db.attrs(AttrDefId::ModuleId(self.root_module(db).into()));
200 let doc_attr_q = attrs.by_key("doc");
202 if !doc_attr_q.exists() {
206 let doc_url = doc_attr_q.tt_values().map(|tt| {
207 let name = tt.token_trees.iter()
208 .skip_while(|tt| !matches!(tt, TokenTree::Leaf(Leaf::Ident(Ident{text: ref ident, ..})) if ident == "html_root_url"))
213 Some(TokenTree::Leaf(Leaf::Literal(Literal{ref text, ..}))) => Some(text),
216 }).flat_map(|t| t).next();
218 doc_url.map(|s| s.trim_matches('"').trim_end_matches('/').to_owned() + "/")
222 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
224 pub(crate) id: ModuleId,
227 /// The defs which can be visible in the module.
228 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
233 // Can't be directly declared, but can be imported.
238 TypeAlias(TypeAlias),
239 BuiltinType(BuiltinType),
244 Adt(Struct, Enum, Union),
254 impl From<VariantDef> for ModuleDef {
255 fn from(var: VariantDef) -> Self {
257 VariantDef::Struct(t) => Adt::from(t).into(),
258 VariantDef::Union(t) => Adt::from(t).into(),
259 VariantDef::Variant(t) => t.into(),
265 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
267 ModuleDef::Module(it) => it.parent(db),
268 ModuleDef::Function(it) => Some(it.module(db)),
269 ModuleDef::Adt(it) => Some(it.module(db)),
270 ModuleDef::Variant(it) => Some(it.module(db)),
271 ModuleDef::Const(it) => Some(it.module(db)),
272 ModuleDef::Static(it) => Some(it.module(db)),
273 ModuleDef::Trait(it) => Some(it.module(db)),
274 ModuleDef::TypeAlias(it) => Some(it.module(db)),
275 ModuleDef::BuiltinType(_) => None,
279 pub fn canonical_path(&self, db: &dyn HirDatabase) -> Option<String> {
280 let mut segments = vec![self.name(db)?.to_string()];
281 for m in self.module(db)?.path_to_root(db) {
282 segments.extend(m.name(db).map(|it| it.to_string()))
285 Some(segments.join("::"))
288 pub fn definition_visibility(&self, db: &dyn HirDatabase) -> Option<Visibility> {
289 let module = match self {
290 ModuleDef::Module(it) => it.parent(db)?,
291 ModuleDef::Function(it) => return Some(it.visibility(db)),
292 ModuleDef::Adt(it) => it.module(db),
293 ModuleDef::Variant(it) => {
294 let parent = it.parent_enum(db);
295 let module = it.module(db);
296 return module.visibility_of(db, &ModuleDef::Adt(Adt::Enum(parent)));
298 ModuleDef::Const(it) => return Some(it.visibility(db)),
299 ModuleDef::Static(it) => it.module(db),
300 ModuleDef::Trait(it) => it.module(db),
301 ModuleDef::TypeAlias(it) => return Some(it.visibility(db)),
302 ModuleDef::BuiltinType(_) => return None,
305 module.visibility_of(db, self)
308 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
310 ModuleDef::Adt(it) => Some(it.name(db)),
311 ModuleDef::Trait(it) => Some(it.name(db)),
312 ModuleDef::Function(it) => Some(it.name(db)),
313 ModuleDef::Variant(it) => Some(it.name(db)),
314 ModuleDef::TypeAlias(it) => Some(it.name(db)),
315 ModuleDef::Module(it) => it.name(db),
316 ModuleDef::Const(it) => it.name(db),
317 ModuleDef::Static(it) => it.name(db),
318 ModuleDef::BuiltinType(it) => Some(it.name()),
322 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
323 let id = match self {
324 ModuleDef::Adt(it) => match it {
325 Adt::Struct(it) => it.id.into(),
326 Adt::Enum(it) => it.id.into(),
327 Adt::Union(it) => it.id.into(),
329 ModuleDef::Trait(it) => it.id.into(),
330 ModuleDef::Function(it) => it.id.into(),
331 ModuleDef::TypeAlias(it) => it.id.into(),
332 ModuleDef::Module(it) => it.id.into(),
333 ModuleDef::Const(it) => it.id.into(),
334 ModuleDef::Static(it) => it.id.into(),
338 let module = match self.module(db) {
343 hir_ty::diagnostics::validate_module_item(db, module.id.krate(), id, sink)
348 /// Name of this module.
349 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
350 let def_map = self.id.def_map(db.upcast());
351 let parent = def_map[self.id.local_id].parent?;
352 def_map[parent].children.iter().find_map(|(name, module_id)| {
353 if *module_id == self.id.local_id {
361 /// Returns the crate this module is part of.
362 pub fn krate(self) -> Crate {
363 Crate { id: self.id.krate() }
366 /// Topmost parent of this module. Every module has a `crate_root`, but some
367 /// might be missing `krate`. This can happen if a module's file is not included
368 /// in the module tree of any target in `Cargo.toml`.
369 pub fn crate_root(self, db: &dyn HirDatabase) -> Module {
370 let def_map = db.crate_def_map(self.id.krate());
371 Module { id: def_map.module_id(def_map.root()) }
374 /// Iterates over all child modules.
375 pub fn children(self, db: &dyn HirDatabase) -> impl Iterator<Item = Module> {
376 let def_map = self.id.def_map(db.upcast());
377 let children = def_map[self.id.local_id]
380 .map(|(_, module_id)| Module { id: def_map.module_id(*module_id) })
381 .collect::<Vec<_>>();
385 /// Finds a parent module.
386 pub fn parent(self, db: &dyn HirDatabase) -> Option<Module> {
387 // FIXME: handle block expressions as modules (their parent is in a different DefMap)
388 let def_map = self.id.def_map(db.upcast());
389 let parent_id = def_map[self.id.local_id].parent?;
390 Some(Module { id: def_map.module_id(parent_id) })
393 pub fn path_to_root(self, db: &dyn HirDatabase) -> Vec<Module> {
394 let mut res = vec![self];
396 while let Some(next) = curr.parent(db) {
403 /// Returns a `ModuleScope`: a set of items, visible in this module.
406 db: &dyn HirDatabase,
407 visible_from: Option<Module>,
408 ) -> Vec<(Name, ScopeDef)> {
409 self.id.def_map(db.upcast())[self.id.local_id]
412 .filter_map(|(name, def)| {
413 if let Some(m) = visible_from {
415 def.filter_visibility(|vis| vis.is_visible_from(db.upcast(), m.id));
416 if filtered.is_none() && !def.is_none() {
419 Some((name, filtered))
425 .flat_map(|(name, def)| {
426 ScopeDef::all_items(def).into_iter().map(move |item| (name.clone(), item))
431 pub fn visibility_of(self, db: &dyn HirDatabase, def: &ModuleDef) -> Option<Visibility> {
432 self.id.def_map(db.upcast())[self.id.local_id].scope.visibility_of(def.clone().into())
435 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
436 let _p = profile::span("Module::diagnostics").detail(|| {
437 format!("{:?}", self.name(db).map_or("<unknown>".into(), |name| name.to_string()))
439 let def_map = self.id.def_map(db.upcast());
440 def_map.add_diagnostics(db.upcast(), self.id.local_id, sink);
441 for decl in self.declarations(db) {
443 crate::ModuleDef::Function(f) => f.diagnostics(db, sink),
444 crate::ModuleDef::Module(m) => {
445 // Only add diagnostics from inline modules
446 if def_map[m.id.local_id].origin.is_inline() {
447 m.diagnostics(db, sink)
451 decl.diagnostics(db, sink);
456 for impl_def in self.impl_defs(db) {
457 for item in impl_def.items(db) {
458 if let AssocItem::Function(f) = item {
459 f.diagnostics(db, sink);
465 pub fn declarations(self, db: &dyn HirDatabase) -> Vec<ModuleDef> {
466 let def_map = self.id.def_map(db.upcast());
467 def_map[self.id.local_id].scope.declarations().map(ModuleDef::from).collect()
470 pub fn impl_defs(self, db: &dyn HirDatabase) -> Vec<Impl> {
471 let def_map = self.id.def_map(db.upcast());
472 def_map[self.id.local_id].scope.impls().map(Impl::from).collect()
475 /// Finds a path that can be used to refer to the given item from within
476 /// this module, if possible.
477 pub fn find_use_path(self, db: &dyn DefDatabase, item: impl Into<ItemInNs>) -> Option<ModPath> {
478 hir_def::find_path::find_path(db, item.into(), self.into())
481 /// Finds a path that can be used to refer to the given item from within
482 /// this module, if possible. This is used for returning import paths for use-statements.
483 pub fn find_use_path_prefixed(
485 db: &dyn DefDatabase,
486 item: impl Into<ItemInNs>,
487 prefix_kind: PrefixKind,
488 ) -> Option<ModPath> {
489 hir_def::find_path::find_path_prefixed(db, item.into(), self.into(), prefix_kind)
493 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
495 pub(crate) parent: VariantDef,
496 pub(crate) id: LocalFieldId,
499 #[derive(Debug, PartialEq, Eq)]
500 pub enum FieldSource {
501 Named(ast::RecordField),
502 Pos(ast::TupleField),
506 pub fn name(&self, db: &dyn HirDatabase) -> Name {
507 self.parent.variant_data(db).fields()[self.id].name.clone()
510 /// Returns the type as in the signature of the struct (i.e., with
511 /// placeholder types for type parameters). This is good for showing
512 /// signature help, but not so good to actually get the type of the field
513 /// when you actually have a variable of the struct.
514 pub fn signature_ty(&self, db: &dyn HirDatabase) -> Type {
515 let var_id = self.parent.into();
516 let generic_def_id: GenericDefId = match self.parent {
517 VariantDef::Struct(it) => it.id.into(),
518 VariantDef::Union(it) => it.id.into(),
519 VariantDef::Variant(it) => it.parent.id.into(),
521 let substs = Substitution::type_params(db, generic_def_id);
522 let ty = db.field_types(var_id)[self.id].clone().subst(&substs);
523 Type::new(db, self.parent.module(db).id.krate(), var_id, ty)
526 pub fn parent_def(&self, _db: &dyn HirDatabase) -> VariantDef {
531 impl HasVisibility for Field {
532 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
533 let variant_data = self.parent.variant_data(db);
534 let visibility = &variant_data.fields()[self.id].visibility;
535 let parent_id: hir_def::VariantId = self.parent.into();
536 visibility.resolve(db.upcast(), &parent_id.resolver(db.upcast()))
540 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
542 pub(crate) id: StructId,
546 pub fn module(self, db: &dyn HirDatabase) -> Module {
547 Module { id: self.id.lookup(db.upcast()).container }
550 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
551 Some(self.module(db).krate())
554 pub fn name(self, db: &dyn HirDatabase) -> Name {
555 db.struct_data(self.id).name.clone()
558 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
559 db.struct_data(self.id)
563 .map(|(id, _)| Field { parent: self.into(), id })
567 pub fn ty(self, db: &dyn HirDatabase) -> Type {
568 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
571 pub fn repr(self, db: &dyn HirDatabase) -> Option<ReprKind> {
572 db.struct_data(self.id).repr.clone()
575 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
576 self.variant_data(db).kind()
579 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
580 db.struct_data(self.id).variant_data.clone()
584 impl HasVisibility for Struct {
585 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
586 db.struct_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
590 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
592 pub(crate) id: UnionId,
596 pub fn name(self, db: &dyn HirDatabase) -> Name {
597 db.union_data(self.id).name.clone()
600 pub fn module(self, db: &dyn HirDatabase) -> Module {
601 Module { id: self.id.lookup(db.upcast()).container }
604 pub fn ty(self, db: &dyn HirDatabase) -> Type {
605 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
608 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
609 db.union_data(self.id)
613 .map(|(id, _)| Field { parent: self.into(), id })
617 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
618 db.union_data(self.id).variant_data.clone()
622 impl HasVisibility for Union {
623 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
624 db.union_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
628 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
630 pub(crate) id: EnumId,
634 pub fn module(self, db: &dyn HirDatabase) -> Module {
635 Module { id: self.id.lookup(db.upcast()).container }
638 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
639 Some(self.module(db).krate())
642 pub fn name(self, db: &dyn HirDatabase) -> Name {
643 db.enum_data(self.id).name.clone()
646 pub fn variants(self, db: &dyn HirDatabase) -> Vec<Variant> {
647 db.enum_data(self.id).variants.iter().map(|(id, _)| Variant { parent: self, id }).collect()
650 pub fn ty(self, db: &dyn HirDatabase) -> Type {
651 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
655 impl HasVisibility for Enum {
656 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
657 db.enum_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
661 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
663 pub(crate) parent: Enum,
664 pub(crate) id: LocalEnumVariantId,
668 pub fn module(self, db: &dyn HirDatabase) -> Module {
669 self.parent.module(db)
671 pub fn parent_enum(self, _db: &dyn HirDatabase) -> Enum {
675 pub fn name(self, db: &dyn HirDatabase) -> Name {
676 db.enum_data(self.parent.id).variants[self.id].name.clone()
679 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
680 self.variant_data(db)
683 .map(|(id, _)| Field { parent: self.into(), id })
687 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
688 self.variant_data(db).kind()
691 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
692 db.enum_data(self.parent.id).variants[self.id].variant_data.clone()
697 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
703 impl_from!(Struct, Union, Enum for Adt);
706 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
707 let subst = db.generic_defaults(self.into());
708 subst.iter().any(|ty| ty.value.is_unknown())
711 /// Turns this ADT into a type. Any type parameters of the ADT will be
712 /// turned into unknown types, which is good for e.g. finding the most
713 /// general set of completions, but will not look very nice when printed.
714 pub fn ty(self, db: &dyn HirDatabase) -> Type {
715 let id = AdtId::from(self);
716 Type::from_def(db, id.module(db.upcast()).krate(), id)
719 pub fn module(self, db: &dyn HirDatabase) -> Module {
721 Adt::Struct(s) => s.module(db),
722 Adt::Union(s) => s.module(db),
723 Adt::Enum(e) => e.module(db),
727 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
728 self.module(db).krate()
731 pub fn name(self, db: &dyn HirDatabase) -> Name {
733 Adt::Struct(s) => s.name(db),
734 Adt::Union(u) => u.name(db),
735 Adt::Enum(e) => e.name(db),
740 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
741 pub enum VariantDef {
746 impl_from!(Struct, Union, Variant for VariantDef);
749 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
751 VariantDef::Struct(it) => it.fields(db),
752 VariantDef::Union(it) => it.fields(db),
753 VariantDef::Variant(it) => it.fields(db),
757 pub fn module(self, db: &dyn HirDatabase) -> Module {
759 VariantDef::Struct(it) => it.module(db),
760 VariantDef::Union(it) => it.module(db),
761 VariantDef::Variant(it) => it.module(db),
765 pub fn name(&self, db: &dyn HirDatabase) -> Name {
767 VariantDef::Struct(s) => s.name(db),
768 VariantDef::Union(u) => u.name(db),
769 VariantDef::Variant(e) => e.name(db),
773 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
775 VariantDef::Struct(it) => it.variant_data(db),
776 VariantDef::Union(it) => it.variant_data(db),
777 VariantDef::Variant(it) => it.variant_data(db),
782 /// The defs which have a body.
783 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
784 pub enum DefWithBody {
789 impl_from!(Function, Const, Static for DefWithBody);
792 pub fn module(self, db: &dyn HirDatabase) -> Module {
794 DefWithBody::Const(c) => c.module(db),
795 DefWithBody::Function(f) => f.module(db),
796 DefWithBody::Static(s) => s.module(db),
800 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
802 DefWithBody::Function(f) => Some(f.name(db)),
803 DefWithBody::Static(s) => s.name(db),
804 DefWithBody::Const(c) => c.name(db),
809 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
810 pub struct Function {
811 pub(crate) id: FunctionId,
815 pub fn module(self, db: &dyn HirDatabase) -> Module {
816 self.id.lookup(db.upcast()).module(db.upcast()).into()
819 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
820 Some(self.module(db).krate())
823 pub fn name(self, db: &dyn HirDatabase) -> Name {
824 db.function_data(self.id).name.clone()
827 /// Get this function's return type
828 pub fn ret_type(self, db: &dyn HirDatabase) -> Type {
829 let resolver = self.id.resolver(db.upcast());
830 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
831 let ret_type = &db.function_data(self.id).ret_type;
832 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
833 let ty = ctx.lower_ty(ret_type);
834 Type::new_with_resolver_inner(db, krate, &resolver, ty)
837 pub fn self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
838 if !db.function_data(self.id).has_self_param {
841 Some(SelfParam { func: self.id })
844 pub fn assoc_fn_params(self, db: &dyn HirDatabase) -> Vec<Param> {
845 let resolver = self.id.resolver(db.upcast());
846 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
847 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
848 let environment = db.trait_environment(self.id.into());
849 db.function_data(self.id)
853 .map(|(idx, type_ref)| {
857 value: ctx.lower_ty(type_ref),
858 environment: environment.clone(),
861 Param { func: self, ty, idx }
865 pub fn method_params(self, db: &dyn HirDatabase) -> Option<Vec<Param>> {
866 if self.self_param(db).is_none() {
869 let mut res = self.assoc_fn_params(db);
874 pub fn is_unsafe(self, db: &dyn HirDatabase) -> bool {
875 db.function_data(self.id).qualifier.is_unsafe
878 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
879 let krate = self.module(db).id.krate();
880 hir_def::diagnostics::validate_body(db.upcast(), self.id.into(), sink);
881 hir_ty::diagnostics::validate_module_item(db, krate, self.id.into(), sink);
882 hir_ty::diagnostics::validate_body(db, self.id.into(), sink);
885 /// Whether this function declaration has a definition.
887 /// This is false in the case of required (not provided) trait methods.
888 pub fn has_body(self, db: &dyn HirDatabase) -> bool {
889 db.function_data(self.id).has_body
892 /// A textual representation of the HIR of this function for debugging purposes.
893 pub fn debug_hir(self, db: &dyn HirDatabase) -> String {
894 let body = db.body(self.id.into());
896 let mut result = String::new();
897 format_to!(result, "HIR expressions in the body of `{}`:\n", self.name(db));
898 for (id, expr) in body.exprs.iter() {
899 format_to!(result, "{:?}: {:?}\n", id, expr);
906 // Note: logically, this belongs to `hir_ty`, but we are not using it there yet.
913 impl From<hir_ty::Mutability> for Access {
914 fn from(mutability: hir_ty::Mutability) -> Access {
916 hir_ty::Mutability::Not => Access::Shared,
917 hir_ty::Mutability::Mut => Access::Exclusive,
925 /// The index in parameter list, including self parameter.
931 pub fn ty(&self) -> &Type {
935 pub fn pattern_source(&self, db: &dyn HirDatabase) -> Option<ast::Pat> {
936 let params = self.func.source(db)?.value.param_list()?;
937 if params.self_param().is_some() {
938 params.params().nth(self.idx.checked_sub(1)?)?.pat()
940 params.params().nth(self.idx)?.pat()
945 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
946 pub struct SelfParam {
951 pub fn access(self, db: &dyn HirDatabase) -> Access {
952 let func_data = db.function_data(self.func);
956 .map(|param| match *param {
957 TypeRef::Reference(.., mutability) => match mutability {
958 hir_def::type_ref::Mutability::Shared => Access::Shared,
959 hir_def::type_ref::Mutability::Mut => Access::Exclusive,
963 .unwrap_or(Access::Owned)
966 pub fn display(self, db: &dyn HirDatabase) -> &'static str {
967 match self.access(db) {
968 Access::Shared => "&self",
969 Access::Exclusive => "&mut self",
970 Access::Owned => "self",
975 impl HasVisibility for Function {
976 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
977 let function_data = db.function_data(self.id);
978 let visibility = &function_data.visibility;
979 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
983 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
985 pub(crate) id: ConstId,
989 pub fn module(self, db: &dyn HirDatabase) -> Module {
990 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
993 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
994 Some(self.module(db).krate())
997 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
998 db.const_data(self.id).name.clone()
1001 pub fn type_ref(self, db: &dyn HirDatabase) -> TypeRef {
1002 db.const_data(self.id).type_ref.clone()
1006 impl HasVisibility for Const {
1007 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1008 let function_data = db.const_data(self.id);
1009 let visibility = &function_data.visibility;
1010 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1014 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1016 pub(crate) id: StaticId,
1020 pub fn module(self, db: &dyn HirDatabase) -> Module {
1021 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1024 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
1025 Some(self.module(db).krate())
1028 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1029 db.static_data(self.id).name.clone()
1032 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1033 db.static_data(self.id).mutable
1037 impl HasVisibility for Static {
1038 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1039 db.static_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1043 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1045 pub(crate) id: TraitId,
1049 pub fn module(self, db: &dyn HirDatabase) -> Module {
1050 Module { id: self.id.lookup(db.upcast()).container }
1053 pub fn name(self, db: &dyn HirDatabase) -> Name {
1054 db.trait_data(self.id).name.clone()
1057 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1058 db.trait_data(self.id).items.iter().map(|(_name, it)| (*it).into()).collect()
1061 pub fn is_auto(self, db: &dyn HirDatabase) -> bool {
1062 db.trait_data(self.id).is_auto
1066 impl HasVisibility for Trait {
1067 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1068 db.trait_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1072 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1073 pub struct TypeAlias {
1074 pub(crate) id: TypeAliasId,
1078 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
1079 let subst = db.generic_defaults(self.id.into());
1080 subst.iter().any(|ty| ty.value.is_unknown())
1083 pub fn module(self, db: &dyn HirDatabase) -> Module {
1084 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1087 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1088 self.module(db).krate()
1091 pub fn type_ref(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1092 db.type_alias_data(self.id).type_ref.clone()
1095 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1096 Type::from_def(db, self.id.lookup(db.upcast()).module(db.upcast()).krate(), self.id)
1099 pub fn name(self, db: &dyn HirDatabase) -> Name {
1100 db.type_alias_data(self.id).name.clone()
1104 impl HasVisibility for TypeAlias {
1105 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1106 let function_data = db.type_alias_data(self.id);
1107 let visibility = &function_data.visibility;
1108 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1112 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1113 pub struct BuiltinType {
1114 pub(crate) inner: hir_def::builtin_type::BuiltinType,
1118 pub fn ty(self, db: &dyn HirDatabase, module: Module) -> Type {
1119 let resolver = module.id.resolver(db.upcast());
1120 Type::new_with_resolver(db, &resolver, Ty::builtin(self.inner))
1121 .expect("crate not present in resolver")
1124 pub fn name(self) -> Name {
1125 self.inner.as_name()
1129 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1130 pub struct MacroDef {
1131 pub(crate) id: MacroDefId,
1135 /// FIXME: right now, this just returns the root module of the crate that
1136 /// defines this macro. The reasons for this is that macros are expanded
1137 /// early, in `hir_expand`, where modules simply do not exist yet.
1138 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
1139 let krate = self.id.krate;
1140 let def_map = db.crate_def_map(krate);
1141 let module_id = def_map.root();
1142 Some(Module { id: def_map.module_id(module_id) })
1145 /// XXX: this parses the file
1146 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1147 match self.source(db)?.value {
1148 Either::Left(it) => it.name().map(|it| it.as_name()),
1149 Either::Right(it) => it.name().map(|it| it.as_name()),
1153 /// Indicate it is a proc-macro
1154 pub fn is_proc_macro(&self) -> bool {
1155 matches!(self.id.kind, MacroDefKind::ProcMacro(..))
1158 /// Indicate it is a derive macro
1159 pub fn is_derive_macro(&self) -> bool {
1160 // FIXME: wrong for `ProcMacro`
1161 matches!(self.id.kind, MacroDefKind::ProcMacro(..) | MacroDefKind::BuiltInDerive(..))
1165 /// Invariant: `inner.as_assoc_item(db).is_some()`
1166 /// We do not actively enforce this invariant.
1167 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1168 pub enum AssocItem {
1171 TypeAlias(TypeAlias),
1174 pub enum AssocItemContainer {
1178 pub trait AsAssocItem {
1179 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>;
1182 impl AsAssocItem for Function {
1183 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1184 as_assoc_item(db, AssocItem::Function, self.id)
1187 impl AsAssocItem for Const {
1188 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1189 as_assoc_item(db, AssocItem::Const, self.id)
1192 impl AsAssocItem for TypeAlias {
1193 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1194 as_assoc_item(db, AssocItem::TypeAlias, self.id)
1197 impl AsAssocItem for ModuleDef {
1198 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1200 ModuleDef::Function(it) => it.as_assoc_item(db),
1201 ModuleDef::Const(it) => it.as_assoc_item(db),
1202 ModuleDef::TypeAlias(it) => it.as_assoc_item(db),
1207 fn as_assoc_item<ID, DEF, CTOR, AST>(db: &dyn HirDatabase, ctor: CTOR, id: ID) -> Option<AssocItem>
1209 ID: Lookup<Data = AssocItemLoc<AST>>,
1211 CTOR: FnOnce(DEF) -> AssocItem,
1214 match id.lookup(db.upcast()).container {
1215 AssocContainerId::TraitId(_) | AssocContainerId::ImplId(_) => Some(ctor(DEF::from(id))),
1216 AssocContainerId::ModuleId(_) => None,
1221 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1223 AssocItem::Function(it) => Some(it.name(db)),
1224 AssocItem::Const(it) => it.name(db),
1225 AssocItem::TypeAlias(it) => Some(it.name(db)),
1228 pub fn module(self, db: &dyn HirDatabase) -> Module {
1230 AssocItem::Function(f) => f.module(db),
1231 AssocItem::Const(c) => c.module(db),
1232 AssocItem::TypeAlias(t) => t.module(db),
1235 pub fn container(self, db: &dyn HirDatabase) -> AssocItemContainer {
1236 let container = match self {
1237 AssocItem::Function(it) => it.id.lookup(db.upcast()).container,
1238 AssocItem::Const(it) => it.id.lookup(db.upcast()).container,
1239 AssocItem::TypeAlias(it) => it.id.lookup(db.upcast()).container,
1242 AssocContainerId::TraitId(id) => AssocItemContainer::Trait(id.into()),
1243 AssocContainerId::ImplId(id) => AssocItemContainer::Impl(id.into()),
1244 AssocContainerId::ModuleId(_) => panic!("invalid AssocItem"),
1248 pub fn containing_trait(self, db: &dyn HirDatabase) -> Option<Trait> {
1249 match self.container(db) {
1250 AssocItemContainer::Trait(t) => Some(t),
1256 impl HasVisibility for AssocItem {
1257 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1259 AssocItem::Function(f) => f.visibility(db),
1260 AssocItem::Const(c) => c.visibility(db),
1261 AssocItem::TypeAlias(t) => t.visibility(db),
1266 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1267 pub enum GenericDef {
1271 TypeAlias(TypeAlias),
1273 // enum variants cannot have generics themselves, but their parent enums
1274 // can, and this makes some code easier to write
1276 // consts can have type parameters from their parents (i.e. associated consts of traits)
1281 Adt(Struct, Enum, Union),
1291 pub fn params(self, db: &dyn HirDatabase) -> Vec<GenericParam> {
1292 let generics = db.generic_params(self.into());
1293 let ty_params = generics
1296 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1297 .map(GenericParam::TypeParam);
1298 let lt_params = generics
1301 .map(|(local_id, _)| LifetimeParam {
1302 id: LifetimeParamId { parent: self.into(), local_id },
1304 .map(GenericParam::LifetimeParam);
1305 let const_params = generics
1308 .map(|(local_id, _)| ConstParam { id: ConstParamId { parent: self.into(), local_id } })
1309 .map(GenericParam::ConstParam);
1310 ty_params.chain(lt_params).chain(const_params).collect()
1313 pub fn type_params(self, db: &dyn HirDatabase) -> Vec<TypeParam> {
1314 let generics = db.generic_params(self.into());
1318 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1323 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1325 pub(crate) parent: DefWithBodyId,
1326 pub(crate) pat_id: PatId,
1330 pub fn is_param(self, db: &dyn HirDatabase) -> bool {
1331 let src = self.source(db);
1333 Either::Left(bind_pat) => {
1334 bind_pat.syntax().ancestors().any(|it| ast::Param::can_cast(it.kind()))
1336 Either::Right(_self_param) => true,
1340 // FIXME: why is this an option? It shouldn't be?
1341 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1342 let body = db.body(self.parent);
1343 match &body[self.pat_id] {
1344 Pat::Bind { name, .. } => Some(name.clone()),
1349 pub fn is_self(self, db: &dyn HirDatabase) -> bool {
1350 self.name(db) == Some(name![self])
1353 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1354 let body = db.body(self.parent);
1355 matches!(&body[self.pat_id], Pat::Bind { mode: BindingAnnotation::Mutable, .. })
1358 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1362 pub fn module(self, db: &dyn HirDatabase) -> Module {
1363 self.parent(db).module(db)
1366 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1367 let def = self.parent;
1368 let infer = db.infer(def);
1369 let ty = infer[self.pat_id].clone();
1370 let krate = def.module(db.upcast()).krate();
1371 Type::new(db, krate, def, ty)
1374 pub fn source(self, db: &dyn HirDatabase) -> InFile<Either<ast::IdentPat, ast::SelfParam>> {
1375 let (_body, source_map) = db.body_with_source_map(self.parent);
1376 let src = source_map.pat_syntax(self.pat_id).unwrap(); // Hmm...
1377 let root = src.file_syntax(db.upcast());
1379 ast.map_left(|it| it.cast().unwrap().to_node(&root)).map_right(|it| it.to_node(&root))
1384 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1386 pub(crate) parent: DefWithBodyId,
1387 pub(crate) label_id: LabelId,
1391 pub fn module(self, db: &dyn HirDatabase) -> Module {
1392 self.parent(db).module(db)
1395 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1399 pub fn name(self, db: &dyn HirDatabase) -> Name {
1400 let body = db.body(self.parent);
1401 body[self.label_id].name.clone()
1404 pub fn source(self, db: &dyn HirDatabase) -> InFile<ast::Label> {
1405 let (_body, source_map) = db.body_with_source_map(self.parent);
1406 let src = source_map.label_syntax(self.label_id);
1407 let root = src.file_syntax(db.upcast());
1408 src.map(|ast| ast.to_node(&root))
1412 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1413 pub enum GenericParam {
1414 TypeParam(TypeParam),
1415 LifetimeParam(LifetimeParam),
1416 ConstParam(ConstParam),
1418 impl_from!(TypeParam, LifetimeParam, ConstParam for GenericParam);
1421 pub fn module(self, db: &dyn HirDatabase) -> Module {
1423 GenericParam::TypeParam(it) => it.module(db),
1424 GenericParam::LifetimeParam(it) => it.module(db),
1425 GenericParam::ConstParam(it) => it.module(db),
1429 pub fn name(self, db: &dyn HirDatabase) -> Name {
1431 GenericParam::TypeParam(it) => it.name(db),
1432 GenericParam::LifetimeParam(it) => it.name(db),
1433 GenericParam::ConstParam(it) => it.name(db),
1438 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1439 pub struct TypeParam {
1440 pub(crate) id: TypeParamId,
1444 pub fn name(self, db: &dyn HirDatabase) -> Name {
1445 let params = db.generic_params(self.id.parent);
1446 params.types[self.id.local_id].name.clone().unwrap_or_else(Name::missing)
1449 pub fn module(self, db: &dyn HirDatabase) -> Module {
1450 self.id.parent.module(db.upcast()).into()
1453 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1454 let resolver = self.id.parent.resolver(db.upcast());
1455 let krate = self.id.parent.module(db.upcast()).krate();
1456 let ty = TyKind::Placeholder(hir_ty::to_placeholder_idx(db, self.id)).intern(&Interner);
1457 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1460 pub fn trait_bounds(self, db: &dyn HirDatabase) -> Vec<Trait> {
1461 db.generic_predicates_for_param(self.id)
1463 .filter_map(|pred| match &pred.value {
1464 hir_ty::WhereClause::Implemented(trait_ref) => {
1465 Some(Trait::from(trait_ref.hir_trait_id()))
1472 pub fn default(self, db: &dyn HirDatabase) -> Option<Type> {
1473 let params = db.generic_defaults(self.id.parent);
1474 let local_idx = hir_ty::param_idx(db, self.id)?;
1475 let resolver = self.id.parent.resolver(db.upcast());
1476 let krate = self.id.parent.module(db.upcast()).krate();
1477 let ty = params.get(local_idx)?.clone();
1478 let subst = Substitution::type_params(db, self.id.parent);
1479 let ty = ty.subst(&subst.prefix(local_idx));
1480 Some(Type::new_with_resolver_inner(db, krate, &resolver, ty))
1484 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1485 pub struct LifetimeParam {
1486 pub(crate) id: LifetimeParamId,
1489 impl LifetimeParam {
1490 pub fn name(self, db: &dyn HirDatabase) -> Name {
1491 let params = db.generic_params(self.id.parent);
1492 params.lifetimes[self.id.local_id].name.clone()
1495 pub fn module(self, db: &dyn HirDatabase) -> Module {
1496 self.id.parent.module(db.upcast()).into()
1499 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1500 self.id.parent.into()
1504 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1505 pub struct ConstParam {
1506 pub(crate) id: ConstParamId,
1510 pub fn name(self, db: &dyn HirDatabase) -> Name {
1511 let params = db.generic_params(self.id.parent);
1512 params.consts[self.id.local_id].name.clone()
1515 pub fn module(self, db: &dyn HirDatabase) -> Module {
1516 self.id.parent.module(db.upcast()).into()
1519 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1520 self.id.parent.into()
1523 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1524 let def = self.id.parent;
1525 let krate = def.module(db.upcast()).krate();
1526 Type::new(db, krate, def, db.const_param_ty(self.id))
1530 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1532 pub(crate) id: ImplId,
1536 pub fn all_in_crate(db: &dyn HirDatabase, krate: Crate) -> Vec<Impl> {
1537 let inherent = db.inherent_impls_in_crate(krate.id);
1538 let trait_ = db.trait_impls_in_crate(krate.id);
1540 inherent.all_impls().chain(trait_.all_impls()).map(Self::from).collect()
1543 pub fn all_for_type(db: &dyn HirDatabase, Type { krate, ty }: Type) -> Vec<Impl> {
1544 let def_crates = match ty.value.def_crates(db, krate) {
1545 Some(def_crates) => def_crates,
1546 None => return Vec::new(),
1549 let filter = |impl_def: &Impl| {
1550 let target_ty = impl_def.target_ty(db);
1551 let rref = target_ty.remove_ref();
1552 ty.value.equals_ctor(rref.as_ref().map_or(&target_ty.ty.value, |it| &it.ty.value))
1555 let mut all = Vec::new();
1556 def_crates.iter().for_each(|&id| {
1557 all.extend(db.inherent_impls_in_crate(id).all_impls().map(Self::from).filter(filter))
1559 let fp = TyFingerprint::for_impl(&ty.value);
1560 for id in def_crates
1562 .flat_map(|&id| Crate { id }.transitive_reverse_dependencies(db))
1563 .map(|Crate { id }| id)
1564 .chain(def_crates.iter().copied())
1568 Some(fp) => all.extend(
1569 db.trait_impls_in_crate(id).for_self_ty(fp).map(Self::from).filter(filter),
1572 .extend(db.trait_impls_in_crate(id).all_impls().map(Self::from).filter(filter)),
1578 pub fn all_for_trait(db: &dyn HirDatabase, trait_: Trait) -> Vec<Impl> {
1579 let krate = trait_.module(db).krate();
1580 let mut all = Vec::new();
1581 for Crate { id } in krate.transitive_reverse_dependencies(db).into_iter().chain(Some(krate))
1583 let impls = db.trait_impls_in_crate(id);
1584 all.extend(impls.for_trait(trait_.id).map(Self::from))
1589 // FIXME: the return type is wrong. This should be a hir version of
1590 // `TraitRef` (ie, resolved `TypeRef`).
1591 pub fn target_trait(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1592 db.impl_data(self.id).target_trait.clone()
1595 pub fn target_ty(self, db: &dyn HirDatabase) -> Type {
1596 let impl_data = db.impl_data(self.id);
1597 let resolver = self.id.resolver(db.upcast());
1598 let krate = self.id.lookup(db.upcast()).container.krate();
1599 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1600 let ty = ctx.lower_ty(&impl_data.target_type);
1601 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1604 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1605 db.impl_data(self.id).items.iter().map(|it| (*it).into()).collect()
1608 pub fn is_negative(self, db: &dyn HirDatabase) -> bool {
1609 db.impl_data(self.id).is_negative
1612 pub fn module(self, db: &dyn HirDatabase) -> Module {
1613 self.id.lookup(db.upcast()).container.into()
1616 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1617 Crate { id: self.module(db).id.krate() }
1620 pub fn is_builtin_derive(self, db: &dyn HirDatabase) -> Option<InFile<ast::Attr>> {
1621 let src = self.source(db)?;
1622 let item = src.file_id.is_builtin_derive(db.upcast())?;
1623 let hygenic = hir_expand::hygiene::Hygiene::new(db.upcast(), item.file_id);
1625 // FIXME: handle `cfg_attr`
1630 let path = ModPath::from_src(it.path()?, &hygenic)?;
1631 if path.as_ident()?.to_string() == "derive" {
1639 Some(item.with_value(attr))
1643 #[derive(Clone, PartialEq, Eq, Debug)]
1646 ty: InEnvironment<Ty>,
1650 pub(crate) fn new_with_resolver(
1651 db: &dyn HirDatabase,
1652 resolver: &Resolver,
1655 let krate = resolver.krate()?;
1656 Some(Type::new_with_resolver_inner(db, krate, resolver, ty))
1658 pub(crate) fn new_with_resolver_inner(
1659 db: &dyn HirDatabase,
1661 resolver: &Resolver,
1665 resolver.generic_def().map_or_else(Default::default, |d| db.trait_environment(d));
1666 Type { krate, ty: InEnvironment { value: ty, environment } }
1669 fn new(db: &dyn HirDatabase, krate: CrateId, lexical_env: impl HasResolver, ty: Ty) -> Type {
1670 let resolver = lexical_env.resolver(db.upcast());
1672 resolver.generic_def().map_or_else(Default::default, |d| db.trait_environment(d));
1673 Type { krate, ty: InEnvironment { value: ty, environment } }
1677 db: &dyn HirDatabase,
1679 def: impl HasResolver + Into<TyDefId> + Into<GenericDefId>,
1681 let substs = Substitution::build_for_def(db, def).fill_with_unknown().build();
1682 let ty = db.ty(def.into()).subst(&substs);
1683 Type::new(db, krate, def, ty)
1686 pub fn is_unit(&self) -> bool {
1687 matches!(self.ty.value.interned(&Interner), TyKind::Tuple(0, ..))
1689 pub fn is_bool(&self) -> bool {
1690 matches!(self.ty.value.interned(&Interner), TyKind::Scalar(Scalar::Bool))
1693 pub fn is_mutable_reference(&self) -> bool {
1694 matches!(self.ty.value.interned(&Interner), TyKind::Ref(hir_ty::Mutability::Mut, ..))
1697 pub fn is_usize(&self) -> bool {
1698 matches!(self.ty.value.interned(&Interner), TyKind::Scalar(Scalar::Uint(UintTy::Usize)))
1701 pub fn remove_ref(&self) -> Option<Type> {
1702 match &self.ty.value.interned(&Interner) {
1703 TyKind::Ref(.., ty) => Some(self.derived(ty.clone())),
1708 pub fn is_unknown(&self) -> bool {
1709 self.ty.value.is_unknown()
1712 /// Checks that particular type `ty` implements `std::future::Future`.
1713 /// This function is used in `.await` syntax completion.
1714 pub fn impls_future(&self, db: &dyn HirDatabase) -> bool {
1715 // No special case for the type of async block, since Chalk can figure it out.
1717 let krate = self.krate;
1719 let std_future_trait =
1720 db.lang_item(krate, "future_trait".into()).and_then(|it| it.as_trait());
1721 let std_future_trait = match std_future_trait {
1723 None => return false,
1726 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1727 method_resolution::implements_trait(
1730 self.ty.environment.clone(),
1736 /// Checks that particular type `ty` implements `std::ops::FnOnce`.
1738 /// This function can be used to check if a particular type is callable, since FnOnce is a
1739 /// supertrait of Fn and FnMut, so all callable types implements at least FnOnce.
1740 pub fn impls_fnonce(&self, db: &dyn HirDatabase) -> bool {
1741 let krate = self.krate;
1743 let fnonce_trait = match FnTrait::FnOnce.get_id(db, krate) {
1745 None => return false,
1748 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1749 method_resolution::implements_trait_unique(
1752 self.ty.environment.clone(),
1758 pub fn impls_trait(&self, db: &dyn HirDatabase, trait_: Trait, args: &[Type]) -> bool {
1759 let trait_ref = hir_ty::TraitRef {
1760 trait_id: hir_ty::to_chalk_trait_id(trait_.id),
1761 substitution: Substitution::build_for_def(db, trait_.id)
1762 .push(self.ty.value.clone())
1763 .fill(args.iter().map(|t| t.ty.value.clone()))
1767 let goal = Canonical {
1768 value: hir_ty::InEnvironment::new(
1769 self.ty.environment.clone(),
1770 trait_ref.cast(&Interner),
1772 kinds: Arc::new([]),
1775 db.trait_solve(self.krate, goal).is_some()
1778 pub fn normalize_trait_assoc_type(
1780 db: &dyn HirDatabase,
1785 let subst = Substitution::build_for_def(db, trait_.id)
1786 .push(self.ty.value.clone())
1787 .fill(args.iter().map(|t| t.ty.value.clone()))
1789 let goal = Canonical {
1790 value: InEnvironment::new(
1791 self.ty.environment.clone(),
1793 alias: AliasTy::Projection(ProjectionTy {
1794 associated_ty_id: to_assoc_type_id(alias.id),
1795 substitution: subst,
1797 ty: TyKind::BoundVar(BoundVar::new(DebruijnIndex::INNERMOST, 0))
1802 kinds: Arc::new([TyVariableKind::General]),
1805 match db.trait_solve(self.krate, goal)? {
1806 Solution::Unique(SolutionVariables(subst)) => {
1807 subst.value.first().map(|ty| self.derived(ty.clone()))
1809 Solution::Ambig(_) => None,
1813 pub fn is_copy(&self, db: &dyn HirDatabase) -> bool {
1814 let lang_item = db.lang_item(self.krate, SmolStr::new("copy"));
1815 let copy_trait = match lang_item {
1816 Some(LangItemTarget::TraitId(it)) => it,
1819 self.impls_trait(db, copy_trait.into(), &[])
1822 pub fn as_callable(&self, db: &dyn HirDatabase) -> Option<Callable> {
1823 let def = self.ty.value.callable_def(db);
1825 let sig = self.ty.value.callable_sig(db)?;
1826 Some(Callable { ty: self.clone(), sig, def, is_bound_method: false })
1829 pub fn is_closure(&self) -> bool {
1830 matches!(&self.ty.value.interned(&Interner), TyKind::Closure { .. })
1833 pub fn is_fn(&self) -> bool {
1834 matches!(&self.ty.value.interned(&Interner), TyKind::FnDef(..) | TyKind::Function { .. })
1837 pub fn is_packed(&self, db: &dyn HirDatabase) -> bool {
1838 let adt_id = match self.ty.value.interned(&Interner) {
1839 &TyKind::Adt(hir_ty::AdtId(adt_id), ..) => adt_id,
1843 let adt = adt_id.into();
1845 Adt::Struct(s) => matches!(s.repr(db), Some(ReprKind::Packed)),
1850 pub fn is_raw_ptr(&self) -> bool {
1851 matches!(&self.ty.value.interned(&Interner), TyKind::Raw(..))
1854 pub fn contains_unknown(&self) -> bool {
1855 return go(&self.ty.value);
1857 fn go(ty: &Ty) -> bool {
1858 match ty.interned(&Interner) {
1859 TyKind::Unknown => true,
1861 TyKind::Adt(_, substs)
1862 | TyKind::AssociatedType(_, substs)
1863 | TyKind::Tuple(_, substs)
1864 | TyKind::OpaqueType(_, substs)
1865 | TyKind::FnDef(_, substs)
1866 | TyKind::Closure(_, substs) => substs.iter().any(go),
1868 TyKind::Array(ty) | TyKind::Slice(ty) | TyKind::Raw(_, ty) | TyKind::Ref(_, ty) => {
1875 | TyKind::Placeholder(_)
1876 | TyKind::BoundVar(_)
1877 | TyKind::InferenceVar(_, _)
1879 | TyKind::Function(_)
1881 | TyKind::ForeignType(_) => false,
1886 pub fn fields(&self, db: &dyn HirDatabase) -> Vec<(Field, Type)> {
1887 let (variant_id, substs) = match self.ty.value.interned(&Interner) {
1888 &TyKind::Adt(hir_ty::AdtId(AdtId::StructId(s)), ref substs) => (s.into(), substs),
1889 &TyKind::Adt(hir_ty::AdtId(AdtId::UnionId(u)), ref substs) => (u.into(), substs),
1890 _ => return Vec::new(),
1893 db.field_types(variant_id)
1895 .map(|(local_id, ty)| {
1896 let def = Field { parent: variant_id.into(), id: local_id };
1897 let ty = ty.clone().subst(substs);
1898 (def, self.derived(ty))
1903 pub fn tuple_fields(&self, _db: &dyn HirDatabase) -> Vec<Type> {
1904 if let TyKind::Tuple(_, substs) = &self.ty.value.interned(&Interner) {
1905 substs.iter().map(|ty| self.derived(ty.clone())).collect()
1911 pub fn autoderef<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Type> + 'a {
1912 // There should be no inference vars in types passed here
1913 // FIXME check that?
1914 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1915 let environment = self.ty.environment.clone();
1916 let ty = InEnvironment { value: canonical, environment };
1917 autoderef(db, Some(self.krate), ty)
1918 .map(|canonical| canonical.value)
1919 .map(move |ty| self.derived(ty))
1922 // This would be nicer if it just returned an iterator, but that runs into
1923 // lifetime problems, because we need to borrow temp `CrateImplDefs`.
1924 pub fn iterate_assoc_items<T>(
1926 db: &dyn HirDatabase,
1928 mut callback: impl FnMut(AssocItem) -> Option<T>,
1930 for krate in self.ty.value.def_crates(db, krate.id)? {
1931 let impls = db.inherent_impls_in_crate(krate);
1933 for impl_def in impls.for_self_ty(&self.ty.value) {
1934 for &item in db.impl_data(*impl_def).items.iter() {
1935 if let Some(result) = callback(item.into()) {
1936 return Some(result);
1944 pub fn type_parameters(&self) -> impl Iterator<Item = Type> + '_ {
1950 .flat_map(|substs| substs.iter())
1951 .map(move |ty| self.derived(ty.clone()))
1954 pub fn iterate_method_candidates<T>(
1956 db: &dyn HirDatabase,
1958 traits_in_scope: &FxHashSet<TraitId>,
1959 name: Option<&Name>,
1960 mut callback: impl FnMut(&Ty, Function) -> Option<T>,
1962 // There should be no inference vars in types passed here
1963 // FIXME check that?
1964 // FIXME replace Unknown by bound vars here
1965 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1967 let env = self.ty.environment.clone();
1968 let krate = krate.id;
1970 let from_module = match self.as_adt() {
1971 Some(adt) => Some(adt.module(db).id),
1975 method_resolution::iterate_method_candidates(
1983 method_resolution::LookupMode::MethodCall,
1985 AssocItemId::FunctionId(f) => callback(ty, f.into()),
1991 pub fn iterate_path_candidates<T>(
1993 db: &dyn HirDatabase,
1995 traits_in_scope: &FxHashSet<TraitId>,
1996 name: Option<&Name>,
1997 mut callback: impl FnMut(&Ty, AssocItem) -> Option<T>,
1999 // There should be no inference vars in types passed here
2000 // FIXME check that?
2001 // FIXME replace Unknown by bound vars here
2002 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
2004 let env = self.ty.environment.clone();
2005 let krate = krate.id;
2007 method_resolution::iterate_method_candidates(
2015 method_resolution::LookupMode::Path,
2016 |ty, it| callback(ty, it.into()),
2020 pub fn as_adt(&self) -> Option<Adt> {
2021 let (adt, _subst) = self.ty.value.as_adt()?;
2025 pub fn as_dyn_trait(&self) -> Option<Trait> {
2026 self.ty.value.dyn_trait().map(Into::into)
2029 pub fn as_impl_traits(&self, db: &dyn HirDatabase) -> Option<Vec<Trait>> {
2030 self.ty.value.impl_trait_bounds(db).map(|it| {
2032 .filter_map(|pred| match pred {
2033 hir_ty::WhereClause::Implemented(trait_ref) => {
2034 Some(Trait::from(trait_ref.hir_trait_id()))
2042 pub fn as_associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<Trait> {
2043 self.ty.value.associated_type_parent_trait(db).map(Into::into)
2046 fn derived(&self, ty: Ty) -> Type {
2049 ty: InEnvironment { value: ty, environment: self.ty.environment.clone() },
2053 pub fn walk(&self, db: &dyn HirDatabase, mut cb: impl FnMut(Type)) {
2054 // TypeWalk::walk for a Ty at first visits parameters and only after that the Ty itself.
2055 // We need a different order here.
2058 db: &dyn HirDatabase,
2060 substs: &Substitution,
2061 cb: &mut impl FnMut(Type),
2063 for ty in substs.iter() {
2064 walk_type(db, &type_.derived(ty.clone()), cb);
2069 db: &dyn HirDatabase,
2071 bounds: &[WhereClause],
2072 cb: &mut impl FnMut(Type),
2074 for pred in bounds {
2076 WhereClause::Implemented(trait_ref) => {
2078 walk_substs(db, type_, &trait_ref.substitution, cb);
2085 fn walk_type(db: &dyn HirDatabase, type_: &Type, cb: &mut impl FnMut(Type)) {
2086 let ty = type_.ty.value.strip_references();
2087 match ty.interned(&Interner) {
2088 TyKind::Adt(..) => {
2089 cb(type_.derived(ty.clone()));
2091 TyKind::AssociatedType(..) => {
2092 if let Some(_) = ty.associated_type_parent_trait(db) {
2093 cb(type_.derived(ty.clone()));
2096 TyKind::OpaqueType(..) => {
2097 if let Some(bounds) = ty.impl_trait_bounds(db) {
2098 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2101 TyKind::Alias(AliasTy::Opaque(opaque_ty)) => {
2102 if let Some(bounds) = ty.impl_trait_bounds(db) {
2103 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2106 walk_substs(db, type_, &opaque_ty.substitution, cb);
2108 TyKind::Placeholder(_) => {
2109 if let Some(bounds) = ty.impl_trait_bounds(db) {
2110 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2113 TyKind::Dyn(bounds) => {
2114 walk_bounds(db, &type_.derived(ty.clone()), bounds.as_ref(), cb);
2117 TyKind::Ref(_, ty) | TyKind::Raw(_, ty) | TyKind::Array(ty) | TyKind::Slice(ty) => {
2118 walk_type(db, &type_.derived(ty.clone()), cb);
2123 if let Some(substs) = ty.substs() {
2124 walk_substs(db, type_, &substs, cb);
2128 walk_type(db, self, &mut cb);
2134 pub struct Callable {
2137 def: Option<CallableDefId>,
2138 pub(crate) is_bound_method: bool,
2141 pub enum CallableKind {
2143 TupleStruct(Struct),
2144 TupleEnumVariant(Variant),
2149 pub fn kind(&self) -> CallableKind {
2151 Some(CallableDefId::FunctionId(it)) => CallableKind::Function(it.into()),
2152 Some(CallableDefId::StructId(it)) => CallableKind::TupleStruct(it.into()),
2153 Some(CallableDefId::EnumVariantId(it)) => CallableKind::TupleEnumVariant(it.into()),
2154 None => CallableKind::Closure,
2157 pub fn receiver_param(&self, db: &dyn HirDatabase) -> Option<ast::SelfParam> {
2158 let func = match self.def {
2159 Some(CallableDefId::FunctionId(it)) if self.is_bound_method => it,
2162 let src = func.lookup(db.upcast()).source(db.upcast());
2163 let param_list = src.value.param_list()?;
2164 param_list.self_param()
2166 pub fn n_params(&self) -> usize {
2167 self.sig.params().len() - if self.is_bound_method { 1 } else { 0 }
2171 db: &dyn HirDatabase,
2172 ) -> Vec<(Option<Either<ast::SelfParam, ast::Pat>>, Type)> {
2177 .skip(if self.is_bound_method { 1 } else { 0 })
2178 .map(|ty| self.ty.derived(ty.clone()));
2179 let patterns = match self.def {
2180 Some(CallableDefId::FunctionId(func)) => {
2181 let src = func.lookup(db.upcast()).source(db.upcast());
2182 src.value.param_list().map(|param_list| {
2185 .map(|it| Some(Either::Left(it)))
2186 .filter(|_| !self.is_bound_method)
2188 .chain(param_list.params().map(|it| it.pat().map(Either::Right)))
2193 patterns.into_iter().flatten().chain(iter::repeat(None)).zip(types).collect()
2195 pub fn return_type(&self) -> Type {
2196 self.ty.derived(self.sig.ret().clone())
2201 #[derive(Debug, PartialEq, Eq, Hash)]
2203 ModuleDef(ModuleDef),
2205 GenericParam(GenericParam),
2213 pub fn all_items(def: PerNs) -> ArrayVec<[Self; 3]> {
2214 let mut items = ArrayVec::new();
2216 match (def.take_types(), def.take_values()) {
2217 (Some(m1), None) => items.push(ScopeDef::ModuleDef(m1.into())),
2218 (None, Some(m2)) => items.push(ScopeDef::ModuleDef(m2.into())),
2219 (Some(m1), Some(m2)) => {
2220 // Some items, like unit structs and enum variants, are
2221 // returned as both a type and a value. Here we want
2222 // to de-duplicate them.
2224 items.push(ScopeDef::ModuleDef(m1.into()));
2225 items.push(ScopeDef::ModuleDef(m2.into()));
2227 items.push(ScopeDef::ModuleDef(m1.into()));
2233 if let Some(macro_def_id) = def.take_macros() {
2234 items.push(ScopeDef::MacroDef(macro_def_id.into()));
2237 if items.is_empty() {
2238 items.push(ScopeDef::Unknown);
2245 impl From<ItemInNs> for ScopeDef {
2246 fn from(item: ItemInNs) -> Self {
2248 ItemInNs::Types(id) => ScopeDef::ModuleDef(id.into()),
2249 ItemInNs::Values(id) => ScopeDef::ModuleDef(id.into()),
2250 ItemInNs::Macros(id) => ScopeDef::MacroDef(id.into()),
2255 pub trait HasVisibility {
2256 fn visibility(&self, db: &dyn HirDatabase) -> Visibility;
2257 fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool {
2258 let vis = self.visibility(db);
2259 vis.is_visible_from(db.upcast(), module.id)