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::ConstExtension,
  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 diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink) {
 879         let krate = self.module(db).id.krate();
 880         hir_def::diagnostics::validate_body(db.upcast(), self.id.into(), sink);
 881         hir_ty::diagnostics::validate_module_item(db, krate, self.id.into(), sink);
 882         hir_ty::diagnostics::validate_body(db, self.id.into(), sink);
 883     }
 884
 885     /// Whether this function declaration has a definition.
 886     ///
 887     /// This is false in the case of required (not provided) trait methods.
 888     pub fn has_body(self, db: &dyn HirDatabase) -> bool {
 889         db.function_data(self.id).has_body()
 890     }
 891
 892     /// A textual representation of the HIR of this function for debugging purposes.
 893     pub fn debug_hir(self, db: &dyn HirDatabase) -> String {
 894         let body = db.body(self.id.into());
 895
 896         let mut result = String::new();
 897         format_to!(result, "HIR expressions in the body of `{}`:\n", self.name(db));
 898         for (id, expr) in body.exprs.iter() {
 899             format_to!(result, "{:?}: {:?}\n", id, expr);
 900         }
 901
 902         result
 903     }
 904 }
 905
 906 // Note: logically, this belongs to `hir_ty`, but we are not using it there yet.
 907 pub enum Access {
 908     Shared,
 909     Exclusive,
 910     Owned,
 911 }
 912
 913 impl From<hir_ty::Mutability> for Access {
 914     fn from(mutability: hir_ty::Mutability) -> Access {
 915         match mutability {
 916             hir_ty::Mutability::Not => Access::Shared,
 917             hir_ty::Mutability::Mut => Access::Exclusive,
 918         }
 919     }
 920 }
 921
 922 #[derive(Clone, Debug)]
 923 pub struct Param {
 924     func: Function,
 925     /// The index in parameter list, including self parameter.
 926     idx: usize,
 927     ty: Type,
 928 }
 929
 930 impl Param {
 931     pub fn ty(&self) -> &Type {
 932         &self.ty
 933     }
 934
 935     pub fn as_local(&self, db: &dyn HirDatabase) -> Local {
 936         let parent = DefWithBodyId::FunctionId(self.func.into());
 937         let body = db.body(parent);
 938         Local { parent, pat_id: body.params[self.idx] }
 939     }
 940
 941     pub fn pattern_source(&self, db: &dyn HirDatabase) -> Option<ast::Pat> {
 942         self.source(db).and_then(|p| p.value.pat())
 943     }
 944
 945     pub fn source(&self, db: &dyn HirDatabase) -> Option<InFile<ast::Param>> {
 946         let InFile { file_id, value } = self.func.source(db)?;
 947         let params = value.param_list()?;
 948         if params.self_param().is_some() {
 949             params.params().nth(self.idx.checked_sub(1)?)
 950         } else {
 951             params.params().nth(self.idx)
 952         }
 953         .map(|value| InFile { file_id, value })
 954     }
 955 }
 956
 957 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 958 pub struct SelfParam {
 959     func: FunctionId,
 960 }
 961
 962 impl SelfParam {
 963     pub fn access(self, db: &dyn HirDatabase) -> Access {
 964         let func_data = db.function_data(self.func);
 965         func_data
 966             .params
 967             .first()
 968             .map(|param| match &**param {
 969                 TypeRef::Reference(.., mutability) => match mutability {
 970                     hir_def::type_ref::Mutability::Shared => Access::Shared,
 971                     hir_def::type_ref::Mutability::Mut => Access::Exclusive,
 972                 },
 973                 _ => Access::Owned,
 974             })
 975             .unwrap_or(Access::Owned)
 976     }
 977
 978     pub fn display(self, db: &dyn HirDatabase) -> &'static str {
 979         match self.access(db) {
 980             Access::Shared => "&self",
 981             Access::Exclusive => "&mut self",
 982             Access::Owned => "self",
 983         }
 984     }
 985
 986     pub fn source(&self, db: &dyn HirDatabase) -> Option<InFile<ast::SelfParam>> {
 987         let InFile { file_id, value } = Function::from(self.func).source(db)?;
 988         value
 989             .param_list()
 990             .and_then(|params| params.self_param())
 991             .map(|value| InFile { file_id, value })
 992     }
 993 }
 994
 995 impl HasVisibility for Function {
 996     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 997         let function_data = db.function_data(self.id);
 998         let visibility = &function_data.visibility;
 999         visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1000     }
1001 }
1002
1003 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1004 pub struct Const {
1005     pub(crate) id: ConstId,
1006 }
1007
1008 impl Const {
1009     pub fn module(self, db: &dyn HirDatabase) -> Module {
1010         Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1011     }
1012
1013     pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
1014         Some(self.module(db).krate())
1015     }
1016
1017     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1018         db.const_data(self.id).name.clone()
1019     }
1020
1021     pub fn type_ref(self, db: &dyn HirDatabase) -> TypeRef {
1022         db.const_data(self.id).type_ref.as_ref().clone()
1023     }
1024 }
1025
1026 impl HasVisibility for Const {
1027     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1028         let function_data = db.const_data(self.id);
1029         let visibility = &function_data.visibility;
1030         visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1031     }
1032 }
1033
1034 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1035 pub struct Static {
1036     pub(crate) id: StaticId,
1037 }
1038
1039 impl Static {
1040     pub fn module(self, db: &dyn HirDatabase) -> Module {
1041         Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1042     }
1043
1044     pub fn krate(self, db: &dyn HirDatabase) -> Option<Crate> {
1045         Some(self.module(db).krate())
1046     }
1047
1048     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1049         db.static_data(self.id).name.clone()
1050     }
1051
1052     pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1053         db.static_data(self.id).mutable
1054     }
1055 }
1056
1057 impl HasVisibility for Static {
1058     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1059         db.static_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1060     }
1061 }
1062
1063 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1064 pub struct Trait {
1065     pub(crate) id: TraitId,
1066 }
1067
1068 impl Trait {
1069     pub fn module(self, db: &dyn HirDatabase) -> Module {
1070         Module { id: self.id.lookup(db.upcast()).container }
1071     }
1072
1073     pub fn name(self, db: &dyn HirDatabase) -> Name {
1074         db.trait_data(self.id).name.clone()
1075     }
1076
1077     pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1078         db.trait_data(self.id).items.iter().map(|(_name, it)| (*it).into()).collect()
1079     }
1080
1081     pub fn is_auto(self, db: &dyn HirDatabase) -> bool {
1082         db.trait_data(self.id).is_auto
1083     }
1084 }
1085
1086 impl HasVisibility for Trait {
1087     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1088         db.trait_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1089     }
1090 }
1091
1092 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1093 pub struct TypeAlias {
1094     pub(crate) id: TypeAliasId,
1095 }
1096
1097 impl TypeAlias {
1098     pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
1099         let subst = db.generic_defaults(self.id.into());
1100         subst.iter().any(|ty| ty.skip_binders().is_unknown())
1101     }
1102
1103     pub fn module(self, db: &dyn HirDatabase) -> Module {
1104         Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1105     }
1106
1107     pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1108         self.module(db).krate()
1109     }
1110
1111     pub fn type_ref(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1112         db.type_alias_data(self.id).type_ref.as_deref().cloned()
1113     }
1114
1115     pub fn ty(self, db: &dyn HirDatabase) -> Type {
1116         Type::from_def(db, self.id.lookup(db.upcast()).module(db.upcast()).krate(), self.id)
1117     }
1118
1119     pub fn name(self, db: &dyn HirDatabase) -> Name {
1120         db.type_alias_data(self.id).name.clone()
1121     }
1122 }
1123
1124 impl HasVisibility for TypeAlias {
1125     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1126         let function_data = db.type_alias_data(self.id);
1127         let visibility = &function_data.visibility;
1128         visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1129     }
1130 }
1131
1132 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1133 pub struct BuiltinType {
1134     pub(crate) inner: hir_def::builtin_type::BuiltinType,
1135 }
1136
1137 impl BuiltinType {
1138     pub fn ty(self, db: &dyn HirDatabase, module: Module) -> Type {
1139         let resolver = module.id.resolver(db.upcast());
1140         Type::new_with_resolver(db, &resolver, TyBuilder::builtin(self.inner))
1141             .expect("crate not present in resolver")
1142     }
1143
1144     pub fn name(self) -> Name {
1145         self.inner.as_name()
1146     }
1147 }
1148
1149 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1150 pub enum MacroKind {
1151     Declarative,
1152     ProcMacro,
1153     Derive,
1154     BuiltIn,
1155 }
1156
1157 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1158 pub struct MacroDef {
1159     pub(crate) id: MacroDefId,
1160 }
1161
1162 impl MacroDef {
1163     /// FIXME: right now, this just returns the root module of the crate that
1164     /// defines this macro. The reasons for this is that macros are expanded
1165     /// early, in `hir_expand`, where modules simply do not exist yet.
1166     pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
1167         let krate = self.id.krate;
1168         let def_map = db.crate_def_map(krate);
1169         let module_id = def_map.root();
1170         Some(Module { id: def_map.module_id(module_id) })
1171     }
1172
1173     /// XXX: this parses the file
1174     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1175         match self.source(db)?.value {
1176             Either::Left(it) => it.name().map(|it| it.as_name()),
1177             Either::Right(it) => it.name().map(|it| it.as_name()),
1178         }
1179     }
1180
1181     pub fn kind(&self) -> MacroKind {
1182         match self.id.kind {
1183             MacroDefKind::Declarative(_) => MacroKind::Declarative,
1184             MacroDefKind::BuiltIn(_, _) => MacroKind::BuiltIn,
1185             MacroDefKind::BuiltInDerive(_, _) => MacroKind::Derive,
1186             MacroDefKind::BuiltInEager(_, _) => MacroKind::BuiltIn,
1187             // FIXME might be a derive
1188             MacroDefKind::ProcMacro(_, _) => MacroKind::ProcMacro,
1189         }
1190     }
1191 }
1192
1193 /// Invariant: `inner.as_assoc_item(db).is_some()`
1194 /// We do not actively enforce this invariant.
1195 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1196 pub enum AssocItem {
1197     Function(Function),
1198     Const(Const),
1199     TypeAlias(TypeAlias),
1200 }
1201 #[derive(Debug)]
1202 pub enum AssocItemContainer {
1203     Trait(Trait),
1204     Impl(Impl),
1205 }
1206 pub trait AsAssocItem {
1207     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>;
1208 }
1209
1210 impl AsAssocItem for Function {
1211     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1212         as_assoc_item(db, AssocItem::Function, self.id)
1213     }
1214 }
1215 impl AsAssocItem for Const {
1216     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1217         as_assoc_item(db, AssocItem::Const, self.id)
1218     }
1219 }
1220 impl AsAssocItem for TypeAlias {
1221     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1222         as_assoc_item(db, AssocItem::TypeAlias, self.id)
1223     }
1224 }
1225 impl AsAssocItem for ModuleDef {
1226     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1227         match self {
1228             ModuleDef::Function(it) => it.as_assoc_item(db),
1229             ModuleDef::Const(it) => it.as_assoc_item(db),
1230             ModuleDef::TypeAlias(it) => it.as_assoc_item(db),
1231             _ => None,
1232         }
1233     }
1234 }
1235 fn as_assoc_item<ID, DEF, CTOR, AST>(db: &dyn HirDatabase, ctor: CTOR, id: ID) -> Option<AssocItem>
1236 where
1237     ID: Lookup<Data = AssocItemLoc<AST>>,
1238     DEF: From<ID>,
1239     CTOR: FnOnce(DEF) -> AssocItem,
1240     AST: ItemTreeNode,
1241 {
1242     match id.lookup(db.upcast()).container {
1243         AssocContainerId::TraitId(_) | AssocContainerId::ImplId(_) => Some(ctor(DEF::from(id))),
1244         AssocContainerId::ModuleId(_) => None,
1245     }
1246 }
1247
1248 impl AssocItem {
1249     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1250         match self {
1251             AssocItem::Function(it) => Some(it.name(db)),
1252             AssocItem::Const(it) => it.name(db),
1253             AssocItem::TypeAlias(it) => Some(it.name(db)),
1254         }
1255     }
1256     pub fn module(self, db: &dyn HirDatabase) -> Module {
1257         match self {
1258             AssocItem::Function(f) => f.module(db),
1259             AssocItem::Const(c) => c.module(db),
1260             AssocItem::TypeAlias(t) => t.module(db),
1261         }
1262     }
1263     pub fn container(self, db: &dyn HirDatabase) -> AssocItemContainer {
1264         let container = match self {
1265             AssocItem::Function(it) => it.id.lookup(db.upcast()).container,
1266             AssocItem::Const(it) => it.id.lookup(db.upcast()).container,
1267             AssocItem::TypeAlias(it) => it.id.lookup(db.upcast()).container,
1268         };
1269         match container {
1270             AssocContainerId::TraitId(id) => AssocItemContainer::Trait(id.into()),
1271             AssocContainerId::ImplId(id) => AssocItemContainer::Impl(id.into()),
1272             AssocContainerId::ModuleId(_) => panic!("invalid AssocItem"),
1273         }
1274     }
1275
1276     pub fn containing_trait(self, db: &dyn HirDatabase) -> Option<Trait> {
1277         match self.container(db) {
1278             AssocItemContainer::Trait(t) => Some(t),
1279             _ => None,
1280         }
1281     }
1282 }
1283
1284 impl HasVisibility for AssocItem {
1285     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1286         match self {
1287             AssocItem::Function(f) => f.visibility(db),
1288             AssocItem::Const(c) => c.visibility(db),
1289             AssocItem::TypeAlias(t) => t.visibility(db),
1290         }
1291     }
1292 }
1293
1294 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1295 pub enum GenericDef {
1296     Function(Function),
1297     Adt(Adt),
1298     Trait(Trait),
1299     TypeAlias(TypeAlias),
1300     Impl(Impl),
1301     // enum variants cannot have generics themselves, but their parent enums
1302     // can, and this makes some code easier to write
1303     Variant(Variant),
1304     // consts can have type parameters from their parents (i.e. associated consts of traits)
1305     Const(Const),
1306 }
1307 impl_from!(
1308     Function,
1309     Adt(Struct, Enum, Union),
1310     Trait,
1311     TypeAlias,
1312     Impl,
1313     Variant,
1314     Const
1315     for GenericDef
1316 );
1317
1318 impl GenericDef {
1319     pub fn params(self, db: &dyn HirDatabase) -> Vec<GenericParam> {
1320         let generics = db.generic_params(self.into());
1321         let ty_params = generics
1322             .types
1323             .iter()
1324             .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1325             .map(GenericParam::TypeParam);
1326         let lt_params = generics
1327             .lifetimes
1328             .iter()
1329             .map(|(local_id, _)| LifetimeParam {
1330                 id: LifetimeParamId { parent: self.into(), local_id },
1331             })
1332             .map(GenericParam::LifetimeParam);
1333         let const_params = generics
1334             .consts
1335             .iter()
1336             .map(|(local_id, _)| ConstParam { id: ConstParamId { parent: self.into(), local_id } })
1337             .map(GenericParam::ConstParam);
1338         ty_params.chain(lt_params).chain(const_params).collect()
1339     }
1340
1341     pub fn type_params(self, db: &dyn HirDatabase) -> Vec<TypeParam> {
1342         let generics = db.generic_params(self.into());
1343         generics
1344             .types
1345             .iter()
1346             .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1347             .collect()
1348     }
1349 }
1350
1351 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1352 pub struct Local {
1353     pub(crate) parent: DefWithBodyId,
1354     pub(crate) pat_id: PatId,
1355 }
1356
1357 impl Local {
1358     pub fn is_param(self, db: &dyn HirDatabase) -> bool {
1359         let src = self.source(db);
1360         match src.value {
1361             Either::Left(bind_pat) => {
1362                 bind_pat.syntax().ancestors().any(|it| ast::Param::can_cast(it.kind()))
1363             }
1364             Either::Right(_self_param) => true,
1365         }
1366     }
1367
1368     pub fn as_self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
1369         match self.parent {
1370             DefWithBodyId::FunctionId(func) if self.is_self(db) => Some(SelfParam { func }),
1371             _ => None,
1372         }
1373     }
1374
1375     // FIXME: why is this an option? It shouldn't be?
1376     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1377         let body = db.body(self.parent);
1378         match &body[self.pat_id] {
1379             Pat::Bind { name, .. } => Some(name.clone()),
1380             _ => None,
1381         }
1382     }
1383
1384     pub fn is_self(self, db: &dyn HirDatabase) -> bool {
1385         self.name(db) == Some(name![self])
1386     }
1387
1388     pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1389         let body = db.body(self.parent);
1390         matches!(&body[self.pat_id], Pat::Bind { mode: BindingAnnotation::Mutable, .. })
1391     }
1392
1393     pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1394         self.parent.into()
1395     }
1396
1397     pub fn module(self, db: &dyn HirDatabase) -> Module {
1398         self.parent(db).module(db)
1399     }
1400
1401     pub fn ty(self, db: &dyn HirDatabase) -> Type {
1402         let def = self.parent;
1403         let infer = db.infer(def);
1404         let ty = infer[self.pat_id].clone();
1405         let krate = def.module(db.upcast()).krate();
1406         Type::new(db, krate, def, ty)
1407     }
1408
1409     pub fn source(self, db: &dyn HirDatabase) -> InFile<Either<ast::IdentPat, ast::SelfParam>> {
1410         let (_body, source_map) = db.body_with_source_map(self.parent);
1411         let src = source_map.pat_syntax(self.pat_id).unwrap(); // Hmm...
1412         let root = src.file_syntax(db.upcast());
1413         src.map(|ast| {
1414             ast.map_left(|it| it.cast().unwrap().to_node(&root)).map_right(|it| it.to_node(&root))
1415         })
1416     }
1417 }
1418
1419 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1420 pub struct Label {
1421     pub(crate) parent: DefWithBodyId,
1422     pub(crate) label_id: LabelId,
1423 }
1424
1425 impl Label {
1426     pub fn module(self, db: &dyn HirDatabase) -> Module {
1427         self.parent(db).module(db)
1428     }
1429
1430     pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
1431         self.parent.into()
1432     }
1433
1434     pub fn name(self, db: &dyn HirDatabase) -> Name {
1435         let body = db.body(self.parent);
1436         body[self.label_id].name.clone()
1437     }
1438
1439     pub fn source(self, db: &dyn HirDatabase) -> InFile<ast::Label> {
1440         let (_body, source_map) = db.body_with_source_map(self.parent);
1441         let src = source_map.label_syntax(self.label_id);
1442         let root = src.file_syntax(db.upcast());
1443         src.map(|ast| ast.to_node(&root))
1444     }
1445 }
1446
1447 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1448 pub enum GenericParam {
1449     TypeParam(TypeParam),
1450     LifetimeParam(LifetimeParam),
1451     ConstParam(ConstParam),
1452 }
1453 impl_from!(TypeParam, LifetimeParam, ConstParam for GenericParam);
1454
1455 impl GenericParam {
1456     pub fn module(self, db: &dyn HirDatabase) -> Module {
1457         match self {
1458             GenericParam::TypeParam(it) => it.module(db),
1459             GenericParam::LifetimeParam(it) => it.module(db),
1460             GenericParam::ConstParam(it) => it.module(db),
1461         }
1462     }
1463
1464     pub fn name(self, db: &dyn HirDatabase) -> Name {
1465         match self {
1466             GenericParam::TypeParam(it) => it.name(db),
1467             GenericParam::LifetimeParam(it) => it.name(db),
1468             GenericParam::ConstParam(it) => it.name(db),
1469         }
1470     }
1471 }
1472
1473 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1474 pub struct TypeParam {
1475     pub(crate) id: TypeParamId,
1476 }
1477
1478 impl TypeParam {
1479     pub fn name(self, db: &dyn HirDatabase) -> Name {
1480         let params = db.generic_params(self.id.parent);
1481         params.types[self.id.local_id].name.clone().unwrap_or_else(Name::missing)
1482     }
1483
1484     pub fn module(self, db: &dyn HirDatabase) -> Module {
1485         self.id.parent.module(db.upcast()).into()
1486     }
1487
1488     pub fn ty(self, db: &dyn HirDatabase) -> Type {
1489         let resolver = self.id.parent.resolver(db.upcast());
1490         let krate = self.id.parent.module(db.upcast()).krate();
1491         let ty = TyKind::Placeholder(hir_ty::to_placeholder_idx(db, self.id)).intern(&Interner);
1492         Type::new_with_resolver_inner(db, krate, &resolver, ty)
1493     }
1494
1495     pub fn trait_bounds(self, db: &dyn HirDatabase) -> Vec<Trait> {
1496         db.generic_predicates_for_param(self.id)
1497             .into_iter()
1498             .filter_map(|pred| match &pred.skip_binders().skip_binders() {
1499                 hir_ty::WhereClause::Implemented(trait_ref) => {
1500                     Some(Trait::from(trait_ref.hir_trait_id()))
1501                 }
1502                 _ => None,
1503             })
1504             .collect()
1505     }
1506
1507     pub fn default(self, db: &dyn HirDatabase) -> Option<Type> {
1508         let params = db.generic_defaults(self.id.parent);
1509         let local_idx = hir_ty::param_idx(db, self.id)?;
1510         let resolver = self.id.parent.resolver(db.upcast());
1511         let krate = self.id.parent.module(db.upcast()).krate();
1512         let ty = params.get(local_idx)?.clone();
1513         let subst = TyBuilder::type_params_subst(db, self.id.parent);
1514         let ty = ty.substitute(&Interner, &subst_prefix(&subst, local_idx));
1515         Some(Type::new_with_resolver_inner(db, krate, &resolver, ty))
1516     }
1517 }
1518
1519 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1520 pub struct LifetimeParam {
1521     pub(crate) id: LifetimeParamId,
1522 }
1523
1524 impl LifetimeParam {
1525     pub fn name(self, db: &dyn HirDatabase) -> Name {
1526         let params = db.generic_params(self.id.parent);
1527         params.lifetimes[self.id.local_id].name.clone()
1528     }
1529
1530     pub fn module(self, db: &dyn HirDatabase) -> Module {
1531         self.id.parent.module(db.upcast()).into()
1532     }
1533
1534     pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1535         self.id.parent.into()
1536     }
1537 }
1538
1539 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1540 pub struct ConstParam {
1541     pub(crate) id: ConstParamId,
1542 }
1543
1544 impl ConstParam {
1545     pub fn name(self, db: &dyn HirDatabase) -> Name {
1546         let params = db.generic_params(self.id.parent);
1547         params.consts[self.id.local_id].name.clone()
1548     }
1549
1550     pub fn module(self, db: &dyn HirDatabase) -> Module {
1551         self.id.parent.module(db.upcast()).into()
1552     }
1553
1554     pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
1555         self.id.parent.into()
1556     }
1557
1558     pub fn ty(self, db: &dyn HirDatabase) -> Type {
1559         let def = self.id.parent;
1560         let krate = def.module(db.upcast()).krate();
1561         Type::new(db, krate, def, db.const_param_ty(self.id))
1562     }
1563 }
1564
1565 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1566 pub struct Impl {
1567     pub(crate) id: ImplId,
1568 }
1569
1570 impl Impl {
1571     pub fn all_in_crate(db: &dyn HirDatabase, krate: Crate) -> Vec<Impl> {
1572         let inherent = db.inherent_impls_in_crate(krate.id);
1573         let trait_ = db.trait_impls_in_crate(krate.id);
1574
1575         inherent.all_impls().chain(trait_.all_impls()).map(Self::from).collect()
1576     }
1577
1578     pub fn all_for_type(db: &dyn HirDatabase, Type { krate, ty, .. }: Type) -> Vec<Impl> {
1579         let def_crates = match def_crates(db, &ty, krate) {
1580             Some(def_crates) => def_crates,
1581             None => return Vec::new(),
1582         };
1583
1584         let filter = |impl_def: &Impl| {
1585             let self_ty = impl_def.self_ty(db);
1586             let rref = self_ty.remove_ref();
1587             ty.equals_ctor(rref.as_ref().map_or(&self_ty.ty, |it| &it.ty))
1588         };
1589
1590         let fp = TyFingerprint::for_inherent_impl(&ty);
1591         let fp = if let Some(fp) = fp {
1592             fp
1593         } else {
1594             return Vec::new();
1595         };
1596
1597         let mut all = Vec::new();
1598         def_crates.iter().for_each(|&id| {
1599             all.extend(
1600                 db.inherent_impls_in_crate(id)
1601                     .for_self_ty(&ty)
1602                     .into_iter()
1603                     .cloned()
1604                     .map(Self::from)
1605                     .filter(filter),
1606             )
1607         });
1608         for id in def_crates
1609             .iter()
1610             .flat_map(|&id| Crate { id }.transitive_reverse_dependencies(db))
1611             .map(|Crate { id }| id)
1612             .chain(def_crates.iter().copied())
1613             .unique()
1614         {
1615             all.extend(
1616                 db.trait_impls_in_crate(id)
1617                     .for_self_ty_without_blanket_impls(fp)
1618                     .map(Self::from)
1619                     .filter(filter),
1620             );
1621         }
1622         all
1623     }
1624
1625     pub fn all_for_trait(db: &dyn HirDatabase, trait_: Trait) -> Vec<Impl> {
1626         let krate = trait_.module(db).krate();
1627         let mut all = Vec::new();
1628         for Crate { id } in krate.transitive_reverse_dependencies(db).into_iter() {
1629             let impls = db.trait_impls_in_crate(id);
1630             all.extend(impls.for_trait(trait_.id).map(Self::from))
1631         }
1632         all
1633     }
1634
1635     // FIXME: the return type is wrong. This should be a hir version of
1636     // `TraitRef` (ie, resolved `TypeRef`).
1637     pub fn trait_(self, db: &dyn HirDatabase) -> Option<TraitRef> {
1638         db.impl_data(self.id).target_trait.as_deref().cloned()
1639     }
1640
1641     pub fn self_ty(self, db: &dyn HirDatabase) -> Type {
1642         let impl_data = db.impl_data(self.id);
1643         let resolver = self.id.resolver(db.upcast());
1644         let krate = self.id.lookup(db.upcast()).container.krate();
1645         let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1646         let ty = ctx.lower_ty(&impl_data.self_ty);
1647         Type::new_with_resolver_inner(db, krate, &resolver, ty)
1648     }
1649
1650     pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1651         db.impl_data(self.id).items.iter().map(|it| (*it).into()).collect()
1652     }
1653
1654     pub fn is_negative(self, db: &dyn HirDatabase) -> bool {
1655         db.impl_data(self.id).is_negative
1656     }
1657
1658     pub fn module(self, db: &dyn HirDatabase) -> Module {
1659         self.id.lookup(db.upcast()).container.into()
1660     }
1661
1662     pub fn krate(self, db: &dyn HirDatabase) -> Crate {
1663         Crate { id: self.module(db).id.krate() }
1664     }
1665
1666     pub fn is_builtin_derive(self, db: &dyn HirDatabase) -> Option<InFile<ast::Attr>> {
1667         let src = self.source(db)?;
1668         let item = src.file_id.is_builtin_derive(db.upcast())?;
1669         let hygenic = hir_expand::hygiene::Hygiene::new(db.upcast(), item.file_id);
1670
1671         // FIXME: handle `cfg_attr`
1672         let attr = item
1673             .value
1674             .attrs()
1675             .filter_map(|it| {
1676                 let path = ModPath::from_src(db.upcast(), it.path()?, &hygenic)?;
1677                 if path.as_ident()?.to_string() == "derive" {
1678                     Some(it)
1679                 } else {
1680                     None
1681                 }
1682             })
1683             .last()?;
1684
1685         Some(item.with_value(attr))
1686     }
1687 }
1688
1689 #[derive(Clone, PartialEq, Eq, Debug)]
1690 pub struct Type {
1691     krate: CrateId,
1692     env: Arc<TraitEnvironment>,
1693     ty: Ty,
1694 }
1695
1696 impl Type {
1697     pub(crate) fn new_with_resolver(
1698         db: &dyn HirDatabase,
1699         resolver: &Resolver,
1700         ty: Ty,
1701     ) -> Option<Type> {
1702         let krate = resolver.krate()?;
1703         Some(Type::new_with_resolver_inner(db, krate, resolver, ty))
1704     }
1705     pub(crate) fn new_with_resolver_inner(
1706         db: &dyn HirDatabase,
1707         krate: CrateId,
1708         resolver: &Resolver,
1709         ty: Ty,
1710     ) -> Type {
1711         let environment =
1712             resolver.generic_def().map_or_else(Default::default, |d| db.trait_environment(d));
1713         Type { krate, env: environment, ty }
1714     }
1715
1716     fn new(db: &dyn HirDatabase, krate: CrateId, lexical_env: impl HasResolver, ty: Ty) -> Type {
1717         let resolver = lexical_env.resolver(db.upcast());
1718         let environment =
1719             resolver.generic_def().map_or_else(Default::default, |d| db.trait_environment(d));
1720         Type { krate, env: environment, ty }
1721     }
1722
1723     fn from_def(
1724         db: &dyn HirDatabase,
1725         krate: CrateId,
1726         def: impl HasResolver + Into<TyDefId>,
1727     ) -> Type {
1728         let ty = TyBuilder::def_ty(db, def.into()).fill_with_unknown().build();
1729         Type::new(db, krate, def, ty)
1730     }
1731
1732     pub fn is_unit(&self) -> bool {
1733         matches!(self.ty.kind(&Interner), TyKind::Tuple(0, ..))
1734     }
1735     pub fn is_bool(&self) -> bool {
1736         matches!(self.ty.kind(&Interner), TyKind::Scalar(Scalar::Bool))
1737     }
1738
1739     pub fn is_mutable_reference(&self) -> bool {
1740         matches!(self.ty.kind(&Interner), TyKind::Ref(hir_ty::Mutability::Mut, ..))
1741     }
1742
1743     pub fn is_usize(&self) -> bool {
1744         matches!(self.ty.kind(&Interner), TyKind::Scalar(Scalar::Uint(UintTy::Usize)))
1745     }
1746
1747     pub fn remove_ref(&self) -> Option<Type> {
1748         match &self.ty.kind(&Interner) {
1749             TyKind::Ref(.., ty) => Some(self.derived(ty.clone())),
1750             _ => None,
1751         }
1752     }
1753
1754     pub fn strip_references(&self) -> Type {
1755         self.derived(self.ty.strip_references().clone())
1756     }
1757
1758     pub fn is_unknown(&self) -> bool {
1759         self.ty.is_unknown()
1760     }
1761
1762     /// Checks that particular type `ty` implements `std::future::Future`.
1763     /// This function is used in `.await` syntax completion.
1764     pub fn impls_future(&self, db: &dyn HirDatabase) -> bool {
1765         // No special case for the type of async block, since Chalk can figure it out.
1766
1767         let krate = self.krate;
1768
1769         let std_future_trait =
1770             db.lang_item(krate, "future_trait".into()).and_then(|it| it.as_trait());
1771         let std_future_trait = match std_future_trait {
1772             Some(it) => it,
1773             None => return false,
1774         };
1775
1776         let canonical_ty =
1777             Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(&Interner) };
1778         method_resolution::implements_trait(
1779             &canonical_ty,
1780             db,
1781             self.env.clone(),
1782             krate,
1783             std_future_trait,
1784         )
1785     }
1786
1787     /// Checks that particular type `ty` implements `std::ops::FnOnce`.
1788     ///
1789     /// This function can be used to check if a particular type is callable, since FnOnce is a
1790     /// supertrait of Fn and FnMut, so all callable types implements at least FnOnce.
1791     pub fn impls_fnonce(&self, db: &dyn HirDatabase) -> bool {
1792         let krate = self.krate;
1793
1794         let fnonce_trait = match FnTrait::FnOnce.get_id(db, krate) {
1795             Some(it) => it,
1796             None => return false,
1797         };
1798
1799         let canonical_ty =
1800             Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(&Interner) };
1801         method_resolution::implements_trait_unique(
1802             &canonical_ty,
1803             db,
1804             self.env.clone(),
1805             krate,
1806             fnonce_trait,
1807         )
1808     }
1809
1810     pub fn impls_trait(&self, db: &dyn HirDatabase, trait_: Trait, args: &[Type]) -> bool {
1811         let trait_ref = TyBuilder::trait_ref(db, trait_.id)
1812             .push(self.ty.clone())
1813             .fill(args.iter().map(|t| t.ty.clone()))
1814             .build();
1815
1816         let goal = Canonical {
1817             value: hir_ty::InEnvironment::new(&self.env.env, trait_ref.cast(&Interner)),
1818             binders: CanonicalVarKinds::empty(&Interner),
1819         };
1820
1821         db.trait_solve(self.krate, goal).is_some()
1822     }
1823
1824     pub fn normalize_trait_assoc_type(
1825         &self,
1826         db: &dyn HirDatabase,
1827         args: &[Type],
1828         alias: TypeAlias,
1829     ) -> Option<Type> {
1830         let projection = TyBuilder::assoc_type_projection(db, alias.id)
1831             .push(self.ty.clone())
1832             .fill(args.iter().map(|t| t.ty.clone()))
1833             .build();
1834         let goal = hir_ty::make_canonical(
1835             InEnvironment::new(
1836                 &self.env.env,
1837                 AliasEq {
1838                     alias: AliasTy::Projection(projection),
1839                     ty: TyKind::BoundVar(BoundVar::new(DebruijnIndex::INNERMOST, 0))
1840                         .intern(&Interner),
1841                 }
1842                 .cast(&Interner),
1843             ),
1844             [TyVariableKind::General].iter().copied(),
1845         );
1846
1847         match db.trait_solve(self.krate, goal)? {
1848             Solution::Unique(s) => s
1849                 .value
1850                 .subst
1851                 .as_slice(&Interner)
1852                 .first()
1853                 .map(|ty| self.derived(ty.assert_ty_ref(&Interner).clone())),
1854             Solution::Ambig(_) => None,
1855         }
1856     }
1857
1858     pub fn is_copy(&self, db: &dyn HirDatabase) -> bool {
1859         let lang_item = db.lang_item(self.krate, SmolStr::new("copy"));
1860         let copy_trait = match lang_item {
1861             Some(LangItemTarget::TraitId(it)) => it,
1862             _ => return false,
1863         };
1864         self.impls_trait(db, copy_trait.into(), &[])
1865     }
1866
1867     pub fn as_callable(&self, db: &dyn HirDatabase) -> Option<Callable> {
1868         let def = self.ty.callable_def(db);
1869
1870         let sig = self.ty.callable_sig(db)?;
1871         Some(Callable { ty: self.clone(), sig, def, is_bound_method: false })
1872     }
1873
1874     pub fn is_closure(&self) -> bool {
1875         matches!(&self.ty.kind(&Interner), TyKind::Closure { .. })
1876     }
1877
1878     pub fn is_fn(&self) -> bool {
1879         matches!(&self.ty.kind(&Interner), TyKind::FnDef(..) | TyKind::Function { .. })
1880     }
1881
1882     pub fn is_packed(&self, db: &dyn HirDatabase) -> bool {
1883         let adt_id = match self.ty.kind(&Interner) {
1884             &TyKind::Adt(hir_ty::AdtId(adt_id), ..) => adt_id,
1885             _ => return false,
1886         };
1887
1888         let adt = adt_id.into();
1889         match adt {
1890             Adt::Struct(s) => matches!(s.repr(db), Some(ReprKind::Packed)),
1891             _ => false,
1892         }
1893     }
1894
1895     pub fn is_raw_ptr(&self) -> bool {
1896         matches!(&self.ty.kind(&Interner), TyKind::Raw(..))
1897     }
1898
1899     pub fn contains_unknown(&self) -> bool {
1900         return go(&self.ty);
1901
1902         fn go(ty: &Ty) -> bool {
1903             match ty.kind(&Interner) {
1904                 TyKind::Error => true,
1905
1906                 TyKind::Adt(_, substs)
1907                 | TyKind::AssociatedType(_, substs)
1908                 | TyKind::Tuple(_, substs)
1909                 | TyKind::OpaqueType(_, substs)
1910                 | TyKind::FnDef(_, substs)
1911                 | TyKind::Closure(_, substs) => {
1912                     substs.iter(&Interner).filter_map(|a| a.ty(&Interner)).any(go)
1913                 }
1914
1915                 TyKind::Array(_ty, len) if len.is_unknown() => true,
1916                 TyKind::Array(ty, _)
1917                 | TyKind::Slice(ty)
1918                 | TyKind::Raw(_, ty)
1919                 | TyKind::Ref(_, _, ty) => go(ty),
1920
1921                 TyKind::Scalar(_)
1922                 | TyKind::Str
1923                 | TyKind::Never
1924                 | TyKind::Placeholder(_)
1925                 | TyKind::BoundVar(_)
1926                 | TyKind::InferenceVar(_, _)
1927                 | TyKind::Dyn(_)
1928                 | TyKind::Function(_)
1929                 | TyKind::Alias(_)
1930                 | TyKind::Foreign(_)
1931                 | TyKind::Generator(..)
1932                 | TyKind::GeneratorWitness(..) => false,
1933             }
1934         }
1935     }
1936
1937     pub fn fields(&self, db: &dyn HirDatabase) -> Vec<(Field, Type)> {
1938         let (variant_id, substs) = match self.ty.kind(&Interner) {
1939             &TyKind::Adt(hir_ty::AdtId(AdtId::StructId(s)), ref substs) => (s.into(), substs),
1940             &TyKind::Adt(hir_ty::AdtId(AdtId::UnionId(u)), ref substs) => (u.into(), substs),
1941             _ => return Vec::new(),
1942         };
1943
1944         db.field_types(variant_id)
1945             .iter()
1946             .map(|(local_id, ty)| {
1947                 let def = Field { parent: variant_id.into(), id: local_id };
1948                 let ty = ty.clone().substitute(&Interner, substs);
1949                 (def, self.derived(ty))
1950             })
1951             .collect()
1952     }
1953
1954     pub fn tuple_fields(&self, _db: &dyn HirDatabase) -> Vec<Type> {
1955         if let TyKind::Tuple(_, substs) = &self.ty.kind(&Interner) {
1956             substs
1957                 .iter(&Interner)
1958                 .map(|ty| self.derived(ty.assert_ty_ref(&Interner).clone()))
1959                 .collect()
1960         } else {
1961             Vec::new()
1962         }
1963     }
1964
1965     pub fn autoderef<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Type> + 'a {
1966         // There should be no inference vars in types passed here
1967         // FIXME check that?
1968         let canonical =
1969             Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(&Interner) };
1970         let environment = self.env.env.clone();
1971         let ty = InEnvironment { goal: canonical, environment };
1972         autoderef(db, Some(self.krate), ty)
1973             .map(|canonical| canonical.value)
1974             .map(move |ty| self.derived(ty))
1975     }
1976
1977     // This would be nicer if it just returned an iterator, but that runs into
1978     // lifetime problems, because we need to borrow temp `CrateImplDefs`.
1979     pub fn iterate_assoc_items<T>(
1980         self,
1981         db: &dyn HirDatabase,
1982         krate: Crate,
1983         mut callback: impl FnMut(AssocItem) -> Option<T>,
1984     ) -> Option<T> {
1985         for krate in def_crates(db, &self.ty, krate.id)? {
1986             let impls = db.inherent_impls_in_crate(krate);
1987
1988             for impl_def in impls.for_self_ty(&self.ty) {
1989                 for &item in db.impl_data(*impl_def).items.iter() {
1990                     if let Some(result) = callback(item.into()) {
1991                         return Some(result);
1992                     }
1993                 }
1994             }
1995         }
1996         None
1997     }
1998
1999     pub fn type_arguments(&self) -> impl Iterator<Item = Type> + '_ {
2000         self.ty
2001             .strip_references()
2002             .as_adt()
2003             .into_iter()
2004             .flat_map(|(_, substs)| substs.iter(&Interner))
2005             .filter_map(|arg| arg.ty(&Interner).cloned())
2006             .map(move |ty| self.derived(ty))
2007     }
2008
2009     pub fn iterate_method_candidates<T>(
2010         &self,
2011         db: &dyn HirDatabase,
2012         krate: Crate,
2013         traits_in_scope: &FxHashSet<TraitId>,
2014         name: Option<&Name>,
2015         mut callback: impl FnMut(&Ty, Function) -> Option<T>,
2016     ) -> Option<T> {
2017         // There should be no inference vars in types passed here
2018         // FIXME check that?
2019         // FIXME replace Unknown by bound vars here
2020         let canonical =
2021             Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(&Interner) };
2022
2023         let env = self.env.clone();
2024         let krate = krate.id;
2025
2026         method_resolution::iterate_method_candidates(
2027             &canonical,
2028             db,
2029             env,
2030             krate,
2031             traits_in_scope,
2032             None,
2033             name,
2034             method_resolution::LookupMode::MethodCall,
2035             |ty, it| match it {
2036                 AssocItemId::FunctionId(f) => callback(ty, f.into()),
2037                 _ => None,
2038             },
2039         )
2040     }
2041
2042     pub fn iterate_path_candidates<T>(
2043         &self,
2044         db: &dyn HirDatabase,
2045         krate: Crate,
2046         traits_in_scope: &FxHashSet<TraitId>,
2047         name: Option<&Name>,
2048         mut callback: impl FnMut(&Ty, AssocItem) -> Option<T>,
2049     ) -> Option<T> {
2050         // There should be no inference vars in types passed here
2051         // FIXME check that?
2052         // FIXME replace Unknown by bound vars here
2053         let canonical =
2054             Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(&Interner) };
2055
2056         let env = self.env.clone();
2057         let krate = krate.id;
2058
2059         method_resolution::iterate_method_candidates(
2060             &canonical,
2061             db,
2062             env,
2063             krate,
2064             traits_in_scope,
2065             None,
2066             name,
2067             method_resolution::LookupMode::Path,
2068             |ty, it| callback(ty, it.into()),
2069         )
2070     }
2071
2072     pub fn as_adt(&self) -> Option<Adt> {
2073         let (adt, _subst) = self.ty.as_adt()?;
2074         Some(adt.into())
2075     }
2076
2077     pub fn as_builtin(&self) -> Option<BuiltinType> {
2078         self.ty.as_builtin().map(|inner| BuiltinType { inner })
2079     }
2080
2081     pub fn as_dyn_trait(&self) -> Option<Trait> {
2082         self.ty.dyn_trait().map(Into::into)
2083     }
2084
2085     /// If a type can be represented as `dyn Trait`, returns all traits accessible via this type,
2086     /// or an empty iterator otherwise.
2087     pub fn applicable_inherent_traits<'a>(
2088         &'a self,
2089         db: &'a dyn HirDatabase,
2090     ) -> impl Iterator<Item = Trait> + 'a {
2091         self.autoderef(db)
2092             .filter_map(|derefed_type| derefed_type.ty.dyn_trait())
2093             .flat_map(move |dyn_trait_id| hir_ty::all_super_traits(db.upcast(), dyn_trait_id))
2094             .map(Trait::from)
2095     }
2096
2097     pub fn as_impl_traits(&self, db: &dyn HirDatabase) -> Option<Vec<Trait>> {
2098         self.ty.impl_trait_bounds(db).map(|it| {
2099             it.into_iter()
2100                 .filter_map(|pred| match pred.skip_binders() {
2101                     hir_ty::WhereClause::Implemented(trait_ref) => {
2102                         Some(Trait::from(trait_ref.hir_trait_id()))
2103                     }
2104                     _ => None,
2105                 })
2106                 .collect()
2107         })
2108     }
2109
2110     pub fn as_associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<Trait> {
2111         self.ty.associated_type_parent_trait(db).map(Into::into)
2112     }
2113
2114     fn derived(&self, ty: Ty) -> Type {
2115         Type { krate: self.krate, env: self.env.clone(), ty }
2116     }
2117
2118     pub fn walk(&self, db: &dyn HirDatabase, mut cb: impl FnMut(Type)) {
2119         // TypeWalk::walk for a Ty at first visits parameters and only after that the Ty itself.
2120         // We need a different order here.
2121
2122         fn walk_substs(
2123             db: &dyn HirDatabase,
2124             type_: &Type,
2125             substs: &Substitution,
2126             cb: &mut impl FnMut(Type),
2127         ) {
2128             for ty in substs.iter(&Interner).filter_map(|a| a.ty(&Interner)) {
2129                 walk_type(db, &type_.derived(ty.clone()), cb);
2130             }
2131         }
2132
2133         fn walk_bounds(
2134             db: &dyn HirDatabase,
2135             type_: &Type,
2136             bounds: &[QuantifiedWhereClause],
2137             cb: &mut impl FnMut(Type),
2138         ) {
2139             for pred in bounds {
2140                 match pred.skip_binders() {
2141                     WhereClause::Implemented(trait_ref) => {
2142                         cb(type_.clone());
2143                         // skip the self type. it's likely the type we just got the bounds from
2144                         for ty in trait_ref
2145                             .substitution
2146                             .iter(&Interner)
2147                             .skip(1)
2148                             .filter_map(|a| a.ty(&Interner))
2149                         {
2150                             walk_type(db, &type_.derived(ty.clone()), cb);
2151                         }
2152                     }
2153                     _ => (),
2154                 }
2155             }
2156         }
2157
2158         fn walk_type(db: &dyn HirDatabase, type_: &Type, cb: &mut impl FnMut(Type)) {
2159             let ty = type_.ty.strip_references();
2160             match ty.kind(&Interner) {
2161                 TyKind::Adt(_, substs) => {
2162                     cb(type_.derived(ty.clone()));
2163                     walk_substs(db, type_, &substs, cb);
2164                 }
2165                 TyKind::AssociatedType(_, substs) => {
2166                     if let Some(_) = ty.associated_type_parent_trait(db) {
2167                         cb(type_.derived(ty.clone()));
2168                     }
2169                     walk_substs(db, type_, &substs, cb);
2170                 }
2171                 TyKind::OpaqueType(_, subst) => {
2172                     if let Some(bounds) = ty.impl_trait_bounds(db) {
2173                         walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2174                     }
2175
2176                     walk_substs(db, type_, subst, cb);
2177                 }
2178                 TyKind::Alias(AliasTy::Opaque(opaque_ty)) => {
2179                     if let Some(bounds) = ty.impl_trait_bounds(db) {
2180                         walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2181                     }
2182
2183                     walk_substs(db, type_, &opaque_ty.substitution, cb);
2184                 }
2185                 TyKind::Placeholder(_) => {
2186                     if let Some(bounds) = ty.impl_trait_bounds(db) {
2187                         walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2188                     }
2189                 }
2190                 TyKind::Dyn(bounds) => {
2191                     walk_bounds(
2192                         db,
2193                         &type_.derived(ty.clone()),
2194                         bounds.bounds.skip_binders().interned(),
2195                         cb,
2196                     );
2197                 }
2198
2199                 TyKind::Ref(_, _, ty)
2200                 | TyKind::Raw(_, ty)
2201                 | TyKind::Array(ty, _)
2202                 | TyKind::Slice(ty) => {
2203                     walk_type(db, &type_.derived(ty.clone()), cb);
2204                 }
2205
2206                 TyKind::FnDef(_, substs)
2207                 | TyKind::Tuple(_, substs)
2208                 | TyKind::Closure(.., substs) => {
2209                     walk_substs(db, type_, &substs, cb);
2210                 }
2211                 TyKind::Function(hir_ty::FnPointer { substitution, .. }) => {
2212                     walk_substs(db, type_, &substitution.0, cb);
2213                 }
2214
2215                 _ => {}
2216             }
2217         }
2218
2219         walk_type(db, self, &mut cb);
2220     }
2221
2222     pub fn could_unify_with(&self, other: &Type) -> bool {
2223         could_unify(&self.ty, &other.ty)
2224     }
2225 }
2226
2227 // FIXME: closures
2228 #[derive(Debug)]
2229 pub struct Callable {
2230     ty: Type,
2231     sig: CallableSig,
2232     def: Option<CallableDefId>,
2233     pub(crate) is_bound_method: bool,
2234 }
2235
2236 pub enum CallableKind {
2237     Function(Function),
2238     TupleStruct(Struct),
2239     TupleEnumVariant(Variant),
2240     Closure,
2241 }
2242
2243 impl Callable {
2244     pub fn kind(&self) -> CallableKind {
2245         match self.def {
2246             Some(CallableDefId::FunctionId(it)) => CallableKind::Function(it.into()),
2247             Some(CallableDefId::StructId(it)) => CallableKind::TupleStruct(it.into()),
2248             Some(CallableDefId::EnumVariantId(it)) => CallableKind::TupleEnumVariant(it.into()),
2249             None => CallableKind::Closure,
2250         }
2251     }
2252     pub fn receiver_param(&self, db: &dyn HirDatabase) -> Option<ast::SelfParam> {
2253         let func = match self.def {
2254             Some(CallableDefId::FunctionId(it)) if self.is_bound_method => it,
2255             _ => return None,
2256         };
2257         let src = func.lookup(db.upcast()).source(db.upcast());
2258         let param_list = src.value.param_list()?;
2259         param_list.self_param()
2260     }
2261     pub fn n_params(&self) -> usize {
2262         self.sig.params().len() - if self.is_bound_method { 1 } else { 0 }
2263     }
2264     pub fn params(
2265         &self,
2266         db: &dyn HirDatabase,
2267     ) -> Vec<(Option<Either<ast::SelfParam, ast::Pat>>, Type)> {
2268         let types = self
2269             .sig
2270             .params()
2271             .iter()
2272             .skip(if self.is_bound_method { 1 } else { 0 })
2273             .map(|ty| self.ty.derived(ty.clone()));
2274         let patterns = match self.def {
2275             Some(CallableDefId::FunctionId(func)) => {
2276                 let src = func.lookup(db.upcast()).source(db.upcast());
2277                 src.value.param_list().map(|param_list| {
2278                     param_list
2279                         .self_param()
2280                         .map(|it| Some(Either::Left(it)))
2281                         .filter(|_| !self.is_bound_method)
2282                         .into_iter()
2283                         .chain(param_list.params().map(|it| it.pat().map(Either::Right)))
2284                 })
2285             }
2286             _ => None,
2287         };
2288         patterns.into_iter().flatten().chain(iter::repeat(None)).zip(types).collect()
2289     }
2290     pub fn return_type(&self) -> Type {
2291         self.ty.derived(self.sig.ret().clone())
2292     }
2293 }
2294
2295 /// For IDE only
2296 #[derive(Debug, PartialEq, Eq, Hash)]
2297 pub enum ScopeDef {
2298     ModuleDef(ModuleDef),
2299     MacroDef(MacroDef),
2300     GenericParam(GenericParam),
2301     ImplSelfType(Impl),
2302     AdtSelfType(Adt),
2303     Local(Local),
2304     Label(Label),
2305     Unknown,
2306 }
2307
2308 impl ScopeDef {
2309     pub fn all_items(def: PerNs) -> ArrayVec<Self, 3> {
2310         let mut items = ArrayVec::new();
2311
2312         match (def.take_types(), def.take_values()) {
2313             (Some(m1), None) => items.push(ScopeDef::ModuleDef(m1.into())),
2314             (None, Some(m2)) => items.push(ScopeDef::ModuleDef(m2.into())),
2315             (Some(m1), Some(m2)) => {
2316                 // Some items, like unit structs and enum variants, are
2317                 // returned as both a type and a value. Here we want
2318                 // to de-duplicate them.
2319                 if m1 != m2 {
2320                     items.push(ScopeDef::ModuleDef(m1.into()));
2321                     items.push(ScopeDef::ModuleDef(m2.into()));
2322                 } else {
2323                     items.push(ScopeDef::ModuleDef(m1.into()));
2324                 }
2325             }
2326             (None, None) => {}
2327         };
2328
2329         if let Some(macro_def_id) = def.take_macros() {
2330             items.push(ScopeDef::MacroDef(macro_def_id.into()));
2331         }
2332
2333         if items.is_empty() {
2334             items.push(ScopeDef::Unknown);
2335         }
2336
2337         items
2338     }
2339 }
2340
2341 impl From<ItemInNs> for ScopeDef {
2342     fn from(item: ItemInNs) -> Self {
2343         match item {
2344             ItemInNs::Types(id) => ScopeDef::ModuleDef(id.into()),
2345             ItemInNs::Values(id) => ScopeDef::ModuleDef(id.into()),
2346             ItemInNs::Macros(id) => ScopeDef::MacroDef(id.into()),
2347         }
2348     }
2349 }
2350
2351 pub trait HasVisibility {
2352     fn visibility(&self, db: &dyn HirDatabase) -> Visibility;
2353     fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool {
2354         let vis = self.visibility(db);
2355         vis.is_visible_from(db.upcast(), module.id)
2356     }
2357 }