Subversion Repositories Kolibri OS

Rev

Go to most recent revision | Blame | Last modification | View Log | RSS feed

  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. from decimal import Decimal
  29. import libxml2
  30. import re, sys, string
  31. import typeexpr
  32.  
  33.  
  34. def parse_GL_API( file_name, factory = None ):
  35.     doc = libxml2.readFile( file_name, None, libxml2.XML_PARSE_XINCLUDE + libxml2.XML_PARSE_NOBLANKS + libxml2.XML_PARSE_DTDVALID + libxml2.XML_PARSE_DTDATTR + libxml2.XML_PARSE_DTDLOAD + libxml2.XML_PARSE_NOENT )
  36.     ret = doc.xincludeProcess()
  37.  
  38.     if not factory:
  39.         factory = gl_item_factory()
  40.  
  41.     api = factory.create_item( "api", None, None )
  42.     api.process_element( doc )
  43.  
  44.     # After the XML has been processed, we need to go back and assign
  45.     # dispatch offsets to the functions that request that their offsets
  46.     # be assigned by the scripts.  Typically this means all functions
  47.     # that are not part of the ABI.
  48.  
  49.     for func in api.functionIterateByCategory():
  50.         if func.assign_offset:
  51.             func.offset = api.next_offset;
  52.             api.next_offset += 1
  53.  
  54.     doc.freeDoc()
  55.  
  56.     return api
  57.  
  58.  
  59. def is_attr_true( element, name ):
  60.     """Read a name value from an element's attributes.
  61.  
  62.    The value read from the attribute list must be either 'true' or
  63.    'false'.  If the value is 'false', zero will be returned.  If the
  64.    value is 'true', non-zero will be returned.  An exception will be
  65.    raised for any other value."""
  66.  
  67.     value = element.nsProp( name, None )
  68.     if value == "true":
  69.         return 1
  70.     elif value == "false":
  71.         return 0
  72.     else:
  73.         raise RuntimeError('Invalid value "%s" for boolean "%s".' % (value, name))
  74.  
  75.  
  76. class gl_print_base(object):
  77.     """Base class of all API pretty-printers.
  78.  
  79.    In the model-view-controller pattern, this is the view.  Any derived
  80.    class will want to over-ride the printBody, printRealHader, and
  81.    printRealFooter methods.  Some derived classes may want to over-ride
  82.    printHeader and printFooter, or even Print (though this is unlikely).
  83.    """
  84.  
  85.     def __init__(self):
  86.         # Name of the script that is generating the output file.
  87.         # Every derived class should set this to the name of its
  88.         # source file.
  89.  
  90.         self.name = "a"
  91.  
  92.  
  93.         # License on the *generated* source file.  This may differ
  94.         # from the license on the script that is generating the file.
  95.         # Every derived class should set this to some reasonable
  96.         # value.
  97.         #
  98.         # See license.py for an example of a reasonable value.
  99.  
  100.         self.license = "The license for this file is unspecified."
  101.  
  102.  
  103.         # The header_tag is the name of the C preprocessor define
  104.         # used to prevent multiple inclusion.  Typically only
  105.         # generated C header files need this to be set.  Setting it
  106.         # causes code to be generated automatically in printHeader
  107.         # and printFooter.
  108.  
  109.         self.header_tag = None
  110.  
  111.  
  112.         # List of file-private defines that must be undefined at the
  113.         # end of the file.  This can be used in header files to define
  114.         # names for use in the file, then undefine them at the end of
  115.         # the header file.
  116.  
  117.         self.undef_list = []
  118.         return
  119.  
  120.  
  121.     def Print(self, api):
  122.         self.printHeader()
  123.         self.printBody(api)
  124.         self.printFooter()
  125.         return
  126.  
  127.  
  128.     def printHeader(self):
  129.         """Print the header associated with all files and call the printRealHeader method."""
  130.  
  131.         print '/* DO NOT EDIT - This file generated automatically by %s script */' \
  132.                 % (self.name)
  133.         print ''
  134.         print '/*'
  135.         print ' * ' + self.license.replace('\n', '\n * ')
  136.         print ' */'
  137.         print ''
  138.         if self.header_tag:
  139.             print '#if !defined( %s )' % (self.header_tag)
  140.             print '#  define %s' % (self.header_tag)
  141.             print ''
  142.         self.printRealHeader();
  143.         return
  144.  
  145.  
  146.     def printFooter(self):
  147.         """Print the header associated with all files and call the printRealFooter method."""
  148.  
  149.         self.printRealFooter()
  150.  
  151.         if self.undef_list:
  152.             print ''
  153.             for u in self.undef_list:
  154.                 print "#  undef %s" % (u)
  155.  
  156.         if self.header_tag:
  157.             print ''
  158.             print '#endif /* !defined( %s ) */' % (self.header_tag)
  159.  
  160.  
  161.     def printRealHeader(self):
  162.         """Print the "real" header for the created file.
  163.  
  164.        In the base class, this function is empty.  All derived
  165.        classes should over-ride this function."""
  166.         return
  167.  
  168.  
  169.     def printRealFooter(self):
  170.         """Print the "real" footer for the created file.
  171.  
  172.        In the base class, this function is empty.  All derived
  173.        classes should over-ride this function."""
  174.         return
  175.  
  176.  
  177.     def printPure(self):
  178.         """Conditionally define `PURE' function attribute.
  179.  
  180.        Conditionally defines a preprocessor macro `PURE' that wraps
  181.        GCC's `pure' function attribute.  The conditional code can be
  182.        easilly adapted to other compilers that support a similar
  183.        feature.
  184.  
  185.        The name is also added to the file's undef_list.
  186.        """
  187.         self.undef_list.append("PURE")
  188.         print """#  if defined(__GNUC__) || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
  189. #    define PURE __attribute__((pure))
  190. #  else
  191. #    define PURE
  192. #  endif"""
  193.         return
  194.  
  195.  
  196.     def printFastcall(self):
  197.         """Conditionally define `FASTCALL' function attribute.
  198.  
  199.        Conditionally defines a preprocessor macro `FASTCALL' that
  200.        wraps GCC's `fastcall' function attribute.  The conditional
  201.        code can be easilly adapted to other compilers that support a
  202.        similar feature.
  203.  
  204.        The name is also added to the file's undef_list.
  205.        """
  206.  
  207.         self.undef_list.append("FASTCALL")
  208.         print """#  if defined(__i386__) && defined(__GNUC__) && !defined(__CYGWIN__) && !defined(__MINGW32__)
  209. #    define FASTCALL __attribute__((fastcall))
  210. #  else
  211. #    define FASTCALL
  212. #  endif"""
  213.         return
  214.  
  215.  
  216.     def printVisibility(self, S, s):
  217.         """Conditionally define visibility function attribute.
  218.  
  219.        Conditionally defines a preprocessor macro name S that wraps
  220.        GCC's visibility function attribute.  The visibility used is
  221.        the parameter s.  The conditional code can be easilly adapted
  222.        to other compilers that support a similar feature.
  223.  
  224.        The name is also added to the file's undef_list.
  225.        """
  226.  
  227.         self.undef_list.append(S)
  228.         print """#  if (defined(__GNUC__) && !defined(__CYGWIN__) && !defined(__MINGW32__)) || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590) && defined(__ELF__))
  229. #    define %s  __attribute__((visibility("%s")))
  230. #  else
  231. #    define %s
  232. #  endif""" % (S, s, S)
  233.         return
  234.  
  235.  
  236.     def printNoinline(self):
  237.         """Conditionally define `NOINLINE' function attribute.
  238.  
  239.        Conditionally defines a preprocessor macro `NOINLINE' that
  240.        wraps GCC's `noinline' function attribute.  The conditional
  241.        code can be easilly adapted to other compilers that support a
  242.        similar feature.
  243.  
  244.        The name is also added to the file's undef_list.
  245.        """
  246.  
  247.         self.undef_list.append("NOINLINE")
  248.         print """#  if defined(__GNUC__) || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
  249. #    define NOINLINE __attribute__((noinline))
  250. #  else
  251. #    define NOINLINE
  252. #  endif"""
  253.         return
  254.  
  255.  
  256. def real_function_name(element):
  257.     name = element.nsProp( "name", None )
  258.     alias = element.nsProp( "alias", None )
  259.  
  260.     if alias:
  261.         return alias
  262.     else:
  263.         return name
  264.  
  265.  
  266. def real_category_name(c):
  267.     if re.compile("[1-9][0-9]*[.][0-9]+").match(c):
  268.         return "GL_VERSION_" + c.replace(".", "_")
  269.     else:
  270.         return c
  271.  
  272.  
  273. def classify_category(name, number):
  274.     """Based on the category name and number, select a numerical class for it.
  275.  
  276.    Categories are divided into four classes numbered 0 through 3.  The
  277.    classes are:
  278.  
  279.            0. Core GL versions, sorted by version number.
  280.            1. ARB extensions, sorted by extension number.
  281.            2. Non-ARB extensions, sorted by extension number.
  282.            3. Un-numbered extensions, sorted by extension name.
  283.    """
  284.  
  285.     try:
  286.         core_version = float(name)
  287.     except Exception,e:
  288.         core_version = 0.0
  289.  
  290.     if core_version > 0.0:
  291.         cat_type = 0
  292.         key = name
  293.     elif name.startswith("GL_ARB_") or name.startswith("GLX_ARB_") or name.startswith("WGL_ARB_"):
  294.         cat_type = 1
  295.         key = int(number)
  296.     else:
  297.         if number != None:
  298.             cat_type = 2
  299.             key = int(number)
  300.         else:
  301.             cat_type = 3
  302.             key = name
  303.  
  304.  
  305.     return [cat_type, key]
  306.  
  307.  
  308. def create_parameter_string(parameters, include_names):
  309.     """Create a parameter string from a list of gl_parameters."""
  310.  
  311.     list = []
  312.     for p in parameters:
  313.         if p.is_padding:
  314.             continue
  315.  
  316.         if include_names:
  317.             list.append( p.string() )
  318.         else:
  319.             list.append( p.type_string() )
  320.  
  321.     if len(list) == 0: list = ["void"]
  322.  
  323.     return string.join(list, ", ")
  324.  
  325.  
  326. class gl_item(object):
  327.     def __init__(self, element, context):
  328.         self.context = context
  329.         self.name = element.nsProp( "name", None )
  330.         self.category = real_category_name( element.parent.nsProp( "name", None ) )
  331.         return
  332.  
  333.  
  334. class gl_type( gl_item ):
  335.     def __init__(self, element, context):
  336.         gl_item.__init__(self, element, context)
  337.         self.size = int( element.nsProp( "size", None ), 0 )
  338.  
  339.         te = typeexpr.type_expression( None )
  340.         tn = typeexpr.type_node()
  341.         tn.size = int( element.nsProp( "size", None ), 0 )
  342.         tn.integer = not is_attr_true( element, "float" )
  343.         tn.unsigned = is_attr_true( element, "unsigned" )
  344.         tn.pointer = is_attr_true( element, "pointer" )
  345.         tn.name = "GL" + self.name
  346.         te.set_base_type_node( tn )
  347.  
  348.         self.type_expr = te
  349.         return
  350.  
  351.  
  352.     def get_type_expression(self):
  353.         return self.type_expr
  354.  
  355.  
  356. class gl_enum( gl_item ):
  357.     def __init__(self, element, context):
  358.         gl_item.__init__(self, element, context)
  359.         self.value = int( element.nsProp( "value", None ), 0 )
  360.  
  361.         temp = element.nsProp( "count", None )
  362.         if not temp or temp == "?":
  363.             self.default_count = -1
  364.         else:
  365.             try:
  366.                 c = int(temp)
  367.             except Exception,e:
  368.                 raise RuntimeError('Invalid count value "%s" for enum "%s" in function "%s" when an integer was expected.' % (temp, self.name, n))
  369.  
  370.             self.default_count = c
  371.  
  372.         return
  373.  
  374.  
  375.     def priority(self):
  376.         """Calculate a 'priority' for this enum name.
  377.  
  378.        When an enum is looked up by number, there may be many
  379.        possible names, but only one is the 'prefered' name.  The
  380.        priority is used to select which name is the 'best'.
  381.  
  382.        Highest precedence is given to core GL name.  ARB extension
  383.        names have the next highest, followed by EXT extension names.
  384.        Vendor extension names are the lowest.
  385.        """
  386.  
  387.         if self.name.endswith( "_BIT" ):
  388.             bias = 1
  389.         else:
  390.             bias = 0
  391.  
  392.         if self.category.startswith( "GL_VERSION_" ):
  393.             priority = 0
  394.         elif self.category.startswith( "GL_ARB_" ):
  395.             priority = 2
  396.         elif self.category.startswith( "GL_EXT_" ):
  397.             priority = 4
  398.         else:
  399.             priority = 6
  400.  
  401.         return priority + bias
  402.  
  403.  
  404.  
  405. class gl_parameter(object):
  406.     def __init__(self, element, context):
  407.         self.name = element.nsProp( "name", None )
  408.  
  409.         ts = element.nsProp( "type", None )
  410.         self.type_expr = typeexpr.type_expression( ts, context )
  411.  
  412.         temp = element.nsProp( "variable_param", None )
  413.         if temp:
  414.             self.count_parameter_list = temp.split( ' ' )
  415.         else:
  416.             self.count_parameter_list = []
  417.  
  418.         # The count tag can be either a numeric string or the name of
  419.         # a variable.  If it is the name of a variable, the int(c)
  420.         # statement will throw an exception, and the except block will
  421.         # take over.
  422.  
  423.         c = element.nsProp( "count", None )
  424.         try:
  425.             count = int(c)
  426.             self.count = count
  427.             self.counter = None
  428.         except Exception,e:
  429.             count = 1
  430.             self.count = 0
  431.             self.counter = c
  432.  
  433.         self.count_scale = int(element.nsProp( "count_scale", None ))
  434.  
  435.         elements = (count * self.count_scale)
  436.         if elements == 1:
  437.             elements = 0
  438.  
  439.         #if ts == "GLdouble":
  440.         #       print '/* stack size -> %s = %u (before)*/' % (self.name, self.type_expr.get_stack_size())
  441.         #       print '/* # elements = %u */' % (elements)
  442.         self.type_expr.set_elements( elements )
  443.         #if ts == "GLdouble":
  444.         #       print '/* stack size -> %s = %u (after) */' % (self.name, self.type_expr.get_stack_size())
  445.  
  446.         self.is_client_only = is_attr_true( element, 'client_only' )
  447.         self.is_counter     = is_attr_true( element, 'counter' )
  448.         self.is_output      = is_attr_true( element, 'output' )
  449.  
  450.  
  451.         # Pixel data has special parameters.
  452.  
  453.         self.width      = element.nsProp('img_width',  None)
  454.         self.height     = element.nsProp('img_height', None)
  455.         self.depth      = element.nsProp('img_depth',  None)
  456.         self.extent     = element.nsProp('img_extent', None)
  457.  
  458.         self.img_xoff   = element.nsProp('img_xoff',   None)
  459.         self.img_yoff   = element.nsProp('img_yoff',   None)
  460.         self.img_zoff   = element.nsProp('img_zoff',   None)
  461.         self.img_woff   = element.nsProp('img_woff',   None)
  462.  
  463.         self.img_format = element.nsProp('img_format', None)
  464.         self.img_type   = element.nsProp('img_type',   None)
  465.         self.img_target = element.nsProp('img_target', None)
  466.  
  467.         self.img_pad_dimensions = is_attr_true( element, 'img_pad_dimensions' )
  468.         self.img_null_flag      = is_attr_true( element, 'img_null_flag' )
  469.         self.img_send_null      = is_attr_true( element, 'img_send_null' )
  470.  
  471.         self.is_padding = is_attr_true( element, 'padding' )
  472.         return
  473.  
  474.  
  475.     def compatible(self, other):
  476.         return 1
  477.  
  478.  
  479.     def is_array(self):
  480.         return self.is_pointer()
  481.  
  482.  
  483.     def is_pointer(self):
  484.         return self.type_expr.is_pointer()
  485.  
  486.  
  487.     def is_image(self):
  488.         if self.width:
  489.             return 1
  490.         else:
  491.             return 0
  492.  
  493.  
  494.     def is_variable_length(self):
  495.         return len(self.count_parameter_list) or self.counter
  496.  
  497.  
  498.     def is_64_bit(self):
  499.         count = self.type_expr.get_element_count()
  500.         if count:
  501.             if (self.size() / count) == 8:
  502.                 return 1
  503.         else:
  504.             if self.size() == 8:
  505.                 return 1
  506.  
  507.         return 0
  508.  
  509.  
  510.     def string(self):
  511.         return self.type_expr.original_string + " " + self.name
  512.  
  513.  
  514.     def type_string(self):
  515.         return self.type_expr.original_string
  516.  
  517.  
  518.     def get_base_type_string(self):
  519.         return self.type_expr.get_base_name()
  520.  
  521.  
  522.     def get_dimensions(self):
  523.         if not self.width:
  524.             return [ 0, "0", "0", "0", "0" ]
  525.  
  526.         dim = 1
  527.         w = self.width
  528.         h = "1"
  529.         d = "1"
  530.         e = "1"
  531.  
  532.         if self.height:
  533.             dim = 2
  534.             h = self.height
  535.  
  536.         if self.depth:
  537.             dim = 3
  538.             d = self.depth
  539.  
  540.         if self.extent:
  541.             dim = 4
  542.             e = self.extent
  543.  
  544.         return [ dim, w, h, d, e ]
  545.  
  546.  
  547.     def get_stack_size(self):
  548.         return self.type_expr.get_stack_size()
  549.  
  550.  
  551.     def size(self):
  552.         if self.is_image():
  553.             return 0
  554.         else:
  555.             return self.type_expr.get_element_size()
  556.  
  557.  
  558.     def get_element_count(self):
  559.         c = self.type_expr.get_element_count()
  560.         if c == 0:
  561.             return 1
  562.  
  563.         return c
  564.  
  565.  
  566.     def size_string(self, use_parens = 1):
  567.         s = self.size()
  568.         if self.counter or self.count_parameter_list:
  569.             list = [ "compsize" ]
  570.  
  571.             if self.counter and self.count_parameter_list:
  572.                 list.append( self.counter )
  573.             elif self.counter:
  574.                 list = [ self.counter ]
  575.  
  576.             if s > 1:
  577.                 list.append( str(s) )
  578.  
  579.             if len(list) > 1 and use_parens :
  580.                 return "(%s)" % (string.join(list, " * "))
  581.             else:
  582.                 return string.join(list, " * ")
  583.  
  584.         elif self.is_image():
  585.             return "compsize"
  586.         else:
  587.             return str(s)
  588.  
  589.  
  590.     def format_string(self):
  591.         if self.type_expr.original_string == "GLenum":
  592.             return "0x%x"
  593.         else:
  594.             return self.type_expr.format_string()
  595.  
  596.  
  597. class gl_function( gl_item ):
  598.     def __init__(self, element, context):
  599.         self.context = context
  600.         self.name = None
  601.  
  602.         self.entry_points = []
  603.         self.return_type = "void"
  604.         self.parameters = []
  605.         self.offset = -1
  606.         self.initialized = 0
  607.         self.images = []
  608.         self.exec_flavor = 'mesa'
  609.         self.desktop = True
  610.         self.deprecated = None
  611.  
  612.         # self.entry_point_api_map[name][api] is a decimal value
  613.         # indicating the earliest version of the given API in which
  614.         # each entry point exists.  Every entry point is included in
  615.         # the first level of the map; the second level of the map only
  616.         # lists APIs which contain the entry point in at least one
  617.         # version.  For example,
  618.         # self.entry_point_api_map['ClipPlanex'] == { 'es1':
  619.         # Decimal('1.1') }.
  620.         self.entry_point_api_map = {}
  621.  
  622.         # self.api_map[api] is a decimal value indicating the earliest
  623.         # version of the given API in which ANY alias for the function
  624.         # exists.  The map only lists APIs which contain the function
  625.         # in at least one version.  For example, for the ClipPlanex
  626.         # function, self.entry_point_api_map == { 'es1':
  627.         # Decimal('1.1') }.
  628.         self.api_map = {}
  629.  
  630.         self.assign_offset = 0
  631.  
  632.         self.static_entry_points = []
  633.  
  634.         # Track the parameter string (for the function prototype)
  635.         # for each entry-point.  This is done because some functions
  636.         # change their prototype slightly when promoted from extension
  637.         # to ARB extension to core.  glTexImage3DEXT and glTexImage3D
  638.         # are good examples of this.  Scripts that need to generate
  639.         # code for these differing aliases need to real prototype
  640.         # for each entry-point.  Otherwise, they may generate code
  641.         # that won't compile.
  642.  
  643.         self.entry_point_parameters = {}
  644.  
  645.         self.process_element( element )
  646.  
  647.         return
  648.  
  649.  
  650.     def process_element(self, element):
  651.         name = element.nsProp( "name", None )
  652.         alias = element.nsProp( "alias", None )
  653.  
  654.         if is_attr_true(element, "static_dispatch"):
  655.             self.static_entry_points.append(name)
  656.  
  657.         self.entry_points.append( name )
  658.  
  659.         self.entry_point_api_map[name] = {}
  660.         for api in ('es1', 'es2'):
  661.             version_str = element.nsProp(api, None)
  662.             assert version_str is not None
  663.             if version_str != 'none':
  664.                 version_decimal = Decimal(version_str)
  665.                 self.entry_point_api_map[name][api] = version_decimal
  666.                 if api not in self.api_map or \
  667.                         version_decimal < self.api_map[api]:
  668.                     self.api_map[api] = version_decimal
  669.  
  670.         exec_flavor = element.nsProp('exec', None)
  671.         if exec_flavor:
  672.             self.exec_flavor = exec_flavor
  673.  
  674.         deprecated = element.nsProp('deprecated', None)
  675.         if deprecated != 'none':
  676.             self.deprecated = Decimal(deprecated)
  677.  
  678.         if not is_attr_true(element, 'desktop'):
  679.             self.desktop = False
  680.  
  681.         if alias:
  682.             true_name = alias
  683.         else:
  684.             true_name = name
  685.  
  686.             # Only try to set the offset when a non-alias entry-point
  687.             # is being processed.
  688.  
  689.             offset = element.nsProp( "offset", None )
  690.             if offset:
  691.                 try:
  692.                     o = int( offset )
  693.                     self.offset = o
  694.                 except Exception, e:
  695.                     self.offset = -1
  696.                     if offset == "assign":
  697.                         self.assign_offset = 1
  698.  
  699.  
  700.         if not self.name:
  701.             self.name = true_name
  702.         elif self.name != true_name:
  703.             raise RuntimeError("Function true name redefined.  Was %s, now %s." % (self.name, true_name))
  704.  
  705.  
  706.         # There are two possible cases.  The first time an entry-point
  707.         # with data is seen, self.initialized will be 0.  On that
  708.         # pass, we just fill in the data.  The next time an
  709.         # entry-point with data is seen, self.initialized will be 1.
  710.         # On that pass we have to make that the new values match the
  711.         # valuse from the previous entry-point.
  712.  
  713.         parameters = []
  714.         return_type = "void"
  715.         child = element.children
  716.         while child:
  717.             if child.type == "element":
  718.                 if child.name == "return":
  719.                     return_type = child.nsProp( "type", None )
  720.                 elif child.name == "param":
  721.                     param = self.context.factory.create_item( "parameter", child, self.context)
  722.                     parameters.append( param )
  723.  
  724.             child = child.next
  725.  
  726.  
  727.         if self.initialized:
  728.             if self.return_type != return_type:
  729.                 raise RuntimeError( "Return type changed in %s.  Was %s, now %s." % (name, self.return_type, return_type))
  730.  
  731.             if len(parameters) != len(self.parameters):
  732.                 raise RuntimeError( "Parameter count mismatch in %s.  Was %d, now %d." % (name, len(self.parameters), len(parameters)))
  733.  
  734.             for j in range(0, len(parameters)):
  735.                 p1 = parameters[j]
  736.                 p2 = self.parameters[j]
  737.                 if not p1.compatible( p2 ):
  738.                     raise RuntimeError( 'Parameter type mismatch in %s.  "%s" was "%s", now "%s".' % (name, p2.name, p2.type_expr.original_string, p1.type_expr.original_string))
  739.  
  740.  
  741.         if true_name == name or not self.initialized:
  742.             self.return_type = return_type
  743.             self.parameters = parameters
  744.  
  745.             for param in self.parameters:
  746.                 if param.is_image():
  747.                     self.images.append( param )
  748.  
  749.         if element.children:
  750.             self.initialized = 1
  751.             self.entry_point_parameters[name] = parameters
  752.         else:
  753.             self.entry_point_parameters[name] = []
  754.  
  755.         return
  756.  
  757.     def filter_entry_points(self, entry_point_list):
  758.         """Filter out entry points not in entry_point_list."""
  759.         if not self.initialized:
  760.             raise RuntimeError('%s is not initialized yet' % self.name)
  761.  
  762.         entry_points = []
  763.         for ent in self.entry_points:
  764.             if ent not in entry_point_list:
  765.                 if ent in self.static_entry_points:
  766.                     self.static_entry_points.remove(ent)
  767.                 self.entry_point_parameters.pop(ent)
  768.             else:
  769.                 entry_points.append(ent)
  770.  
  771.         if not entry_points:
  772.             raise RuntimeError('%s has no entry point after filtering' % self.name)
  773.  
  774.         self.entry_points = entry_points
  775.         if self.name not in entry_points:
  776.             # use the first remaining entry point
  777.             self.name = entry_points[0]
  778.             self.parameters = self.entry_point_parameters[entry_points[0]]
  779.  
  780.     def get_images(self):
  781.         """Return potentially empty list of input images."""
  782.         return self.images
  783.  
  784.  
  785.     def parameterIterator(self, name = None):
  786.         if name is not None:
  787.             return self.entry_point_parameters[name].__iter__();
  788.         else:
  789.             return self.parameters.__iter__();
  790.  
  791.  
  792.     def get_parameter_string(self, entrypoint = None):
  793.         if entrypoint:
  794.             params = self.entry_point_parameters[ entrypoint ]
  795.         else:
  796.             params = self.parameters
  797.  
  798.         return create_parameter_string( params, 1 )
  799.  
  800.     def get_called_parameter_string(self):
  801.         p_string = ""
  802.         comma = ""
  803.  
  804.         for p in self.parameterIterator():
  805.             if p.is_padding:
  806.                 continue
  807.             p_string = p_string + comma + p.name
  808.             comma = ", "
  809.  
  810.         return p_string
  811.  
  812.  
  813.     def is_abi(self):
  814.         return (self.offset >= 0 and not self.assign_offset)
  815.  
  816.     def is_static_entry_point(self, name):
  817.         return name in self.static_entry_points
  818.  
  819.     def dispatch_name(self):
  820.         if self.name in self.static_entry_points:
  821.             return self.name
  822.         else:
  823.             return "_dispatch_stub_%u" % (self.offset)
  824.  
  825.     def static_name(self, name):
  826.         if name in self.static_entry_points:
  827.             return name
  828.         else:
  829.             return "_dispatch_stub_%u" % (self.offset)
  830.  
  831.     def entry_points_for_api_version(self, api, version = None):
  832.         """Return a list of the entry point names for this function
  833.        which are supported in the given API (and optionally, version).
  834.  
  835.        Use the decimal.Decimal type to precisely express non-integer
  836.        versions.
  837.        """
  838.         result = []
  839.         for entry_point, api_to_ver in self.entry_point_api_map.iteritems():
  840.             if api not in api_to_ver:
  841.                 continue
  842.             if version is not None and version < api_to_ver[api]:
  843.                 continue
  844.             result.append(entry_point)
  845.         return result
  846.  
  847.  
  848. class gl_item_factory(object):
  849.     """Factory to create objects derived from gl_item."""
  850.  
  851.     def create_item(self, item_name, element, context):
  852.         if item_name == "function":
  853.             return gl_function(element, context)
  854.         if item_name == "type":
  855.             return gl_type(element, context)
  856.         elif item_name == "enum":
  857.             return gl_enum(element, context)
  858.         elif item_name == "parameter":
  859.             return gl_parameter(element, context)
  860.         elif item_name == "api":
  861.             return gl_api(self)
  862.         else:
  863.             return None
  864.  
  865.  
  866. class gl_api(object):
  867.     def __init__(self, factory):
  868.         self.functions_by_name = {}
  869.         self.enums_by_name = {}
  870.         self.types_by_name = {}
  871.  
  872.         self.category_dict = {}
  873.         self.categories = [{}, {}, {}, {}]
  874.  
  875.         self.factory = factory
  876.  
  877.         self.next_offset = 0
  878.  
  879.         typeexpr.create_initial_types()
  880.         return
  881.  
  882.     def filter_functions(self, entry_point_list):
  883.         """Filter out entry points not in entry_point_list."""
  884.         functions_by_name = {}
  885.         for func in self.functions_by_name.itervalues():
  886.             entry_points = [ent for ent in func.entry_points if ent in entry_point_list]
  887.             if entry_points:
  888.                 func.filter_entry_points(entry_points)
  889.                 functions_by_name[func.name] = func
  890.  
  891.         self.functions_by_name = functions_by_name
  892.  
  893.     def filter_functions_by_api(self, api, version = None):
  894.         """Filter out entry points not in the given API (or
  895.        optionally, not in the given version of the given API).
  896.        """
  897.         functions_by_name = {}
  898.         for func in self.functions_by_name.itervalues():
  899.             entry_points = func.entry_points_for_api_version(api, version)
  900.             if entry_points:
  901.                 func.filter_entry_points(entry_points)
  902.                 functions_by_name[func.name] = func
  903.  
  904.         self.functions_by_name = functions_by_name
  905.  
  906.     def process_element(self, doc):
  907.         element = doc.children
  908.         while element.type != "element" or element.name != "OpenGLAPI":
  909.             element = element.next
  910.  
  911.         if element:
  912.             self.process_OpenGLAPI(element)
  913.         return
  914.  
  915.  
  916.     def process_OpenGLAPI(self, element):
  917.         child = element.children
  918.         while child:
  919.             if child.type == "element":
  920.                 if child.name == "category":
  921.                     self.process_category( child )
  922.                 elif child.name == "OpenGLAPI":
  923.                     self.process_OpenGLAPI( child )
  924.  
  925.             child = child.next
  926.  
  927.         return
  928.  
  929.  
  930.     def process_category(self, cat):
  931.         cat_name = cat.nsProp( "name", None )
  932.         cat_number = cat.nsProp( "number", None )
  933.  
  934.         [cat_type, key] = classify_category(cat_name, cat_number)
  935.         self.categories[cat_type][key] = [cat_name, cat_number]
  936.  
  937.         child = cat.children
  938.         while child:
  939.             if child.type == "element":
  940.                 if child.name == "function":
  941.                     func_name = real_function_name( child )
  942.  
  943.                     temp_name = child.nsProp( "name", None )
  944.                     self.category_dict[ temp_name ] = [cat_name, cat_number]
  945.  
  946.                     if self.functions_by_name.has_key( func_name ):
  947.                         func = self.functions_by_name[ func_name ]
  948.                         func.process_element( child )
  949.                     else:
  950.                         func = self.factory.create_item( "function", child, self )
  951.                         self.functions_by_name[ func_name ] = func
  952.  
  953.                     if func.offset >= self.next_offset:
  954.                         self.next_offset = func.offset + 1
  955.  
  956.  
  957.                 elif child.name == "enum":
  958.                     enum = self.factory.create_item( "enum", child, self )
  959.                     self.enums_by_name[ enum.name ] = enum
  960.                 elif child.name == "type":
  961.                     t = self.factory.create_item( "type", child, self )
  962.                     self.types_by_name[ "GL" + t.name ] = t
  963.  
  964.  
  965.             child = child.next
  966.  
  967.         return
  968.  
  969.  
  970.     def functionIterateByCategory(self, cat = None):
  971.         """Iterate over functions by category.
  972.  
  973.        If cat is None, all known functions are iterated in category
  974.        order.  See classify_category for details of the ordering.
  975.        Within a category, functions are sorted by name.  If cat is
  976.        not None, then only functions in that category are iterated.
  977.        """
  978.         lists = [{}, {}, {}, {}]
  979.  
  980.         for func in self.functionIterateAll():
  981.             [cat_name, cat_number] = self.category_dict[func.name]
  982.  
  983.             if (cat == None) or (cat == cat_name):
  984.                 [func_cat_type, key] = classify_category(cat_name, cat_number)
  985.  
  986.                 if not lists[func_cat_type].has_key(key):
  987.                     lists[func_cat_type][key] = {}
  988.  
  989.                 lists[func_cat_type][key][func.name] = func
  990.  
  991.  
  992.         functions = []
  993.         for func_cat_type in range(0,4):
  994.             keys = lists[func_cat_type].keys()
  995.             keys.sort()
  996.  
  997.             for key in keys:
  998.                 names = lists[func_cat_type][key].keys()
  999.                 names.sort()
  1000.  
  1001.                 for name in names:
  1002.                     functions.append(lists[func_cat_type][key][name])
  1003.  
  1004.         return functions.__iter__()
  1005.  
  1006.  
  1007.     def functionIterateByOffset(self):
  1008.         max_offset = -1
  1009.         for func in self.functions_by_name.itervalues():
  1010.             if func.offset > max_offset:
  1011.                 max_offset = func.offset
  1012.  
  1013.  
  1014.         temp = [None for i in range(0, max_offset + 1)]
  1015.         for func in self.functions_by_name.itervalues():
  1016.             if func.offset != -1:
  1017.                 temp[ func.offset ] = func
  1018.  
  1019.  
  1020.         list = []
  1021.         for i in range(0, max_offset + 1):
  1022.             if temp[i]:
  1023.                 list.append(temp[i])
  1024.  
  1025.         return list.__iter__();
  1026.  
  1027.  
  1028.     def functionIterateAll(self):
  1029.         return self.functions_by_name.itervalues()
  1030.  
  1031.  
  1032.     def enumIterateByName(self):
  1033.         keys = self.enums_by_name.keys()
  1034.         keys.sort()
  1035.  
  1036.         list = []
  1037.         for enum in keys:
  1038.             list.append( self.enums_by_name[ enum ] )
  1039.  
  1040.         return list.__iter__()
  1041.  
  1042.  
  1043.     def categoryIterate(self):
  1044.         """Iterate over categories.
  1045.  
  1046.        Iterate over all known categories in the order specified by
  1047.        classify_category.  Each iterated value is a tuple of the
  1048.        name and number (which may be None) of the category.
  1049.        """
  1050.  
  1051.         list = []
  1052.         for cat_type in range(0,4):
  1053.             keys = self.categories[cat_type].keys()
  1054.             keys.sort()
  1055.  
  1056.             for key in keys:
  1057.                 list.append(self.categories[cat_type][key])
  1058.  
  1059.         return list.__iter__()
  1060.  
  1061.  
  1062.     def get_category_for_name( self, name ):
  1063.         if self.category_dict.has_key(name):
  1064.             return self.category_dict[name]
  1065.         else:
  1066.             return ["<unknown category>", None]
  1067.  
  1068.  
  1069.     def typeIterate(self):
  1070.         return self.types_by_name.itervalues()
  1071.  
  1072.  
  1073.     def find_type( self, type_name ):
  1074.         if type_name in self.types_by_name:
  1075.             return self.types_by_name[ type_name ].type_expr
  1076.         else:
  1077.             print "Unable to find base type matching \"%s\"." % (type_name)
  1078.             return None
  1079.