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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
use crate::{Location, case, error::*};
use serde::{Deserialize, Serialize};
use std::{cmp::Eq, collections::HashSet, hash::Hash, path::PathBuf};
/// Enum representing integer types
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum IntegerType {
/// Signed 8-bit integer
I8,
/// Signed 16-bit integer
I16,
/// Signed 32-bit integer
I32,
/// Signed 64-bit integer
I64,
/// Unsigned 8-bit integer
U8,
/// Unsigned 16-bit integer
U16,
/// Unsigned 32-bit integer
U32,
/// Unsigned 64-bit integer
U64,
}
/// Enum representing integer values
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Eq)]
pub enum IntegerValue {
/// Signed 8-bit integer value
I8(i8),
/// Signed 16-bit integer value
I16(i16),
/// Signed 32-bit integer value
I32(i32),
/// Signed 64-bit integer value
I64(i64),
/// Unsigned 8-bit integer value
U8(u8),
/// Unsigned 16-bit integer value
U16(u16),
/// Unsigned 32-bit integer value
U32(u32),
/// Unsigned 64-bit integer value
U64(u64),
}
/// Enum representing float values
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum FloatType {
/// 32-bit floating-point value
F32,
/// 64-bit floating-point value
F64,
}
/// Enum representing all built-in types
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum BuiltinType {
/// Integer types
Integer(IntegerType),
/// Float types
Float(FloatType),
/// String type
String,
/// Bool type
Bool,
}
/// Identifier type
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Ident {
/// The name of the identifier
pub name: String,
/// The location of the identifier in the source file
pub location: Location,
}
impl Ident {
/// Returns a reference to the name of the identifier
pub fn as_str(&self) -> &str {
self.name.as_str()
}
/// Returns a reference to the location of the identifier
pub fn as_location(&self) -> &Location {
&self.location
}
}
impl Hash for Ident {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
self.name.hash(state);
}
}
impl Eq for Ident {}
/// Enum representing all field types
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum FieldType {
/// Array type
Array(Box<FieldType>, Option<usize>, bool),
/// Map type
Map(BuiltinType, Box<FieldType>, bool),
/// Builtin type
Builtin(BuiltinType, bool),
/// User-defined type
UserDefined(Ident, bool),
}
/// Enum representing metadata values
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum MetadataValue {
/// String value
String(String),
/// Integer value
Integer(IntegerValue),
}
/// Enum representing declarations
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum Declaration {
/// Enum declaration
Enum {
/// Enum identifier
ident: Ident,
/// Enum base integer type
base_type: IntegerType,
/// Enum variants
variants: Vec<(Ident, IntegerValue)>,
},
/// Struct declaration
Struct {
/// Struct identifier
ident: Ident,
/// Struct fields
fields: Vec<(Ident, FieldType)>,
},
}
/// Schema declaration
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Schema {
/// Schema metadata
pub metadata: Vec<(Ident, MetadataValue)>,
/// Schema declarations
pub declarations: Vec<Declaration>,
/// Nested ASTs
pub nested_asts: Vec<Schema>,
/// Source file path of the schema
pub file_path: PathBuf,
}
impl Schema {
/// Validate the schema and all nested schemas
pub fn validate(&self) -> Result<(), GenoError> {
let mut type_names = HashSet::<String>::new();
self.first_pass_validate(&mut type_names)?;
self.second_pass_validate(&type_names)?;
Ok(())
}
fn first_pass_validate(&self, type_names: &mut HashSet<String>) -> Result<(), GenoError> {
self.validate_metadata_format()?;
// Check for duplicate type definitions and duplicate fields/variants within each declaration
for decl in &self.declarations {
match decl {
Declaration::Enum {
ident, variants, ..
} => {
// Ensure that the ident starts with an uppercase letter
if !case::is_first_char_uppercase(ident.as_str()) {
return Err(GenoError::new_must_start_with_uppercase(
ident.as_str(),
&self.file_path,
ident.as_location(),
));
}
// Don't allow enum with no variants
if variants.is_empty() {
return Err(GenoError::new_empty_enum(
ident.as_str(),
&self.file_path,
ident.as_location(),
));
}
let mut variant_names = HashSet::new();
let mut variant_values = HashSet::new();
for (variant_name, variant_value) in variants {
// Ensure that the variant name starts with a lowercase letter
if !case::is_first_char_lowercase(variant_name.as_str()) {
return Err(GenoError::new_must_start_with_lowercase(
variant_name.as_str(),
&self.file_path,
variant_name.as_location(),
));
}
// Check for duplicate variant names
if !variant_names.insert(variant_name.as_str()) {
return Err(GenoError::new_duplicate_variant(
ident.as_str(),
variant_name.as_str(),
&self.file_path,
variant_name.as_location(),
));
}
let value_str = Self::integer_value_str(variant_value);
// Check for duplicate variant values
if !variant_values.insert(value_str.clone()) {
return Err(GenoError::new_duplicate_variant_value(
variant_name.as_str(),
&value_str,
&self.file_path,
variant_name.as_location(),
));
}
}
// Record type name, checking for duplicates
if !type_names.insert(ident.as_str().to_string()) {
return Err(GenoError::new_duplicate_type(
ident.as_str(),
&self.file_path,
ident.as_location(),
));
}
}
Declaration::Struct { ident, fields } => {
// Ensure that the ident starts with an uppercase letter
if !case::is_first_char_uppercase(ident.as_str()) {
return Err(GenoError::new_must_start_with_uppercase(
ident.as_str(),
&self.file_path,
ident.as_location(),
));
}
let mut field_names = HashSet::new();
for (file_ident, _) in fields {
// Ensure that the field name starts with a lowercase letter
if !case::is_first_char_lowercase(file_ident.as_str()) {
return Err(GenoError::new_must_start_with_lowercase(
file_ident.as_str(),
&self.file_path,
file_ident.as_location(),
));
}
// Ensure that the field name is unique
if !field_names.insert(file_ident.as_str()) {
return Err(GenoError::new_duplicate_field(
ident.as_str(),
file_ident.as_str(),
&self.file_path,
file_ident.as_location(),
));
}
}
// Record type name, checking for duplicates
if !type_names.insert(ident.as_str().to_string()) {
return Err(GenoError::new_duplicate_type(
ident.as_str(),
&self.file_path,
ident.as_location(),
));
}
}
}
}
// Perform first pass on nested ASTs
for ast in &self.nested_asts {
ast.first_pass_validate(type_names)?;
}
Ok(())
}
fn second_pass_validate(&self, type_names: &HashSet<String>) -> Result<(), GenoError> {
// Check for undefined types in structs
for decl in &self.declarations {
if let Declaration::Struct { fields, .. } = decl {
for (_, field_type) in fields {
self.check_for_undefined_types(field_type, &type_names)?;
}
}
}
// Perform first pass on nested ASTs
for ast in &self.nested_asts {
ast.second_pass_validate(type_names)?;
}
Ok(())
}
fn validate_metadata_format(&self) -> Result<(), GenoError> {
const EXPECTED_FORMAT: i64 = 1;
let actual_format = self.metadata.iter().find(|(k, _)| k.name == "format");
if let Some(actual_format) = actual_format {
if let MetadataValue::Integer(IntegerValue::I64(value)) = &actual_format.1 {
if *value != EXPECTED_FORMAT {
return Err(GenoError::new_invalid_metadata_format(
actual_format.0.as_str(),
&self.file_path,
&actual_format.0.as_location(),
));
}
}
} else {
return Err(GenoError::new_missing_metadata_format(
&self.file_path,
&Location { line: 1, column: 1 },
));
}
Ok(())
}
fn integer_value_str(v: &IntegerValue) -> String {
match v {
IntegerValue::I8(n) => n.to_string(),
IntegerValue::I16(n) => n.to_string(),
IntegerValue::I32(n) => n.to_string(),
IntegerValue::I64(n) => n.to_string(),
IntegerValue::U8(n) => n.to_string(),
IntegerValue::U16(n) => n.to_string(),
IntegerValue::U32(n) => n.to_string(),
IntegerValue::U64(n) => n.to_string(),
}
}
fn check_for_undefined_types(
&self,
field_type: &FieldType,
type_names: &HashSet<String>,
) -> Result<(), GenoError> {
match field_type {
FieldType::UserDefined(ident, _) => {
if !type_names.contains(ident.as_str()) {
return Err(GenoError::new_undefined_type(
ident.as_str(),
&self.file_path,
ident.as_location(),
));
}
}
FieldType::Array(inner, _, _) => {
self.check_for_undefined_types(inner, type_names)?;
}
FieldType::Map(_, value_type, _) => {
self.check_for_undefined_types(value_type, type_names)?;
}
FieldType::Builtin(_, _) => {}
}
Ok(())
}
/// Flattens the all nested AST declarations
pub fn flatten_decls<'a>(&'a self) -> Vec<&'a Declaration> {
let mut declarations = Vec::new();
self.flatten_nested(&mut declarations);
declarations
}
fn flatten_nested<'a>(&'a self, declarations: &mut Vec<&'a Declaration>) {
// First, flatten nested ASTs. This keeps the order of nested ASTs.
for ast in &self.nested_asts {
ast.flatten_nested(declarations);
}
// Then, add this AST's declarations
for decl in self.declarations.iter() {
declarations.push(&decl);
}
}
}