src/mapi/glapi/gen/remap_helper.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (C) 2009 Chia-I Wu <olv@0xlab.org>
   4 # All Rights Reserved.
   5 #
   6 # This is based on extension_helper.py by Ian Romanick.
   7 #
   8 # Permission is hereby granted, free of charge, to any person obtaining a
   9 # copy of this software and associated documentation files (the "Software"),
  10 # to deal in the Software without restriction, including without limitation
  11 # on the rights to use, copy, modify, merge, publish, distribute, sub
  12 # license, and/or sell copies of the Software, and to permit persons to whom
  13 # the Software is furnished to do so, subject to the following conditions:
  14 #
  15 # The above copyright notice and this permission notice (including the next
  16 # paragraph) shall be included in all copies or substantial portions of the
  17 # Software.
  18 #
  19 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
  22 # IBM AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  25 # IN THE SOFTWARE.
  26
  27 import sys
  28 import getopt
  29
  30 import license
  31 import gl_XML
  32
  33
  34 def get_function_spec(func):
  35     sig = ""
  36     # derive parameter signature
  37     for p in func.parameterIterator():
  38         if p.is_padding:
  39             continue
  40         # FIXME: This is a *really* ugly hack. :(
  41         tn = p.type_expr.get_base_type_node()
  42         if p.is_pointer():
  43             sig += 'p'
  44         elif tn.integer:
  45             sig += 'i'
  46         elif tn.size == 4:
  47             sig += 'f'
  48         else:
  49             sig += 'd'
  50
  51     spec = [sig]
  52     for ent in func.entry_points:
  53         spec.append("gl" + ent)
  54
  55     # spec is terminated by an empty string
  56     spec.append('')
  57
  58     return spec
  59
  60
  61 class PrintGlRemap(gl_XML.gl_print_base):
  62     def __init__(self):
  63         gl_XML.gl_print_base.__init__(self)
  64
  65         self.name = "remap_helper.py (from Mesa)"
  66         self.license = license.bsd_license_template % ("Copyright (C) 2009 Chia-I Wu <olv@0xlab.org>", "Chia-I Wu")
  67         return
  68
  69
  70     def printRealHeader(self):
  71         print '#include "main/dispatch.h"'
  72         print '#include "main/remap.h"'
  73         print ''
  74         return
  75
  76
  77     def printBody(self, api):
  78         pool_indices = {}
  79
  80         print '/* this is internal to remap.c */'
  81         print '#ifndef need_MESA_remap_table'
  82         print '#error Only remap.c should include this file!'
  83         print '#endif /* need_MESA_remap_table */'
  84         print ''
  85
  86         print ''
  87         print 'static const char _mesa_function_pool[] ='
  88
  89         # output string pool
  90         index = 0;
  91         for f in api.functionIterateAll():
  92             pool_indices[f] = index
  93
  94             spec = get_function_spec(f)
  95
  96             # a function has either assigned offset, fixed offset,
  97             # or no offset
  98             if f.assign_offset:
  99                 comments = "will be remapped"
 100             elif f.offset > 0:
 101                 comments = "offset %d" % f.offset
 102             else:
 103                 comments = "dynamic"
 104
 105             print '   /* _mesa_function_pool[%d]: %s (%s) */' \
 106                             % (index, f.name, comments)
 107             for line in spec:
 108                 print '   "%s\\0"' % line
 109                 index += len(line) + 1
 110         print '   ;'
 111         print ''
 112
 113         print '/* these functions need to be remapped */'
 114         print 'static const struct gl_function_pool_remap MESA_remap_table_functions[] = {'
 115         # output all functions that need to be remapped
 116         # iterate by offsets so that they are sorted by remap indices
 117         for f in api.functionIterateByOffset():
 118             if not f.assign_offset:
 119                 continue
 120             print '   { %5d, %s_remap_index },' \
 121                             % (pool_indices[f], f.name)
 122         print '   {    -1, -1 }'
 123         print '};'
 124         print ''
 125
 126         # collect functions by versions/extensions
 127         extension_functions = {}
 128         abi_extensions = []
 129         for f in api.functionIterateAll():
 130             for n in f.entry_points:
 131                 category, num = api.get_category_for_name(n)
 132                 # consider only GL_VERSION_X_Y or extensions
 133                 c = gl_XML.real_category_name(category)
 134                 if c.startswith("GL_"):
 135                     if not extension_functions.has_key(c):
 136                         extension_functions[c] = []
 137                     extension_functions[c].append(f)
 138                     # remember the ext names of the ABI
 139                     if (f.is_abi() and n == f.name and
 140                             c not in abi_extensions):
 141                         abi_extensions.append(c)
 142         # ignore the ABI itself
 143         for ext in abi_extensions:
 144             extension_functions.pop(ext)
 145
 146         extensions = extension_functions.keys()
 147         extensions.sort()
 148
 149         # output ABI functions that have alternative names (with ext suffix)
 150         print '/* these functions are in the ABI, but have alternative names */'
 151         print 'static const struct gl_function_remap MESA_alt_functions[] = {'
 152         for ext in extensions:
 153             funcs = []
 154             for f in extension_functions[ext]:
 155                 # test if the function is in the ABI and has alt names
 156                 if f.is_abi() and len(f.entry_points) > 1:
 157                     funcs.append(f)
 158             if not funcs:
 159                 continue
 160             print '   /* from %s */' % ext
 161             for f in funcs:
 162                 print '   { %5d, _gloffset_%s },' \
 163                                 % (pool_indices[f], f.name)
 164         print '   {    -1, -1 }'
 165         print '};'
 166         print ''
 167         return
 168
 169
 170 def show_usage():
 171     print "Usage: %s [-f input_file_name] [-c ver]" % sys.argv[0]
 172     print "    -c ver    Version can be 'es1' or 'es2'."
 173     sys.exit(1)
 174
 175
 176 def main():
 177     file_name = "gl_API.xml"
 178
 179     try:
 180         (args, trail) = getopt.getopt(sys.argv[1:], "f:c:")
 181     except Exception:
 182         show_usage()
 183
 184     es = None
 185     for (arg,val) in args:
 186         if arg == "-f":
 187             file_name = val
 188         elif arg == "-c":
 189             es = val
 190
 191     api = gl_XML.parse_GL_API( file_name )
 192
 193     if es is not None:
 194         api.filter_functions_by_api(es)
 195
 196     printer = PrintGlRemap()
 197     printer.Print( api )
 198
 199
 200 if __name__ == '__main__':
 201     main()