meta-language 0.20.0

A self-describing links-network core for lossless language representation
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

/// Half-open byte range in source text.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct ByteRange {
    start: usize,
    end: usize,
}

impl ByteRange {
    /// Creates a byte range.
    ///
    /// # Panics
    ///
    /// Panics when `start` is greater than `end`.
    #[must_use]
    pub const fn new(start: usize, end: usize) -> Self {
        assert!(start <= end, "byte range start must not exceed end");
        Self { start, end }
    }

    /// First byte in the range.
    #[must_use]
    pub const fn start(self) -> usize {
        self.start
    }

    /// Byte immediately after the range.
    #[must_use]
    pub const fn end(self) -> usize {
        self.end
    }

    /// Returns `true` when this range intersects `other`.
    #[must_use]
    pub const fn intersects(self, other: Self) -> bool {
        if self.start == self.end || other.start == other.end {
            self.start <= other.end && other.start <= self.end
        } else {
            self.start < other.end && other.start < self.end
        }
    }
}

/// Row and column point in source text.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Point {
    row: usize,
    column: usize,
}

impl Point {
    /// Creates a row/column point.
    #[must_use]
    pub const fn new(row: usize, column: usize) -> Self {
        Self { row, column }
    }

    /// Zero-based row.
    #[must_use]
    pub const fn row(self) -> usize {
        self.row
    }

    /// Zero-based column.
    #[must_use]
    pub const fn column(self) -> usize {
        self.column
    }
}

/// Source span attached to a link.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct SourceSpan {
    byte_range: ByteRange,
    start_point: Point,
    end_point: Point,
}

impl SourceSpan {
    /// Creates a source span from byte and point ranges.
    #[must_use]
    pub const fn new(byte_range: ByteRange, start_point: Point, end_point: Point) -> Self {
        Self {
            byte_range,
            start_point,
            end_point,
        }
    }

    /// Byte range covered by the span.
    #[must_use]
    pub const fn byte_range(self) -> ByteRange {
        self.byte_range
    }

    /// Start row/column point.
    #[must_use]
    pub const fn start_point(self) -> Point {
        self.start_point
    }

    /// End row/column point.
    #[must_use]
    pub const fn end_point(self) -> Point {
        self.end_point
    }
}