veryl-metadata 0.14.1

A modern hardware description language
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

use regex::Regex;
use serde::{Deserialize, Serialize};
use std::fmt;

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Lint {
    #[serde(default)]
    pub naming: LintNaming,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct LintNaming {
    #[serde(default)]
    pub case_clock_domain: Option<Case>,
    #[serde(default)]
    pub case_enum: Option<Case>,
    #[serde(default)]
    pub case_function: Option<Case>,
    #[serde(default)]
    pub case_function_inout: Option<Case>,
    #[serde(default)]
    pub case_function_input: Option<Case>,
    #[serde(default)]
    pub case_function_output: Option<Case>,
    #[serde(default)]
    pub case_function_ref: Option<Case>,
    #[serde(default)]
    pub case_instance: Option<Case>,
    #[serde(default)]
    pub case_interface: Option<Case>,
    #[serde(default)]
    pub case_modport: Option<Case>,
    #[serde(default)]
    pub case_module: Option<Case>,
    #[serde(default)]
    pub case_package: Option<Case>,
    #[serde(default)]
    pub case_parameter: Option<Case>,
    #[serde(default)]
    pub case_port_inout: Option<Case>,
    #[serde(default)]
    pub case_port_input: Option<Case>,
    #[serde(default)]
    pub case_port_modport: Option<Case>,
    #[serde(default)]
    pub case_port_output: Option<Case>,
    #[serde(default)]
    pub case_reg: Option<Case>,
    #[serde(default)]
    pub case_struct: Option<Case>,
    #[serde(default)]
    pub case_union: Option<Case>,
    #[serde(default)]
    pub case_var: Option<Case>,
    #[serde(default)]
    pub case_wire: Option<Case>,
    #[serde(default)]
    pub prefix_clock_domain: Option<String>,
    #[serde(default)]
    pub prefix_enum: Option<String>,
    #[serde(default)]
    pub prefix_function: Option<String>,
    #[serde(default)]
    pub prefix_function_inout: Option<String>,
    #[serde(default)]
    pub prefix_function_input: Option<String>,
    #[serde(default)]
    pub prefix_function_output: Option<String>,
    #[serde(default)]
    pub prefix_function_ref: Option<String>,
    #[serde(default)]
    pub prefix_instance: Option<String>,
    #[serde(default)]
    pub prefix_interface: Option<String>,
    #[serde(default)]
    pub prefix_modport: Option<String>,
    #[serde(default)]
    pub prefix_module: Option<String>,
    #[serde(default)]
    pub prefix_package: Option<String>,
    #[serde(default)]
    pub prefix_parameter: Option<String>,
    #[serde(default)]
    pub prefix_port_inout: Option<String>,
    #[serde(default)]
    pub prefix_port_input: Option<String>,
    #[serde(default)]
    pub prefix_port_modport: Option<String>,
    #[serde(default)]
    pub prefix_port_output: Option<String>,
    #[serde(default)]
    pub prefix_reg: Option<String>,
    #[serde(default)]
    pub prefix_struct: Option<String>,
    #[serde(default)]
    pub prefix_union: Option<String>,
    #[serde(default)]
    pub prefix_var: Option<String>,
    #[serde(default)]
    pub prefix_wire: Option<String>,
    #[serde(default)]
    pub suffix_clock_domain: Option<String>,
    #[serde(default)]
    pub suffix_enum: Option<String>,
    #[serde(default)]
    pub suffix_function: Option<String>,
    #[serde(default)]
    pub suffix_function_inout: Option<String>,
    #[serde(default)]
    pub suffix_function_input: Option<String>,
    #[serde(default)]
    pub suffix_function_output: Option<String>,
    #[serde(default)]
    pub suffix_function_ref: Option<String>,
    #[serde(default)]
    pub suffix_instance: Option<String>,
    #[serde(default)]
    pub suffix_interface: Option<String>,
    #[serde(default)]
    pub suffix_modport: Option<String>,
    #[serde(default)]
    pub suffix_module: Option<String>,
    #[serde(default)]
    pub suffix_package: Option<String>,
    #[serde(default)]
    pub suffix_parameter: Option<String>,
    #[serde(default)]
    pub suffix_port_inout: Option<String>,
    #[serde(default)]
    pub suffix_port_input: Option<String>,
    #[serde(default)]
    pub suffix_port_modport: Option<String>,
    #[serde(default)]
    pub suffix_port_output: Option<String>,
    #[serde(default)]
    pub suffix_reg: Option<String>,
    #[serde(default)]
    pub suffix_struct: Option<String>,
    #[serde(default)]
    pub suffix_union: Option<String>,
    #[serde(default)]
    pub suffix_var: Option<String>,
    #[serde(default)]
    pub suffix_wire: Option<String>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_clock_domain: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_enum: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_function: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_function_inout: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_function_input: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_function_output: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_function_ref: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_instance: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_interface: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_modport: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_module: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_package: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_parameter: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_port_inout: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_port_input: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_port_modport: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_port_output: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_reg: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_struct: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_union: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_var: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_forbidden_wire: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_clock_domain: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_enum: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_function: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_function_inout: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_function_input: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_function_output: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_function_ref: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_instance: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_interface: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_modport: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_module: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_package: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_parameter: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_port_inout: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_port_input: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_port_modport: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_port_output: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_reg: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_struct: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_union: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_var: Option<Regex>,
    #[serde(default, with = "serde_regex")]
    pub re_required_wire: Option<Regex>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub enum Case {
    #[default]
    #[serde(rename = "snake")]
    Snake,
    #[serde(rename = "screaming_snake")]
    ScreamingSnake,
    #[serde(rename = "upper_camel")]
    UpperCamel,
    #[serde(rename = "lower_camel")]
    LowerCamel,
}

impl fmt::Display for Case {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let text = match self {
            Case::Snake => "snake_case".to_string(),
            Case::ScreamingSnake => "SCREAMING_SNAKE_CASE".to_string(),
            Case::UpperCamel => "UpperCamelCase".to_string(),
            Case::LowerCamel => "lowerCamelCase".to_string(),
        };
        text.fmt(f)
    }
}