xidl-parser 0.54.0

A IDL codegen.
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

use crate::parser::parser_text;
use crate::typed_ast::{
    AnnotationAppl, AnnotationName, AnnotationParams, BuiltinAnnotation, DataRepresentationKind,
    Definition, TemplateTypeSpec, TopicPlatform, TypeDclInner, TypeDeclaratorInner, TypeSpec,
};

#[test]
fn parse_template_type_spec() {
    let typed = parser_text(
        r#"
        module m {
            typedef Vec<long> MyVec;
        };
        "#,
    )
    .expect("parse should succeed");

    let module = match &typed.0[0] {
        Definition::ModuleDcl(module) => module,
        other => panic!("expected module, got {other:?}"),
    };
    let type_dcl = match &module.definition[0] {
        Definition::TypeDcl(type_dcl) => type_dcl,
        other => panic!("expected type declaration, got {other:?}"),
    };
    let typedef = match &type_dcl.decl {
        TypeDclInner::TypedefDcl(typedef) => typedef,
        other => panic!("expected typedef, got {other:?}"),
    };
    let template = match &typedef.decl.ty {
        TypeDeclaratorInner::TemplateTypeSpec(TemplateTypeSpec::TemplateType(template)) => template,
        other => panic!("expected template_type, got {other:?}"),
    };
    assert_eq!(template.ident.0, "Vec");
    assert_eq!(template.args.len(), 1);
    assert!(matches!(
        template.args[0],
        TypeSpec::SimpleTypeSpec(crate::typed_ast::SimpleTypeSpec::BaseTypeSpec(
            crate::typed_ast::BaseTypeSpec::IntegerType(_)
        ))
    ));
}

#[test]
fn parse_doc_comments_as_doc_annotation() {
    let typed = parser_text(
        r#"
        /// module doc
        module m {
            /// struct doc
            struct S {
                /// field doc
                long x;
            };
        };
        "#,
    )
    .expect("parse should succeed");

    let module = match &typed.0[0] {
        Definition::ModuleDcl(module) => module,
        other => panic!("expected module, got {other:?}"),
    };
    assert_has_doc(&module.annotations, "\"module doc\"");

    let type_dcl = match &module.definition[0] {
        Definition::TypeDcl(type_dcl) => type_dcl,
        other => panic!("expected type declaration, got {other:?}"),
    };
    assert_has_doc(&type_dcl.annotations, "\"struct doc\"");

    let struct_def = match &type_dcl.decl {
        TypeDclInner::ConstrTypeDcl(crate::typed_ast::ConstrTypeDcl::StructDcl(
            crate::typed_ast::StructDcl::StructDef(def),
        )) => def,
        other => panic!("expected struct def, got {other:?}"),
    };
    let member = &struct_def.member[0];
    assert_has_doc(&member.annotations, "\"field doc\"");
}

#[test]
fn parse_builtin_annotations_with_structured_args() {
    let typed = parser_text(
        r#"
        @range(min=1, max=8)
        @topic("orders", DDS)
        @data_representation(allowed_kinds = XML)
        struct S {};
        "#,
    )
    .expect("parse should succeed");

    let Definition::TypeDcl(type_dcl) = &typed.0[0] else {
        panic!("expected type declaration");
    };
    let [range, topic, data_representation] = &type_dcl.annotations[..] else {
        panic!("expected three annotations");
    };

    let range = range
        .builtin
        .as_ref()
        .expect("range should keep builtin parse");
    assert!(matches!(
        range,
        BuiltinAnnotation::Range { min, max }
            if matches!(&min.0, crate::typed_ast::ConstExpr(_))
            && matches!(&max.0, crate::typed_ast::ConstExpr(_))
    ));

    let topic = topic
        .builtin
        .as_ref()
        .expect("topic should keep builtin parse");
    assert!(matches!(
        topic,
        BuiltinAnnotation::Topic {
            name: Some(_),
            platform: Some(TopicPlatform::Dds)
        }
    ));

    let data_representation = data_representation
        .builtin
        .as_ref()
        .expect("data_representation should keep builtin parse");
    assert!(matches!(
        data_representation,
        BuiltinAnnotation::DataRepresentation { kinds }
            if kinds == &[DataRepresentationKind::Xml]
    ));
}

fn assert_has_doc(annotations: &[AnnotationAppl], expected: &str) {
    let doc = annotations.iter().find_map(|anno| match &anno.name {
        AnnotationName::Builtin(name) if name == "doc" => match &anno.params {
            Some(AnnotationParams::Raw(raw)) => Some(raw.as_str()),
            _ => None,
        },
        _ => None,
    });
    assert_eq!(doc, Some(expected));
}