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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

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

#[derive(Clone, Debug, PartialEq)]
pub enum FunctionDataTypeOrImplicit<'a> {
    DataType(Box<DataTypeOrVoid<'a>>),
    Implicit(Box<ImplicitDataType<'a>>),
}

#[derive(Clone, Debug, PartialEq)]
pub struct FunctionDeclaration<'a>(
    pub Metadata<'a>, // function
    pub Option<DynamicOverrideSpecifiers<'a>>,
    pub Option<Lifetime<'a>>,
    pub FunctionBodyDeclaration<'a>,
);

#[derive(Clone, Debug, PartialEq)]
pub enum FunctionBodyDeclaration<'a> {
    Tf(
        Box<(
            FunctionDataTypeOrImplicit<'a>,
            Option<InterfaceIdentifierOrClassScope<'a>>,
            FunctionIdentifier<'a>,
            Metadata<'a>, // ;
            Vec<TfItemDeclaration<'a>>,
            Vec<FunctionStatementOrNull<'a>>,
            Metadata<'a>, // endfunction
            Option<(
                Metadata<'a>, // :
                FunctionIdentifier<'a>,
            )>,
        )>,
    ),
    Block(
        Box<(
            FunctionDataTypeOrImplicit<'a>,
            Option<InterfaceIdentifierOrClassScope<'a>>,
            FunctionIdentifier<'a>,
            Metadata<'a>, // (
            Option<TfPortList<'a>>,
            Metadata<'a>, // )
            Metadata<'a>, // ;
            Vec<BlockItemDeclaration<'a>>,
            Vec<FunctionStatementOrNull<'a>>,
            Metadata<'a>, // endfunction
            Option<(
                Metadata<'a>, // :
                FunctionIdentifier<'a>,
            )>,
        )>,
    ),
}

#[derive(Clone, Debug, PartialEq)]
pub struct FunctionPrototype<'a>(
    pub Metadata<'a>, // function
    pub Option<DynamicOverrideSpecifiers<'a>>,
    pub DataTypeOrVoid<'a>,
    pub FunctionIdentifier<'a>,
    pub  Option<(
        Metadata<'a>, // (
        Option<TfPortList<'a>>,
        Metadata<'a>, // )
    )>,
);

#[derive(Clone, Debug, PartialEq)]
pub enum DpiImportExport<'a> {
    FunctionImport(
        Box<(
            Metadata<'a>, // import
            DpiSpecString<'a>,
            Option<DpiFunctionImportProperty<'a>>,
            Option<(
                CIdentifier<'a>,
                Metadata<'a>, // =
            )>,
            DpiFunctionProto<'a>,
            Metadata<'a>, // ;
        )>,
    ),
    TaskImport(
        Box<(
            Metadata<'a>, // import
            DpiSpecString<'a>,
            Option<DpiTaskImportProperty<'a>>,
            Option<(
                CIdentifier<'a>,
                Metadata<'a>, // =
            )>,
            DpiTaskProto<'a>,
            Metadata<'a>, // ;
        )>,
    ),
    FunctionExport(
        Box<(
            Metadata<'a>, // export
            DpiSpecString<'a>,
            Option<(
                CIdentifier<'a>,
                Metadata<'a>, // =
            )>,
            Metadata<'a>, // function
            FunctionIdentifier<'a>,
            Metadata<'a>, // ;
        )>,
    ),
    TaskExport(
        Box<(
            Metadata<'a>, // export
            DpiSpecString<'a>,
            Option<(
                CIdentifier<'a>,
                Metadata<'a>, // =
            )>,
            Metadata<'a>, // task
            TaskIdentifier<'a>,
            Metadata<'a>, // ;
        )>,
    ),
}

#[derive(Clone, Debug, PartialEq)]
pub enum DpiSpecString<'a> {
    DpiC(Metadata<'a>),
    Dpi(Metadata<'a>),
}

#[derive(Clone, Debug, PartialEq)]
pub enum DpiFunctionImportProperty<'a> {
    Context(Metadata<'a>),
    Pure(Metadata<'a>),
}

#[derive(Clone, Debug, PartialEq)]
pub struct DpiTaskImportProperty<'a>(
    pub Metadata<'a>, // context
);

#[derive(Clone, Debug, PartialEq)]
pub struct DpiFunctionProto<'a>(pub FunctionPrototype<'a>);

#[derive(Clone, Debug, PartialEq)]
pub struct DpiTaskProto<'a>(pub TaskPrototype<'a>);