chisel-common 1.1.0

Chisel common macros, types and functions
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

use std::cmp::Ordering;
use std::fmt::{Display, Formatter};

use crate::char::coords::Coords;

/// A [Span] represents a linear interval within the parser input, between to different [Coords]
#[derive(Debug, Default, Copy, Clone, PartialEq)]
pub struct Span {
    /// Start [Coords] for the span
    pub start: Coords,
    /// End [Coords] for the span
    pub end: Coords,
}

impl Span {}

impl Eq for Span {}

impl PartialOrd<Self> for Span {
    /// The partial order is based on the start coordinates for a span
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        match self.start.cmp(&other.start) {
            Ordering::Less => Some(Ordering::Less),
            Ordering::Equal => Some(Ordering::Equal),
            Ordering::Greater => Some(Ordering::Greater),
        }
    }
}

impl Ord for Span {
    /// The total order for a span is based on the start coordinates of a span
    fn cmp(&self, other: &Self) -> Ordering {
        self.start.cmp(&other.start)
    }
}

impl Display for Span {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "start: {}, end: {}", self.start, self.end,)
    }
}
#[cfg(test)]
mod test {
    use crate::char::coords::Coords;
    use crate::char::span::Span;

    #[test]
    fn equality_between_defaults() {
        let s1 = Span::default();
        let s2 = Span::default();
        assert_eq!(s1, s2)
    }

    #[test]
    fn basic_ordering_should_work() {
        let mut s1 = Span::default();
        let s2 = Span::default();
        s1.start = Coords {
            line: 2,
            column: 1,
            absolute: 3,
        };
        assert!(s1 > s2)
    }
}