• 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('#include "util/glheader.h"')
53        print('')
54        print('#ifdef __cplusplus')
55        print('extern "C" {')
56        print('#endif')
57        print('')
58        print('#if defined(_WIN32) && defined(_WINDOWS_)')
59        print('#error "Should not include <windows.h> here"')
60        print('#endif')
61        print('')
62        print('struct _glapi_table')
63        print('{')
64        return
65
66    def printRealFooter(self):
67        print('};')
68        print('')
69        print('#ifdef __cplusplus')
70        print('}')
71        print('#endif')
72        return
73
74
75class PrintRemapTable(gl_XML.gl_print_base):
76    def __init__(self):
77        gl_XML.gl_print_base.__init__(self)
78
79        self.header_tag = '_DISPATCH_H_'
80        self.name = "gl_table.py (from Mesa)"
81        self.license = license.bsd_license_template % (
82            "(C) Copyright IBM Corporation 2005", "IBM")
83        return
84
85
86    def printRealHeader(self):
87        print("""
88/**
89 * \\file main/dispatch.h
90 * Macros for handling GL dispatch tables.
91 *
92 * For each known GL function, there are 3 macros in this file.  The first
93 * macro is named CALL_FuncName and is used to call that GL function using
94 * the specified dispatch table.  The other 2 macros, called GET_FuncName
95 * can SET_FuncName, are used to get and set the dispatch pointer for the
96 * named function in the specified dispatch table.
97 */
98
99#include "util/glheader.h"
100""")
101        return
102
103
104    def printBody(self, api):
105        print('#define CALL_by_offset(disp, cast, offset, parameters) \\')
106        print('    (*(cast (GET_by_offset(disp, offset)))) parameters')
107        print('#define GET_by_offset(disp, offset) \\')
108        print('    (offset >= 0) ? (((_glapi_proc *)(disp))[offset]) : NULL')
109        print('#define SET_by_offset(disp, offset, fn) \\')
110        print('    do { \\')
111        print('        if ( (offset) < 0 ) { \\')
112        print('            /* fprintf( stderr, "[%s:%u] SET_by_offset(%p, %d, %s)!\\n", */ \\')
113        print('            /*         __func__, __LINE__, disp, offset, # fn); */ \\')
114        print('            /* abort(); */ \\')
115        print('        } \\')
116        print('        else { \\')
117        print('            ( (_glapi_proc *) (disp) )[offset] = (_glapi_proc) fn; \\')
118        print('        } \\')
119        print('    } while(0)')
120        print('')
121
122        abi_functions = [f for f in api.functionIterateByOffset()]
123
124        print('/* total number of offsets below */')
125        print('#define _gloffset_COUNT %d' % (len(abi_functions)))
126        print('')
127
128        for f in abi_functions:
129            print('#define _gloffset_%s %d' % (f.name, f.offset))
130
131        print('')
132
133        for f in abi_functions:
134            arg_string = gl_XML.create_parameter_string(f.parameters, 0)
135
136            print('typedef %s (GLAPIENTRYP _glptr_%s)(%s);' % (f.return_type, f.name, arg_string))
137            print('#define CALL_{0}(disp, parameters) (* GET_{0}(disp)) parameters'.format(f.name))
138            print('#define GET_{0}(disp) ((_glptr_{0})(GET_by_offset((disp), _gloffset_{0})))'.format(f.name))
139            print("""#define SET_{0}(disp, func) do {{ \\
140   {1} (GLAPIENTRYP fn)({2}) = func; \\
141   SET_by_offset(disp, _gloffset_{0}, fn); \\
142}} while (0)
143""".format(f.name, f.return_type, arg_string))
144
145        return
146
147
148def _parser():
149    """Parse arguments and return a namespace."""
150    parser = argparse.ArgumentParser()
151    parser.add_argument('-f', '--filename',
152                        default='gl_API.xml',
153                        metavar="input_file_name",
154                        dest='file_name',
155                        help="Path to an XML description of OpenGL API.")
156    parser.add_argument('-m', '--mode',
157                        choices=['table', 'dispatch'],
158                        default='table',
159                        metavar="mode",
160                        help="Generate either a table or a dispatch")
161    return parser.parse_args()
162
163
164def main():
165    """Main function."""
166    args = _parser()
167
168    api = gl_XML.parse_GL_API(args.file_name)
169
170    if args.mode == "table":
171        printer = PrintGlTable()
172    elif args.mode == "dispatch":
173        printer = PrintRemapTable()
174
175    printer.Print(api)
176
177
178if __name__ == '__main__':
179    main()
180