crates/hir/src/semantics.rs

   1 //! See `Semantics`.
   2
   3 mod source_to_def;
   4
   5 use std::{cell::RefCell, fmt};
   6
   7 use base_db::{FileId, FileRange};
   8 use hir_def::{
   9     body,
  10     resolver::{self, HasResolver, Resolver, TypeNs},
  11     AsMacroCall, FunctionId, TraitId, VariantId,
  12 };
  13 use hir_expand::{name::AsName, ExpansionInfo};
  14 use hir_ty::{associated_type_shorthand_candidates, Interner};
  15 use itertools::Itertools;
  16 use rustc_hash::{FxHashMap, FxHashSet};
  17 use smallvec::{smallvec, SmallVec};
  18 use syntax::{
  19     algo::skip_trivia_token,
  20     ast::{self, HasAttrs, HasGenericParams, HasLoopBody},
  21     match_ast, AstNode, Direction, SyntaxNode, SyntaxNodePtr, SyntaxToken, TextSize,
  22 };
  23
  24 use crate::{
  25     db::HirDatabase,
  26     semantics::source_to_def::{ChildContainer, SourceToDefCache, SourceToDefCtx},
  27     source_analyzer::{resolve_hir_path, resolve_hir_path_as_macro, SourceAnalyzer},
  28     Access, AssocItem, Callable, ConstParam, Crate, Field, Function, HasSource, HirFileId, Impl,
  29     InFile, Label, LifetimeParam, Local, MacroDef, Module, ModuleDef, Name, Path, ScopeDef, Trait,
  30     Type, TypeAlias, TypeParam, VariantDef,
  31 };
  32
  33 #[derive(Debug, Clone, PartialEq, Eq)]
  34 pub enum PathResolution {
  35     /// An item
  36     Def(ModuleDef),
  37     /// A local binding (only value namespace)
  38     Local(Local),
  39     /// A type parameter
  40     TypeParam(TypeParam),
  41     /// A const parameter
  42     ConstParam(ConstParam),
  43     SelfType(Impl),
  44     Macro(MacroDef),
  45     AssocItem(AssocItem),
  46 }
  47
  48 impl PathResolution {
  49     fn in_type_ns(&self) -> Option<TypeNs> {
  50         match self {
  51             PathResolution::Def(ModuleDef::Adt(adt)) => Some(TypeNs::AdtId((*adt).into())),
  52             PathResolution::Def(ModuleDef::BuiltinType(builtin)) => {
  53                 Some(TypeNs::BuiltinType((*builtin).into()))
  54             }
  55             PathResolution::Def(
  56                 ModuleDef::Const(_)
  57                 | ModuleDef::Variant(_)
  58                 | ModuleDef::Function(_)
  59                 | ModuleDef::Module(_)
  60                 | ModuleDef::Static(_)
  61                 | ModuleDef::Trait(_),
  62             ) => None,
  63             PathResolution::Def(ModuleDef::TypeAlias(alias)) => {
  64                 Some(TypeNs::TypeAliasId((*alias).into()))
  65             }
  66             PathResolution::Local(_) | PathResolution::Macro(_) | PathResolution::ConstParam(_) => {
  67                 None
  68             }
  69             PathResolution::TypeParam(param) => Some(TypeNs::GenericParam((*param).into())),
  70             PathResolution::SelfType(impl_def) => Some(TypeNs::SelfType((*impl_def).into())),
  71             PathResolution::AssocItem(AssocItem::Const(_) | AssocItem::Function(_)) => None,
  72             PathResolution::AssocItem(AssocItem::TypeAlias(alias)) => {
  73                 Some(TypeNs::TypeAliasId((*alias).into()))
  74             }
  75         }
  76     }
  77
  78     /// Returns an iterator over associated types that may be specified after this path (using
  79     /// `Ty::Assoc` syntax).
  80     pub fn assoc_type_shorthand_candidates<R>(
  81         &self,
  82         db: &dyn HirDatabase,
  83         mut cb: impl FnMut(&Name, TypeAlias) -> Option<R>,
  84     ) -> Option<R> {
  85         associated_type_shorthand_candidates(db, self.in_type_ns()?, |name, _, id| {
  86             cb(name, id.into())
  87         })
  88     }
  89 }
  90
  91 #[derive(Debug)]
  92 pub struct TypeInfo {
  93     /// The original type of the expression or pattern.
  94     pub original: Type,
  95     /// The adjusted type, if an adjustment happened.
  96     pub adjusted: Option<Type>,
  97 }
  98
  99 impl TypeInfo {
 100     pub fn original(self) -> Type {
 101         self.original
 102     }
 103
 104     pub fn has_adjustment(&self) -> bool {
 105         self.adjusted.is_some()
 106     }
 107
 108     /// The adjusted type, or the original in case no adjustments occurred.
 109     pub fn adjusted(self) -> Type {
 110         self.adjusted.unwrap_or(self.original)
 111     }
 112 }
 113
 114 /// Primary API to get semantic information, like types, from syntax trees.
 115 pub struct Semantics<'db, DB> {
 116     pub db: &'db DB,
 117     imp: SemanticsImpl<'db>,
 118 }
 119
 120 pub struct SemanticsImpl<'db> {
 121     pub db: &'db dyn HirDatabase,
 122     s2d_cache: RefCell<SourceToDefCache>,
 123     expansion_info_cache: RefCell<FxHashMap<HirFileId, Option<ExpansionInfo>>>,
 124     // Rootnode to HirFileId cache
 125     cache: RefCell<FxHashMap<SyntaxNode, HirFileId>>,
 126     // MacroCall to its expansion's HirFileId cache
 127     macro_call_cache: RefCell<FxHashMap<InFile<ast::MacroCall>, HirFileId>>,
 128 }
 129
 130 impl<DB> fmt::Debug for Semantics<'_, DB> {
 131     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 132         write!(f, "Semantics {{ ... }}")
 133     }
 134 }
 135
 136 impl<'db, DB: HirDatabase> Semantics<'db, DB> {
 137     pub fn new(db: &DB) -> Semantics<DB> {
 138         let impl_ = SemanticsImpl::new(db);
 139         Semantics { db, imp: impl_ }
 140     }
 141
 142     pub fn parse(&self, file_id: FileId) -> ast::SourceFile {
 143         self.imp.parse(file_id)
 144     }
 145
 146     pub fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
 147         self.imp.expand(macro_call)
 148     }
 149
 150     /// If `item` has an attribute macro attached to it, expands it.
 151     pub fn expand_attr_macro(&self, item: &ast::Item) -> Option<SyntaxNode> {
 152         self.imp.expand_attr_macro(item)
 153     }
 154
 155     pub fn expand_derive_macro(&self, derive: &ast::Attr) -> Option<Vec<SyntaxNode>> {
 156         self.imp.expand_derive_macro(derive)
 157     }
 158
 159     pub fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
 160         self.imp.is_attr_macro_call(item)
 161     }
 162
 163     pub fn speculative_expand(
 164         &self,
 165         actual_macro_call: &ast::MacroCall,
 166         speculative_args: &ast::TokenTree,
 167         token_to_map: SyntaxToken,
 168     ) -> Option<(SyntaxNode, SyntaxToken)> {
 169         self.imp.speculative_expand(actual_macro_call, speculative_args, token_to_map)
 170     }
 171
 172     pub fn speculative_expand_attr_macro(
 173         &self,
 174         actual_macro_call: &ast::Item,
 175         speculative_args: &ast::Item,
 176         token_to_map: SyntaxToken,
 177     ) -> Option<(SyntaxNode, SyntaxToken)> {
 178         self.imp.speculative_expand_attr(actual_macro_call, speculative_args, token_to_map)
 179     }
 180
 181     /// Descend the token into macrocalls to its first mapped counterpart.
 182     pub fn descend_into_macros_single(&self, token: SyntaxToken) -> SyntaxToken {
 183         self.imp.descend_into_macros_single(token)
 184     }
 185
 186     /// Descend the token into macrocalls to all its mapped counterparts.
 187     pub fn descend_into_macros(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
 188         self.imp.descend_into_macros(token)
 189     }
 190
 191     /// Maps a node down by mapping its first and last token down.
 192     pub fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
 193         self.imp.descend_node_into_attributes(node)
 194     }
 195
 196     /// Search for a definition's source and cache its syntax tree
 197     pub fn source<Def: HasSource>(&self, def: Def) -> Option<InFile<Def::Ast>>
 198     where
 199         Def::Ast: AstNode,
 200     {
 201         self.imp.source(def)
 202     }
 203
 204     pub fn hir_file_for(&self, syntax_node: &SyntaxNode) -> HirFileId {
 205         self.imp.find_file(syntax_node.clone()).file_id
 206     }
 207
 208     pub fn original_range(&self, node: &SyntaxNode) -> FileRange {
 209         self.imp.original_range(node)
 210     }
 211
 212     pub fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
 213         self.imp.original_range_opt(node)
 214     }
 215
 216     pub fn original_ast_node<N: AstNode>(&self, node: N) -> Option<N> {
 217         self.imp.original_ast_node(node)
 218     }
 219
 220     pub fn diagnostics_display_range(&self, diagnostics: InFile<SyntaxNodePtr>) -> FileRange {
 221         self.imp.diagnostics_display_range(diagnostics)
 222     }
 223
 224     pub fn token_ancestors_with_macros(
 225         &self,
 226         token: SyntaxToken,
 227     ) -> impl Iterator<Item = SyntaxNode> + '_ {
 228         token.parent().into_iter().flat_map(move |it| self.ancestors_with_macros(it))
 229     }
 230
 231     /// Iterates the ancestors of the given node, climbing up macro expansions while doing so.
 232     pub fn ancestors_with_macros(&self, node: SyntaxNode) -> impl Iterator<Item = SyntaxNode> + '_ {
 233         self.imp.ancestors_with_macros(node)
 234     }
 235
 236     pub fn ancestors_at_offset_with_macros(
 237         &self,
 238         node: &SyntaxNode,
 239         offset: TextSize,
 240     ) -> impl Iterator<Item = SyntaxNode> + '_ {
 241         self.imp.ancestors_at_offset_with_macros(node, offset)
 242     }
 243
 244     /// Find an AstNode by offset inside SyntaxNode, if it is inside *Macrofile*,
 245     /// search up until it is of the target AstNode type
 246     pub fn find_node_at_offset_with_macros<N: AstNode>(
 247         &self,
 248         node: &SyntaxNode,
 249         offset: TextSize,
 250     ) -> Option<N> {
 251         self.imp.ancestors_at_offset_with_macros(node, offset).find_map(N::cast)
 252     }
 253
 254     /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
 255     /// descend it and find again
 256     pub fn find_node_at_offset_with_descend<N: AstNode>(
 257         &self,
 258         node: &SyntaxNode,
 259         offset: TextSize,
 260     ) -> Option<N> {
 261         self.imp.descend_node_at_offset(node, offset).flatten().find_map(N::cast)
 262     }
 263
 264     /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
 265     /// descend it and find again
 266     pub fn find_nodes_at_offset_with_descend<'slf, N: AstNode + 'slf>(
 267         &'slf self,
 268         node: &SyntaxNode,
 269         offset: TextSize,
 270     ) -> impl Iterator<Item = N> + 'slf {
 271         self.imp.descend_node_at_offset(node, offset).filter_map(|mut it| it.find_map(N::cast))
 272     }
 273
 274     pub fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
 275         self.imp.resolve_lifetime_param(lifetime)
 276     }
 277
 278     pub fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
 279         self.imp.resolve_label(lifetime)
 280     }
 281
 282     pub fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
 283         self.imp.resolve_type(ty)
 284     }
 285
 286     pub fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
 287         self.imp.type_of_expr(expr)
 288     }
 289
 290     pub fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
 291         self.imp.type_of_pat(pat)
 292     }
 293
 294     pub fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
 295         self.imp.type_of_self(param)
 296     }
 297
 298     pub fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<Function> {
 299         self.imp.resolve_method_call(call).map(Function::from)
 300     }
 301
 302     pub fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
 303         self.imp.resolve_method_call_as_callable(call)
 304     }
 305
 306     pub fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
 307         self.imp.resolve_field(field)
 308     }
 309
 310     pub fn resolve_record_field(
 311         &self,
 312         field: &ast::RecordExprField,
 313     ) -> Option<(Field, Option<Local>, Type)> {
 314         self.imp.resolve_record_field(field)
 315     }
 316
 317     pub fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
 318         self.imp.resolve_record_pat_field(field)
 319     }
 320
 321     pub fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
 322         self.imp.resolve_macro_call(macro_call)
 323     }
 324
 325     pub fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
 326         self.imp.resolve_attr_macro_call(item)
 327     }
 328
 329     pub fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
 330         self.imp.resolve_path(path)
 331     }
 332
 333     pub fn resolve_path_as_macro(&self, path: &ast::Path) -> Option<MacroDef> {
 334         self.imp.resolve_path_as_macro(path)
 335     }
 336
 337     pub fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
 338         self.imp.resolve_extern_crate(extern_crate)
 339     }
 340
 341     pub fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantDef> {
 342         self.imp.resolve_variant(record_lit).map(VariantDef::from)
 343     }
 344
 345     pub fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
 346         self.imp.resolve_bind_pat_to_const(pat)
 347     }
 348
 349     // FIXME: use this instead?
 350     // pub fn resolve_name_ref(&self, name_ref: &ast::NameRef) -> Option<???>;
 351
 352     pub fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
 353         self.imp.record_literal_missing_fields(literal)
 354     }
 355
 356     pub fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
 357         self.imp.record_pattern_missing_fields(pattern)
 358     }
 359
 360     pub fn to_def<T: ToDef>(&self, src: &T) -> Option<T::Def> {
 361         let src = self.imp.find_file(src.syntax().clone()).with_value(src).cloned();
 362         T::to_def(&self.imp, src)
 363     }
 364
 365     pub fn to_module_def(&self, file: FileId) -> Option<Module> {
 366         self.imp.to_module_def(file).next()
 367     }
 368
 369     pub fn to_module_defs(&self, file: FileId) -> impl Iterator<Item = Module> {
 370         self.imp.to_module_def(file)
 371     }
 372
 373     pub fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
 374         self.imp.scope(node)
 375     }
 376
 377     pub fn scope_at_offset(&self, token: &SyntaxToken, offset: TextSize) -> SemanticsScope<'db> {
 378         self.imp.scope_at_offset(&token.parent().unwrap(), offset)
 379     }
 380
 381     pub fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
 382         self.imp.scope_for_def(def)
 383     }
 384
 385     pub fn assert_contains_node(&self, node: &SyntaxNode) {
 386         self.imp.assert_contains_node(node)
 387     }
 388
 389     pub fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
 390         self.imp.is_unsafe_method_call(method_call_expr)
 391     }
 392
 393     pub fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
 394         self.imp.is_unsafe_ref_expr(ref_expr)
 395     }
 396
 397     pub fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
 398         self.imp.is_unsafe_ident_pat(ident_pat)
 399     }
 400 }
 401
 402 impl<'db> SemanticsImpl<'db> {
 403     fn new(db: &'db dyn HirDatabase) -> Self {
 404         SemanticsImpl {
 405             db,
 406             s2d_cache: Default::default(),
 407             cache: Default::default(),
 408             expansion_info_cache: Default::default(),
 409             macro_call_cache: Default::default(),
 410         }
 411     }
 412
 413     fn parse(&self, file_id: FileId) -> ast::SourceFile {
 414         let tree = self.db.parse(file_id).tree();
 415         self.cache(tree.syntax().clone(), file_id.into());
 416         tree
 417     }
 418
 419     fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
 420         let sa = self.analyze(macro_call.syntax());
 421         let file_id = sa.expand(self.db, InFile::new(sa.file_id, macro_call))?;
 422         let node = self.db.parse_or_expand(file_id)?;
 423         self.cache(node.clone(), file_id);
 424         Some(node)
 425     }
 426
 427     fn expand_attr_macro(&self, item: &ast::Item) -> Option<SyntaxNode> {
 428         let sa = self.analyze(item.syntax());
 429         let src = InFile::new(sa.file_id, item.clone());
 430         let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(src))?;
 431         let file_id = macro_call_id.as_file();
 432         let node = self.db.parse_or_expand(file_id)?;
 433         self.cache(node.clone(), file_id);
 434         Some(node)
 435     }
 436
 437     fn expand_derive_macro(&self, attr: &ast::Attr) -> Option<Vec<SyntaxNode>> {
 438         let item = attr.syntax().parent().and_then(ast::Item::cast)?;
 439         let sa = self.analyze(item.syntax());
 440         let item = InFile::new(sa.file_id, &item);
 441         let src = InFile::new(sa.file_id, attr.clone());
 442         self.with_ctx(|ctx| {
 443             let macro_call_ids = ctx.attr_to_derive_macro_call(item, src)?;
 444
 445             let expansions: Vec<_> = macro_call_ids
 446                 .iter()
 447                 .map(|call| call.as_file())
 448                 .flat_map(|file_id| {
 449                     let node = self.db.parse_or_expand(file_id)?;
 450                     self.cache(node.clone(), file_id);
 451                     Some(node)
 452                 })
 453                 .collect();
 454             if expansions.is_empty() {
 455                 None
 456             } else {
 457                 Some(expansions)
 458             }
 459         })
 460     }
 461
 462     fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
 463         let sa = self.analyze(item.syntax());
 464         let src = InFile::new(sa.file_id, item.clone());
 465         self.with_ctx(|ctx| ctx.item_to_macro_call(src).is_some())
 466     }
 467
 468     fn speculative_expand(
 469         &self,
 470         actual_macro_call: &ast::MacroCall,
 471         speculative_args: &ast::TokenTree,
 472         token_to_map: SyntaxToken,
 473     ) -> Option<(SyntaxNode, SyntaxToken)> {
 474         let sa = self.analyze(actual_macro_call.syntax());
 475         let macro_call = InFile::new(sa.file_id, actual_macro_call);
 476         let krate = sa.resolver.krate()?;
 477         let macro_call_id = macro_call.as_call_id(self.db.upcast(), krate, |path| {
 478             sa.resolver.resolve_path_as_macro(self.db.upcast(), &path)
 479         })?;
 480         hir_expand::db::expand_speculative(
 481             self.db.upcast(),
 482             macro_call_id,
 483             speculative_args.syntax(),
 484             token_to_map,
 485         )
 486     }
 487
 488     fn speculative_expand_attr(
 489         &self,
 490         actual_macro_call: &ast::Item,
 491         speculative_args: &ast::Item,
 492         token_to_map: SyntaxToken,
 493     ) -> Option<(SyntaxNode, SyntaxToken)> {
 494         let sa = self.analyze(actual_macro_call.syntax());
 495         let macro_call = InFile::new(sa.file_id, actual_macro_call.clone());
 496         let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(macro_call))?;
 497         hir_expand::db::expand_speculative(
 498             self.db.upcast(),
 499             macro_call_id,
 500             speculative_args.syntax(),
 501             token_to_map,
 502         )
 503     }
 504
 505     // This might not be the correct way to do this, but it works for now
 506     fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
 507         let mut res = smallvec![];
 508         let tokens = (|| {
 509             let first = skip_trivia_token(node.syntax().first_token()?, Direction::Next)?;
 510             let last = skip_trivia_token(node.syntax().last_token()?, Direction::Prev)?;
 511             Some((first, last))
 512         })();
 513         let (first, last) = match tokens {
 514             Some(it) => it,
 515             None => return res,
 516         };
 517
 518         if first == last {
 519             self.descend_into_macros_impl(
 520                 first,
 521                 |InFile { value, .. }| {
 522                     if let Some(node) = value.ancestors().find_map(N::cast) {
 523                         res.push(node)
 524                     }
 525                 },
 526                 false,
 527             );
 528         } else {
 529             // Descend first and last token, then zip them to look for the node they belong to
 530             let mut scratch: SmallVec<[_; 1]> = smallvec![];
 531             self.descend_into_macros_impl(
 532                 first,
 533                 |token| {
 534                     scratch.push(token);
 535                 },
 536                 false,
 537             );
 538
 539             let mut scratch = scratch.into_iter();
 540             self.descend_into_macros_impl(
 541                 last,
 542                 |InFile { value: last, file_id: last_fid }| {
 543                     if let Some(InFile { value: first, file_id: first_fid }) = scratch.next() {
 544                         if first_fid == last_fid {
 545                             if let Some(p) = first.parent() {
 546                                 let range = first.text_range().cover(last.text_range());
 547                                 let node = find_root(&p)
 548                                     .covering_element(range)
 549                                     .ancestors()
 550                                     .take_while(|it| it.text_range() == range)
 551                                     .find_map(N::cast);
 552                                 if let Some(node) = node {
 553                                     res.push(node);
 554                                 }
 555                             }
 556                         }
 557                     }
 558                 },
 559                 false,
 560             );
 561         }
 562         res
 563     }
 564
 565     fn descend_into_macros(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
 566         let mut res = smallvec![];
 567         self.descend_into_macros_impl(token, |InFile { value, .. }| res.push(value), false);
 568         res
 569     }
 570
 571     fn descend_into_macros_single(&self, token: SyntaxToken) -> SyntaxToken {
 572         let mut res = token.clone();
 573         self.descend_into_macros_impl(token, |InFile { value, .. }| res = value, true);
 574         res
 575     }
 576
 577     fn descend_into_macros_impl(
 578         &self,
 579         token: SyntaxToken,
 580         mut f: impl FnMut(InFile<SyntaxToken>),
 581         single: bool,
 582     ) {
 583         let _p = profile::span("descend_into_macros");
 584         let parent = match token.parent() {
 585             Some(it) => it,
 586             None => return,
 587         };
 588         let sa = self.analyze(&parent);
 589         let mut stack: SmallVec<[_; 4]> = smallvec![InFile::new(sa.file_id, token)];
 590         let mut cache = self.expansion_info_cache.borrow_mut();
 591         let mut mcache = self.macro_call_cache.borrow_mut();
 592
 593         let mut process_expansion_for_token =
 594             |stack: &mut SmallVec<_>, macro_file, item, token: InFile<&_>| {
 595                 let expansion_info = cache
 596                     .entry(macro_file)
 597                     .or_insert_with(|| macro_file.expansion_info(self.db.upcast()))
 598                     .as_ref()?;
 599
 600                 {
 601                     let InFile { file_id, value } = expansion_info.expanded();
 602                     self.cache(value, file_id);
 603                 }
 604
 605                 let mut mapped_tokens =
 606                     expansion_info.map_token_down(self.db.upcast(), item, token)?;
 607
 608                 let len = stack.len();
 609                 // requeue the tokens we got from mapping our current token down
 610                 if single {
 611                     stack.extend(mapped_tokens.next());
 612                 } else {
 613                     stack.extend(mapped_tokens);
 614                 }
 615                 // if the length changed we have found a mapping for the token
 616                 (stack.len() != len).then(|| ())
 617             };
 618
 619         // Remap the next token in the queue into a macro call its in, if it is not being remapped
 620         // either due to not being in a macro-call or because its unused push it into the result vec,
 621         // otherwise push the remapped tokens back into the queue as they can potentially be remapped again.
 622         while let Some(token) = stack.pop() {
 623             self.db.unwind_if_cancelled();
 624             let was_not_remapped = (|| {
 625                 // are we inside an attribute macro call
 626                 let containing_attribute_macro_call = self.with_ctx(|ctx| {
 627                     token.value.ancestors().filter_map(ast::Item::cast).find_map(|item| {
 628                         if item.attrs().next().is_none() {
 629                             // Don't force populate the dyn cache for items that don't have an attribute anyways
 630                             return None;
 631                         }
 632                         Some((ctx.item_to_macro_call(token.with_value(item.clone()))?, item))
 633                     })
 634                 });
 635                 if let Some((call_id, item)) = containing_attribute_macro_call {
 636                     let file_id = call_id.as_file();
 637                     return process_expansion_for_token(
 638                         &mut stack,
 639                         file_id,
 640                         Some(item),
 641                         token.as_ref(),
 642                     );
 643                 }
 644
 645                 // or are we inside a function-like macro call
 646                 if let Some(tt) =
 647                     // FIXME replace map.while_some with take_while once stable
 648                     token.value.ancestors().map(ast::TokenTree::cast).while_some().last()
 649                 {
 650                     let macro_call = tt.syntax().parent().and_then(ast::MacroCall::cast)?;
 651                     if tt.left_delimiter_token().map_or(false, |it| it == token.value) {
 652                         return None;
 653                     }
 654                     if tt.right_delimiter_token().map_or(false, |it| it == token.value) {
 655                         return None;
 656                     }
 657
 658                     let mcall = token.with_value(macro_call);
 659                     let file_id = match mcache.get(&mcall) {
 660                         Some(&it) => it,
 661                         None => {
 662                             let it = sa.expand(self.db, mcall.as_ref())?;
 663                             mcache.insert(mcall, it);
 664                             it
 665                         }
 666                     };
 667                     return process_expansion_for_token(&mut stack, file_id, None, token.as_ref());
 668                 }
 669
 670                 // outside of a macro invocation so this is a "final" token
 671                 None
 672             })()
 673             .is_none();
 674
 675             if was_not_remapped {
 676                 f(token)
 677             }
 678         }
 679     }
 680
 681     // Note this return type is deliberate as [`find_nodes_at_offset_with_descend`] wants to stop
 682     // traversing the inner iterator when it finds a node.
 683     // The outer iterator is over the tokens descendants
 684     // The inner iterator is the ancestors of a descendant
 685     fn descend_node_at_offset(
 686         &self,
 687         node: &SyntaxNode,
 688         offset: TextSize,
 689     ) -> impl Iterator<Item = impl Iterator<Item = SyntaxNode> + '_> + '_ {
 690         node.token_at_offset(offset)
 691             .map(move |token| self.descend_into_macros(token))
 692             .map(|descendants| {
 693                 descendants.into_iter().map(move |it| self.token_ancestors_with_macros(it))
 694             })
 695             // re-order the tokens from token_at_offset by returning the ancestors with the smaller first nodes first
 696             // See algo::ancestors_at_offset, which uses the same approach
 697             .kmerge_by(|left, right| {
 698                 left.clone()
 699                     .map(|node| node.text_range().len())
 700                     .lt(right.clone().map(|node| node.text_range().len()))
 701             })
 702     }
 703
 704     fn original_range(&self, node: &SyntaxNode) -> FileRange {
 705         let node = self.find_file(node.clone());
 706         node.as_ref().original_file_range(self.db.upcast())
 707     }
 708
 709     fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
 710         let node = self.find_file(node.clone());
 711         node.as_ref().original_file_range_opt(self.db.upcast())
 712     }
 713
 714     fn original_ast_node<N: AstNode>(&self, node: N) -> Option<N> {
 715         let file = self.find_file(node.syntax().clone());
 716         file.with_value(node).original_ast_node(self.db.upcast()).map(|it| it.value)
 717     }
 718
 719     fn diagnostics_display_range(&self, src: InFile<SyntaxNodePtr>) -> FileRange {
 720         let root = self.db.parse_or_expand(src.file_id).unwrap();
 721         let node = src.value.to_node(&root);
 722         self.cache(root, src.file_id);
 723         src.with_value(&node).original_file_range(self.db.upcast())
 724     }
 725
 726     fn token_ancestors_with_macros(
 727         &self,
 728         token: SyntaxToken,
 729     ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
 730         token.parent().into_iter().flat_map(move |parent| self.ancestors_with_macros(parent))
 731     }
 732
 733     fn ancestors_with_macros(
 734         &self,
 735         node: SyntaxNode,
 736     ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
 737         let node = self.find_file(node);
 738         node.ancestors_with_macros(self.db.upcast()).map(|it| it.value)
 739     }
 740
 741     fn ancestors_at_offset_with_macros(
 742         &self,
 743         node: &SyntaxNode,
 744         offset: TextSize,
 745     ) -> impl Iterator<Item = SyntaxNode> + '_ {
 746         node.token_at_offset(offset)
 747             .map(|token| self.token_ancestors_with_macros(token))
 748             .kmerge_by(|node1, node2| node1.text_range().len() < node2.text_range().len())
 749     }
 750
 751     fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
 752         let text = lifetime.text();
 753         let lifetime_param = lifetime.syntax().ancestors().find_map(|syn| {
 754             let gpl = ast::AnyHasGenericParams::cast(syn)?.generic_param_list()?;
 755             gpl.lifetime_params()
 756                 .find(|tp| tp.lifetime().as_ref().map(|lt| lt.text()).as_ref() == Some(&text))
 757         })?;
 758         let src = self.find_file(lifetime_param.syntax().clone()).with_value(lifetime_param);
 759         ToDef::to_def(self, src)
 760     }
 761
 762     fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
 763         let text = lifetime.text();
 764         let label = lifetime.syntax().ancestors().find_map(|syn| {
 765             let label = match_ast! {
 766                 match syn {
 767                     ast::ForExpr(it) => it.label(),
 768                     ast::WhileExpr(it) => it.label(),
 769                     ast::LoopExpr(it) => it.label(),
 770                     ast::BlockExpr(it) => it.label(),
 771                     _ => None,
 772                 }
 773             };
 774             label.filter(|l| {
 775                 l.lifetime()
 776                     .and_then(|lt| lt.lifetime_ident_token())
 777                     .map_or(false, |lt| lt.text() == text)
 778             })
 779         })?;
 780         let src = self.find_file(label.syntax().clone()).with_value(label);
 781         ToDef::to_def(self, src)
 782     }
 783
 784     fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
 785         let scope = self.scope(ty.syntax());
 786         let ctx = body::LowerCtx::new(self.db.upcast(), scope.file_id);
 787         let ty = hir_ty::TyLoweringContext::new(self.db, &scope.resolver)
 788             .lower_ty(&crate::TypeRef::from_ast(&ctx, ty.clone()));
 789         Type::new_with_resolver(self.db, &scope.resolver, ty)
 790     }
 791
 792     fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
 793         self.analyze(expr.syntax())
 794             .type_of_expr(self.db, expr)
 795             .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
 796     }
 797
 798     fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
 799         self.analyze(pat.syntax())
 800             .type_of_pat(self.db, pat)
 801             .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
 802     }
 803
 804     fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
 805         self.analyze(param.syntax()).type_of_self(self.db, param)
 806     }
 807
 808     fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<FunctionId> {
 809         self.analyze(call.syntax()).resolve_method_call(self.db, call).map(|(id, _)| id)
 810     }
 811
 812     fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
 813         let (func, subst) = self.analyze(call.syntax()).resolve_method_call(self.db, call)?;
 814         let ty = self.db.value_ty(func.into()).substitute(&Interner, &subst);
 815         let resolver = self.analyze(call.syntax()).resolver;
 816         let ty = Type::new_with_resolver(self.db, &resolver, ty)?;
 817         let mut res = ty.as_callable(self.db)?;
 818         res.is_bound_method = true;
 819         Some(res)
 820     }
 821
 822     fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
 823         self.analyze(field.syntax()).resolve_field(self.db, field)
 824     }
 825
 826     fn resolve_record_field(
 827         &self,
 828         field: &ast::RecordExprField,
 829     ) -> Option<(Field, Option<Local>, Type)> {
 830         self.analyze(field.syntax()).resolve_record_field(self.db, field)
 831     }
 832
 833     fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
 834         self.analyze(field.syntax()).resolve_record_pat_field(self.db, field)
 835     }
 836
 837     fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
 838         let sa = self.analyze(macro_call.syntax());
 839         let macro_call = self.find_file(macro_call.syntax().clone()).with_value(macro_call);
 840         sa.resolve_macro_call(self.db, macro_call)
 841     }
 842
 843     fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
 844         let item_in_file = self.find_file(item.syntax().clone()).with_value(item.clone());
 845         let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(item_in_file))?;
 846         Some(MacroDef { id: self.db.lookup_intern_macro_call(macro_call_id).def })
 847     }
 848
 849     fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
 850         self.analyze(path.syntax()).resolve_path(self.db, path)
 851     }
 852
 853     // FIXME: This shouldn't exist, but is currently required to always resolve attribute paths in
 854     // the IDE layer due to namespace collisions
 855     fn resolve_path_as_macro(&self, path: &ast::Path) -> Option<MacroDef> {
 856         self.analyze(path.syntax()).resolve_path_as_macro(self.db, path)
 857     }
 858
 859     fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
 860         let krate = self.scope(extern_crate.syntax()).krate()?;
 861         krate.dependencies(self.db).into_iter().find_map(|dep| {
 862             if dep.name == extern_crate.name_ref()?.as_name() {
 863                 Some(dep.krate)
 864             } else {
 865                 None
 866             }
 867         })
 868     }
 869
 870     fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantId> {
 871         self.analyze(record_lit.syntax()).resolve_variant(self.db, record_lit)
 872     }
 873
 874     fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
 875         self.analyze(pat.syntax()).resolve_bind_pat_to_const(self.db, pat)
 876     }
 877
 878     fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
 879         self.analyze(literal.syntax())
 880             .record_literal_missing_fields(self.db, literal)
 881             .unwrap_or_default()
 882     }
 883
 884     fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
 885         self.analyze(pattern.syntax())
 886             .record_pattern_missing_fields(self.db, pattern)
 887             .unwrap_or_default()
 888     }
 889
 890     fn with_ctx<F: FnOnce(&mut SourceToDefCtx) -> T, T>(&self, f: F) -> T {
 891         let mut cache = self.s2d_cache.borrow_mut();
 892         let mut ctx = SourceToDefCtx { db: self.db, cache: &mut *cache };
 893         f(&mut ctx)
 894     }
 895
 896     fn to_module_def(&self, file: FileId) -> impl Iterator<Item = Module> {
 897         self.with_ctx(|ctx| ctx.file_to_def(file)).into_iter().map(Module::from)
 898     }
 899
 900     fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
 901         let SourceAnalyzer { file_id, resolver, .. } = self.analyze(node);
 902         SemanticsScope { db: self.db, file_id, resolver }
 903     }
 904
 905     fn scope_at_offset(&self, node: &SyntaxNode, offset: TextSize) -> SemanticsScope<'db> {
 906         let SourceAnalyzer { file_id, resolver, .. } = self.analyze_with_offset(node, offset);
 907         SemanticsScope { db: self.db, file_id, resolver }
 908     }
 909
 910     fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
 911         let file_id = self.db.lookup_intern_trait(def.id).id.file_id();
 912         let resolver = def.id.resolver(self.db.upcast());
 913         SemanticsScope { db: self.db, file_id, resolver }
 914     }
 915
 916     fn source<Def: HasSource>(&self, def: Def) -> Option<InFile<Def::Ast>>
 917     where
 918         Def::Ast: AstNode,
 919     {
 920         let res = def.source(self.db)?;
 921         self.cache(find_root(res.value.syntax()), res.file_id);
 922         Some(res)
 923     }
 924
 925     fn analyze(&self, node: &SyntaxNode) -> SourceAnalyzer {
 926         self.analyze_impl(node, None)
 927     }
 928
 929     fn analyze_with_offset(&self, node: &SyntaxNode, offset: TextSize) -> SourceAnalyzer {
 930         self.analyze_impl(node, Some(offset))
 931     }
 932
 933     fn analyze_impl(&self, node: &SyntaxNode, offset: Option<TextSize>) -> SourceAnalyzer {
 934         let _p = profile::span("Semantics::analyze_impl");
 935         let node = self.find_file(node.clone());
 936         let node = node.as_ref();
 937
 938         let container = match self.with_ctx(|ctx| ctx.find_container(node)) {
 939             Some(it) => it,
 940             None => return SourceAnalyzer::new_for_resolver(Resolver::default(), node),
 941         };
 942
 943         let resolver = match container {
 944             ChildContainer::DefWithBodyId(def) => {
 945                 return SourceAnalyzer::new_for_body(self.db, def, node, offset)
 946             }
 947             ChildContainer::TraitId(it) => it.resolver(self.db.upcast()),
 948             ChildContainer::ImplId(it) => it.resolver(self.db.upcast()),
 949             ChildContainer::ModuleId(it) => it.resolver(self.db.upcast()),
 950             ChildContainer::EnumId(it) => it.resolver(self.db.upcast()),
 951             ChildContainer::VariantId(it) => it.resolver(self.db.upcast()),
 952             ChildContainer::TypeAliasId(it) => it.resolver(self.db.upcast()),
 953             ChildContainer::GenericDefId(it) => it.resolver(self.db.upcast()),
 954         };
 955         SourceAnalyzer::new_for_resolver(resolver, node)
 956     }
 957
 958     fn cache(&self, root_node: SyntaxNode, file_id: HirFileId) {
 959         assert!(root_node.parent().is_none());
 960         let mut cache = self.cache.borrow_mut();
 961         let prev = cache.insert(root_node, file_id);
 962         assert!(prev == None || prev == Some(file_id))
 963     }
 964
 965     fn assert_contains_node(&self, node: &SyntaxNode) {
 966         self.find_file(node.clone());
 967     }
 968
 969     fn lookup(&self, root_node: &SyntaxNode) -> Option<HirFileId> {
 970         let cache = self.cache.borrow();
 971         cache.get(root_node).copied()
 972     }
 973
 974     fn find_file(&self, node: SyntaxNode) -> InFile<SyntaxNode> {
 975         let root_node = find_root(&node);
 976         let file_id = self.lookup(&root_node).unwrap_or_else(|| {
 977             panic!(
 978                 "\n\nFailed to lookup {:?} in this Semantics.\n\
 979                  Make sure to use only query nodes, derived from this instance of Semantics.\n\
 980                  root node:   {:?}\n\
 981                  known nodes: {}\n\n",
 982                 node,
 983                 root_node,
 984                 self.cache
 985                     .borrow()
 986                     .keys()
 987                     .map(|it| format!("{:?}", it))
 988                     .collect::<Vec<_>>()
 989                     .join(", ")
 990             )
 991         });
 992         InFile::new(file_id, node)
 993     }
 994
 995     fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
 996         method_call_expr
 997             .receiver()
 998             .and_then(|expr| {
 999                 let field_expr = match expr {
1000                     ast::Expr::FieldExpr(field_expr) => field_expr,
1001                     _ => return None,
1002                 };
1003                 let ty = self.type_of_expr(&field_expr.expr()?)?.original;
1004                 if !ty.is_packed(self.db) {
1005                     return None;
1006                 }
1007
1008                 let func = self.resolve_method_call(method_call_expr).map(Function::from)?;
1009                 let res = match func.self_param(self.db)?.access(self.db) {
1010                     Access::Shared | Access::Exclusive => true,
1011                     Access::Owned => false,
1012                 };
1013                 Some(res)
1014             })
1015             .unwrap_or(false)
1016     }
1017
1018     fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
1019         ref_expr
1020             .expr()
1021             .and_then(|expr| {
1022                 let field_expr = match expr {
1023                     ast::Expr::FieldExpr(field_expr) => field_expr,
1024                     _ => return None,
1025                 };
1026                 let expr = field_expr.expr()?;
1027                 self.type_of_expr(&expr)
1028             })
1029             // Binding a reference to a packed type is possibly unsafe.
1030             .map(|ty| ty.original.is_packed(self.db))
1031             .unwrap_or(false)
1032
1033         // FIXME This needs layout computation to be correct. It will highlight
1034         // more than it should with the current implementation.
1035     }
1036
1037     fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
1038         if ident_pat.ref_token().is_none() {
1039             return false;
1040         }
1041
1042         ident_pat
1043             .syntax()
1044             .parent()
1045             .and_then(|parent| {
1046                 // `IdentPat` can live under `RecordPat` directly under `RecordPatField` or
1047                 // `RecordPatFieldList`. `RecordPatField` also lives under `RecordPatFieldList`,
1048                 // so this tries to lookup the `IdentPat` anywhere along that structure to the
1049                 // `RecordPat` so we can get the containing type.
1050                 let record_pat = ast::RecordPatField::cast(parent.clone())
1051                     .and_then(|record_pat| record_pat.syntax().parent())
1052                     .or_else(|| Some(parent.clone()))
1053                     .and_then(|parent| {
1054                         ast::RecordPatFieldList::cast(parent)?
1055                             .syntax()
1056                             .parent()
1057                             .and_then(ast::RecordPat::cast)
1058                     });
1059
1060                 // If this doesn't match a `RecordPat`, fallback to a `LetStmt` to see if
1061                 // this is initialized from a `FieldExpr`.
1062                 if let Some(record_pat) = record_pat {
1063                     self.type_of_pat(&ast::Pat::RecordPat(record_pat))
1064                 } else if let Some(let_stmt) = ast::LetStmt::cast(parent) {
1065                     let field_expr = match let_stmt.initializer()? {
1066                         ast::Expr::FieldExpr(field_expr) => field_expr,
1067                         _ => return None,
1068                     };
1069
1070                     self.type_of_expr(&field_expr.expr()?)
1071                 } else {
1072                     None
1073                 }
1074             })
1075             // Binding a reference to a packed type is possibly unsafe.
1076             .map(|ty| ty.original.is_packed(self.db))
1077             .unwrap_or(false)
1078     }
1079 }
1080
1081 pub trait ToDef: AstNode + Clone {
1082     type Def;
1083
1084     fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def>;
1085 }
1086
1087 macro_rules! to_def_impls {
1088     ($(($def:path, $ast:path, $meth:ident)),* ,) => {$(
1089         impl ToDef for $ast {
1090             type Def = $def;
1091             fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def> {
1092                 sema.with_ctx(|ctx| ctx.$meth(src)).map(<$def>::from)
1093             }
1094         }
1095     )*}
1096 }
1097
1098 to_def_impls![
1099     (crate::Module, ast::Module, module_to_def),
1100     (crate::Module, ast::SourceFile, source_file_to_def),
1101     (crate::Struct, ast::Struct, struct_to_def),
1102     (crate::Enum, ast::Enum, enum_to_def),
1103     (crate::Union, ast::Union, union_to_def),
1104     (crate::Trait, ast::Trait, trait_to_def),
1105     (crate::Impl, ast::Impl, impl_to_def),
1106     (crate::TypeAlias, ast::TypeAlias, type_alias_to_def),
1107     (crate::Const, ast::Const, const_to_def),
1108     (crate::Static, ast::Static, static_to_def),
1109     (crate::Function, ast::Fn, fn_to_def),
1110     (crate::Field, ast::RecordField, record_field_to_def),
1111     (crate::Field, ast::TupleField, tuple_field_to_def),
1112     (crate::Variant, ast::Variant, enum_variant_to_def),
1113     (crate::TypeParam, ast::TypeParam, type_param_to_def),
1114     (crate::LifetimeParam, ast::LifetimeParam, lifetime_param_to_def),
1115     (crate::ConstParam, ast::ConstParam, const_param_to_def),
1116     (crate::MacroDef, ast::Macro, macro_to_def),
1117     (crate::Local, ast::IdentPat, bind_pat_to_def),
1118     (crate::Local, ast::SelfParam, self_param_to_def),
1119     (crate::Label, ast::Label, label_to_def),
1120     (crate::Adt, ast::Adt, adt_to_def),
1121 ];
1122
1123 fn find_root(node: &SyntaxNode) -> SyntaxNode {
1124     node.ancestors().last().unwrap()
1125 }
1126
1127 /// `SemanticScope` encapsulates the notion of a scope (the set of visible
1128 /// names) at a particular program point.
1129 ///
1130 /// It is a bit tricky, as scopes do not really exist inside the compiler.
1131 /// Rather, the compiler directly computes for each reference the definition it
1132 /// refers to. It might transiently compute the explicit scope map while doing
1133 /// so, but, generally, this is not something left after the analysis.
1134 ///
1135 /// However, we do very much need explicit scopes for IDE purposes --
1136 /// completion, at its core, lists the contents of the current scope. The notion
1137 /// of scope is also useful to answer questions like "what would be the meaning
1138 /// of this piece of code if we inserted it into this position?".
1139 ///
1140 /// So `SemanticsScope` is constructed from a specific program point (a syntax
1141 /// node or just a raw offset) and provides access to the set of visible names
1142 /// on a somewhat best-effort basis.
1143 ///
1144 /// Note that if you are wondering "what does this specific existing name mean?",
1145 /// you'd better use the `resolve_` family of methods.
1146 #[derive(Debug)]
1147 pub struct SemanticsScope<'a> {
1148     pub db: &'a dyn HirDatabase,
1149     file_id: HirFileId,
1150     resolver: Resolver,
1151 }
1152
1153 impl<'a> SemanticsScope<'a> {
1154     pub fn module(&self) -> Option<Module> {
1155         Some(Module { id: self.resolver.module()? })
1156     }
1157
1158     pub fn krate(&self) -> Option<Crate> {
1159         Some(Crate { id: self.resolver.krate()? })
1160     }
1161
1162     /// Note: `FxHashSet<TraitId>` should be treated as an opaque type, passed into `Type
1163     // FIXME: rename to visible_traits to not repeat scope?
1164     pub fn traits_in_scope(&self) -> FxHashSet<TraitId> {
1165         let resolver = &self.resolver;
1166         resolver.traits_in_scope(self.db.upcast())
1167     }
1168
1169     pub fn process_all_names(&self, f: &mut dyn FnMut(Name, ScopeDef)) {
1170         let scope = self.resolver.names_in_scope(self.db.upcast());
1171         for (name, entries) in scope {
1172             for entry in entries {
1173                 let def = match entry {
1174                     resolver::ScopeDef::ModuleDef(it) => ScopeDef::ModuleDef(it.into()),
1175                     resolver::ScopeDef::MacroDef(it) => ScopeDef::MacroDef(it.into()),
1176                     resolver::ScopeDef::Unknown => ScopeDef::Unknown,
1177                     resolver::ScopeDef::ImplSelfType(it) => ScopeDef::ImplSelfType(it.into()),
1178                     resolver::ScopeDef::AdtSelfType(it) => ScopeDef::AdtSelfType(it.into()),
1179                     resolver::ScopeDef::GenericParam(id) => ScopeDef::GenericParam(id.into()),
1180                     resolver::ScopeDef::Local(pat_id) => {
1181                         let parent = self.resolver.body_owner().unwrap();
1182                         ScopeDef::Local(Local { parent, pat_id })
1183                     }
1184                     resolver::ScopeDef::Label(label_id) => {
1185                         let parent = self.resolver.body_owner().unwrap();
1186                         ScopeDef::Label(Label { parent, label_id })
1187                     }
1188                 };
1189                 f(name.clone(), def)
1190             }
1191         }
1192     }
1193
1194     /// Resolve a path as-if it was written at the given scope. This is
1195     /// necessary a heuristic, as it doesn't take hygiene into account.
1196     pub fn speculative_resolve(&self, path: &ast::Path) -> Option<PathResolution> {
1197         let ctx = body::LowerCtx::new(self.db.upcast(), self.file_id);
1198         let path = Path::from_src(path.clone(), &ctx)?;
1199         resolve_hir_path(self.db, &self.resolver, &path)
1200     }
1201
1202     /// Resolve a path as-if it was written at the given scope. This is
1203     /// necessary a heuristic, as it doesn't take hygiene into account.
1204     // FIXME: This special casing solely exists for attributes for now
1205     // ideally we should have a path resolution infra that properly knows about overlapping namespaces
1206     pub fn speculative_resolve_as_mac(&self, path: &ast::Path) -> Option<MacroDef> {
1207         let ctx = body::LowerCtx::new(self.db.upcast(), self.file_id);
1208         let path = Path::from_src(path.clone(), &ctx)?;
1209         resolve_hir_path_as_macro(self.db, &self.resolver, &path)
1210     }
1211 }