crates/ide/src/syntax_highlighting.rs

   1 pub(crate) mod tags;
   2
   3 mod highlights;
   4 mod injector;
   5
   6 mod highlight;
   7 mod format;
   8 mod macro_;
   9 mod inject;
  10
  11 mod html;
  12 #[cfg(test)]
  13 mod tests;
  14
  15 use hir::{InFile, Name, Semantics};
  16 use ide_db::{RootDatabase, SymbolKind};
  17 use rustc_hash::FxHashMap;
  18 use syntax::{
  19     ast::{self, HasFormatSpecifier},
  20     match_ast, AstNode, AstToken, Direction, NodeOrToken,
  21     SyntaxKind::*,
  22     SyntaxNode, TextRange, WalkEvent, T,
  23 };
  24
  25 use crate::{
  26     syntax_highlighting::{
  27         format::highlight_format_string, highlights::Highlights, macro_::MacroHighlighter,
  28         tags::Highlight,
  29     },
  30     FileId, HlMod, HlTag,
  31 };
  32
  33 pub(crate) use html::highlight_as_html;
  34
  35 #[derive(Debug, Clone, Copy)]
  36 pub struct HlRange {
  37     pub range: TextRange,
  38     pub highlight: Highlight,
  39     pub binding_hash: Option<u64>,
  40 }
  41
  42 // Feature: Semantic Syntax Highlighting
  43 //
  44 // rust-analyzer highlights the code semantically.
  45 // For example, `Bar` in `foo::Bar` might be colored differently depending on whether `Bar` is an enum or a trait.
  46 // rust-analyzer does not specify colors directly, instead it assigns a tag (like `struct`) and a set of modifiers (like `declaration`) to each token.
  47 // It's up to the client to map those to specific colors.
  48 //
  49 // The general rule is that a reference to an entity gets colored the same way as the entity itself.
  50 // We also give special modifier for `mut` and `&mut` local variables.
  51 //
  52 //
  53 // .Token Tags
  54 //
  55 // Rust-analyzer currently emits the following token tags:
  56 //
  57 // - For items:
  58 // +
  59 // [horizontal]
  60 // enum:: Emitted for enums.
  61 // function:: Emitted for free-standing functions.
  62 // macro:: Emitted for macros.
  63 // method:: Emitted for associated functions, also knowns as methods.
  64 // namespace:: Emitted for modules.
  65 // struct:: Emitted for structs.
  66 // trait:: Emitted for traits.
  67 // typeAlias:: Emitted for type aliases and `Self` in `impl`s.
  68 // union:: Emitted for unions.
  69 //
  70 // - For literals:
  71 // +
  72 // [horizontal]
  73 // boolean:: Emitted for the boolean literals `true` and `false`.
  74 // character:: Emitted for character literals.
  75 // number:: Emitted for numeric literals.
  76 // string:: Emitted for string literals.
  77 // escapeSequence:: Emitted for escaped sequences inside strings like `\n`.
  78 // formatSpecifier:: Emitted for format specifiers `{:?}` in `format!`-like macros.
  79 //
  80 // - For operators:
  81 // +
  82 // [horizontal]
  83 // operator:: Emitted for general operators.
  84 // arithmetic:: Emitted for the arithmetic operators `+`, `-`, `*`, `/`, `+=`, `-=`, `*=`, `/=`.
  85 // bitwise:: Emitted for the bitwise operators `|`, `&`, `!`, `^`, `|=`, `&=`, `^=`.
  86 // comparison:: Emitted for the comparison operators `>`, `<`, `==`, `>=`, `<=`, `!=`.
  87 // logical:: Emitted for the logical operators `||`, `&&`, `!`.
  88 //
  89 // - For punctuation:
  90 // +
  91 // [horizontal]
  92 // punctuation:: Emitted for general punctuation.
  93 // angle:: Emitted for `<>` angle brackets.
  94 // brace:: Emitted for `{}` braces.
  95 // bracket:: Emitted for `[]` brackets.
  96 // parenthesis:: Emitted for `()` parentheses.
  97 // colon:: Emitted for the `:` token.
  98 // comma:: Emitted for the `,` token.
  99 // dot:: Emitted for the `.` token.
 100 // Semi:: Emitted for the `;` token.
 101 //
 102 // //-
 103 //
 104 // [horizontal]
 105 // attribute:: Emitted for the `#[` `]` tokens.
 106 // builtinAttribute:: Emitted for names to builtin attributes in attribute path, the `repr` in `#[repr(u8)]` for example.
 107 // builtinType:: Emitted for builtin types like `u32`, `str` and `f32`.
 108 // comment:: Emitted for comments.
 109 // constParameter:: Emitted for const parameters.
 110 // enumMember:: Emitted for enum variants.
 111 // generic:: Emitted for generic tokens that have no mapping.
 112 // keyword:: Emitted for keywords.
 113 // label:: Emitted for labels.
 114 // lifetime:: Emitted for lifetimes.
 115 // parameter:: Emitted for non-self function parameters.
 116 // property:: Emitted for struct and union fields.
 117 // selfKeyword:: Emitted for the self function parameter and self path-specifier.
 118 // typeParameter:: Emitted for type parameters.
 119 // unresolvedReference:: Emitted for unresolved references, names that rust-analyzer can't find the definition of.
 120 // variable:: Emitted for locals, constants and statics.
 121 //
 122 //
 123 // .Token Modifiers
 124 //
 125 // Token modifiers allow to style some elements in the source code more precisely.
 126 //
 127 // Rust-analyzer currently emits the following token modifiers:
 128 //
 129 // [horizontal]
 130 // async:: Emitted for async functions and the `async` and `await` keywords.
 131 // attribute:: Emitted for tokens inside attributes.
 132 // callable:: Emitted for locals whose types implements one of the `Fn*` traits.
 133 // constant:: Emitted for consts.
 134 // consuming:: Emitted for locals that are being consumed when use in a function call.
 135 // controlFlow:: Emitted for control-flow related tokens, this includes the `?` operator.
 136 // declaration:: Emitted for names of definitions, like `foo` in `fn foo() {}`.
 137 // documentation:: Emitted for documentation comments.
 138 // injected:: Emitted for doc-string injected highlighting like rust source blocks in documentation.
 139 // intraDocLink:: Emitted for intra doc links in doc-strings.
 140 // library:: Emitted for items that are defined outside of the current crate.
 141 // public:: Emitted for items that are from the current crate and are `pub`.
 142 // mutable:: Emitted for mutable locals and statics.
 143 // static:: Emitted for "static" functions, also known as functions that do not take a `self` param, as well as statics and consts.
 144 // trait:: Emitted for associated trait items.
 145 // unsafe:: Emitted for unsafe operations, like unsafe function calls, as well as the `unsafe` token.
 146 //
 147 //
 148 // image::https://user-images.githubusercontent.com/48062697/113164457-06cfb980-9239-11eb-819b-0f93e646acf8.png[]
 149 // image::https://user-images.githubusercontent.com/48062697/113187625-f7f50100-9250-11eb-825e-91c58f236071.png[]
 150 pub(crate) fn highlight(
 151     db: &RootDatabase,
 152     file_id: FileId,
 153     range_to_highlight: Option<TextRange>,
 154     syntactic_name_ref_highlighting: bool,
 155 ) -> Vec<HlRange> {
 156     let _p = profile::span("highlight");
 157     let sema = Semantics::new(db);
 158
 159     // Determine the root based on the given range.
 160     let (root, range_to_highlight) = {
 161         let source_file = sema.parse(file_id);
 162         let source_file = source_file.syntax();
 163         match range_to_highlight {
 164             Some(range) => {
 165                 let node = match source_file.covering_element(range) {
 166                     NodeOrToken::Node(it) => it,
 167                     NodeOrToken::Token(it) => it.parent().unwrap_or_else(|| source_file.clone()),
 168                 };
 169                 (node, range)
 170             }
 171             None => (source_file.clone(), source_file.text_range()),
 172         }
 173     };
 174
 175     let mut hl = highlights::Highlights::new(root.text_range());
 176     traverse(
 177         &mut hl,
 178         &sema,
 179         InFile::new(file_id.into(), &root),
 180         sema.scope(&root).krate(),
 181         range_to_highlight,
 182         syntactic_name_ref_highlighting,
 183     );
 184     hl.to_vec()
 185 }
 186
 187 fn traverse(
 188     hl: &mut Highlights,
 189     sema: &Semantics<RootDatabase>,
 190     root: InFile<&SyntaxNode>,
 191     krate: Option<hir::Crate>,
 192     range_to_highlight: TextRange,
 193     syntactic_name_ref_highlighting: bool,
 194 ) {
 195     let mut bindings_shadow_count: FxHashMap<Name, u32> = FxHashMap::default();
 196
 197     let mut current_macro_call: Option<ast::MacroCall> = None;
 198     let mut current_attr_macro_call = None;
 199     let mut current_macro: Option<ast::Macro> = None;
 200     let mut macro_highlighter = MacroHighlighter::default();
 201     let mut inside_attribute = false;
 202
 203     // Walk all nodes, keeping track of whether we are inside a macro or not.
 204     // If in macro, expand it first and highlight the expanded code.
 205     for event in root.value.preorder_with_tokens() {
 206         let event_range = match &event {
 207             WalkEvent::Enter(it) | WalkEvent::Leave(it) => it.text_range(),
 208         };
 209
 210         // Element outside of the viewport, no need to highlight
 211         if range_to_highlight.intersect(event_range).is_none() {
 212             continue;
 213         }
 214
 215         match event.clone() {
 216             WalkEvent::Enter(NodeOrToken::Node(node)) => {
 217                 match_ast! {
 218                     match node {
 219                         ast::MacroCall(mcall) => {
 220                             if let Some(range) = macro_call_range(&mcall) {
 221                                 hl.add(HlRange {
 222                                     range,
 223                                     highlight: HlTag::Symbol(SymbolKind::Macro).into(),
 224                                     binding_hash: None,
 225                                 });
 226                             }
 227                             current_macro_call = Some(mcall);
 228                             continue;
 229                         },
 230                         ast::Macro(mac) => {
 231                             macro_highlighter.init();
 232                             current_macro = Some(mac);
 233                             continue;
 234                         },
 235                         ast::Item(item) => {
 236                             if sema.is_attr_macro_call(&item) {
 237                                 current_attr_macro_call = Some(item);
 238                             }
 239                         },
 240                         ast::Attr(__) => inside_attribute = true,
 241                         _ => ()
 242                     }
 243                 }
 244             }
 245             WalkEvent::Leave(NodeOrToken::Node(node)) => {
 246                 match_ast! {
 247                     match node {
 248                         ast::MacroCall(mcall) => {
 249                             assert_eq!(current_macro_call, Some(mcall));
 250                             current_macro_call = None;
 251                         },
 252                         ast::Macro(mac) => {
 253                             assert_eq!(current_macro, Some(mac));
 254                             current_macro = None;
 255                             macro_highlighter = MacroHighlighter::default();
 256                         },
 257                         ast::Item(item) => {
 258                             if current_attr_macro_call == Some(item) {
 259                                 current_attr_macro_call = None;
 260                             }
 261                         },
 262                         ast::Attr(__) => inside_attribute = false,
 263                         _ => ()
 264                     }
 265                 }
 266             }
 267             _ => (),
 268         }
 269
 270         let element = match event {
 271             WalkEvent::Enter(it) => it,
 272             WalkEvent::Leave(it) => {
 273                 if let Some(node) = it.as_node() {
 274                     inject::doc_comment(hl, sema, root.with_value(node));
 275                 }
 276                 continue;
 277             }
 278         };
 279
 280         let range = element.text_range();
 281
 282         if current_macro.is_some() {
 283             if let Some(tok) = element.as_token() {
 284                 macro_highlighter.advance(tok);
 285             }
 286         }
 287
 288         let element_to_highlight = if current_macro_call.is_some() && element.kind() != COMMENT {
 289             // Inside a macro -- expand it first
 290             let token = match element.clone().into_token() {
 291                 Some(it) if it.parent().map_or(false, |it| it.kind() == TOKEN_TREE) => it,
 292                 _ => continue,
 293             };
 294             let token = sema.descend_into_macros(token.clone());
 295             match token.parent() {
 296                 Some(parent) => {
 297                     // We only care Name and Name_ref
 298                     match (token.kind(), parent.kind()) {
 299                         (IDENT, NAME | NAME_REF) => parent.into(),
 300                         _ => token.into(),
 301                     }
 302                 }
 303                 None => token.into(),
 304             }
 305         } else if current_attr_macro_call.is_some() {
 306             let token = match element.clone().into_token() {
 307                 Some(it) => it,
 308                 _ => continue,
 309             };
 310             let token = sema.descend_into_macros(token.clone());
 311             match token.parent() {
 312                 Some(parent) => {
 313                     // We only care Name and Name_ref
 314                     match (token.kind(), parent.kind()) {
 315                         (IDENT, NAME | NAME_REF) => parent.into(),
 316                         _ => token.into(),
 317                     }
 318                 }
 319                 None => token.into(),
 320             }
 321         } else {
 322             element.clone()
 323         };
 324
 325         if let Some(token) = element.as_token().cloned().and_then(ast::String::cast) {
 326             if token.is_raw() {
 327                 let expanded = element_to_highlight.as_token().unwrap().clone();
 328                 if inject::ra_fixture(hl, sema, token, expanded).is_some() {
 329                     continue;
 330                 }
 331             }
 332         }
 333
 334         if let Some(_) = macro_highlighter.highlight(element_to_highlight.clone()) {
 335             continue;
 336         }
 337
 338         if let Some((mut highlight, binding_hash)) = highlight::element(
 339             sema,
 340             krate,
 341             &mut bindings_shadow_count,
 342             syntactic_name_ref_highlighting,
 343             element_to_highlight.clone(),
 344         ) {
 345             if inside_attribute {
 346                 highlight = highlight | HlMod::Attribute;
 347             }
 348
 349             hl.add(HlRange { range, highlight, binding_hash });
 350         }
 351
 352         if let Some(string) = element_to_highlight.as_token().cloned().and_then(ast::String::cast) {
 353             highlight_format_string(hl, &string, range);
 354             // Highlight escape sequences
 355             if let Some(char_ranges) = string.char_ranges() {
 356                 for (piece_range, _) in char_ranges.iter().filter(|(_, char)| char.is_ok()) {
 357                     if string.text()[piece_range.start().into()..].starts_with('\\') {
 358                         hl.add(HlRange {
 359                             range: piece_range + range.start(),
 360                             highlight: HlTag::EscapeSequence.into(),
 361                             binding_hash: None,
 362                         });
 363                     }
 364                 }
 365             }
 366         }
 367     }
 368 }
 369
 370 fn macro_call_range(macro_call: &ast::MacroCall) -> Option<TextRange> {
 371     let path = macro_call.path()?;
 372     let name_ref = path.segment()?.name_ref()?;
 373
 374     let range_start = name_ref.syntax().text_range().start();
 375     let mut range_end = name_ref.syntax().text_range().end();
 376     for sibling in path.syntax().siblings_with_tokens(Direction::Next) {
 377         match sibling.kind() {
 378             T![!] | IDENT => range_end = sibling.text_range().end(),
 379             _ => (),
 380         }
 381     }
 382
 383     Some(TextRange::new(range_start, range_end))
 384 }