summaryrefslogtreecommitdiffstats
path: root/src/mapi/glapi/gen/gl_table.py
blob: 3f02902308763d5729071d666ea7e8098453d4a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
#!/usr/bin/python2

# (C) Copyright IBM Corporation 2004
# All Rights Reserved.
# Copyright (c) 2014 Intel Corporation
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# on the rights to use, copy, modify, merge, publish, distribute, sub
# license, and/or sell copies of the Software, and to permit persons to whom
# the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
# IBM AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# Authors:
#    Ian Romanick <idr@us.ibm.com>

import argparse

import gl_XML
import license


class PrintGlTable(gl_XML.gl_print_base):
    def __init__(self, es=False):
        gl_XML.gl_print_base.__init__(self)

        self.es = es
        self.header_tag = '_GLAPI_TABLE_H_'
        self.name = "gl_table.py (from Mesa)"
        self.license = license.bsd_license_template % ( \
"""Copyright (C) 1999-2003  Brian Paul   All Rights Reserved.
(C) Copyright IBM Corporation 2004""", "BRIAN PAUL, IBM")
        self.ifdef_emitted = False
        return

    def printBody(self, api):
        for f in api.functionIterateByOffset():
            if not f.is_abi() and not self.ifdef_emitted:
                print '#if !defined HAVE_SHARED_GLAPI'
                self.ifdef_emitted = True
            arg_string = f.get_parameter_string()
            print '   %s (GLAPIENTRYP %s)(%s); /* %d */' % (
                f.return_type, f.name, arg_string, f.offset)

        print '#endif /* !defined HAVE_SHARED_GLAPI */'

    def printRealHeader(self):
        print '#ifndef GLAPIENTRYP'
        print '# ifndef GLAPIENTRY'
        print '#  define GLAPIENTRY'
        print '# endif'
        print ''
        print '# define GLAPIENTRYP GLAPIENTRY *'
        print '#endif'
        print ''
        print ''
        print 'struct _glapi_table'
        print '{'
        return

    def printRealFooter(self):
        print '};'
        return


class PrintRemapTable(gl_XML.gl_print_base):
    def __init__(self, es=False):
        gl_XML.gl_print_base.__init__(self)

        self.es = es
        self.header_tag = '_DISPATCH_H_'
        self.name = "gl_table.py (from Mesa)"
        self.license = license.bsd_license_template % (
            "(C) Copyright IBM Corporation 2005", "IBM")
        return


    def printRealHeader(self):
        print """
/**
 * \\file main/dispatch.h
 * Macros for handling GL dispatch tables.
 *
 * For each known GL function, there are 3 macros in this file.  The first
 * macro is named CALL_FuncName and is used to call that GL function using
 * the specified dispatch table.  The other 2 macros, called GET_FuncName
 * can SET_FuncName, are used to get and set the dispatch pointer for the
 * named function in the specified dispatch table.
 */
"""
        return


    def printBody(self, api):
        print '#define CALL_by_offset(disp, cast, offset, parameters) \\'
        print '    (*(cast (GET_by_offset(disp, offset)))) parameters'
        print '#define GET_by_offset(disp, offset) \\'
        print '    (offset >= 0) ? (((_glapi_proc *)(disp))[offset]) : NULL'
        print '#define SET_by_offset(disp, offset, fn) \\'
        print '    do { \\'
        print '        if ( (offset) < 0 ) { \\'
        print '            /* fprintf( stderr, "[%s:%u] SET_by_offset(%p, %d, %s)!\\n", */ \\'
        print '            /*         __func__, __LINE__, disp, offset, # fn); */ \\'
        print '            /* abort(); */ \\'
        print '        } \\'
        print '        else { \\'
        print '            ( (_glapi_proc *) (disp) )[offset] = (_glapi_proc) fn; \\'
        print '        } \\'
        print '    } while(0)'
        print ''

        functions = []
        abi_functions = []
        alias_functions = []
        count = 0
        for f in api.functionIterateByOffset():
            if not f.is_abi():
                functions.append([f, count])
                count += 1
            else:
                abi_functions.append([f, -1])

            if self.es:
                # remember functions with aliases
                if len(f.entry_points) > 1:
                    alias_functions.append(f)

        print '/* total number of offsets below */'
        print '#define _gloffset_COUNT %d' % (len(abi_functions + functions))
        print ''

        for f, index in abi_functions:
            print '#define _gloffset_%s %d' % (f.name, f.offset)

        if self.es:
            remap_table = "esLocalRemapTable"

            print '#define %s_size %u' % (remap_table, count)
            print 'static int %s[ %s_size ];' % (remap_table, remap_table)
            print ''
        else:
            remap_table = "driDispatchRemapTable"

            print '#define %s_size %u' % (remap_table, count)
            print 'extern int %s[ %s_size ];' % (remap_table, remap_table)
            print ''

        for f, index in functions:
            print '#define %s_remap_index %u' % (f.name, index)

        print ''

        for f, index in functions:
            print '#define _gloffset_%s %s[%s_remap_index]' % (f.name, remap_table, f.name)

        print ''

        for f, index in abi_functions + functions:
            arg_string = gl_XML.create_parameter_string(f.parameters, 0)

            print 'typedef %s (GLAPIENTRYP _glptr_%s)(%s);' % (f.return_type, f.name, arg_string)
            print '#define CALL_%s(disp, parameters) \\' % (f.name)
            print '    (* GET_%s(disp)) parameters' % (f.name)
            print 'static inline _glptr_%s GET_%s(struct _glapi_table *disp) {' % (f.name, f.name)
            print '   return (_glptr_%s) (GET_by_offset(disp, _gloffset_%s));' % (f.name, f.name)
            print '}'
            print
            print 'static inline void SET_%s(struct _glapi_table *disp, %s (GLAPIENTRYP fn)(%s)) {' % (f.name, f.return_type, arg_string)
            print '   SET_by_offset(disp, _gloffset_%s, fn);' % (f.name)
            print '}'
            print

        if alias_functions:
            print ''
            print '/* define aliases for compatibility */'
            for f in alias_functions:
                for name in f.entry_points:
                    if name != f.name:
                        print '#define CALL_%s(disp, parameters) CALL_%s(disp, parameters)' % (name, f.name)
                        print '#define GET_%s(disp) GET_%s(disp)' % (name, f.name)
                        print '#define SET_%s(disp, fn) SET_%s(disp, fn)' % (name, f.name)
            print ''

            for f in alias_functions:
                for name in f.entry_points:
                    if name != f.name:
                        print '#define %s_remap_index %s_remap_index' % (name, f.name)
            print ''

        return


def _parser():
    """Parse arguments and return a namespace."""
    parser = argparse.ArgumentParser()
    parser.add_argument('-f', '--filename',
                        default='gl_API.xml',
                        metavar="input_file_name",
                        dest='file_name',
                        help="Path to an XML description of OpenGL API.")
    parser.add_argument('-m', '--mode',
                        choices=['table', 'remap_table'],
                        default='table',
                        metavar="mode",
                        help="Generate either a table or a remap_table")
    parser.add_argument('-c', '--es-version',
                        choices=[None, 'es1', 'es2'],
                        default=None,
                        metavar="ver",
                        dest='es',
                        help="filter functions for es")
    return parser.parse_args()


def main():
    """Main function."""
    args = _parser()

    api = gl_XML.parse_GL_API(args.file_name)

    if args.mode == "table":
        printer = PrintGlTable(args.es)
    elif args.mode == "remap_table":
        printer = PrintRemapTable(args.es)

    if args.es is not None:
        api.filter_functions_by_api(args.es)

    printer.Print(api)


if __name__ == '__main__':
    main()