merman-lsp 0.8.0-alpha.3

Language server for Merman diagnostics and completion foundations.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
use crate::snapshot::DocumentSnapshot;
use merman_editor_core::{
    SemanticTokenKind, SemanticTokenModifier as CoreSemanticTokenModifier,
    semantic_token_legend as core_semantic_token_legend,
    semantic_tokens_for_snapshot as core_semantic_tokens_for_snapshot,
    semantic_tokens_for_snapshot_range as core_semantic_tokens_for_snapshot_range,
    token_modifier_index, token_type_index,
};
use std::collections::hash_map::DefaultHasher;
use std::hash::{Hash, Hasher};
use tower_lsp::lsp_types::{
    Range, SemanticToken, SemanticTokenModifier, SemanticTokenType, SemanticTokens,
    SemanticTokensDelta, SemanticTokensEdit, SemanticTokensFullDeltaResult,
    SemanticTokensFullOptions, SemanticTokensLegend, SemanticTokensOptions,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct AbsoluteToken {
    line: u32,
    start: u32,
    length: u32,
    token_type: u32,
    token_modifiers_bitset: u32,
}

pub fn semantic_tokens_options() -> SemanticTokensOptions {
    SemanticTokensOptions {
        work_done_progress_options: Default::default(),
        legend: semantic_tokens_legend(),
        range: Some(true),
        full: Some(SemanticTokensFullOptions::Delta { delta: Some(true) }),
    }
}

pub fn semantic_tokens_legend() -> SemanticTokensLegend {
    let legend = core_semantic_token_legend();
    SemanticTokensLegend {
        token_types: legend
            .token_types
            .into_iter()
            .map(semantic_token_type_to_lsp)
            .collect(),
        token_modifiers: legend
            .token_modifiers
            .into_iter()
            .map(semantic_token_modifier_to_lsp)
            .collect(),
    }
}

pub fn semantic_tokens_for_snapshot(snapshot: &DocumentSnapshot) -> SemanticTokens {
    semantic_tokens_from_absolute_tokens_with_result_id(
        absolute_tokens_for_snapshot(snapshot),
        None,
    )
}

pub fn semantic_tokens_for_snapshot_range(
    snapshot: &DocumentSnapshot,
    range: Range,
) -> SemanticTokens {
    let absolute_tokens = absolute_tokens_for_snapshot_range(snapshot, &range)
        .into_iter()
        .filter(|token| token_overlaps_range(token, &range))
        .collect();

    semantic_tokens_from_absolute_tokens_with_result_id(absolute_tokens, None)
}

pub fn semantic_tokens_delta_result(
    previous_tokens: &[SemanticToken],
    current_tokens: &[SemanticToken],
    result_id: String,
) -> SemanticTokensFullDeltaResult {
    let Some(edit) = semantic_tokens_delta_edit(previous_tokens, current_tokens) else {
        return SemanticTokensFullDeltaResult::TokensDelta(SemanticTokensDelta {
            result_id: Some(result_id),
            edits: Vec::new(),
        });
    };

    SemanticTokensFullDeltaResult::TokensDelta(SemanticTokensDelta {
        result_id: Some(result_id),
        edits: vec![edit],
    })
}

fn semantic_tokens_from_absolute_tokens_with_result_id(
    absolute_tokens: Vec<AbsoluteToken>,
    result_id: Option<String>,
) -> SemanticTokens {
    SemanticTokens {
        result_id,
        data: encode_relative_tokens(absolute_tokens),
    }
}

pub fn semantic_tokens_result_id(snapshot: &DocumentSnapshot, tokens: &[SemanticToken]) -> String {
    let mut hasher = DefaultHasher::new();
    snapshot.version.hash(&mut hasher);
    for token in tokens {
        token.delta_line.hash(&mut hasher);
        token.delta_start.hash(&mut hasher);
        token.length.hash(&mut hasher);
        token.token_type.hash(&mut hasher);
        token.token_modifiers_bitset.hash(&mut hasher);
    }
    format!("{}:{:016x}", snapshot.version, hasher.finish())
}

fn absolute_tokens_for_snapshot(snapshot: &DocumentSnapshot) -> Vec<AbsoluteToken> {
    core_semantic_tokens_for_snapshot(snapshot.as_editor())
        .into_iter()
        .map(|token| AbsoluteToken {
            line: token.line,
            start: token.start,
            length: token.length,
            token_type: token_type(token.kind),
            token_modifiers_bitset: token_modifier_bitset(token.modifier),
        })
        .collect()
}

fn absolute_tokens_for_snapshot_range(
    snapshot: &DocumentSnapshot,
    range: &Range,
) -> Vec<AbsoluteToken> {
    core_semantic_tokens_for_snapshot_range(snapshot.as_editor(), range.start.line, range.end.line)
        .into_iter()
        .map(|token| AbsoluteToken {
            line: token.line,
            start: token.start,
            length: token.length,
            token_type: token_type(token.kind),
            token_modifiers_bitset: token_modifier_bitset(token.modifier),
        })
        .collect()
}

fn token_overlaps_range(token: &AbsoluteToken, range: &Range) -> bool {
    let range_start_line = range.start.line;
    let range_start_character = range.start.character;
    let range_end_line = range.end.line;
    let range_end_character = range.end.character;
    let token_line = token.line;
    let token_start = token.start;
    let token_end = token.start + token.length;

    if token_line < range_start_line || token_line > range_end_line {
        return false;
    }

    if range_start_line == range_end_line {
        return token_line == range_start_line
            && token_end > range_start_character
            && token_start < range_end_character;
    }

    if token_line == range_start_line {
        return token_end > range_start_character;
    }

    if token_line == range_end_line {
        return token_start < range_end_character;
    }

    true
}

fn encode_relative_tokens(absolute_tokens: Vec<AbsoluteToken>) -> Vec<SemanticToken> {
    let mut previous_line = 0u32;
    let mut previous_start = 0u32;

    absolute_tokens
        .into_iter()
        .map(|token| {
            let delta_line = token.line.saturating_sub(previous_line);
            let delta_start = if delta_line == 0 {
                token.start.saturating_sub(previous_start)
            } else {
                token.start
            };

            previous_line = token.line;
            previous_start = token.start;

            SemanticToken {
                delta_line,
                delta_start,
                length: token.length,
                token_type: token.token_type,
                token_modifiers_bitset: token.token_modifiers_bitset,
            }
        })
        .collect()
}

fn semantic_tokens_delta_edit(
    previous_tokens: &[SemanticToken],
    current_tokens: &[SemanticToken],
) -> Option<SemanticTokensEdit> {
    let prefix_tokens = previous_tokens
        .iter()
        .zip(current_tokens.iter())
        .take_while(|(previous, current)| previous == current)
        .count();

    if prefix_tokens == previous_tokens.len() && prefix_tokens == current_tokens.len() {
        return None;
    }

    let previous_remainder = &previous_tokens[prefix_tokens..];
    let current_remainder = &current_tokens[prefix_tokens..];
    let suffix_tokens = previous_remainder
        .iter()
        .rev()
        .zip(current_remainder.iter().rev())
        .take_while(|(previous, current)| previous == current)
        .count();

    let previous_end = previous_tokens.len().saturating_sub(suffix_tokens);
    let current_end = current_tokens.len().saturating_sub(suffix_tokens);

    Some(SemanticTokensEdit {
        start: (prefix_tokens * 5) as u32,
        delete_count: ((previous_end - prefix_tokens) * 5) as u32,
        data: if prefix_tokens < current_end {
            Some(current_tokens[prefix_tokens..current_end].to_vec())
        } else {
            None
        },
    })
}

fn semantic_token_type_to_lsp(kind: SemanticTokenKind) -> SemanticTokenType {
    match kind {
        SemanticTokenKind::Namespace => SemanticTokenType::NAMESPACE,
        SemanticTokenKind::Class => SemanticTokenType::CLASS,
        SemanticTokenKind::Struct => SemanticTokenType::STRUCT,
        SemanticTokenKind::Variable => SemanticTokenType::VARIABLE,
        SemanticTokenKind::Property => SemanticTokenType::PROPERTY,
        SemanticTokenKind::Event => SemanticTokenType::EVENT,
        SemanticTokenKind::Function => SemanticTokenType::FUNCTION,
        SemanticTokenKind::String => SemanticTokenType::STRING,
    }
}

fn semantic_token_modifier_to_lsp(modifier: CoreSemanticTokenModifier) -> SemanticTokenModifier {
    match modifier {
        CoreSemanticTokenModifier::Entity => SemanticTokenModifier::new("mermanEntity"),
        CoreSemanticTokenModifier::Outline => SemanticTokenModifier::new("mermanOutline"),
        CoreSemanticTokenModifier::Payload => SemanticTokenModifier::new("mermanPayload"),
    }
}

fn token_type(kind: SemanticTokenKind) -> u32 {
    token_type_index(kind)
}

fn token_modifier_bitset(modifier: CoreSemanticTokenModifier) -> u32 {
    1 << token_modifier_index(modifier)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::document_store::DocumentStore;
    use tower_lsp::lsp_types::{Position, Url};

    #[test]
    fn semantic_tokens_legend_and_encoding_follow_editor_core_order() {
        let core_legend = core_semantic_token_legend();
        let lsp_legend = semantic_tokens_legend();

        assert_eq!(
            lsp_legend.token_types,
            core_legend
                .token_types
                .iter()
                .copied()
                .map(semantic_token_type_to_lsp)
                .collect::<Vec<_>>()
        );
        assert_eq!(
            lsp_legend.token_modifiers,
            core_legend
                .token_modifiers
                .iter()
                .copied()
                .map(semantic_token_modifier_to_lsp)
                .collect::<Vec<_>>()
        );
        for (index, kind) in core_legend.token_types.iter().copied().enumerate() {
            assert_eq!(token_type(kind), index as u32);
        }
        for (index, modifier) in core_legend.token_modifiers.iter().copied().enumerate() {
            assert_eq!(token_modifier_index(modifier), index as u32);
        }
    }

    #[test]
    fn semantic_tokens_project_entity_outline_and_payload_roles() {
        let mut store = DocumentStore::new();
        let uri = Url::parse("file:///tmp/example.mmd").unwrap();
        let snapshot = store.upsert(
            uri,
            1,
            concat!(
                "gantt\n",
                "title Roadmap\n",
                "section Demo\n",
                "Task 1: id1,2014-01-01,1d\n",
                "Task 2: id2,after id1,2d\n",
            )
            .to_string(),
        );

        let tokens = semantic_tokens_for_snapshot(&snapshot);

        assert!(tokens.data.iter().any(|token| {
            token.token_type == token_type(SemanticTokenKind::Variable)
                && token.token_modifiers_bitset
                    == token_modifier_bitset(CoreSemanticTokenModifier::Entity)
        }));
        assert!(tokens.data.iter().any(|token| {
            token.token_type == token_type(SemanticTokenKind::Namespace)
                && token.token_modifiers_bitset
                    == token_modifier_bitset(CoreSemanticTokenModifier::Outline)
        }));
        assert!(tokens.data.iter().any(|token| {
            token.token_type == token_type(SemanticTokenKind::String)
                && token.token_modifiers_bitset
                    == token_modifier_bitset(CoreSemanticTokenModifier::Payload)
        }));
    }

    #[test]
    fn semantic_tokens_use_absolute_markdown_ranges_and_utf16_lengths() {
        let mut store = DocumentStore::new();
        let uri = Url::parse("file:///tmp/example.md").unwrap();
        let snapshot = store.upsert(
            uri,
            1,
            "before\n```mermaid\nsequenceDiagram\ntitle: Diagram 🤓\n```\nafter\n".to_string(),
        );
        let tokens = semantic_tokens_for_snapshot(&snapshot);
        let decoded = decode_tokens(&tokens.data);

        let payload_start = snapshot.text.find("Diagram 🤓").unwrap();
        let payload_end = payload_start + "Diagram 🤓".len();
        let payload_span = snapshot
            .source_map
            .span(payload_start, payload_end)
            .expect("payload span should map");
        let payload_line = payload_span.lsp_range.start.line as u32;
        let payload_start_character = payload_span.lsp_range.start.character as u32;
        let payload_length =
            (payload_span.lsp_range.end.character - payload_span.lsp_range.start.character) as u32;

        assert!(decoded.iter().any(|token| {
            token.line == payload_line
                && token.start == payload_start_character
                && token.length == payload_length
                && token.token_type == token_type(SemanticTokenKind::String)
                && token.token_modifiers_bitset
                    == token_modifier_bitset(CoreSemanticTokenModifier::Payload)
        }));
    }

    #[test]
    fn semantic_tokens_range_filters_to_requested_markdown_fence() {
        let mut store = DocumentStore::new();
        let uri = Url::parse("file:///tmp/example.md").unwrap();
        let snapshot = store.upsert(
            uri,
            1,
            concat!(
                "intro\n",
                "```mermaid\n",
                "sequenceDiagram\n",
                "title: First\n",
                "```\n",
                "middle\n",
                "```mermaid\n",
                "sequenceDiagram\n",
                "title: Second\n",
                "```\n",
                "outro\n",
            )
            .to_string(),
        );

        let tokens = semantic_tokens_for_snapshot_range(
            &snapshot,
            Range::new(Position::new(6, 0), Position::new(10, 0)),
        );
        let decoded = decode_tokens(&tokens.data);

        let first_start = snapshot.text.find("First").unwrap();
        let first_span = snapshot
            .source_map
            .span(first_start, first_start + "First".len())
            .expect("first title span should map");
        let second_start = snapshot.text.find("Second").unwrap();
        let second_span = snapshot
            .source_map
            .span(second_start, second_start + "Second".len())
            .expect("second title span should map");
        let second_line = second_span.lsp_range.start.line as u32;
        let second_start_character = second_span.lsp_range.start.character as u32;
        let second_length =
            (second_span.lsp_range.end.character - second_span.lsp_range.start.character) as u32;
        let payload_bitset = token_modifier_bitset(CoreSemanticTokenModifier::Payload);

        assert!(decoded.iter().any(|token| {
            token.line == second_line
                && token.start == second_start_character
                && token.length == second_length
                && token.token_type == token_type(SemanticTokenKind::String)
                && token.token_modifiers_bitset == payload_bitset
        }));
        assert!(
            !decoded
                .iter()
                .any(|token| token.line == first_span.lsp_range.start.line as u32),
            "range request should not return tokens from the first fence: {decoded:?}"
        );
    }

    #[test]
    fn semantic_tokens_split_multiline_payload_spans() {
        let mut store = DocumentStore::new();
        let uri = Url::parse("file:///tmp/example.mmd").unwrap();
        let snapshot = store.upsert(
            uri,
            1,
            "gantt\naccDescr {\nline one\nline two\n}\n".to_string(),
        );
        let tokens = semantic_tokens_for_snapshot(&snapshot);
        let decoded = decode_tokens(&tokens.data);
        let payload_bitset = token_modifier_bitset(CoreSemanticTokenModifier::Payload);
        let payload_tokens = decoded
            .iter()
            .filter(|token| {
                token.token_type == token_type(SemanticTokenKind::String)
                    && token.token_modifiers_bitset == payload_bitset
            })
            .collect::<Vec<_>>();

        assert!(
            payload_tokens.len() >= 2,
            "expected multiline payload to produce per-line semantic tokens: {decoded:?}"
        );
    }

    #[test]
    fn semantic_tokens_delta_result_prefers_edits_over_full_tokens() {
        let previous = vec![
            SemanticToken {
                delta_line: 0,
                delta_start: 0,
                length: 3,
                token_type: token_type(SemanticTokenKind::Namespace),
                token_modifiers_bitset: 0,
            },
            SemanticToken {
                delta_line: 0,
                delta_start: 4,
                length: 2,
                token_type: token_type(SemanticTokenKind::String),
                token_modifiers_bitset: token_modifier_bitset(CoreSemanticTokenModifier::Payload),
            },
        ];
        let current = vec![
            SemanticToken {
                delta_line: 0,
                delta_start: 0,
                length: 3,
                token_type: token_type(SemanticTokenKind::Namespace),
                token_modifiers_bitset: 0,
            },
            SemanticToken {
                delta_line: 0,
                delta_start: 5,
                length: 2,
                token_type: token_type(SemanticTokenKind::String),
                token_modifiers_bitset: token_modifier_bitset(CoreSemanticTokenModifier::Payload),
            },
        ];

        let result = semantic_tokens_delta_result(&previous, &current, "next".to_string());
        let SemanticTokensFullDeltaResult::TokensDelta(delta) = result else {
            panic!("expected delta tokens");
        };

        assert_eq!(delta.result_id.as_deref(), Some("next"));
        assert_eq!(delta.edits.len(), 1);
        assert!(!delta.edits[0].data.as_ref().unwrap().is_empty());
    }

    fn decode_tokens(tokens: &[SemanticToken]) -> Vec<AbsoluteToken> {
        let mut line = 0u32;
        let mut start = 0u32;
        let mut decoded = Vec::new();

        for token in tokens {
            line += token.delta_line;
            if token.delta_line == 0 {
                start += token.delta_start;
            } else {
                start = token.delta_start;
            }

            decoded.push(AbsoluteToken {
                line,
                start,
                length: token.length,
                token_type: token.token_type,
                token_modifiers_bitset: token.token_modifiers_bitset,
            });
        }

        decoded
    }
}