crates/rust-analyzer/src/semantic_tokens.rs

   1 //! Semantic Tokens helpers
   2
   3 use std::ops;
   4
   5 use lsp_types::{Range, SemanticToken, SemanticTokenModifier, SemanticTokenType, SemanticTokens};
   6
   7 macro_rules! define_semantic_token_types {
   8     ($(($ident:ident, $string:literal)),*$(,)?) => {
   9         $(pub(crate) const $ident: SemanticTokenType = SemanticTokenType::new($string);)*
  10
  11         pub(crate) const SUPPORTED_TYPES: &[SemanticTokenType] = &[
  12             SemanticTokenType::COMMENT,
  13             SemanticTokenType::KEYWORD,
  14             SemanticTokenType::STRING,
  15             SemanticTokenType::NUMBER,
  16             SemanticTokenType::REGEXP,
  17             SemanticTokenType::OPERATOR,
  18             SemanticTokenType::NAMESPACE,
  19             SemanticTokenType::TYPE,
  20             SemanticTokenType::STRUCT,
  21             SemanticTokenType::CLASS,
  22             SemanticTokenType::INTERFACE,
  23             SemanticTokenType::ENUM,
  24             SemanticTokenType::TYPE_PARAMETER,
  25             SemanticTokenType::FUNCTION,
  26             SemanticTokenType::MEMBER,
  27             SemanticTokenType::PROPERTY,
  28             SemanticTokenType::MACRO,
  29             SemanticTokenType::VARIABLE,
  30             SemanticTokenType::PARAMETER,
  31             SemanticTokenType::LABEL,
  32             $($ident),*
  33         ];
  34     };
  35 }
  36
  37 define_semantic_token_types![
  38     (ATTRIBUTE, "attribute"),
  39     (BOOLEAN, "boolean"),
  40     (BUILTIN_TYPE, "builtinType"),
  41     (ENUM_MEMBER, "enumMember"),
  42     (ESCAPE_SEQUENCE, "escapeSequence"),
  43     (FORMAT_SPECIFIER, "formatSpecifier"),
  44     (GENERIC, "generic"),
  45     (LIFETIME, "lifetime"),
  46     (SELF_KEYWORD, "selfKeyword"),
  47     (TYPE_ALIAS, "typeAlias"),
  48     (UNION, "union"),
  49     (UNRESOLVED_REFERENCE, "unresolvedReference"),
  50 ];
  51
  52 macro_rules! define_semantic_token_modifiers {
  53     ($(($ident:ident, $string:literal)),*$(,)?) => {
  54         $(pub(crate) const $ident: SemanticTokenModifier = SemanticTokenModifier::new($string);)*
  55
  56         pub(crate) const SUPPORTED_MODIFIERS: &[SemanticTokenModifier] = &[
  57             SemanticTokenModifier::DOCUMENTATION,
  58             SemanticTokenModifier::DECLARATION,
  59             SemanticTokenModifier::DEFINITION,
  60             SemanticTokenModifier::STATIC,
  61             SemanticTokenModifier::ABSTRACT,
  62             SemanticTokenModifier::DEPRECATED,
  63             SemanticTokenModifier::READONLY,
  64             $($ident),*
  65         ];
  66     };
  67 }
  68
  69 define_semantic_token_modifiers![
  70     (CONSTANT, "constant"),
  71     (CONTROL_FLOW, "controlFlow"),
  72     (INJECTED, "injected"),
  73     (MUTABLE, "mutable"),
  74     (UNSAFE, "unsafe"),
  75     (ATTRIBUTE_MODIFIER, "attribute"),
  76 ];
  77
  78 #[derive(Default)]
  79 pub(crate) struct ModifierSet(pub(crate) u32);
  80
  81 impl ops::BitOrAssign<SemanticTokenModifier> for ModifierSet {
  82     fn bitor_assign(&mut self, rhs: SemanticTokenModifier) {
  83         let idx = SUPPORTED_MODIFIERS.iter().position(|it| it == &rhs).unwrap();
  84         self.0 |= 1 << idx;
  85     }
  86 }
  87
  88 /// Tokens are encoded relative to each other.
  89 ///
  90 /// This is a direct port of https://github.com/microsoft/vscode-languageserver-node/blob/f425af9de46a0187adb78ec8a46b9b2ce80c5412/server/src/sematicTokens.proposed.ts#L45
  91 #[derive(Default)]
  92 pub(crate) struct SemanticTokensBuilder {
  93     prev_line: u32,
  94     prev_char: u32,
  95     data: Vec<SemanticToken>,
  96 }
  97
  98 impl SemanticTokensBuilder {
  99     /// Push a new token onto the builder
 100     pub fn push(&mut self, range: Range, token_index: u32, modifier_bitset: u32) {
 101         let mut push_line = range.start.line as u32;
 102         let mut push_char = range.start.character as u32;
 103
 104         if !self.data.is_empty() {
 105             push_line -= self.prev_line;
 106             if push_line == 0 {
 107                 push_char -= self.prev_char;
 108             }
 109         }
 110
 111         // A token cannot be multiline
 112         let token_len = range.end.character - range.start.character;
 113
 114         let token = SemanticToken {
 115             delta_line: push_line,
 116             delta_start: push_char,
 117             length: token_len as u32,
 118             token_type: token_index,
 119             token_modifiers_bitset: modifier_bitset,
 120         };
 121
 122         self.data.push(token);
 123
 124         self.prev_line = range.start.line as u32;
 125         self.prev_char = range.start.character as u32;
 126     }
 127
 128     pub fn build(self) -> SemanticTokens {
 129         SemanticTokens { result_id: None, data: self.data }
 130     }
 131 }
 132
 133 pub fn type_index(type_: SemanticTokenType) -> u32 {
 134     SUPPORTED_TYPES.iter().position(|it| *it == type_).unwrap() as u32
 135 }