1#!/usr/bin/env python
2
3# Copyright (C) 2012 Intel Corporation
4#
5# Permission is hereby granted, free of charge, to any person obtaining a
6# copy of this software and associated documentation files (the "Software"),
7# to deal in the Software without restriction, including without limitation
8# the rights to use, copy, modify, merge, publish, distribute, sublicense,
9# and/or sell copies of the Software, and to permit persons to whom the
10# Software is furnished to do so, subject to the following conditions:
11#
12# The above copyright notice and this permission notice (including the next
13# paragraph) shall be included in all copies or substantial portions of the
14# Software.
15#
16# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22# IN THE SOFTWARE.
23
24# This script generates the file api_exec.c, which contains
25# _mesa_initialize_exec_table().  It is responsible for populating all
26# entries in the "exec" dispatch table that aren't dynamic.
27
28import argparse
29import collections
30import license
31import gl_XML
32import sys
33import apiexec
34
35
36exec_flavor_map = {
37    'dynamic': None,
38    'mesa': '_mesa_',
39    'skip': None,
40    }
41
42
43header = """/**
44 * \\file api_exec.c
45 * Initialize dispatch table.
46 */
47
48
49#include "main/accum.h"
50#include "main/api_loopback.h"
51#include "main/api_exec.h"
52#include "main/arbprogram.h"
53#include "main/atifragshader.h"
54#include "main/attrib.h"
55#include "main/blend.h"
56#include "main/blit.h"
57#include "main/bufferobj.h"
58#include "main/arrayobj.h"
59#include "main/bbox.h"
60#include "main/buffers.h"
61#include "main/clear.h"
62#include "main/clip.h"
63#include "main/colortab.h"
64#include "main/compute.h"
65#include "main/condrender.h"
66#include "main/context.h"
67#include "main/convolve.h"
68#include "main/copyimage.h"
69#include "main/depth.h"
70#include "main/debug_output.h"
71#include "main/dlist.h"
72#include "main/drawpix.h"
73#include "main/drawtex.h"
74#include "main/rastpos.h"
75#include "main/enable.h"
76#include "main/errors.h"
77#include "main/es1_conversion.h"
78#include "main/eval.h"
79#include "main/get.h"
80#include "main/feedback.h"
81#include "main/fog.h"
82#include "main/fbobject.h"
83#include "main/framebuffer.h"
84#include "main/genmipmap.h"
85#include "main/hint.h"
86#include "main/histogram.h"
87#include "main/imports.h"
88#include "main/light.h"
89#include "main/lines.h"
90#include "main/matrix.h"
91#include "main/multisample.h"
92#include "main/objectlabel.h"
93#include "main/objectpurge.h"
94#include "main/performance_monitor.h"
95#include "main/pipelineobj.h"
96#include "main/pixel.h"
97#include "main/pixelstore.h"
98#include "main/points.h"
99#include "main/polygon.h"
100#include "main/program_resource.h"
101#include "main/querymatrix.h"
102#include "main/queryobj.h"
103#include "main/readpix.h"
104#include "main/samplerobj.h"
105#include "main/scissor.h"
106#include "main/stencil.h"
107#include "main/texenv.h"
108#include "main/texgetimage.h"
109#include "main/teximage.h"
110#include "main/texgen.h"
111#include "main/texobj.h"
112#include "main/texparam.h"
113#include "main/texstate.h"
114#include "main/texstorage.h"
115#include "main/barrier.h"
116#include "main/textureview.h"
117#include "main/transformfeedback.h"
118#include "main/mtypes.h"
119#include "main/varray.h"
120#include "main/viewport.h"
121#include "main/shaderapi.h"
122#include "main/shaderimage.h"
123#include "main/uniforms.h"
124#include "main/syncobj.h"
125#include "main/formatquery.h"
126#include "main/dispatch.h"
127#include "main/vdpau.h"
128#include "vbo/vbo.h"
129
130
131/**
132 * Initialize a context's exec table with pointers to Mesa's supported
133 * GL functions.
134 *
135 * This function depends on ctx->Version.
136 *
137 * \param ctx  GL context to which \c exec belongs.
138 */
139void
140_mesa_initialize_exec_table(struct gl_context *ctx)
141{
142   struct _glapi_table *exec;
143
144   exec = ctx->Exec;
145   assert(exec != NULL);
146
147   assert(ctx->Version > 0);
148
149   vbo_initialize_exec_dispatch(ctx, exec);
150"""
151
152
153footer = """
154}
155"""
156
157
158class PrintCode(gl_XML.gl_print_base):
159
160    def __init__(self):
161        gl_XML.gl_print_base.__init__(self)
162
163        self.name = 'gl_genexec.py'
164        self.license = license.bsd_license_template % (
165            'Copyright (C) 2012 Intel Corporation',
166            'Intel Corporation')
167
168    def printRealHeader(self):
169        print header
170
171    def printRealFooter(self):
172        print footer
173
174    def printBody(self, api):
175        # Collect SET_* calls by the condition under which they should
176        # be called.
177        settings_by_condition = collections.defaultdict(lambda: [])
178        for f in api.functionIterateAll():
179            if f.exec_flavor not in exec_flavor_map:
180                raise Exception(
181                    'Unrecognized exec flavor {0!r}'.format(f.exec_flavor))
182            condition_parts = []
183            if f.name in apiexec.functions:
184                ex = apiexec.functions[f.name]
185                unconditional_count = 0
186
187                if ex.compatibility is not None:
188                    condition_parts.append('ctx->API == API_OPENGL_COMPAT')
189                    unconditional_count += 1
190
191                if ex.core is not None:
192                    condition_parts.append('ctx->API == API_OPENGL_CORE')
193                    unconditional_count += 1
194
195                if ex.es1 is not None:
196                    condition_parts.append('ctx->API == API_OPENGLES')
197                    unconditional_count += 1
198
199                if ex.es2 is not None:
200                    if ex.es2 > 20:
201                        condition_parts.append('(ctx->API == API_OPENGLES2 && ctx->Version >= {0})'.format(ex.es2))
202                    else:
203                        condition_parts.append('ctx->API == API_OPENGLES2')
204                        unconditional_count += 1
205
206                # If the function is unconditionally available in all four
207                # APIs, then it is always available.  Replace the complex
208                # tautology condition with "true" and let GCC do the right
209                # thing.
210                if unconditional_count == 4:
211                    condition_parts = ['true']
212            else:
213                if f.desktop:
214                    if f.deprecated:
215                        condition_parts.append('ctx->API == API_OPENGL_COMPAT')
216                    else:
217                        condition_parts.append('_mesa_is_desktop_gl(ctx)')
218                if 'es1' in f.api_map:
219                    condition_parts.append('ctx->API == API_OPENGLES')
220                if 'es2' in f.api_map:
221                    if f.api_map['es2'] > 2.0:
222                        condition_parts.append('(ctx->API == API_OPENGLES2 && ctx->Version >= {0})'.format(int(f.api_map['es2'] * 10)))
223                    else:
224                        condition_parts.append('ctx->API == API_OPENGLES2')
225
226            if not condition_parts:
227                # This function does not exist in any API.
228                continue
229            condition = ' || '.join(condition_parts)
230            prefix = exec_flavor_map[f.exec_flavor]
231            if prefix is None:
232                # This function is not implemented, or is dispatched
233                # dynamically.
234                continue
235            settings_by_condition[condition].append(
236                'SET_{0}(exec, {1}{0});'.format(f.name, prefix, f.name))
237        # Print out an if statement for each unique condition, with
238        # the SET_* calls nested inside it.
239        for condition in sorted(settings_by_condition.keys()):
240            print '   if ({0}) {{'.format(condition)
241            for setting in sorted(settings_by_condition[condition]):
242                print '      {0}'.format(setting)
243            print '   }'
244
245
246def _parser():
247    """Parse arguments and return namespace."""
248    parser = argparse.ArgumentParser()
249    parser.add_argument('-f',
250                        dest='filename',
251                        default='gl_and_es_API.xml',
252                        help='an xml file describing an API')
253    return parser.parse_args()
254
255
256def main():
257    """Main function."""
258    args = _parser()
259    printer = PrintCode()
260    api = gl_XML.parse_GL_API(args.filename)
261    printer.Print(api)
262
263
264if __name__ == '__main__':
265    main()
266