pactole-syntax 0.2.0

Tolerant tree-sitter-based syntax analysis (spans and diagnostics) for Pactole documents.
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

//! Byte-offset and row/column spans for syntax nodes.

use std::fmt;

/// A single position in the source text, expressed both as a byte offset and
/// as a zero-indexed (row, column) pair.
///
/// The `column` is a byte offset within its `row`, matching tree-sitter's
/// [`tree_sitter::Point`] semantics.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Point {
    /// Zero-indexed byte offset of the position within the whole source text.
    pub byte: usize,
    /// Zero-indexed row (line number).
    pub row: usize,
    /// Zero-indexed column (byte offset within `row`).
    pub column: usize,
}

impl Point {
    /// Builds a [`Point`] from a tree-sitter [`tree_sitter::Point`] and a byte offset.
    pub fn new(byte: usize, ts_point: tree_sitter::Point) -> Self {
        Self {
            byte,
            row: ts_point.row,
            column: ts_point.column,
        }
    }
}

impl fmt::Display for Point {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}:{}", self.row + 1, self.column + 1)
    }
}

/// A contiguous range in the source text, delimited by a start and end [`Point`].
///
/// The range is half-open: `start` is inclusive and `end` is exclusive, mirroring
/// tree-sitter's node range semantics.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Span {
    /// Inclusive start position of the span.
    pub start: Point,
    /// Exclusive end position of the span.
    pub end: Point,
}

impl Span {
    /// Builds a [`Span`] from a start and end [`Point`].
    pub fn new(start: Point, end: Point) -> Self {
        Self { start, end }
    }

    /// Builds a [`Span`] covering the full range of a tree-sitter [`tree_sitter::Node`].
    pub fn from_node(node: &tree_sitter::Node) -> Self {
        Self {
            start: Point::new(node.start_byte(), node.start_position()),
            end: Point::new(node.end_byte(), node.end_position()),
        }
    }

    /// The byte range covered by this span, usable to slice the original source text.
    pub fn byte_range(&self) -> std::ops::Range<usize> {
        self.start.byte..self.end.byte
    }
}

impl fmt::Display for Span {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}-{}", self.start, self.end)
    }
}