blues-lsp 0.1.0

LSP language server for the Bluespec SystemVerilog language
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
use std::{cmp::Ordering, ops::Range, sync::Arc};

use tracing::debug;

use crate::project::file::FileContents;

#[derive(Debug)]
pub struct OriginTable {
    /// Indexed by `OriginId`
    table: Vec<Origin>,
}

impl OriginTable {
    pub fn new(root: Arc<FileContents>) -> Self {
        Self {
            table: vec![
                Origin {
                    origin: 0,
                    span: FileSpan::default(),
                    file: root.clone(),
                    reason: OriginReason::Root,
                },
                Origin {
                    origin: 0,
                    span: FileSpan::default(),
                    file: root.clone(),
                    reason: OriginReason::Builtin,
                },
                Origin {
                    origin: 0,
                    span: FileSpan::default(),
                    file: root,
                    reason: OriginReason::Cli,
                },
            ],
        }
    }

    pub fn get(&self, id: OriginId) -> &Origin {
        &self.table[id as usize]
    }

    pub fn add(&mut self, origin: Origin) -> OriginId {
        let id = self.table.len() as u32;
        self.table.push(origin);
        id
    }

    pub fn root(&self) -> Arc<FileContents> {
        self.get(ROOT_ORIGIN).file.clone()
    }
}

/// Id for OriginTable
pub type OriginId = u32;
pub const ROOT_ORIGIN: OriginId = 0;
pub const BUILTIN_ORIGIN: OriginId = 1;
pub const CLI_ORIGIN: OriginId = 2;

#[derive(Debug)]
pub struct Origin {
    pub origin: OriginId,

    /// Span in parrent origin
    pub span: FileSpan,

    /// New source, if needed.
    /// Otherwise same as parent origin
    // TODO: Turn this into a handle (path)
    pub file: Arc<FileContents>,

    pub reason: OriginReason,
}

#[derive(Debug, Clone, Copy)]
pub enum OriginReason {
    /// Root file of the CU
    Root,
    /// Result of macro expansion
    Macro,
    /// Macro interpolation (arguments)
    MacroInterp,
    /// File inlcude
    Include,
    /// Built-in (`bluespec and `BLUESPEC)
    Builtin,
    /// From CLI args
    Cli,
}

#[derive(Debug, Clone, Copy, Default)]
pub struct Span {
    pub origin: OriginId,
    pub text_span: FileSpan,
}

impl Span {
    pub fn cross_origin(l: Pos, r: Pos, ot: &OriginTable) -> Self {
        // TODO: In case we have a span across origins, we should
        // probably find closest parent origin and go from there...
        if l.origin != r.origin {
            // Temp placeholder until we do just that:
            debug!("TODO: unhandled cross-origin span between: {l:?}, {r:?}");
            return Self {
                origin: l.origin,
                text_span: FileSpan::empty_at(l.text_pos),
            };
        }

        let file = &ot.get(l.origin).file;

        Self {
            origin: l.origin,
            text_span: FileSpan::from_range(l.text_pos..r.text_pos, file),
        }
    }

    pub fn empty_at(pos: Pos) -> Self {
        Self {
            origin: pos.origin,
            text_span: FileSpan::empty_at(pos.text_pos),
        }
    }

    pub fn empty_at_start(self) -> Self {
        Self {
            origin: self.origin,
            text_span: self.text_span.empty_at_start(),
        }
    }

    pub fn empty_at_end(self, ot: &OriginTable) -> Self {
        Self {
            origin: self.origin,
            text_span: self.text_span.empty_at_end(&ot.get(self.origin).file),
        }
    }

    pub fn start(&self) -> Pos {
        Pos {
            origin: self.origin,
            text_pos: self.text_span.start,
        }
    }

    pub fn end(&self, ot: &OriginTable) -> Pos {
        Pos {
            origin: self.origin,
            text_pos: self.text_span.end(&ot.get(self.origin).file),
        }
    }

    pub fn contains(&self, pos: &Pos, ot: &OriginTable) -> Option<bool> {
        let start = self.start();
        let end = self.end(ot);

        Some(start.try_cmp(pos)?.is_le() && pos.try_cmp(&end)?.is_le())
    }

    pub fn parent_span(&self, ot: &OriginTable) -> Option<Self> {
        if self.origin == ROOT_ORIGIN {
            None
        } else {
            let origin = ot.get(self.origin);
            Some(Span {
                origin: origin.origin,
                text_span: origin.span,
            })
        }
    }

    pub fn to_lsp(&self, ot: &OriginTable) -> lsp_types::Range {
        let mut span = *self;
        while let Some(parent) = span.parent_span(ot) {
            span = parent;
        }
        span.text_span.to_lsp(&ot.get(span.origin).file)
    }

    pub fn root_span(&self) -> Option<FileSpan> {
        if self.origin != ROOT_ORIGIN {
            return None;
        }
        Some(self.text_span)
    }
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub struct Pos {
    pub origin: OriginId,
    pub text_pos: FilePos,
}

impl Pos {
    pub const fn zero() -> Self {
        Pos {
            origin: ROOT_ORIGIN,
            text_pos: FilePos {
                line: 0,
                col: LspCol(0),
            },
        }
    }

    pub fn from_lsp(lsp: lsp_types::Position) -> Self {
        Self {
            origin: ROOT_ORIGIN,
            text_pos: FilePos::from_lsp(lsp),
        }
    }

    pub fn parent_span(&self, ot: &OriginTable) -> Option<Self> {
        if self.origin == ROOT_ORIGIN {
            None
        } else {
            let origin = ot.get(self.origin);
            Some(Pos {
                origin: origin.origin,
                text_pos: origin.span.start,
            })
        }
    }

    pub fn to_lsp(&self, ot: &OriginTable) -> lsp_types::Position {
        let mut pos = *self;
        while let Some(parent) = pos.parent_span(ot) {
            pos = parent;
        }
        pos.text_pos.to_lsp()
    }

    pub fn at(origin: OriginId, line: u32, col: u32) -> Self {
        Self {
            origin,
            text_pos: FilePos {
                line,
                col: LspCol::from_raw(col),
            },
        }
    }

    pub fn try_cmp(&self, other: &Self) -> Option<Ordering> {
        // TODO: properly handle cross-origin stuff
        if self.origin != other.origin {
            None
        } else {
            Some(self.text_pos.cmp(&other.text_pos))
        }
    }
}

#[derive(Debug, Clone, Copy, Default)]
pub struct FileSpan {
    pub start: FilePos,
    pub len: LspCol,
}

impl FileSpan {
    pub fn empty_at(start: FilePos) -> Self {
        Self {
            start,
            len: LspCol::from_raw(0),
        }
    }

    pub fn from_range(range: Range<FilePos>, file: &FileContents) -> Self {
        let start = range.start;
        let len = file.pos_diff(range);
        Self { start, len }
    }

    pub fn to_lsp(&self, file: &FileContents) -> lsp_types::Range {
        let start = self.start;
        let end = self.end(file);
        lsp_types::Range {
            start: start.to_lsp(),
            end: end.to_lsp(),
        }
    }

    pub fn end(&self, file: &FileContents) -> FilePos {
        file.pos_add(self.start, self.len)
    }

    pub fn empty_at_start(&self) -> Self {
        FileSpan {
            start: self.start,
            len: LspCol::from_raw(0),
        }
    }

    pub fn empty_at_end(&self, file: &FileContents) -> Self {
        FileSpan {
            start: self.end(file),
            len: LspCol::from_raw(0),
        }
    }

    pub fn overlaps(&self, other: &Self, file: &FileContents) -> bool {
        let self_end = self.end(file);
        let other_end = other.end(file);
        self.start < other_end && self_end > other.start
    }
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub struct FilePos {
    pub line: u32,
    pub col: LspCol,
}

impl FilePos {
    pub fn to_lsp(&self) -> lsp_types::Position {
        lsp_types::Position {
            line: self.line,
            character: self.col.to_lsp(),
        }
    }

    pub fn from_lsp(lsp: lsp_types::Position) -> Self {
        Self {
            line: lsp.line,
            col: LspCol::from_raw(lsp.character),
        }
    }

    /// Advance possition by given char (eg. increment line count on newline)
    ///
    /// NOTE: "\r\n" and "\r" are not handled.
    /// They should be normalized to "\n" by caller code.
    pub fn advance(&mut self, char: char) {
        // Fun fact: this diverges from bsc's implementation for counting
        // line:col. bsc doesn't properly handle "\r\n" and "\r" line endings,
        // and treats tabs as converted spaces, for some reason.
        //
        // That's fine, we want to match LSP spec here.
        // TODO: Maybe file a bsc issue.
        match char {
            '\r' => unreachable!(),
            '\n' => {
                self.line += 1;
                self.col = LspCol::start();
            }
            c => self.col.advance(c),
        }
    }
}

impl PartialOrd for FilePos {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for FilePos {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.line.cmp(&other.line).then(self.col.cmp(&other.col))
    }
}

#[derive(Debug, Clone, Copy, Default)]
pub struct LineColCounter {
    pos: FilePos,
    post_cr: bool,
}

impl LineColCounter {
    pub fn start_at(pos: FilePos) -> Self {
        Self {
            pos,
            post_cr: false,
        }
    }

    pub fn pos(&self, next: Option<char>) -> FilePos {
        let mut pos = self.pos;
        if self.post_cr && next != Some('\n') {
            pos.advance('\n');
        }
        pos
    }

    pub fn advance(&mut self, c: char) {
        if self.post_cr && c != '\n' {
            self.pos.advance('\n');
        }
        self.post_cr = false;
        match c {
            '\r' => self.post_cr = true,
            c => self.pos.advance(c),
        }
    }
}

/// Source column, in unit negotiated with LSP client (either UTF-8 or UTF-16 codepoints)
///
/// For now only UTF-16 is supported
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord)]
pub struct LspCol(u32);

impl LspCol {
    pub fn from_raw(col: u32) -> Self {
        LspCol(col)
    }

    pub fn to_raw(self) -> u32 {
        self.0
    }

    pub fn start() -> Self {
        LspCol(0)
    }

    pub fn advance(&mut self, char: char) {
        self.0 += char.len_utf16() as u32;
    }

    pub fn to_lsp(&self) -> u32 {
        self.0
    }
}