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