1 //! Semantic Tokens helpers
6 Range, SemanticToken, SemanticTokenModifier, SemanticTokenType, SemanticTokens,
10 macro_rules! define_semantic_token_types {
11 ($(($ident:ident, $string:literal)),*$(,)?) => {
12 $(pub(crate) const $ident: SemanticTokenType = SemanticTokenType::new($string);)*
14 pub(crate) const SUPPORTED_TYPES: &[SemanticTokenType] = &[
15 SemanticTokenType::COMMENT,
16 SemanticTokenType::KEYWORD,
17 SemanticTokenType::STRING,
18 SemanticTokenType::NUMBER,
19 SemanticTokenType::REGEXP,
20 SemanticTokenType::OPERATOR,
21 SemanticTokenType::NAMESPACE,
22 SemanticTokenType::TYPE,
23 SemanticTokenType::STRUCT,
24 SemanticTokenType::CLASS,
25 SemanticTokenType::INTERFACE,
26 SemanticTokenType::ENUM,
27 SemanticTokenType::ENUM_MEMBER,
28 SemanticTokenType::TYPE_PARAMETER,
29 SemanticTokenType::FUNCTION,
30 SemanticTokenType::METHOD,
31 SemanticTokenType::PROPERTY,
32 SemanticTokenType::MACRO,
33 SemanticTokenType::VARIABLE,
34 SemanticTokenType::PARAMETER,
40 define_semantic_token_types![
42 (ATTRIBUTE, "attribute"),
46 (BUILTIN_TYPE, "builtinType"),
47 (CHAR_LITERAL, "characterLiteral"),
50 (CONST_PARAMETER, "constParameter"),
52 (ESCAPE_SEQUENCE, "escapeSequence"),
53 (FORMAT_SPECIFIER, "formatSpecifier"),
56 (LIFETIME, "lifetime"),
57 (PARENTHESIS, "parenthesis"),
58 (PUNCTUATION, "punctuation"),
59 (SELF_KEYWORD, "selfKeyword"),
60 (SEMICOLON, "semicolon"),
61 (TYPE_ALIAS, "typeAlias"),
63 (UNRESOLVED_REFERENCE, "unresolvedReference"),
66 macro_rules! define_semantic_token_modifiers {
67 ($(($ident:ident, $string:literal)),*$(,)?) => {
68 $(pub(crate) const $ident: SemanticTokenModifier = SemanticTokenModifier::new($string);)*
70 pub(crate) const SUPPORTED_MODIFIERS: &[SemanticTokenModifier] = &[
71 SemanticTokenModifier::DOCUMENTATION,
72 SemanticTokenModifier::DECLARATION,
73 SemanticTokenModifier::DEFINITION,
74 SemanticTokenModifier::STATIC,
75 SemanticTokenModifier::ABSTRACT,
76 SemanticTokenModifier::DEPRECATED,
77 SemanticTokenModifier::READONLY,
83 define_semantic_token_modifiers![
84 (CONSTANT, "constant"),
85 (CONTROL_FLOW, "controlFlow"),
86 (INJECTED, "injected"),
88 (CONSUMING, "consuming"),
90 (ATTRIBUTE_MODIFIER, "attribute"),
91 (TRAIT_MODIFIER, "trait"),
92 (CALLABLE, "callable"),
93 (INTRA_DOC_LINK, "intraDocLink"),
97 pub(crate) struct ModifierSet(pub(crate) u32);
99 impl ops::BitOrAssign<SemanticTokenModifier> for ModifierSet {
100 fn bitor_assign(&mut self, rhs: SemanticTokenModifier) {
101 let idx = SUPPORTED_MODIFIERS.iter().position(|it| it == &rhs).unwrap();
106 /// Tokens are encoded relative to each other.
108 /// This is a direct port of https://github.com/microsoft/vscode-languageserver-node/blob/f425af9de46a0187adb78ec8a46b9b2ce80c5412/server/src/sematicTokens.proposed.ts#L45
109 pub(crate) struct SemanticTokensBuilder {
113 data: Vec<SemanticToken>,
116 impl SemanticTokensBuilder {
117 pub(crate) fn new(id: String) -> Self {
118 SemanticTokensBuilder { id, prev_line: 0, prev_char: 0, data: Default::default() }
121 /// Push a new token onto the builder
122 pub(crate) fn push(&mut self, range: Range, token_index: u32, modifier_bitset: u32) {
123 let mut push_line = range.start.line as u32;
124 let mut push_char = range.start.character as u32;
126 if !self.data.is_empty() {
127 push_line -= self.prev_line;
129 push_char -= self.prev_char;
133 // A token cannot be multiline
134 let token_len = range.end.character - range.start.character;
136 let token = SemanticToken {
137 delta_line: push_line,
138 delta_start: push_char,
139 length: token_len as u32,
140 token_type: token_index,
141 token_modifiers_bitset: modifier_bitset,
144 self.data.push(token);
146 self.prev_line = range.start.line as u32;
147 self.prev_char = range.start.character as u32;
150 pub(crate) fn build(self) -> SemanticTokens {
151 SemanticTokens { result_id: Some(self.id), data: self.data }
155 pub(crate) fn diff_tokens(old: &[SemanticToken], new: &[SemanticToken]) -> Vec<SemanticTokensEdit> {
156 let offset = new.iter().zip(old.iter()).take_while(|&(n, p)| n == p).count();
158 let (_, old) = old.split_at(offset);
159 let (_, new) = new.split_at(offset);
161 let offset_from_end =
162 new.iter().rev().zip(old.iter().rev()).take_while(|&(n, p)| n == p).count();
164 let (old, _) = old.split_at(old.len() - offset_from_end);
165 let (new, _) = new.split_at(new.len() - offset_from_end);
167 if old.is_empty() && new.is_empty() {
170 // The lsp data field is actually a byte-diff but we
171 // travel in tokens so `start` and `delete_count` are in multiples of the
172 // serialized size of `SemanticToken`.
173 vec![SemanticTokensEdit {
174 start: 5 * offset as u32,
175 delete_count: 5 * old.len() as u32,
176 data: Some(new.into()),
181 pub(crate) fn type_index(type_: SemanticTokenType) -> u32 {
182 SUPPORTED_TYPES.iter().position(|it| *it == type_).unwrap() as u32
189 fn from(t: (u32, u32, u32, u32, u32)) -> SemanticToken {
195 token_modifiers_bitset: t.4,
200 fn test_diff_insert_at_end() {
201 let before = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
202 let after = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10)), from((11, 12, 13, 14, 15))];
204 let edits = diff_tokens(&before, &after);
210 data: Some(vec![from((11, 12, 13, 14, 15))])
216 fn test_diff_insert_at_beginning() {
217 let before = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
218 let after = [from((11, 12, 13, 14, 15)), from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
220 let edits = diff_tokens(&before, &after);
226 data: Some(vec![from((11, 12, 13, 14, 15))])
232 fn test_diff_insert_in_middle() {
233 let before = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
235 from((1, 2, 3, 4, 5)),
236 from((10, 20, 30, 40, 50)),
237 from((60, 70, 80, 90, 100)),
238 from((6, 7, 8, 9, 10)),
241 let edits = diff_tokens(&before, &after);
247 data: Some(vec![from((10, 20, 30, 40, 50)), from((60, 70, 80, 90, 100))])
253 fn test_diff_remove_from_end() {
254 let before = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10)), from((11, 12, 13, 14, 15))];
255 let after = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
257 let edits = diff_tokens(&before, &after);
258 assert_eq!(edits[0], SemanticTokensEdit { start: 10, delete_count: 5, data: Some(vec![]) });
262 fn test_diff_remove_from_beginning() {
263 let before = [from((11, 12, 13, 14, 15)), from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
264 let after = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
266 let edits = diff_tokens(&before, &after);
267 assert_eq!(edits[0], SemanticTokensEdit { start: 0, delete_count: 5, data: Some(vec![]) });
271 fn test_diff_remove_from_middle() {
273 from((1, 2, 3, 4, 5)),
274 from((10, 20, 30, 40, 50)),
275 from((60, 70, 80, 90, 100)),
276 from((6, 7, 8, 9, 10)),
278 let after = [from((1, 2, 3, 4, 5)), from((6, 7, 8, 9, 10))];
280 let edits = diff_tokens(&before, &after);
281 assert_eq!(edits[0], SemanticTokensEdit { start: 5, delete_count: 10, data: Some(vec![]) });