summaryrefslogtreecommitdiff
path: root/src/mesa/glapi/gl_XML.py
blob: f096d3d953f49b037cf45a36a0ac0aaeea4c6192 (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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
#!/usr/bin/python2

# (C) Copyright IBM Corporation 2004, 2005
# All Rights Reserved.
#
# 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>

from xml.sax import saxutils
from xml.sax import make_parser
from xml.sax.handler import feature_namespaces

import re

class glItem:
	"""Generic class on which all other API entity types are based."""

	def __init__(self, tag_name, name, context):
		self.name = name
		self.category = context.get_category_define()
		self.context = context
		self.tag_name = tag_name
		
		context.append(tag_name, self)
		return
	
	def startElement(self, name, attrs):
		"""Generic startElement handler.
		
		The startElement handler is called for all elements except
		the one that starts the object.  For a foo element, the
		XML "<foo><bar/></foo>" would cause the startElement handler
		to be called once, but the endElement handler would be called
		twice."""
		return

	def endElement(self, name):
		"""Generic endElement handler.

		Generic endElement handler.    Returns 1 if the tag containing
		the object is complete.  Otherwise 0 is returned.  All
		derived class endElement handlers should call this method.  If
		the name of the ending tag is the same as the tag that
		started this object, the object is assumed to be complete.
		
		This fails if a tag can contain another tag with the same
		name.  The XML "<foo><foo/><bar/></foo>" would fail.  The
		object would end before the bar tag was processed.
		
		The endElement handler is called for every end element
		associated with an object, even the element that started the
		object.  See the description of startElement an example."""

		if name == self.tag_name:
			return 1
		else:
			return 0

	def get_category_define(self):
		return self.category


class glEnum( glItem ):
	"""Subclass of glItem for representing GL enumerants.
	
	This class is not complete, and is not really used yet."""

	def __init__(self, context, name, attrs):
		self.value = int(attrs.get('value', "0x0000"), 0)

		enum_name = "GL_" + attrs.get('name', None)
		glItem.__init__(self, name, enum_name, context)

		temp = attrs.get('count', None)
		if temp == None:
			self.default_count = 0
		else:
			try:
				c = int(temp)
			except Exception,e:
				raise RuntimeError('Invalid count value "%s" for enum "%s" in function "%s" when an integer was expected.' % (temp, self.name, n))

			self.default_count = c
		return


	def process_attributes(self, attrs):
		name = attrs.get('name', None)

		temp = attrs.get('count', None)
		if temp == None:
			c = self.default_count
		else:
			try:
				c = int(temp)
			except Exception,e:
				raise RuntimeError('Invalid count value "%s" for enum "%s" in function "%s" when an integer was expected.' % (temp, self.name, n))

		mode_str = attrs.get('mode', "set")
		if mode_str == "set":
			mode = 1
		elif mode_str == "get":
			mode = 0
		else:
			raise RuntimeError("Invalid mode '%s' for function '%s' in enum '%s'." % (mode_str, self.context.name, self.name))

		return [name, c, mode]


class glType( glItem ):
	"""Subclass of glItem for representing GL types."""

	def __init__(self, context, name, attrs):
		self.size = int(attrs.get('size', "0"))
		self.glx_name = attrs.get('glx_name', "")

		type_name = "GL" + attrs.get('name', None)
		glItem.__init__(self, name, type_name, context)


class glParameter( glItem ):
	"""Parameter of a glFunction."""
	p_type = None
	p_type_string = ""
	p_count = 0
	counter = None
	is_output = 0
	is_counter = 0
	is_pointer = 0

	def __init__(self, context, name, attrs):
		p_name = attrs.get('name', None)
		self.p_type_string = attrs.get('type', None)

		temp = attrs.get('variable_param', None)
		if temp:
			self.count_parameter_list = temp.replace( ' ', '' ).split( ',' )
		else:
			self.count_parameter_list = []

		self.p_type = context.context.find_type(self.p_type_string)
		if self.p_type == None:
			raise RuntimeError("Unknown type '%s' in function '%s'." % (self.p_type_string, context.name))


		# The count tag can be either a numeric string or the name of
		# a variable.  If it is the name of a variable, the int(c)
		# statement will throw an exception, and the except block will
		# take over.

		c = attrs.get('count', "0")
		try: 
			self.p_count = int(c)
			self.counter = None
		except Exception,e:
			self.p_count = 0
			self.counter = c

		if attrs.get('counter', "false") == "true":
			self.is_counter = 1
		else:
			self.is_counter = 0

		if attrs.get('output', "false") == "true":
			self.is_output = 1
		else:
			self.is_output = 0

			
		# Pixel data has special parameters.

		self.width      = attrs.get('img_width',  None)
		self.height     = attrs.get('img_height', None)
		self.depth      = attrs.get('img_depth',  None)
		self.extent     = attrs.get('img_extent', None)

		self.img_xoff   = attrs.get('img_xoff',   None)
		self.img_yoff   = attrs.get('img_yoff',   None)
		self.img_zoff   = attrs.get('img_zoff',   None)
		self.img_woff   = attrs.get('img_woff',   None)

		self.img_format = attrs.get('img_format', None)
		self.img_type   = attrs.get('img_type',   None)
		self.img_target = attrs.get('img_target', None)

		pad = attrs.get('img_pad_dimensions', "false")
		if pad == "true":
			self.img_pad_dimensions = 1
		else:
			self.img_pad_dimensions = 0


		null_flag = attrs.get('img_null_flag', "false")
		if null_flag == "true":
			self.img_null_flag = 1
		else:
			self.img_null_flag = 0

		send_null = attrs.get('img_send_null', "false")
		if send_null == "true":
			self.img_send_null = 1
		else:
			self.img_send_null = 0



		if self.p_count > 0 or self.counter or self.count_parameter_list:
			has_count = 1
		else:
			has_count = 0


		# If there is a * anywhere in the parameter's type, then it
		# is a pointer.

		if re.compile("[*]").search(self.p_type_string):
			# We could do some other validation here.  For
			# example, an output parameter should not be const,
			# but every non-output parameter should.

			self.is_pointer = 1;
		else:
			# If a parameter is not a pointer, then there cannot
			# be an associated count (either fixed size or
			# variable) and the parameter cannot be an output.

			if has_count or self.is_output:
				raise RuntimeError("Non-pointer type has count or is output.")
			self.is_pointer = 0;

		glItem.__init__(self, name, p_name, context)
		return


	def is_variable_length_array(self):
		"""Determine if a parameter is a variable length array.
		
		A parameter is considered to be a variable length array if
		its size depends on the value of another parameter that is
		an enumerant.  The params parameter to glTexEnviv is an
		example of a variable length array parameter.  Arrays whose
		size depends on a count variable, such as the lists parameter
		to glCallLists, are not variable length arrays in this
		sense."""

		return self.count_parameter_list or self.counter or self.width


	def is_array(self):
		return self.is_pointer


	def count_string(self):
		"""Return a string representing the number of items
		
		Returns a string representing the number of items in a
		parameter.  For scalar types this will always be "1".  For
		vector types, it will depend on whether or not it is a
		fixed length vector (like the parameter of glVertex3fv),
		a counted length (like the vector parameter of
		glDeleteTextures), or a general variable length vector."""

		if self.is_array():
			if self.count_parameter_list:
				return "compsize"
			elif self.counter != None:
				return self.counter
			else:
				return str(self.p_count)
		else:
			return "1"


	def size(self):
		if self.count_parameter_list or self.counter or self.width or self.is_output:
			return 0
		elif self.p_count == 0:
			return self.p_type.size
		else:
			return self.p_type.size * self.p_count

	def size_string(self):
		s = self.size()
		if s == 0:
			a_prod = "compsize"
			b_prod = self.p_type.size

			# Handle functions like glCompressedTexImage2D that
			# have a counted 'void *' parameter.

			if b_prod == 0:	b_prod = 1

			if not self.count_parameter_list and self.counter != None:
				a_prod = self.counter
			elif self.count_parameter_list and self.counter == None:
				pass
			elif self.count_parameter_list and self.counter != None:
				b_prod = self.counter
			elif self.width:
				return "compsize"
			else:
				raise RuntimeError("Parameter '%s' to function '%s' has size 0." % (self.name, self.context.name))

			return "(%s * %s)" % (a_prod, b_prod)
		else:
			return str(s)


class glParameterIterator:
	"""Class to iterate over a list of glParameters.
	
	Objects of this class are returned by the parameterIterator method of
	the glFunction class.  They are used to iterate over the list of
	parameters to the function."""

	def __init__(self, data):
		self.data = data
		self.index = 0

	def __iter__(self):
		return self

	def next(self):
		if self.index == len( self.data ):
			raise StopIteration
		i = self.index
		self.index += 1
		return self.data[i]


class glFunction( glItem ):
	def __init__(self, context, name, attrs):
		self.fn_alias = attrs.get('alias', None)
		self.fn_parameters = []
		self.image = None
		self.count_parameter_list = []
		self.fn_return_type = "void"

		temp = attrs.get('offset', None)
		if temp == None or temp == "?":
			self.fn_offset = -1
		else:
			self.fn_offset = int(temp)

		fn_name = attrs.get('name', None)
		if self.fn_alias != None:
			self.real_name = self.fn_alias
		else:
			self.real_name = fn_name

		glItem.__init__(self, name, fn_name, context)
		return


	def parameterIterator(self):
		return glParameterIterator(self.fn_parameters)


	def startElement(self, name, attrs):
		if name == "param":
			try:
				self.context.factory.create(self, name, attrs)
			except RuntimeError:
				print "Error with parameter '%s' in function '%s'." \
					% (attrs.get('name','(unknown)'), self.name)
				raise
		elif name == "return":
			self.set_return_type(attrs.get('type', None))


	def append(self, tag_name, p):
		if tag_name != "param":
			raise RuntimeError("Trying to append '%s' to parameter list of function '%s'." % (tag_name, self.name))

		if p.width:
			self.image = p

		self.fn_parameters.append(p)
		if p.count_parameter_list != []:
			self.count_parameter_list.extend( p.count_parameter_list )


	def set_return_type(self, t):
		self.fn_return_type = t


	def get_parameter_string(self):
		arg_string = ""
		comma = ""
		for p in glFunction.parameterIterator(self):
			arg_string = arg_string + comma + p.p_type_string + " " + p.name
			comma = ", "

		if arg_string == "":
			arg_string = "void"

		return arg_string


class glItemFactory:
	"""Factory to create objects derived from glItem."""
    
	def create(self, context, name, attrs):
		if name == "function":
			return glFunction(context, name, attrs)
		elif name == "type":
			return glType(context, name, attrs)
		elif name == "enum":
			return glEnum(context, name, attrs)
		elif name == "param":
			return glParameter(context, name, attrs)
		else:
			return None


class glFunctionIterator:
	"""Class to iterate over a list of glFunctions

	Objects of this classare returned by
	FilterGLAPISpecBase::functionIterator.  This default version
	iterates over the functions in order of dispatch table offset.  All
	of the "true" functions are iterated first, followed by the alias
	functions."""

	def __init__(self, context):
		self.context = context
		self.keys = context.functions.keys()
		self.keys.sort()

		self.prevk = -1
		self.direction = 1

		for self.index in range(0, len(self.keys)):
			if self.keys[ self.index ] >= 0: break

		if self.index == len(self.keys):
			self.direction = -1
			self.index -= 1

		self.split = self.index - 1
		return


	def __iter__(self):
		return self


	def next(self):
		if self.index < 0:
			raise StopIteration

		k = self.keys[ self.index ]

		#if self.context.functions[k].fn_alias == None:
		#	if k != self.prevk + 1:
		#		print 'Missing offset %d' % (prevk)
		#	self.prevk = int(k)

		self.index += self.direction

		if self.index == len(self.keys):
			self.index = self.split
			self.direction = -1

		return self.context.functions[k]


class FilterGLAPISpecBase(saxutils.XMLFilterBase):
	name = "a"
	license = "The license for this file is unspecified."
	functions = {}
	next_alias = -2
	types = {}
	xref = {}
	current_object = None
	factory = None
	current_category = ""

	def __init__(self):
		saxutils.XMLFilterBase.__init__(self)
		self.functions = {}
		self.types = {}
		self.xref = {}
		self.factory = glItemFactory()
		self.header_tag = None
		self.undef_list = []
		self.enums = []


	def find_type(self,type_name):
		for t in self.types:
			if re.compile(t).search(type_name):
				return self.types[t]
		print "Unable to find base type matching \"%s\"." % (type_name)
		return None


	def find_function(self,function_name):
		index = self.xref[function_name]
		return self.functions[index]


	def functionIterator(self):
		return glFunctionIterator(self)


	def printFunctions(self):
		for f in self.functionIterator():
			self.printFunction(f)
		return


	def printHeader(self):
		"""Print the header associated with all files and call the printRealHeader method."""

		print '/* DO NOT EDIT - This file generated automatically by %s script */' \
			% (self.name)
		print ''
		print '/*'
		print ' * ' + self.license.replace('\n', '\n * ')
		print ' */'
		print ''
		if self.header_tag:
		    print '#if !defined( %s )' % (self.header_tag)
		    print '#  define %s' % (self.header_tag)
		    print ''
		self.printRealHeader();
		return


	def printFooter(self):
		"""Print the header associated with all files and call the printRealFooter method."""

		self.printFunctions()
		self.printRealFooter()
		if self.header_tag:
			if self.undef_list:
				print ''
				for u in self.undef_list:
					print "#  undef %s" % (u)
			print ''
			print '#endif /* !defined( %s ) */' % (self.header_tag)


	def get_category_define(self):
		"""Convert the category name to the #define that would be found in glext.h"""

		if re.compile("[1-9][0-9]*[.][0-9]+").match(self.current_category):
			s = self.current_category
			return "GL_VERSION_" + s.replace(".", "_")
		else:
			return self.current_category


	def append(self, object_type, obj):
		if object_type == "function":
			# If the function is not an alias and has a negative
			# offset, then we do not need to track it.  These are
			# functions that don't have an assigned offset

			if obj.fn_offset >= 0 or obj.fn_alias != None:
				if obj.fn_offset >= 0:
					index = obj.fn_offset
				else:
					index = self.next_alias
					self.next_alias -= 1

				self.functions[index] = obj
				self.xref[obj.name] = index
		elif object_type == "type":
			self.types[obj.name] = obj
		elif object_type == "enum":
			self.enums.append(obj)

		return


	def startElement(self, name, attrs):
		"""Start a new element in the XML stream.
		
		Starts a new element.  There are three types of elements that
		are specially handled by this function.  When a "category"
		element is encountered, the name of the category is saved.
		If an element is encountered and no API object is
		in-progress, a new object is created using the API factory.
		Any future elements, until that API object is closed, are
		passed to the current objects startElement method.
	
		This paradigm was chosen becuase it allows subclasses of the
		basic API types (i.e., glFunction, glEnum, etc.) to handle
		additional XML data, GLX protocol information,  that the base
		classes do not know about."""

		if self.current_object != None:
			self.current_object.startElement(name, attrs)
		elif name == "category":
			self.current_category = attrs.get('name', "")
		elif name == "include":
			self.next_include = attrs.get('name', "")
		else:
			self.current_object = self.factory.create(self, name, attrs)
		return


	def endElement(self, name):
		if self.current_object != None:
			if self.current_object.endElement(name):
				self.current_object = None
		elif name == "include":
			parser = make_parser()
			parser.setFeature(feature_namespaces, 0)
			parser.setContentHandler(self)

			f = open(self.next_include)
			parser.parse(f)

		return


	def printPure(self):
		self.undef_list.append("PURE")
		print """#  if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
#    define PURE __attribute__((pure))
#  else
#    define PURE
#  endif"""

	def printFastcall(self):
		self.undef_list.append("FASTCALL")
		print """#  if defined(__i386__) && defined(__GNUC__)
#    define FASTCALL __attribute__((fastcall))
#  else
#    define FASTCALL
#  endif"""

	def printVisibility(self, S, s):
		self.undef_list.append(S)
		print """#  if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)
#    define %s  __attribute__((visibility("%s")))
#  else
#    define %s
#  endif""" % (S, s, S)

	def printNoinline(self):
		self.undef_list.append("NOINLINE")
		print """#  if defined(__GNUC__)
#    define NOINLINE __attribute__((noinline))
#  else
#    define NOINLINE
#  endif"""

	def printHaveAlias(self):
		self.undef_list.append("HAVE_ALIAS")
		print """#  if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)
#    define HAVE_ALIAS
#  endif"""

	def printFunction(self,offset):
		"""Print a single function.

		In the base class, this function is empty.  All derived
		classes should over-ride this function."""
		return
    

	def printRealHeader(self):
		"""Print the "real" header for the created file.

		In the base class, this function is empty.  All derived
		classes should over-ride this function."""
		return


	def printRealFooter(self):
		"""Print the "real" footer for the created file.

		In the base class, this function is empty.  All derived
		classes should over-ride this function."""
		return