src/tools/rust-analyzer/crates/hir/src/semantics.rs

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