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"]
32 use std::{iter, sync::Arc};
34 use arrayvec::ArrayVec;
35 use base_db::{CrateDisplayName, CrateId, Edition, FileId};
38 adt::{ReprKind, VariantData},
39 expr::{BindingAnnotation, LabelId, Pat, PatId},
40 item_tree::ItemTreeNode,
41 lang_item::LangItemTarget,
43 resolver::{HasResolver, Resolver},
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,
50 use hir_expand::{diagnostics::DiagnosticSink, name::name, MacroDefKind};
53 display::{write_bounds_like_dyn_trait_with_prefix, HirDisplayError, HirFormatter},
54 method_resolution, to_assoc_type_id,
55 traits::{FnTrait, Solution, SolutionVariables},
56 AliasTy, BoundVar, CallableDefId, CallableSig, Canonical, DebruijnIndex, GenericPredicate,
57 InEnvironment, Interner, Obligation, ProjectionPredicate, ProjectionTy, Scalar, Substs, Ty,
58 TyDefId, TyKind, TyVariableKind,
60 use rustc_hash::FxHashSet;
61 use stdx::{format_to, impl_from};
63 ast::{self, AttrsOwner, NameOwner},
66 use tt::{Ident, Leaf, Literal, TokenTree};
68 use crate::db::{DefDatabase, HirDatabase};
71 attrs::{HasAttrs, Namespace},
72 has_source::HasSource,
73 semantics::{PathResolution, Semantics, SemanticsScope},
76 // Be careful with these re-exports.
78 // `hir` is the boundary between the compiler and the IDE. It should try hard to
79 // isolate the compiler from the ide, to allow the two to be refactored
80 // independently. Re-exporting something from the compiler is the sure way to
81 // breach the boundary.
83 // Generally, a refactoring which *removes* a name from this list is a good
88 attr::{Attrs, Documentation},
89 body::scope::ExprScopes,
90 find_path::PrefixKind,
93 nameres::ModuleSource,
94 path::{ModPath, PathKind},
95 type_ref::{Mutability, TypeRef},
96 visibility::Visibility,
100 ExpandResult, HirFileId, InFile, MacroCallId, MacroCallLoc, /* FIXME */ MacroDefId,
103 hir_ty::display::HirDisplay,
106 // These are negative re-exports: pub using these names is forbidden, they
107 // should remain private to hir internals.
111 hir_expand::{hygiene::Hygiene, name::AsName},
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
117 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
119 pub(crate) id: CrateId,
123 pub struct CrateDependency {
129 pub fn dependencies(self, db: &dyn HirDatabase) -> Vec<CrateDependency> {
130 db.crate_graph()[self.id]
134 let krate = Crate { id: dep.crate_id };
135 let name = dep.as_name();
136 CrateDependency { krate, name }
141 // FIXME: add `transitive_reverse_dependencies`.
142 pub fn reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
143 let crate_graph = db.crate_graph();
147 crate_graph[krate].dependencies.iter().any(|it| it.crate_id == self.id)
149 .map(|id| Crate { id })
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()) }
158 pub fn root_file(self, db: &dyn HirDatabase) -> FileId {
159 db.crate_graph()[self.id].root_file_id
162 pub fn edition(self, db: &dyn HirDatabase) -> Edition {
163 db.crate_graph()[self.id].edition
166 pub fn display_name(self, db: &dyn HirDatabase) -> Option<CrateDisplayName> {
167 db.crate_graph()[self.id].display_name.clone()
170 pub fn query_external_importables(
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()),
181 pub fn all(db: &dyn HirDatabase) -> Vec<Crate> {
182 db.crate_graph().iter().map(|id| Crate { id }).collect()
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");
191 if !doc_attr_q.exists() {
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"))
202 Some(TokenTree::Leaf(Leaf::Literal(Literal{ref text, ..}))) => Some(text),
205 }).flat_map(|t| t).next();
207 doc_url.map(|s| s.trim_matches('"').trim_end_matches('/').to_owned() + "/")
211 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
213 pub(crate) id: ModuleId,
216 /// The defs which can be visible in the module.
217 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
222 // Can't be directly declared, but can be imported.
227 TypeAlias(TypeAlias),
228 BuiltinType(BuiltinType),
233 Adt(Struct, Enum, Union),
243 impl From<VariantDef> for ModuleDef {
244 fn from(var: VariantDef) -> Self {
246 VariantDef::Struct(t) => Adt::from(t).into(),
247 VariantDef::Union(t) => Adt::from(t).into(),
248 VariantDef::Variant(t) => t.into(),
254 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
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,
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()))
275 Some(segments.join("::"))
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)));
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,
295 module.visibility_of(db, self)
298 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
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 ModuleDef::BuiltinType(it) => Some(it.name()),
312 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
313 let id = match self {
314 ModuleDef::Adt(it) => match it {
315 Adt::Struct(it) => it.id.into(),
316 Adt::Enum(it) => it.id.into(),
317 Adt::Union(it) => it.id.into(),
319 ModuleDef::Trait(it) => it.id.into(),
320 ModuleDef::Function(it) => it.id.into(),
321 ModuleDef::TypeAlias(it) => it.id.into(),
322 ModuleDef::Module(it) => it.id.into(),
323 ModuleDef::Const(it) => it.id.into(),
324 ModuleDef::Static(it) => it.id.into(),
328 let module = match self.module(db) {
333 hir_ty::diagnostics::validate_module_item(db, module.id.krate(), id, sink)
338 /// Name of this module.
339 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
340 let def_map = self.id.def_map(db.upcast());
341 let parent = def_map[self.id.local_id].parent?;
342 def_map[parent].children.iter().find_map(|(name, module_id)| {
343 if *module_id == self.id.local_id {
351 /// Returns the crate this module is part of.
352 pub fn krate(self) -> Crate {
353 Crate { id: self.id.krate() }
356 /// Topmost parent of this module. Every module has a `crate_root`, but some
357 /// might be missing `krate`. This can happen if a module's file is not included
358 /// in the module tree of any target in `Cargo.toml`.
359 pub fn crate_root(self, db: &dyn HirDatabase) -> Module {
360 let def_map = db.crate_def_map(self.id.krate());
361 Module { id: def_map.module_id(def_map.root()) }
364 /// Iterates over all child modules.
365 pub fn children(self, db: &dyn HirDatabase) -> impl Iterator<Item = Module> {
366 let def_map = self.id.def_map(db.upcast());
367 let children = def_map[self.id.local_id]
370 .map(|(_, module_id)| Module { id: def_map.module_id(*module_id) })
371 .collect::<Vec<_>>();
375 /// Finds a parent module.
376 pub fn parent(self, db: &dyn HirDatabase) -> Option<Module> {
377 // FIXME: handle block expressions as modules (their parent is in a different DefMap)
378 let def_map = self.id.def_map(db.upcast());
379 let parent_id = def_map[self.id.local_id].parent?;
380 Some(Module { id: def_map.module_id(parent_id) })
383 pub fn path_to_root(self, db: &dyn HirDatabase) -> Vec<Module> {
384 let mut res = vec![self];
386 while let Some(next) = curr.parent(db) {
393 /// Returns a `ModuleScope`: a set of items, visible in this module.
396 db: &dyn HirDatabase,
397 visible_from: Option<Module>,
398 ) -> Vec<(Name, ScopeDef)> {
399 self.id.def_map(db.upcast())[self.id.local_id]
402 .filter_map(|(name, def)| {
403 if let Some(m) = visible_from {
405 def.filter_visibility(|vis| vis.is_visible_from(db.upcast(), m.id));
406 if filtered.is_none() && !def.is_none() {
409 Some((name, filtered))
415 .flat_map(|(name, def)| {
416 ScopeDef::all_items(def).into_iter().map(move |item| (name.clone(), item))
421 pub fn visibility_of(self, db: &dyn HirDatabase, def: &ModuleDef) -> Option<Visibility> {
422 self.id.def_map(db.upcast())[self.id.local_id].scope.visibility_of(def.clone().into())
425 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
426 let _p = profile::span("Module::diagnostics").detail(|| {
427 format!("{:?}", self.name(db).map_or("<unknown>".into(), |name| name.to_string()))
429 let def_map = self.id.def_map(db.upcast());
430 def_map.add_diagnostics(db.upcast(), self.id.local_id, sink);
431 for decl in self.declarations(db) {
433 crate::ModuleDef::Function(f) => f.diagnostics(db, sink),
434 crate::ModuleDef::Module(m) => {
435 // Only add diagnostics from inline modules
436 if def_map[m.id.local_id].origin.is_inline() {
437 m.diagnostics(db, sink)
441 decl.diagnostics(db, sink);
446 for impl_def in self.impl_defs(db) {
447 for item in impl_def.items(db) {
448 if let AssocItem::Function(f) = item {
449 f.diagnostics(db, sink);
455 pub fn declarations(self, db: &dyn HirDatabase) -> Vec<ModuleDef> {
456 let def_map = self.id.def_map(db.upcast());
457 def_map[self.id.local_id].scope.declarations().map(ModuleDef::from).collect()
460 pub fn impl_defs(self, db: &dyn HirDatabase) -> Vec<Impl> {
461 let def_map = self.id.def_map(db.upcast());
462 def_map[self.id.local_id].scope.impls().map(Impl::from).collect()
465 /// Finds a path that can be used to refer to the given item from within
466 /// this module, if possible.
467 pub fn find_use_path(self, db: &dyn DefDatabase, item: impl Into<ItemInNs>) -> Option<ModPath> {
468 hir_def::find_path::find_path(db, item.into(), self.into())
471 /// Finds a path that can be used to refer to the given item from within
472 /// this module, if possible. This is used for returning import paths for use-statements.
473 pub fn find_use_path_prefixed(
475 db: &dyn DefDatabase,
476 item: impl Into<ItemInNs>,
477 prefix_kind: PrefixKind,
478 ) -> Option<ModPath> {
479 hir_def::find_path::find_path_prefixed(db, item.into(), self.into(), prefix_kind)
483 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
485 pub(crate) parent: VariantDef,
486 pub(crate) id: LocalFieldId,
489 #[derive(Debug, PartialEq, Eq)]
490 pub enum FieldSource {
491 Named(ast::RecordField),
492 Pos(ast::TupleField),
496 pub fn name(&self, db: &dyn HirDatabase) -> Name {
497 self.parent.variant_data(db).fields()[self.id].name.clone()
500 /// Returns the type as in the signature of the struct (i.e., with
501 /// placeholder types for type parameters). This is good for showing
502 /// signature help, but not so good to actually get the type of the field
503 /// when you actually have a variable of the struct.
504 pub fn signature_ty(&self, db: &dyn HirDatabase) -> Type {
505 let var_id = self.parent.into();
506 let generic_def_id: GenericDefId = match self.parent {
507 VariantDef::Struct(it) => it.id.into(),
508 VariantDef::Union(it) => it.id.into(),
509 VariantDef::Variant(it) => it.parent.id.into(),
511 let substs = Substs::type_params(db, generic_def_id);
512 let ty = db.field_types(var_id)[self.id].clone().subst(&substs);
513 Type::new(db, self.parent.module(db).id.krate(), var_id, ty)
516 pub fn parent_def(&self, _db: &dyn HirDatabase) -> VariantDef {
521 impl HasVisibility for Field {
522 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
523 let variant_data = self.parent.variant_data(db);
524 let visibility = &variant_data.fields()[self.id].visibility;
525 let parent_id: hir_def::VariantId = self.parent.into();
526 visibility.resolve(db.upcast(), &parent_id.resolver(db.upcast()))
530 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
532 pub(crate) id: StructId,
536 pub fn module(self, db: &dyn HirDatabase) -> Module {
537 Module { id: self.id.lookup(db.upcast()).container }
540 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
541 Some(self.module(db).krate())
544 pub fn name(self, db: &dyn HirDatabase) -> Name {
545 db.struct_data(self.id).name.clone()
548 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
549 db.struct_data(self.id)
553 .map(|(id, _)| Field { parent: self.into(), id })
557 pub fn ty(self, db: &dyn HirDatabase) -> Type {
558 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
561 pub fn repr(self, db: &dyn HirDatabase) -> Option<ReprKind> {
562 db.struct_data(self.id).repr.clone()
565 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
566 self.variant_data(db).kind()
569 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
570 db.struct_data(self.id).variant_data.clone()
574 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
576 pub(crate) id: UnionId,
580 pub fn name(self, db: &dyn HirDatabase) -> Name {
581 db.union_data(self.id).name.clone()
584 pub fn module(self, db: &dyn HirDatabase) -> Module {
585 Module { id: self.id.lookup(db.upcast()).container }
588 pub fn ty(self, db: &dyn HirDatabase) -> Type {
589 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
592 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
593 db.union_data(self.id)
597 .map(|(id, _)| Field { parent: self.into(), id })
601 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
602 db.union_data(self.id).variant_data.clone()
606 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
608 pub(crate) id: EnumId,
612 pub fn module(self, db: &dyn HirDatabase) -> Module {
613 Module { id: self.id.lookup(db.upcast()).container }
616 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
617 Some(self.module(db).krate())
620 pub fn name(self, db: &dyn HirDatabase) -> Name {
621 db.enum_data(self.id).name.clone()
624 pub fn variants(self, db: &dyn HirDatabase) -> Vec<Variant> {
625 db.enum_data(self.id).variants.iter().map(|(id, _)| Variant { parent: self, id }).collect()
628 pub fn ty(self, db: &dyn HirDatabase) -> Type {
629 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
633 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
635 pub(crate) parent: Enum,
636 pub(crate) id: LocalEnumVariantId,
640 pub fn module(self, db: &dyn HirDatabase) -> Module {
641 self.parent.module(db)
643 pub fn parent_enum(self, _db: &dyn HirDatabase) -> Enum {
647 pub fn name(self, db: &dyn HirDatabase) -> Name {
648 db.enum_data(self.parent.id).variants[self.id].name.clone()
651 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
652 self.variant_data(db)
655 .map(|(id, _)| Field { parent: self.into(), id })
659 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
660 self.variant_data(db).kind()
663 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
664 db.enum_data(self.parent.id).variants[self.id].variant_data.clone()
669 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
675 impl_from!(Struct, Union, Enum for Adt);
678 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
679 let subst = db.generic_defaults(self.into());
680 subst.iter().any(|ty| ty.value.is_unknown())
683 /// Turns this ADT into a type. Any type parameters of the ADT will be
684 /// turned into unknown types, which is good for e.g. finding the most
685 /// general set of completions, but will not look very nice when printed.
686 pub fn ty(self, db: &dyn HirDatabase) -> Type {
687 let id = AdtId::from(self);
688 Type::from_def(db, id.module(db.upcast()).krate(), id)
691 pub fn module(self, db: &dyn HirDatabase) -> Module {
693 Adt::Struct(s) => s.module(db),
694 Adt::Union(s) => s.module(db),
695 Adt::Enum(e) => e.module(db),
699 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
700 self.module(db).krate()
703 pub fn name(self, db: &dyn HirDatabase) -> Name {
705 Adt::Struct(s) => s.name(db),
706 Adt::Union(u) => u.name(db),
707 Adt::Enum(e) => e.name(db),
712 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
713 pub enum VariantDef {
718 impl_from!(Struct, Union, Variant for VariantDef);
721 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
723 VariantDef::Struct(it) => it.fields(db),
724 VariantDef::Union(it) => it.fields(db),
725 VariantDef::Variant(it) => it.fields(db),
729 pub fn module(self, db: &dyn HirDatabase) -> Module {
731 VariantDef::Struct(it) => it.module(db),
732 VariantDef::Union(it) => it.module(db),
733 VariantDef::Variant(it) => it.module(db),
737 pub fn name(&self, db: &dyn HirDatabase) -> Name {
739 VariantDef::Struct(s) => s.name(db),
740 VariantDef::Union(u) => u.name(db),
741 VariantDef::Variant(e) => e.name(db),
745 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
747 VariantDef::Struct(it) => it.variant_data(db),
748 VariantDef::Union(it) => it.variant_data(db),
749 VariantDef::Variant(it) => it.variant_data(db),
754 /// The defs which have a body.
755 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
756 pub enum DefWithBody {
761 impl_from!(Function, Const, Static for DefWithBody);
764 pub fn module(self, db: &dyn HirDatabase) -> Module {
766 DefWithBody::Const(c) => c.module(db),
767 DefWithBody::Function(f) => f.module(db),
768 DefWithBody::Static(s) => s.module(db),
772 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
774 DefWithBody::Function(f) => Some(f.name(db)),
775 DefWithBody::Static(s) => s.name(db),
776 DefWithBody::Const(c) => c.name(db),
781 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
782 pub struct Function {
783 pub(crate) id: FunctionId,
787 pub fn module(self, db: &dyn HirDatabase) -> Module {
788 self.id.lookup(db.upcast()).module(db.upcast()).into()
791 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
792 Some(self.module(db).krate())
795 pub fn name(self, db: &dyn HirDatabase) -> Name {
796 db.function_data(self.id).name.clone()
799 /// Get this function's return type
800 pub fn ret_type(self, db: &dyn HirDatabase) -> Type {
801 let resolver = self.id.resolver(db.upcast());
802 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
803 let ret_type = &db.function_data(self.id).ret_type;
804 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
805 let ty = ctx.lower_ty(ret_type);
806 Type::new_with_resolver_inner(db, krate, &resolver, ty)
809 pub fn self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
810 if !db.function_data(self.id).has_self_param {
813 Some(SelfParam { func: self.id })
816 pub fn assoc_fn_params(self, db: &dyn HirDatabase) -> Vec<Param> {
817 let resolver = self.id.resolver(db.upcast());
818 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
819 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
820 let environment = db.trait_environment(self.id.into());
821 db.function_data(self.id)
828 value: ctx.lower_ty(type_ref),
829 environment: environment.clone(),
836 pub fn method_params(self, db: &dyn HirDatabase) -> Option<Vec<Param>> {
837 if self.self_param(db).is_none() {
840 let mut res = self.assoc_fn_params(db);
845 pub fn is_unsafe(self, db: &dyn HirDatabase) -> bool {
846 db.function_data(self.id).is_unsafe
849 pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
850 let krate = self.module(db).id.krate();
851 hir_def::diagnostics::validate_body(db.upcast(), self.id.into(), sink);
852 hir_ty::diagnostics::validate_module_item(db, krate, self.id.into(), sink);
853 hir_ty::diagnostics::validate_body(db, self.id.into(), sink);
856 /// Whether this function declaration has a definition.
858 /// This is false in the case of required (not provided) trait methods.
859 pub fn has_body(self, db: &dyn HirDatabase) -> bool {
860 db.function_data(self.id).has_body
863 /// A textual representation of the HIR of this function for debugging purposes.
864 pub fn debug_hir(self, db: &dyn HirDatabase) -> String {
865 let body = db.body(self.id.into());
867 let mut result = String::new();
868 format_to!(result, "HIR expressions in the body of `{}`:\n", self.name(db));
869 for (id, expr) in body.exprs.iter() {
870 format_to!(result, "{:?}: {:?}\n", id, expr);
877 // Note: logically, this belongs to `hir_ty`, but we are not using it there yet.
884 impl From<hir_ty::Mutability> for Access {
885 fn from(mutability: hir_ty::Mutability) -> Access {
887 hir_ty::Mutability::Not => Access::Shared,
888 hir_ty::Mutability::Mut => Access::Exclusive,
899 pub fn ty(&self) -> &Type {
904 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
905 pub struct SelfParam {
910 pub fn access(self, db: &dyn HirDatabase) -> Access {
911 let func_data = db.function_data(self.func);
915 .map(|param| match *param {
916 TypeRef::Reference(.., mutability) => match mutability {
917 hir_def::type_ref::Mutability::Shared => Access::Shared,
918 hir_def::type_ref::Mutability::Mut => Access::Exclusive,
922 .unwrap_or(Access::Owned)
926 impl HasVisibility for Function {
927 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
928 let function_data = db.function_data(self.id);
929 let visibility = &function_data.visibility;
930 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
934 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
936 pub(crate) id: ConstId,
940 pub fn module(self, db: &dyn HirDatabase) -> Module {
941 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
944 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
945 Some(self.module(db).krate())
948 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
949 db.const_data(self.id).name.clone()
953 impl HasVisibility for Const {
954 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
955 let function_data = db.const_data(self.id);
956 let visibility = &function_data.visibility;
957 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
961 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
963 pub(crate) id: StaticId,
967 pub fn module(self, db: &dyn HirDatabase) -> Module {
968 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
971 pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
972 Some(self.module(db).krate())
975 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
976 db.static_data(self.id).name.clone()
979 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
980 db.static_data(self.id).mutable
984 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
986 pub(crate) id: TraitId,
990 pub fn module(self, db: &dyn HirDatabase) -> Module {
991 Module { id: self.id.lookup(db.upcast()).container }
994 pub fn name(self, db: &dyn HirDatabase) -> Name {
995 db.trait_data(self.id).name.clone()
998 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
999 db.trait_data(self.id).items.iter().map(|(_name, it)| (*it).into()).collect()
1002 pub fn is_auto(self, db: &dyn HirDatabase) -> bool {
1003 db.trait_data(self.id).auto
1007 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1008 pub struct TypeAlias {
1009 pub(crate) id: TypeAliasId,
1013 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
1014 let subst = db.generic_defaults(self.id.into());
1015 subst.iter().any(|ty| ty.value.is_unknown())
1018 pub fn module(self, db: &dyn HirDatabase) -> Module {
1019 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1022 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1023 self.module(db).krate()
1026 pub fn type_ref(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1027 db.type_alias_data(self.id).type_ref.clone()
1030 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1031 Type::from_def(db, self.id.lookup(db.upcast()).module(db.upcast()).krate(), self.id)
1034 pub fn name(self, db: &dyn HirDatabase) -> Name {
1035 db.type_alias_data(self.id).name.clone()
1039 impl HasVisibility for TypeAlias {
1040 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1041 let function_data = db.type_alias_data(self.id);
1042 let visibility = &function_data.visibility;
1043 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1047 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1048 pub struct BuiltinType {
1049 pub(crate) inner: hir_def::builtin_type::BuiltinType,
1053 pub fn ty(self, db: &dyn HirDatabase, module: Module) -> Type {
1054 let resolver = module.id.resolver(db.upcast());
1055 Type::new_with_resolver(db, &resolver, Ty::builtin(self.inner))
1056 .expect("crate not present in resolver")
1059 pub fn name(self) -> Name {
1060 self.inner.as_name()
1064 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1065 pub struct MacroDef {
1066 pub(crate) id: MacroDefId,
1070 /// FIXME: right now, this just returns the root module of the crate that
1071 /// defines this macro. The reasons for this is that macros are expanded
1072 /// early, in `hir_expand`, where modules simply do not exist yet.
1073 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
1074 let krate = self.id.krate;
1075 let def_map = db.crate_def_map(krate);
1076 let module_id = def_map.root();
1077 Some(Module { id: def_map.module_id(module_id) })
1080 /// XXX: this parses the file
1081 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1082 self.source(db)?.value.name().map(|it| it.as_name())
1085 /// Indicate it is a proc-macro
1086 pub fn is_proc_macro(&self) -> bool {
1087 matches!(self.id.kind, MacroDefKind::ProcMacro(_))
1090 /// Indicate it is a derive macro
1091 pub fn is_derive_macro(&self) -> bool {
1092 matches!(self.id.kind, MacroDefKind::ProcMacro(_) | MacroDefKind::BuiltInDerive(_))
1096 /// Invariant: `inner.as_assoc_item(db).is_some()`
1097 /// We do not actively enforce this invariant.
1098 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1099 pub enum AssocItem {
1102 TypeAlias(TypeAlias),
1105 pub enum AssocItemContainer {
1109 pub trait AsAssocItem {
1110 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>;
1113 impl AsAssocItem for Function {
1114 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1115 as_assoc_item(db, AssocItem::Function, self.id)
1118 impl AsAssocItem for Const {
1119 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1120 as_assoc_item(db, AssocItem::Const, self.id)
1123 impl AsAssocItem for TypeAlias {
1124 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1125 as_assoc_item(db, AssocItem::TypeAlias, self.id)
1128 impl AsAssocItem for ModuleDef {
1129 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1131 ModuleDef::Function(it) => it.as_assoc_item(db),
1132 ModuleDef::Const(it) => it.as_assoc_item(db),
1133 ModuleDef::TypeAlias(it) => it.as_assoc_item(db),
1138 fn as_assoc_item<ID, DEF, CTOR, AST>(db: &dyn HirDatabase, ctor: CTOR, id: ID) -> Option<AssocItem>
1140 ID: Lookup<Data = AssocItemLoc<AST>>,
1142 CTOR: FnOnce(DEF) -> AssocItem,
1145 match id.lookup(db.upcast()).container {
1146 AssocContainerId::TraitId(_) | AssocContainerId::ImplId(_) => Some(ctor(DEF::from(id))),
1147 AssocContainerId::ModuleId(_) => None,
1152 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1154 AssocItem::Function(it) => Some(it.name(db)),
1155 AssocItem::Const(it) => it.name(db),
1156 AssocItem::TypeAlias(it) => Some(it.name(db)),
1159 pub fn module(self, db: &dyn HirDatabase) -> Module {
1161 AssocItem::Function(f) => f.module(db),
1162 AssocItem::Const(c) => c.module(db),
1163 AssocItem::TypeAlias(t) => t.module(db),
1166 pub fn container(self, db: &dyn HirDatabase) -> AssocItemContainer {
1167 let container = match self {
1168 AssocItem::Function(it) => it.id.lookup(db.upcast()).container,
1169 AssocItem::Const(it) => it.id.lookup(db.upcast()).container,
1170 AssocItem::TypeAlias(it) => it.id.lookup(db.upcast()).container,
1173 AssocContainerId::TraitId(id) => AssocItemContainer::Trait(id.into()),
1174 AssocContainerId::ImplId(id) => AssocItemContainer::Impl(id.into()),
1175 AssocContainerId::ModuleId(_) => panic!("invalid AssocItem"),
1179 pub fn containing_trait(self, db: &dyn HirDatabase) -> Option<Trait> {
1180 match self.container(db) {
1181 AssocItemContainer::Trait(t) => Some(t),
1187 impl HasVisibility for AssocItem {
1188 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1190 AssocItem::Function(f) => f.visibility(db),
1191 AssocItem::Const(c) => c.visibility(db),
1192 AssocItem::TypeAlias(t) => t.visibility(db),
1197 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1198 pub enum GenericDef {
1202 TypeAlias(TypeAlias),
1204 // enum variants cannot have generics themselves, but their parent enums
1205 // can, and this makes some code easier to write
1207 // consts can have type parameters from their parents (i.e. associated consts of traits)
1212 Adt(Struct, Enum, Union),
1222 pub fn params(self, db: &dyn HirDatabase) -> Vec<GenericParam> {
1223 let generics = db.generic_params(self.into());
1224 let ty_params = generics
1227 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1228 .map(GenericParam::TypeParam);
1229 let lt_params = generics
1232 .map(|(local_id, _)| LifetimeParam {
1233 id: LifetimeParamId { parent: self.into(), local_id },
1235 .map(GenericParam::LifetimeParam);
1236 let const_params = generics
1239 .map(|(local_id, _)| ConstParam { id: ConstParamId { parent: self.into(), local_id } })
1240 .map(GenericParam::ConstParam);
1241 ty_params.chain(lt_params).chain(const_params).collect()
1244 pub fn type_params(self, db: &dyn HirDatabase) -> Vec<TypeParam> {
1245 let generics = db.generic_params(self.into());
1249 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1254 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1256 pub(crate) parent: DefWithBodyId,
1257 pub(crate) pat_id: PatId,
1261 pub fn is_param(self, db: &dyn HirDatabase) -> bool {
1262 let src = self.source(db);
1264 Either::Left(bind_pat) => {
1265 bind_pat.syntax().ancestors().any(|it| ast::Param::can_cast(it.kind()))
1267 Either::Right(_self_param) => true,
1271 // FIXME: why is this an option? It shouldn't be?
1272 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1273 let body = db.body(self.parent.into());
1274 match &body[self.pat_id] {
1275 Pat::Bind { name, .. } => Some(name.clone()),
1280 pub fn is_self(self, db: &dyn HirDatabase) -> bool {
1281 self.name(db) == Some(name![self])
1284 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1285 let body = db.body(self.parent.into());
1286 matches!(&body[self.pat_id], Pat::Bind { mode: BindingAnnotation::Mutable, .. })
1289 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1293 pub fn module(self, db: &dyn HirDatabase) -> Module {
1294 self.parent(db).module(db)
1297 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1298 let def = DefWithBodyId::from(self.parent);
1299 let infer = db.infer(def);
1300 let ty = infer[self.pat_id].clone();
1301 let krate = def.module(db.upcast()).krate();
1302 Type::new(db, krate, def, ty)
1305 pub fn source(self, db: &dyn HirDatabase) -> InFile<Either<ast::IdentPat, ast::SelfParam>> {
1306 let (_body, source_map) = db.body_with_source_map(self.parent.into());
1307 let src = source_map.pat_syntax(self.pat_id).unwrap(); // Hmm...
1308 let root = src.file_syntax(db.upcast());
1310 ast.map_left(|it| it.cast().unwrap().to_node(&root)).map_right(|it| it.to_node(&root))
1315 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1317 pub(crate) parent: DefWithBodyId,
1318 pub(crate) label_id: LabelId,
1322 pub fn module(self, db: &dyn HirDatabase) -> Module {
1323 self.parent(db).module(db)
1326 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1330 pub fn name(self, db: &dyn HirDatabase) -> Name {
1331 let body = db.body(self.parent.into());
1332 body[self.label_id].name.clone()
1335 pub fn source(self, db: &dyn HirDatabase) -> InFile<ast::Label> {
1336 let (_body, source_map) = db.body_with_source_map(self.parent.into());
1337 let src = source_map.label_syntax(self.label_id);
1338 let root = src.file_syntax(db.upcast());
1339 src.map(|ast| ast.to_node(&root))
1343 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1344 pub enum GenericParam {
1345 TypeParam(TypeParam),
1346 LifetimeParam(LifetimeParam),
1347 ConstParam(ConstParam),
1349 impl_from!(TypeParam, LifetimeParam, ConstParam for GenericParam);
1352 pub fn module(self, db: &dyn HirDatabase) -> Module {
1354 GenericParam::TypeParam(it) => it.module(db),
1355 GenericParam::LifetimeParam(it) => it.module(db),
1356 GenericParam::ConstParam(it) => it.module(db),
1360 pub fn name(self, db: &dyn HirDatabase) -> Name {
1362 GenericParam::TypeParam(it) => it.name(db),
1363 GenericParam::LifetimeParam(it) => it.name(db),
1364 GenericParam::ConstParam(it) => it.name(db),
1369 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1370 pub struct TypeParam {
1371 pub(crate) id: TypeParamId,
1375 pub fn name(self, db: &dyn HirDatabase) -> Name {
1376 let params = db.generic_params(self.id.parent);
1377 params.types[self.id.local_id].name.clone().unwrap_or_else(Name::missing)
1380 pub fn module(self, db: &dyn HirDatabase) -> Module {
1381 self.id.parent.module(db.upcast()).into()
1384 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1385 let resolver = self.id.parent.resolver(db.upcast());
1386 let krate = self.id.parent.module(db.upcast()).krate();
1387 let ty = TyKind::Placeholder(hir_ty::to_placeholder_idx(db, self.id)).intern(&Interner);
1388 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1391 pub fn trait_bounds(self, db: &dyn HirDatabase) -> Vec<Trait> {
1392 db.generic_predicates_for_param(self.id)
1394 .filter_map(|pred| match &pred.value {
1395 hir_ty::GenericPredicate::Implemented(trait_ref) => {
1396 Some(Trait::from(trait_ref.trait_))
1403 pub fn default(self, db: &dyn HirDatabase) -> Option<Type> {
1404 let params = db.generic_defaults(self.id.parent);
1405 let local_idx = hir_ty::param_idx(db, self.id)?;
1406 let resolver = self.id.parent.resolver(db.upcast());
1407 let krate = self.id.parent.module(db.upcast()).krate();
1408 let ty = params.get(local_idx)?.clone();
1409 let subst = Substs::type_params(db, self.id.parent);
1410 let ty = ty.subst(&subst.prefix(local_idx));
1411 Some(Type::new_with_resolver_inner(db, krate, &resolver, ty))
1415 impl HirDisplay for TypeParam {
1416 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1417 write!(f, "{}", self.name(f.db))?;
1418 let bounds = f.db.generic_predicates_for_param(self.id);
1419 let substs = Substs::type_params(f.db, self.id.parent);
1420 let predicates = bounds.iter().cloned().map(|b| b.subst(&substs)).collect::<Vec<_>>();
1421 if !(predicates.is_empty() || f.omit_verbose_types()) {
1422 write_bounds_like_dyn_trait_with_prefix(":", &predicates, f)?;
1428 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1429 pub struct LifetimeParam {
1430 pub(crate) id: LifetimeParamId,
1433 impl LifetimeParam {
1434 pub fn name(self, db: &dyn HirDatabase) -> Name {
1435 let params = db.generic_params(self.id.parent);
1436 params.lifetimes[self.id.local_id].name.clone()
1439 pub fn module(self, db: &dyn HirDatabase) -> Module {
1440 self.id.parent.module(db.upcast()).into()
1443 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1444 self.id.parent.into()
1448 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1449 pub struct ConstParam {
1450 pub(crate) id: ConstParamId,
1454 pub fn name(self, db: &dyn HirDatabase) -> Name {
1455 let params = db.generic_params(self.id.parent);
1456 params.consts[self.id.local_id].name.clone()
1459 pub fn module(self, db: &dyn HirDatabase) -> Module {
1460 self.id.parent.module(db.upcast()).into()
1463 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1464 self.id.parent.into()
1467 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1468 let def = self.id.parent;
1469 let krate = def.module(db.upcast()).krate();
1470 Type::new(db, krate, def, db.const_param_ty(self.id))
1474 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1476 pub(crate) id: ImplId,
1480 pub fn all_in_crate(db: &dyn HirDatabase, krate: Crate) -> Vec<Impl> {
1481 let inherent = db.inherent_impls_in_crate(krate.id);
1482 let trait_ = db.trait_impls_in_crate(krate.id);
1484 inherent.all_impls().chain(trait_.all_impls()).map(Self::from).collect()
1487 pub fn all_for_type(db: &dyn HirDatabase, Type { krate, ty }: Type) -> Vec<Impl> {
1488 let def_crates = match ty.value.def_crates(db, krate) {
1489 Some(def_crates) => def_crates,
1490 None => return vec![],
1493 let filter = |impl_def: &Impl| {
1494 let target_ty = impl_def.target_ty(db);
1495 let rref = target_ty.remove_ref();
1496 ty.value.equals_ctor(rref.as_ref().map_or(&target_ty.ty.value, |it| &it.ty.value))
1499 let mut all = Vec::new();
1500 def_crates.iter().for_each(|&id| {
1501 all.extend(db.inherent_impls_in_crate(id).all_impls().map(Self::from).filter(filter))
1503 for id in def_crates
1505 .flat_map(|&id| Crate { id }.reverse_dependencies(db))
1506 .map(|Crate { id }| id)
1507 .chain(def_crates.iter().copied())
1509 all.extend(db.trait_impls_in_crate(id).all_impls().map(Self::from).filter(filter));
1514 pub fn all_for_trait(db: &dyn HirDatabase, trait_: Trait) -> Vec<Impl> {
1515 let krate = trait_.module(db).krate();
1516 let mut all = Vec::new();
1517 for Crate { id } in krate.reverse_dependencies(db).into_iter().chain(Some(krate)) {
1518 let impls = db.trait_impls_in_crate(id);
1519 all.extend(impls.for_trait(trait_.id).map(Self::from))
1524 // FIXME: the return type is wrong. This should be a hir version of
1525 // `TraitRef` (ie, resolved `TypeRef`).
1526 pub fn target_trait(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1527 db.impl_data(self.id).target_trait.clone()
1530 pub fn target_ty(self, db: &dyn HirDatabase) -> Type {
1531 let impl_data = db.impl_data(self.id);
1532 let resolver = self.id.resolver(db.upcast());
1533 let krate = self.id.lookup(db.upcast()).container.krate();
1534 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1535 let ty = ctx.lower_ty(&impl_data.target_type);
1536 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1539 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1540 db.impl_data(self.id).items.iter().map(|it| (*it).into()).collect()
1543 pub fn is_negative(self, db: &dyn HirDatabase) -> bool {
1544 db.impl_data(self.id).is_negative
1547 pub fn module(self, db: &dyn HirDatabase) -> Module {
1548 self.id.lookup(db.upcast()).container.into()
1551 pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1552 Crate { id: self.module(db).id.krate() }
1555 pub fn is_builtin_derive(self, db: &dyn HirDatabase) -> Option<InFile<ast::Attr>> {
1556 let src = self.source(db)?;
1557 let item = src.file_id.is_builtin_derive(db.upcast())?;
1558 let hygenic = hir_expand::hygiene::Hygiene::new(db.upcast(), item.file_id);
1560 // FIXME: handle `cfg_attr`
1565 let path = ModPath::from_src(it.path()?, &hygenic)?;
1566 if path.as_ident()?.to_string() == "derive" {
1574 Some(item.with_value(attr))
1578 #[derive(Clone, PartialEq, Eq, Debug)]
1581 ty: InEnvironment<Ty>,
1585 pub(crate) fn new_with_resolver(
1586 db: &dyn HirDatabase,
1587 resolver: &Resolver,
1590 let krate = resolver.krate()?;
1591 Some(Type::new_with_resolver_inner(db, krate, resolver, ty))
1593 pub(crate) fn new_with_resolver_inner(
1594 db: &dyn HirDatabase,
1596 resolver: &Resolver,
1600 resolver.generic_def().map_or_else(Default::default, |d| db.trait_environment(d));
1601 Type { krate, ty: InEnvironment { value: ty, environment } }
1604 fn new(db: &dyn HirDatabase, krate: CrateId, lexical_env: impl HasResolver, ty: Ty) -> Type {
1605 let resolver = lexical_env.resolver(db.upcast());
1607 resolver.generic_def().map_or_else(Default::default, |d| db.trait_environment(d));
1608 Type { krate, ty: InEnvironment { value: ty, environment } }
1612 db: &dyn HirDatabase,
1614 def: impl HasResolver + Into<TyDefId> + Into<GenericDefId>,
1616 let substs = Substs::build_for_def(db, def).fill_with_unknown().build();
1617 let ty = db.ty(def.into()).subst(&substs);
1618 Type::new(db, krate, def, ty)
1621 pub fn is_unit(&self) -> bool {
1622 matches!(self.ty.value.interned(&Interner), TyKind::Tuple(0, ..))
1624 pub fn is_bool(&self) -> bool {
1625 matches!(self.ty.value.interned(&Interner), TyKind::Scalar(Scalar::Bool))
1628 pub fn is_mutable_reference(&self) -> bool {
1629 matches!(self.ty.value.interned(&Interner), TyKind::Ref(hir_ty::Mutability::Mut, ..))
1632 pub fn remove_ref(&self) -> Option<Type> {
1633 match &self.ty.value.interned(&Interner) {
1634 TyKind::Ref(.., substs) => Some(self.derived(substs[0].clone())),
1639 pub fn is_unknown(&self) -> bool {
1640 self.ty.value.is_unknown()
1643 /// Checks that particular type `ty` implements `std::future::Future`.
1644 /// This function is used in `.await` syntax completion.
1645 pub fn impls_future(&self, db: &dyn HirDatabase) -> bool {
1646 // No special case for the type of async block, since Chalk can figure it out.
1648 let krate = self.krate;
1650 let std_future_trait =
1651 db.lang_item(krate, "future_trait".into()).and_then(|it| it.as_trait());
1652 let std_future_trait = match std_future_trait {
1654 None => return false,
1657 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1658 method_resolution::implements_trait(
1661 self.ty.environment.clone(),
1667 /// Checks that particular type `ty` implements `std::ops::FnOnce`.
1669 /// This function can be used to check if a particular type is callable, since FnOnce is a
1670 /// supertrait of Fn and FnMut, so all callable types implements at least FnOnce.
1671 pub fn impls_fnonce(&self, db: &dyn HirDatabase) -> bool {
1672 let krate = self.krate;
1674 let fnonce_trait = match FnTrait::FnOnce.get_id(db, krate) {
1676 None => return false,
1679 let canonical_ty = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1680 method_resolution::implements_trait_unique(
1683 self.ty.environment.clone(),
1689 pub fn impls_trait(&self, db: &dyn HirDatabase, trait_: Trait, args: &[Type]) -> bool {
1690 let trait_ref = hir_ty::TraitRef {
1692 substs: Substs::build_for_def(db, trait_.id)
1693 .push(self.ty.value.clone())
1694 .fill(args.iter().map(|t| t.ty.value.clone()))
1698 let goal = Canonical {
1699 value: hir_ty::InEnvironment::new(
1700 self.ty.environment.clone(),
1701 hir_ty::Obligation::Trait(trait_ref),
1703 kinds: Arc::new([]),
1706 db.trait_solve(self.krate, goal).is_some()
1709 pub fn normalize_trait_assoc_type(
1711 db: &dyn HirDatabase,
1716 let subst = Substs::build_for_def(db, trait_.id)
1717 .push(self.ty.value.clone())
1718 .fill(args.iter().map(|t| t.ty.value.clone()))
1720 let predicate = ProjectionPredicate {
1721 projection_ty: ProjectionTy {
1722 associated_ty_id: to_assoc_type_id(alias.id),
1723 substitution: subst,
1725 ty: TyKind::BoundVar(BoundVar::new(DebruijnIndex::INNERMOST, 0)).intern(&Interner),
1727 let goal = Canonical {
1728 value: InEnvironment::new(
1729 self.ty.environment.clone(),
1730 Obligation::Projection(predicate),
1732 kinds: Arc::new([TyVariableKind::General]),
1735 match db.trait_solve(self.krate, goal)? {
1736 Solution::Unique(SolutionVariables(subst)) => {
1737 subst.value.first().map(|ty| self.derived(ty.clone()))
1739 Solution::Ambig(_) => None,
1743 pub fn is_copy(&self, db: &dyn HirDatabase) -> bool {
1744 let lang_item = db.lang_item(self.krate, SmolStr::new("copy"));
1745 let copy_trait = match lang_item {
1746 Some(LangItemTarget::TraitId(it)) => it,
1749 self.impls_trait(db, copy_trait.into(), &[])
1752 pub fn as_callable(&self, db: &dyn HirDatabase) -> Option<Callable> {
1753 let def = self.ty.value.callable_def(db);
1755 let sig = self.ty.value.callable_sig(db)?;
1756 Some(Callable { ty: self.clone(), sig, def, is_bound_method: false })
1759 pub fn is_closure(&self) -> bool {
1760 matches!(&self.ty.value.interned(&Interner), TyKind::Closure { .. })
1763 pub fn is_fn(&self) -> bool {
1764 matches!(&self.ty.value.interned(&Interner), TyKind::FnDef(..) | TyKind::Function { .. })
1767 pub fn is_packed(&self, db: &dyn HirDatabase) -> bool {
1768 let adt_id = match self.ty.value.interned(&Interner) {
1769 &TyKind::Adt(hir_ty::AdtId(adt_id), ..) => adt_id,
1773 let adt = adt_id.into();
1775 Adt::Struct(s) => matches!(s.repr(db), Some(ReprKind::Packed)),
1780 pub fn is_raw_ptr(&self) -> bool {
1781 matches!(&self.ty.value.interned(&Interner), TyKind::Raw(..))
1784 pub fn contains_unknown(&self) -> bool {
1785 return go(&self.ty.value);
1787 fn go(ty: &Ty) -> bool {
1788 if ty.is_unknown() {
1791 ty.substs().map_or(false, |substs| substs.iter().any(go))
1796 pub fn fields(&self, db: &dyn HirDatabase) -> Vec<(Field, Type)> {
1797 let (variant_id, substs) = match self.ty.value.interned(&Interner) {
1798 &TyKind::Adt(hir_ty::AdtId(AdtId::StructId(s)), ref substs) => (s.into(), substs),
1799 &TyKind::Adt(hir_ty::AdtId(AdtId::UnionId(u)), ref substs) => (u.into(), substs),
1800 _ => return Vec::new(),
1803 db.field_types(variant_id)
1805 .map(|(local_id, ty)| {
1806 let def = Field { parent: variant_id.into(), id: local_id };
1807 let ty = ty.clone().subst(substs);
1808 (def, self.derived(ty))
1813 pub fn tuple_fields(&self, _db: &dyn HirDatabase) -> Vec<Type> {
1814 if let TyKind::Tuple(_, substs) = &self.ty.value.interned(&Interner) {
1815 substs.iter().map(|ty| self.derived(ty.clone())).collect()
1821 pub fn autoderef<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Type> + 'a {
1822 // There should be no inference vars in types passed here
1823 // FIXME check that?
1824 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1825 let environment = self.ty.environment.clone();
1826 let ty = InEnvironment { value: canonical, environment };
1827 autoderef(db, Some(self.krate), ty)
1828 .map(|canonical| canonical.value)
1829 .map(move |ty| self.derived(ty))
1832 // This would be nicer if it just returned an iterator, but that runs into
1833 // lifetime problems, because we need to borrow temp `CrateImplDefs`.
1834 pub fn iterate_assoc_items<T>(
1836 db: &dyn HirDatabase,
1838 mut callback: impl FnMut(AssocItem) -> Option<T>,
1840 for krate in self.ty.value.def_crates(db, krate.id)? {
1841 let impls = db.inherent_impls_in_crate(krate);
1843 for impl_def in impls.for_self_ty(&self.ty.value) {
1844 for &item in db.impl_data(*impl_def).items.iter() {
1845 if let Some(result) = callback(item.into()) {
1846 return Some(result);
1854 pub fn type_parameters(&self) -> impl Iterator<Item = Type> + '_ {
1860 .flat_map(|substs| substs.iter())
1861 .map(move |ty| self.derived(ty.clone()))
1864 pub fn iterate_method_candidates<T>(
1866 db: &dyn HirDatabase,
1868 traits_in_scope: &FxHashSet<TraitId>,
1869 name: Option<&Name>,
1870 mut callback: impl FnMut(&Ty, Function) -> Option<T>,
1872 // There should be no inference vars in types passed here
1873 // FIXME check that?
1874 // FIXME replace Unknown by bound vars here
1875 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1877 let env = self.ty.environment.clone();
1878 let krate = krate.id;
1880 method_resolution::iterate_method_candidates(
1887 method_resolution::LookupMode::MethodCall,
1889 AssocItemId::FunctionId(f) => callback(ty, f.into()),
1895 pub fn iterate_path_candidates<T>(
1897 db: &dyn HirDatabase,
1899 traits_in_scope: &FxHashSet<TraitId>,
1900 name: Option<&Name>,
1901 mut callback: impl FnMut(&Ty, AssocItem) -> Option<T>,
1903 // There should be no inference vars in types passed here
1904 // FIXME check that?
1905 // FIXME replace Unknown by bound vars here
1906 let canonical = Canonical { value: self.ty.value.clone(), kinds: Arc::new([]) };
1908 let env = self.ty.environment.clone();
1909 let krate = krate.id;
1911 method_resolution::iterate_method_candidates(
1918 method_resolution::LookupMode::Path,
1919 |ty, it| callback(ty, it.into()),
1923 pub fn as_adt(&self) -> Option<Adt> {
1924 let (adt, _subst) = self.ty.value.as_adt()?;
1928 pub fn as_dyn_trait(&self) -> Option<Trait> {
1929 self.ty.value.dyn_trait().map(Into::into)
1932 pub fn as_impl_traits(&self, db: &dyn HirDatabase) -> Option<Vec<Trait>> {
1933 self.ty.value.impl_trait_bounds(db).map(|it| {
1935 .filter_map(|pred| match pred {
1936 hir_ty::GenericPredicate::Implemented(trait_ref) => {
1937 Some(Trait::from(trait_ref.trait_))
1945 pub fn as_associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<Trait> {
1946 self.ty.value.associated_type_parent_trait(db).map(Into::into)
1949 fn derived(&self, ty: Ty) -> Type {
1952 ty: InEnvironment { value: ty, environment: self.ty.environment.clone() },
1956 pub fn walk(&self, db: &dyn HirDatabase, mut cb: impl FnMut(Type)) {
1957 // TypeWalk::walk for a Ty at first visits parameters and only after that the Ty itself.
1958 // We need a different order here.
1961 db: &dyn HirDatabase,
1964 cb: &mut impl FnMut(Type),
1966 for ty in substs.iter() {
1967 walk_type(db, &type_.derived(ty.clone()), cb);
1972 db: &dyn HirDatabase,
1974 bounds: &[GenericPredicate],
1975 cb: &mut impl FnMut(Type),
1977 for pred in bounds {
1979 GenericPredicate::Implemented(trait_ref) => {
1981 walk_substs(db, type_, &trait_ref.substs, cb);
1988 fn walk_type(db: &dyn HirDatabase, type_: &Type, cb: &mut impl FnMut(Type)) {
1989 let ty = type_.ty.value.strip_references();
1990 match ty.interned(&Interner) {
1991 TyKind::Adt(..) => {
1992 cb(type_.derived(ty.clone()));
1994 TyKind::AssociatedType(..) => {
1995 if let Some(_) = ty.associated_type_parent_trait(db) {
1996 cb(type_.derived(ty.clone()));
1999 TyKind::OpaqueType(..) => {
2000 if let Some(bounds) = ty.impl_trait_bounds(db) {
2001 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2004 TyKind::Alias(AliasTy::Opaque(opaque_ty)) => {
2005 if let Some(bounds) = ty.impl_trait_bounds(db) {
2006 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2009 walk_substs(db, type_, &opaque_ty.substitution, cb);
2011 TyKind::Placeholder(_) => {
2012 if let Some(bounds) = ty.impl_trait_bounds(db) {
2013 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2016 TyKind::Dyn(bounds) => {
2017 walk_bounds(db, &type_.derived(ty.clone()), bounds.as_ref(), cb);
2022 if let Some(substs) = ty.substs() {
2023 walk_substs(db, type_, &substs, cb);
2027 walk_type(db, self, &mut cb);
2031 impl HirDisplay for Type {
2032 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
2033 self.ty.value.hir_fmt(f)
2039 pub struct Callable {
2042 def: Option<CallableDefId>,
2043 pub(crate) is_bound_method: bool,
2046 pub enum CallableKind {
2048 TupleStruct(Struct),
2049 TupleEnumVariant(Variant),
2054 pub fn kind(&self) -> CallableKind {
2056 Some(CallableDefId::FunctionId(it)) => CallableKind::Function(it.into()),
2057 Some(CallableDefId::StructId(it)) => CallableKind::TupleStruct(it.into()),
2058 Some(CallableDefId::EnumVariantId(it)) => CallableKind::TupleEnumVariant(it.into()),
2059 None => CallableKind::Closure,
2062 pub fn receiver_param(&self, db: &dyn HirDatabase) -> Option<ast::SelfParam> {
2063 let func = match self.def {
2064 Some(CallableDefId::FunctionId(it)) if self.is_bound_method => it,
2067 let src = func.lookup(db.upcast()).source(db.upcast());
2068 let param_list = src.value.param_list()?;
2069 param_list.self_param()
2071 pub fn n_params(&self) -> usize {
2072 self.sig.params().len() - if self.is_bound_method { 1 } else { 0 }
2076 db: &dyn HirDatabase,
2077 ) -> Vec<(Option<Either<ast::SelfParam, ast::Pat>>, Type)> {
2082 .skip(if self.is_bound_method { 1 } else { 0 })
2083 .map(|ty| self.ty.derived(ty.clone()));
2084 let patterns = match self.def {
2085 Some(CallableDefId::FunctionId(func)) => {
2086 let src = func.lookup(db.upcast()).source(db.upcast());
2087 src.value.param_list().map(|param_list| {
2090 .map(|it| Some(Either::Left(it)))
2091 .filter(|_| !self.is_bound_method)
2093 .chain(param_list.params().map(|it| it.pat().map(Either::Right)))
2098 patterns.into_iter().flatten().chain(iter::repeat(None)).zip(types).collect()
2100 pub fn return_type(&self) -> Type {
2101 self.ty.derived(self.sig.ret().clone())
2106 #[derive(Debug, PartialEq, Eq, Hash)]
2108 ModuleDef(ModuleDef),
2110 GenericParam(GenericParam),
2118 pub fn all_items(def: PerNs) -> ArrayVec<[Self; 3]> {
2119 let mut items = ArrayVec::new();
2121 match (def.take_types(), def.take_values()) {
2122 (Some(m1), None) => items.push(ScopeDef::ModuleDef(m1.into())),
2123 (None, Some(m2)) => items.push(ScopeDef::ModuleDef(m2.into())),
2124 (Some(m1), Some(m2)) => {
2125 // Some items, like unit structs and enum variants, are
2126 // returned as both a type and a value. Here we want
2127 // to de-duplicate them.
2129 items.push(ScopeDef::ModuleDef(m1.into()));
2130 items.push(ScopeDef::ModuleDef(m2.into()));
2132 items.push(ScopeDef::ModuleDef(m1.into()));
2138 if let Some(macro_def_id) = def.take_macros() {
2139 items.push(ScopeDef::MacroDef(macro_def_id.into()));
2142 if items.is_empty() {
2143 items.push(ScopeDef::Unknown);
2150 impl From<ItemInNs> for ScopeDef {
2151 fn from(item: ItemInNs) -> Self {
2153 ItemInNs::Types(id) => ScopeDef::ModuleDef(id.into()),
2154 ItemInNs::Values(id) => ScopeDef::ModuleDef(id.into()),
2155 ItemInNs::Macros(id) => ScopeDef::MacroDef(id.into()),
2160 pub trait HasVisibility {
2161 fn visibility(&self, db: &dyn HirDatabase) -> Visibility;
2162 fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool {
2163 let vis = self.visibility(db);
2164 vis.is_visible_from(db.upcast(), module.id)