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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
use std::collections::HashMap;

use crate::specification::*;

#[derive(Debug, PartialEq)]
pub enum NameMapObject<'a> {
    Measurement(&'a Measurement),
    Characteristic(&'a Characteristic),
    AxisPts(&'a AxisPts),
    Blob(&'a Blob),
    Instance(&'a Instance),
}

#[allow(clippy::enum_variant_names)]
#[derive(Debug, PartialEq)]
pub enum NameMapCompuTab<'a> {
    CompuTab(&'a CompuTab),
    CompuVtab(&'a CompuVtab),
    CompuVtabRange(&'a CompuVtabRange),
}

#[allow(clippy::enum_variant_names)]
#[derive(Debug, PartialEq)]
pub enum NameMapTypedef<'a> {
    TypedefBlob(&'a TypedefBlob),
    TypedefAxis(&'a TypedefAxis),
    TypedefMeasurement(&'a TypedefMeasurement),
    TypedefCharacteristic(&'a TypedefCharacteristic),
    TypedefStructure(&'a TypedefStructure),
}

macro_rules! check_and_insert {
    ( $hash:expr, $key:expr, $item:expr, $log_msgs:expr, $blockname:expr ) => {
        if let Some(existing_val) = $hash.get(&$key) {
            $log_msgs.push(format!(
                "Name collision: The {} blocks on line {} and {} both use the name {}",
                $blockname,
                existing_val.get_line(),
                $item.get_line(),
                $key
            ));
        } else {
            $hash.insert($key, $item);
        }
    };
}

macro_rules! check_and_insert_multi {
    ( $hash:expr, $key:expr, $item:expr, $log_msgs:expr, $blockname:expr ) => {
        if let Some(existing_val) = $hash.get(&$key) {
            $log_msgs.push(format!("Name collision: The block {} on line {} and the block {} on line {} both use the name {}",
                existing_val.get_blockname(), existing_val.get_line(), $blockname, $item.get_line(), $key));
        } else {
            $hash.insert($key, $item);
        }
    }
}

/// `ModuleNameMap` collects references to all items with a [Module] into `HashMaps`, making it possible to access them all by name.
///
/// There are several name spaces per module, each stored in a different `HashMap` in the `ModuleNameMap`:
/// - `object`: `CHARACTERISTIC`, `MEASUREMENT`, `AXIS_PTS`, `BLOB`, `INSTANCE`
/// - `compu_method`: `COMPU_METHOD`
/// - `compu_tab`: `COMPU_VTAB`, `COMPU_VTAB_RANGE`, `COMPU_TAB`
/// - `frame`: `FRAME`
/// - `function`: `FUNCTION`
/// - `group`: `GROUP`
/// - `memory_segment`: `MEMORY_SEGMENT`
/// - `record_layout`: `RECORD_LAYOUT`
/// - `transformer`: `TRANSFORMER`
/// - `typedef`: `TYPEDEF_AXIS`, `TYPEDEF_BLOB`, `TYPEDEF_CHARACTERISTIC`, `TYPEDEF_INSTANCE`, `TYPEDEF_MEASUREMENT`
/// - `unit`: `UNIT`
/// - `variant`: `VARIANT`
///
/// While the `ModuleNameMap` is holding these references, the borrow checker will prevent any of these items from being modified.
#[derive(Debug, PartialEq)]
pub struct ModuleNameMap<'a> {
    pub compu_method: HashMap<String, &'a CompuMethod>,
    pub compu_tab: HashMap<String, NameMapCompuTab<'a>>,
    pub frame: HashMap<String, &'a Frame>,
    pub function: HashMap<String, &'a Function>,
    pub group: HashMap<String, &'a Group>,
    pub memory_segment: HashMap<String, &'a MemorySegment>,
    pub object: HashMap<String, NameMapObject<'a>>,
    pub record_layout: HashMap<String, &'a RecordLayout>,
    pub transformer: HashMap<String, &'a Transformer>,
    pub typedef: HashMap<String, NameMapTypedef<'a>>,
    pub unit: HashMap<String, &'a Unit>,
    pub variant: HashMap<String, &'a VarCriterion>,
}

impl<'a> ModuleNameMap<'a> {
    /// build a new `ModuleNameMap` for the given [Module]
    pub fn build(module: &'a Module, log_msgs: &mut Vec<String>) -> Self {
        Self {
            compu_method: build_namemap_compu_method(module, log_msgs),
            compu_tab: build_namemap_compu_tab(module, log_msgs),
            frame: build_namemap_frame(module, log_msgs),
            function: build_namemap_function(module, log_msgs),
            group: build_namemap_group(module, log_msgs),
            memory_segment: build_namemap_memory_segment(module, log_msgs),
            object: build_namemap_object(module, log_msgs),
            record_layout: build_namemap_record_layout(module, log_msgs),
            transformer: build_namemap_transformer(module, log_msgs),
            typedef: build_namemap_typedef(module, log_msgs),
            unit: build_namemap_unit(module, log_msgs),
            variant: build_namemap_variant(module, log_msgs),
        }
    }
}

pub(crate) fn build_namemap_unit<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a Unit> {
    let mut namelist_unit = HashMap::<String, &'a Unit>::new();
    for unit in &module.unit {
        check_and_insert!(namelist_unit, unit.name.clone(), unit, log_msgs, "UNIT");
    }
    namelist_unit
}

pub(crate) fn build_namemap_typedef<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, NameMapTypedef<'a>> {
    let mut namelist_typedef = HashMap::<String, NameMapTypedef<'a>>::new();
    for typedef_axis in &module.typedef_axis {
        check_and_insert_multi!(
            namelist_typedef,
            typedef_axis.name.clone(),
            NameMapTypedef::TypedefAxis(typedef_axis),
            log_msgs,
            "TYPEDEF_AXIS"
        );
    }
    for typedef_blob in &module.typedef_blob {
        check_and_insert_multi!(
            namelist_typedef,
            typedef_blob.name.clone(),
            NameMapTypedef::TypedefBlob(typedef_blob),
            log_msgs,
            "TYPEDEF_BLOB"
        );
    }
    for typedef_characteristic in &module.typedef_characteristic {
        check_and_insert_multi!(
            namelist_typedef,
            typedef_characteristic.name.clone(),
            NameMapTypedef::TypedefCharacteristic(typedef_characteristic),
            log_msgs,
            "TYPEDEF_CHARACTERISTIC"
        );
    }
    for typedef_measurement in &module.typedef_measurement {
        check_and_insert_multi!(
            namelist_typedef,
            typedef_measurement.name.clone(),
            NameMapTypedef::TypedefMeasurement(typedef_measurement),
            log_msgs,
            "TYPEDEF_MEASUREMENT"
        );
    }
    for typedef_structure in &module.typedef_structure {
        check_and_insert_multi!(
            namelist_typedef,
            typedef_structure.name.clone(),
            NameMapTypedef::TypedefStructure(typedef_structure),
            log_msgs,
            "TYPEDEF_STRUCTURE"
        );
    }
    namelist_typedef
}

pub(crate) fn build_namemap_record_layout<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a RecordLayout> {
    let mut namelist_record_layout = HashMap::<String, &'a RecordLayout>::new();
    for record_layout in &module.record_layout {
        check_and_insert!(
            namelist_record_layout,
            record_layout.name.clone(),
            record_layout,
            log_msgs,
            "RECORD_LAYOUT"
        );
    }
    namelist_record_layout
}

pub(crate) fn build_namemap_memory_segment<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a MemorySegment> {
    let mut namelist_memory_segment = HashMap::<String, &'a MemorySegment>::new();
    if let Some(mod_par) = &module.mod_par {
        for memory_segment in &mod_par.memory_segment {
            check_and_insert!(
                namelist_memory_segment,
                memory_segment.name.clone(),
                memory_segment,
                log_msgs,
                "MEMORY_SEGMENT"
            );
        }
    }
    namelist_memory_segment
}

pub(crate) fn build_namemap_compu_tab<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, NameMapCompuTab<'a>> {
    let mut namelist_compu_tab = HashMap::<String, NameMapCompuTab<'a>>::new();
    for compu_tab in &module.compu_tab {
        check_and_insert_multi!(
            namelist_compu_tab,
            compu_tab.name.clone(),
            NameMapCompuTab::CompuTab(compu_tab),
            log_msgs,
            "COMPU_TAB"
        );
    }
    for compu_vtab in &module.compu_vtab {
        check_and_insert_multi!(
            namelist_compu_tab,
            compu_vtab.name.clone(),
            NameMapCompuTab::CompuVtab(compu_vtab),
            log_msgs,
            "COMPU_VTAB"
        );
    }
    for compu_vtab_range in &module.compu_vtab_range {
        check_and_insert_multi!(
            namelist_compu_tab,
            compu_vtab_range.name.clone(),
            NameMapCompuTab::CompuVtabRange(compu_vtab_range),
            log_msgs,
            "COMPU_VTAB_RANGE"
        );
    }
    namelist_compu_tab
}

pub(crate) fn build_namemap_compu_method<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a CompuMethod> {
    let mut namelist_compu_method = HashMap::<String, &'a CompuMethod>::new();
    for compu_method in &module.compu_method {
        check_and_insert!(
            namelist_compu_method,
            compu_method.name.clone(),
            compu_method,
            log_msgs,
            "COMPU_METHOD"
        );
    }
    namelist_compu_method
}

pub(crate) fn build_namemap_transformer<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a Transformer> {
    let mut namelist_transformer = HashMap::<String, &'a Transformer>::new();
    for transformer in &module.transformer {
        check_and_insert!(
            namelist_transformer,
            transformer.name.clone(),
            transformer,
            log_msgs,
            "TRANSFORMER"
        );
    }
    namelist_transformer
}

pub(crate) fn build_namemap_object<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, NameMapObject<'a>> {
    let mut namelist_object = HashMap::<String, NameMapObject<'a>>::new();
    for measurement in &module.measurement {
        check_and_insert_multi!(
            namelist_object,
            measurement.name.clone(),
            NameMapObject::Measurement(measurement),
            log_msgs,
            "MEASUREMENT"
        );
    }
    for characteristic in &module.characteristic {
        check_and_insert_multi!(
            namelist_object,
            characteristic.name.clone(),
            NameMapObject::Characteristic(characteristic),
            log_msgs,
            "CHARACTERISTIC"
        );
    }
    for axis_pts in &module.axis_pts {
        check_and_insert_multi!(
            namelist_object,
            axis_pts.name.clone(),
            NameMapObject::AxisPts(axis_pts),
            log_msgs,
            "AXIS_PTS"
        );
    }
    for blob in &module.blob {
        check_and_insert_multi!(
            namelist_object,
            blob.name.clone(),
            NameMapObject::Blob(blob),
            log_msgs,
            "BLOB"
        );
    }
    for instance in &module.instance {
        check_and_insert_multi!(
            namelist_object,
            instance.name.clone(),
            NameMapObject::Instance(instance),
            log_msgs,
            "INSTANCE"
        );
    }
    namelist_object
}

pub(crate) fn build_namemap_variant<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a VarCriterion> {
    let mut namelist_variant = HashMap::<String, &'a VarCriterion>::new();
    for variant_coding in &module.variant_coding {
        for var_criterion in &variant_coding.var_criterion {
            check_and_insert!(
                namelist_variant,
                var_criterion.name.clone(),
                var_criterion,
                log_msgs,
                "VAR_CRITERION"
            );
        }
    }
    namelist_variant
}

pub(crate) fn build_namemap_group<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a Group> {
    let mut namelist_group = HashMap::<String, &'a Group>::new();
    for group in &module.group {
        check_and_insert!(namelist_group, group.name.clone(), group, log_msgs, "GROUP");
    }
    namelist_group
}

pub(crate) fn build_namemap_frame<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a Frame> {
    let mut namelist_frame = HashMap::<String, &'a Frame>::new();
    for frame in &module.frame {
        check_and_insert!(namelist_frame, frame.name.clone(), frame, log_msgs, "FRAME");
    }
    namelist_frame
}

pub(crate) fn build_namemap_function<'a>(
    module: &'a Module,
    log_msgs: &mut Vec<String>,
) -> HashMap<String, &'a Function> {
    let mut namelist_function = HashMap::<String, &'a Function>::new();
    for function in &module.function {
        check_and_insert!(
            namelist_function,
            function.name.clone(),
            function,
            log_msgs,
            "FUNCTION"
        );
    }
    namelist_function
}

impl<'a> NameMapObject<'a> {
    pub(crate) fn get_line(&self) -> u32 {
        match self {
            Self::AxisPts(axis) => axis.get_line(),
            Self::Blob(blob) => blob.get_line(),
            Self::Characteristic(characteristic) => characteristic.get_line(),
            Self::Instance(instance) => instance.get_line(),
            Self::Measurement(measurement) => measurement.get_line(),
        }
    }

    fn get_blockname(&self) -> &'static str {
        match self {
            Self::AxisPts(_) => "AXIS_PTS",
            Self::Blob(_) => "BLOB",
            Self::Characteristic(_) => "CHARACTERISTIC",
            Self::Instance(_) => "INSTANCE",
            Self::Measurement(_) => "MEASUREMENT",
        }
    }
}

impl<'a> NameMapCompuTab<'a> {
    pub(crate) fn get_line(&self) -> u32 {
        match self {
            Self::CompuTab(computab) => computab.get_line(),
            Self::CompuVtab(compuvtab) => compuvtab.get_line(),
            Self::CompuVtabRange(compuvtabrange) => compuvtabrange.get_line(),
        }
    }

    fn get_blockname(&self) -> &'static str {
        match self {
            Self::CompuTab(_) => "COMPU_TAB",
            Self::CompuVtab(_) => "COMPU_VTAB",
            Self::CompuVtabRange(_) => "COMPU_VTAB_RANGE",
        }
    }
}

impl<'a> NameMapTypedef<'a> {
    pub(crate) fn get_line(&self) -> u32 {
        match self {
            Self::TypedefAxis(axis) => axis.get_line(),
            Self::TypedefBlob(blob) => blob.get_line(),
            Self::TypedefCharacteristic(characteristic) => characteristic.get_line(),
            Self::TypedefMeasurement(measurement) => measurement.get_line(),
            Self::TypedefStructure(structure) => structure.get_line(),
        }
    }

    fn get_blockname(&self) -> &'static str {
        match self {
            Self::TypedefAxis(_) => "TYPEDEF_AXIS",
            Self::TypedefBlob(_) => "TYPEDEF_BLOB",
            Self::TypedefCharacteristic(_) => "TYPEDEF_CHARACTERISTIC",
            Self::TypedefMeasurement(_) => "TYPEDEF_MEASUREMENT",
            Self::TypedefStructure(_) => "TYPEDEF_STRUCTURE",
        }
    }
}