File: directx_x_file_parser.py

package info (click to toggle)
pyparsing 3.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,928 kB
  • sloc: python: 25,633; ansic: 422; makefile: 22
file content (196 lines) | stat: -rw-r--r-- 5,673 bytes parent folder | download | duplicates (2)
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
#
# directx_x_file_parser.py
#
# Parses .x files used for DirectX.
# Based on format documentation at http://paulbourke.net/dataformats/directx/
#
# Copyright 2024, Paul McGuire
#
import pyparsing as pp


LBRACE, RBRACE, LBRACK, RBRACK, SEMI = pp.Suppress.using_each("{}[];")

ident = pp.Word(pp.alphas, pp.alphanums + "_").set_name("identifier")
integer = pp.Word("123456789", pp.nums).add_parse_action(lambda t: int(t[0]))

# scalar_type = pp.one_of(
#     "WORD DWORD FLOAT DOUBLE CHAR UCHAR BYTE STRING CSTRING UNICODE", as_keyword=True
# ).set_name("base_type")
scalar_type = pp.MatchFirst(
    pp.Keyword.using_each(
        "WORD DWORD FLOAT DOUBLE CHAR UCHAR BYTE STRING CSTRING UNICODE".split()
    )
).set_name("scalar_type")
type_ref = scalar_type | ident

ARRAY = pp.Keyword("array")
array_type_ref = pp.Group(ARRAY + type_ref("element_type"))
array_dim = LBRACK + (integer | ident) + RBRACK
member_defn = pp.Group(
    (
        array_type_ref("type") + ident("name") + array_dim[...]("dims")
        | type_ref("type") + ident("name")
    )
    + SEMI
)

TEMPLATE = pp.Keyword("template")
uuid = pp.Regex(
    r"<[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}>"
).set_parse_action(lambda t: t[0][1:-1])
open_template_indicator = pp.Combine(LBRACK + "..." + RBRACK, adjacent=False)
restriction = pp.Group(type_ref("type") + pp.Optional(uuid)("uuid"))
template_restrictions = LBRACK + pp.DelimitedList(restriction) + RBRACK
directx_template_defn = (
    TEMPLATE
    + ident("name")
    + LBRACE
    + pp.Optional(uuid)("uuid")
    + member_defn[...]("members")
    + pp.Optional(
        open_template_indicator.set_parse_action(lambda: True), default=False
    )("open_template")
    + pp.Optional(template_restrictions)("restrictions")
    + RBRACE
).set_name("template_defn")
directx_template_defn.add_parse_action(
    lambda t: t.__setitem__("closed", not (t.open_template or t.restrictions))
)

directx_template_defn.ignore(pp.cpp_style_comment)


def make_template_parser(template_defn: pp.ParseResults) -> pp.ParserElement:
    """
    Create a pyparsing parser from a DirectX template definition.
    (Limited to templates containing scalar types, or arrays of scalars.)
    """
    float_ = pp.common.real
    type_map = {
        "WORD": integer,
        "DWORD": integer,
        "FLOAT": float_,
        "DOUBLE": float_,
        "CHAR": integer,
        "UCHAR": integer,
        "BYTE": integer,
        "STRING": pp.QuotedString('"'),
        "CSTRING": pp.QuotedString('"'),
        "UNICODE": pp.QuotedString('"'),
    }
    member_parsers = []
    for member in template_defn.members:
        if member.type in type_map:
            expr = pp.ungroup(type_map[member.type] + SEMI)
        elif member.dims:
            expr = type_map[member.type.element_type]
            for dim in member.dims:
                expr = pp.Group(pp.DelimitedList(expr, max=dim) + SEMI)
        member_parsers.append(expr(member.name))

    return (
        pp.Keyword(template_defn.name)("type")
        + ident("name")
        + LBRACE
        + pp.Group(pp.And(member_parsers))("fields")
        + RBRACE
    )


if __name__ == "__main__":

    sample = """
    some stuff...

    template Mesh {
    <3D82AB44-62DA-11cf-AB39-0020AF71E433>
    DWORD nVertices;
    array Vector vertices[nVertices];
    DWORD nFaces;
    array MeshFace faces[nFaces];
     [ ... ]                // An open template
    }
    
    template PolyArray {
    <3D82AB44-62DA-11cf-AB39-0020AF71E433>
    DWORD nPolys;
    array FLOAT polys[nPolys][3];
    }

    template Vector {
    <3D82AB5E-62DA-11cf-AB39-0020AF71E434>
    FLOAT x;
    FLOAT y;
    FLOAT z;
    }                        // A closed template

    template FileSystem {
    <3D82AB5E-62DA-11cf-AB39-0020AF71E435>
    STRING name;
    [ Directory <3D82AB5E-62DA-11cf-AB39-0020AF71E436>, File <3D82AB5E-62DA-11cf-AB39-0020AF71E437> ]    // A restricted template
    }

    more stuff...

    template mytemp {
    DWORD myvar;
    DWORD myvar2;
    }

    template container {
    DWORD count;
    array mytemp tempArray[count];
    }
    """

    for template in directx_template_defn.search_string(sample):
        # print(template.dump())
        print(
            f"Name: {template.name!r}"
            f" UUID: {template.uuid}"
            f" Open: {template.open_template!r}"
            f" Closed: {template.closed!r}"
            f" Restricted: {bool(template.restrictions)}"
        )
        # print()

    # create railroad diagram
    pp.autoname_elements()
    directx_template_defn.create_diagram(
        "directx_x_file_parser.html", show_results_names=True, show_groups=False
    )

    vector_template = directx_template_defn.parse_string(
        """\
    template Vector {
        <3D82AB5E-62DA-11cf-AB39-0020AF71E434>
        STRING label;
        FLOAT x;
        FLOAT y;
        FLOAT z;
    }  
    """
    )
    vector_parser = make_template_parser(vector_template)
    vector_parser.create_diagram(
        "directx_x_vector_parser.html", show_results_names=True, show_groups=False
    )
    v = vector_parser.parse_string('Vector p1 {"datum_A"; 1.0; 3.0; 5.0;}')
    print(v.dump())

    vector_template = directx_template_defn.parse_string(
        """\
    template Vector {
        <3D82AB5E-62DA-11cf-AB39-0020AF71E434>
        STRING label;
        array FLOAT coords[3];
    }  
    """
    )
    vector_parser = make_template_parser(vector_template)
    vector_parser.create_diagram(
        "directx_x_vector_parser.html", show_results_names=True, show_groups=False
    )
    v = vector_parser.parse_string('Vector p1 {"datum_A"; 1.0, 3.0, 5.0;}')
    print(v.dump())