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