2 # Copyright © 2017 Intel Corporation
4 # Permission is hereby granted, free of charge, to any person obtaining a copy
5 # of this software and associated documentation files (the "Software"), to deal
6 # in the Software without restriction, including without limitation the rights
7 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 # copies of the Software, and to permit persons to whom the Software is
9 # furnished to do so, subject to the following conditions:
11 # The above copyright notice and this permission notice shall be included in
12 # all copies or substantial portions of the Software.
14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 """Create enum to string functions for vulking using vk.xml."""
24 from __future__
import print_function
28 import xml
.etree
.cElementTree
as et
30 from mako
.template
import Template
32 COPYRIGHT
= textwrap
.dedent(u
"""\
33 * Copyright © 2017 Intel Corporation
35 * Permission is hereby granted, free of charge, to any person obtaining a copy
36 * of this software and associated documentation files (the "Software"), to deal
37 * in the Software without restriction, including without limitation the rights
38 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
39 * copies of the Software, and to permit persons to whom the Software is
40 * furnished to do so, subject to the following conditions:
42 * The above copyright notice and this permission notice shall be included in
43 * all copies or substantial portions of the Software.
45 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
46 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
47 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
48 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
49 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
50 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
53 C_TEMPLATE
= Template(textwrap
.dedent(u
"""\
54 /* Autogenerated file -- do not edit
55 * generated by ${file}
60 #include <vulkan/vulkan.h>
61 #include "util/macros.h"
62 #include "vk_enum_to_str.h"
67 vk_${enum.name[2:]}_to_str(${enum.name} input)
70 % for v in enum.values:
75 unreachable("Undefined enum value.");
79 output_encoding
='utf-8')
81 H_TEMPLATE
= Template(textwrap
.dedent(u
"""\
82 /* Autogenerated file -- do not edit
83 * generated by ${file}
88 #ifndef MESA_VK_ENUM_TO_STR_H
89 #define MESA_VK_ENUM_TO_STR_H
91 #include <vulkan/vulkan.h>
94 const char * vk_${enum.name[2:]}_to_str(${enum.name} input);
98 output_encoding
='utf-8')
101 class EnumFactory(object):
102 """Factory for creating enums."""
104 def __init__(self
, type_
):
108 def __call__(self
, name
):
110 return self
.registry
[name
]
112 n
= self
.registry
[name
] = self
.type(name
)
116 class VkEnum(object):
117 """Simple struct-like class representing a single Vulkan Enum."""
119 def __init__(self
, name
, values
=None):
121 self
.values
= values
or []
124 def xml_parser(filename
):
125 """Parse the XML file and return parsed data.
127 This parser is a memory efficient iterative XML parser that returns a list
130 efactory
= EnumFactory(VkEnum
)
132 with
open(filename
, 'rb') as f
:
133 context
= iter(et
.iterparse(f
, events
=('start', 'end')))
135 # This gives the root element, since goal is to iterate over the
136 # elements without building a tree, this allows the root to be cleared
137 # (erase the elements) after the children have been processed.
138 _
, root
= next(context
)
140 for event
, elem
in context
:
141 if event
== 'end' and elem
.tag
== 'enums':
142 type_
= elem
.attrib
.get('type')
144 enum
= efactory(elem
.attrib
['name'])
145 enum
.values
.extend([e
.attrib
['name'] for e
in elem
147 elif event
== 'end' and elem
.tag
== 'extension':
148 if elem
.attrib
['supported'] != 'vulkan':
150 for e
in elem
.findall('.//enum[@extends][@offset]'):
151 enum
= efactory(e
.attrib
['extends'])
152 enum
.values
.append(e
.attrib
['name'])
156 return efactory
.registry
.values()
160 parser
= argparse
.ArgumentParser()
161 parser
.add_argument('--xml', help='Vulkan API XML file.', required
=True)
162 parser
.add_argument('--outdir',
163 help='Directory to put the generated files in',
166 args
= parser
.parse_args()
168 enums
= xml_parser(args
.xml
)
169 for template
, file_
in [(C_TEMPLATE
, os
.path
.join(args
.outdir
, 'vk_enum_to_str.c')),
170 (H_TEMPLATE
, os
.path
.join(args
.outdir
, 'vk_enum_to_str.h'))]:
171 with
open(file_
, 'wb') as f
:
172 f
.write(template
.render(
173 file=os
.path
.basename(__file__
),
175 copyright
=COPYRIGHT
))
178 if __name__
== '__main__':