src/mesa/glapi/gl_procs.py

   1 #!/usr/bin/env python
   2
   3 # (C) Copyright IBM Corporation 2004, 2005
   4 # All Rights Reserved.
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a
   7 # copy of this software and associated documentation files (the "Software"),
   8 # to deal in the Software without restriction, including without limitation
   9 # on the rights to use, copy, modify, merge, publish, distribute, sub
  10 # license, and/or sell copies of the Software, and to permit persons to whom
  11 # the Software is furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice (including the next
  14 # paragraph) shall be included in all copies or substantial portions of the
  15 # Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
  20 # IBM AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  23 # IN THE SOFTWARE.
  24 #
  25 # Authors:
  26 #    Ian Romanick <idr@us.ibm.com>
  27
  28 import license
  29 import gl_XML
  30 import sys, getopt
  31
  32 class PrintGlProcs(gl_XML.gl_print_base):
  33         def __init__(self, long_strings):
  34                 gl_XML.gl_print_base.__init__(self)
  35
  36                 self.long_strings = long_strings
  37                 self.name = "gl_procs.py (from Mesa)"
  38                 self.license = license.bsd_license_template % ( \
  39 """Copyright (C) 1999-2001  Brian Paul   All Rights Reserved.
  40 (C) Copyright IBM Corporation 2004""", "BRIAN PAUL, IBM")
  41
  42
  43         def printRealHeader(self):
  44                 print '/* This file is only included by glapi.c and is used for'
  45                 print ' * the GetProcAddress() function'
  46                 print ' */'
  47                 print ''
  48                 print 'typedef struct {'
  49                 print '    GLint Name_offset;'
  50                 print '#ifdef NEED_FUNCTION_POINTER'
  51                 print '    _glapi_proc Address;'
  52                 print '#endif'
  53                 print '    GLuint Offset;'
  54                 print '} glprocs_table_t;'
  55                 print ''
  56                 print '#ifdef NEED_FUNCTION_POINTER'
  57                 print '#  define NAME_FUNC_OFFSET(n,f,o) { n , (_glapi_proc) f , o }'
  58                 print '#else'
  59                 print '#  define NAME_FUNC_OFFSET(n,f,o) { n , o }'
  60                 print '#endif'
  61                 print ''
  62                 return
  63
  64         def printRealFooter(self):
  65                 print ''
  66                 print '#undef NAME_FUNC_OFFSET'
  67                 return
  68
  69         def printFunctionString(self, name):
  70                 if self.long_strings:
  71                         print '    "gl%s\\0"' % (name)
  72                 else:
  73                         print "    'g','l',",
  74                         for c in name:
  75                                 print "'%s'," % (c),
  76
  77                         print "'\\0',"
  78
  79
  80         def printBody(self, api):
  81                 print ''
  82                 if self.long_strings:
  83                         print 'static const char gl_string_table[] ='
  84                 else:
  85                         print 'static const char gl_string_table[] = {'
  86
  87                 base_offset = 0
  88                 table = []
  89                 for func in api.functionIterateByOffset():
  90                         if func.is_static_entry_point(func.name):
  91                                 name = func.name
  92                         else:
  93                                 name = "_dispatch_stub_%u" % (func.offset)
  94
  95                         self.printFunctionString( func.name )
  96                         table.append((base_offset, name, func.name))
  97
  98                         # The length of the function's name, plus 2 for "gl",
  99                         # plus 1 for the NUL.
 100
 101                         base_offset += len(func.name) + 3
 102
 103
 104                 for func in api.functionIterateByOffset():
 105                         for n in func.entry_points:
 106                                 if n != func.name:
 107                                         if func.is_static_entry_point(n):
 108                                                 name = n
 109                                         else:
 110                                                 name = "_dispatch_stub_%u" % (func.offset)
 111
 112                                         self.printFunctionString( n )
 113                                         table.append((base_offset, name, func.name))
 114                                         base_offset += len(n) + 3
 115
 116
 117                 if self.long_strings:
 118                         print '    ;'
 119                 else:
 120                         print '};'
 121
 122                 print ''
 123                 print '/* FIXME: Having these (incorrect) prototypes here is ugly. */'
 124                 print '#ifdef NEED_FUNCTION_POINTER'
 125                 for func in api.functionIterateByOffset():
 126                         for n in func.entry_points:
 127                                 if not func.is_static_entry_point(n):
 128                                         print 'extern void gl_dispatch_stub_%u(void);' % (func.offset)
 129                                         break
 130
 131                 print '#endif /* NEED_FUNCTION_POINTER */'
 132
 133                 print ''
 134                 print 'static const glprocs_table_t static_functions[] = {'
 135
 136                 for (offset, disp_name, real_name) in table:
 137                         print '    NAME_FUNC_OFFSET( %5u, gl%s, _gloffset_%s ),' % (offset, disp_name, real_name)
 138
 139                 print '    NAME_FUNC_OFFSET( -1, NULL, 0 )'
 140                 print '};'
 141                 return
 142
 143
 144 def show_usage():
 145         print "Usage: %s [-f input_file_name] [-m mode]" % sys.argv[0]
 146         print "mode can be one of:"
 147         print "    long  - Create code for compilers that can handle very "
 148         print "            long string constants. (default)"
 149         print "    short - Create code for compilers that can only handle "
 150         print "            ANSI C89 string constants."
 151         sys.exit(1)
 152
 153 if __name__ == '__main__':
 154         file_name = "gl_API.xml"
 155
 156         try:
 157                 (args, trail) = getopt.getopt(sys.argv[1:], "f:m:")
 158         except Exception,e:
 159                 show_usage()
 160
 161         long_string = 1
 162         for (arg,val) in args:
 163                 if arg == "-f":
 164                         file_name = val
 165                 elif arg == "-m":
 166                         if val == "short":
 167                                 long_string = 0
 168                         elif val == "long":
 169                                 long_string = 1
 170                         else:
 171                                 show_usage()
 172
 173         api = gl_XML.parse_GL_API( file_name )
 174
 175         printer = PrintGlProcs( long_string )
 176         printer.Print( api )