crates/ide/src/syntax_highlighting/highlight.rs

   1 //! Computes color for a single element.
   2
   3 use hir::{AsAssocItem, HasVisibility, Semantics};
   4 use ide_db::{
   5     defs::{Definition, NameClass, NameRefClass},
   6     helpers::{try_resolve_derive_input, FamousDefs},
   7     RootDatabase, SymbolKind,
   8 };
   9 use rustc_hash::FxHashMap;
  10 use syntax::{
  11     ast, match_ast, AstNode, AstToken, NodeOrToken, SyntaxElement,
  12     SyntaxKind::{self, *},
  13     SyntaxNode, SyntaxToken, T,
  14 };
  15
  16 use crate::{
  17     syntax_highlighting::tags::{HlOperator, HlPunct},
  18     Highlight, HlMod, HlTag,
  19 };
  20
  21 pub(super) fn element(
  22     sema: &Semantics<RootDatabase>,
  23     krate: Option<hir::Crate>,
  24     bindings_shadow_count: &mut FxHashMap<hir::Name, u32>,
  25     syntactic_name_ref_highlighting: bool,
  26     element: SyntaxElement,
  27 ) -> Option<(Highlight, Option<u64>)> {
  28     match element {
  29         NodeOrToken::Node(it) => {
  30             node(sema, krate, bindings_shadow_count, syntactic_name_ref_highlighting, it)
  31         }
  32         NodeOrToken::Token(it) => Some((token(sema, krate, it)?, None)),
  33     }
  34 }
  35
  36 fn token(
  37     sema: &Semantics<RootDatabase>,
  38     krate: Option<hir::Crate>,
  39     token: SyntaxToken,
  40 ) -> Option<Highlight> {
  41     let highlight: Highlight = if let Some(comment) = ast::Comment::cast(token.clone()) {
  42         let h = HlTag::Comment;
  43         match comment.kind().doc {
  44             Some(_) => h | HlMod::Documentation,
  45             None => h.into(),
  46         }
  47     } else {
  48         match token.kind() {
  49             STRING | BYTE_STRING => HlTag::StringLiteral.into(),
  50             INT_NUMBER if token.ancestors().nth(1).map_or(false, |it| it.kind() == FIELD_EXPR) => {
  51                 SymbolKind::Field.into()
  52             }
  53             INT_NUMBER | FLOAT_NUMBER => HlTag::NumericLiteral.into(),
  54             BYTE => HlTag::ByteLiteral.into(),
  55             CHAR => HlTag::CharLiteral.into(),
  56             T![?] => HlTag::Operator(HlOperator::Other) | HlMod::ControlFlow,
  57             IDENT if parent_matches::<ast::TokenTree>(&token) => {
  58                 if let Some(attr) = token.ancestors().nth(2).and_then(ast::Attr::cast) {
  59                     match try_resolve_derive_input(sema, &attr, &ast::Ident::cast(token).unwrap()) {
  60                         Some(res) => highlight_def(sema, krate, Definition::from(res)),
  61                         None => HlTag::None.into(),
  62                     }
  63                 } else {
  64                     HlTag::None.into()
  65                 }
  66             }
  67             p if p.is_punct() => match p {
  68                 T![&] if parent_matches::<ast::BinExpr>(&token) => HlOperator::Bitwise.into(),
  69                 T![&] => {
  70                     let h = HlTag::Operator(HlOperator::Other).into();
  71                     let is_unsafe = token
  72                         .parent()
  73                         .and_then(ast::RefExpr::cast)
  74                         .map_or(false, |ref_expr| sema.is_unsafe_ref_expr(&ref_expr));
  75                     if is_unsafe {
  76                         h | HlMod::Unsafe
  77                     } else {
  78                         h
  79                     }
  80                 }
  81                 T![::] | T![->] | T![=>] | T![..] | T![=] | T![@] | T![.] => {
  82                     HlOperator::Other.into()
  83                 }
  84                 T![!] if parent_matches::<ast::MacroCall>(&token) => SymbolKind::Macro.into(),
  85                 T![!] if parent_matches::<ast::NeverType>(&token) => HlTag::BuiltinType.into(),
  86                 T![!] if parent_matches::<ast::PrefixExpr>(&token) => HlOperator::Logical.into(),
  87                 T![*] if parent_matches::<ast::PtrType>(&token) => HlTag::Keyword.into(),
  88                 T![*] if parent_matches::<ast::PrefixExpr>(&token) => {
  89                     let prefix_expr = token.parent().and_then(ast::PrefixExpr::cast)?;
  90
  91                     let expr = prefix_expr.expr()?;
  92                     let ty = sema.type_of_expr(&expr)?.original;
  93                     if ty.is_raw_ptr() {
  94                         HlTag::Operator(HlOperator::Other) | HlMod::Unsafe
  95                     } else if let Some(ast::UnaryOp::Deref) = prefix_expr.op_kind() {
  96                         HlOperator::Other.into()
  97                     } else {
  98                         HlPunct::Other.into()
  99                     }
 100                 }
 101                 T![-] if parent_matches::<ast::PrefixExpr>(&token) => {
 102                     let prefix_expr = token.parent().and_then(ast::PrefixExpr::cast)?;
 103
 104                     let expr = prefix_expr.expr()?;
 105                     match expr {
 106                         ast::Expr::Literal(_) => HlTag::NumericLiteral,
 107                         _ => HlTag::Operator(HlOperator::Other),
 108                     }
 109                     .into()
 110                 }
 111                 _ if parent_matches::<ast::PrefixExpr>(&token) => HlOperator::Other.into(),
 112                 T![+] | T![-] | T![*] | T![/] if parent_matches::<ast::BinExpr>(&token) => {
 113                     HlOperator::Arithmetic.into()
 114                 }
 115                 T![+=] | T![-=] | T![*=] | T![/=] if parent_matches::<ast::BinExpr>(&token) => {
 116                     Highlight::from(HlOperator::Arithmetic) | HlMod::Mutable
 117                 }
 118                 T![|] | T![&] | T![!] | T![^] if parent_matches::<ast::BinExpr>(&token) => {
 119                     HlOperator::Bitwise.into()
 120                 }
 121                 T![|=] | T![&=] | T![^=] if parent_matches::<ast::BinExpr>(&token) => {
 122                     Highlight::from(HlOperator::Bitwise) | HlMod::Mutable
 123                 }
 124                 T![&&] | T![||] if parent_matches::<ast::BinExpr>(&token) => {
 125                     HlOperator::Logical.into()
 126                 }
 127                 T![>] | T![<] | T![==] | T![>=] | T![<=] | T![!=]
 128                     if parent_matches::<ast::BinExpr>(&token) =>
 129                 {
 130                     HlOperator::Comparison.into()
 131                 }
 132                 _ if parent_matches::<ast::BinExpr>(&token) => HlOperator::Other.into(),
 133                 _ if parent_matches::<ast::RangeExpr>(&token) => HlOperator::Other.into(),
 134                 _ if parent_matches::<ast::RangePat>(&token) => HlOperator::Other.into(),
 135                 _ if parent_matches::<ast::RestPat>(&token) => HlOperator::Other.into(),
 136                 _ if parent_matches::<ast::Attr>(&token) => HlTag::AttributeBracket.into(),
 137                 kind => match kind {
 138                     T!['['] | T![']'] => HlPunct::Bracket,
 139                     T!['{'] | T!['}'] => HlPunct::Brace,
 140                     T!['('] | T![')'] => HlPunct::Parenthesis,
 141                     T![<] | T![>] => HlPunct::Angle,
 142                     T![,] => HlPunct::Comma,
 143                     T![:] => HlPunct::Colon,
 144                     T![;] => HlPunct::Semi,
 145                     T![.] => HlPunct::Dot,
 146                     _ => HlPunct::Other,
 147                 }
 148                 .into(),
 149             },
 150             k if k.is_keyword() => {
 151                 let h = Highlight::new(HlTag::Keyword);
 152                 match k {
 153                     T![await] => h | HlMod::Async | HlMod::ControlFlow,
 154                     T![break]
 155                     | T![continue]
 156                     | T![else]
 157                     | T![if]
 158                     | T![in]
 159                     | T![loop]
 160                     | T![match]
 161                     | T![return]
 162                     | T![while]
 163                     | T![yield] => h | HlMod::ControlFlow,
 164                     T![for] if !is_child_of_impl(&token) => h | HlMod::ControlFlow,
 165                     T![unsafe] => h | HlMod::Unsafe,
 166                     T![true] | T![false] => HlTag::BoolLiteral.into(),
 167                     // crate is handled just as a token if it's in an `extern crate`
 168                     T![crate] if parent_matches::<ast::ExternCrate>(&token) => h,
 169                     // self, crate and super are handled as either a Name or NameRef already
 170                     T![self] | T![crate] | T![super] => return None,
 171                     T![ref] => token
 172                         .parent()
 173                         .and_then(ast::IdentPat::cast)
 174                         .and_then(|ident_pat| {
 175                             (sema.is_unsafe_ident_pat(&ident_pat)).then(|| HlMod::Unsafe)
 176                         })
 177                         .map_or(h, |modifier| h | modifier),
 178                     T![async] => h | HlMod::Async,
 179                     _ => h,
 180                 }
 181             }
 182             _ => return None,
 183         }
 184     };
 185     Some(highlight)
 186 }
 187
 188 fn node(
 189     sema: &Semantics<RootDatabase>,
 190     krate: Option<hir::Crate>,
 191     bindings_shadow_count: &mut FxHashMap<hir::Name, u32>,
 192     syntactic_name_ref_highlighting: bool,
 193     node: SyntaxNode,
 194 ) -> Option<(Highlight, Option<u64>)> {
 195     let mut binding_hash = None;
 196     let highlight = match_ast! {
 197         match node {
 198             ast::Fn(__) => {
 199                 bindings_shadow_count.clear();
 200                 return None;
 201             },
 202             ast::Attr(__) => {
 203                 HlTag::AttributeBracket.into()
 204             },
 205             // Highlight definitions depending on the "type" of the definition.
 206             ast::Name(name) => {
 207                 highlight_name(sema, bindings_shadow_count, &mut binding_hash, krate, name)
 208             },
 209             // Highlight references like the definitions they resolve to
 210             ast::NameRef(name_ref) => {
 211                 highlight_name_ref(
 212                     sema,
 213                     krate,
 214                     bindings_shadow_count,
 215                     &mut binding_hash,
 216                     syntactic_name_ref_highlighting,
 217                     name_ref,
 218                 )
 219             },
 220             ast::Lifetime(lifetime) => {
 221                 match NameClass::classify_lifetime(sema, &lifetime) {
 222                     Some(NameClass::Definition(def)) => {
 223                         highlight_def(sema, krate, def) | HlMod::Definition
 224                     }
 225                     None => match NameRefClass::classify_lifetime(sema, &lifetime) {
 226                         Some(NameRefClass::Definition(def)) => highlight_def(sema, krate, def),
 227                         _ => SymbolKind::LifetimeParam.into(),
 228                     },
 229                     _ => Highlight::from(SymbolKind::LifetimeParam) | HlMod::Definition,
 230                 }
 231             },
 232             _ => return None,
 233         }
 234     };
 235     Some((highlight, binding_hash))
 236 }
 237
 238 fn highlight_name_ref(
 239     sema: &Semantics<RootDatabase>,
 240     krate: Option<hir::Crate>,
 241     bindings_shadow_count: &mut FxHashMap<hir::Name, u32>,
 242     binding_hash: &mut Option<u64>,
 243     syntactic_name_ref_highlighting: bool,
 244     name_ref: ast::NameRef,
 245 ) -> Highlight {
 246     let db = sema.db;
 247     if let Some(res) = highlight_method_call_by_name_ref(sema, krate, &name_ref) {
 248         return res;
 249     }
 250
 251     let name_class = match NameRefClass::classify(sema, &name_ref) {
 252         Some(name_kind) => name_kind,
 253         None if syntactic_name_ref_highlighting => {
 254             return highlight_name_ref_by_syntax(name_ref, sema, krate)
 255         }
 256         // FIXME: Workaround for https://github.com/rust-analyzer/rust-analyzer/issues/10708
 257         //
 258         // Some popular proc macros (namely async_trait) will rewrite `self` in such a way that it no
 259         // longer resolves via NameRefClass. If we can't be resolved, but we know we're a self token,
 260         // within a function with a self param, pretend to still be `self`, rather than
 261         // an unresolved reference.
 262         None if name_ref.self_token().is_some() && is_in_fn_with_self_param(&name_ref) => {
 263             return SymbolKind::SelfParam.into()
 264         }
 265         None => return HlTag::UnresolvedReference.into(),
 266     };
 267     let mut h = match name_class {
 268         NameRefClass::Definition(def) => {
 269             if let Definition::Local(local) = &def {
 270                 if let Some(name) = local.name(db) {
 271                     let shadow_count = bindings_shadow_count.entry(name.clone()).or_default();
 272                     *binding_hash = Some(calc_binding_hash(&name, *shadow_count))
 273                 }
 274             };
 275
 276             let mut h = highlight_def(sema, krate, def);
 277
 278             match def {
 279                 Definition::Local(local) if is_consumed_lvalue(name_ref.syntax(), &local, db) => {
 280                     h |= HlMod::Consuming;
 281                 }
 282                 Definition::Trait(trait_) if trait_.is_unsafe(db) => {
 283                     if ast::Impl::for_trait_name_ref(&name_ref)
 284                         .map_or(false, |impl_| impl_.unsafe_token().is_some())
 285                     {
 286                         h |= HlMod::Unsafe;
 287                     }
 288                 }
 289                 Definition::Field(field) => {
 290                     if let Some(parent) = name_ref.syntax().parent() {
 291                         if matches!(parent.kind(), FIELD_EXPR | RECORD_PAT_FIELD) {
 292                             if let hir::VariantDef::Union(_) = field.parent_def(db) {
 293                                 h |= HlMod::Unsafe;
 294                             }
 295                         }
 296                     }
 297                 }
 298                 _ => (),
 299             }
 300
 301             h
 302         }
 303         NameRefClass::FieldShorthand { .. } => SymbolKind::Field.into(),
 304     };
 305     if name_ref.self_token().is_some() {
 306         h.tag = HlTag::Symbol(SymbolKind::SelfParam);
 307     }
 308     if name_ref.crate_token().is_some() || name_ref.super_token().is_some() {
 309         h.tag = HlTag::Keyword;
 310     }
 311     h
 312 }
 313
 314 fn highlight_name(
 315     sema: &Semantics<RootDatabase>,
 316     bindings_shadow_count: &mut FxHashMap<hir::Name, u32>,
 317     binding_hash: &mut Option<u64>,
 318     krate: Option<hir::Crate>,
 319     name: ast::Name,
 320 ) -> Highlight {
 321     let db = sema.db;
 322     let name_kind = NameClass::classify(sema, &name);
 323     if let Some(NameClass::Definition(Definition::Local(local))) = &name_kind {
 324         if let Some(name) = local.name(db) {
 325             let shadow_count = bindings_shadow_count.entry(name.clone()).or_default();
 326             *shadow_count += 1;
 327             *binding_hash = Some(calc_binding_hash(&name, *shadow_count))
 328         }
 329     };
 330     match name_kind {
 331         Some(NameClass::Definition(def)) => {
 332             let mut h = highlight_def(sema, krate, def) | HlMod::Definition;
 333             if let Definition::Trait(trait_) = &def {
 334                 if trait_.is_unsafe(db) {
 335                     h |= HlMod::Unsafe;
 336                 }
 337             }
 338             h
 339         }
 340         Some(NameClass::ConstReference(def)) => highlight_def(sema, krate, def),
 341         Some(NameClass::PatFieldShorthand { field_ref, .. }) => {
 342             let mut h = HlTag::Symbol(SymbolKind::Field).into();
 343             if let hir::VariantDef::Union(_) = field_ref.parent_def(db) {
 344                 h |= HlMod::Unsafe;
 345             }
 346             h
 347         }
 348         None => highlight_name_by_syntax(name) | HlMod::Definition,
 349     }
 350 }
 351
 352 fn calc_binding_hash(name: &hir::Name, shadow_count: u32) -> u64 {
 353     fn hash<T: std::hash::Hash + std::fmt::Debug>(x: T) -> u64 {
 354         use std::{collections::hash_map::DefaultHasher, hash::Hasher};
 355
 356         let mut hasher = DefaultHasher::new();
 357         x.hash(&mut hasher);
 358         hasher.finish()
 359     }
 360
 361     hash((name, shadow_count))
 362 }
 363
 364 fn highlight_def(
 365     sema: &Semantics<RootDatabase>,
 366     krate: Option<hir::Crate>,
 367     def: Definition,
 368 ) -> Highlight {
 369     let db = sema.db;
 370     let mut h = match def {
 371         Definition::Macro(m) => Highlight::new(HlTag::Symbol(match m.kind() {
 372             hir::MacroKind::Declarative | hir::MacroKind::BuiltIn | hir::MacroKind::ProcMacro => {
 373                 SymbolKind::Macro
 374             }
 375             hir::MacroKind::Derive => SymbolKind::Derive,
 376             hir::MacroKind::Attr => SymbolKind::Attribute,
 377         })),
 378         Definition::Field(_) => Highlight::new(HlTag::Symbol(SymbolKind::Field)),
 379         Definition::Module(module) => {
 380             let mut h = Highlight::new(HlTag::Symbol(SymbolKind::Module));
 381             if module.parent(db).is_none() {
 382                 h |= HlMod::CrateRoot
 383             }
 384             h
 385         }
 386         Definition::Function(func) => {
 387             let mut h = Highlight::new(HlTag::Symbol(SymbolKind::Function));
 388             if let Some(item) = func.as_assoc_item(db) {
 389                 h |= HlMod::Associated;
 390                 match func.self_param(db) {
 391                     Some(sp) => match sp.access(db) {
 392                         hir::Access::Exclusive => {
 393                             h |= HlMod::Mutable;
 394                             h |= HlMod::Reference;
 395                         }
 396                         hir::Access::Shared => h |= HlMod::Reference,
 397                         hir::Access::Owned => h |= HlMod::Consuming,
 398                     },
 399                     None => h |= HlMod::Static,
 400                 }
 401
 402                 match item.container(db) {
 403                     hir::AssocItemContainer::Impl(i) => {
 404                         if i.trait_(db).is_some() {
 405                             h |= HlMod::Trait;
 406                         }
 407                     }
 408                     hir::AssocItemContainer::Trait(_t) => {
 409                         h |= HlMod::Trait;
 410                     }
 411                 }
 412             }
 413
 414             if func.is_unsafe(db) {
 415                 h |= HlMod::Unsafe;
 416             }
 417             if func.is_async(db) {
 418                 h |= HlMod::Async;
 419             }
 420
 421             h
 422         }
 423         Definition::Adt(adt) => {
 424             let h = match adt {
 425                 hir::Adt::Struct(_) => HlTag::Symbol(SymbolKind::Struct),
 426                 hir::Adt::Enum(_) => HlTag::Symbol(SymbolKind::Enum),
 427                 hir::Adt::Union(_) => HlTag::Symbol(SymbolKind::Union),
 428             };
 429
 430             Highlight::new(h)
 431         }
 432         Definition::Variant(_) => Highlight::new(HlTag::Symbol(SymbolKind::Variant)),
 433         Definition::Const(konst) => {
 434             let mut h = Highlight::new(HlTag::Symbol(SymbolKind::Const));
 435
 436             if let Some(item) = konst.as_assoc_item(db) {
 437                 h |= HlMod::Associated;
 438                 match item.container(db) {
 439                     hir::AssocItemContainer::Impl(i) => {
 440                         if i.trait_(db).is_some() {
 441                             h |= HlMod::Trait;
 442                         }
 443                     }
 444                     hir::AssocItemContainer::Trait(_t) => {
 445                         h |= HlMod::Trait;
 446                     }
 447                 }
 448             }
 449
 450             h
 451         }
 452         Definition::Trait(_) => Highlight::new(HlTag::Symbol(SymbolKind::Trait)),
 453         Definition::TypeAlias(type_) => {
 454             let mut h = Highlight::new(HlTag::Symbol(SymbolKind::TypeAlias));
 455
 456             if let Some(item) = type_.as_assoc_item(db) {
 457                 h |= HlMod::Associated;
 458                 match item.container(db) {
 459                     hir::AssocItemContainer::Impl(i) => {
 460                         if i.trait_(db).is_some() {
 461                             h |= HlMod::Trait;
 462                         }
 463                     }
 464                     hir::AssocItemContainer::Trait(_t) => {
 465                         h |= HlMod::Trait;
 466                     }
 467                 }
 468             }
 469
 470             h
 471         }
 472         Definition::BuiltinType(_) => Highlight::new(HlTag::BuiltinType),
 473         Definition::Static(s) => {
 474             let mut h = Highlight::new(HlTag::Symbol(SymbolKind::Static));
 475
 476             if s.is_mut(db) {
 477                 h |= HlMod::Mutable;
 478                 h |= HlMod::Unsafe;
 479             }
 480
 481             h
 482         }
 483         Definition::SelfType(_) => Highlight::new(HlTag::Symbol(SymbolKind::Impl)),
 484         Definition::GenericParam(it) => match it {
 485             hir::GenericParam::TypeParam(_) => Highlight::new(HlTag::Symbol(SymbolKind::TypeParam)),
 486             hir::GenericParam::ConstParam(_) => {
 487                 Highlight::new(HlTag::Symbol(SymbolKind::ConstParam))
 488             }
 489             hir::GenericParam::LifetimeParam(_) => {
 490                 Highlight::new(HlTag::Symbol(SymbolKind::LifetimeParam))
 491             }
 492         },
 493         Definition::Local(local) => {
 494             let tag = if local.is_self(db) {
 495                 HlTag::Symbol(SymbolKind::SelfParam)
 496             } else if local.is_param(db) {
 497                 HlTag::Symbol(SymbolKind::ValueParam)
 498             } else {
 499                 HlTag::Symbol(SymbolKind::Local)
 500             };
 501             let mut h = Highlight::new(tag);
 502             let ty = local.ty(db);
 503             if local.is_mut(db) || ty.is_mutable_reference() {
 504                 h |= HlMod::Mutable;
 505             }
 506             if local.is_ref(db) || ty.is_reference() {
 507                 h |= HlMod::Reference;
 508             }
 509             if ty.as_callable(db).is_some() || ty.impls_fnonce(db) {
 510                 h |= HlMod::Callable;
 511             }
 512             h
 513         }
 514         Definition::Label(_) => Highlight::new(HlTag::Symbol(SymbolKind::Label)),
 515         Definition::BuiltinAttr(_) => Highlight::new(HlTag::Symbol(SymbolKind::BuiltinAttr)),
 516         Definition::ToolModule(_) => Highlight::new(HlTag::Symbol(SymbolKind::ToolModule)),
 517     };
 518
 519     let famous_defs = FamousDefs(sema, krate);
 520     let def_crate = def.module(db).map(hir::Module::krate).or_else(|| match def {
 521         Definition::Module(module) => Some(module.krate()),
 522         _ => None,
 523     });
 524     let is_from_other_crate = def_crate != krate;
 525     let is_from_builtin_crate =
 526         def_crate.map_or(false, |def_crate| famous_defs.builtin_crates().any(|it| def_crate == it));
 527     let is_builtin_type = matches!(def, Definition::BuiltinType(_));
 528     let is_public = def.visibility(db) == Some(hir::Visibility::Public);
 529
 530     match (is_from_other_crate, is_builtin_type, is_public) {
 531         (true, false, _) => h |= HlMod::Library,
 532         (false, _, true) => h |= HlMod::Public,
 533         _ => {}
 534     }
 535
 536     if is_from_builtin_crate {
 537         h |= HlMod::DefaultLibrary;
 538     }
 539
 540     h
 541 }
 542
 543 fn highlight_method_call_by_name_ref(
 544     sema: &Semantics<RootDatabase>,
 545     krate: Option<hir::Crate>,
 546     name_ref: &ast::NameRef,
 547 ) -> Option<Highlight> {
 548     let mc = name_ref.syntax().parent().and_then(ast::MethodCallExpr::cast)?;
 549     highlight_method_call(sema, krate, &mc)
 550 }
 551
 552 fn highlight_method_call(
 553     sema: &Semantics<RootDatabase>,
 554     krate: Option<hir::Crate>,
 555     method_call: &ast::MethodCallExpr,
 556 ) -> Option<Highlight> {
 557     let func = sema.resolve_method_call(method_call)?;
 558
 559     let mut h = SymbolKind::Function.into();
 560     h |= HlMod::Associated;
 561
 562     if func.is_unsafe(sema.db) || sema.is_unsafe_method_call(method_call) {
 563         h |= HlMod::Unsafe;
 564     }
 565     if func.is_async(sema.db) {
 566         h |= HlMod::Async;
 567     }
 568     if func.as_assoc_item(sema.db).and_then(|it| it.containing_trait(sema.db)).is_some() {
 569         h |= HlMod::Trait;
 570     }
 571
 572     let famous_defs = FamousDefs(sema, krate);
 573     let def_crate = func.module(sema.db).krate();
 574     let is_from_other_crate = Some(def_crate) != krate;
 575     let is_from_builtin_crate = famous_defs.builtin_crates().any(|it| def_crate == it);
 576     let is_public = func.visibility(sema.db) == hir::Visibility::Public;
 577
 578     if is_from_other_crate {
 579         h |= HlMod::Library;
 580     } else if is_public {
 581         h |= HlMod::Public;
 582     }
 583
 584     if is_from_builtin_crate {
 585         h |= HlMod::DefaultLibrary;
 586     }
 587
 588     if let Some(self_param) = func.self_param(sema.db) {
 589         match self_param.access(sema.db) {
 590             hir::Access::Shared => h |= HlMod::Reference,
 591             hir::Access::Exclusive => {
 592                 h |= HlMod::Mutable;
 593                 h |= HlMod::Reference;
 594             }
 595             hir::Access::Owned => {
 596                 if let Some(receiver_ty) =
 597                     method_call.receiver().and_then(|it| sema.type_of_expr(&it))
 598                 {
 599                     if !receiver_ty.adjusted().is_copy(sema.db) {
 600                         h |= HlMod::Consuming
 601                     }
 602                 }
 603             }
 604         }
 605     }
 606     Some(h)
 607 }
 608
 609 fn highlight_name_by_syntax(name: ast::Name) -> Highlight {
 610     let default = HlTag::UnresolvedReference;
 611
 612     let parent = match name.syntax().parent() {
 613         Some(it) => it,
 614         _ => return default.into(),
 615     };
 616
 617     let tag = match parent.kind() {
 618         STRUCT => SymbolKind::Struct,
 619         ENUM => SymbolKind::Enum,
 620         VARIANT => SymbolKind::Variant,
 621         UNION => SymbolKind::Union,
 622         TRAIT => SymbolKind::Trait,
 623         TYPE_ALIAS => SymbolKind::TypeAlias,
 624         TYPE_PARAM => SymbolKind::TypeParam,
 625         RECORD_FIELD => SymbolKind::Field,
 626         MODULE => SymbolKind::Module,
 627         FN => SymbolKind::Function,
 628         CONST => SymbolKind::Const,
 629         STATIC => SymbolKind::Static,
 630         IDENT_PAT => SymbolKind::Local,
 631         _ => return default.into(),
 632     };
 633
 634     tag.into()
 635 }
 636
 637 fn highlight_name_ref_by_syntax(
 638     name: ast::NameRef,
 639     sema: &Semantics<RootDatabase>,
 640     krate: Option<hir::Crate>,
 641 ) -> Highlight {
 642     let default = HlTag::UnresolvedReference;
 643
 644     let parent = match name.syntax().parent() {
 645         Some(it) => it,
 646         _ => return default.into(),
 647     };
 648
 649     match parent.kind() {
 650         METHOD_CALL_EXPR => ast::MethodCallExpr::cast(parent)
 651             .and_then(|it| highlight_method_call(sema, krate, &it))
 652             .unwrap_or_else(|| SymbolKind::Function.into()),
 653         FIELD_EXPR => {
 654             let h = HlTag::Symbol(SymbolKind::Field);
 655             let is_union = ast::FieldExpr::cast(parent)
 656                 .and_then(|field_expr| sema.resolve_field(&field_expr))
 657                 .map_or(false, |field| {
 658                     matches!(field.parent_def(sema.db), hir::VariantDef::Union(_))
 659                 });
 660             if is_union {
 661                 h | HlMod::Unsafe
 662             } else {
 663                 h.into()
 664             }
 665         }
 666         PATH_SEGMENT => {
 667             let path = match parent.parent().and_then(ast::Path::cast) {
 668                 Some(it) => it,
 669                 _ => return default.into(),
 670             };
 671             let expr = match path.syntax().parent().and_then(ast::PathExpr::cast) {
 672                 Some(it) => it,
 673                 _ => {
 674                     // within path, decide whether it is module or adt by checking for uppercase name
 675                     return if name.text().chars().next().unwrap_or_default().is_uppercase() {
 676                         SymbolKind::Struct
 677                     } else {
 678                         SymbolKind::Module
 679                     }
 680                     .into();
 681                 }
 682             };
 683             let parent = match expr.syntax().parent() {
 684                 Some(it) => it,
 685                 None => return default.into(),
 686             };
 687
 688             match parent.kind() {
 689                 CALL_EXPR => SymbolKind::Function.into(),
 690                 _ => if name.text().chars().next().unwrap_or_default().is_uppercase() {
 691                     SymbolKind::Struct
 692                 } else {
 693                     SymbolKind::Const
 694                 }
 695                 .into(),
 696             }
 697         }
 698         _ => default.into(),
 699     }
 700 }
 701
 702 fn is_consumed_lvalue(node: &SyntaxNode, local: &hir::Local, db: &RootDatabase) -> bool {
 703     // When lvalues are passed as arguments and they're not Copy, then mark them as Consuming.
 704     parents_match(node.clone().into(), &[PATH_SEGMENT, PATH, PATH_EXPR, ARG_LIST])
 705         && !local.ty(db).is_copy(db)
 706 }
 707
 708 /// Returns true if the parent nodes of `node` all match the `SyntaxKind`s in `kinds` exactly.
 709 fn parents_match(mut node: NodeOrToken<SyntaxNode, SyntaxToken>, mut kinds: &[SyntaxKind]) -> bool {
 710     while let (Some(parent), [kind, rest @ ..]) = (&node.parent(), kinds) {
 711         if parent.kind() != *kind {
 712             return false;
 713         }
 714
 715         // FIXME: Would be nice to get parent out of the match, but binding by-move and by-value
 716         // in the same pattern is unstable: rust-lang/rust#68354.
 717         node = node.parent().unwrap().into();
 718         kinds = rest;
 719     }
 720
 721     // Only true if we matched all expected kinds
 722     kinds.is_empty()
 723 }
 724
 725 #[inline]
 726 fn parent_matches<N: AstNode>(token: &SyntaxToken) -> bool {
 727     token.parent().map_or(false, |it| N::can_cast(it.kind()))
 728 }
 729
 730 fn is_child_of_impl(token: &SyntaxToken) -> bool {
 731     match token.parent() {
 732         Some(e) => e.kind() == IMPL,
 733         _ => false,
 734     }
 735 }
 736
 737 fn is_in_fn_with_self_param<N: AstNode>(node: &N) -> bool {
 738     node.syntax()
 739         .ancestors()
 740         .find_map(ast::Fn::cast)
 741         .and_then(|s| s.param_list()?.self_param())
 742         .is_some()
 743 }