ifc-template-catalog 0.3.0

Versioned IFC PSD/QTO catalog definitions and correction overlays
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

use crate::catalog::Catalog;
use crate::definition::{PropertyKind, PropertyTemplate, SetTemplateKind};

use super::{issue, visit_data_types, CatalogDiagnostic, DiagnosticCode, DiagnosticSeverity};

/// Minimum schema capability needed to validate external catalog names.
pub trait CatalogSchema {
    /// True when the schema declares an entity by this exact name.
    fn has_entity(&self, name: &str) -> bool;
    /// True when the schema declares a defined type by this exact name.
    fn has_type(&self, name: &str) -> bool;
}

impl Catalog {
    /// Validate entity and value-type references against the selected IFC schema.
    pub fn schema_diagnostics(&self, schema: &impl CatalogSchema) -> Vec<CatalogDiagnostic> {
        let mut output = Vec::new();
        for template in self.iter() {
            for selector in &template.applicability {
                if !schema.has_entity(&selector.entity) {
                    output.push(issue(
                        DiagnosticCode::UnknownApplicableEntity,
                        DiagnosticSeverity::Error,
                        &template.name,
                        None,
                        &format!("unknown applicable entity `{}`", selector.entity),
                    ));
                }
            }
            if let SetTemplateKind::Property { properties, .. } = &template.kind {
                inspect_properties(&template.name, properties, schema, &mut output);
            }
        }
        output
    }
}

fn inspect_properties(
    template: &str,
    properties: &[PropertyTemplate],
    schema: &impl CatalogSchema,
    output: &mut Vec<CatalogDiagnostic>,
) {
    for property in properties {
        visit_data_types(&property.kind, &mut |type_name| {
            if let Some(type_name) = type_name {
                if !schema.has_type(type_name) {
                    output.push(issue(
                        DiagnosticCode::UnknownPropertyDataType,
                        DiagnosticSeverity::Error,
                        template,
                        Some(&property.name),
                        &format!("unknown property data type `{type_name}`"),
                    ));
                }
            }
        });
        match &property.kind {
            PropertyKind::ReferenceValue { reference_type }
                if !schema.has_entity(reference_type) =>
            {
                output.push(issue(
                    DiagnosticCode::UnknownReferenceEntity,
                    DiagnosticSeverity::Error,
                    template,
                    Some(&property.name),
                    &format!("unknown reference entity `{reference_type}`"),
                ));
            }
            PropertyKind::Complex { properties, .. } => {
                inspect_properties(template, properties, schema, output);
            }
            _ => {}
        }
    }
}

#[cfg(feature = "schema")]
impl CatalogSchema for ifc_schema::Schema {
    fn has_entity(&self, name: &str) -> bool {
        self.entity(name).is_some()
    }

    fn has_type(&self, name: &str) -> bool {
        self.type_def(name).is_some()
    }
}