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 vulkan 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 <vulkan/vk_android_native_buffer.h>
62 #include "util/macros.h"
63 #include "vk_enum_to_str.h"
68 vk_${enum.name[2:]}_to_str(${enum.name} input)
71 % for v in enum.values:
72 % if v in FOREIGN_ENUM_VALUES:
74 #pragma GCC diagnostic push
75 #pragma GCC diagnostic ignored "-Wswitch"
79 % if v in FOREIGN_ENUM_VALUES:
80 #pragma GCC diagnostic pop
85 unreachable("Undefined enum value.");
89 output_encoding
='utf-8')
91 H_TEMPLATE
= Template(textwrap
.dedent(u
"""\
92 /* Autogenerated file -- do not edit
93 * generated by ${file}
98 #ifndef MESA_VK_ENUM_TO_STR_H
99 #define MESA_VK_ENUM_TO_STR_H
101 #include <vulkan/vulkan.h>
102 #include <vulkan/vk_android_native_buffer.h>
104 % for ext in extensions:
105 #define _${ext.name}_number (${ext.number})
109 const char * vk_${enum.name[2:]}_to_str(${enum.name} input);
113 output_encoding
='utf-8')
115 # These enums are defined outside their respective enum blocks, and thus cause
117 FOREIGN_ENUM_VALUES
= [
118 "VK_STRUCTURE_TYPE_NATIVE_BUFFER_ANDROID",
122 class NamedFactory(object):
123 """Factory for creating enums."""
125 def __init__(self
, type_
):
129 def __call__(self
, name
, **kwargs
):
131 return self
.registry
[name
]
133 n
= self
.registry
[name
] = self
.type(name
, **kwargs
)
137 class VkExtension(object):
138 """Simple struct-like class representing extensions"""
140 def __init__(self
, name
, number
=None):
145 class VkEnum(object):
146 """Simple struct-like class representing a single Vulkan Enum."""
148 def __init__(self
, name
, values
=None):
150 self
.values
= values
or []
153 def parse_xml(enum_factory
, ext_factory
, filename
):
154 """Parse the XML file. Accumulate results into the factories.
156 This parser is a memory efficient iterative XML parser that returns a list
160 with
open(filename
, 'rb') as f
:
161 context
= iter(et
.iterparse(f
, events
=('start', 'end')))
163 # This gives the root element, since goal is to iterate over the
164 # elements without building a tree, this allows the root to be cleared
165 # (erase the elements) after the children have been processed.
166 _
, root
= next(context
)
168 for event
, elem
in context
:
169 if event
== 'end' and elem
.tag
== 'enums':
170 type_
= elem
.attrib
.get('type')
172 enum
= enum_factory(elem
.attrib
['name'])
173 enum
.values
.extend([e
.attrib
['name'] for e
in elem
175 elif event
== 'start' and elem
.tag
== 'extension':
176 ext_factory(elem
.attrib
['name'],
177 number
=int(elem
.attrib
['number']))
178 elif event
== 'end' and elem
.tag
== 'extension':
179 if elem
.attrib
['supported'] != 'vulkan':
181 for e
in elem
.findall('.//enum[@extends][@offset]'):
182 enum
= enum_factory(e
.attrib
['extends'])
183 enum
.values
.append(e
.attrib
['name'])
188 parser
= argparse
.ArgumentParser()
189 parser
.add_argument('--xml', required
=True,
190 help='Vulkan API XML files',
193 parser
.add_argument('--outdir',
194 help='Directory to put the generated files in',
197 args
= parser
.parse_args()
199 enum_factory
= NamedFactory(VkEnum
)
200 ext_factory
= NamedFactory(VkExtension
)
201 for filename
in args
.xml_files
:
202 parse_xml(enum_factory
, ext_factory
, filename
)
203 enums
= sorted(enum_factory
.registry
.values(), key
=lambda e
: e
.name
)
204 extensions
= sorted(ext_factory
.registry
.values(), key
=lambda e
: e
.name
)
206 for template
, file_
in [(C_TEMPLATE
, os
.path
.join(args
.outdir
, 'vk_enum_to_str.c')),
207 (H_TEMPLATE
, os
.path
.join(args
.outdir
, 'vk_enum_to_str.h'))]:
208 with
open(file_
, 'wb') as f
:
209 f
.write(template
.render(
210 file=os
.path
.basename(__file__
),
212 extensions
=extensions
,
214 FOREIGN_ENUM_VALUES
=FOREIGN_ENUM_VALUES
))
217 if __name__
== '__main__':