ginko 0.0.6

A device-tree source parser and analyzer
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

use crate::dts::data::HasSource;
use crate::dts::{HasSpan, Span};
use std::fmt::{Display, Formatter};
use std::path::Path;
use std::sync::Arc;

#[derive(Eq, PartialEq, Debug, Clone)]
pub enum TokenKind {
    Semicolon,
    // ;
    Slash,
    // /
    Equal,
    // =
    OpenBracket,
    // [
    CloseBracket,
    // ]
    OpenParen,
    // (
    CloseParen,
    // )
    ChevronLeft,
    // <
    ChevronRight,
    // >
    Comma,
    // ,
    OpenBrace,
    // {
    CloseBrace,
    // }
    Ident(String),
    // The most basic identifier, representing everything from node-name to byte string
    Label(String),
    String(String),
    // Since numbers can appear in various circumstances,
    // this simply represents a string starting with a number.
    // Verifying this number is done by the parser when more context is available.
    UnparsedNumber(String),
    Directive(CompilerDirective),
    Ref(Reference),
    Comment(String),
    Unknown(u8),
}

#[derive(Eq, PartialEq, Debug, Clone)]
pub enum CompilerDirective {
    DTSVersionHeader,
    MemReserve,
    DeleteNode,
    DeleteProperty,
    Plugin,
    Bits,
    OmitIfNoRef,
    Include,
    Other(String),
}

impl Display for CompilerDirective {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            CompilerDirective::DTSVersionHeader => write!(f, "/dts-v1/"),
            CompilerDirective::MemReserve => write!(f, "/memreserve/"),
            CompilerDirective::DeleteNode => write!(f, "/delete-node/"),
            CompilerDirective::DeleteProperty => write!(f, "/delete-property/"),
            CompilerDirective::Plugin => write!(f, "/plugin/"),
            CompilerDirective::Bits => write!(f, "/bits/"),
            CompilerDirective::OmitIfNoRef => write!(f, "/omit-if-no-ref/"),
            CompilerDirective::Include => write!(f, "/include/"),
            CompilerDirective::Other(other) => write!(f, "/{other}/"),
        }
    }
}

#[derive(Eq, PartialEq, Debug, Clone)]
pub enum Reference {
    // &some_label
    Simple(String),
    // &{/path/to/some/label}
    // Verification happens at the parser / analysis site
    Path(String),
}

#[derive(Eq, PartialEq, Debug, Clone)]
pub struct Token {
    pub kind: TokenKind,
    pub span: Span,
    pub source: Arc<Path>,
}

impl HasSpan for Token {
    fn span(&self) -> Span {
        self.span
    }
}

impl HasSource for Token {
    fn source(&self) -> Arc<Path> {
        self.source.clone()
    }
}