xidl-parser 0.100.1

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
145
146
147
148
149

//! Reference bookkeeping across a projection: dangling references, pruned
//! exception sets and root-qualification rewriting.

use super::*;
use crate::error::ParseError;
use crate::versioning::VersioningError;

#[test]
fn projection_reports_references_into_dropped_subtrees() {
    let (spec, record) = analyze(
        r#"
@version
enum Versions { v1, v2 };

@added(Versions::v2)
module Extras {
    struct Note { long x; };
};

struct Pet {
    string id;
    Extras::Note note;
};
"#,
    );
    let versions = project_ids(&record);

    record
        .project(&spec, versions[1])
        .expect("v2 keeps the module");
    match record.project(&spec, versions[0]) {
        Err(ParseError::Versioning(VersioningError::DanglingReference {
            decl,
            reference,
            version,
        })) => {
            assert!(decl.contains("Pet"));
            assert_eq!(reference, "Extras::Note");
            assert_eq!(version, "v1");
        }
        other => panic!("expected a dangling reference error, got {other:?}"),
    }
}

#[test]
fn projection_reports_references_to_the_version_enum() {
    let (spec, record) = analyze(
        r#"
@version
enum ApiVersions { v1, v2 };

struct Uses { ApiVersions v; };
"#,
    );
    let versions = project_ids(&record);

    match record.project(&spec, versions[0]) {
        Err(ParseError::Versioning(VersioningError::DanglingReference { reference, .. })) => {
            assert_eq!(reference, "ApiVersions")
        }
        other => panic!("expected a dangling reference error, got {other:?}"),
    }
}

#[test]
fn projection_matches_qualified_references_across_modules() {
    let (spec, record) = analyze(
        r#"
@version
enum Versions { v1, v2 };

module A {
    @added(Versions::v2)
    struct Foo { long x; };
};

module B {
    struct Foo { long y; };
};

struct Pet { A::Foo foo; };
"#,
    );
    let versions = project_ids(&record);

    record.project(&spec, versions[1]).expect("v2 keeps A::Foo");
    match record.project(&spec, versions[0]) {
        Err(ParseError::Versioning(VersioningError::DanglingReference { reference, .. })) => {
            assert_eq!(reference, "A::Foo")
        }
        other => panic!("expected a dangling reference error, got {other:?}"),
    }
}

#[test]
fn projection_prunes_raises_into_dropped_subtrees() {
    let (spec, record) = analyze(
        r#"
@version
enum Versions { v1, v2 };

@removed(Versions::v2)
module Late {
    @http(409)
    exception Conflict { string reason; };
};

interface Pets {
    void adopt() raises(Late::Conflict);
};
"#,
    );
    let versions = project_ids(&record);

    let v1 = record
        .project(&spec, versions[0])
        .expect("v1 keeps the exception");
    assert_eq!(raised_exceptions(&v1), vec!["Late::Conflict"]);
    let v2 = record
        .project(&spec, versions[1])
        .expect("v2 prunes the entry");
    assert!(raised_exceptions(&v2).is_empty());
}

#[test]
fn projection_relativizes_const_values_and_union_labels() {
    let (spec, record) = analyze(
        r#"
@version
enum Versions { v1, v2 };

enum Color { RED, GREEN };

const long FAVOURITE = ::Color::RED;

union Paint switch (Color) {
    case ::Color::GREEN: long g;
};
"#,
    );
    let versions = project_ids(&record);
    let projected = record.project(&spec, versions[0]).expect("projection");
    let json = serde_json::to_string(&projected).expect("serialize");

    assert!(
        !json.contains("\"is_root\":true"),
        "root references must be relativized: {json}"
    );
}