scarf-syntax 0.2.1

A helper crate of scarf for expressing a SystemVerilog concrete syntax tree
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

// =======================================================================
// generated_instantiation.rs
// =======================================================================
//! CST Nodes from 1800-2023 A.4.2
use crate::*;

#[derive(Clone, Debug, PartialEq)]
pub struct GenerateRegion<'a>(
    pub Metadata<'a>, // generate
    pub Vec<GenerateItem<'a>>,
    pub Metadata<'a>, // endgenerate
);

#[derive(Clone, Debug, PartialEq)]
pub struct LoopGenerateConstruct<'a>(
    pub Metadata<'a>, // for
    pub Metadata<'a>, // (
    pub GenvarInitialization<'a>,
    pub Metadata<'a>, // ;
    pub GenvarExpression<'a>,
    pub Metadata<'a>, // ;
    pub GenvarIteration<'a>,
    pub Metadata<'a>, // )
    pub GenerateBlock<'a>,
);

#[derive(Clone, Debug, PartialEq)]
pub struct GenvarInitialization<'a>(
    pub Option<Metadata<'a>>, // genvar
    pub GenvarIdentifier<'a>,
    pub Metadata<'a>, // =
    pub ConstantExpression<'a>,
);

#[derive(Clone, Debug, PartialEq)]
pub enum GenvarIteration<'a> {
    Assignment(
        Box<(
            GenvarIdentifier<'a>,
            AssignmentOperator<'a>,
            GenvarExpression<'a>,
        )>,
    ),
    Prefix(Box<(IncOrDecOperator<'a>, GenvarIdentifier<'a>)>),
    Postfix(Box<(GenvarIdentifier<'a>, IncOrDecOperator<'a>)>),
}

#[derive(Clone, Debug, PartialEq)]
pub enum ConditionalGenerateConstruct<'a> {
    If(Box<IfGenerateConstruct<'a>>),
    Case(Box<CaseGenerateConstruct<'a>>),
}

#[derive(Clone, Debug, PartialEq)]
pub struct IfGenerateConstruct<'a>(
    pub Metadata<'a>, // if
    pub Metadata<'a>, // (
    pub ConstantExpression<'a>,
    pub Metadata<'a>, // )
    pub GenerateBlock<'a>,
    pub  Option<(
        Metadata<'a>, // else
        GenerateBlock<'a>,
    )>,
);

#[derive(Clone, Debug, PartialEq)]
pub struct CaseGenerateConstruct<'a>(
    pub Metadata<'a>, // case
    pub Metadata<'a>, // (
    pub ConstantExpression<'a>,
    pub Metadata<'a>, // )
    pub CaseGenerateItem<'a>,
    pub Vec<CaseGenerateItem<'a>>,
    pub Metadata<'a>, // endcase
);

#[derive(Clone, Debug, PartialEq)]
pub enum CaseGenerateItem<'a> {
    Expression(
        Box<(
            ConstantExpression<'a>,
            Vec<(
                Metadata<'a>, // ,
                ConstantExpression<'a>,
            )>,
            Metadata<'a>, // :
            GenerateBlock<'a>,
        )>,
    ),
    Default(
        Box<(
            Metadata<'a>,         // default
            Option<Metadata<'a>>, // :
            GenerateBlock<'a>,
        )>,
    ),
}

#[derive(Clone, Debug, PartialEq)]
pub enum GenerateBlock<'a> {
    Item(Box<GenerateItem<'a>>),
    Block(
        Box<(
            Option<(
                GenerateBlockIdentifier<'a>,
                Metadata<'a>, // :
            )>,
            Metadata<'a>, // begin
            Option<(
                Metadata<'a>, // :
                GenerateBlockIdentifier<'a>,
            )>,
            Vec<GenerateItem<'a>>,
            Metadata<'a>, // end
            Option<(
                Metadata<'a>, // :
                GenerateBlockIdentifier<'a>,
            )>,
        )>,
    ),
}

#[derive(Clone, Debug, PartialEq)]
pub enum GenerateItem<'a> {
    Module(Box<ModuleOrGenerateItem<'a>>),
    Interface(Box<InterfaceOrGenerateItem<'a>>),
    Checker(Box<CheckerOrGenerateItem<'a>>),
}