3 # (C) Copyright IBM Corporation 2004, 2005
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:
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
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
26 # Ian Romanick <idr@us.ibm.com>
28 import gl_XML
, glX_XML
32 class PrintGlOffsets(gl_XML
.gl_print_base
):
33 def __init__(self
, es
=False):
34 gl_XML
.gl_print_base
.__init
__(self
)
36 self
.name
= "gl_apitemp.py (from Mesa)"
37 self
.license
= license
.bsd_license_template
% ( \
38 """Copyright (C) 1999-2001 Brian Paul All Rights Reserved.
39 (C) Copyright IBM Corporation 2004""", "BRIAN PAUL, IBM")
43 self
.undef_list
.append( "KEYWORD1" )
44 self
.undef_list
.append( "KEYWORD1_ALT" )
45 self
.undef_list
.append( "KEYWORD2" )
46 self
.undef_list
.append( "NAME" )
47 self
.undef_list
.append( "DISPATCH" )
48 self
.undef_list
.append( "RETURN_DISPATCH" )
49 self
.undef_list
.append( "DISPATCH_TABLE_NAME" )
50 self
.undef_list
.append( "UNUSED_TABLE_NAME" )
51 self
.undef_list
.append( "TABLE_ENTRY" )
54 def printFunction(self
, f
, name
):
60 if f
.is_static_entry_point(name
):
63 keyword
= "KEYWORD1_ALT"
65 n
= f
.static_name(name
)
69 for p
in f
.parameterIterator(name
):
74 cast
= "(const void *) "
78 t_string
= t_string
+ comma
+ p
.format_string()
79 p_string
= p_string
+ comma
+ p
.name
80 o_string
= o_string
+ comma
+ cast
+ p
.name
83 silence
+= "%s(void) %s;" % (space
, p
.name
);
87 if f
.return_type
!= 'void':
88 dispatch
= "RETURN_DISPATCH"
93 if not f
.is_static_entry_point(name
):
96 cat
, num
= api
.get_category_for_name(name
)
97 if (cat
.startswith("es") or cat
.startswith("GL_OES")):
100 print '%s %s KEYWORD2 NAME(%s)(%s);' % (keyword
, f
.return_type
, n
, f
.get_parameter_string(name
))
103 print '%s %s KEYWORD2 NAME(%s)(%s)' % (keyword
, f
.return_type
, n
, f
.get_parameter_string(name
))
106 print ' %s' % (silence
)
108 print ' %s(%s, (), (F, "gl%s();\\n"));' \
109 % (dispatch
, f
.name
, name
)
111 print ' %s(%s, (%s), (F, "gl%s(%s);\\n", %s));' \
112 % (dispatch
, f
.name
, p_string
, name
, t_string
, o_string
)
117 def printRealHeader(self
):
119 self
.printVisibility( "HIDDEN", "hidden" )
122 * This file is a template which generates the OpenGL API entry point
123 * functions. It should be included by a .c file which first defines
124 * the following macros:
125 * KEYWORD1 - usually nothing, but might be __declspec(dllexport) on Win32
126 * KEYWORD2 - usually nothing, but might be __stdcall on Win32
127 * NAME(n) - builds the final function name (usually add "gl" prefix)
128 * DISPATCH(func, args, msg) - code to do dispatch of named function.
129 * msg is a printf-style debug message.
130 * RETURN_DISPATCH(func, args, msg) - code to do dispatch with a return value
132 * Here is an example which generates the usual OpenGL functions:
135 * #define NAME(func) gl##func
136 * #define DISPATCH(func, args, msg) \\
137 * struct _glapi_table *dispatch = CurrentDispatch; \\
138 * (*dispatch->func) args
139 * #define RETURN DISPATCH(func, args, msg) \\
140 * struct _glapi_table *dispatch = CurrentDispatch; \\
141 * return (*dispatch->func) args
152 #define KEYWORD1_ALT HIDDEN
160 #error DISPATCH must be defined
163 #ifndef RETURN_DISPATCH
164 #error RETURN_DISPATCH must be defined
172 def printInitDispatch(self
, api
):
174 #endif /* defined( NAME ) */
177 * This is how a dispatch table can be initialized with all the functions
178 * we generated above.
180 #ifdef DISPATCH_TABLE_NAME
183 #error TABLE_ENTRY must be defined
186 #ifdef _GLAPI_SKIP_NORMAL_ENTRY_POINTS
187 #error _GLAPI_SKIP_NORMAL_ENTRY_POINTS must not be defined
190 _glapi_proc DISPATCH_TABLE_NAME[] = {"""
191 for f
in api
.functionIterateByOffset():
192 print ' TABLE_ENTRY(%s),' % (f
.dispatch_name())
194 print ' /* A whole bunch of no-op functions. These might be called'
195 print ' * when someone tries to call a dynamically-registered'
196 print ' * extension function without a current rendering context.'
198 for i
in range(1, 100):
199 print ' TABLE_ENTRY(Unused),'
202 print '#endif /* DISPATCH_TABLE_NAME */'
207 def printAliasedTable(self
, api
):
210 * This is just used to silence compiler warnings.
211 * We list the functions which are not otherwise used.
213 #ifdef UNUSED_TABLE_NAME
214 _glapi_proc UNUSED_TABLE_NAME[] = {"""
218 for f
in api
.functionIterateByOffset():
219 normal_ents
, proto_ents
= self
.classifyEntryPoints(f
)
222 if f
.name
in normal_ents
:
223 normal_ents
.remove(f
.name
)
224 elif f
.name
in proto_ents
:
225 proto_ents
.remove(f
.name
)
227 normal_ents
= [f
.static_name(ent
) for ent
in normal_ents
]
228 proto_ents
= [f
.static_name(ent
) for ent
in proto_ents
]
230 normal_entries
.extend(normal_ents
)
231 proto_entries
.extend(proto_ents
)
233 print '#ifndef _GLAPI_SKIP_NORMAL_ENTRY_POINTS'
234 for ent
in normal_entries
:
235 print ' TABLE_ENTRY(%s),' % (ent
)
236 print '#endif /* _GLAPI_SKIP_NORMAL_ENTRY_POINTS */'
237 print '#ifndef _GLAPI_SKIP_PROTO_ENTRY_POINTS'
238 for ent
in proto_entries
:
239 print ' TABLE_ENTRY(%s),' % (ent
)
240 print '#endif /* _GLAPI_SKIP_PROTO_ENTRY_POINTS */'
243 print '#endif /*UNUSED_TABLE_NAME*/'
248 def classifyEntryPoints(self
, func
):
253 # classify the entry points
254 for name
in func
.entry_points
:
255 if func
.has_different_protocol(name
):
256 if func
.is_static_entry_point(name
):
257 proto_names
.append(name
)
259 proto_stubs
.append(name
)
261 if func
.is_static_entry_point(name
):
262 normal_names
.append(name
)
264 normal_stubs
.append(name
)
265 # there can be at most one stub for a function
267 normal_names
.append(normal_stubs
[0])
269 proto_names
.append(proto_stubs
[0])
271 return (normal_names
, proto_names
)
273 def printBody(self
, api
):
274 normal_entry_points
= []
275 proto_entry_points
= []
276 for func
in api
.functionIterateByOffset():
277 normal_ents
, proto_ents
= self
.classifyEntryPoints(func
)
278 normal_entry_points
.append((func
, normal_ents
))
279 proto_entry_points
.append((func
, proto_ents
))
281 print '#ifndef _GLAPI_SKIP_NORMAL_ENTRY_POINTS'
283 for func
, ents
in normal_entry_points
:
285 self
.printFunction(func
, ent
)
287 print '#endif /* _GLAPI_SKIP_NORMAL_ENTRY_POINTS */'
289 print '/* these entry points might require different protocols */'
290 print '#ifndef _GLAPI_SKIP_PROTO_ENTRY_POINTS'
292 for func
, ents
in proto_entry_points
:
294 self
.printFunction(func
, ent
)
296 print '#endif /* _GLAPI_SKIP_PROTO_ENTRY_POINTS */'
299 self
.printInitDispatch(api
)
300 self
.printAliasedTable(api
)
305 print "Usage: %s [-f input_file_name] [-c]" % sys
.argv
[0]
306 print "-c Enable compatibility with OpenGL ES."
309 if __name__
== '__main__':
310 file_name
= "gl_API.xml"
313 (args
, trail
) = getopt
.getopt(sys
.argv
[1:], "f:c")
318 for (arg
,val
) in args
:
324 api
= gl_XML
.parse_GL_API(file_name
, glX_XML
.glx_item_factory())
326 printer
= PrintGlOffsets(es
)