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::{collections::HashMap, iter, ops::ControlFlow, sync::Arc};
  35
  36 use arrayvec::ArrayVec;
  37 use base_db::{CrateDisplayName, CrateId, CrateOrigin, Edition, FileId};
  38 use either::Either;
  39 use hir_def::{
  40     adt::{ReprKind, VariantData},
  41     body::{BodyDiagnostic, SyntheticSyntax},
  42     expr::{BindingAnnotation, LabelId, Pat, PatId},
  43     lang_item::LangItemTarget,
  44     nameres,
  45     per_ns::PerNs,
  46     resolver::{HasResolver, Resolver},
  47     AttrDefId, ConstId, ConstParamId, EnumId, FunctionId, GenericDefId, HasModule, LifetimeParamId,
  48     LocalEnumVariantId, LocalFieldId, StaticId, StructId, TypeAliasId, TypeParamId, UnionId,
  49 };
  50 use hir_expand::{name::name, MacroCallKind, MacroDefKind};
  51 use hir_ty::{
  52     autoderef,
  53     consteval::{eval_const, ComputedExpr, ConstEvalCtx, ConstEvalError, ConstExt},
  54     could_unify,
  55     diagnostics::BodyValidationDiagnostic,
  56     method_resolution::{self, TyFingerprint},
  57     primitive::UintTy,
  58     subst_prefix,
  59     traits::FnTrait,
  60     AliasEq, AliasTy, BoundVar, CallableDefId, CallableSig, Canonical, CanonicalVarKinds, Cast,
  61     DebruijnIndex, InEnvironment, Interner, QuantifiedWhereClause, Scalar, Solution, Substitution,
  62     TraitEnvironment, TraitRefExt, Ty, TyBuilder, TyDefId, TyExt, TyKind, TyVariableKind,
  63     WhereClause,
  64 };
  65 use itertools::Itertools;
  66 use nameres::diagnostics::DefDiagnosticKind;
  67 use once_cell::unsync::Lazy;
  68 use rustc_hash::FxHashSet;
  69 use stdx::{format_to, impl_from};
  70 use syntax::{
  71     ast::{self, HasAttrs as _, HasName},
  72     AstNode, AstPtr, SmolStr, SyntaxKind, SyntaxNodePtr,
  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     diagnostics::{
  81         AddReferenceHere, AnyDiagnostic, BreakOutsideOfLoop, InactiveCode, IncorrectCase,
  82         InvalidDeriveTarget, MacroError, MalformedDerive, MismatchedArgCount, MissingFields,
  83         MissingMatchArms, MissingOkOrSomeInTailExpr, MissingUnsafe, NoSuchField,
  84         RemoveThisSemicolon, ReplaceFilterMapNextWithFindMap, UnimplementedBuiltinMacro,
  85         UnresolvedExternCrate, UnresolvedImport, UnresolvedMacroCall, UnresolvedModule,
  86         UnresolvedProcMacro,
  87     },
  88     has_source::HasSource,
  89     semantics::{PathResolution, Semantics, SemanticsScope, TypeInfo},
  90 };
  91
  92 // Be careful with these re-exports.
  93 //
  94 // `hir` is the boundary between the compiler and the IDE. It should try hard to
  95 // isolate the compiler from the ide, to allow the two to be refactored
  96 // independently. Re-exporting something from the compiler is the sure way to
  97 // breach the boundary.
  98 //
  99 // Generally, a refactoring which *removes* a name from this list is a good
 100 // idea!
 101 pub use {
 102     cfg::{CfgAtom, CfgExpr, CfgOptions},
 103     hir_def::{
 104         adt::StructKind,
 105         attr::{Attr, Attrs, AttrsWithOwner, Documentation},
 106         builtin_attr::AttributeTemplate,
 107         find_path::PrefixKind,
 108         import_map,
 109         item_scope::ItemScope,
 110         item_tree::ItemTreeNode,
 111         nameres::{DefMap, ModuleData, ModuleOrigin, ModuleSource},
 112         path::{ModPath, PathKind},
 113         src::HasSource as DefHasSource, // xx: I don't like this shadowing of HasSource... :(
 114         type_ref::{Mutability, TypeRef},
 115         visibility::Visibility,
 116         AdtId,
 117         AssocItemId,
 118         AssocItemLoc,
 119         DefWithBodyId,
 120         ImplId,
 121         ItemContainerId,
 122         ItemLoc,
 123         Lookup,
 124         ModuleDefId,
 125         ModuleId,
 126         TraitId,
 127     },
 128     hir_expand::{
 129         name::{known, Name},
 130         ExpandResult, HirFileId, InFile, MacroDefId, MacroFile, Origin,
 131     },
 132     hir_ty::display::HirDisplay,
 133 };
 134
 135 // These are negative re-exports: pub using these names is forbidden, they
 136 // should remain private to hir internals.
 137 #[allow(unused)]
 138 use {
 139     hir_def::path::Path,
 140     hir_expand::{hygiene::Hygiene, name::AsName},
 141 };
 142
 143 /// hir::Crate describes a single crate. It's the main interface with which
 144 /// a crate's dependencies interact. Mostly, it should be just a proxy for the
 145 /// root module.
 146 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 147 pub struct Crate {
 148     pub(crate) id: CrateId,
 149 }
 150
 151 #[derive(Debug)]
 152 pub struct CrateDependency {
 153     pub krate: Crate,
 154     pub name: Name,
 155 }
 156
 157 impl Crate {
 158     pub fn origin(self, db: &dyn HirDatabase) -> CrateOrigin {
 159         db.crate_graph()[self.id].origin.clone()
 160     }
 161
 162     pub fn dependencies(self, db: &dyn HirDatabase) -> Vec<CrateDependency> {
 163         db.crate_graph()[self.id]
 164             .dependencies
 165             .iter()
 166             .map(|dep| {
 167                 let krate = Crate { id: dep.crate_id };
 168                 let name = dep.as_name();
 169                 CrateDependency { krate, name }
 170             })
 171             .collect()
 172     }
 173
 174     pub fn reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
 175         let crate_graph = db.crate_graph();
 176         crate_graph
 177             .iter()
 178             .filter(|&krate| {
 179                 crate_graph[krate].dependencies.iter().any(|it| it.crate_id == self.id)
 180             })
 181             .map(|id| Crate { id })
 182             .collect()
 183     }
 184
 185     pub fn transitive_reverse_dependencies(self, db: &dyn HirDatabase) -> Vec<Crate> {
 186         db.crate_graph().transitive_rev_deps(self.id).into_iter().map(|id| Crate { id }).collect()
 187     }
 188
 189     pub fn root_module(self, db: &dyn HirDatabase) -> Module {
 190         let def_map = db.crate_def_map(self.id);
 191         Module { id: def_map.module_id(def_map.root()) }
 192     }
 193
 194     pub fn root_file(self, db: &dyn HirDatabase) -> FileId {
 195         db.crate_graph()[self.id].root_file_id
 196     }
 197
 198     pub fn edition(self, db: &dyn HirDatabase) -> Edition {
 199         db.crate_graph()[self.id].edition
 200     }
 201
 202     pub fn version(self, db: &dyn HirDatabase) -> Option<String> {
 203         db.crate_graph()[self.id].version.clone()
 204     }
 205
 206     pub fn display_name(self, db: &dyn HirDatabase) -> Option<CrateDisplayName> {
 207         db.crate_graph()[self.id].display_name.clone()
 208     }
 209
 210     pub fn query_external_importables(
 211         self,
 212         db: &dyn DefDatabase,
 213         query: import_map::Query,
 214     ) -> impl Iterator<Item = Either<ModuleDef, MacroDef>> {
 215         let _p = profile::span("query_external_importables");
 216         import_map::search_dependencies(db, self.into(), query).into_iter().map(|item| {
 217             match ItemInNs::from(item) {
 218                 ItemInNs::Types(mod_id) | ItemInNs::Values(mod_id) => Either::Left(mod_id),
 219                 ItemInNs::Macros(mac_id) => Either::Right(mac_id),
 220             }
 221         })
 222     }
 223
 224     pub fn all(db: &dyn HirDatabase) -> Vec<Crate> {
 225         db.crate_graph().iter().map(|id| Crate { id }).collect()
 226     }
 227
 228     /// Try to get the root URL of the documentation of a crate.
 229     pub fn get_html_root_url(self: &Crate, db: &dyn HirDatabase) -> Option<String> {
 230         // Look for #![doc(html_root_url = "...")]
 231         let attrs = db.attrs(AttrDefId::ModuleId(self.root_module(db).into()));
 232         let doc_attr_q = attrs.by_key("doc");
 233
 234         if !doc_attr_q.exists() {
 235             return None;
 236         }
 237
 238         let doc_url = doc_attr_q.tt_values().map(|tt| {
 239             let name = tt.token_trees.iter()
 240                 .skip_while(|tt| !matches!(tt, TokenTree::Leaf(Leaf::Ident(Ident { text, ..} )) if text == "html_root_url"))
 241                 .nth(2);
 242
 243             match name {
 244                 Some(TokenTree::Leaf(Leaf::Literal(Literal{ref text, ..}))) => Some(text),
 245                 _ => None
 246             }
 247         }).flatten().next();
 248
 249         doc_url.map(|s| s.trim_matches('"').trim_end_matches('/').to_owned() + "/")
 250     }
 251
 252     pub fn cfg(&self, db: &dyn HirDatabase) -> CfgOptions {
 253         db.crate_graph()[self.id].cfg_options.clone()
 254     }
 255
 256     pub fn potential_cfg(&self, db: &dyn HirDatabase) -> CfgOptions {
 257         db.crate_graph()[self.id].potential_cfg_options.clone()
 258     }
 259 }
 260
 261 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 262 pub struct Module {
 263     pub(crate) id: ModuleId,
 264 }
 265
 266 /// The defs which can be visible in the module.
 267 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 268 pub enum ModuleDef {
 269     Module(Module),
 270     Function(Function),
 271     Adt(Adt),
 272     // Can't be directly declared, but can be imported.
 273     Variant(Variant),
 274     Const(Const),
 275     Static(Static),
 276     Trait(Trait),
 277     TypeAlias(TypeAlias),
 278     BuiltinType(BuiltinType),
 279 }
 280 impl_from!(
 281     Module,
 282     Function,
 283     Adt(Struct, Enum, Union),
 284     Variant,
 285     Const,
 286     Static,
 287     Trait,
 288     TypeAlias,
 289     BuiltinType
 290     for ModuleDef
 291 );
 292
 293 impl From<VariantDef> for ModuleDef {
 294     fn from(var: VariantDef) -> Self {
 295         match var {
 296             VariantDef::Struct(t) => Adt::from(t).into(),
 297             VariantDef::Union(t) => Adt::from(t).into(),
 298             VariantDef::Variant(t) => t.into(),
 299         }
 300     }
 301 }
 302
 303 impl ModuleDef {
 304     pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
 305         match self {
 306             ModuleDef::Module(it) => it.parent(db),
 307             ModuleDef::Function(it) => Some(it.module(db)),
 308             ModuleDef::Adt(it) => Some(it.module(db)),
 309             ModuleDef::Variant(it) => Some(it.module(db)),
 310             ModuleDef::Const(it) => Some(it.module(db)),
 311             ModuleDef::Static(it) => Some(it.module(db)),
 312             ModuleDef::Trait(it) => Some(it.module(db)),
 313             ModuleDef::TypeAlias(it) => Some(it.module(db)),
 314             ModuleDef::BuiltinType(_) => None,
 315         }
 316     }
 317
 318     pub fn canonical_path(&self, db: &dyn HirDatabase) -> Option<String> {
 319         let mut segments = vec![self.name(db)?];
 320         for m in self.module(db)?.path_to_root(db) {
 321             segments.extend(m.name(db))
 322         }
 323         segments.reverse();
 324         Some(segments.into_iter().join("::"))
 325     }
 326
 327     pub fn canonical_module_path(
 328         &self,
 329         db: &dyn HirDatabase,
 330     ) -> Option<impl Iterator<Item = Module>> {
 331         self.module(db).map(|it| it.path_to_root(db).into_iter().rev())
 332     }
 333
 334     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
 335         let name = match self {
 336             ModuleDef::Module(it) => it.name(db)?,
 337             ModuleDef::Const(it) => it.name(db)?,
 338             ModuleDef::Adt(it) => it.name(db),
 339             ModuleDef::Trait(it) => it.name(db),
 340             ModuleDef::Function(it) => it.name(db),
 341             ModuleDef::Variant(it) => it.name(db),
 342             ModuleDef::TypeAlias(it) => it.name(db),
 343             ModuleDef::Static(it) => it.name(db),
 344             ModuleDef::BuiltinType(it) => it.name(),
 345         };
 346         Some(name)
 347     }
 348
 349     pub fn diagnostics(self, db: &dyn HirDatabase) -> Vec<AnyDiagnostic> {
 350         let id = match self {
 351             ModuleDef::Adt(it) => match it {
 352                 Adt::Struct(it) => it.id.into(),
 353                 Adt::Enum(it) => it.id.into(),
 354                 Adt::Union(it) => it.id.into(),
 355             },
 356             ModuleDef::Trait(it) => it.id.into(),
 357             ModuleDef::Function(it) => it.id.into(),
 358             ModuleDef::TypeAlias(it) => it.id.into(),
 359             ModuleDef::Module(it) => it.id.into(),
 360             ModuleDef::Const(it) => it.id.into(),
 361             ModuleDef::Static(it) => it.id.into(),
 362             _ => return Vec::new(),
 363         };
 364
 365         let module = match self.module(db) {
 366             Some(it) => it,
 367             None => return Vec::new(),
 368         };
 369
 370         let mut acc = Vec::new();
 371
 372         match self.as_def_with_body() {
 373             Some(def) => {
 374                 def.diagnostics(db, &mut acc);
 375             }
 376             None => {
 377                 for diag in hir_ty::diagnostics::incorrect_case(db, module.id.krate(), id) {
 378                     acc.push(diag.into())
 379                 }
 380             }
 381         }
 382
 383         acc
 384     }
 385
 386     pub fn as_def_with_body(self) -> Option<DefWithBody> {
 387         match self {
 388             ModuleDef::Function(it) => Some(it.into()),
 389             ModuleDef::Const(it) => Some(it.into()),
 390             ModuleDef::Static(it) => Some(it.into()),
 391
 392             ModuleDef::Module(_)
 393             | ModuleDef::Adt(_)
 394             | ModuleDef::Variant(_)
 395             | ModuleDef::Trait(_)
 396             | ModuleDef::TypeAlias(_)
 397             | ModuleDef::BuiltinType(_) => None,
 398         }
 399     }
 400
 401     pub fn attrs(&self, db: &dyn HirDatabase) -> Option<AttrsWithOwner> {
 402         Some(match self {
 403             ModuleDef::Module(it) => it.attrs(db),
 404             ModuleDef::Function(it) => it.attrs(db),
 405             ModuleDef::Adt(it) => it.attrs(db),
 406             ModuleDef::Variant(it) => it.attrs(db),
 407             ModuleDef::Const(it) => it.attrs(db),
 408             ModuleDef::Static(it) => it.attrs(db),
 409             ModuleDef::Trait(it) => it.attrs(db),
 410             ModuleDef::TypeAlias(it) => it.attrs(db),
 411             ModuleDef::BuiltinType(_) => return None,
 412         })
 413     }
 414 }
 415
 416 impl HasVisibility for ModuleDef {
 417     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 418         match *self {
 419             ModuleDef::Module(it) => it.visibility(db),
 420             ModuleDef::Function(it) => it.visibility(db),
 421             ModuleDef::Adt(it) => it.visibility(db),
 422             ModuleDef::Const(it) => it.visibility(db),
 423             ModuleDef::Static(it) => it.visibility(db),
 424             ModuleDef::Trait(it) => it.visibility(db),
 425             ModuleDef::TypeAlias(it) => it.visibility(db),
 426             ModuleDef::Variant(it) => it.visibility(db),
 427             ModuleDef::BuiltinType(_) => Visibility::Public,
 428         }
 429     }
 430 }
 431
 432 impl Module {
 433     /// Name of this module.
 434     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
 435         let def_map = self.id.def_map(db.upcast());
 436         let parent = def_map[self.id.local_id].parent?;
 437         def_map[parent].children.iter().find_map(|(name, module_id)| {
 438             if *module_id == self.id.local_id {
 439                 Some(name.clone())
 440             } else {
 441                 None
 442             }
 443         })
 444     }
 445
 446     /// Returns the crate this module is part of.
 447     pub fn krate(self) -> Crate {
 448         Crate { id: self.id.krate() }
 449     }
 450
 451     /// Topmost parent of this module. Every module has a `crate_root`, but some
 452     /// might be missing `krate`. This can happen if a module's file is not included
 453     /// in the module tree of any target in `Cargo.toml`.
 454     pub fn crate_root(self, db: &dyn HirDatabase) -> Module {
 455         let def_map = db.crate_def_map(self.id.krate());
 456         Module { id: def_map.module_id(def_map.root()) }
 457     }
 458
 459     /// Iterates over all child modules.
 460     pub fn children(self, db: &dyn HirDatabase) -> impl Iterator<Item = Module> {
 461         let def_map = self.id.def_map(db.upcast());
 462         let children = def_map[self.id.local_id]
 463             .children
 464             .iter()
 465             .map(|(_, module_id)| Module { id: def_map.module_id(*module_id) })
 466             .collect::<Vec<_>>();
 467         children.into_iter()
 468     }
 469
 470     /// Finds a parent module.
 471     pub fn parent(self, db: &dyn HirDatabase) -> Option<Module> {
 472         // FIXME: handle block expressions as modules (their parent is in a different DefMap)
 473         let def_map = self.id.def_map(db.upcast());
 474         let parent_id = def_map[self.id.local_id].parent?;
 475         Some(Module { id: def_map.module_id(parent_id) })
 476     }
 477
 478     pub fn path_to_root(self, db: &dyn HirDatabase) -> Vec<Module> {
 479         let mut res = vec![self];
 480         let mut curr = self;
 481         while let Some(next) = curr.parent(db) {
 482             res.push(next);
 483             curr = next
 484         }
 485         res
 486     }
 487
 488     /// Returns a `ModuleScope`: a set of items, visible in this module.
 489     pub fn scope(
 490         self,
 491         db: &dyn HirDatabase,
 492         visible_from: Option<Module>,
 493     ) -> Vec<(Name, ScopeDef)> {
 494         self.id.def_map(db.upcast())[self.id.local_id]
 495             .scope
 496             .entries()
 497             .filter_map(|(name, def)| {
 498                 if let Some(m) = visible_from {
 499                     let filtered =
 500                         def.filter_visibility(|vis| vis.is_visible_from(db.upcast(), m.id));
 501                     if filtered.is_none() && !def.is_none() {
 502                         None
 503                     } else {
 504                         Some((name, filtered))
 505                     }
 506                 } else {
 507                     Some((name, def))
 508                 }
 509             })
 510             .flat_map(|(name, def)| {
 511                 ScopeDef::all_items(def).into_iter().map(move |item| (name.clone(), item))
 512             })
 513             .collect()
 514     }
 515
 516     pub fn diagnostics(self, db: &dyn HirDatabase, acc: &mut Vec<AnyDiagnostic>) {
 517         let _p = profile::span("Module::diagnostics").detail(|| {
 518             format!("{:?}", self.name(db).map_or("<unknown>".into(), |name| name.to_string()))
 519         });
 520         let def_map = self.id.def_map(db.upcast());
 521         for diag in def_map.diagnostics() {
 522             if diag.in_module != self.id.local_id {
 523                 // FIXME: This is accidentally quadratic.
 524                 continue;
 525             }
 526             match &diag.kind {
 527                 DefDiagnosticKind::UnresolvedModule { ast: declaration, candidate } => {
 528                     let decl = declaration.to_node(db.upcast());
 529                     acc.push(
 530                         UnresolvedModule {
 531                             decl: InFile::new(declaration.file_id, AstPtr::new(&decl)),
 532                             candidate: candidate.clone(),
 533                         }
 534                         .into(),
 535                     )
 536                 }
 537                 DefDiagnosticKind::UnresolvedExternCrate { ast } => {
 538                     let item = ast.to_node(db.upcast());
 539                     acc.push(
 540                         UnresolvedExternCrate {
 541                             decl: InFile::new(ast.file_id, AstPtr::new(&item)),
 542                         }
 543                         .into(),
 544                     );
 545                 }
 546
 547                 DefDiagnosticKind::UnresolvedImport { id, index } => {
 548                     let file_id = id.file_id();
 549                     let item_tree = id.item_tree(db.upcast());
 550                     let import = &item_tree[id.value];
 551
 552                     let use_tree = import.use_tree_to_ast(db.upcast(), file_id, *index);
 553                     acc.push(
 554                         UnresolvedImport { decl: InFile::new(file_id, AstPtr::new(&use_tree)) }
 555                             .into(),
 556                     );
 557                 }
 558
 559                 DefDiagnosticKind::UnconfiguredCode { ast, cfg, opts } => {
 560                     let item = ast.to_node(db.upcast());
 561                     acc.push(
 562                         InactiveCode {
 563                             node: ast.with_value(AstPtr::new(&item).into()),
 564                             cfg: cfg.clone(),
 565                             opts: opts.clone(),
 566                         }
 567                         .into(),
 568                     );
 569                 }
 570
 571                 DefDiagnosticKind::UnresolvedProcMacro { ast } => {
 572                     let mut precise_location = None;
 573                     let (node, name) = match ast {
 574                         MacroCallKind::FnLike { ast_id, .. } => {
 575                             let node = ast_id.to_node(db.upcast());
 576                             (ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node))), None)
 577                         }
 578                         MacroCallKind::Derive { ast_id, derive_name, .. } => {
 579                             let node = ast_id.to_node(db.upcast());
 580
 581                             // Compute the precise location of the macro name's token in the derive
 582                             // list.
 583                             // FIXME: This does not handle paths to the macro, but neither does the
 584                             // rest of r-a.
 585                             let derive_attrs =
 586                                 node.attrs().filter_map(|attr| match attr.as_simple_call() {
 587                                     Some((name, args)) if name == "derive" => Some(args),
 588                                     _ => None,
 589                                 });
 590                             'outer: for attr in derive_attrs {
 591                                 let tokens =
 592                                     attr.syntax().children_with_tokens().filter_map(|elem| {
 593                                         match elem {
 594                                             syntax::NodeOrToken::Node(_) => None,
 595                                             syntax::NodeOrToken::Token(tok) => Some(tok),
 596                                         }
 597                                     });
 598                                 for token in tokens {
 599                                     if token.kind() == SyntaxKind::IDENT
 600                                         && token.text() == &**derive_name
 601                                     {
 602                                         precise_location = Some(token.text_range());
 603                                         break 'outer;
 604                                     }
 605                                 }
 606                             }
 607
 608                             (
 609                                 ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node))),
 610                                 Some(derive_name.clone()),
 611                             )
 612                         }
 613                         MacroCallKind::Attr { ast_id, invoc_attr_index, attr_name, .. } => {
 614                             let node = ast_id.to_node(db.upcast());
 615                             let attr =
 616                                 node.attrs().nth((*invoc_attr_index) as usize).unwrap_or_else(
 617                                     || panic!("cannot find attribute #{}", invoc_attr_index),
 618                                 );
 619                             (
 620                                 ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&attr))),
 621                                 Some(attr_name.clone()),
 622                             )
 623                         }
 624                     };
 625                     acc.push(
 626                         UnresolvedProcMacro {
 627                             node,
 628                             precise_location,
 629                             macro_name: name.map(Into::into),
 630                         }
 631                         .into(),
 632                     );
 633                 }
 634
 635                 DefDiagnosticKind::UnresolvedMacroCall { ast, path } => {
 636                     let node = ast.to_node(db.upcast());
 637                     acc.push(
 638                         UnresolvedMacroCall {
 639                             macro_call: InFile::new(ast.file_id, AstPtr::new(&node)),
 640                             path: path.clone(),
 641                         }
 642                         .into(),
 643                     );
 644                 }
 645
 646                 DefDiagnosticKind::MacroError { ast, message } => {
 647                     let node = match ast {
 648                         MacroCallKind::FnLike { ast_id, .. } => {
 649                             let node = ast_id.to_node(db.upcast());
 650                             ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node)))
 651                         }
 652                         MacroCallKind::Derive { ast_id, .. }
 653                         | MacroCallKind::Attr { ast_id, .. } => {
 654                             // FIXME: point to the attribute instead, this creates very large diagnostics
 655                             let node = ast_id.to_node(db.upcast());
 656                             ast_id.with_value(SyntaxNodePtr::from(AstPtr::new(&node)))
 657                         }
 658                     };
 659                     acc.push(MacroError { node, message: message.clone() }.into());
 660                 }
 661
 662                 DefDiagnosticKind::UnimplementedBuiltinMacro { ast } => {
 663                     let node = ast.to_node(db.upcast());
 664                     // Must have a name, otherwise we wouldn't emit it.
 665                     let name = node.name().expect("unimplemented builtin macro with no name");
 666                     acc.push(
 667                         UnimplementedBuiltinMacro {
 668                             node: ast.with_value(SyntaxNodePtr::from(AstPtr::new(&name))),
 669                         }
 670                         .into(),
 671                     );
 672                 }
 673                 DefDiagnosticKind::InvalidDeriveTarget { ast, id } => {
 674                     let node = ast.to_node(db.upcast());
 675                     let derive = node.attrs().nth(*id as usize);
 676                     match derive {
 677                         Some(derive) => {
 678                             acc.push(
 679                                 InvalidDeriveTarget {
 680                                     node: ast.with_value(SyntaxNodePtr::from(AstPtr::new(&derive))),
 681                                 }
 682                                 .into(),
 683                             );
 684                         }
 685                         None => stdx::never!("derive diagnostic on item without derive attribute"),
 686                     }
 687                 }
 688                 DefDiagnosticKind::MalformedDerive { ast, id } => {
 689                     let node = ast.to_node(db.upcast());
 690                     let derive = node.attrs().nth(*id as usize);
 691                     match derive {
 692                         Some(derive) => {
 693                             acc.push(
 694                                 MalformedDerive {
 695                                     node: ast.with_value(SyntaxNodePtr::from(AstPtr::new(&derive))),
 696                                 }
 697                                 .into(),
 698                             );
 699                         }
 700                         None => stdx::never!("derive diagnostic on item without derive attribute"),
 701                     }
 702                 }
 703             }
 704         }
 705         for decl in self.declarations(db) {
 706             match decl {
 707                 ModuleDef::Module(m) => {
 708                     // Only add diagnostics from inline modules
 709                     if def_map[m.id.local_id].origin.is_inline() {
 710                         m.diagnostics(db, acc)
 711                     }
 712                 }
 713                 _ => acc.extend(decl.diagnostics(db)),
 714             }
 715         }
 716
 717         for impl_def in self.impl_defs(db) {
 718             for item in impl_def.items(db) {
 719                 let def: DefWithBody = match item {
 720                     AssocItem::Function(it) => it.into(),
 721                     AssocItem::Const(it) => it.into(),
 722                     AssocItem::TypeAlias(_) => continue,
 723                 };
 724
 725                 def.diagnostics(db, acc);
 726             }
 727         }
 728     }
 729
 730     pub fn declarations(self, db: &dyn HirDatabase) -> Vec<ModuleDef> {
 731         let def_map = self.id.def_map(db.upcast());
 732         let scope = &def_map[self.id.local_id].scope;
 733         scope
 734             .declarations()
 735             .map(ModuleDef::from)
 736             .chain(scope.unnamed_consts().map(|id| ModuleDef::Const(Const::from(id))))
 737             .collect()
 738     }
 739
 740     pub fn impl_defs(self, db: &dyn HirDatabase) -> Vec<Impl> {
 741         let def_map = self.id.def_map(db.upcast());
 742         def_map[self.id.local_id].scope.impls().map(Impl::from).collect()
 743     }
 744
 745     /// Finds a path that can be used to refer to the given item from within
 746     /// this module, if possible.
 747     pub fn find_use_path(self, db: &dyn DefDatabase, item: impl Into<ItemInNs>) -> Option<ModPath> {
 748         hir_def::find_path::find_path(db, item.into().into(), self.into())
 749     }
 750
 751     /// Finds a path that can be used to refer to the given item from within
 752     /// this module, if possible. This is used for returning import paths for use-statements.
 753     pub fn find_use_path_prefixed(
 754         self,
 755         db: &dyn DefDatabase,
 756         item: impl Into<ItemInNs>,
 757         prefix_kind: PrefixKind,
 758     ) -> Option<ModPath> {
 759         hir_def::find_path::find_path_prefixed(db, item.into().into(), self.into(), prefix_kind)
 760     }
 761 }
 762
 763 impl HasVisibility for Module {
 764     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 765         let def_map = self.id.def_map(db.upcast());
 766         let module_data = &def_map[self.id.local_id];
 767         module_data.visibility
 768     }
 769 }
 770
 771 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 772 pub struct Field {
 773     pub(crate) parent: VariantDef,
 774     pub(crate) id: LocalFieldId,
 775 }
 776
 777 #[derive(Debug, PartialEq, Eq)]
 778 pub enum FieldSource {
 779     Named(ast::RecordField),
 780     Pos(ast::TupleField),
 781 }
 782
 783 impl Field {
 784     pub fn name(&self, db: &dyn HirDatabase) -> Name {
 785         self.parent.variant_data(db).fields()[self.id].name.clone()
 786     }
 787
 788     /// Returns the type as in the signature of the struct (i.e., with
 789     /// placeholder types for type parameters). Only use this in the context of
 790     /// the field definition.
 791     pub fn ty(&self, db: &dyn HirDatabase) -> Type {
 792         let var_id = self.parent.into();
 793         let generic_def_id: GenericDefId = match self.parent {
 794             VariantDef::Struct(it) => it.id.into(),
 795             VariantDef::Union(it) => it.id.into(),
 796             VariantDef::Variant(it) => it.parent.id.into(),
 797         };
 798         let substs = TyBuilder::type_params_subst(db, generic_def_id);
 799         let ty = db.field_types(var_id)[self.id].clone().substitute(Interner, &substs);
 800         Type::new(db, self.parent.module(db).id.krate(), var_id, ty)
 801     }
 802
 803     pub fn parent_def(&self, _db: &dyn HirDatabase) -> VariantDef {
 804         self.parent
 805     }
 806 }
 807
 808 impl HasVisibility for Field {
 809     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 810         let variant_data = self.parent.variant_data(db);
 811         let visibility = &variant_data.fields()[self.id].visibility;
 812         let parent_id: hir_def::VariantId = self.parent.into();
 813         visibility.resolve(db.upcast(), &parent_id.resolver(db.upcast()))
 814     }
 815 }
 816
 817 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 818 pub struct Struct {
 819     pub(crate) id: StructId,
 820 }
 821
 822 impl Struct {
 823     pub fn module(self, db: &dyn HirDatabase) -> Module {
 824         Module { id: self.id.lookup(db.upcast()).container }
 825     }
 826
 827     pub fn name(self, db: &dyn HirDatabase) -> Name {
 828         db.struct_data(self.id).name.clone()
 829     }
 830
 831     pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
 832         db.struct_data(self.id)
 833             .variant_data
 834             .fields()
 835             .iter()
 836             .map(|(id, _)| Field { parent: self.into(), id })
 837             .collect()
 838     }
 839
 840     pub fn ty(self, db: &dyn HirDatabase) -> Type {
 841         Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
 842     }
 843
 844     pub fn repr(self, db: &dyn HirDatabase) -> Option<ReprKind> {
 845         db.struct_data(self.id).repr.clone()
 846     }
 847
 848     pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
 849         self.variant_data(db).kind()
 850     }
 851
 852     fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
 853         db.struct_data(self.id).variant_data.clone()
 854     }
 855 }
 856
 857 impl HasVisibility for Struct {
 858     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 859         db.struct_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
 860     }
 861 }
 862
 863 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 864 pub struct Union {
 865     pub(crate) id: UnionId,
 866 }
 867
 868 impl Union {
 869     pub fn name(self, db: &dyn HirDatabase) -> Name {
 870         db.union_data(self.id).name.clone()
 871     }
 872
 873     pub fn module(self, db: &dyn HirDatabase) -> Module {
 874         Module { id: self.id.lookup(db.upcast()).container }
 875     }
 876
 877     pub fn ty(self, db: &dyn HirDatabase) -> Type {
 878         Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
 879     }
 880
 881     pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
 882         db.union_data(self.id)
 883             .variant_data
 884             .fields()
 885             .iter()
 886             .map(|(id, _)| Field { parent: self.into(), id })
 887             .collect()
 888     }
 889
 890     fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
 891         db.union_data(self.id).variant_data.clone()
 892     }
 893 }
 894
 895 impl HasVisibility for Union {
 896     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 897         db.union_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
 898     }
 899 }
 900
 901 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 902 pub struct Enum {
 903     pub(crate) id: EnumId,
 904 }
 905
 906 impl Enum {
 907     pub fn module(self, db: &dyn HirDatabase) -> Module {
 908         Module { id: self.id.lookup(db.upcast()).container }
 909     }
 910
 911     pub fn name(self, db: &dyn HirDatabase) -> Name {
 912         db.enum_data(self.id).name.clone()
 913     }
 914
 915     pub fn variants(self, db: &dyn HirDatabase) -> Vec<Variant> {
 916         db.enum_data(self.id).variants.iter().map(|(id, _)| Variant { parent: self, id }).collect()
 917     }
 918
 919     pub fn ty(self, db: &dyn HirDatabase) -> Type {
 920         Type::from_def(db, self.id.lookup(db.upcast()).container.krate(), self.id)
 921     }
 922 }
 923
 924 impl HasVisibility for Enum {
 925     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 926         db.enum_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
 927     }
 928 }
 929
 930 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 931 pub struct Variant {
 932     pub(crate) parent: Enum,
 933     pub(crate) id: LocalEnumVariantId,
 934 }
 935
 936 impl Variant {
 937     pub fn module(self, db: &dyn HirDatabase) -> Module {
 938         self.parent.module(db)
 939     }
 940
 941     pub fn parent_enum(self, _db: &dyn HirDatabase) -> Enum {
 942         self.parent
 943     }
 944
 945     pub fn name(self, db: &dyn HirDatabase) -> Name {
 946         db.enum_data(self.parent.id).variants[self.id].name.clone()
 947     }
 948
 949     pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
 950         self.variant_data(db)
 951             .fields()
 952             .iter()
 953             .map(|(id, _)| Field { parent: self.into(), id })
 954             .collect()
 955     }
 956
 957     pub fn kind(self, db: &dyn HirDatabase) -> StructKind {
 958         self.variant_data(db).kind()
 959     }
 960
 961     pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
 962         db.enum_data(self.parent.id).variants[self.id].variant_data.clone()
 963     }
 964 }
 965
 966 /// Variants inherit visibility from the parent enum.
 967 impl HasVisibility for Variant {
 968     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
 969         self.parent_enum(db).visibility(db)
 970     }
 971 }
 972
 973 /// A Data Type
 974 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 975 pub enum Adt {
 976     Struct(Struct),
 977     Union(Union),
 978     Enum(Enum),
 979 }
 980 impl_from!(Struct, Union, Enum for Adt);
 981
 982 impl Adt {
 983     pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
 984         let subst = db.generic_defaults(self.into());
 985         subst.iter().any(|ty| ty.skip_binders().is_unknown())
 986     }
 987
 988     /// Turns this ADT into a type. Any type parameters of the ADT will be
 989     /// turned into unknown types, which is good for e.g. finding the most
 990     /// general set of completions, but will not look very nice when printed.
 991     pub fn ty(self, db: &dyn HirDatabase) -> Type {
 992         let id = AdtId::from(self);
 993         Type::from_def(db, id.module(db.upcast()).krate(), id)
 994     }
 995
 996     pub fn module(self, db: &dyn HirDatabase) -> Module {
 997         match self {
 998             Adt::Struct(s) => s.module(db),
 999             Adt::Union(s) => s.module(db),
1000             Adt::Enum(e) => e.module(db),
1001         }
1002     }
1003
1004     pub fn name(self, db: &dyn HirDatabase) -> Name {
1005         match self {
1006             Adt::Struct(s) => s.name(db),
1007             Adt::Union(u) => u.name(db),
1008             Adt::Enum(e) => e.name(db),
1009         }
1010     }
1011 }
1012
1013 impl HasVisibility for Adt {
1014     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1015         match self {
1016             Adt::Struct(it) => it.visibility(db),
1017             Adt::Union(it) => it.visibility(db),
1018             Adt::Enum(it) => it.visibility(db),
1019         }
1020     }
1021 }
1022
1023 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1024 pub enum VariantDef {
1025     Struct(Struct),
1026     Union(Union),
1027     Variant(Variant),
1028 }
1029 impl_from!(Struct, Union, Variant for VariantDef);
1030
1031 impl VariantDef {
1032     pub fn fields(self, db: &dyn HirDatabase) -> Vec<Field> {
1033         match self {
1034             VariantDef::Struct(it) => it.fields(db),
1035             VariantDef::Union(it) => it.fields(db),
1036             VariantDef::Variant(it) => it.fields(db),
1037         }
1038     }
1039
1040     pub fn module(self, db: &dyn HirDatabase) -> Module {
1041         match self {
1042             VariantDef::Struct(it) => it.module(db),
1043             VariantDef::Union(it) => it.module(db),
1044             VariantDef::Variant(it) => it.module(db),
1045         }
1046     }
1047
1048     pub fn name(&self, db: &dyn HirDatabase) -> Name {
1049         match self {
1050             VariantDef::Struct(s) => s.name(db),
1051             VariantDef::Union(u) => u.name(db),
1052             VariantDef::Variant(e) => e.name(db),
1053         }
1054     }
1055
1056     pub(crate) fn variant_data(self, db: &dyn HirDatabase) -> Arc<VariantData> {
1057         match self {
1058             VariantDef::Struct(it) => it.variant_data(db),
1059             VariantDef::Union(it) => it.variant_data(db),
1060             VariantDef::Variant(it) => it.variant_data(db),
1061         }
1062     }
1063 }
1064
1065 /// The defs which have a body.
1066 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1067 pub enum DefWithBody {
1068     Function(Function),
1069     Static(Static),
1070     Const(Const),
1071 }
1072 impl_from!(Function, Const, Static for DefWithBody);
1073
1074 impl DefWithBody {
1075     pub fn module(self, db: &dyn HirDatabase) -> Module {
1076         match self {
1077             DefWithBody::Const(c) => c.module(db),
1078             DefWithBody::Function(f) => f.module(db),
1079             DefWithBody::Static(s) => s.module(db),
1080         }
1081     }
1082
1083     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1084         match self {
1085             DefWithBody::Function(f) => Some(f.name(db)),
1086             DefWithBody::Static(s) => Some(s.name(db)),
1087             DefWithBody::Const(c) => c.name(db),
1088         }
1089     }
1090
1091     /// Returns the type this def's body has to evaluate to.
1092     pub fn body_type(self, db: &dyn HirDatabase) -> Type {
1093         match self {
1094             DefWithBody::Function(it) => it.ret_type(db),
1095             DefWithBody::Static(it) => it.ty(db),
1096             DefWithBody::Const(it) => it.ty(db),
1097         }
1098     }
1099
1100     pub fn diagnostics(self, db: &dyn HirDatabase, acc: &mut Vec<AnyDiagnostic>) {
1101         let krate = self.module(db).id.krate();
1102
1103         let source_map = db.body_with_source_map(self.into()).1;
1104         for diag in source_map.diagnostics() {
1105             match diag {
1106                 BodyDiagnostic::InactiveCode { node, cfg, opts } => acc.push(
1107                     InactiveCode { node: node.clone(), cfg: cfg.clone(), opts: opts.clone() }
1108                         .into(),
1109                 ),
1110                 BodyDiagnostic::MacroError { node, message } => acc.push(
1111                     MacroError {
1112                         node: node.clone().map(|it| it.into()),
1113                         message: message.to_string(),
1114                     }
1115                     .into(),
1116                 ),
1117                 BodyDiagnostic::UnresolvedProcMacro { node } => acc.push(
1118                     UnresolvedProcMacro {
1119                         node: node.clone().map(|it| it.into()),
1120                         precise_location: None,
1121                         macro_name: None,
1122                     }
1123                     .into(),
1124                 ),
1125                 BodyDiagnostic::UnresolvedMacroCall { node, path } => acc.push(
1126                     UnresolvedMacroCall { macro_call: node.clone(), path: path.clone() }.into(),
1127                 ),
1128             }
1129         }
1130
1131         let infer = db.infer(self.into());
1132         let source_map = Lazy::new(|| db.body_with_source_map(self.into()).1);
1133         for d in &infer.diagnostics {
1134             match d {
1135                 hir_ty::InferenceDiagnostic::NoSuchField { expr } => {
1136                     let field = source_map.field_syntax(*expr);
1137                     acc.push(NoSuchField { field }.into())
1138                 }
1139                 hir_ty::InferenceDiagnostic::BreakOutsideOfLoop { expr } => {
1140                     let expr = source_map
1141                         .expr_syntax(*expr)
1142                         .expect("break outside of loop in synthetic syntax");
1143                     acc.push(BreakOutsideOfLoop { expr }.into())
1144                 }
1145             }
1146         }
1147
1148         for expr in hir_ty::diagnostics::missing_unsafe(db, self.into()) {
1149             match source_map.expr_syntax(expr) {
1150                 Ok(expr) => acc.push(MissingUnsafe { expr }.into()),
1151                 Err(SyntheticSyntax) => {
1152                     // FIXME: Here and eslwhere in this file, the `expr` was
1153                     // desugared, report or assert that this doesn't happen.
1154                 }
1155             }
1156         }
1157
1158         for diagnostic in BodyValidationDiagnostic::collect(db, self.into()) {
1159             match diagnostic {
1160                 BodyValidationDiagnostic::RecordMissingFields {
1161                     record,
1162                     variant,
1163                     missed_fields,
1164                 } => {
1165                     let variant_data = variant.variant_data(db.upcast());
1166                     let missed_fields = missed_fields
1167                         .into_iter()
1168                         .map(|idx| variant_data.fields()[idx].name.clone())
1169                         .collect();
1170
1171                     match record {
1172                         Either::Left(record_expr) => match source_map.expr_syntax(record_expr) {
1173                             Ok(source_ptr) => {
1174                                 let root = source_ptr.file_syntax(db.upcast());
1175                                 if let ast::Expr::RecordExpr(record_expr) =
1176                                     &source_ptr.value.to_node(&root)
1177                                 {
1178                                     if record_expr.record_expr_field_list().is_some() {
1179                                         acc.push(
1180                                             MissingFields {
1181                                                 file: source_ptr.file_id,
1182                                                 field_list_parent: Either::Left(AstPtr::new(
1183                                                     record_expr,
1184                                                 )),
1185                                                 field_list_parent_path: record_expr
1186                                                     .path()
1187                                                     .map(|path| AstPtr::new(&path)),
1188                                                 missed_fields,
1189                                             }
1190                                             .into(),
1191                                         )
1192                                     }
1193                                 }
1194                             }
1195                             Err(SyntheticSyntax) => (),
1196                         },
1197                         Either::Right(record_pat) => match source_map.pat_syntax(record_pat) {
1198                             Ok(source_ptr) => {
1199                                 if let Some(expr) = source_ptr.value.as_ref().left() {
1200                                     let root = source_ptr.file_syntax(db.upcast());
1201                                     if let ast::Pat::RecordPat(record_pat) = expr.to_node(&root) {
1202                                         if record_pat.record_pat_field_list().is_some() {
1203                                             acc.push(
1204                                                 MissingFields {
1205                                                     file: source_ptr.file_id,
1206                                                     field_list_parent: Either::Right(AstPtr::new(
1207                                                         &record_pat,
1208                                                     )),
1209                                                     field_list_parent_path: record_pat
1210                                                         .path()
1211                                                         .map(|path| AstPtr::new(&path)),
1212                                                     missed_fields,
1213                                                 }
1214                                                 .into(),
1215                                             )
1216                                         }
1217                                     }
1218                                 }
1219                             }
1220                             Err(SyntheticSyntax) => (),
1221                         },
1222                     }
1223                 }
1224                 BodyValidationDiagnostic::ReplaceFilterMapNextWithFindMap { method_call_expr } => {
1225                     if let Ok(next_source_ptr) = source_map.expr_syntax(method_call_expr) {
1226                         acc.push(
1227                             ReplaceFilterMapNextWithFindMap {
1228                                 file: next_source_ptr.file_id,
1229                                 next_expr: next_source_ptr.value,
1230                             }
1231                             .into(),
1232                         );
1233                     }
1234                 }
1235                 BodyValidationDiagnostic::MismatchedArgCount { call_expr, expected, found } => {
1236                     match source_map.expr_syntax(call_expr) {
1237                         Ok(source_ptr) => acc.push(
1238                             MismatchedArgCount { call_expr: source_ptr, expected, found }.into(),
1239                         ),
1240                         Err(SyntheticSyntax) => (),
1241                     }
1242                 }
1243                 BodyValidationDiagnostic::RemoveThisSemicolon { expr } => {
1244                     match source_map.expr_syntax(expr) {
1245                         Ok(expr) => acc.push(RemoveThisSemicolon { expr }.into()),
1246                         Err(SyntheticSyntax) => (),
1247                     }
1248                 }
1249                 BodyValidationDiagnostic::MissingOkOrSomeInTailExpr { expr, required } => {
1250                     match source_map.expr_syntax(expr) {
1251                         Ok(expr) => acc.push(
1252                             MissingOkOrSomeInTailExpr {
1253                                 expr,
1254                                 required,
1255                                 expected: self.body_type(db),
1256                             }
1257                             .into(),
1258                         ),
1259                         Err(SyntheticSyntax) => (),
1260                     }
1261                 }
1262                 BodyValidationDiagnostic::MissingMatchArms { match_expr } => {
1263                     match source_map.expr_syntax(match_expr) {
1264                         Ok(source_ptr) => {
1265                             let root = source_ptr.file_syntax(db.upcast());
1266                             if let ast::Expr::MatchExpr(match_expr) =
1267                                 &source_ptr.value.to_node(&root)
1268                             {
1269                                 if let (Some(match_expr), Some(arms)) =
1270                                     (match_expr.expr(), match_expr.match_arm_list())
1271                                 {
1272                                     acc.push(
1273                                         MissingMatchArms {
1274                                             file: source_ptr.file_id,
1275                                             match_expr: AstPtr::new(&match_expr),
1276                                             arms: AstPtr::new(&arms),
1277                                         }
1278                                         .into(),
1279                                     )
1280                                 }
1281                             }
1282                         }
1283                         Err(SyntheticSyntax) => (),
1284                     }
1285                 }
1286                 BodyValidationDiagnostic::AddReferenceHere { arg_expr, mutability } => {
1287                     match source_map.expr_syntax(arg_expr) {
1288                         Ok(expr) => acc.push(AddReferenceHere { expr, mutability }.into()),
1289                         Err(SyntheticSyntax) => (),
1290                     }
1291                 }
1292             }
1293         }
1294
1295         let def: ModuleDef = match self {
1296             DefWithBody::Function(it) => it.into(),
1297             DefWithBody::Static(it) => it.into(),
1298             DefWithBody::Const(it) => it.into(),
1299         };
1300         for diag in hir_ty::diagnostics::incorrect_case(db, krate, def.into()) {
1301             acc.push(diag.into())
1302         }
1303     }
1304 }
1305
1306 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1307 pub struct Function {
1308     pub(crate) id: FunctionId,
1309 }
1310
1311 impl Function {
1312     pub fn module(self, db: &dyn HirDatabase) -> Module {
1313         self.id.lookup(db.upcast()).module(db.upcast()).into()
1314     }
1315
1316     pub fn name(self, db: &dyn HirDatabase) -> Name {
1317         db.function_data(self.id).name.clone()
1318     }
1319
1320     /// Get this function's return type
1321     pub fn ret_type(self, db: &dyn HirDatabase) -> Type {
1322         let resolver = self.id.resolver(db.upcast());
1323         let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
1324         let ret_type = &db.function_data(self.id).ret_type;
1325         let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1326         let ty = ctx.lower_ty(ret_type);
1327         Type::new_with_resolver_inner(db, krate, &resolver, ty)
1328     }
1329
1330     pub fn self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
1331         if !db.function_data(self.id).has_self_param() {
1332             return None;
1333         }
1334         Some(SelfParam { func: self.id })
1335     }
1336
1337     pub fn assoc_fn_params(self, db: &dyn HirDatabase) -> Vec<Param> {
1338         let resolver = self.id.resolver(db.upcast());
1339         let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
1340         let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1341         let environment = db.trait_environment(self.id.into());
1342         db.function_data(self.id)
1343             .params
1344             .iter()
1345             .enumerate()
1346             .map(|(idx, (_, type_ref))| {
1347                 let ty = Type { krate, env: environment.clone(), ty: ctx.lower_ty(type_ref) };
1348                 Param { func: self, ty, idx }
1349             })
1350             .collect()
1351     }
1352
1353     pub fn method_params(self, db: &dyn HirDatabase) -> Option<Vec<Param>> {
1354         if self.self_param(db).is_none() {
1355             return None;
1356         }
1357         let mut res = self.assoc_fn_params(db);
1358         res.remove(0);
1359         Some(res)
1360     }
1361
1362     pub fn is_unsafe(self, db: &dyn HirDatabase) -> bool {
1363         db.function_data(self.id).is_unsafe()
1364     }
1365
1366     pub fn is_const(self, db: &dyn HirDatabase) -> bool {
1367         db.function_data(self.id).is_const()
1368     }
1369
1370     pub fn is_async(self, db: &dyn HirDatabase) -> bool {
1371         db.function_data(self.id).is_async()
1372     }
1373
1374     /// Whether this function declaration has a definition.
1375     ///
1376     /// This is false in the case of required (not provided) trait methods.
1377     pub fn has_body(self, db: &dyn HirDatabase) -> bool {
1378         db.function_data(self.id).has_body()
1379     }
1380
1381     /// A textual representation of the HIR of this function for debugging purposes.
1382     pub fn debug_hir(self, db: &dyn HirDatabase) -> String {
1383         let body = db.body(self.id.into());
1384
1385         let mut result = String::new();
1386         format_to!(result, "HIR expressions in the body of `{}`:\n", self.name(db));
1387         for (id, expr) in body.exprs.iter() {
1388             format_to!(result, "{:?}: {:?}\n", id, expr);
1389         }
1390
1391         result
1392     }
1393 }
1394
1395 // Note: logically, this belongs to `hir_ty`, but we are not using it there yet.
1396 pub enum Access {
1397     Shared,
1398     Exclusive,
1399     Owned,
1400 }
1401
1402 impl From<hir_ty::Mutability> for Access {
1403     fn from(mutability: hir_ty::Mutability) -> Access {
1404         match mutability {
1405             hir_ty::Mutability::Not => Access::Shared,
1406             hir_ty::Mutability::Mut => Access::Exclusive,
1407         }
1408     }
1409 }
1410
1411 #[derive(Clone, Debug)]
1412 pub struct Param {
1413     func: Function,
1414     /// The index in parameter list, including self parameter.
1415     idx: usize,
1416     ty: Type,
1417 }
1418
1419 impl Param {
1420     pub fn ty(&self) -> &Type {
1421         &self.ty
1422     }
1423
1424     pub fn name(&self, db: &dyn HirDatabase) -> Option<Name> {
1425         db.function_data(self.func.id).params[self.idx].0.clone()
1426     }
1427
1428     pub fn as_local(&self, db: &dyn HirDatabase) -> Local {
1429         let parent = DefWithBodyId::FunctionId(self.func.into());
1430         let body = db.body(parent);
1431         Local { parent, pat_id: body.params[self.idx] }
1432     }
1433
1434     pub fn pattern_source(&self, db: &dyn HirDatabase) -> Option<ast::Pat> {
1435         self.source(db).and_then(|p| p.value.pat())
1436     }
1437
1438     pub fn source(&self, db: &dyn HirDatabase) -> Option<InFile<ast::Param>> {
1439         let InFile { file_id, value } = self.func.source(db)?;
1440         let params = value.param_list()?;
1441         if params.self_param().is_some() {
1442             params.params().nth(self.idx.checked_sub(1)?)
1443         } else {
1444             params.params().nth(self.idx)
1445         }
1446         .map(|value| InFile { file_id, value })
1447     }
1448 }
1449
1450 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1451 pub struct SelfParam {
1452     func: FunctionId,
1453 }
1454
1455 impl SelfParam {
1456     pub fn access(self, db: &dyn HirDatabase) -> Access {
1457         let func_data = db.function_data(self.func);
1458         func_data
1459             .params
1460             .first()
1461             .map(|(_, param)| match &**param {
1462                 TypeRef::Reference(.., mutability) => match mutability {
1463                     hir_def::type_ref::Mutability::Shared => Access::Shared,
1464                     hir_def::type_ref::Mutability::Mut => Access::Exclusive,
1465                 },
1466                 _ => Access::Owned,
1467             })
1468             .unwrap_or(Access::Owned)
1469     }
1470
1471     pub fn display(self, db: &dyn HirDatabase) -> &'static str {
1472         match self.access(db) {
1473             Access::Shared => "&self",
1474             Access::Exclusive => "&mut self",
1475             Access::Owned => "self",
1476         }
1477     }
1478
1479     pub fn source(&self, db: &dyn HirDatabase) -> Option<InFile<ast::SelfParam>> {
1480         let InFile { file_id, value } = Function::from(self.func).source(db)?;
1481         value
1482             .param_list()
1483             .and_then(|params| params.self_param())
1484             .map(|value| InFile { file_id, value })
1485     }
1486
1487     pub fn ty(&self, db: &dyn HirDatabase) -> Type {
1488         let resolver = self.func.resolver(db.upcast());
1489         let krate = self.func.lookup(db.upcast()).container.module(db.upcast()).krate();
1490         let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1491         let environment = db.trait_environment(self.func.into());
1492
1493         Type {
1494             krate,
1495             env: environment.clone(),
1496             ty: ctx.lower_ty(&db.function_data(self.func).params[0].1),
1497         }
1498     }
1499 }
1500
1501 impl HasVisibility for Function {
1502     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1503         let function_data = db.function_data(self.id);
1504         let visibility = &function_data.visibility;
1505         visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1506     }
1507 }
1508
1509 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1510 pub struct Const {
1511     pub(crate) id: ConstId,
1512 }
1513
1514 impl Const {
1515     pub fn module(self, db: &dyn HirDatabase) -> Module {
1516         Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1517     }
1518
1519     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1520         db.const_data(self.id).name.clone()
1521     }
1522
1523     pub fn value(self, db: &dyn HirDatabase) -> Option<ast::Expr> {
1524         self.source(db)?.value.body()
1525     }
1526
1527     pub fn ty(self, db: &dyn HirDatabase) -> Type {
1528         let data = db.const_data(self.id);
1529         let resolver = self.id.resolver(db.upcast());
1530         let krate = self.id.lookup(db.upcast()).container.krate(db);
1531         let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1532         let ty = ctx.lower_ty(&data.type_ref);
1533         Type::new_with_resolver_inner(db, krate.id, &resolver, ty)
1534     }
1535
1536     pub fn eval(self, db: &dyn HirDatabase) -> Result<ComputedExpr, ConstEvalError> {
1537         let body = db.body(self.id.into());
1538         let root = &body.exprs[body.body_expr];
1539         let infer = db.infer_query(self.id.into());
1540         let infer = infer.as_ref();
1541         let result = eval_const(
1542             root,
1543             &mut ConstEvalCtx {
1544                 exprs: &body.exprs,
1545                 pats: &body.pats,
1546                 local_data: HashMap::default(),
1547                 infer: &mut |x| infer[x].clone(),
1548             },
1549         );
1550         result
1551     }
1552 }
1553
1554 impl HasVisibility for Const {
1555     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1556         let function_data = db.const_data(self.id);
1557         let visibility = &function_data.visibility;
1558         visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1559     }
1560 }
1561
1562 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1563 pub struct Static {
1564     pub(crate) id: StaticId,
1565 }
1566
1567 impl Static {
1568     pub fn module(self, db: &dyn HirDatabase) -> Module {
1569         Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1570     }
1571
1572     pub fn name(self, db: &dyn HirDatabase) -> Name {
1573         db.static_data(self.id).name.clone()
1574     }
1575
1576     pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
1577         db.static_data(self.id).mutable
1578     }
1579
1580     pub fn value(self, db: &dyn HirDatabase) -> Option<ast::Expr> {
1581         self.source(db)?.value.body()
1582     }
1583
1584     pub fn ty(self, db: &dyn HirDatabase) -> Type {
1585         let data = db.static_data(self.id);
1586         let resolver = self.id.resolver(db.upcast());
1587         let krate = self.id.lookup(db.upcast()).container.module(db.upcast()).krate();
1588         let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
1589         let ty = ctx.lower_ty(&data.type_ref);
1590         Type::new_with_resolver_inner(db, krate, &resolver, ty)
1591     }
1592 }
1593
1594 impl HasVisibility for Static {
1595     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1596         db.static_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1597     }
1598 }
1599
1600 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1601 pub struct Trait {
1602     pub(crate) id: TraitId,
1603 }
1604
1605 impl Trait {
1606     pub fn module(self, db: &dyn HirDatabase) -> Module {
1607         Module { id: self.id.lookup(db.upcast()).container }
1608     }
1609
1610     pub fn name(self, db: &dyn HirDatabase) -> Name {
1611         db.trait_data(self.id).name.clone()
1612     }
1613
1614     pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
1615         db.trait_data(self.id).items.iter().map(|(_name, it)| (*it).into()).collect()
1616     }
1617
1618     pub fn is_auto(self, db: &dyn HirDatabase) -> bool {
1619         db.trait_data(self.id).is_auto
1620     }
1621
1622     pub fn is_unsafe(&self, db: &dyn HirDatabase) -> bool {
1623         db.trait_data(self.id).is_unsafe
1624     }
1625 }
1626
1627 impl HasVisibility for Trait {
1628     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1629         db.trait_data(self.id).visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1630     }
1631 }
1632
1633 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1634 pub struct TypeAlias {
1635     pub(crate) id: TypeAliasId,
1636 }
1637
1638 impl TypeAlias {
1639     pub fn has_non_default_type_params(self, db: &dyn HirDatabase) -> bool {
1640         let subst = db.generic_defaults(self.id.into());
1641         subst.iter().any(|ty| ty.skip_binders().is_unknown())
1642     }
1643
1644     pub fn module(self, db: &dyn HirDatabase) -> Module {
1645         Module { id: self.id.lookup(db.upcast()).module(db.upcast()) }
1646     }
1647
1648     pub fn type_ref(self, db: &dyn HirDatabase) -> Option<TypeRef> {
1649         db.type_alias_data(self.id).type_ref.as_deref().cloned()
1650     }
1651
1652     pub fn ty(self, db: &dyn HirDatabase) -> Type {
1653         Type::from_def(db, self.id.lookup(db.upcast()).module(db.upcast()).krate(), self.id)
1654     }
1655
1656     pub fn name(self, db: &dyn HirDatabase) -> Name {
1657         db.type_alias_data(self.id).name.clone()
1658     }
1659 }
1660
1661 impl HasVisibility for TypeAlias {
1662     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1663         let function_data = db.type_alias_data(self.id);
1664         let visibility = &function_data.visibility;
1665         visibility.resolve(db.upcast(), &self.id.resolver(db.upcast()))
1666     }
1667 }
1668
1669 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1670 pub struct BuiltinType {
1671     pub(crate) inner: hir_def::builtin_type::BuiltinType,
1672 }
1673
1674 impl BuiltinType {
1675     pub fn str() -> BuiltinType {
1676         BuiltinType { inner: hir_def::builtin_type::BuiltinType::Str }
1677     }
1678
1679     pub fn ty(self, db: &dyn HirDatabase, module: Module) -> Type {
1680         let resolver = module.id.resolver(db.upcast());
1681         Type::new_with_resolver(db, &resolver, TyBuilder::builtin(self.inner))
1682             .expect("crate not present in resolver")
1683     }
1684
1685     pub fn name(self) -> Name {
1686         self.inner.as_name()
1687     }
1688 }
1689
1690 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1691 pub enum MacroKind {
1692     /// `macro_rules!` or Macros 2.0 macro.
1693     Declarative,
1694     /// A built-in or custom derive.
1695     Derive,
1696     /// A built-in function-like macro.
1697     BuiltIn,
1698     /// A procedural attribute macro.
1699     Attr,
1700     /// A function-like procedural macro.
1701     ProcMacro,
1702 }
1703
1704 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1705 pub struct MacroDef {
1706     pub(crate) id: MacroDefId,
1707 }
1708
1709 impl MacroDef {
1710     /// FIXME: right now, this just returns the root module of the crate that
1711     /// defines this macro. The reasons for this is that macros are expanded
1712     /// early, in `hir_expand`, where modules simply do not exist yet.
1713     pub fn module(self, db: &dyn HirDatabase) -> Option<Module> {
1714         let krate = self.id.krate;
1715         let def_map = db.crate_def_map(krate);
1716         let module_id = def_map.root();
1717         Some(Module { id: def_map.module_id(module_id) })
1718     }
1719
1720     /// XXX: this parses the file
1721     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1722         match self.source(db)?.value {
1723             Either::Left(it) => it.name().map(|it| it.as_name()),
1724             Either::Right(_) => {
1725                 let krate = self.id.krate;
1726                 let def_map = db.crate_def_map(krate);
1727                 let (_, name) = def_map.exported_proc_macros().find(|&(id, _)| id == self.id)?;
1728                 Some(name)
1729             }
1730         }
1731     }
1732
1733     pub fn kind(&self) -> MacroKind {
1734         match self.id.kind {
1735             MacroDefKind::Declarative(_) => MacroKind::Declarative,
1736             MacroDefKind::BuiltIn(_, _) | MacroDefKind::BuiltInEager(_, _) => MacroKind::BuiltIn,
1737             MacroDefKind::BuiltInDerive(_, _) => MacroKind::Derive,
1738             MacroDefKind::BuiltInAttr(_, _) => MacroKind::Attr,
1739             MacroDefKind::ProcMacro(_, base_db::ProcMacroKind::CustomDerive, _) => {
1740                 MacroKind::Derive
1741             }
1742             MacroDefKind::ProcMacro(_, base_db::ProcMacroKind::Attr, _) => MacroKind::Attr,
1743             MacroDefKind::ProcMacro(_, base_db::ProcMacroKind::FuncLike, _) => MacroKind::ProcMacro,
1744         }
1745     }
1746
1747     pub fn is_fn_like(&self) -> bool {
1748         match self.kind() {
1749             MacroKind::Declarative | MacroKind::BuiltIn | MacroKind::ProcMacro => true,
1750             MacroKind::Attr | MacroKind::Derive => false,
1751         }
1752     }
1753
1754     pub fn is_attr(&self) -> bool {
1755         matches!(self.kind(), MacroKind::Attr)
1756     }
1757 }
1758
1759 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1760 pub enum ItemInNs {
1761     Types(ModuleDef),
1762     Values(ModuleDef),
1763     Macros(MacroDef),
1764 }
1765
1766 impl From<MacroDef> for ItemInNs {
1767     fn from(it: MacroDef) -> Self {
1768         Self::Macros(it)
1769     }
1770 }
1771
1772 impl From<ModuleDef> for ItemInNs {
1773     fn from(module_def: ModuleDef) -> Self {
1774         match module_def {
1775             ModuleDef::Static(_) | ModuleDef::Const(_) | ModuleDef::Function(_) => {
1776                 ItemInNs::Values(module_def)
1777             }
1778             _ => ItemInNs::Types(module_def),
1779         }
1780     }
1781 }
1782
1783 impl ItemInNs {
1784     pub fn as_module_def(self) -> Option<ModuleDef> {
1785         match self {
1786             ItemInNs::Types(id) | ItemInNs::Values(id) => Some(id),
1787             ItemInNs::Macros(_) => None,
1788         }
1789     }
1790
1791     /// Returns the crate defining this item (or `None` if `self` is built-in).
1792     pub fn krate(&self, db: &dyn HirDatabase) -> Option<Crate> {
1793         match self {
1794             ItemInNs::Types(did) | ItemInNs::Values(did) => did.module(db).map(|m| m.krate()),
1795             ItemInNs::Macros(id) => id.module(db).map(|m| m.krate()),
1796         }
1797     }
1798
1799     pub fn attrs(&self, db: &dyn HirDatabase) -> Option<AttrsWithOwner> {
1800         match self {
1801             ItemInNs::Types(it) | ItemInNs::Values(it) => it.attrs(db),
1802             ItemInNs::Macros(it) => Some(it.attrs(db)),
1803         }
1804     }
1805 }
1806
1807 /// Invariant: `inner.as_assoc_item(db).is_some()`
1808 /// We do not actively enforce this invariant.
1809 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1810 pub enum AssocItem {
1811     Function(Function),
1812     Const(Const),
1813     TypeAlias(TypeAlias),
1814 }
1815 #[derive(Debug)]
1816 pub enum AssocItemContainer {
1817     Trait(Trait),
1818     Impl(Impl),
1819 }
1820 pub trait AsAssocItem {
1821     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>;
1822 }
1823
1824 impl AsAssocItem for Function {
1825     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1826         as_assoc_item(db, AssocItem::Function, self.id)
1827     }
1828 }
1829 impl AsAssocItem for Const {
1830     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1831         as_assoc_item(db, AssocItem::Const, self.id)
1832     }
1833 }
1834 impl AsAssocItem for TypeAlias {
1835     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1836         as_assoc_item(db, AssocItem::TypeAlias, self.id)
1837     }
1838 }
1839 impl AsAssocItem for ModuleDef {
1840     fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem> {
1841         match self {
1842             ModuleDef::Function(it) => it.as_assoc_item(db),
1843             ModuleDef::Const(it) => it.as_assoc_item(db),
1844             ModuleDef::TypeAlias(it) => it.as_assoc_item(db),
1845             _ => None,
1846         }
1847     }
1848 }
1849 fn as_assoc_item<ID, DEF, CTOR, AST>(db: &dyn HirDatabase, ctor: CTOR, id: ID) -> Option<AssocItem>
1850 where
1851     ID: Lookup<Data = AssocItemLoc<AST>>,
1852     DEF: From<ID>,
1853     CTOR: FnOnce(DEF) -> AssocItem,
1854     AST: ItemTreeNode,
1855 {
1856     match id.lookup(db.upcast()).container {
1857         ItemContainerId::TraitId(_) | ItemContainerId::ImplId(_) => Some(ctor(DEF::from(id))),
1858         ItemContainerId::ModuleId(_) | ItemContainerId::ExternBlockId(_) => None,
1859     }
1860 }
1861
1862 impl AssocItem {
1863     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
1864         match self {
1865             AssocItem::Function(it) => Some(it.name(db)),
1866             AssocItem::Const(it) => it.name(db),
1867             AssocItem::TypeAlias(it) => Some(it.name(db)),
1868         }
1869     }
1870     pub fn module(self, db: &dyn HirDatabase) -> Module {
1871         match self {
1872             AssocItem::Function(f) => f.module(db),
1873             AssocItem::Const(c) => c.module(db),
1874             AssocItem::TypeAlias(t) => t.module(db),
1875         }
1876     }
1877     pub fn container(self, db: &dyn HirDatabase) -> AssocItemContainer {
1878         let container = match self {
1879             AssocItem::Function(it) => it.id.lookup(db.upcast()).container,
1880             AssocItem::Const(it) => it.id.lookup(db.upcast()).container,
1881             AssocItem::TypeAlias(it) => it.id.lookup(db.upcast()).container,
1882         };
1883         match container {
1884             ItemContainerId::TraitId(id) => AssocItemContainer::Trait(id.into()),
1885             ItemContainerId::ImplId(id) => AssocItemContainer::Impl(id.into()),
1886             ItemContainerId::ModuleId(_) | ItemContainerId::ExternBlockId(_) => {
1887                 panic!("invalid AssocItem")
1888             }
1889         }
1890     }
1891
1892     pub fn containing_trait(self, db: &dyn HirDatabase) -> Option<Trait> {
1893         match self.container(db) {
1894             AssocItemContainer::Trait(t) => Some(t),
1895             _ => None,
1896         }
1897     }
1898
1899     pub fn containing_trait_impl(self, db: &dyn HirDatabase) -> Option<Trait> {
1900         match self.container(db) {
1901             AssocItemContainer::Impl(i) => i.trait_(db),
1902             _ => None,
1903         }
1904     }
1905
1906     pub fn containing_trait_or_trait_impl(self, db: &dyn HirDatabase) -> Option<Trait> {
1907         match self.container(db) {
1908             AssocItemContainer::Trait(t) => Some(t),
1909             AssocItemContainer::Impl(i) => i.trait_(db),
1910         }
1911     }
1912 }
1913
1914 impl HasVisibility for AssocItem {
1915     fn visibility(&self, db: &dyn HirDatabase) -> Visibility {
1916         match self {
1917             AssocItem::Function(f) => f.visibility(db),
1918             AssocItem::Const(c) => c.visibility(db),
1919             AssocItem::TypeAlias(t) => t.visibility(db),
1920         }
1921     }
1922 }
1923
1924 impl From<AssocItem> for ModuleDef {
1925     fn from(assoc: AssocItem) -> Self {
1926         match assoc {
1927             AssocItem::Function(it) => ModuleDef::Function(it),
1928             AssocItem::Const(it) => ModuleDef::Const(it),
1929             AssocItem::TypeAlias(it) => ModuleDef::TypeAlias(it),
1930         }
1931     }
1932 }
1933
1934 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
1935 pub enum GenericDef {
1936     Function(Function),
1937     Adt(Adt),
1938     Trait(Trait),
1939     TypeAlias(TypeAlias),
1940     Impl(Impl),
1941     // enum variants cannot have generics themselves, but their parent enums
1942     // can, and this makes some code easier to write
1943     Variant(Variant),
1944     // consts can have type parameters from their parents (i.e. associated consts of traits)
1945     Const(Const),
1946 }
1947 impl_from!(
1948     Function,
1949     Adt(Struct, Enum, Union),
1950     Trait,
1951     TypeAlias,
1952     Impl,
1953     Variant,
1954     Const
1955     for GenericDef
1956 );
1957
1958 impl GenericDef {
1959     pub fn params(self, db: &dyn HirDatabase) -> Vec<GenericParam> {
1960         let generics = db.generic_params(self.into());
1961         let ty_params = generics
1962             .types
1963             .iter()
1964             .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1965             .map(GenericParam::TypeParam);
1966         let lt_params = generics
1967             .lifetimes
1968             .iter()
1969             .map(|(local_id, _)| LifetimeParam {
1970                 id: LifetimeParamId { parent: self.into(), local_id },
1971             })
1972             .map(GenericParam::LifetimeParam);
1973         let const_params = generics
1974             .consts
1975             .iter()
1976             .map(|(local_id, _)| ConstParam { id: ConstParamId { parent: self.into(), local_id } })
1977             .map(GenericParam::ConstParam);
1978         ty_params.chain(lt_params).chain(const_params).collect()
1979     }
1980
1981     pub fn type_params(self, db: &dyn HirDatabase) -> Vec<TypeParam> {
1982         let generics = db.generic_params(self.into());
1983         generics
1984             .types
1985             .iter()
1986             .map(|(local_id, _)| TypeParam { id: TypeParamId { parent: self.into(), local_id } })
1987             .collect()
1988     }
1989 }
1990
1991 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
1992 pub struct Local {
1993     pub(crate) parent: DefWithBodyId,
1994     pub(crate) pat_id: PatId,
1995 }
1996
1997 impl Local {
1998     pub fn is_param(self, db: &dyn HirDatabase) -> bool {
1999         let src = self.source(db);
2000         match src.value {
2001             Either::Left(bind_pat) => {
2002                 bind_pat.syntax().ancestors().any(|it| ast::Param::can_cast(it.kind()))
2003             }
2004             Either::Right(_self_param) => true,
2005         }
2006     }
2007
2008     pub fn as_self_param(self, db: &dyn HirDatabase) -> Option<SelfParam> {
2009         match self.parent {
2010             DefWithBodyId::FunctionId(func) if self.is_self(db) => Some(SelfParam { func }),
2011             _ => None,
2012         }
2013     }
2014
2015     // FIXME: why is this an option? It shouldn't be?
2016     pub fn name(self, db: &dyn HirDatabase) -> Option<Name> {
2017         let body = db.body(self.parent);
2018         match &body[self.pat_id] {
2019             Pat::Bind { name, .. } => Some(name.clone()),
2020             _ => None,
2021         }
2022     }
2023
2024     pub fn is_self(self, db: &dyn HirDatabase) -> bool {
2025         self.name(db) == Some(name![self])
2026     }
2027
2028     pub fn is_mut(self, db: &dyn HirDatabase) -> bool {
2029         let body = db.body(self.parent);
2030         matches!(&body[self.pat_id], Pat::Bind { mode: BindingAnnotation::Mutable, .. })
2031     }
2032
2033     pub fn is_ref(self, db: &dyn HirDatabase) -> bool {
2034         let body = db.body(self.parent);
2035         matches!(
2036             &body[self.pat_id],
2037             Pat::Bind { mode: BindingAnnotation::Ref | BindingAnnotation::RefMut, .. }
2038         )
2039     }
2040
2041     pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
2042         self.parent.into()
2043     }
2044
2045     pub fn module(self, db: &dyn HirDatabase) -> Module {
2046         self.parent(db).module(db)
2047     }
2048
2049     pub fn ty(self, db: &dyn HirDatabase) -> Type {
2050         let def = self.parent;
2051         let infer = db.infer(def);
2052         let ty = infer[self.pat_id].clone();
2053         let krate = def.module(db.upcast()).krate();
2054         Type::new(db, krate, def, ty)
2055     }
2056
2057     pub fn source(self, db: &dyn HirDatabase) -> InFile<Either<ast::IdentPat, ast::SelfParam>> {
2058         let (_body, source_map) = db.body_with_source_map(self.parent);
2059         let src = source_map.pat_syntax(self.pat_id).unwrap(); // Hmm...
2060         let root = src.file_syntax(db.upcast());
2061         src.map(|ast| {
2062             ast.map_left(|it| it.cast().unwrap().to_node(&root)).map_right(|it| it.to_node(&root))
2063         })
2064     }
2065 }
2066
2067 // FIXME: Wrong name? This is could also be a registered attribute
2068 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2069 pub struct BuiltinAttr {
2070     krate: Option<CrateId>,
2071     idx: usize,
2072 }
2073
2074 impl BuiltinAttr {
2075     // FIXME: consider crates\hir_def\src\nameres\attr_resolution.rs?
2076     pub(crate) fn by_name(db: &dyn HirDatabase, krate: Crate, name: &str) -> Option<Self> {
2077         if let builtin @ Some(_) = Self::builtin(name) {
2078             return builtin;
2079         }
2080         let idx = db.crate_def_map(krate.id).registered_attrs().iter().position(|it| it == name)?;
2081         Some(BuiltinAttr { krate: Some(krate.id), idx })
2082     }
2083
2084     pub(crate) fn builtin(name: &str) -> Option<Self> {
2085         hir_def::builtin_attr::INERT_ATTRIBUTES
2086             .iter()
2087             .position(|tool| tool.name == name)
2088             .map(|idx| BuiltinAttr { krate: None, idx })
2089     }
2090
2091     pub fn name(&self, db: &dyn HirDatabase) -> SmolStr {
2092         // FIXME: Return a `Name` here
2093         match self.krate {
2094             Some(krate) => db.crate_def_map(krate).registered_attrs()[self.idx].clone(),
2095             None => SmolStr::new(hir_def::builtin_attr::INERT_ATTRIBUTES[self.idx].name),
2096         }
2097     }
2098
2099     pub fn template(&self, _: &dyn HirDatabase) -> Option<AttributeTemplate> {
2100         match self.krate {
2101             Some(_) => None,
2102             None => Some(hir_def::builtin_attr::INERT_ATTRIBUTES[self.idx].template),
2103         }
2104     }
2105 }
2106
2107 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2108 pub struct ToolModule {
2109     krate: Option<CrateId>,
2110     idx: usize,
2111 }
2112
2113 impl ToolModule {
2114     // FIXME: consider crates\hir_def\src\nameres\attr_resolution.rs?
2115     pub(crate) fn by_name(db: &dyn HirDatabase, krate: Crate, name: &str) -> Option<Self> {
2116         if let builtin @ Some(_) = Self::builtin(name) {
2117             return builtin;
2118         }
2119         let idx = db.crate_def_map(krate.id).registered_tools().iter().position(|it| it == name)?;
2120         Some(ToolModule { krate: Some(krate.id), idx })
2121     }
2122
2123     pub(crate) fn builtin(name: &str) -> Option<Self> {
2124         hir_def::builtin_attr::TOOL_MODULES
2125             .iter()
2126             .position(|&tool| tool == name)
2127             .map(|idx| ToolModule { krate: None, idx })
2128     }
2129
2130     pub fn name(&self, db: &dyn HirDatabase) -> SmolStr {
2131         // FIXME: Return a `Name` here
2132         match self.krate {
2133             Some(krate) => db.crate_def_map(krate).registered_tools()[self.idx].clone(),
2134             None => SmolStr::new(hir_def::builtin_attr::TOOL_MODULES[self.idx]),
2135         }
2136     }
2137 }
2138
2139 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2140 pub struct Label {
2141     pub(crate) parent: DefWithBodyId,
2142     pub(crate) label_id: LabelId,
2143 }
2144
2145 impl Label {
2146     pub fn module(self, db: &dyn HirDatabase) -> Module {
2147         self.parent(db).module(db)
2148     }
2149
2150     pub fn parent(self, _db: &dyn HirDatabase) -> DefWithBody {
2151         self.parent.into()
2152     }
2153
2154     pub fn name(self, db: &dyn HirDatabase) -> Name {
2155         let body = db.body(self.parent);
2156         body[self.label_id].name.clone()
2157     }
2158
2159     pub fn source(self, db: &dyn HirDatabase) -> InFile<ast::Label> {
2160         let (_body, source_map) = db.body_with_source_map(self.parent);
2161         let src = source_map.label_syntax(self.label_id);
2162         let root = src.file_syntax(db.upcast());
2163         src.map(|ast| ast.to_node(&root))
2164     }
2165 }
2166
2167 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2168 pub enum GenericParam {
2169     TypeParam(TypeParam),
2170     LifetimeParam(LifetimeParam),
2171     ConstParam(ConstParam),
2172 }
2173 impl_from!(TypeParam, LifetimeParam, ConstParam for GenericParam);
2174
2175 impl GenericParam {
2176     pub fn module(self, db: &dyn HirDatabase) -> Module {
2177         match self {
2178             GenericParam::TypeParam(it) => it.module(db),
2179             GenericParam::LifetimeParam(it) => it.module(db),
2180             GenericParam::ConstParam(it) => it.module(db),
2181         }
2182     }
2183
2184     pub fn name(self, db: &dyn HirDatabase) -> Name {
2185         match self {
2186             GenericParam::TypeParam(it) => it.name(db),
2187             GenericParam::LifetimeParam(it) => it.name(db),
2188             GenericParam::ConstParam(it) => it.name(db),
2189         }
2190     }
2191 }
2192
2193 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2194 pub struct TypeParam {
2195     pub(crate) id: TypeParamId,
2196 }
2197
2198 impl TypeParam {
2199     pub fn name(self, db: &dyn HirDatabase) -> Name {
2200         let params = db.generic_params(self.id.parent);
2201         params.types[self.id.local_id].name.clone().unwrap_or_else(Name::missing)
2202     }
2203
2204     pub fn module(self, db: &dyn HirDatabase) -> Module {
2205         self.id.parent.module(db.upcast()).into()
2206     }
2207
2208     pub fn ty(self, db: &dyn HirDatabase) -> Type {
2209         let resolver = self.id.parent.resolver(db.upcast());
2210         let krate = self.id.parent.module(db.upcast()).krate();
2211         let ty = TyKind::Placeholder(hir_ty::to_placeholder_idx(db, self.id)).intern(Interner);
2212         Type::new_with_resolver_inner(db, krate, &resolver, ty)
2213     }
2214
2215     pub fn trait_bounds(self, db: &dyn HirDatabase) -> Vec<Trait> {
2216         db.generic_predicates_for_param(self.id, None)
2217             .iter()
2218             .filter_map(|pred| match &pred.skip_binders().skip_binders() {
2219                 hir_ty::WhereClause::Implemented(trait_ref) => {
2220                     Some(Trait::from(trait_ref.hir_trait_id()))
2221                 }
2222                 _ => None,
2223             })
2224             .collect()
2225     }
2226
2227     pub fn default(self, db: &dyn HirDatabase) -> Option<Type> {
2228         let params = db.generic_defaults(self.id.parent);
2229         let local_idx = hir_ty::param_idx(db, self.id)?;
2230         let resolver = self.id.parent.resolver(db.upcast());
2231         let krate = self.id.parent.module(db.upcast()).krate();
2232         let ty = params.get(local_idx)?.clone();
2233         let subst = TyBuilder::type_params_subst(db, self.id.parent);
2234         let ty = ty.substitute(Interner, &subst_prefix(&subst, local_idx));
2235         Some(Type::new_with_resolver_inner(db, krate, &resolver, ty))
2236     }
2237 }
2238
2239 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2240 pub struct LifetimeParam {
2241     pub(crate) id: LifetimeParamId,
2242 }
2243
2244 impl LifetimeParam {
2245     pub fn name(self, db: &dyn HirDatabase) -> Name {
2246         let params = db.generic_params(self.id.parent);
2247         params.lifetimes[self.id.local_id].name.clone()
2248     }
2249
2250     pub fn module(self, db: &dyn HirDatabase) -> Module {
2251         self.id.parent.module(db.upcast()).into()
2252     }
2253
2254     pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
2255         self.id.parent.into()
2256     }
2257 }
2258
2259 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
2260 pub struct ConstParam {
2261     pub(crate) id: ConstParamId,
2262 }
2263
2264 impl ConstParam {
2265     pub fn name(self, db: &dyn HirDatabase) -> Name {
2266         let params = db.generic_params(self.id.parent);
2267         params.consts[self.id.local_id].name.clone()
2268     }
2269
2270     pub fn module(self, db: &dyn HirDatabase) -> Module {
2271         self.id.parent.module(db.upcast()).into()
2272     }
2273
2274     pub fn parent(self, _db: &dyn HirDatabase) -> GenericDef {
2275         self.id.parent.into()
2276     }
2277
2278     pub fn ty(self, db: &dyn HirDatabase) -> Type {
2279         let def = self.id.parent;
2280         let krate = def.module(db.upcast()).krate();
2281         Type::new(db, krate, def, db.const_param_ty(self.id))
2282     }
2283 }
2284
2285 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2286 pub struct Impl {
2287     pub(crate) id: ImplId,
2288 }
2289
2290 impl Impl {
2291     pub fn all_in_crate(db: &dyn HirDatabase, krate: Crate) -> Vec<Impl> {
2292         let inherent = db.inherent_impls_in_crate(krate.id);
2293         let trait_ = db.trait_impls_in_crate(krate.id);
2294
2295         inherent.all_impls().chain(trait_.all_impls()).map(Self::from).collect()
2296     }
2297
2298     pub fn all_for_type(db: &dyn HirDatabase, Type { krate, ty, .. }: Type) -> Vec<Impl> {
2299         let def_crates = match method_resolution::def_crates(db, &ty, krate) {
2300             Some(def_crates) => def_crates,
2301             None => return Vec::new(),
2302         };
2303
2304         let filter = |impl_def: &Impl| {
2305             let self_ty = impl_def.self_ty(db);
2306             let rref = self_ty.remove_ref();
2307             ty.equals_ctor(rref.as_ref().map_or(&self_ty.ty, |it| &it.ty))
2308         };
2309
2310         let fp = TyFingerprint::for_inherent_impl(&ty);
2311         let fp = match fp {
2312             Some(fp) => fp,
2313             None => return Vec::new(),
2314         };
2315
2316         let mut all = Vec::new();
2317         def_crates.iter().for_each(|&id| {
2318             all.extend(
2319                 db.inherent_impls_in_crate(id)
2320                     .for_self_ty(&ty)
2321                     .iter()
2322                     .cloned()
2323                     .map(Self::from)
2324                     .filter(filter),
2325             )
2326         });
2327         for id in def_crates
2328             .iter()
2329             .flat_map(|&id| Crate { id }.transitive_reverse_dependencies(db))
2330             .map(|Crate { id }| id)
2331             .chain(def_crates.iter().copied())
2332             .unique()
2333         {
2334             all.extend(
2335                 db.trait_impls_in_crate(id)
2336                     .for_self_ty_without_blanket_impls(fp)
2337                     .map(Self::from)
2338                     .filter(filter),
2339             );
2340         }
2341         all
2342     }
2343
2344     pub fn all_for_trait(db: &dyn HirDatabase, trait_: Trait) -> Vec<Impl> {
2345         let krate = trait_.module(db).krate();
2346         let mut all = Vec::new();
2347         for Crate { id } in krate.transitive_reverse_dependencies(db).into_iter() {
2348             let impls = db.trait_impls_in_crate(id);
2349             all.extend(impls.for_trait(trait_.id).map(Self::from))
2350         }
2351         all
2352     }
2353
2354     // FIXME: the return type is wrong. This should be a hir version of
2355     // `TraitRef` (to account for parameters and qualifiers)
2356     pub fn trait_(self, db: &dyn HirDatabase) -> Option<Trait> {
2357         let trait_ref = db.impl_trait(self.id)?.skip_binders().clone();
2358         let id = hir_ty::from_chalk_trait_id(trait_ref.trait_id);
2359         Some(Trait { id })
2360     }
2361
2362     pub fn self_ty(self, db: &dyn HirDatabase) -> Type {
2363         let impl_data = db.impl_data(self.id);
2364         let resolver = self.id.resolver(db.upcast());
2365         let krate = self.id.lookup(db.upcast()).container.krate();
2366         let ctx = hir_ty::TyLoweringContext::new(db, &resolver);
2367         let ty = ctx.lower_ty(&impl_data.self_ty);
2368         Type::new_with_resolver_inner(db, krate, &resolver, ty)
2369     }
2370
2371     pub fn items(self, db: &dyn HirDatabase) -> Vec<AssocItem> {
2372         db.impl_data(self.id).items.iter().map(|it| (*it).into()).collect()
2373     }
2374
2375     pub fn is_negative(self, db: &dyn HirDatabase) -> bool {
2376         db.impl_data(self.id).is_negative
2377     }
2378
2379     pub fn module(self, db: &dyn HirDatabase) -> Module {
2380         self.id.lookup(db.upcast()).container.into()
2381     }
2382
2383     pub fn is_builtin_derive(self, db: &dyn HirDatabase) -> Option<InFile<ast::Attr>> {
2384         let src = self.source(db)?;
2385         let item = src.file_id.is_builtin_derive(db.upcast())?;
2386         let hygenic = hir_expand::hygiene::Hygiene::new(db.upcast(), item.file_id);
2387
2388         // FIXME: handle `cfg_attr`
2389         let attr = item
2390             .value
2391             .attrs()
2392             .filter_map(|it| {
2393                 let path = ModPath::from_src(db.upcast(), it.path()?, &hygenic)?;
2394                 if path.as_ident()?.to_smol_str() == "derive" {
2395                     Some(it)
2396                 } else {
2397                     None
2398                 }
2399             })
2400             .last()?;
2401
2402         Some(item.with_value(attr))
2403     }
2404 }
2405
2406 #[derive(Clone, PartialEq, Eq, Debug)]
2407 pub struct Type {
2408     krate: CrateId,
2409     env: Arc<TraitEnvironment>,
2410     ty: Ty,
2411 }
2412
2413 impl Type {
2414     pub(crate) fn new_with_resolver(
2415         db: &dyn HirDatabase,
2416         resolver: &Resolver,
2417         ty: Ty,
2418     ) -> Option<Type> {
2419         let krate = resolver.krate()?;
2420         Some(Type::new_with_resolver_inner(db, krate, resolver, ty))
2421     }
2422     pub(crate) fn new_with_resolver_inner(
2423         db: &dyn HirDatabase,
2424         krate: CrateId,
2425         resolver: &Resolver,
2426         ty: Ty,
2427     ) -> Type {
2428         let environment = resolver
2429             .generic_def()
2430             .map_or_else(|| Arc::new(TraitEnvironment::empty(krate)), |d| db.trait_environment(d));
2431         Type { krate, env: environment, ty }
2432     }
2433
2434     fn new(db: &dyn HirDatabase, krate: CrateId, lexical_env: impl HasResolver, ty: Ty) -> Type {
2435         let resolver = lexical_env.resolver(db.upcast());
2436         let environment = resolver
2437             .generic_def()
2438             .map_or_else(|| Arc::new(TraitEnvironment::empty(krate)), |d| db.trait_environment(d));
2439         Type { krate, env: environment, ty }
2440     }
2441
2442     fn from_def(
2443         db: &dyn HirDatabase,
2444         krate: CrateId,
2445         def: impl HasResolver + Into<TyDefId>,
2446     ) -> Type {
2447         let ty = TyBuilder::def_ty(db, def.into()).fill_with_unknown().build();
2448         Type::new(db, krate, def, ty)
2449     }
2450
2451     pub fn new_slice(ty: Type) -> Type {
2452         Type { krate: ty.krate, env: ty.env, ty: TyBuilder::slice(ty.ty) }
2453     }
2454
2455     pub fn is_unit(&self) -> bool {
2456         matches!(self.ty.kind(Interner), TyKind::Tuple(0, ..))
2457     }
2458
2459     pub fn is_bool(&self) -> bool {
2460         matches!(self.ty.kind(Interner), TyKind::Scalar(Scalar::Bool))
2461     }
2462
2463     pub fn is_never(&self) -> bool {
2464         matches!(self.ty.kind(Interner), TyKind::Never)
2465     }
2466
2467     pub fn is_mutable_reference(&self) -> bool {
2468         matches!(self.ty.kind(Interner), TyKind::Ref(hir_ty::Mutability::Mut, ..))
2469     }
2470
2471     pub fn is_reference(&self) -> bool {
2472         matches!(self.ty.kind(Interner), TyKind::Ref(..))
2473     }
2474
2475     pub fn is_usize(&self) -> bool {
2476         matches!(self.ty.kind(Interner), TyKind::Scalar(Scalar::Uint(UintTy::Usize)))
2477     }
2478
2479     pub fn remove_ref(&self) -> Option<Type> {
2480         match &self.ty.kind(Interner) {
2481             TyKind::Ref(.., ty) => Some(self.derived(ty.clone())),
2482             _ => None,
2483         }
2484     }
2485
2486     pub fn strip_references(&self) -> Type {
2487         self.derived(self.ty.strip_references().clone())
2488     }
2489
2490     pub fn is_unknown(&self) -> bool {
2491         self.ty.is_unknown()
2492     }
2493
2494     /// Checks that particular type `ty` implements `std::future::Future`.
2495     /// This function is used in `.await` syntax completion.
2496     pub fn impls_future(&self, db: &dyn HirDatabase) -> bool {
2497         // No special case for the type of async block, since Chalk can figure it out.
2498
2499         let krate = self.krate;
2500
2501         let std_future_trait =
2502             db.lang_item(krate, SmolStr::new_inline("future_trait")).and_then(|it| it.as_trait());
2503         let std_future_trait = match std_future_trait {
2504             Some(it) => it,
2505             None => return false,
2506         };
2507
2508         let canonical_ty =
2509             Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(Interner) };
2510         method_resolution::implements_trait(
2511             &canonical_ty,
2512             db,
2513             self.env.clone(),
2514             krate,
2515             std_future_trait,
2516         )
2517     }
2518
2519     /// Checks that particular type `ty` implements `std::ops::FnOnce`.
2520     ///
2521     /// This function can be used to check if a particular type is callable, since FnOnce is a
2522     /// supertrait of Fn and FnMut, so all callable types implements at least FnOnce.
2523     pub fn impls_fnonce(&self, db: &dyn HirDatabase) -> bool {
2524         let krate = self.krate;
2525
2526         let fnonce_trait = match FnTrait::FnOnce.get_id(db, krate) {
2527             Some(it) => it,
2528             None => return false,
2529         };
2530
2531         let canonical_ty =
2532             Canonical { value: self.ty.clone(), binders: CanonicalVarKinds::empty(Interner) };
2533         method_resolution::implements_trait_unique(
2534             &canonical_ty,
2535             db,
2536             self.env.clone(),
2537             krate,
2538             fnonce_trait,
2539         )
2540     }
2541
2542     pub fn impls_trait(&self, db: &dyn HirDatabase, trait_: Trait, args: &[Type]) -> bool {
2543         let trait_ref = TyBuilder::trait_ref(db, trait_.id)
2544             .push(self.ty.clone())
2545             .fill(args.iter().map(|t| t.ty.clone()))
2546             .build();
2547
2548         let goal = Canonical {
2549             value: hir_ty::InEnvironment::new(&self.env.env, trait_ref.cast(Interner)),
2550             binders: CanonicalVarKinds::empty(Interner),
2551         };
2552
2553         db.trait_solve(self.krate, goal).is_some()
2554     }
2555
2556     pub fn normalize_trait_assoc_type(
2557         &self,
2558         db: &dyn HirDatabase,
2559         args: &[Type],
2560         alias: TypeAlias,
2561     ) -> Option<Type> {
2562         let projection = TyBuilder::assoc_type_projection(db, alias.id)
2563             .push(self.ty.clone())
2564             .fill(args.iter().map(|t| t.ty.clone()))
2565             .build();
2566         let goal = hir_ty::make_canonical(
2567             InEnvironment::new(
2568                 &self.env.env,
2569                 AliasEq {
2570                     alias: AliasTy::Projection(projection),
2571                     ty: TyKind::BoundVar(BoundVar::new(DebruijnIndex::INNERMOST, 0))
2572                         .intern(Interner),
2573                 }
2574                 .cast(Interner),
2575             ),
2576             [TyVariableKind::General].into_iter(),
2577         );
2578
2579         match db.trait_solve(self.krate, goal)? {
2580             Solution::Unique(s) => s
2581                 .value
2582                 .subst
2583                 .as_slice(Interner)
2584                 .first()
2585                 .map(|ty| self.derived(ty.assert_ty_ref(Interner).clone())),
2586             Solution::Ambig(_) => None,
2587         }
2588     }
2589
2590     pub fn is_copy(&self, db: &dyn HirDatabase) -> bool {
2591         let lang_item = db.lang_item(self.krate, SmolStr::new_inline("copy"));
2592         let copy_trait = match lang_item {
2593             Some(LangItemTarget::TraitId(it)) => it,
2594             _ => return false,
2595         };
2596         self.impls_trait(db, copy_trait.into(), &[])
2597     }
2598
2599     pub fn as_callable(&self, db: &dyn HirDatabase) -> Option<Callable> {
2600         let def = self.ty.callable_def(db);
2601
2602         let sig = self.ty.callable_sig(db)?;
2603         Some(Callable { ty: self.clone(), sig, def, is_bound_method: false })
2604     }
2605
2606     pub fn is_closure(&self) -> bool {
2607         matches!(&self.ty.kind(Interner), TyKind::Closure { .. })
2608     }
2609
2610     pub fn is_fn(&self) -> bool {
2611         matches!(&self.ty.kind(Interner), TyKind::FnDef(..) | TyKind::Function { .. })
2612     }
2613
2614     pub fn is_packed(&self, db: &dyn HirDatabase) -> bool {
2615         let adt_id = match *self.ty.kind(Interner) {
2616             TyKind::Adt(hir_ty::AdtId(adt_id), ..) => adt_id,
2617             _ => return false,
2618         };
2619
2620         let adt = adt_id.into();
2621         match adt {
2622             Adt::Struct(s) => matches!(s.repr(db), Some(ReprKind::Packed)),
2623             _ => false,
2624         }
2625     }
2626
2627     pub fn is_raw_ptr(&self) -> bool {
2628         matches!(&self.ty.kind(Interner), TyKind::Raw(..))
2629     }
2630
2631     pub fn contains_unknown(&self) -> bool {
2632         return go(&self.ty);
2633
2634         fn go(ty: &Ty) -> bool {
2635             match ty.kind(Interner) {
2636                 TyKind::Error => true,
2637
2638                 TyKind::Adt(_, substs)
2639                 | TyKind::AssociatedType(_, substs)
2640                 | TyKind::Tuple(_, substs)
2641                 | TyKind::OpaqueType(_, substs)
2642                 | TyKind::FnDef(_, substs)
2643                 | TyKind::Closure(_, substs) => {
2644                     substs.iter(Interner).filter_map(|a| a.ty(Interner)).any(go)
2645                 }
2646
2647                 TyKind::Array(_ty, len) if len.is_unknown() => true,
2648                 TyKind::Array(ty, _)
2649                 | TyKind::Slice(ty)
2650                 | TyKind::Raw(_, ty)
2651                 | TyKind::Ref(_, _, ty) => go(ty),
2652
2653                 TyKind::Scalar(_)
2654                 | TyKind::Str
2655                 | TyKind::Never
2656                 | TyKind::Placeholder(_)
2657                 | TyKind::BoundVar(_)
2658                 | TyKind::InferenceVar(_, _)
2659                 | TyKind::Dyn(_)
2660                 | TyKind::Function(_)
2661                 | TyKind::Alias(_)
2662                 | TyKind::Foreign(_)
2663                 | TyKind::Generator(..)
2664                 | TyKind::GeneratorWitness(..) => false,
2665             }
2666         }
2667     }
2668
2669     pub fn fields(&self, db: &dyn HirDatabase) -> Vec<(Field, Type)> {
2670         let (variant_id, substs) = match self.ty.kind(Interner) {
2671             TyKind::Adt(hir_ty::AdtId(AdtId::StructId(s)), substs) => ((*s).into(), substs),
2672             TyKind::Adt(hir_ty::AdtId(AdtId::UnionId(u)), substs) => ((*u).into(), substs),
2673             _ => return Vec::new(),
2674         };
2675
2676         db.field_types(variant_id)
2677             .iter()
2678             .map(|(local_id, ty)| {
2679                 let def = Field { parent: variant_id.into(), id: local_id };
2680                 let ty = ty.clone().substitute(Interner, substs);
2681                 (def, self.derived(ty))
2682             })
2683             .collect()
2684     }
2685
2686     pub fn tuple_fields(&self, _db: &dyn HirDatabase) -> Vec<Type> {
2687         if let TyKind::Tuple(_, substs) = &self.ty.kind(Interner) {
2688             substs
2689                 .iter(Interner)
2690                 .map(|ty| self.derived(ty.assert_ty_ref(Interner).clone()))
2691                 .collect()
2692         } else {
2693             Vec::new()
2694         }
2695     }
2696
2697     pub fn autoderef<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Type> + 'a {
2698         self.autoderef_(db).map(move |ty| self.derived(ty))
2699     }
2700
2701     pub fn autoderef_<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Ty> + 'a {
2702         // There should be no inference vars in types passed here
2703         let canonical = hir_ty::replace_errors_with_variables(&self.ty);
2704         let environment = self.env.env.clone();
2705         let ty = InEnvironment { goal: canonical, environment };
2706         autoderef(db, Some(self.krate), ty).map(|canonical| canonical.value)
2707     }
2708
2709     // This would be nicer if it just returned an iterator, but that runs into
2710     // lifetime problems, because we need to borrow temp `CrateImplDefs`.
2711     pub fn iterate_assoc_items<T>(
2712         self,
2713         db: &dyn HirDatabase,
2714         krate: Crate,
2715         mut callback: impl FnMut(AssocItem) -> Option<T>,
2716     ) -> Option<T> {
2717         let mut slot = None;
2718         self.iterate_assoc_items_dyn(db, krate, &mut |assoc_item_id| {
2719             slot = callback(assoc_item_id.into());
2720             slot.is_some()
2721         });
2722         slot
2723     }
2724
2725     fn iterate_assoc_items_dyn(
2726         self,
2727         db: &dyn HirDatabase,
2728         krate: Crate,
2729         callback: &mut dyn FnMut(AssocItemId) -> bool,
2730     ) {
2731         let def_crates = match method_resolution::def_crates(db, &self.ty, krate.id) {
2732             Some(it) => it,
2733             None => return,
2734         };
2735         for krate in def_crates {
2736             let impls = db.inherent_impls_in_crate(krate);
2737
2738             for impl_def in impls.for_self_ty(&self.ty) {
2739                 for &item in db.impl_data(*impl_def).items.iter() {
2740                     if callback(item) {
2741                         return;
2742                     }
2743                 }
2744             }
2745         }
2746     }
2747
2748     pub fn type_arguments(&self) -> impl Iterator<Item = Type> + '_ {
2749         self.ty
2750             .strip_references()
2751             .as_adt()
2752             .into_iter()
2753             .flat_map(|(_, substs)| substs.iter(Interner))
2754             .filter_map(|arg| arg.ty(Interner).cloned())
2755             .map(move |ty| self.derived(ty))
2756     }
2757
2758     pub fn iterate_method_candidates<T>(
2759         &self,
2760         db: &dyn HirDatabase,
2761         krate: Crate,
2762         traits_in_scope: &FxHashSet<TraitId>,
2763         name: Option<&Name>,
2764         mut callback: impl FnMut(Type, Function) -> Option<T>,
2765     ) -> Option<T> {
2766         let _p = profile::span("iterate_method_candidates");
2767         let mut slot = None;
2768         self.iterate_method_candidates_dyn(
2769             db,
2770             krate,
2771             traits_in_scope,
2772             name,
2773             &mut |ty, assoc_item_id| {
2774                 if let AssocItemId::FunctionId(func) = assoc_item_id {
2775                     if let Some(res) = callback(self.derived(ty.clone()), func.into()) {
2776                         slot = Some(res);
2777                         return ControlFlow::Break(());
2778                     }
2779                 }
2780                 ControlFlow::Continue(())
2781             },
2782         );
2783         slot
2784     }
2785
2786     fn iterate_method_candidates_dyn(
2787         &self,
2788         db: &dyn HirDatabase,
2789         krate: Crate,
2790         traits_in_scope: &FxHashSet<TraitId>,
2791         name: Option<&Name>,
2792         callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
2793     ) {
2794         // There should be no inference vars in types passed here
2795         let canonical = hir_ty::replace_errors_with_variables(&self.ty);
2796
2797         let env = self.env.clone();
2798         let krate = krate.id;
2799
2800         method_resolution::iterate_method_candidates_dyn(
2801             &canonical,
2802             db,
2803             env,
2804             krate,
2805             traits_in_scope,
2806             None,
2807             name,
2808             method_resolution::LookupMode::MethodCall,
2809             &mut |ty, id| callback(&ty.value, id),
2810         );
2811     }
2812
2813     pub fn iterate_path_candidates<T>(
2814         &self,
2815         db: &dyn HirDatabase,
2816         krate: Crate,
2817         traits_in_scope: &FxHashSet<TraitId>,
2818         name: Option<&Name>,
2819         mut callback: impl FnMut(Type, AssocItem) -> Option<T>,
2820     ) -> Option<T> {
2821         let _p = profile::span("iterate_path_candidates");
2822         let mut slot = None;
2823         self.iterate_path_candidates_dyn(
2824             db,
2825             krate,
2826             traits_in_scope,
2827             name,
2828             &mut |ty, assoc_item_id| {
2829                 if let Some(res) = callback(self.derived(ty.clone()), assoc_item_id.into()) {
2830                     slot = Some(res);
2831                     return ControlFlow::Break(());
2832                 }
2833                 ControlFlow::Continue(())
2834             },
2835         );
2836         slot
2837     }
2838
2839     fn iterate_path_candidates_dyn(
2840         &self,
2841         db: &dyn HirDatabase,
2842         krate: Crate,
2843         traits_in_scope: &FxHashSet<TraitId>,
2844         name: Option<&Name>,
2845         callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
2846     ) {
2847         let canonical = hir_ty::replace_errors_with_variables(&self.ty);
2848
2849         let env = self.env.clone();
2850         let krate = krate.id;
2851
2852         method_resolution::iterate_method_candidates_dyn(
2853             &canonical,
2854             db,
2855             env,
2856             krate,
2857             traits_in_scope,
2858             None,
2859             name,
2860             method_resolution::LookupMode::Path,
2861             &mut |ty, id| callback(&ty.value, id),
2862         );
2863     }
2864
2865     pub fn as_adt(&self) -> Option<Adt> {
2866         let (adt, _subst) = self.ty.as_adt()?;
2867         Some(adt.into())
2868     }
2869
2870     pub fn as_builtin(&self) -> Option<BuiltinType> {
2871         self.ty.as_builtin().map(|inner| BuiltinType { inner })
2872     }
2873
2874     pub fn as_dyn_trait(&self) -> Option<Trait> {
2875         self.ty.dyn_trait().map(Into::into)
2876     }
2877
2878     /// If a type can be represented as `dyn Trait`, returns all traits accessible via this type,
2879     /// or an empty iterator otherwise.
2880     pub fn applicable_inherent_traits<'a>(
2881         &'a self,
2882         db: &'a dyn HirDatabase,
2883     ) -> impl Iterator<Item = Trait> + 'a {
2884         let _p = profile::span("applicable_inherent_traits");
2885         self.autoderef_(db)
2886             .filter_map(|ty| ty.dyn_trait())
2887             .flat_map(move |dyn_trait_id| hir_ty::all_super_traits(db.upcast(), dyn_trait_id))
2888             .map(Trait::from)
2889     }
2890
2891     pub fn env_traits<'a>(&'a self, db: &'a dyn HirDatabase) -> impl Iterator<Item = Trait> + 'a {
2892         let _p = profile::span("env_traits");
2893         self.autoderef_(db)
2894             .filter(|ty| matches!(ty.kind(Interner), TyKind::Placeholder(_)))
2895             .flat_map(|ty| {
2896                 self.env
2897                     .traits_in_scope_from_clauses(ty)
2898                     .flat_map(|t| hir_ty::all_super_traits(db.upcast(), t))
2899             })
2900             .map(Trait::from)
2901     }
2902
2903     pub fn as_impl_traits(&self, db: &dyn HirDatabase) -> Option<impl Iterator<Item = Trait>> {
2904         self.ty.impl_trait_bounds(db).map(|it| {
2905             it.into_iter().filter_map(|pred| match pred.skip_binders() {
2906                 hir_ty::WhereClause::Implemented(trait_ref) => {
2907                     Some(Trait::from(trait_ref.hir_trait_id()))
2908                 }
2909                 _ => None,
2910             })
2911         })
2912     }
2913
2914     pub fn as_associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<Trait> {
2915         self.ty.associated_type_parent_trait(db).map(Into::into)
2916     }
2917
2918     fn derived(&self, ty: Ty) -> Type {
2919         Type { krate: self.krate, env: self.env.clone(), ty }
2920     }
2921
2922     pub fn walk(&self, db: &dyn HirDatabase, mut cb: impl FnMut(Type)) {
2923         // TypeWalk::walk for a Ty at first visits parameters and only after that the Ty itself.
2924         // We need a different order here.
2925
2926         fn walk_substs(
2927             db: &dyn HirDatabase,
2928             type_: &Type,
2929             substs: &Substitution,
2930             cb: &mut impl FnMut(Type),
2931         ) {
2932             for ty in substs.iter(Interner).filter_map(|a| a.ty(Interner)) {
2933                 walk_type(db, &type_.derived(ty.clone()), cb);
2934             }
2935         }
2936
2937         fn walk_bounds(
2938             db: &dyn HirDatabase,
2939             type_: &Type,
2940             bounds: &[QuantifiedWhereClause],
2941             cb: &mut impl FnMut(Type),
2942         ) {
2943             for pred in bounds {
2944                 if let WhereClause::Implemented(trait_ref) = pred.skip_binders() {
2945                     cb(type_.clone());
2946                     // skip the self type. it's likely the type we just got the bounds from
2947                     for ty in
2948                         trait_ref.substitution.iter(Interner).skip(1).filter_map(|a| a.ty(Interner))
2949                     {
2950                         walk_type(db, &type_.derived(ty.clone()), cb);
2951                     }
2952                 }
2953             }
2954         }
2955
2956         fn walk_type(db: &dyn HirDatabase, type_: &Type, cb: &mut impl FnMut(Type)) {
2957             let ty = type_.ty.strip_references();
2958             match ty.kind(Interner) {
2959                 TyKind::Adt(_, substs) => {
2960                     cb(type_.derived(ty.clone()));
2961                     walk_substs(db, type_, substs, cb);
2962                 }
2963                 TyKind::AssociatedType(_, substs) => {
2964                     if ty.associated_type_parent_trait(db).is_some() {
2965                         cb(type_.derived(ty.clone()));
2966                     }
2967                     walk_substs(db, type_, substs, cb);
2968                 }
2969                 TyKind::OpaqueType(_, subst) => {
2970                     if let Some(bounds) = ty.impl_trait_bounds(db) {
2971                         walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2972                     }
2973
2974                     walk_substs(db, type_, subst, cb);
2975                 }
2976                 TyKind::Alias(AliasTy::Opaque(opaque_ty)) => {
2977                     if let Some(bounds) = ty.impl_trait_bounds(db) {
2978                         walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2979                     }
2980
2981                     walk_substs(db, type_, &opaque_ty.substitution, cb);
2982                 }
2983                 TyKind::Placeholder(_) => {
2984                     if let Some(bounds) = ty.impl_trait_bounds(db) {
2985                         walk_bounds(db, &type_.derived(ty.clone()), &bounds, cb);
2986                     }
2987                 }
2988                 TyKind::Dyn(bounds) => {
2989                     walk_bounds(
2990                         db,
2991                         &type_.derived(ty.clone()),
2992                         bounds.bounds.skip_binders().interned(),
2993                         cb,
2994                     );
2995                 }
2996
2997                 TyKind::Ref(_, _, ty)
2998                 | TyKind::Raw(_, ty)
2999                 | TyKind::Array(ty, _)
3000                 | TyKind::Slice(ty) => {
3001                     walk_type(db, &type_.derived(ty.clone()), cb);
3002                 }
3003
3004                 TyKind::FnDef(_, substs)
3005                 | TyKind::Tuple(_, substs)
3006                 | TyKind::Closure(.., substs) => {
3007                     walk_substs(db, type_, substs, cb);
3008                 }
3009                 TyKind::Function(hir_ty::FnPointer { substitution, .. }) => {
3010                     walk_substs(db, type_, &substitution.0, cb);
3011                 }
3012
3013                 _ => {}
3014             }
3015         }
3016
3017         walk_type(db, self, &mut cb);
3018     }
3019
3020     pub fn could_unify_with(&self, db: &dyn HirDatabase, other: &Type) -> bool {
3021         let tys = hir_ty::replace_errors_with_variables(&(self.ty.clone(), other.ty.clone()));
3022         could_unify(db, self.env.clone(), &tys)
3023     }
3024 }
3025
3026 // FIXME: closures
3027 #[derive(Debug)]
3028 pub struct Callable {
3029     ty: Type,
3030     sig: CallableSig,
3031     def: Option<CallableDefId>,
3032     pub(crate) is_bound_method: bool,
3033 }
3034
3035 pub enum CallableKind {
3036     Function(Function),
3037     TupleStruct(Struct),
3038     TupleEnumVariant(Variant),
3039     Closure,
3040 }
3041
3042 impl Callable {
3043     pub fn kind(&self) -> CallableKind {
3044         match self.def {
3045             Some(CallableDefId::FunctionId(it)) => CallableKind::Function(it.into()),
3046             Some(CallableDefId::StructId(it)) => CallableKind::TupleStruct(it.into()),
3047             Some(CallableDefId::EnumVariantId(it)) => CallableKind::TupleEnumVariant(it.into()),
3048             None => CallableKind::Closure,
3049         }
3050     }
3051     pub fn receiver_param(&self, db: &dyn HirDatabase) -> Option<ast::SelfParam> {
3052         let func = match self.def {
3053             Some(CallableDefId::FunctionId(it)) if self.is_bound_method => it,
3054             _ => return None,
3055         };
3056         let src = func.lookup(db.upcast()).source(db.upcast());
3057         let param_list = src.value.param_list()?;
3058         param_list.self_param()
3059     }
3060     pub fn n_params(&self) -> usize {
3061         self.sig.params().len() - if self.is_bound_method { 1 } else { 0 }
3062     }
3063     pub fn params(
3064         &self,
3065         db: &dyn HirDatabase,
3066     ) -> Vec<(Option<Either<ast::SelfParam, ast::Pat>>, Type)> {
3067         let types = self
3068             .sig
3069             .params()
3070             .iter()
3071             .skip(if self.is_bound_method { 1 } else { 0 })
3072             .map(|ty| self.ty.derived(ty.clone()));
3073         let patterns = match self.def {
3074             Some(CallableDefId::FunctionId(func)) => {
3075                 let src = func.lookup(db.upcast()).source(db.upcast());
3076                 src.value.param_list().map(|param_list| {
3077                     param_list
3078                         .self_param()
3079                         .map(|it| Some(Either::Left(it)))
3080                         .filter(|_| !self.is_bound_method)
3081                         .into_iter()
3082                         .chain(param_list.params().map(|it| it.pat().map(Either::Right)))
3083                 })
3084             }
3085             _ => None,
3086         };
3087         patterns.into_iter().flatten().chain(iter::repeat(None)).zip(types).collect()
3088     }
3089     pub fn return_type(&self) -> Type {
3090         self.ty.derived(self.sig.ret().clone())
3091     }
3092 }
3093
3094 /// For IDE only
3095 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
3096 pub enum ScopeDef {
3097     ModuleDef(ModuleDef),
3098     MacroDef(MacroDef),
3099     GenericParam(GenericParam),
3100     ImplSelfType(Impl),
3101     AdtSelfType(Adt),
3102     Local(Local),
3103     Label(Label),
3104     Unknown,
3105 }
3106
3107 impl ScopeDef {
3108     pub fn all_items(def: PerNs) -> ArrayVec<Self, 3> {
3109         let mut items = ArrayVec::new();
3110
3111         match (def.take_types(), def.take_values()) {
3112             (Some(m1), None) => items.push(ScopeDef::ModuleDef(m1.into())),
3113             (None, Some(m2)) => items.push(ScopeDef::ModuleDef(m2.into())),
3114             (Some(m1), Some(m2)) => {
3115                 // Some items, like unit structs and enum variants, are
3116                 // returned as both a type and a value. Here we want
3117                 // to de-duplicate them.
3118                 if m1 != m2 {
3119                     items.push(ScopeDef::ModuleDef(m1.into()));
3120                     items.push(ScopeDef::ModuleDef(m2.into()));
3121                 } else {
3122                     items.push(ScopeDef::ModuleDef(m1.into()));
3123                 }
3124             }
3125             (None, None) => {}
3126         };
3127
3128         if let Some(macro_def_id) = def.take_macros() {
3129             items.push(ScopeDef::MacroDef(macro_def_id.into()));
3130         }
3131
3132         if items.is_empty() {
3133             items.push(ScopeDef::Unknown);
3134         }
3135
3136         items
3137     }
3138
3139     pub fn attrs(&self, db: &dyn HirDatabase) -> Option<AttrsWithOwner> {
3140         match self {
3141             ScopeDef::ModuleDef(it) => it.attrs(db),
3142             ScopeDef::MacroDef(it) => Some(it.attrs(db)),
3143             ScopeDef::GenericParam(it) => Some(it.attrs(db)),
3144             ScopeDef::ImplSelfType(_)
3145             | ScopeDef::AdtSelfType(_)
3146             | ScopeDef::Local(_)
3147             | ScopeDef::Label(_)
3148             | ScopeDef::Unknown => None,
3149         }
3150     }
3151
3152     pub fn krate(&self, db: &dyn HirDatabase) -> Option<Crate> {
3153         match self {
3154             ScopeDef::ModuleDef(it) => it.module(db).map(|m| m.krate()),
3155             ScopeDef::MacroDef(it) => it.module(db).map(|m| m.krate()),
3156             ScopeDef::GenericParam(it) => Some(it.module(db).krate()),
3157             ScopeDef::ImplSelfType(_) => None,
3158             ScopeDef::AdtSelfType(it) => Some(it.module(db).krate()),
3159             ScopeDef::Local(it) => Some(it.module(db).krate()),
3160             ScopeDef::Label(it) => Some(it.module(db).krate()),
3161             ScopeDef::Unknown => None,
3162         }
3163     }
3164 }
3165
3166 impl From<ItemInNs> for ScopeDef {
3167     fn from(item: ItemInNs) -> Self {
3168         match item {
3169             ItemInNs::Types(id) => ScopeDef::ModuleDef(id),
3170             ItemInNs::Values(id) => ScopeDef::ModuleDef(id),
3171             ItemInNs::Macros(id) => ScopeDef::MacroDef(id),
3172         }
3173     }
3174 }
3175
3176 pub trait HasVisibility {
3177     fn visibility(&self, db: &dyn HirDatabase) -> Visibility;
3178     fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool {
3179         let vis = self.visibility(db);
3180         vis.is_visible_from(db.upcast(), module.id)
3181     }
3182 }
3183
3184 /// Trait for obtaining the defining crate of an item.
3185 pub trait HasCrate {
3186     fn krate(&self, db: &dyn HirDatabase) -> Crate;
3187 }
3188
3189 impl<T: hir_def::HasModule> HasCrate for T {
3190     fn krate(&self, db: &dyn HirDatabase) -> Crate {
3191         self.module(db.upcast()).krate().into()
3192     }
3193 }
3194
3195 impl HasCrate for AssocItem {
3196     fn krate(&self, db: &dyn HirDatabase) -> Crate {
3197         self.module(db).krate()
3198     }
3199 }
3200
3201 impl HasCrate for Field {
3202     fn krate(&self, db: &dyn HirDatabase) -> Crate {
3203         self.parent_def(db).module(db).krate()
3204     }
3205 }
3206
3207 impl HasCrate for Function {
3208     fn krate(&self, db: &dyn HirDatabase) -> Crate {
3209         self.module(db).krate()
3210     }
3211 }
3212
3213 impl HasCrate for Const {
3214     fn krate(&self, db: &dyn HirDatabase) -> Crate {
3215         self.module(db).krate()
3216     }
3217 }
3218
3219 impl HasCrate for TypeAlias {
3220     fn krate(&self, db: &dyn HirDatabase) -> Crate {
3221         self.module(db).krate()
3222     }
3223 }
3224
3225 impl HasCrate for Type {
3226     fn krate(&self, _db: &dyn HirDatabase) -> Crate {
3227         self.krate.into()
3228     }
3229 }