Added a couple missing always_array annotations and a couple trival
[mesa.git] / src / mesa / glapi / gl_apitemp.py
1 #!/usr/bin/python2
2
3 # (C) Copyright IBM Corporation 2004
4 # All Rights Reserved.
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
28 from xml.sax import saxutils
29 from xml.sax import make_parser
30 from xml.sax.handler import feature_namespaces
31
32 import gl_XML
33 import license
34 import sys, getopt
35
36 class PrintGlOffsets(gl_XML.FilterGLAPISpecBase):
37 name = "gl_apitemp.py (from Mesa)"
38
39 def __init__(self):
40 gl_XML.FilterGLAPISpecBase.__init__(self)
41 self.license = license.bsd_license_template % ( \
42 """Copyright (C) 1999-2001 Brian Paul All Rights Reserved.
43 (C) Copyright IBM Corporation 2004""", "BRIAN PAUL, IBM")
44
45 def printFunction(self, f):
46 p_string = ""
47 o_string = ""
48 t_string = ""
49 comma = ""
50
51 for p in f:
52 cast = ""
53
54 if p.is_pointer:
55 t = "%p"
56 cast = "(const void *) "
57 elif p.p_type_string == 'GLenum':
58 t = "0x%x"
59 elif p.p_type_string in ['GLfloat', 'GLdouble', 'GLclampf', 'GLclampd']:
60 t = "%f"
61 else:
62 t = "%d"
63
64 t_string = t_string + comma + t
65 p_string = p_string + comma + p.name
66 o_string = o_string + comma + cast + p.name
67 comma = ", "
68
69
70 if f.fn_return_type != 'void':
71 dispatch = "RETURN_DISPATCH"
72 else:
73 dispatch = "DISPATCH"
74
75 print 'KEYWORD1 %s KEYWORD2 NAME(%s)(%s)' \
76 % (f.fn_return_type, f.name, f.get_parameter_string())
77 print '{'
78 if p_string == "":
79 print ' %s(%s, (), (F, "gl%s();\\n"));' \
80 % (dispatch, f.real_name, f.name)
81 else:
82 print ' %s(%s, (%s), (F, "gl%s(%s);\\n", %s));' \
83 % (dispatch, f.real_name, p_string, f.name, t_string, o_string)
84 print '}'
85 print ''
86 return
87
88 def printRealHeader(self):
89 print """
90 /*
91 * This file is a template which generates the OpenGL API entry point
92 * functions. It should be included by a .c file which first defines
93 * the following macros:
94 * KEYWORD1 - usually nothing, but might be __declspec(dllexport) on Win32
95 * KEYWORD2 - usually nothing, but might be __stdcall on Win32
96 * NAME(n) - builds the final function name (usually add "gl" prefix)
97 * DISPATCH(func, args, msg) - code to do dispatch of named function.
98 * msg is a printf-style debug message.
99 * RETURN_DISPATCH(func, args, msg) - code to do dispatch with a return value
100 *
101 * Here is an example which generates the usual OpenGL functions:
102 * #define KEYWORD1
103 * #define KEYWORD2
104 * #define NAME(func) gl##func
105 * #define DISPATCH(func, args, msg) \\
106 * struct _glapi_table *dispatch = CurrentDispatch; \\
107 * (*dispatch->func) args
108 * #define RETURN DISPATCH(func, args, msg) \\
109 * struct _glapi_table *dispatch = CurrentDispatch; \\
110 * return (*dispatch->func) args
111 *
112 */
113
114
115 #if defined( NAME )
116 #ifndef KEYWORD1
117 #define KEYWORD1
118 #endif
119
120 #ifndef KEYWORD2
121 #define KEYWORD2
122 #endif
123
124 #ifndef DISPATCH
125 #error DISPATCH must be defined
126 #endif
127
128 #ifndef RETURN_DISPATCH
129 #error RETURN_DISPATCH must be defined
130 #endif
131
132 """
133 return
134
135
136
137 def printInitDispatch(self):
138 print """
139 #endif /* defined( NAME ) */
140
141 /*
142 * This is how a dispatch table can be initialized with all the functions
143 * we generated above.
144 */
145 #ifdef DISPATCH_TABLE_NAME
146
147 #ifndef TABLE_ENTRY
148 #error TABLE_ENTRY must be defined
149 #endif
150
151 static _glapi_proc DISPATCH_TABLE_NAME[] = {"""
152 keys = self.functions.keys()
153 keys.sort()
154 for k in keys:
155 if k < 0: continue
156
157 print ' TABLE_ENTRY(%s),' % (self.functions[k].name)
158
159 print ' /* A whole bunch of no-op functions. These might be called'
160 print ' * when someone tries to call a dynamically-registered'
161 print ' * extension function without a current rendering context.'
162 print ' */'
163 for i in range(1, 100):
164 print ' TABLE_ENTRY(Unused),'
165
166 print '};'
167 print '#endif /* DISPATCH_TABLE_NAME */'
168 print ''
169 return
170
171 def printAliasedTable(self):
172 print """
173 /*
174 * This is just used to silence compiler warnings.
175 * We list the functions which are not otherwise used.
176 */
177 #ifdef UNUSED_TABLE_NAME
178 static _glapi_proc UNUSED_TABLE_NAME[] = {"""
179
180 keys = self.functions.keys()
181 keys.sort()
182 keys.reverse();
183 for k in keys:
184 f = self.functions[k]
185 if f.fn_offset < 0:
186 print ' TABLE_ENTRY(%s),' % (f.name)
187
188 print '};'
189 print '#endif /*UNUSED_TABLE_NAME*/'
190 print ''
191 return
192
193 def printRealFooter(self):
194 self.printInitDispatch()
195 self.printAliasedTable()
196 print"""
197 #undef KEYWORD1
198 #undef KEYWORD2
199 #undef NAME
200 #undef DISPATCH
201 #undef RETURN_DISPATCH
202 #undef DISPATCH_TABLE_NAME
203 #undef UNUSED_TABLE_NAME
204 #undef TABLE_ENTRY
205 """
206 return
207
208 def show_usage():
209 print "Usage: %s [-f input_file_name]" % sys.argv[0]
210 sys.exit(1)
211
212 if __name__ == '__main__':
213 file_name = "gl_API.xml"
214
215 try:
216 (args, trail) = getopt.getopt(sys.argv[1:], "f:")
217 except Exception,e:
218 show_usage()
219
220 for (arg,val) in args:
221 if arg == "-f":
222 file_name = val
223
224 dh = PrintGlOffsets()
225
226 parser = make_parser()
227 parser.setFeature(feature_namespaces, 0)
228 parser.setContentHandler(dh)
229
230 f = open(file_name)
231
232 dh.printHeader()
233 parser.parse(f)
234 dh.printFooter()
235