• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2# (C) Copyright IBM Corporation 2004
3# All Rights Reserved.
4# Copyright (c) 2014 Intel Corporation
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
28import argparse
29
30import gl_XML
31import license
32
33
34class PrintGlTable(gl_XML.gl_print_base):
35    def __init__(self):
36        gl_XML.gl_print_base.__init__(self)
37
38        self.header_tag = '_GLAPI_TABLE_H_'
39        self.name = "gl_table.py (from Mesa)"
40        self.license = license.bsd_license_template % ( \
41"""Copyright (C) 1999-2003  Brian Paul   All Rights Reserved.
42(C) Copyright IBM Corporation 2004""", "BRIAN PAUL, IBM")
43        return
44
45    def printBody(self, api):
46        for f in api.functionIterateByOffset():
47            arg_string = f.get_parameter_string()
48            print '   %s (GLAPIENTRYP %s)(%s); /* %d */' % (
49                f.return_type, f.name, arg_string, f.offset)
50
51    def printRealHeader(self):
52        print '#ifndef GLAPIENTRYP'
53        print '# ifndef GLAPIENTRY'
54        print '#  define GLAPIENTRY'
55        print '# endif'
56        print ''
57        print '# define GLAPIENTRYP GLAPIENTRY *'
58        print '#endif'
59        print ''
60        print ''
61        print '#ifdef __cplusplus'
62        print 'extern "C" {'
63        print '#endif'
64        print ''
65        print 'struct _glapi_table'
66        print '{'
67        return
68
69    def printRealFooter(self):
70        print '};'
71        print ''
72        print '#ifdef __cplusplus'
73        print '}'
74        print '#endif'
75        return
76
77
78class PrintRemapTable(gl_XML.gl_print_base):
79    def __init__(self):
80        gl_XML.gl_print_base.__init__(self)
81
82        self.header_tag = '_DISPATCH_H_'
83        self.name = "gl_table.py (from Mesa)"
84        self.license = license.bsd_license_template % (
85            "(C) Copyright IBM Corporation 2005", "IBM")
86        return
87
88
89    def printRealHeader(self):
90        print """
91/**
92 * \\file main/dispatch.h
93 * Macros for handling GL dispatch tables.
94 *
95 * For each known GL function, there are 3 macros in this file.  The first
96 * macro is named CALL_FuncName and is used to call that GL function using
97 * the specified dispatch table.  The other 2 macros, called GET_FuncName
98 * can SET_FuncName, are used to get and set the dispatch pointer for the
99 * named function in the specified dispatch table.
100 */
101"""
102        return
103
104
105    def printBody(self, api):
106        print '#define CALL_by_offset(disp, cast, offset, parameters) \\'
107        print '    (*(cast (GET_by_offset(disp, offset)))) parameters'
108        print '#define GET_by_offset(disp, offset) \\'
109        print '    (offset >= 0) ? (((_glapi_proc *)(disp))[offset]) : NULL'
110        print '#define SET_by_offset(disp, offset, fn) \\'
111        print '    do { \\'
112        print '        if ( (offset) < 0 ) { \\'
113        print '            /* fprintf( stderr, "[%s:%u] SET_by_offset(%p, %d, %s)!\\n", */ \\'
114        print '            /*         __func__, __LINE__, disp, offset, # fn); */ \\'
115        print '            /* abort(); */ \\'
116        print '        } \\'
117        print '        else { \\'
118        print '            ( (_glapi_proc *) (disp) )[offset] = (_glapi_proc) fn; \\'
119        print '        } \\'
120        print '    } while(0)'
121        print ''
122
123        functions = []
124        abi_functions = []
125        count = 0
126        for f in api.functionIterateByOffset():
127            if not f.is_abi():
128                functions.append([f, count])
129                count += 1
130            else:
131                abi_functions.append([f, -1])
132
133        print '/* total number of offsets below */'
134        print '#define _gloffset_COUNT %d' % (len(abi_functions + functions))
135        print ''
136
137        for f, index in abi_functions:
138            print '#define _gloffset_%s %d' % (f.name, f.offset)
139
140        remap_table = "driDispatchRemapTable"
141
142        print '#define %s_size %u' % (remap_table, count)
143        print 'extern int %s[ %s_size ];' % (remap_table, remap_table)
144        print ''
145
146        for f, index in functions:
147            print '#define %s_remap_index %u' % (f.name, index)
148
149        print ''
150
151        for f, index in functions:
152            print '#define _gloffset_%s %s[%s_remap_index]' % (f.name, remap_table, f.name)
153
154        print ''
155
156        for f, index in abi_functions + functions:
157            arg_string = gl_XML.create_parameter_string(f.parameters, 0)
158
159            print 'typedef %s (GLAPIENTRYP _glptr_%s)(%s);' % (f.return_type, f.name, arg_string)
160            print '#define CALL_%s(disp, parameters) \\' % (f.name)
161            print '    (* GET_%s(disp)) parameters' % (f.name)
162            print 'static inline _glptr_%s GET_%s(struct _glapi_table *disp) {' % (f.name, f.name)
163            print '   return (_glptr_%s) (GET_by_offset(disp, _gloffset_%s));' % (f.name, f.name)
164            print '}'
165            print
166            print 'static inline void SET_%s(struct _glapi_table *disp, %s (GLAPIENTRYP fn)(%s)) {' % (f.name, f.return_type, arg_string)
167            print '   SET_by_offset(disp, _gloffset_%s, fn);' % (f.name)
168            print '}'
169            print
170
171        return
172
173
174def _parser():
175    """Parse arguments and return a namespace."""
176    parser = argparse.ArgumentParser()
177    parser.add_argument('-f', '--filename',
178                        default='gl_API.xml',
179                        metavar="input_file_name",
180                        dest='file_name',
181                        help="Path to an XML description of OpenGL API.")
182    parser.add_argument('-m', '--mode',
183                        choices=['table', 'remap_table'],
184                        default='table',
185                        metavar="mode",
186                        help="Generate either a table or a remap_table")
187    return parser.parse_args()
188
189
190def main():
191    """Main function."""
192    args = _parser()
193
194    api = gl_XML.parse_GL_API(args.file_name)
195
196    if args.mode == "table":
197        printer = PrintGlTable()
198    elif args.mode == "remap_table":
199        printer = PrintRemapTable()
200
201    printer.Print(api)
202
203
204if __name__ == '__main__':
205    main()
206