summaryrefslogtreecommitdiffstats
path: root/src/mesa/glapi/remap_helper.py
blob: 2a1f5adc32a8d041559f7820cd101dc9c6ae4118 (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
#!/usr/bin/env python

# Copyright (C) 2009 Chia-I Wu <olv@0xlab.org>
# All Rights Reserved.
#
# This is based on extension_helper.py by Ian Romanick.
#
# 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.

import gl_XML
import license
import sys, getopt, string

def get_function_spec(func):
	sig = ""
	# derive parameter signature
	for p in func.parameterIterator():
		if p.is_padding:
			continue
		# FIXME: This is a *really* ugly hack. :(
		tn = p.type_expr.get_base_type_node()
		if p.is_pointer():
			sig += 'p'
		elif tn.integer:
			sig += 'i'
		elif tn.size == 4:
			sig += 'f'
		else:
			sig += 'd'

	spec = [sig]
	for ent in func.entry_points:
		spec.append("gl" + ent)

	# spec is terminated by an empty string
	spec.append('')

	return spec

class PrintGlRemap(gl_XML.gl_print_base):
	def __init__(self):
		gl_XML.gl_print_base.__init__(self)

		self.name = "remap_helper.py (from Mesa)"
		self.license = license.bsd_license_template % ("Copyright (C) 2009 Chia-I Wu <olv@0xlab.org>", "Chia-I Wu")
		return


	def printRealHeader(self):
		print '#include "glapi/dispatch.h"'
		print ''
		return


	def printBody(self, api):
		print 'struct gl_function_remap {'
		print '   GLint func_index;'
		print '   GLint dispatch_offset; /* for sanity check */'
		print '};'
		print ''

		pool_indices = {}

		print '/* this is internal to remap.c */'
		print '#ifdef need_MESA_remap_table'
		print ''
		print 'static const char _mesa_function_pool[] ='

		# output string pool
		index = 0;
		for f in api.functionIterateAll():
			pool_indices[f] = index

			spec = get_function_spec(f)

			# a function has either assigned offset, fixed offset,
			# or no offset
			if f.assign_offset:
				comments = "will be remapped"
			elif f.offset > 0:
				comments = "offset %d" % f.offset
			else:
				comments = "dynamic"

			print '   /* _mesa_function_pool[%d]: %s (%s) */' \
					% (index, f.name, comments)
			for line in spec:
				print '   "%s\\0"' % line
				index += len(line) + 1
		print '   ;'
		print ''

		print '/* these functions need to be remapped */'
		print 'static const struct {'
		print '   GLint pool_index;'
		print '   GLint remap_index;'
		print '} MESA_remap_table_functions[] = {'
		# output all functions that need to be remapped
		# iterate by offsets so that they are sorted by remap indices
		for f in api.functionIterateByOffset():
			if not f.assign_offset:
				continue
			print '   { %5d, %s_remap_index },' \
					% (pool_indices[f], f.name)
		print '   {    -1, -1 }'
		print '};'
		print ''

		abi = [ "1.0", "1.1", "1.2", "GL_ARB_multitexture" ]
		extension_functions = {}

		# collect non-ABI functions
		for f in api.functionIterateAll():
			for n in f.entry_points:
				category, num = api.get_category_for_name(n)
				if category not in abi:
					c = gl_XML.real_category_name(category)
					if not extension_functions.has_key(c):
						extension_functions[c] = []
					extension_functions[c].append(f)
		extensions = extension_functions.keys()
		extensions.sort()

		# output ABI functions that have alternative names (with ext suffix)
		print '/* these functions are in the ABI, but have alternative names */'
		print 'static const struct gl_function_remap MESA_alt_functions[] = {'
		for ext in extensions:
			funcs = []
			for f in extension_functions[ext]:
				# test if the function is in the ABI
				if f.is_abi():
					funcs.append(f)
			if not funcs:
				continue
			print '   /* from %s */' % ext
			for f in funcs:
				print '   { %5d, _gloffset_%s },' \
						% (pool_indices[f], f.name)
		print '   {    -1, -1 }'
		print '};'
		print ''

		print '#endif /* need_MESA_remap_table */'
		print ''

		# output remap helpers for DRI drivers

		for ext in extensions:
			funcs = []
			remapped = []
			for f in extension_functions[ext]:
				if f.assign_offset:
					# these are handled above
					remapped.append(f)
				else:
					# these functions are either in the
                                        # abi, or have offset -1
					funcs.append(f)

			print '#if defined(need_%s)' % (ext)
			if remapped:
				print '/* functions defined in MESA_remap_table_functions are excluded */'

			# output extension functions that need to be mapped
			print 'static const struct gl_function_remap %s_functions[] = {' % (ext)
			for f in funcs:
				if f.offset >= 0:
					print '   { %5d, _gloffset_%s },' \
							% (pool_indices[f], f.name)
				else:
					print '   { %5d, -1 }, /* %s */' % \
							(pool_indices[f], f.name)
			print '   {    -1, -1 }'
			print '};'

			print '#endif'
			print ''

		return


def show_usage():
	print "Usage: %s [-f input_file_name]" % sys.argv[0]
	sys.exit(1)

if __name__ == '__main__':
	file_name = "gl_API.xml"

	try:
		(args, trail) = getopt.getopt(sys.argv[1:], "f:")
	except Exception,e:
		show_usage()

	for (arg,val) in args:
		if arg == "-f":
			file_name = val

	api = gl_XML.parse_GL_API( file_name )

	printer = PrintGlRemap()
	printer.Print( api )