src/vulkan/util/gen_enum_to_str.py

   1 # encoding=utf-8
   2 # Copyright © 2017 Intel Corporation
   3
   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:
  10
  11 # The above copyright notice and this permission notice shall be included in
  12 # all copies or substantial portions of the Software.
  13
  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
  20 # SOFTWARE.
  21
  22 """Create enum to string functions for vulkan using vk.xml."""
  23
  24 from __future__ import print_function
  25 import argparse
  26 import os
  27 import textwrap
  28 import xml.etree.cElementTree as et
  29
  30 from mako.template import Template
  31
  32 COPYRIGHT = textwrap.dedent(u"""\
  33     * Copyright © 2017 Intel Corporation
  34     *
  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:
  41     *
  42     * The above copyright notice and this permission notice shall be included in
  43     * all copies or substantial portions of the Software.
  44     *
  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
  51     * SOFTWARE.""")
  52
  53 C_TEMPLATE = Template(textwrap.dedent(u"""\
  54     /* Autogenerated file -- do not edit
  55      * generated by ${file}
  56      *
  57      ${copyright}
  58      */
  59
  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"
  64
  65     % for enum in enums:
  66
  67     const char *
  68     vk_${enum.name[2:]}_to_str(${enum.name} input)
  69     {
  70         switch(input) {
  71         % for v in enum.values:
  72             % if v in FOREIGN_ENUM_VALUES:
  73
  74             #pragma GCC diagnostic push
  75             #pragma GCC diagnostic ignored "-Wswitch"
  76             % endif
  77             case ${v}:
  78                 return "${v}";
  79             % if v in FOREIGN_ENUM_VALUES:
  80             #pragma GCC diagnostic pop
  81
  82             % endif
  83         % endfor
  84         default:
  85             unreachable("Undefined enum value.");
  86         }
  87     }
  88     %endfor"""),
  89     output_encoding='utf-8')
  90
  91 H_TEMPLATE = Template(textwrap.dedent(u"""\
  92     /* Autogenerated file -- do not edit
  93      * generated by ${file}
  94      *
  95      ${copyright}
  96      */
  97
  98     #ifndef MESA_VK_ENUM_TO_STR_H
  99     #define MESA_VK_ENUM_TO_STR_H
 100
 101     #include <vulkan/vulkan.h>
 102     #include <vulkan/vk_android_native_buffer.h>
 103
 104     % for ext in extensions:
 105     #define _${ext.name}_number (${ext.number})
 106     % endfor
 107
 108     % for enum in enums:
 109     const char * vk_${enum.name[2:]}_to_str(${enum.name} input);
 110     % endfor
 111
 112     #endif"""),
 113     output_encoding='utf-8')
 114
 115 # These enums are defined outside their respective enum blocks, and thus cause
 116 # -Wswitch warnings.
 117 FOREIGN_ENUM_VALUES = [
 118     "VK_STRUCTURE_TYPE_NATIVE_BUFFER_ANDROID",
 119 ]
 120
 121
 122 class NamedFactory(object):
 123     """Factory for creating enums."""
 124
 125     def __init__(self, type_):
 126         self.registry = {}
 127         self.type = type_
 128
 129     def __call__(self, name, **kwargs):
 130         try:
 131             return self.registry[name]
 132         except KeyError:
 133             n = self.registry[name] = self.type(name, **kwargs)
 134         return n
 135
 136
 137 class VkExtension(object):
 138     """Simple struct-like class representing extensions"""
 139
 140     def __init__(self, name, number=None):
 141         self.name = name
 142         self.number = number
 143
 144
 145 class VkEnum(object):
 146     """Simple struct-like class representing a single Vulkan Enum."""
 147
 148     def __init__(self, name, values=None):
 149         self.name = name
 150         self.values = values or []
 151
 152
 153 def parse_xml(enum_factory, ext_factory, filename):
 154     """Parse the XML file. Accumulate results into the factories.
 155
 156     This parser is a memory efficient iterative XML parser that returns a list
 157     of VkEnum objects.
 158     """
 159
 160     xml = et.parse(filename)
 161
 162     for enum_type in xml.findall('./enums[@type="enum"]'):
 163         enum = enum_factory(enum_type.attrib['name'])
 164         for value in enum_type.findall('./enum'):
 165             enum.values.append(value.attrib['name'])
 166
 167     for ext_elem in xml.findall('./extensions/extension[@supported="vulkan"]'):
 168         ext_factory(ext_elem.attrib['name'],
 169                     number=int(ext_elem.attrib['number']))
 170
 171 def main():
 172     parser = argparse.ArgumentParser()
 173     parser.add_argument('--xml', required=True,
 174                         help='Vulkan API XML files',
 175                         action='append',
 176                         dest='xml_files')
 177     parser.add_argument('--outdir',
 178                         help='Directory to put the generated files in',
 179                         required=True)
 180
 181     args = parser.parse_args()
 182
 183     enum_factory = NamedFactory(VkEnum)
 184     ext_factory = NamedFactory(VkExtension)
 185     for filename in args.xml_files:
 186         parse_xml(enum_factory, ext_factory, filename)
 187     enums = sorted(enum_factory.registry.values(), key=lambda e: e.name)
 188     extensions = sorted(ext_factory.registry.values(), key=lambda e: e.name)
 189
 190     for template, file_ in [(C_TEMPLATE, os.path.join(args.outdir, 'vk_enum_to_str.c')),
 191                             (H_TEMPLATE, os.path.join(args.outdir, 'vk_enum_to_str.h'))]:
 192         with open(file_, 'wb') as f:
 193             f.write(template.render(
 194                 file=os.path.basename(__file__),
 195                 enums=enums,
 196                 extensions=extensions,
 197                 copyright=COPYRIGHT,
 198                 FOREIGN_ENUM_VALUES=FOREIGN_ENUM_VALUES))
 199
 200
 201 if __name__ == '__main__':
 202     main()