crates/hir/src/lib.rs

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