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, ops::ControlFlow, sync::Arc};
36 use arrayvec::ArrayVec;
37 use base_db::{CrateDisplayName, CrateId, CrateOrigin, Edition, FileId};
40 adt::{ReprKind, VariantData},
41 body::{BodyDiagnostic, SyntheticSyntax},
42 expr::{BindingAnnotation, LabelId, Pat, PatId},
43 lang_item::LangItemTarget,
46 resolver::{HasResolver, Resolver},
47 AttrDefId, ConstId, ConstParamId, EnumId, FunctionId, GenericDefId, HasModule, LifetimeParamId,
48 LocalEnumVariantId, LocalFieldId, StaticId, StructId, TypeAliasId, TypeParamId, UnionId,
50 use hir_expand::{name::name, MacroCallKind, MacroDefKind};
55 diagnostics::BodyValidationDiagnostic,
56 method_resolution::{self, TyFingerprint},
60 AliasEq, AliasTy, BoundVar, CallableDefId, CallableSig, Canonical, CanonicalVarKinds, Cast,
61 DebruijnIndex, InEnvironment, Interner, QuantifiedWhereClause, Scalar, Solution, Substitution,
62 TraitEnvironment, TraitRefExt, Ty, TyBuilder, TyDefId, TyExt, TyKind, TyVariableKind,
65 use itertools::Itertools;
66 use nameres::diagnostics::DefDiagnosticKind;
67 use once_cell::unsync::Lazy;
68 use rustc_hash::FxHashSet;
69 use stdx::{format_to, impl_from};
71 ast::{self, HasAttrs as _, HasName},
72 AstNode, AstPtr, SmolStr, SyntaxKind, SyntaxNodePtr,
74 use tt::{Ident, Leaf, Literal, TokenTree};
76 use crate::db::{DefDatabase, HirDatabase};
79 attrs::{HasAttrs, Namespace},
81 AddReferenceHere, AnyDiagnostic, BreakOutsideOfLoop, InactiveCode, IncorrectCase,
82 InvalidDeriveTarget, MacroError, MalformedDerive, MismatchedArgCount, MissingFields,
83 MissingMatchArms, MissingOkOrSomeInTailExpr, MissingUnsafe, NoSuchField,
84 RemoveThisSemicolon, ReplaceFilterMapNextWithFindMap, UnimplementedBuiltinMacro,
85 UnresolvedExternCrate, UnresolvedImport, UnresolvedMacroCall, UnresolvedModule,
88 has_source::HasSource,
89 semantics::{PathResolution, Semantics, SemanticsScope, TypeInfo},
92 // Be careful with these re-exports.
94 // `hir` is the boundary between the compiler and the IDE. It should try hard to
95 // isolate the compiler from the ide, to allow the two to be refactored
96 // independently. Re-exporting something from the compiler is the sure way to
97 // breach the boundary.
99 // Generally, a refactoring which *removes* a name from this list is a good
102 cfg::{CfgAtom, CfgExpr, CfgOptions},
105 attr::{Attr, Attrs, AttrsWithOwner, Documentation},
106 builtin_attr::AttributeTemplate,
107 find_path::PrefixKind,
109 item_scope::ItemScope,
110 item_tree::ItemTreeNode,
111 nameres::{DefMap, ModuleData, ModuleOrigin, ModuleSource},
112 path::{ModPath, PathKind},
113 src::HasSource as DefHasSource, // xx: I don't like this shadowing of HasSource... :(
114 type_ref::{Mutability, TypeRef},
115 visibility::Visibility,
130 ExpandResult, HirFileId, InFile, MacroDefId, MacroFile, Origin,
132 hir_ty::display::HirDisplay,
135 // These are negative re-exports: pub using these names is forbidden, they
136 // should remain private to hir internals.
140 hir_expand::{hygiene::Hygiene, name::AsName},
143 /// hir::Crate describes a single crate. It's the main interface with which
144 /// a crate's dependencies interact. Mostly, it should be just a proxy for the
146 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
148 pub(crate) id: CrateId,
152 pub struct CrateDependency {
158 pub fn origin(self, db: &dyn HirDatabase) -> CrateOrigin {
159 db.crate_graph()[self.id].origin.clone()
162 pub fn dependencies(self, db: &dyn HirDatabase) -> Vec<CrateDependency> {
163 db.crate_graph()[self.id]
167 let krate = Crate { id: dep.crate_id };
168 let name = dep.as_name();
169 CrateDependency { krate, name }
174 pub fn reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
175 let crate_graph = db.crate_graph();
179 crate_graph[krate].dependencies.iter().any(|it| it.crate_id == self.id)
181 .map(|id| Crate { id })
185 pub fn transitive_reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
186 db.crate_graph().transitive_rev_deps(self.id).into_iter().map(|id| Crate { id }).collect()
189 pub fn root_module(self, db: &dyn HirDatabase) -> Module {
190 let def_map = db.crate_def_map(self.id);
191 Module { id: def_map.module_id(def_map.root()) }
194 pub fn root_file(self, db: &dyn HirDatabase) -> FileId {
195 db.crate_graph()[self.id].root_file_id
198 pub fn edition(self, db: &dyn HirDatabase) -> Edition {
199 db.crate_graph()[self.id].edition
202 pub fn version(self, db: &dyn HirDatabase) -> Option<String> {
203 db.crate_graph()[self.id].version.clone()
206 pub fn display_name(self, db: &dyn HirDatabase) -> Option<CrateDisplayName> {
207 db.crate_graph()[self.id].display_name.clone()
210 pub fn query_external_importables(
212 db: &dyn DefDatabase,
213 query: import_map::Query,
214 ) -> impl Iterator<Item = Either<ModuleDef, MacroDef>> {
215 let _p = profile::span("query_external_importables");
216 import_map::search_dependencies(db, self.into(), query).into_iter().map(|item| {
217 match ItemInNs::from(item) {
218 ItemInNs::Types(mod_id) | ItemInNs::Values(mod_id) => Either::Left(mod_id),
219 ItemInNs::Macros(mac_id) => Either::Right(mac_id),
224 pub fn all(db: &dyn HirDatabase) -> Vec<Crate> {
225 db.crate_graph().iter().map(|id| Crate { id }).collect()
228 /// Try to get the root URL of the documentation of a crate.
229 pub fn get_html_root_url(self: &Crate, db: &dyn HirDatabase) -> Option<String> {
230 // Look for #![doc(html_root_url = "...")]
231 let attrs = db.attrs(AttrDefId::ModuleId(self.root_module(db).into()));
232 let doc_attr_q = attrs.by_key("doc");
234 if !doc_attr_q.exists() {
238 let doc_url = doc_attr_q.tt_values().map(|tt| {
239 let name = tt.token_trees.iter()
240 .skip_while(|tt| !matches!(tt, TokenTree::Leaf(Leaf::Ident(Ident { text, ..} )) if text == "html_root_url"))
244 Some(TokenTree::Leaf(Leaf::Literal(Literal{ref text, ..}))) => Some(text),
249 doc_url.map(|s| s.trim_matches('"').trim_end_matches('/').to_owned() + "/")
252 pub fn cfg(&self, db: &dyn HirDatabase) -> CfgOptions {
253 db.crate_graph()[self.id].cfg_options.clone()
256 pub fn potential_cfg(&self, db: &dyn HirDatabase) -> CfgOptions {
257 db.crate_graph()[self.id].potential_cfg_options.clone()
261 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
263 pub(crate) id: ModuleId,
266 /// The defs which can be visible in the module.
267 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
272 // Can't be directly declared, but can be imported.
277 TypeAlias(TypeAlias),
278 BuiltinType(BuiltinType),
283 Adt(Struct, Enum, Union),
293 impl From<VariantDef> for ModuleDef {
294 fn from(var: VariantDef) -> Self {
296 VariantDef::Struct(t) => Adt::from(t).into(),
297 VariantDef::Union(t) => Adt::from(t).into(),
298 VariantDef::Variant(t) => t.into(),
304 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
306 ModuleDef::Module(it) => it.parent(db),
307 ModuleDef::Function(it) => Some(it.module(db)),
308 ModuleDef::Adt(it) => Some(it.module(db)),
309 ModuleDef::Variant(it) => Some(it.module(db)),
310 ModuleDef::Const(it) => Some(it.module(db)),
311 ModuleDef::Static(it) => Some(it.module(db)),
312 ModuleDef::Trait(it) => Some(it.module(db)),
313 ModuleDef::TypeAlias(it) => Some(it.module(db)),
314 ModuleDef::BuiltinType(_) => None,
318 pub fn canonical_path(&self, db: &dyn HirDatabase) -> Option<String> {
319 let mut segments = vec![self.name(db)?];
320 for m in self.module(db)?.path_to_root(db) {
321 segments.extend(m.name(db))
324 Some(segments.into_iter().join("::"))
327 pub fn canonical_module_path(
329 db: &dyn HirDatabase,
330 ) -> Option<impl Iterator<Item = Module>> {
331 self.module(db).map(|it| it.path_to_root(db).into_iter().rev())
334 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
335 let name = match self {
336 ModuleDef::Module(it) => it.name(db)?,
337 ModuleDef::Const(it) => it.name(db)?,
338 ModuleDef::Adt(it) => it.name(db),
339 ModuleDef::Trait(it) => it.name(db),
340 ModuleDef::Function(it) => it.name(db),
341 ModuleDef::Variant(it) => it.name(db),
342 ModuleDef::TypeAlias(it) => it.name(db),
343 ModuleDef::Static(it) => it.name(db),
344 ModuleDef::BuiltinType(it) => it.name(),
349 pub fn diagnostics(self, db: &dyn HirDatabase) -> Vec<AnyDiagnostic> {
350 let id = match self {
351 ModuleDef::Adt(it) => match it {
352 Adt::Struct(it) => it.id.into(),
353 Adt::Enum(it) => it.id.into(),
354 Adt::Union(it) => it.id.into(),
356 ModuleDef::Trait(it) => it.id.into(),
357 ModuleDef::Function(it) => it.id.into(),
358 ModuleDef::TypeAlias(it) => it.id.into(),
359 ModuleDef::Module(it) => it.id.into(),
360 ModuleDef::Const(it) => it.id.into(),
361 ModuleDef::Static(it) => it.id.into(),
362 _ => return Vec::new(),
365 let module = match self.module(db) {
367 None => return Vec::new(),
370 let mut acc = Vec::new();
372 match self.as_def_with_body() {
374 def.diagnostics(db, &mut acc);
377 for diag in hir_ty::diagnostics::incorrect_case(db, module.id.krate(), id) {
378 acc.push(diag.into())
386 pub fn as_def_with_body(self) -> Option<DefWithBody> {
388 ModuleDef::Function(it) => Some(it.into()),
389 ModuleDef::Const(it) => Some(it.into()),
390 ModuleDef::Static(it) => Some(it.into()),
394 | ModuleDef::Variant(_)
395 | ModuleDef::Trait(_)
396 | ModuleDef::TypeAlias(_)
397 | ModuleDef::BuiltinType(_) => None,
401 pub fn attrs(&self, db: &dyn HirDatabase) -> Option<AttrsWithOwner> {
403 ModuleDef::Module(it) => it.attrs(db),
404 ModuleDef::Function(it) => it.attrs(db),
405 ModuleDef::Adt(it) => it.attrs(db),
406 ModuleDef::Variant(it) => it.attrs(db),
407 ModuleDef::Const(it) => it.attrs(db),
408 ModuleDef::Static(it) => it.attrs(db),
409 ModuleDef::Trait(it) => it.attrs(db),
410 ModuleDef::TypeAlias(it) => it.attrs(db),
411 ModuleDef::BuiltinType(_) => return None,
416 impl HasVisibility for ModuleDef {
417 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
419 ModuleDef::Module(it) => it.visibility(db),
420 ModuleDef::Function(it) => it.visibility(db),
421 ModuleDef::Adt(it) => it.visibility(db),
422 ModuleDef::Const(it) => it.visibility(db),
423 ModuleDef::Static(it) => it.visibility(db),
424 ModuleDef::Trait(it) => it.visibility(db),
425 ModuleDef::TypeAlias(it) => it.visibility(db),
426 ModuleDef::Variant(it) => it.visibility(db),
427 ModuleDef::BuiltinType(_) => Visibility::Public,
433 /// Name of this module.
434 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
435 let def_map = self.id.def_map(db.upcast());
436 let parent = def_map[self.id.local_id].parent?;
437 def_map[parent].children.iter().find_map(|(name, module_id)| {
438 if *module_id == self.id.local_id {
446 /// Returns the crate this module is part of.
447 pub fn krate(self) -> Crate {
448 Crate { id: self.id.krate() }
451 /// Topmost parent of this module. Every module has a `crate_root`, but some
452 /// might be missing `krate`. This can happen if a module's file is not included
453 /// in the module tree of any target in `Cargo.toml`.
454 pub fn crate_root(self, db: &dyn HirDatabase) -> Module {
455 let def_map = db.crate_def_map(self.id.krate());
456 Module { id: def_map.module_id(def_map.root()) }
459 /// Iterates over all child modules.
460 pub fn children(self, db: &dyn HirDatabase) -> impl Iterator<Item = Module> {
461 let def_map = self.id.def_map(db.upcast());
462 let children = def_map[self.id.local_id]
465 .map(|(_, module_id)| Module { id: def_map.module_id(*module_id) })
466 .collect::<Vec<_>>();
470 /// Finds a parent module.
471 pub fn parent(self, db: &dyn HirDatabase) -> Option<Module> {
472 // FIXME: handle block expressions as modules (their parent is in a different DefMap)
473 let def_map = self.id.def_map(db.upcast());
474 let parent_id = def_map[self.id.local_id].parent?;
475 Some(Module { id: def_map.module_id(parent_id) })
478 pub fn path_to_root(self, db: &dyn HirDatabase) -> Vec<Module> {
479 let mut res = vec![self];
481 while let Some(next) = curr.parent(db) {
488 /// Returns a `ModuleScope`: a set of items, visible in this module.
491 db: &dyn HirDatabase,
492 visible_from: Option<Module>,
493 ) -> Vec<(Name, ScopeDef)> {
494 self.id.def_map(db.upcast())[self.id.local_id]
497 .filter_map(|(name, def)| {
498 if let Some(m) = visible_from {
500 def.filter_visibility(|vis| vis.is_visible_from(db.upcast(), m.id));
501 if filtered.is_none() && !def.is_none() {
504 Some((name, filtered))
510 .flat_map(|(name, def)| {
511 ScopeDef::all_items(def).into_iter().map(move |item| (name.clone(), item))
516 pub fn diagnostics(self, db: &dyn HirDatabase, acc: &mut Vec<AnyDiagnostic>) {
517 let _p = profile::span("Module::diagnostics").detail(|| {
518 format!("{:?}", self.name(db).map_or("<unknown>".into(), |name| name.to_string()))
520 let def_map = self.id.def_map(db.upcast());
521 for diag in def_map.diagnostics() {
522 if diag.in_module != self.id.local_id {
523 // FIXME: This is accidentally quadratic.
527 DefDiagnosticKind::UnresolvedModule { ast: declaration, candidate } => {
528 let decl = declaration.to_node(db.upcast());
531 decl: InFile::new(declaration.file_id, AstPtr::new(&decl)),
532 candidate: candidate.clone(),
537 DefDiagnosticKind::UnresolvedExternCrate { ast } => {
538 let item = ast.to_node(db.upcast());
540 UnresolvedExternCrate {
541 decl: InFile::new(ast.file_id, AstPtr::new(&item)),
547 DefDiagnosticKind::UnresolvedImport { id, index } => {
548 let file_id = id.file_id();
549 let item_tree = id.item_tree(db.upcast());
550 let import = &item_tree[id.value];
552 let use_tree = import.use_tree_to_ast(db.upcast(), file_id, *index);
554 UnresolvedImport { decl: InFile::new(file_id, AstPtr::new(&use_tree)) }
559 DefDiagnosticKind::UnconfiguredCode { ast, cfg, opts } => {
560 let item = ast.to_node(db.upcast());
563 node: ast.with_value(AstPtr::new(&item).into()),
571 DefDiagnosticKind::UnresolvedProcMacro { ast } => {
572 let mut precise_location = None;
573 let (node, name) = match ast {
574 MacroCallKind::FnLike { ast_id, .. } => {
575 let node = ast_id.to_node(db.upcast());
576 (ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node))), None)
578 MacroCallKind::Derive { ast_id, derive_name, .. } => {
579 let node = ast_id.to_node(db.upcast());
581 // Compute the precise location of the macro name's token in the derive
583 // FIXME: This does not handle paths to the macro, but neither does the
586 node.attrs().filter_map(|attr| match attr.as_simple_call() {
587 Some((name, args)) if name == "derive" => Some(args),
590 'outer: for attr in derive_attrs {
592 attr.syntax().children_with_tokens().filter_map(|elem| {
594 syntax::NodeOrToken::Node(_) => None,
595 syntax::NodeOrToken::Token(tok) => Some(tok),
598 for token in tokens {
599 if token.kind() == SyntaxKind::IDENT
600 && token.text() == &**derive_name
602 precise_location = Some(token.text_range());
609 ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node))),
610 Some(derive_name.clone()),
613 MacroCallKind::Attr { ast_id, invoc_attr_index, attr_name, .. } => {
614 let node = ast_id.to_node(db.upcast());
616 node.attrs().nth((*invoc_attr_index) as usize).unwrap_or_else(
617 || panic!("cannot find attribute #{}", invoc_attr_index),
620 ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&attr))),
621 Some(attr_name.clone()),
626 UnresolvedProcMacro {
629 macro_name: name.map(Into::into),
635 DefDiagnosticKind::UnresolvedMacroCall { ast, path } => {
636 let node = ast.to_node(db.upcast());
638 UnresolvedMacroCall {
639 macro_call: InFile::new(ast.file_id, AstPtr::new(&node)),
646 DefDiagnosticKind::MacroError { ast, message } => {
647 let node = match ast {
648 MacroCallKind::FnLike { ast_id, .. } => {
649 let node = ast_id.to_node(db.upcast());
650 ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node)))
652 MacroCallKind::Derive { ast_id, .. }
653 | MacroCallKind::Attr { ast_id, .. } => {
654 // FIXME: point to the attribute instead, this creates very large diagnostics
655 let node = ast_id.to_node(db.upcast());
656 ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node)))
659 acc.push(MacroError { node, message: message.clone() }.into());
662 DefDiagnosticKind::UnimplementedBuiltinMacro { ast } => {
663 let node = ast.to_node(db.upcast());
664 // Must have a name, otherwise we wouldn't emit it.
665 let name = node.name().expect("unimplemented builtin macro with no name");
667 UnimplementedBuiltinMacro {
668 node: ast.with_value(SyntaxNodePtr::from(AstPtr::new(&name))),
673 DefDiagnosticKind::InvalidDeriveTarget { ast, id } => {
674 let node = ast.to_node(db.upcast());
675 let derive = node.attrs().nth(*id as usize);
679 InvalidDeriveTarget {
680 node: ast.with_value(SyntaxNodePtr::from(AstPtr::new(&derive))),
685 None => stdx::never!("derive diagnostic on item without derive attribute"),
688 DefDiagnosticKind::MalformedDerive { ast, id } => {
689 let node = ast.to_node(db.upcast());
690 let derive = node.attrs().nth(*id as usize);
695 node: ast.with_value(SyntaxNodePtr::from(AstPtr::new(&derive))),
700 None => stdx::never!("derive diagnostic on item without derive attribute"),
705 for decl in self.declarations(db) {
707 ModuleDef::Module(m) => {
708 // Only add diagnostics from inline modules
709 if def_map[m.id.local_id].origin.is_inline() {
710 m.diagnostics(db, acc)
713 _ => acc.extend(decl.diagnostics(db)),
717 for impl_def in self.impl_defs(db) {
718 for item in impl_def.items(db) {
719 let def: DefWithBody = match item {
720 AssocItem::Function(it) => it.into(),
721 AssocItem::Const(it) => it.into(),
722 AssocItem::TypeAlias(_) => continue,
725 def.diagnostics(db, acc);
730 pub fn declarations(self, db: &dyn HirDatabase) -> Vec<ModuleDef> {
731 let def_map = self.id.def_map(db.upcast());
732 let scope = &def_map[self.id.local_id].scope;
735 .map(ModuleDef::from)
736 .chain(scope.unnamed_consts().map(|id| ModuleDef::Const(Const::from(id))))
740 pub fn impl_defs(self, db: &dyn HirDatabase) -> Vec<Impl> {
741 let def_map = self.id.def_map(db.upcast());
742 def_map[self.id.local_id].scope.impls().map(Impl::from).collect()
745 /// Finds a path that can be used to refer to the given item from within
746 /// this module, if possible.
747 pub fn find_use_path(self, db: &dyn DefDatabase, item: impl Into<ItemInNs>) -> Option<ModPath> {
748 hir_def::find_path::find_path(db, item.into().into(), self.into())
751 /// Finds a path that can be used to refer to the given item from within
752 /// this module, if possible. This is used for returning import paths for use-statements.
753 pub fn find_use_path_prefixed(
755 db: &dyn DefDatabase,
756 item: impl Into<ItemInNs>,
757 prefix_kind: PrefixKind,
758 ) -> Option<ModPath> {
759 hir_def::find_path::find_path_prefixed(db, item.into().into(), self.into(), prefix_kind)
763 impl HasVisibility for Module {
764 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
765 let def_map = self.id.def_map(db.upcast());
766 let module_data = &def_map[self.id.local_id];
767 module_data.visibility
771 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
773 pub(crate) parent: VariantDef,
774 pub(crate) id: LocalFieldId,
777 #[derive(Debug, PartialEq, Eq)]
778 pub enum FieldSource {
779 Named(ast::RecordField),
780 Pos(ast::TupleField),
784 pub fn name(&self, db: &dyn HirDatabase) -> Name {
785 self.parent.variant_data(db).fields()[self.id].name.clone()
788 /// Returns the type as in the signature of the struct (i.e., with
789 /// placeholder types for type parameters). Only use this in the context of
790 /// the field definition.
791 pub fn ty(&self, db: &dyn HirDatabase) -> Type {
792 let var_id = self.parent.into();
793 let generic_def_id: GenericDefId = match self.parent {
794 VariantDef::Struct(it) => it.id.into(),
795 VariantDef::Union(it) => it.id.into(),
796 VariantDef::Variant(it) => it.parent.id.into(),
798 let substs = TyBuilder::type_params_subst(db, generic_def_id);
799 let ty = db.field_types(var_id)[self.id].clone().substitute(&Interner, &substs);
800 Type::new(db, self.parent.module(db).id.krate(), var_id, ty)
803 pub fn parent_def(&self, _db: &dyn HirDatabase) -> VariantDef {
808 impl HasVisibility for Field {
809 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
810 let variant_data = self.parent.variant_data(db);
811 let visibility = &variant_data.fields()[self.id].visibility;
812 let parent_id: hir_def::VariantId = self.parent.into();
813 visibility.resolve(db.upcast(), &parent_id.resolver(db.upcast()))
817 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
819 pub(crate) id: StructId,
823 pub fn module(self, db: &dyn HirDatabase) -> Module {
824 Module { id: self.id.lookup(db.upcast()).container }
827 pub fn name(self, db: &dyn HirDatabase) -> Name {
828 db.struct_data(self.id).name.clone()
831 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
832 db.struct_data(self.id)
836 .map(|(id, _)| Field { parent: self.into(), id })
840 pub fn ty(self, db: &dyn HirDatabase) -> Type {
841 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
844 pub fn repr(self, db: &dyn HirDatabase) -> Option<ReprKind> {
845 db.struct_data(self.id).repr.clone()
848 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
849 self.variant_data(db).kind()
852 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
853 db.struct_data(self.id).variant_data.clone()
857 impl HasVisibility for Struct {
858 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
859 db.struct_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
863 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
865 pub(crate) id: UnionId,
869 pub fn name(self, db: &dyn HirDatabase) -> Name {
870 db.union_data(self.id).name.clone()
873 pub fn module(self, db: &dyn HirDatabase) -> Module {
874 Module { id: self.id.lookup(db.upcast()).container }
877 pub fn ty(self, db: &dyn HirDatabase) -> Type {
878 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
881 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
882 db.union_data(self.id)
886 .map(|(id, _)| Field { parent: self.into(), id })
890 fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
891 db.union_data(self.id).variant_data.clone()
895 impl HasVisibility for Union {
896 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
897 db.union_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
901 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
903 pub(crate) id: EnumId,
907 pub fn module(self, db: &dyn HirDatabase) -> Module {
908 Module { id: self.id.lookup(db.upcast()).container }
911 pub fn name(self, db: &dyn HirDatabase) -> Name {
912 db.enum_data(self.id).name.clone()
915 pub fn variants(self, db: &dyn HirDatabase) -> Vec<Variant> {
916 db.enum_data(self.id).variants.iter().map(|(id, _)| Variant { parent: self, id }).collect()
919 pub fn ty(self, db: &dyn HirDatabase) -> Type {
920 Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
924 impl HasVisibility for Enum {
925 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
926 db.enum_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
930 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
932 pub(crate) parent: Enum,
933 pub(crate) id: LocalEnumVariantId,
937 pub fn module(self, db: &dyn HirDatabase) -> Module {
938 self.parent.module(db)
941 pub fn parent_enum(self, _db: &dyn HirDatabase) -> Enum {
945 pub fn name(self, db: &dyn HirDatabase) -> Name {
946 db.enum_data(self.parent.id).variants[self.id].name.clone()
949 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
950 self.variant_data(db)
953 .map(|(id, _)| Field { parent: self.into(), id })
957 pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
958 self.variant_data(db).kind()
961 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
962 db.enum_data(self.parent.id).variants[self.id].variant_data.clone()
966 /// Variants inherit visibility from the parent enum.
967 impl HasVisibility for Variant {
968 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
969 self.parent_enum(db).visibility(db)
974 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
980 impl_from!(Struct, Union, Enum for Adt);
983 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
984 let subst = db.generic_defaults(self.into());
985 subst.iter().any(|ty| ty.skip_binders().is_unknown())
988 /// Turns this ADT into a type. Any type parameters of the ADT will be
989 /// turned into unknown types, which is good for e.g. finding the most
990 /// general set of completions, but will not look very nice when printed.
991 pub fn ty(self, db: &dyn HirDatabase) -> Type {
992 let id = AdtId::from(self);
993 Type::from_def(db, id.module(db.upcast()).krate(), id)
996 pub fn module(self, db: &dyn HirDatabase) -> Module {
998 Adt::Struct(s) => s.module(db),
999 Adt::Union(s) => s.module(db),
1000 Adt::Enum(e) => e.module(db),
1004 pub fn name(self, db: &dyn HirDatabase) -> Name {
1006 Adt::Struct(s) => s.name(db),
1007 Adt::Union(u) => u.name(db),
1008 Adt::Enum(e) => e.name(db),
1013 impl HasVisibility for Adt {
1014 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1016 Adt::Struct(it) => it.visibility(db),
1017 Adt::Union(it) => it.visibility(db),
1018 Adt::Enum(it) => it.visibility(db),
1023 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1024 pub enum VariantDef {
1029 impl_from!(Struct, Union, Variant for VariantDef);
1032 pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
1034 VariantDef::Struct(it) => it.fields(db),
1035 VariantDef::Union(it) => it.fields(db),
1036 VariantDef::Variant(it) => it.fields(db),
1040 pub fn module(self, db: &dyn HirDatabase) -> Module {
1042 VariantDef::Struct(it) => it.module(db),
1043 VariantDef::Union(it) => it.module(db),
1044 VariantDef::Variant(it) => it.module(db),
1048 pub fn name(&self, db: &dyn HirDatabase) -> Name {
1050 VariantDef::Struct(s) => s.name(db),
1051 VariantDef::Union(u) => u.name(db),
1052 VariantDef::Variant(e) => e.name(db),
1056 pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
1058 VariantDef::Struct(it) => it.variant_data(db),
1059 VariantDef::Union(it) => it.variant_data(db),
1060 VariantDef::Variant(it) => it.variant_data(db),
1065 /// The defs which have a body.
1066 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1067 pub enum DefWithBody {
1072 impl_from!(Function, Const, Static for DefWithBody);
1075 pub fn module(self, db: &dyn HirDatabase) -> Module {
1077 DefWithBody::Const(c) => c.module(db),
1078 DefWithBody::Function(f) => f.module(db),
1079 DefWithBody::Static(s) => s.module(db),
1083 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1085 DefWithBody::Function(f) => Some(f.name(db)),
1086 DefWithBody::Static(s) => Some(s.name(db)),
1087 DefWithBody::Const(c) => c.name(db),
1091 /// Returns the type this def's body has to evaluate to.
1092 pub fn body_type(self, db: &dyn HirDatabase) -> Type {
1094 DefWithBody::Function(it) => it.ret_type(db),
1095 DefWithBody::Static(it) => it.ty(db),
1096 DefWithBody::Const(it) => it.ty(db),
1100 pub fn diagnostics(self, db: &dyn HirDatabase, acc: &mut Vec<AnyDiagnostic>) {
1101 let krate = self.module(db).id.krate();
1103 let source_map = db.body_with_source_map(self.into()).1;
1104 for diag in source_map.diagnostics() {
1106 BodyDiagnostic::InactiveCode { node, cfg, opts } => acc.push(
1107 InactiveCode { node: node.clone(), cfg: cfg.clone(), opts: opts.clone() }
1110 BodyDiagnostic::MacroError { node, message } => acc.push(
1112 node: node.clone().map(|it| it.into()),
1113 message: message.to_string(),
1117 BodyDiagnostic::UnresolvedProcMacro { node } => acc.push(
1118 UnresolvedProcMacro {
1119 node: node.clone().map(|it| it.into()),
1120 precise_location: None,
1125 BodyDiagnostic::UnresolvedMacroCall { node, path } => acc.push(
1126 UnresolvedMacroCall { macro_call: node.clone(), path: path.clone() }.into(),
1131 let infer = db.infer(self.into());
1132 let source_map = Lazy::new(|| db.body_with_source_map(self.into()).1);
1133 for d in &infer.diagnostics {
1135 hir_ty::InferenceDiagnostic::NoSuchField { expr } => {
1136 let field = source_map.field_syntax(*expr);
1137 acc.push(NoSuchField { field }.into())
1139 hir_ty::InferenceDiagnostic::BreakOutsideOfLoop { expr } => {
1140 let expr = source_map
1142 .expect("break outside of loop in synthetic syntax");
1143 acc.push(BreakOutsideOfLoop { expr }.into())
1148 for expr in hir_ty::diagnostics::missing_unsafe(db, self.into()) {
1149 match source_map.expr_syntax(expr) {
1150 Ok(expr) => acc.push(MissingUnsafe { expr }.into()),
1151 Err(SyntheticSyntax) => {
1152 // FIXME: Here and eslwhere in this file, the `expr` was
1153 // desugared, report or assert that this doesn't happen.
1158 for diagnostic in BodyValidationDiagnostic::collect(db, self.into()) {
1160 BodyValidationDiagnostic::RecordMissingFields {
1165 let variant_data = variant.variant_data(db.upcast());
1166 let missed_fields = missed_fields
1168 .map(|idx| variant_data.fields()[idx].name.clone())
1172 Either::Left(record_expr) => match source_map.expr_syntax(record_expr) {
1174 let root = source_ptr.file_syntax(db.upcast());
1175 if let ast::Expr::RecordExpr(record_expr) =
1176 &source_ptr.value.to_node(&root)
1178 if record_expr.record_expr_field_list().is_some() {
1181 file: source_ptr.file_id,
1182 field_list_parent: Either::Left(AstPtr::new(
1185 field_list_parent_path: record_expr
1187 .map(|path| AstPtr::new(&path)),
1195 Err(SyntheticSyntax) => (),
1197 Either::Right(record_pat) => match source_map.pat_syntax(record_pat) {
1199 if let Some(expr) = source_ptr.value.as_ref().left() {
1200 let root = source_ptr.file_syntax(db.upcast());
1201 if let ast::Pat::RecordPat(record_pat) = expr.to_node(&root) {
1202 if record_pat.record_pat_field_list().is_some() {
1205 file: source_ptr.file_id,
1206 field_list_parent: Either::Right(AstPtr::new(
1209 field_list_parent_path: record_pat
1211 .map(|path| AstPtr::new(&path)),
1220 Err(SyntheticSyntax) => (),
1224 BodyValidationDiagnostic::ReplaceFilterMapNextWithFindMap { method_call_expr } => {
1225 if let Ok(next_source_ptr) = source_map.expr_syntax(method_call_expr) {
1227 ReplaceFilterMapNextWithFindMap {
1228 file: next_source_ptr.file_id,
1229 next_expr: next_source_ptr.value,
1235 BodyValidationDiagnostic::MismatchedArgCount { call_expr, expected, found } => {
1236 match source_map.expr_syntax(call_expr) {
1237 Ok(source_ptr) => acc.push(
1238 MismatchedArgCount { call_expr: source_ptr, expected, found }.into(),
1240 Err(SyntheticSyntax) => (),
1243 BodyValidationDiagnostic::RemoveThisSemicolon { expr } => {
1244 match source_map.expr_syntax(expr) {
1245 Ok(expr) => acc.push(RemoveThisSemicolon { expr }.into()),
1246 Err(SyntheticSyntax) => (),
1249 BodyValidationDiagnostic::MissingOkOrSomeInTailExpr { expr, required } => {
1250 match source_map.expr_syntax(expr) {
1251 Ok(expr) => acc.push(
1252 MissingOkOrSomeInTailExpr {
1255 expected: self.body_type(db),
1259 Err(SyntheticSyntax) => (),
1262 BodyValidationDiagnostic::MissingMatchArms { match_expr } => {
1263 match source_map.expr_syntax(match_expr) {
1265 let root = source_ptr.file_syntax(db.upcast());
1266 if let ast::Expr::MatchExpr(match_expr) =
1267 &source_ptr.value.to_node(&root)
1269 if let (Some(match_expr), Some(arms)) =
1270 (match_expr.expr(), match_expr.match_arm_list())
1274 file: source_ptr.file_id,
1275 match_expr: AstPtr::new(&match_expr),
1276 arms: AstPtr::new(&arms),
1283 Err(SyntheticSyntax) => (),
1286 BodyValidationDiagnostic::AddReferenceHere { arg_expr, mutability } => {
1287 match source_map.expr_syntax(arg_expr) {
1288 Ok(expr) => acc.push(AddReferenceHere { expr, mutability }.into()),
1289 Err(SyntheticSyntax) => (),
1295 let def: ModuleDef = match self {
1296 DefWithBody::Function(it) => it.into(),
1297 DefWithBody::Static(it) => it.into(),
1298 DefWithBody::Const(it) => it.into(),
1300 for diag in hir_ty::diagnostics::incorrect_case(db, krate, def.into()) {
1301 acc.push(diag.into())
1306 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1307 pub struct Function {
1308 pub(crate) id: FunctionId,
1312 pub fn module(self, db: &dyn HirDatabase) -> Module {
1313 self.id.lookup(db.upcast()).module(db.upcast()).into()
1316 pub fn name(self, db: &dyn HirDatabase) -> Name {
1317 db.function_data(self.id).name.clone()
1320 /// Get this function's return type
1321 pub fn ret_type(self, db: &dyn HirDatabase) -> Type {
1322 let resolver = self.id.resolver(db.upcast());
1323 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
1324 let ret_type = &db.function_data(self.id).ret_type;
1325 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1326 let ty = ctx.lower_ty(ret_type);
1327 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1330 pub fn self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
1331 if !db.function_data(self.id).has_self_param() {
1334 Some(SelfParam { func: self.id })
1337 pub fn assoc_fn_params(self, db: &dyn HirDatabase) -> Vec<Param> {
1338 let resolver = self.id.resolver(db.upcast());
1339 let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
1340 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1341 let environment = db.trait_environment(self.id.into());
1342 db.function_data(self.id)
1346 .map(|(idx, type_ref)| {
1347 let ty = Type { krate, env: environment.clone(), ty: ctx.lower_ty(type_ref) };
1348 Param { func: self, ty, idx }
1353 pub fn method_params(self, db: &dyn HirDatabase) -> Option<Vec<Param>> {
1354 if self.self_param(db).is_none() {
1357 let mut res = self.assoc_fn_params(db);
1362 pub fn is_unsafe(self, db: &dyn HirDatabase) -> bool {
1363 db.function_data(self.id).is_unsafe()
1366 pub fn is_const(self, db: &dyn HirDatabase) -> bool {
1367 db.function_data(self.id).is_const()
1370 pub fn is_async(self, db: &dyn HirDatabase) -> bool {
1371 db.function_data(self.id).is_async()
1374 /// Whether this function declaration has a definition.
1376 /// This is false in the case of required (not provided) trait methods.
1377 pub fn has_body(self, db: &dyn HirDatabase) -> bool {
1378 db.function_data(self.id).has_body()
1381 /// A textual representation of the HIR of this function for debugging purposes.
1382 pub fn debug_hir(self, db: &dyn HirDatabase) -> String {
1383 let body = db.body(self.id.into());
1385 let mut result = String::new();
1386 format_to!(result, "HIR expressions in the body of `{}`:\n", self.name(db));
1387 for (id, expr) in body.exprs.iter() {
1388 format_to!(result, "{:?}: {:?}\n", id, expr);
1395 // Note: logically, this belongs to `hir_ty`, but we are not using it there yet.
1402 impl From<hir_ty::Mutability> for Access {
1403 fn from(mutability: hir_ty::Mutability) -> Access {
1405 hir_ty::Mutability::Not => Access::Shared,
1406 hir_ty::Mutability::Mut => Access::Exclusive,
1411 #[derive(Clone, Debug)]
1414 /// The index in parameter list, including self parameter.
1420 pub fn ty(&self) -> &Type {
1424 pub fn as_local(&self, db: &dyn HirDatabase) -> Local {
1425 let parent = DefWithBodyId::FunctionId(self.func.into());
1426 let body = db.body(parent);
1427 Local { parent, pat_id: body.params[self.idx] }
1430 pub fn pattern_source(&self, db: &dyn HirDatabase) -> Option<ast::Pat> {
1431 self.source(db).and_then(|p| p.value.pat())
1434 pub fn source(&self, db: &dyn HirDatabase) -> Option<InFile<ast::Param>> {
1435 let InFile { file_id, value } = self.func.source(db)?;
1436 let params = value.param_list()?;
1437 if params.self_param().is_some() {
1438 params.params().nth(self.idx.checked_sub(1)?)
1440 params.params().nth(self.idx)
1442 .map(|value| InFile { file_id, value })
1446 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1447 pub struct SelfParam {
1452 pub fn access(self, db: &dyn HirDatabase) -> Access {
1453 let func_data = db.function_data(self.func);
1457 .map(|param| match &**param {
1458 TypeRef::Reference(.., mutability) => match mutability {
1459 hir_def::type_ref::Mutability::Shared => Access::Shared,
1460 hir_def::type_ref::Mutability::Mut => Access::Exclusive,
1464 .unwrap_or(Access::Owned)
1467 pub fn display(self, db: &dyn HirDatabase) -> &'static str {
1468 match self.access(db) {
1469 Access::Shared => "&self",
1470 Access::Exclusive => "&mut self",
1471 Access::Owned => "self",
1475 pub fn source(&self, db: &dyn HirDatabase) -> Option<InFile<ast::SelfParam>> {
1476 let InFile { file_id, value } = Function::from(self.func).source(db)?;
1479 .and_then(|params| params.self_param())
1480 .map(|value| InFile { file_id, value })
1484 impl HasVisibility for Function {
1485 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1486 let function_data = db.function_data(self.id);
1487 let visibility = &function_data.visibility;
1488 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1492 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1494 pub(crate) id: ConstId,
1498 pub fn module(self, db: &dyn HirDatabase) -> Module {
1499 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1502 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1503 db.const_data(self.id).name.clone()
1506 pub fn value(self, db: &dyn HirDatabase) -> Option<ast::Expr> {
1507 self.source(db)?.value.body()
1510 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1511 let data = db.const_data(self.id);
1512 let resolver = self.id.resolver(db.upcast());
1513 let krate = self.id.lookup(db.upcast()).container.krate(db);
1514 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1515 let ty = ctx.lower_ty(&data.type_ref);
1516 Type::new_with_resolver_inner(db, krate.id, &resolver, ty)
1520 impl HasVisibility for Const {
1521 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1522 let function_data = db.const_data(self.id);
1523 let visibility = &function_data.visibility;
1524 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1528 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1530 pub(crate) id: StaticId,
1534 pub fn module(self, db: &dyn HirDatabase) -> Module {
1535 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1538 pub fn name(self, db: &dyn HirDatabase) -> Name {
1539 db.static_data(self.id).name.clone()
1542 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1543 db.static_data(self.id).mutable
1546 pub fn value(self, db: &dyn HirDatabase) -> Option<ast::Expr> {
1547 self.source(db)?.value.body()
1550 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1551 let data = db.static_data(self.id);
1552 let resolver = self.id.resolver(db.upcast());
1553 let krate = self.id.lookup(db.upcast()).container.krate();
1554 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1555 let ty = ctx.lower_ty(&data.type_ref);
1556 Type::new_with_resolver_inner(db, krate, &resolver, ty)
1560 impl HasVisibility for Static {
1561 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1562 db.static_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1566 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1568 pub(crate) id: TraitId,
1572 pub fn module(self, db: &dyn HirDatabase) -> Module {
1573 Module { id: self.id.lookup(db.upcast()).container }
1576 pub fn name(self, db: &dyn HirDatabase) -> Name {
1577 db.trait_data(self.id).name.clone()
1580 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1581 db.trait_data(self.id).items.iter().map(|(_name, it)| (*it).into()).collect()
1584 pub fn is_auto(self, db: &dyn HirDatabase) -> bool {
1585 db.trait_data(self.id).is_auto
1588 pub fn is_unsafe(&self, db: &dyn HirDatabase) -> bool {
1589 db.trait_data(self.id).is_unsafe
1593 impl HasVisibility for Trait {
1594 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1595 db.trait_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1599 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1600 pub struct TypeAlias {
1601 pub(crate) id: TypeAliasId,
1605 pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
1606 let subst = db.generic_defaults(self.id.into());
1607 subst.iter().any(|ty| ty.skip_binders().is_unknown())
1610 pub fn module(self, db: &dyn HirDatabase) -> Module {
1611 Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1614 pub fn type_ref(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1615 db.type_alias_data(self.id).type_ref.as_deref().cloned()
1618 pub fn ty(self, db: &dyn HirDatabase) -> Type {
1619 Type::from_def(db, self.id.lookup(db.upcast()).module(db.upcast()).krate(), self.id)
1622 pub fn name(self, db: &dyn HirDatabase) -> Name {
1623 db.type_alias_data(self.id).name.clone()
1627 impl HasVisibility for TypeAlias {
1628 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1629 let function_data = db.type_alias_data(self.id);
1630 let visibility = &function_data.visibility;
1631 visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1635 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1636 pub struct BuiltinType {
1637 pub(crate) inner: hir_def::builtin_type::BuiltinType,
1641 pub fn str() -> BuiltinType {
1642 BuiltinType { inner: hir_def::builtin_type::BuiltinType::Str }
1645 pub fn ty(self, db: &dyn HirDatabase, module: Module) -> Type {
1646 let resolver = module.id.resolver(db.upcast());
1647 Type::new_with_resolver(db, &resolver, TyBuilder::builtin(self.inner))
1648 .expect("crate not present in resolver")
1651 pub fn name(self) -> Name {
1652 self.inner.as_name()
1656 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1657 pub enum MacroKind {
1658 /// `macro_rules!` or Macros 2.0 macro.
1660 /// A built-in or custom derive.
1662 /// A built-in function-like macro.
1664 /// A procedural attribute macro.
1666 /// A function-like procedural macro.
1670 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1671 pub struct MacroDef {
1672 pub(crate) id: MacroDefId,
1676 /// FIXME: right now, this just returns the root module of the crate that
1677 /// defines this macro. The reasons for this is that macros are expanded
1678 /// early, in `hir_expand`, where modules simply do not exist yet.
1679 pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
1680 let krate = self.id.krate;
1681 let def_map = db.crate_def_map(krate);
1682 let module_id = def_map.root();
1683 Some(Module { id: def_map.module_id(module_id) })
1686 /// XXX: this parses the file
1687 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1688 match self.source(db)?.value {
1689 Either::Left(it) => it.name().map(|it| it.as_name()),
1690 Either::Right(_) => {
1691 let krate = self.id.krate;
1692 let def_map = db.crate_def_map(krate);
1693 let (_, name) = def_map.exported_proc_macros().find(|&(id, _)| id == self.id)?;
1699 pub fn kind(&self) -> MacroKind {
1700 match self.id.kind {
1701 MacroDefKind::Declarative(_) => MacroKind::Declarative,
1702 MacroDefKind::BuiltIn(_, _) | MacroDefKind::BuiltInEager(_, _) => MacroKind::BuiltIn,
1703 MacroDefKind::BuiltInDerive(_, _) => MacroKind::Derive,
1704 MacroDefKind::BuiltInAttr(_, _) => MacroKind::Attr,
1705 MacroDefKind::ProcMacro(_, base_db::ProcMacroKind::CustomDerive, _) => {
1708 MacroDefKind::ProcMacro(_, base_db::ProcMacroKind::Attr, _) => MacroKind::Attr,
1709 MacroDefKind::ProcMacro(_, base_db::ProcMacroKind::FuncLike, _) => MacroKind::ProcMacro,
1713 pub fn is_fn_like(&self) -> bool {
1715 MacroKind::Declarative | MacroKind::BuiltIn | MacroKind::ProcMacro => true,
1716 MacroKind::Attr | MacroKind::Derive => false,
1721 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1728 impl From<MacroDef> for ItemInNs {
1729 fn from(it: MacroDef) -> Self {
1734 impl From<ModuleDef> for ItemInNs {
1735 fn from(module_def: ModuleDef) -> Self {
1737 ModuleDef::Static(_) | ModuleDef::Const(_) | ModuleDef::Function(_) => {
1738 ItemInNs::Values(module_def)
1740 _ => ItemInNs::Types(module_def),
1746 pub fn as_module_def(self) -> Option<ModuleDef> {
1748 ItemInNs::Types(id) | ItemInNs::Values(id) => Some(id),
1749 ItemInNs::Macros(_) => None,
1753 /// Returns the crate defining this item (or `None` if `self` is built-in).
1754 pub fn krate(&self, db: &dyn HirDatabase) -> Option<Crate> {
1756 ItemInNs::Types(did) | ItemInNs::Values(did) => did.module(db).map(|m| m.krate()),
1757 ItemInNs::Macros(id) => id.module(db).map(|m| m.krate()),
1761 pub fn attrs(&self, db: &dyn HirDatabase) -> Option<AttrsWithOwner> {
1763 ItemInNs::Types(it) | ItemInNs::Values(it) => it.attrs(db),
1764 ItemInNs::Macros(it) => Some(it.attrs(db)),
1769 /// Invariant: `inner.as_assoc_item(db).is_some()`
1770 /// We do not actively enforce this invariant.
1771 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1772 pub enum AssocItem {
1775 TypeAlias(TypeAlias),
1778 pub enum AssocItemContainer {
1782 pub trait AsAssocItem {
1783 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>;
1786 impl AsAssocItem for Function {
1787 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1788 as_assoc_item(db, AssocItem::Function, self.id)
1791 impl AsAssocItem for Const {
1792 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1793 as_assoc_item(db, AssocItem::Const, self.id)
1796 impl AsAssocItem for TypeAlias {
1797 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1798 as_assoc_item(db, AssocItem::TypeAlias, self.id)
1801 impl AsAssocItem for ModuleDef {
1802 fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1804 ModuleDef::Function(it) => it.as_assoc_item(db),
1805 ModuleDef::Const(it) => it.as_assoc_item(db),
1806 ModuleDef::TypeAlias(it) => it.as_assoc_item(db),
1811 fn as_assoc_item<ID, DEF, CTOR, AST>(db: &dyn HirDatabase, ctor: CTOR, id: ID) -> Option<AssocItem>
1813 ID: Lookup<Data = AssocItemLoc<AST>>,
1815 CTOR: FnOnce(DEF) -> AssocItem,
1818 match id.lookup(db.upcast()).container {
1819 AssocContainerId::TraitId(_) | AssocContainerId::ImplId(_) => Some(ctor(DEF::from(id))),
1820 AssocContainerId::ModuleId(_) => None,
1825 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1827 AssocItem::Function(it) => Some(it.name(db)),
1828 AssocItem::Const(it) => it.name(db),
1829 AssocItem::TypeAlias(it) => Some(it.name(db)),
1832 pub fn module(self, db: &dyn HirDatabase) -> Module {
1834 AssocItem::Function(f) => f.module(db),
1835 AssocItem::Const(c) => c.module(db),
1836 AssocItem::TypeAlias(t) => t.module(db),
1839 pub fn container(self, db: &dyn HirDatabase) -> AssocItemContainer {
1840 let container = match self {
1841 AssocItem::Function(it) => it.id.lookup(db.upcast()).container,
1842 AssocItem::Const(it) => it.id.lookup(db.upcast()).container,
1843 AssocItem::TypeAlias(it) => it.id.lookup(db.upcast()).container,
1846 AssocContainerId::TraitId(id) => AssocItemContainer::Trait(id.into()),
1847 AssocContainerId::ImplId(id) => AssocItemContainer::Impl(id.into()),
1848 AssocContainerId::ModuleId(_) => panic!("invalid AssocItem"),
1852 pub fn containing_trait(self, db: &dyn HirDatabase) -> Option<Trait> {
1853 match self.container(db) {
1854 AssocItemContainer::Trait(t) => Some(t),
1859 pub fn containing_trait_impl(self, db: &dyn HirDatabase) -> Option<Trait> {
1860 match self.container(db) {
1861 AssocItemContainer::Impl(i) => i.trait_(db),
1866 pub fn containing_trait_or_trait_impl(self, db: &dyn HirDatabase) -> Option<Trait> {
1867 match self.container(db) {
1868 AssocItemContainer::Trait(t) => Some(t),
1869 AssocItemContainer::Impl(i) => i.trait_(db),
1874 impl HasVisibility for AssocItem {
1875 fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1877 AssocItem::Function(f) => f.visibility(db),
1878 AssocItem::Const(c) => c.visibility(db),
1879 AssocItem::TypeAlias(t) => t.visibility(db),
1884 impl From<AssocItem> for ModuleDef {
1885 fn from(assoc: AssocItem) -> Self {
1887 AssocItem::Function(it) => ModuleDef::Function(it),
1888 AssocItem::Const(it) => ModuleDef::Const(it),
1889 AssocItem::TypeAlias(it) => ModuleDef::TypeAlias(it),
1894 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1895 pub enum GenericDef {
1899 TypeAlias(TypeAlias),
1901 // enum variants cannot have generics themselves, but their parent enums
1902 // can, and this makes some code easier to write
1904 // consts can have type parameters from their parents (i.e. associated consts of traits)
1909 Adt(Struct, Enum, Union),
1919 pub fn params(self, db: &dyn HirDatabase) -> Vec<GenericParam> {
1920 let generics = db.generic_params(self.into());
1921 let ty_params = generics
1924 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1925 .map(GenericParam::TypeParam);
1926 let lt_params = generics
1929 .map(|(local_id, _)| LifetimeParam {
1930 id: LifetimeParamId { parent: self.into(), local_id },
1932 .map(GenericParam::LifetimeParam);
1933 let const_params = generics
1936 .map(|(local_id, _)| ConstParam { id: ConstParamId { parent: self.into(), local_id } })
1937 .map(GenericParam::ConstParam);
1938 ty_params.chain(lt_params).chain(const_params).collect()
1941 pub fn type_params(self, db: &dyn HirDatabase) -> Vec<TypeParam> {
1942 let generics = db.generic_params(self.into());
1946 .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1951 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1953 pub(crate) parent: DefWithBodyId,
1954 pub(crate) pat_id: PatId,
1958 pub fn is_param(self, db: &dyn HirDatabase) -> bool {
1959 let src = self.source(db);
1961 Either::Left(bind_pat) => {
1962 bind_pat.syntax().ancestors().any(|it| ast::Param::can_cast(it.kind()))
1964 Either::Right(_self_param) => true,
1968 pub fn as_self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
1970 DefWithBodyId::FunctionId(func) if self.is_self(db) => Some(SelfParam { func }),
1975 // FIXME: why is this an option? It shouldn't be?
1976 pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1977 let body = db.body(self.parent);
1978 match &body[self.pat_id] {
1979 Pat::Bind { name, .. } => Some(name.clone()),
1984 pub fn is_self(self, db: &dyn HirDatabase) -> bool {
1985 self.name(db) == Some(name![self])
1988 pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1989 let body = db.body(self.parent);
1990 matches!(&body[self.pat_id], Pat::Bind { mode: BindingAnnotation::Mutable, .. })
1993 pub fn is_ref(self, db: &dyn HirDatabase) -> bool {
1994 let body = db.body(self.parent);
1997 Pat::Bind { mode: BindingAnnotation::Ref | BindingAnnotation::RefMut, .. }
2001 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
2005 pub fn module(self, db: &dyn HirDatabase) -> Module {
2006 self.parent(db).module(db)
2009 pub fn ty(self, db: &dyn HirDatabase) -> Type {
2010 let def = self.parent;
2011 let infer = db.infer(def);
2012 let ty = infer[self.pat_id].clone();
2013 let krate = def.module(db.upcast()).krate();
2014 Type::new(db, krate, def, ty)
2017 pub fn source(self, db: &dyn HirDatabase) -> InFile<Either<ast::IdentPat, ast::SelfParam>> {
2018 let (_body, source_map) = db.body_with_source_map(self.parent);
2019 let src = source_map.pat_syntax(self.pat_id).unwrap(); // Hmm...
2020 let root = src.file_syntax(db.upcast());
2022 ast.map_left(|it| it.cast().unwrap().to_node(&root)).map_right(|it| it.to_node(&root))
2027 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2028 pub struct BuiltinAttr(usize);
2031 pub(crate) fn by_name(name: &str) -> Option<Self> {
2032 // FIXME: def maps registered attrs?
2033 hir_def::builtin_attr::find_builtin_attr_idx(name).map(Self)
2036 pub fn name(&self, _: &dyn HirDatabase) -> &str {
2037 // FIXME: Return a `Name` here
2038 hir_def::builtin_attr::INERT_ATTRIBUTES[self.0].name
2041 pub fn template(&self, _: &dyn HirDatabase) -> AttributeTemplate {
2042 hir_def::builtin_attr::INERT_ATTRIBUTES[self.0].template
2046 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2047 pub struct ToolModule(usize);
2050 pub(crate) fn by_name(name: &str) -> Option<Self> {
2051 // FIXME: def maps registered tools
2052 hir_def::builtin_attr::TOOL_MODULES.iter().position(|&tool| tool == name).map(Self)
2055 pub fn name(&self, _: &dyn HirDatabase) -> &str {
2056 // FIXME: Return a `Name` here
2057 hir_def::builtin_attr::TOOL_MODULES[self.0]
2061 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2063 pub(crate) parent: DefWithBodyId,
2064 pub(crate) label_id: LabelId,
2068 pub fn module(self, db: &dyn HirDatabase) -> Module {
2069 self.parent(db).module(db)
2072 pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
2076 pub fn name(self, db: &dyn HirDatabase) -> Name {
2077 let body = db.body(self.parent);
2078 body[self.label_id].name.clone()
2081 pub fn source(self, db: &dyn HirDatabase) -> InFile<ast::Label> {
2082 let (_body, source_map) = db.body_with_source_map(self.parent);
2083 let src = source_map.label_syntax(self.label_id);
2084 let root = src.file_syntax(db.upcast());
2085 src.map(|ast| ast.to_node(&root))
2089 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2090 pub enum GenericParam {
2091 TypeParam(TypeParam),
2092 LifetimeParam(LifetimeParam),
2093 ConstParam(ConstParam),
2095 impl_from!(TypeParam, LifetimeParam, ConstParam for GenericParam);
2098 pub fn module(self, db: &dyn HirDatabase) -> Module {
2100 GenericParam::TypeParam(it) => it.module(db),
2101 GenericParam::LifetimeParam(it) => it.module(db),
2102 GenericParam::ConstParam(it) => it.module(db),
2106 pub fn name(self, db: &dyn HirDatabase) -> Name {
2108 GenericParam::TypeParam(it) => it.name(db),
2109 GenericParam::LifetimeParam(it) => it.name(db),
2110 GenericParam::ConstParam(it) => it.name(db),
2115 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2116 pub struct TypeParam {
2117 pub(crate) id: TypeParamId,
2121 pub fn name(self, db: &dyn HirDatabase) -> Name {
2122 let params = db.generic_params(self.id.parent);
2123 params.types[self.id.local_id].name.clone().unwrap_or_else(Name::missing)
2126 pub fn module(self, db: &dyn HirDatabase) -> Module {
2127 self.id.parent.module(db.upcast()).into()
2130 pub fn ty(self, db: &dyn HirDatabase) -> Type {
2131 let resolver = self.id.parent.resolver(db.upcast());
2132 let krate = self.id.parent.module(db.upcast()).krate();
2133 let ty = TyKind::Placeholder(hir_ty::to_placeholder_idx(db, self.id)).intern(&Interner);
2134 Type::new_with_resolver_inner(db, krate, &resolver, ty)
2137 pub fn trait_bounds(self, db: &dyn HirDatabase) -> Vec<Trait> {
2138 db.generic_predicates_for_param(self.id, None)
2140 .filter_map(|pred| match &pred.skip_binders().skip_binders() {
2141 hir_ty::WhereClause::Implemented(trait_ref) => {
2142 Some(Trait::from(trait_ref.hir_trait_id()))
2149 pub fn default(self, db: &dyn HirDatabase) -> Option<Type> {
2150 let params = db.generic_defaults(self.id.parent);
2151 let local_idx = hir_ty::param_idx(db, self.id)?;
2152 let resolver = self.id.parent.resolver(db.upcast());
2153 let krate = self.id.parent.module(db.upcast()).krate();
2154 let ty = params.get(local_idx)?.clone();
2155 let subst = TyBuilder::type_params_subst(db, self.id.parent);
2156 let ty = ty.substitute(&Interner, &subst_prefix(&subst, local_idx));
2157 Some(Type::new_with_resolver_inner(db, krate, &resolver, ty))
2161 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2162 pub struct LifetimeParam {
2163 pub(crate) id: LifetimeParamId,
2166 impl LifetimeParam {
2167 pub fn name(self, db: &dyn HirDatabase) -> Name {
2168 let params = db.generic_params(self.id.parent);
2169 params.lifetimes[self.id.local_id].name.clone()
2172 pub fn module(self, db: &dyn HirDatabase) -> Module {
2173 self.id.parent.module(db.upcast()).into()
2176 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
2177 self.id.parent.into()
2181 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2182 pub struct ConstParam {
2183 pub(crate) id: ConstParamId,
2187 pub fn name(self, db: &dyn HirDatabase) -> Name {
2188 let params = db.generic_params(self.id.parent);
2189 params.consts[self.id.local_id].name.clone()
2192 pub fn module(self, db: &dyn HirDatabase) -> Module {
2193 self.id.parent.module(db.upcast()).into()
2196 pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
2197 self.id.parent.into()
2200 pub fn ty(self, db: &dyn HirDatabase) -> Type {
2201 let def = self.id.parent;
2202 let krate = def.module(db.upcast()).krate();
2203 Type::new(db, krate, def, db.const_param_ty(self.id))
2207 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2209 pub(crate) id: ImplId,
2213 pub fn all_in_crate(db: &dyn HirDatabase, krate: Crate) -> Vec<Impl> {
2214 let inherent = db.inherent_impls_in_crate(krate.id);
2215 let trait_ = db.trait_impls_in_crate(krate.id);
2217 inherent.all_impls().chain(trait_.all_impls()).map(Self::from).collect()
2220 pub fn all_for_type(db: &dyn HirDatabase, Type { krate, ty, .. }: Type) -> Vec<Impl> {
2221 let def_crates = match method_resolution::def_crates(db, &ty, krate) {
2222 Some(def_crates) => def_crates,
2223 None => return Vec::new(),
2226 let filter = |impl_def: &Impl| {
2227 let self_ty = impl_def.self_ty(db);
2228 let rref = self_ty.remove_ref();
2229 ty.equals_ctor(rref.as_ref().map_or(&self_ty.ty, |it| &it.ty))
2232 let fp = TyFingerprint::for_inherent_impl(&ty);
2235 None => return Vec::new(),
2238 let mut all = Vec::new();
2239 def_crates.iter().for_each(|&id| {
2241 db.inherent_impls_in_crate(id)
2249 for id in def_crates
2251 .flat_map(|&id| Crate { id }.transitive_reverse_dependencies(db))
2252 .map(|Crate { id }| id)
2253 .chain(def_crates.iter().copied())
2257 db.trait_impls_in_crate(id)
2258 .for_self_ty_without_blanket_impls(fp)
2266 pub fn all_for_trait(db: &dyn HirDatabase, trait_: Trait) -> Vec<Impl> {
2267 let krate = trait_.module(db).krate();
2268 let mut all = Vec::new();
2269 for Crate { id } in krate.transitive_reverse_dependencies(db).into_iter() {
2270 let impls = db.trait_impls_in_crate(id);
2271 all.extend(impls.for_trait(trait_.id).map(Self::from))
2276 // FIXME: the return type is wrong. This should be a hir version of
2277 // `TraitRef` (to account for parameters and qualifiers)
2278 pub fn trait_(self, db: &dyn HirDatabase) -> Option<Trait> {
2279 let trait_ref = db.impl_trait(self.id)?.skip_binders().clone();
2280 let id = hir_ty::from_chalk_trait_id(trait_ref.trait_id);
2284 pub fn self_ty(self, db: &dyn HirDatabase) -> Type {
2285 let impl_data = db.impl_data(self.id);
2286 let resolver = self.id.resolver(db.upcast());
2287 let krate = self.id.lookup(db.upcast()).container.krate();
2288 let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
2289 let ty = ctx.lower_ty(&impl_data.self_ty);
2290 Type::new_with_resolver_inner(db, krate, &resolver, ty)
2293 pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
2294 db.impl_data(self.id).items.iter().map(|it| (*it).into()).collect()
2297 pub fn is_negative(self, db: &dyn HirDatabase) -> bool {
2298 db.impl_data(self.id).is_negative
2301 pub fn module(self, db: &dyn HirDatabase) -> Module {
2302 self.id.lookup(db.upcast()).container.into()
2305 pub fn is_builtin_derive(self, db: &dyn HirDatabase) -> Option<InFile<ast::Attr>> {
2306 let src = self.source(db)?;
2307 let item = src.file_id.is_builtin_derive(db.upcast())?;
2308 let hygenic = hir_expand::hygiene::Hygiene::new(db.upcast(), item.file_id);
2310 // FIXME: handle `cfg_attr`
2315 let path = ModPath::from_src(db.upcast(), it.path()?, &hygenic)?;
2316 if path.as_ident()?.to_smol_str() == "derive" {
2324 Some(item.with_value(attr))
2328 #[derive(Clone, PartialEq, Eq, Debug)]
2331 env: Arc<TraitEnvironment>,
2336 pub(crate) fn new_with_resolver(
2337 db: &dyn HirDatabase,
2338 resolver: &Resolver,
2341 let krate = resolver.krate()?;
2342 Some(Type::new_with_resolver_inner(db, krate, resolver, ty))
2344 pub(crate) fn new_with_resolver_inner(
2345 db: &dyn HirDatabase,
2347 resolver: &Resolver,
2350 let environment = resolver
2352 .map_or_else(|| Arc::new(TraitEnvironment::empty(krate)), |d| db.trait_environment(d));
2353 Type { krate, env: environment, ty }
2356 fn new(db: &dyn HirDatabase, krate: CrateId, lexical_env: impl HasResolver, ty: Ty) -> Type {
2357 let resolver = lexical_env.resolver(db.upcast());
2358 let environment = resolver
2360 .map_or_else(|| Arc::new(TraitEnvironment::empty(krate)), |d| db.trait_environment(d));
2361 Type { krate, env: environment, ty }
2365 db: &dyn HirDatabase,
2367 def: impl HasResolver + Into<TyDefId>,
2369 let ty = TyBuilder::def_ty(db, def.into()).fill_with_unknown().build();
2370 Type::new(db, krate, def, ty)
2373 pub fn new_slice(ty: Type) -> Type {
2374 Type { krate: ty.krate, env: ty.env, ty: TyBuilder::slice(ty.ty) }
2377 pub fn is_unit(&self) -> bool {
2378 matches!(self.ty.kind(&Interner), TyKind::Tuple(0, ..))
2381 pub fn is_bool(&self) -> bool {
2382 matches!(self.ty.kind(&Interner), TyKind::Scalar(Scalar::Bool))
2385 pub fn is_never(&self) -> bool {
2386 matches!(self.ty.kind(&Interner), TyKind::Never)
2389 pub fn is_mutable_reference(&self) -> bool {
2390 matches!(self.ty.kind(&Interner), TyKind::Ref(hir_ty::Mutability::Mut, ..))
2393 pub fn is_reference(&self) -> bool {
2394 matches!(self.ty.kind(&Interner), TyKind::Ref(..))
2397 pub fn is_usize(&self) -> bool {
2398 matches!(self.ty.kind(&Interner), TyKind::Scalar(Scalar::Uint(UintTy::Usize)))
2401 pub fn remove_ref(&self) -> Option<Type> {
2402 match &self.ty.kind(&Interner) {
2403 TyKind::Ref(.., ty) => Some(self.derived(ty.clone())),
2408 pub fn strip_references(&self) -> Type {
2409 self.derived(self.ty.strip_references().clone())
2412 pub fn is_unknown(&self) -> bool {
2413 self.ty.is_unknown()
2416 /// Checks that particular type `ty` implements `std::future::Future`.
2417 /// This function is used in `.await` syntax completion.
2418 pub fn impls_future(&self, db: &dyn HirDatabase) -> bool {
2419 // No special case for the type of async block, since Chalk can figure it out.
2421 let krate = self.krate;
2423 let std_future_trait =
2424 db.lang_item(krate, "future_trait".into()).and_then(|it| it.as_trait());
2425 let std_future_trait = match std_future_trait {
2427 None => return false,
2431 Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(&Interner) };
2432 method_resolution::implements_trait(
2441 /// Checks that particular type `ty` implements `std::ops::FnOnce`.
2443 /// This function can be used to check if a particular type is callable, since FnOnce is a
2444 /// supertrait of Fn and FnMut, so all callable types implements at least FnOnce.
2445 pub fn impls_fnonce(&self, db: &dyn HirDatabase) -> bool {
2446 let krate = self.krate;
2448 let fnonce_trait = match FnTrait::FnOnce.get_id(db, krate) {
2450 None => return false,
2454 Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(&Interner) };
2455 method_resolution::implements_trait_unique(
2464 pub fn impls_trait(&self, db: &dyn HirDatabase, trait_: Trait, args: &[Type]) -> bool {
2465 let trait_ref = TyBuilder::trait_ref(db, trait_.id)
2466 .push(self.ty.clone())
2467 .fill(args.iter().map(|t| t.ty.clone()))
2470 let goal = Canonical {
2471 value: hir_ty::InEnvironment::new(&self.env.env, trait_ref.cast(&Interner)),
2472 binders: CanonicalVarKinds::empty(&Interner),
2475 db.trait_solve(self.krate, goal).is_some()
2478 pub fn normalize_trait_assoc_type(
2480 db: &dyn HirDatabase,
2484 let projection = TyBuilder::assoc_type_projection(db, alias.id)
2485 .push(self.ty.clone())
2486 .fill(args.iter().map(|t| t.ty.clone()))
2488 let goal = hir_ty::make_canonical(
2492 alias: AliasTy::Projection(projection),
2493 ty: TyKind::BoundVar(BoundVar::new(DebruijnIndex::INNERMOST, 0))
2498 [TyVariableKind::General].into_iter(),
2501 match db.trait_solve(self.krate, goal)? {
2502 Solution::Unique(s) => s
2505 .as_slice(&Interner)
2507 .map(|ty| self.derived(ty.assert_ty_ref(&Interner).clone())),
2508 Solution::Ambig(_) => None,
2512 pub fn is_copy(&self, db: &dyn HirDatabase) -> bool {
2513 let lang_item = db.lang_item(self.krate, SmolStr::new("copy"));
2514 let copy_trait = match lang_item {
2515 Some(LangItemTarget::TraitId(it)) => it,
2518 self.impls_trait(db, copy_trait.into(), &[])
2521 pub fn as_callable(&self, db: &dyn HirDatabase) -> Option<Callable> {
2522 let def = self.ty.callable_def(db);
2524 let sig = self.ty.callable_sig(db)?;
2525 Some(Callable { ty: self.clone(), sig, def, is_bound_method: false })
2528 pub fn is_closure(&self) -> bool {
2529 matches!(&self.ty.kind(&Interner), TyKind::Closure { .. })
2532 pub fn is_fn(&self) -> bool {
2533 matches!(&self.ty.kind(&Interner), TyKind::FnDef(..) | TyKind::Function { .. })
2536 pub fn is_packed(&self, db: &dyn HirDatabase) -> bool {
2537 let adt_id = match *self.ty.kind(&Interner) {
2538 TyKind::Adt(hir_ty::AdtId(adt_id), ..) => adt_id,
2542 let adt = adt_id.into();
2544 Adt::Struct(s) => matches!(s.repr(db), Some(ReprKind::Packed)),
2549 pub fn is_raw_ptr(&self) -> bool {
2550 matches!(&self.ty.kind(&Interner), TyKind::Raw(..))
2553 pub fn contains_unknown(&self) -> bool {
2554 return go(&self.ty);
2556 fn go(ty: &Ty) -> bool {
2557 match ty.kind(&Interner) {
2558 TyKind::Error => true,
2560 TyKind::Adt(_, substs)
2561 | TyKind::AssociatedType(_, substs)
2562 | TyKind::Tuple(_, substs)
2563 | TyKind::OpaqueType(_, substs)
2564 | TyKind::FnDef(_, substs)
2565 | TyKind::Closure(_, substs) => {
2566 substs.iter(&Interner).filter_map(|a| a.ty(&Interner)).any(go)
2569 TyKind::Array(_ty, len) if len.is_unknown() => true,
2570 TyKind::Array(ty, _)
2572 | TyKind::Raw(_, ty)
2573 | TyKind::Ref(_, _, ty) => go(ty),
2578 | TyKind::Placeholder(_)
2579 | TyKind::BoundVar(_)
2580 | TyKind::InferenceVar(_, _)
2582 | TyKind::Function(_)
2584 | TyKind::Foreign(_)
2585 | TyKind::Generator(..)
2586 | TyKind::GeneratorWitness(..) => false,
2591 pub fn fields(&self, db: &dyn HirDatabase) -> Vec<(Field, Type)> {
2592 let (variant_id, substs) = match self.ty.kind(&Interner) {
2593 TyKind::Adt(hir_ty::AdtId(AdtId::StructId(s)), substs) => ((*s).into(), substs),
2594 TyKind::Adt(hir_ty::AdtId(AdtId::UnionId(u)), substs) => ((*u).into(), substs),
2595 _ => return Vec::new(),
2598 db.field_types(variant_id)
2600 .map(|(local_id, ty)| {
2601 let def = Field { parent: variant_id.into(), id: local_id };
2602 let ty = ty.clone().substitute(&Interner, substs);
2603 (def, self.derived(ty))
2608 pub fn tuple_fields(&self, _db: &dyn HirDatabase) -> Vec<Type> {
2609 if let TyKind::Tuple(_, substs) = &self.ty.kind(&Interner) {
2612 .map(|ty| self.derived(ty.assert_ty_ref(&Interner).clone()))
2619 pub fn autoderef<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Type> + 'a {
2620 // There should be no inference vars in types passed here
2621 let canonical = hir_ty::replace_errors_with_variables(&self.ty);
2622 let environment = self.env.env.clone();
2623 let ty = InEnvironment { goal: canonical, environment };
2624 autoderef(db, Some(self.krate), ty)
2625 .map(|canonical| canonical.value)
2626 .map(move |ty| self.derived(ty))
2629 // This would be nicer if it just returned an iterator, but that runs into
2630 // lifetime problems, because we need to borrow temp `CrateImplDefs`.
2631 pub fn iterate_assoc_items<T>(
2633 db: &dyn HirDatabase,
2635 mut callback: impl FnMut(AssocItem) -> Option<T>,
2637 let mut slot = None;
2638 self.iterate_assoc_items_dyn(db, krate, &mut |assoc_item_id| {
2639 slot = callback(assoc_item_id.into());
2645 fn iterate_assoc_items_dyn(
2647 db: &dyn HirDatabase,
2649 callback: &mut dyn FnMut(AssocItemId) -> bool,
2651 let def_crates = match method_resolution::def_crates(db, &self.ty, krate.id) {
2655 for krate in def_crates {
2656 let impls = db.inherent_impls_in_crate(krate);
2658 for impl_def in impls.for_self_ty(&self.ty) {
2659 for &item in db.impl_data(*impl_def).items.iter() {
2668 pub fn type_arguments(&self) -> impl Iterator<Item = Type> + '_ {
2673 .flat_map(|(_, substs)| substs.iter(&Interner))
2674 .filter_map(|arg| arg.ty(&Interner).cloned())
2675 .map(move |ty| self.derived(ty))
2678 pub fn iterate_method_candidates<T>(
2680 db: &dyn HirDatabase,
2682 traits_in_scope: &FxHashSet<TraitId>,
2683 name: Option<&Name>,
2684 mut callback: impl FnMut(Type, Function) -> Option<T>,
2686 let _p = profile::span("iterate_method_candidates");
2687 let mut slot = None;
2688 self.iterate_method_candidates_dyn(
2693 &mut |ty, assoc_item_id| {
2694 if let AssocItemId::FunctionId(func) = assoc_item_id {
2695 if let Some(res) = callback(self.derived(ty.clone()), func.into()) {
2697 return ControlFlow::Break(());
2700 ControlFlow::Continue(())
2706 fn iterate_method_candidates_dyn(
2708 db: &dyn HirDatabase,
2710 traits_in_scope: &FxHashSet<TraitId>,
2711 name: Option<&Name>,
2712 callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
2714 // There should be no inference vars in types passed here
2715 let canonical = hir_ty::replace_errors_with_variables(&self.ty);
2717 let env = self.env.clone();
2718 let krate = krate.id;
2720 method_resolution::iterate_method_candidates_dyn(
2728 method_resolution::LookupMode::MethodCall,
2729 &mut |ty, id| callback(&ty.value, id),
2733 pub fn iterate_path_candidates<T>(
2735 db: &dyn HirDatabase,
2737 traits_in_scope: &FxHashSet<TraitId>,
2738 name: Option<&Name>,
2739 mut callback: impl FnMut(Type, AssocItem) -> Option<T>,
2741 let _p = profile::span("iterate_path_candidates");
2742 let mut slot = None;
2743 self.iterate_path_candidates_dyn(
2748 &mut |ty, assoc_item_id| {
2749 if let Some(res) = callback(self.derived(ty.clone()), assoc_item_id.into()) {
2751 return ControlFlow::Break(());
2753 ControlFlow::Continue(())
2759 fn iterate_path_candidates_dyn(
2761 db: &dyn HirDatabase,
2763 traits_in_scope: &FxHashSet<TraitId>,
2764 name: Option<&Name>,
2765 callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
2767 let canonical = hir_ty::replace_errors_with_variables(&self.ty);
2769 let env = self.env.clone();
2770 let krate = krate.id;
2772 method_resolution::iterate_method_candidates_dyn(
2780 method_resolution::LookupMode::Path,
2781 &mut |ty, id| callback(&ty.value, id),
2785 pub fn as_adt(&self) -> Option<Adt> {
2786 let (adt, _subst) = self.ty.as_adt()?;
2790 pub fn as_builtin(&self) -> Option<BuiltinType> {
2791 self.ty.as_builtin().map(|inner| BuiltinType { inner })
2794 pub fn as_dyn_trait(&self) -> Option<Trait> {
2795 self.ty.dyn_trait().map(Into::into)
2798 /// If a type can be represented as `dyn Trait`, returns all traits accessible via this type,
2799 /// or an empty iterator otherwise.
2800 pub fn applicable_inherent_traits<'a>(
2802 db: &'a dyn HirDatabase,
2803 ) -> impl Iterator<Item = Trait> + 'a {
2804 let _p = profile::span("applicable_inherent_traits");
2806 .filter_map(|derefed_type| derefed_type.ty.dyn_trait())
2807 .flat_map(move |dyn_trait_id| hir_ty::all_super_traits(db.upcast(), dyn_trait_id))
2811 pub fn as_impl_traits(&self, db: &dyn HirDatabase) -> Option<Vec<Trait>> {
2812 self.ty.impl_trait_bounds(db).map(|it| {
2814 .filter_map(|pred| match pred.skip_binders() {
2815 hir_ty::WhereClause::Implemented(trait_ref) => {
2816 Some(Trait::from(trait_ref.hir_trait_id()))
2824 pub fn as_associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<Trait> {
2825 self.ty.associated_type_parent_trait(db).map(Into::into)
2828 fn derived(&self, ty: Ty) -> Type {
2829 Type { krate: self.krate, env: self.env.clone(), ty }
2832 pub fn walk(&self, db: &dyn HirDatabase, mut cb: impl FnMut(Type)) {
2833 // TypeWalk::walk for a Ty at first visits parameters and only after that the Ty itself.
2834 // We need a different order here.
2837 db: &dyn HirDatabase,
2839 substs: &Substitution,
2840 cb: &mut impl FnMut(Type),
2842 for ty in substs.iter(&Interner).filter_map(|a| a.ty(&Interner)) {
2843 walk_type(db, &type_.derived(ty.clone()), cb);
2848 db: &dyn HirDatabase,
2850 bounds: &[QuantifiedWhereClause],
2851 cb: &mut impl FnMut(Type),
2853 for pred in bounds {
2854 if let WhereClause::Implemented(trait_ref) = pred.skip_binders() {
2856 // skip the self type. it's likely the type we just got the bounds from
2861 .filter_map(|a| a.ty(&Interner))
2863 walk_type(db, &type_.derived(ty.clone()), cb);
2869 fn walk_type(db: &dyn HirDatabase, type_: &Type, cb: &mut impl FnMut(Type)) {
2870 let ty = type_.ty.strip_references();
2871 match ty.kind(&Interner) {
2872 TyKind::Adt(_, substs) => {
2873 cb(type_.derived(ty.clone()));
2874 walk_substs(db, type_, substs, cb);
2876 TyKind::AssociatedType(_, substs) => {
2877 if ty.associated_type_parent_trait(db).is_some() {
2878 cb(type_.derived(ty.clone()));
2880 walk_substs(db, type_, substs, cb);
2882 TyKind::OpaqueType(_, subst) => {
2883 if let Some(bounds) = ty.impl_trait_bounds(db) {
2884 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2887 walk_substs(db, type_, subst, cb);
2889 TyKind::Alias(AliasTy::Opaque(opaque_ty)) => {
2890 if let Some(bounds) = ty.impl_trait_bounds(db) {
2891 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2894 walk_substs(db, type_, &opaque_ty.substitution, cb);
2896 TyKind::Placeholder(_) => {
2897 if let Some(bounds) = ty.impl_trait_bounds(db) {
2898 walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2901 TyKind::Dyn(bounds) => {
2904 &type_.derived(ty.clone()),
2905 bounds.bounds.skip_binders().interned(),
2910 TyKind::Ref(_, _, ty)
2911 | TyKind::Raw(_, ty)
2912 | TyKind::Array(ty, _)
2913 | TyKind::Slice(ty) => {
2914 walk_type(db, &type_.derived(ty.clone()), cb);
2917 TyKind::FnDef(_, substs)
2918 | TyKind::Tuple(_, substs)
2919 | TyKind::Closure(.., substs) => {
2920 walk_substs(db, type_, substs, cb);
2922 TyKind::Function(hir_ty::FnPointer { substitution, .. }) => {
2923 walk_substs(db, type_, &substitution.0, cb);
2930 walk_type(db, self, &mut cb);
2933 pub fn could_unify_with(&self, db: &dyn HirDatabase, other: &Type) -> bool {
2934 let tys = hir_ty::replace_errors_with_variables(&(self.ty.clone(), other.ty.clone()));
2935 could_unify(db, self.env.clone(), &tys)
2941 pub struct Callable {
2944 def: Option<CallableDefId>,
2945 pub(crate) is_bound_method: bool,
2948 pub enum CallableKind {
2950 TupleStruct(Struct),
2951 TupleEnumVariant(Variant),
2956 pub fn kind(&self) -> CallableKind {
2958 Some(CallableDefId::FunctionId(it)) => CallableKind::Function(it.into()),
2959 Some(CallableDefId::StructId(it)) => CallableKind::TupleStruct(it.into()),
2960 Some(CallableDefId::EnumVariantId(it)) => CallableKind::TupleEnumVariant(it.into()),
2961 None => CallableKind::Closure,
2964 pub fn receiver_param(&self, db: &dyn HirDatabase) -> Option<ast::SelfParam> {
2965 let func = match self.def {
2966 Some(CallableDefId::FunctionId(it)) if self.is_bound_method => it,
2969 let src = func.lookup(db.upcast()).source(db.upcast());
2970 let param_list = src.value.param_list()?;
2971 param_list.self_param()
2973 pub fn n_params(&self) -> usize {
2974 self.sig.params().len() - if self.is_bound_method { 1 } else { 0 }
2978 db: &dyn HirDatabase,
2979 ) -> Vec<(Option<Either<ast::SelfParam, ast::Pat>>, Type)> {
2984 .skip(if self.is_bound_method { 1 } else { 0 })
2985 .map(|ty| self.ty.derived(ty.clone()));
2986 let patterns = match self.def {
2987 Some(CallableDefId::FunctionId(func)) => {
2988 let src = func.lookup(db.upcast()).source(db.upcast());
2989 src.value.param_list().map(|param_list| {
2992 .map(|it| Some(Either::Left(it)))
2993 .filter(|_| !self.is_bound_method)
2995 .chain(param_list.params().map(|it| it.pat().map(Either::Right)))
3000 patterns.into_iter().flatten().chain(iter::repeat(None)).zip(types).collect()
3002 pub fn return_type(&self) -> Type {
3003 self.ty.derived(self.sig.ret().clone())
3008 #[derive(Debug, PartialEq, Eq, Hash)]
3010 ModuleDef(ModuleDef),
3012 GenericParam(GenericParam),
3021 pub fn all_items(def: PerNs) -> ArrayVec<Self, 3> {
3022 let mut items = ArrayVec::new();
3024 match (def.take_types(), def.take_values()) {
3025 (Some(m1), None) => items.push(ScopeDef::ModuleDef(m1.into())),
3026 (None, Some(m2)) => items.push(ScopeDef::ModuleDef(m2.into())),
3027 (Some(m1), Some(m2)) => {
3028 // Some items, like unit structs and enum variants, are
3029 // returned as both a type and a value. Here we want
3030 // to de-duplicate them.
3032 items.push(ScopeDef::ModuleDef(m1.into()));
3033 items.push(ScopeDef::ModuleDef(m2.into()));
3035 items.push(ScopeDef::ModuleDef(m1.into()));
3041 if let Some(macro_def_id) = def.take_macros() {
3042 items.push(ScopeDef::MacroDef(macro_def_id.into()));
3045 if items.is_empty() {
3046 items.push(ScopeDef::Unknown);
3052 pub fn attrs(&self, db: &dyn HirDatabase) -> Option<AttrsWithOwner> {
3054 ScopeDef::ModuleDef(it) => it.attrs(db),
3055 ScopeDef::MacroDef(it) => Some(it.attrs(db)),
3056 ScopeDef::GenericParam(it) => Some(it.attrs(db)),
3057 ScopeDef::ImplSelfType(_)
3058 | ScopeDef::AdtSelfType(_)
3059 | ScopeDef::Local(_)
3060 | ScopeDef::Label(_)
3061 | ScopeDef::Unknown => None,
3065 pub fn krate(&self, db: &dyn HirDatabase) -> Option<Crate> {
3067 ScopeDef::ModuleDef(it) => it.module(db).map(|m| m.krate()),
3068 ScopeDef::MacroDef(it) => it.module(db).map(|m| m.krate()),
3069 ScopeDef::GenericParam(it) => Some(it.module(db).krate()),
3070 ScopeDef::ImplSelfType(_) => None,
3071 ScopeDef::AdtSelfType(it) => Some(it.module(db).krate()),
3072 ScopeDef::Local(it) => Some(it.module(db).krate()),
3073 ScopeDef::Label(it) => Some(it.module(db).krate()),
3074 ScopeDef::Unknown => None,
3079 impl From<ItemInNs> for ScopeDef {
3080 fn from(item: ItemInNs) -> Self {
3082 ItemInNs::Types(id) => ScopeDef::ModuleDef(id),
3083 ItemInNs::Values(id) => ScopeDef::ModuleDef(id),
3084 ItemInNs::Macros(id) => ScopeDef::MacroDef(id),
3089 pub trait HasVisibility {
3090 fn visibility(&self, db: &dyn HirDatabase) -> Visibility;
3091 fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool {
3092 let vis = self.visibility(db);
3093 vis.is_visible_from(db.upcast(), module.id)
3097 /// Trait for obtaining the defining crate of an item.
3098 pub trait HasCrate {
3099 fn krate(&self, db: &dyn HirDatabase) -> Crate;
3102 impl<T: hir_def::HasModule> HasCrate for T {
3103 fn krate(&self, db: &dyn HirDatabase) -> Crate {
3104 self.module(db.upcast()).krate().into()
3108 impl HasCrate for AssocItem {
3109 fn krate(&self, db: &dyn HirDatabase) -> Crate {
3110 self.module(db).krate()
3114 impl HasCrate for Field {
3115 fn krate(&self, db: &dyn HirDatabase) -> Crate {
3116 self.parent_def(db).module(db).krate()
3120 impl HasCrate for Function {
3121 fn krate(&self, db: &dyn HirDatabase) -> Crate {
3122 self.module(db).krate()
3126 impl HasCrate for Const {
3127 fn krate(&self, db: &dyn HirDatabase) -> Crate {
3128 self.module(db).krate()
3132 impl HasCrate for TypeAlias {
3133 fn krate(&self, db: &dyn HirDatabase) -> Crate {
3134 self.module(db).krate()
3138 impl HasCrate for Type {
3139 fn krate(&self, _db: &dyn HirDatabase) -> Crate {